Refactorings & improvements (fluent interface for ClientResult, crud operations moved to base entity classes), bug fixes

Author: [email protected]

examples/directory/delete_groups.py

@@ -13,7 +13,7 @@
     print("Group deleted.")
     index += 1
 
-deleted_groups = client.directory.deletedGroups.get().execute_query()
+deleted_groups = client.directory.deleted_groups.get().execute_query()
 groups_count = len(deleted_groups)
 index = 0
 while len(deleted_groups) > 0:

office365/actions/download_content_query.py

@@ -9,7 +9,7 @@ def __init__(self, entity_type, format_name=None):
         :type entity_type: office365.runtime.client_object.ClientObject
         :type format_name: str or None
         """
-        result = ClientResult(None)
+        result = ClientResult(entity_type.context)
         action_name = "content"
         if format_name is not None:
             action_name = action_name + r"?format={0}".format(format_name)

office365/directory/application.py

@@ -37,7 +37,7 @@ def delete_object(self, permanent_delete=False):
         """
         super(Application, self).delete_object()
         if permanent_delete:
-            deleted_item = self.context.directory.deletedApplications[self.id]
+            deleted_item = self.context.directory.deleted_applications[self.id]
             deleted_item.delete_object()
         return self
 

office365/directory/directory.py

@@ -8,28 +8,28 @@ class Directory(Entity):
     "container". Deleted items will remain available to restore for up to 30 days. After 30 days, the items are
     permanently deleted. """
 
-    def deletedItems(self, entity_type=None):
+    def deleted_items(self, entity_type=None):
         """Recently deleted items. Read-only. Nullable."""
         if entity_type:
-            return DirectoryObjectCollection(self.context, ResourcePath(entity_type,
-                                                                        ResourcePath("deletedItems",
-                                                                                     self.resource_path)))
+            return DirectoryObjectCollection(self.context,
+                                             ResourcePath(entity_type,
+                                                          ResourcePath("deletedItems", self.resource_path)))
         else:
             return self.properties.get('deletedItems',
                                        DirectoryObjectCollection(self.context,
                                                                  ResourcePath("deletedItems", self.resource_path)))
 
     @property
-    def deletedGroups(self):
+    def deleted_groups(self):
         """Recently deleted groups"""
-        return self.deletedItems("microsoft.graph.group")
+        return self.deleted_items("microsoft.graph.group")
 
     @property
-    def deletedUsers(self):
+    def deleted_users(self):
         """Recently deleted users"""
-        return self.deletedItems("microsoft.graph.user")
+        return self.deleted_items("microsoft.graph.user")
 
     @property
-    def deletedApplications(self):
+    def deleted_applications(self):
         """Recently deleted applications"""
-        return self.deletedItems("microsoft.graph.application")
+        return self.deleted_items("microsoft.graph.application")

office365/directory/directoryObject.py

@@ -1,5 +1,6 @@
 from office365.entity import Entity
 from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 
 
@@ -12,7 +13,7 @@ def get_member_objects(self, security_enabled_only=True):
         This function is transitive.
 
         :type security_enabled_only: bool"""
-        result = ClientResult(None)
+        result = ClientResult(self.context, ClientValueCollection(str))
         payload = {
             "securityEnabledOnly": security_enabled_only
         }
@@ -25,7 +26,7 @@ def get_member_groups(self, security_enabled_only=True):
         transitive.
 
         :type security_enabled_only: bool"""
-        result = ClientResult(None)
+        result = ClientResult(self.context)
         payload = {
             "securityEnabledOnly": security_enabled_only
         }

office365/directory/directoryObjectCollection.py

@@ -26,7 +26,7 @@ def __getitem__(self, key):
 
     def getByIds(self, ids):
         """Returns the directory objects specified in a list of IDs."""
-        result = ClientResult(None)
+        result = ClientResult(self.context)
         qry = ServiceOperationQuery(self, "getByIds", None, None, None, result)
         self.context.add_query(qry)
         return result

office365/directory/group.py

@@ -42,7 +42,7 @@ def check_member_groups(self, group_ids):
 
         :type group_ids: list
         """
-        result = ClientResult(None)
+        result = ClientResult(self.context)
         qry = ServiceOperationQuery(self, "checkMemberGroups", None, group_ids, None, result)
         self.context.add_query(qry)
         return result
@@ -72,7 +72,7 @@ def delete_object(self, permanent_delete=False):
         """
         super(Group, self).delete_object()
         if permanent_delete:
-            deleted_item = self.context.directory.deletedGroups[self.id]
+            deleted_item = self.context.directory.deleted_groups[self.id]
             deleted_item.delete_object()
         return self
 
@@ -106,7 +106,7 @@ def events(self):
         return self.properties.get('events', EventCollection(self.context, ResourcePath("events", self.resource_path)))
 
     @property
-    def appRoleAssignments(self):
+    def app_role_assignments(self):
         """Get an event collection or an appRoleAssignments."""
         return self.properties.get('appRoleAssignments',
                                    AppRoleAssignmentCollection(self.context,

office365/directory/permission.py

@@ -8,26 +8,13 @@
 class Permission(Entity):
     """The Permission resource provides information about a sharing permission granted for a DriveItem resource."""
 
-    def update(self):
-        """Updates the Permission entity."""
-        qry = UpdateEntityQuery(self)
-        self.context.add_query(qry)
-        return self
-
-    def delete_object(self):
-        """Deletes the Permission entity."""
-        qry = DeleteEntityQuery(self)
-        self.context.add_query(qry)
-        self.remove_from_parent_collection()
-        return self
-
     @property
     def invitation(self):
         """For user type permissions, the details of the users & applications for this permission."""
         return self.properties.get('invitation', SharingInvitation())
 
     @property
-    def grantedTo(self):
+    def granted_to(self):
         """For user type permissions, the details of the users & applications for this permission."""
         return self.properties.get('grantedTo', IdentitySet())
 
@@ -37,15 +24,15 @@ def roles(self):
         return self.properties.get('roles', [])
 
     @property
-    def shareId(self):
+    def share_id(self):
         """A unique token that can be used to access this shared item via the shares API. Read-only.
 
         :rtype: str
         """
         return self.properties.get('shareId', None)
 
     @property
-    def hasPassword(self):
+    def has_password(self):
         """This indicates whether password is set for this permission, it's only showing in response.
         Optional and Read-only and for OneDrive Personal only.
 

office365/directory/user.py

@@ -142,7 +142,7 @@ def delete_object(self, permanent_delete=False):
         """
         super(User, self).delete_object()
         if permanent_delete:
-            deleted_user = self.context.directory.deletedUsers[self.id]
+            deleted_user = self.context.directory.deleted_users[self.id]
             deleted_user.delete_object()
         return self
 

office365/entity.py

@@ -5,6 +5,7 @@
 
 
 class Entity(ClientObject):
+    """Base entity"""
 
     def update(self):
         """Updates the entity."""
@@ -40,7 +41,5 @@ def id(self):
     def set_property(self, name, value, persist_changes=True):
         super(Entity, self).set_property(name, value, persist_changes)
         if name == "id" and self._resource_path is None:
-            self._resource_path = ResourcePath(
-                value,
-                self._parent_collection.resource_path)
+            self._resource_path = ResourcePath(value,self._parent_collection.resource_path)
         return self