refactor

Author: MichaelBlaha

clockify_api_client/abstract_clockify.py

@@ -27,3 +27,9 @@ def put(self, url, payload):
         if response.status_code in [200, 201, 202]:
             return response.json()
         raise Exception(response.json())
+
+    def delete(self, url):
+        response = requests.delete(url, headers=self.header)
+        if response.status_code in [200, 201, 202, 204]:
+            return response.json()
+        raise Exception(response.json())

clockify_api_client/client.py

@@ -17,7 +17,10 @@ def __init__(self):
         self.reports = None
 
     def build(self, api_key, api_url):
-        """Builds services from available factories."""
+        """Builds services from available factories.
+        :param api_key Clockify API key.
+        :param api_url Clockify API url.
+        """
 
         self.workspaces = WorkspaceFactory(api_key=api_key, api_url=api_url)
         self.projects = ProjectFactory(api_key=api_key, api_url=api_url)

clockify_api_client/models/client.py

@@ -1,3 +1,4 @@
+import logging
 from urllib.parse import urlencode
 
 from clockify_api_client.abstract_clockify import AbstractClockify
@@ -9,13 +10,18 @@ def __init__(self, api_key, api_url):
         super(Client, self).__init__(api_key=api_key, api_url=api_url)
 
     def get_clients(self, workspace_id, params=None):
-        """Returns all unarchived clients.
+        """Returns all clients.
         :param workspace_id Id of workspace to look for clients.
         :param params       URL params of request.
-        :return             List of clients(dict objects)."""
-        if params is None:
-            params = {}
-        params['archived'] = str(False).lower()
-        url_params = urlencode(params, doseq=True)
-        url = self.base_url + '/workspaces/' + workspace_id + '/clients?archived=false&' + url_params
-        return self.get(url)
+        :return             List of clients(dict objects).
+        """
+        try:
+            if params:
+                url_params = urlencode(params, doseq=True)
+                url = self.base_url + '/workspaces/' + workspace_id + '/clients&' + url_params
+            else:
+                url = self.base_url + '/workspaces/' + workspace_id + '/clients/'
+            return self.get(url)
+        except Exception as e:
+            logging.error("API error: {0}".format(e))
+            raise e

clockify_api_client/models/project.py

@@ -10,7 +10,11 @@ def __init__(self, api_key, api_url):
         super(Project, self).__init__(api_key=api_key, api_url=api_url)
 
     def get_projects(self, workspace_id, params=None):
-        """Returns projects from given workspace with applied params if provided"""
+        """Returns projects from given workspace with applied params if provided.
+        :param workspace_id Id of workspace.
+        :param params       Dictionary with request parameters.
+        :return             List of projects.
+        """
         try:
             if params:
                 url_params = urlencode(params, doseq=True)
@@ -22,7 +26,14 @@ def get_projects(self, workspace_id, params=None):
             logging.error("API error: {0}".format(e))
             raise e
 
