Add team member and collaborator management, improve upload/download returns, and improve doc strings

Author: jhodges10

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.formatting.provider": "black"
+}

examples/invite_users.py

@@ -0,0 +1,16 @@
+import os
+from frameioclient import FrameioClient
+
+
+def get_team_list(account_id):
+    token = os.getenv('FRAMEIO_TOKEN')
+    client = FrameioClient(token, host='https://api.frame.io')
+    pass
+
+
+def invite_users():
+    pass
+
+
+if __name__ == "__main__":
+    invite_users()

examples/user_management.py

@@ -0,0 +1,15 @@
+import os
+from frameioclient import FrameioClient
+
+token = os.getenv("FRAMEIO_TOKEN")
+
+users_list = [
+    "example_2@example.com",
+    "example_2@example.com"
+]
+
+team_id = "35543cd2-954a-c6ee-4aa1-ce9e19602aa9"
+
+client = FrameioClient(token)
+client.teams.add_members(team_id, users_list)
+client.teams.remove_members(team_id, users_list)

frameioclient/service/assets.py

@@ -181,7 +181,20 @@ def build_asset_info(self, filepath):
 
     return file_info
 
-  def upload(self, destination_id, filepath):
+  def upload(self, destination_id, filepath, asset=None):
+    """
+    Upload a file. The method will exit once the file is downloaded.
+
+    :Args:
+      destination_id (uuid): The destination Project or Folder ID.
+      filepath (string): The locaiton of the file on your local filesystem \
+        that you want to upload.
+
+      Example::
+
+        client.assets.upload('1231-12414-afasfaf-aklsajflaksjfla', "./file.mov")
+    """
+
     # Check if destination is a project or folder
     # If it's a project, well then we look up its root asset ID, otherwise we use the folder id provided
     # Then we start our upload
@@ -194,19 +207,27 @@ def upload(self, destination_id, filepath):
         folder_id = Project(self.client).get_project(destination_id)['root_asset_id']
     finally:
       file_info = self.build_asset_info(filepath)
-      try:
-        asset = self.create(folder_id,  
-            type="file",
-            name=file_info['filename'],
-            filetype=file_info['mimetype'],
-            filesize=file_info['filesize']
-        )
 
-        with open(file_info['filepath'], "rb") as fp:
-          self._upload(asset, fp)
+      if not asset:
+        try:
+          asset = self.create(folder_id,  
+              type="file",
+              name=file_info['filename'],
+              filetype=file_info['mimetype'],
+              filesize=file_info['filesize']
+          )
+
+        except Exception as e:
+            print(e)
+
+        try:
+          with open(file_info['filepath'], "rb") as fp:
+            self._upload(asset, fp)
+
+        except Exception as e:
+            print(e)
 
-      except Exception as e:
-          print(e)
+    return asset
 
   def download(self, asset, download_folder, prefix=None, multi_part=False, concurrency=5):
     """
@@ -218,7 +239,7 @@ def download(self, asset, download_folder, prefix=None, multi_part=False, concur
 
       Example::
 
-        client.download(asset, "~./Downloads")
+        client.assets.download(asset, "~./Downloads")
     """
     downloader = FrameioDownloader(asset, download_folder, prefix, multi_part, concurrency)
     return downloader.download_handler()

frameioclient/service/projects.py

@@ -11,21 +11,26 @@ def create(self, team_id, **kwargs):
       (optional) kwargs: additional request parameters.
 
       Example::
-
-        client.projects.create_project(
+        client.projects.create(
           team_id="123",
           name="My Awesome Project",
         )
     """
     endpoint = '/teams/{}/projects'.format(team_id)
     return self.client._api_call('post', endpoint, payload=kwargs)
 
-  def get_project(self, project_id):
+  def get(self, project_id):
     """
     Get an individual project
 
     :Args:
-      project_id (string): the project's id
+      project_id (string): The project's id
+    
+      Example::
+        client.project.get(
+          project_id="123",
+        )
+
     """
     endpoint = '/projects/{}'.format(project_id)
     return self.client._api_call('get', endpoint)
@@ -35,7 +40,13 @@ def get_collaborators(self, project_id, **kwargs):
     Get collaborators for a project
 
     :Args:
-      project_id (string): the project's id
+      project_id (uuid): The project's id
+
+      Example::
+        client.projects.get_collaborators(
+          project_id="123"
+        )
+
     """
     endpoint = "/projects/{}/collaborators?include=project_role".format(project_id)
     return self.client._api_call('get', endpoint, kwargs)
@@ -45,7 +56,48 @@ def get_pending_collaborators(self, project_id, **kwargs):
     Get pending collaborators for a project
 
     :Args:
-      project_id (string): the project's id
+      project_id (uuid): The project's id
+
+      Example::
+        client.projects.get_pending_collaborators(
+          project_id="123"
+        )
+
     """
     endpoint = "/projects/{}/pending_collaborators".format(project_id)
     return self.client._api_call('get', endpoint, kwargs)
+
+  def add_collaborator(self, project_id, email):
+    """
+    Add Collaborator to a Project Collaborator.
+
+    :Args:
+      project_id (uuid): The project id
+      email (string): Email user's e-mail address
+      
+      Example::
+        client.projects.add_collaborator(
+          project_id="123",
+          email="",
+        )
+    """
+    payload = {"email": email}
+    endpoint = '/projects/{}/collaborators'.format(project_id)
+    return self._api_call('post', endpoint, payload=payload)
+
+  def remove_collaborator(self, project_id, email):
+    """
+    Remove Collaborator from Project.
+
+    :Args:
+      project_id (uuid): The Project ID.
+      email (string): The user's e-mail address
+
+      Example::
+        client.projects.remove_collaborator(
+          project_id="123",
+          email="",
+        )
+    """
+    endpoint = '/projects/{}/collaborators/_?email={}'.format(project_id, email)
+    return self._api_call('delete', endpoint)

frameioclient/service/teams.py

@@ -72,3 +72,32 @@ def list_projects(self, team_id, **kwargs):
     """
     endpoint = '/teams/{}/projects'.format(team_id)
     return self.client._api_call('get', endpoint, kwargs)
+
+  def add_members(self, team_id, emails):
+    """
+    Add a list of users via their e-mail address to a given Team.
+
+    :Args:
+      team_id (string): The team id.
+      emails (list): The e-mails you want to add.
+    """
+    payload = dict()
+    payload['batch'] = list(map(lambda email: {"email": email}, emails))
+
+    endpoint = '/batch/teams/{}/members'.format(team_id)
+    return self._api_call('post', endpoint, payload=payload)
+
+  def remove_members(self, team_id, emails):
+    """
+    Remove a list of users via their e-mail address from a given Team.
+    
+    :Args:
+      team_id (string): The team id.
+      emails (list): The e-mails you want to add.
+    """
+
+    payload = dict()
+    payload['batch'] = list(map(lambda email: {"email": email}, emails))
+
+    endpoint = '/batch/teams/{}/members'.format(team_id)
+    return self._api_call('delete', endpoint, payload=payload)

tests/integration.py

@@ -124,7 +124,7 @@ def test_download(client, override=False):
 def test_upload(client):
     print("Beginning upload test")
     # Create new parent asset
-    project_info = client.projects.get_project(project_id)
+    project_info = client.projects.get(project_id)
     root_asset_id = project_info['root_asset_id']
 
     print("Creating new folder to upload to")