-    def create_new_project(self, workspace_id, project_name, client_id, billable=False):
+    def add_project(self, workspace_id, project_name, client_id, billable=False):
+        """Add new project into workspace.
+        :param workspace_id Id of workspace.
+        :param project_name Name of new project.
+        :param client_id    Id of client.
+        :param billable     Bool flag.
+        :return             Dictionary representation of new project.
+        """
         try:
             url = self.base_url + '/workspaces/' + workspace_id + '/projects/'
             data = {

clockify_api_client/models/report.py

@@ -15,9 +15,8 @@ def get_summary_report(self, workspace_id, payload):
         :return             Dictionary with summary report.
         """
         try:
-            url = self.base_url + '/workspaces/' + workspace_id + '/reports/summary'
+            url = self.base_url + '/workspaces/' + workspace_id + '/reports/summary/'
             return self.post(url, payload)
-
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
@@ -29,9 +28,8 @@ def get_detailed_report(self, workspace_id, payload):
         :return             Dictionary with detailed report.
         """
         try:
-            url = self.base_url + '/workspaces/' + workspace_id + '/reports/detailed'
+            url = self.base_url + '/workspaces/' + workspace_id + '/reports/detailed/'
             return self.post(url, payload)
-
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
@@ -43,9 +41,8 @@ def get_weekly_report(self, workspace_id, payload):
         :return             Dictionary with weekly report.
         """
         try:
-            url = self.base_url + '/workspaces/' + workspace_id + '/reports/weekly'
+            url = self.base_url + '/workspaces/' + workspace_id + '/reports/weekly/'
             return self.post(url, payload)
-
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e

clockify_api_client/models/task.py

@@ -9,46 +9,41 @@ class Task(AbstractClockify):
     def __init__(self, api_key, api_url):
         super(Task, self).__init__(api_key=api_key, api_url=api_url)
 
-    def create_task(self, workspace_id, project_id, task_name, request_data=None):
-        """Creates new task in clockify.
+    def add_task(self, workspace_id, project_id, task_name, request_data=None):
+        """Creates new task in Clockify.
         :param workspace_id  Id of workspace.
         :param request_data  Dictionary with request data.
         :param project_id    Id of project.
         :param task_name     Name of new task.
         :return              Dictionary with task object representation.
         """
         try:
-
             url = self.base_url + '/workspaces/' + workspace_id + '/projects/' + project_id + '/tasks/'
-
             payload = {'name': task_name, 'projectId': project_id}
             if request_data:
                 payload = {**payload, **request_data}
-
             return self.post(url, payload)
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
 
     def update_task(self,  workspace_id, project_id, task_id, request_data=None):
-        """Updates task in clockify.
+        """Updates task in Clockify.
         :param workspace_id  Id of workspace.
         :param project_id    Id of project.
         :param task_id       Id of task.
         :param request_data  Dictionary with request data.
         :return              Dictionary with task object representation.
         """
         try:
-
             url = self.base_url + '/workspaces/' + workspace_id + '/projects/' + project_id + '/tasks/' + task_id
-
             return self.put(url, request_data)
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
 
     def get_tasks(self, workspace_id, project_id, params=None):
-        """Gets list of tasks from clockify.
+        """Gets list of tasks from Clockify.
         :param workspace_id  Id of workspace.
         :param project_id    Id of project.
         :param params        Request URL query parameters.
@@ -67,10 +62,10 @@ def get_tasks(self, workspace_id, project_id, params=None):
             raise e
 
     def get_task(self, workspace_id, project_id, task_id):
-        """Gets task from clockify.
+        """Gets task from Clockify.
         :param workspace_id  Id of workspace.
         :param project_id    Id of project.
-        :param task_id        Request URL query parameters.
+        :param task_id       Request URL query parameters.
         :return              List with dictionaries with task object representation.
         """
         try:

clockify_api_client/models/time_entry.py

@@ -9,28 +9,40 @@ class TimeEntry(AbstractClockify):
     def __init__(self, api_key, api_url):
         super(TimeEntry, self).__init__(api_key=api_key, api_url=api_url)
 
-    def get_user_time_entries(self, workspace_id, user_id, params=None):
-        """Returns User time entries.
+    def get_time_entries(self, workspace_id, user_id, params=None):
+        """Returns user time entries.
         :param workspace_id Id of workspace.
         :param user_id      Id of user.
         :param params       Request URL query params.
         :return             List with dictionary representation of time entries from clockify.
         """
         try:
-            base_url = self.base_url.strip('v1/')
             if params:
                 url_params = urlencode(params, doseq=True)
-                url = base_url + '/workspaces/' + workspace_id + '/timeEntries/user/' + user_id + '?' + url_params
+                url = self.base_url + '/workspaces/' + workspace_id + '/user/' + user_id + '/time-entries?' + url_params
             else:
-                url = base_url + '/workspaces/' + workspace_id + '/timeEntries/user/' + user_id + '/'
+                url = self.base_url + '/workspaces/' + workspace_id + '/user/' + user_id + '/time-entries/'
             time_entries_list = self.get(url)
             return time_entries_list
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
 
+    def get_time_entry(self, workspace_id, time_entry_id):
+        """Gets specific time entry.
+        :param workspace_id  Id of workspace.
+        :param time_entry_id Id of time entry
+        :return              Dictionary representation of time entry.
+        """
+        try:
+            url = self.base_url + '/workspaces/' + workspace_id + '/time-entries/' + time_entry_id
+            return self.get(url)
+        except Exception as e:
+            logging.error("API error: {0}".format(e))
+            raise e
+
     def update_time_entry(self, workspace_id, entry_id, payload):
-        """Updates time entry in clockify with provided payload data.
+        """Updates time entry in Clockify with provided payload data.
         :param workspace_id Id of workspace.
         :param entry_id     Id of time entry.
         :param payload      Dictionary with payload data for update.
@@ -44,15 +56,16 @@ def update_time_entry(self, workspace_id, entry_id, payload):
             logging.error("API error: {0}".format(e))
             raise e
 
-    def add_new_time_entry(self, workspace_id, user_id, payload):
-        """Adds time entry in clockify with provided payload data.
+    def add_time_entry(self, workspace_id, user_id, payload):
+        """Adds time entry in Clockify with provided payload data.
+        Paid feature, workspace need to have active paid subscription.
         :param workspace_id Id of workspace.
         :param user_id      Id of workspace.
         :param payload      Dictionary with payload data for update.
         :return             Updated time entry.
         """
         try:
-            url = self.base_url + '/workspaces/' + workspace_id + '/user/' + user_id + '/time-entries'
+            url = self.base_url + '/workspaces/' + workspace_id + '/user/' + user_id + '/time-entries/'
             time_entry = self.post(url, payload)
             return time_entry
         except Exception as e:

clockify_api_client/models/user.py

@@ -9,22 +9,23 @@ class User(AbstractClockify):
     def __init__(self, api_key, api_url):
         super(User, self).__init__(api_key=api_key, api_url=api_url)
 
-    def get_user(self, user_id):
-        """Get user by ID.
-        :param user_id  ID of user.
-        :return         User dictionary representation."""
+    def get_current_user(self):
+        """Get user by paired with API key.
+        :return User dictionary representation.
+        """
         try:
-            url = self.base_url + '/users/' + str(user_id)
+            url = self.base_url + '/user/'
             return self.get(url)
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
 
-    def get_all_workspace_users(self, workspace_id, params=None):
+    def get_users(self, workspace_id, params=None):
         """Returns list of all users in given workspace.
         :param workspace_id Id of workspace.
         :param params       Request URL query params.
-        :return             List of Users dictionary representation."""
+        :return             List of Users dictionary representation.
+        """
         try:
             if params:
                 params = urlencode(params, doseq=True)
@@ -36,17 +37,43 @@ def get_all_workspace_users(self, workspace_id, params=None):
             logging.error("API error: {0}".format(e))
             raise e
 
-    def add_new_user(self, workspace_id, email):
+    def add_user(self, workspace_id, email):
         """Adds new user into workspace.
         :param workspace_id Id of workspace.
         :param email        Email of new user.
         :return             Dictionary representation of user."""
         try:
-            url = self.base_url + '/workspaces/' + workspace_id + '/users'
+            url = self.base_url + '/workspaces/' + workspace_id + '/users/'
             emails = list()
             emails.append(email)
             data = {'emails': emails}
             return self.post(url, data)
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e
+
+    def update_user(self, workspace_id, user_id, payload):
+        """Adds new user into workspace.
+        :param workspace_id Id of workspace.
+        :param user_id      User Id.
+        :param payload      User data to update.
+        :return             Dictionary representation of user.
+        """
+        try:
+            url = self.base_url + '/workspaces/' + workspace_id + '/users/' + user_id
+            return self.put(url, payload)
+        except Exception as e:
+            logging.error("API error: {0}".format(e))
+            raise e
+
+    def remove_user(self, workspace_id, user_id):
+        """Removes user from workspace.
+        :param workspace_id Id of workspace.
+        :param user_id      User Id.
+        """
+        try:
+            url = self.base_url + '/workspaces/' + workspace_id + '/users/' + user_id
+            return self.delete(url)
+        except Exception as e:
+            logging.error("API error: {0}".format(e))
+            raise e

clockify_api_client/models/workspace.py

@@ -10,23 +10,11 @@ def __init__(self, api_key, api_url):
 
     def get_workspaces(self):
         """Returns all workspaces.
-        :return List of Workspaces in dictionary representation."""
+        :return List of Workspaces in dictionary representation.
+        """
         try:
             url = self.base_url + '/workspaces/'
             return self.get(url)
-
-        except Exception as e:
-            logging.error("API error: {0}".format(e))
-            raise e
-
-    def create_new_workspace(self, name):
-        """Creates new workspace with given name.
-        :return Workspace dictionary representation."""
-        try:
-            url = self.base_url + '/workspaces/'
-            data = {'name': name}
-            return self.post(url, data)
-
         except Exception as e:
             logging.error("API error: {0}".format(e))
             raise e

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name='clockify-api-client',
-    version='0.0.11',
+    version='0.1.0',
     author="Michael Bláha",
     author_email="[email protected]",
     description="Simple python API client for clockify. Inspired by https://pypi.org/project/clockify/library.",