New methods in: Jira [Tempo], Bitbucket (#430)

* Bitbucket: add get_users; add example; add to documentation

* Jira: add new Tempo method; update docs for new methods; add example

Co-authored-by: Gonchik Tsymzhitov <[email protected]>

Author: djachkov

atlassian/bitbucket.py

@@ -1659,7 +1659,14 @@ def get_lfs_repo_status(self, project_key, repo):
         return self.get(url)
 
     def get_users(self, user_filter=None):
-        url = "/rest/api/1.0/users"
-        if user_filter: 
-            url += "?filter={}".format(user_filter)
-        return self.get(url)
+        """
+        Get list of bitbucket users. 
+        Use 'user_filter' for get specific users.
+        :user_filter: str
+        """
+        url = "rest/api/1.0/users"
+        params = {}
+        if user_filter:
+            params['filter'] = user_filter
+        return self.get(url, params=params)
+

atlassian/jira.py

@@ -2054,6 +2054,45 @@ def tempo_timesheets_get_worklogs(self, date_from=None, date_to=None, username=N
         url = 'rest/tempo-timesheets/3/worklogs/'
         return self.get(url, params=params)
 
+    def tempo_4_timesheets_find_worklogs(self, **params):
+        """
+        Find existing worklogs with searching parameters.
+        NOTE: check if you are using correct types for the parameters!
+        :param from: string From Date
+        :param to: string To Date
+        :param worker: Array of strings
+        :param taskId: Array of integers
+        :param taskKey: Array of strings
+        :param projectId: Array of integers
+        :param projectKey: Array of strings
+        :param teamId: Array of integers
+        :param roleId: Array of integers
+        :param accountId: Array of integers
+        :param accountKey: Array of strings
+        :param filterId: Array of integers
+        :param customerId: Array of integers
+        :param categoryId: Array of integers
+        :param categoryTypeId: Array of integers
+        :param epicKey: Array of strings
+        :param updatedFrom: string
+        :param includeSubtasks: boolean
+        :param pageNo: integer
+        :param maxResults: integer
+        :param offset: integer
+        """
+    
+        url = "rest/tempo-timesheets/4/worklogs/search"
+        return self.post(url, data=params)
+
+    def tempo_timesheets_get_worklogs_by_issue(self, issue):
+        """
+        Get Tempo timesheet worklog by issue key or id.
+        :param issue: Issue key or Id
+        :return:
+        """
+        url = "rest/tempo-timesheets/4/worklogs/jira/issue/{issue}".format(issue=issue)
+        return self.get(url)
+
     def tempo_timesheets_write_worklog(self, worker, started, time_spend_in_seconds, issue_id, comment=None):
         """
         Log work for user

docs/jira.rst

@@ -188,19 +188,19 @@ Manage issues
 
     # Set issue status by transition_id
     jira.set_issue_status_by_transition_id(issue_key, transition_id)
-    
+
     # Get issue status
     jira.get_issue_status(issue_key)
-    
+
     # Create or Update Issue Links
     jira.create_or_update_issue_remote_links(issue_key, link_url, title, global_id=None, relationship=None)
-    
+
     # Get Issue Link by link ID
     jira.get_issue_remote_link_by_id(issue_key, link_id)
-    
+
     # Update Issue Link by link ID
     jira.update_issue_remote_link_by_id(issue_key, link_id, url, title, global_id=None, relationship=None)
-    
+
     # Delete Issue Links
     jira.delete_issue_remote_link_by_id(issue_key, link_id)
 
@@ -275,3 +275,38 @@ Issue security schemes
     # user has the administrative permission.
     # Use only_levels=True for get the only levels entries
     jira.get_issue_security_scheme(scheme_id, only_levels=False)
+
+TEMPO
+----------------------
+.. code-block:: python
+
+    # Find existing worklogs with the search parameters.
+    # Look at the tempo docs for additional information:
+    # https://www.tempo.io/server-api-documentation/timesheets#operation/searchWorklogs
+    # NOTE: check if you are using correct types for the parameters!
+    #     :param from: string From Date
+    #     :param to: string To Date
+    #     :param worker: Array of strings
+    #     :param taskId: Array of integers
+    #     :param taskKey: Array of strings
+    #     :param projectId: Array of integers
+    #     :param projectKey: Array of strings
+    #     :param teamId: Array of integers
+    #     :param roleId: Array of integers
+    #     :param accountId: Array of integers
+    #     :param accountKey: Array of strings
+    #     :param filterId: Array of integers
+    #     :param customerId: Array of integers
+    #     :param categoryId: Array of integers
+    #     :param categoryTypeId: Array of integers
+    #     :param epicKey: Array of strings
+    #     :param updatedFrom: string
+    #     :param includeSubtasks: boolean
+    #     :param pageNo: integer
+    #     :param maxResults: integer
+    #     :param offset: integer
+    jira.tempo_4_timesheets_find_worklogs(**params)
+
+    # :PRIVATE:
+    # Get Tempo timesheet worklog by issue key or id.
+    jira.tempo_timesheets_get_worklogs_by_issue(issue)

examples/jira-tempo-timesheet-worklogs.py

@@ -0,0 +1,17 @@
+# coding=utf-8
+from atlassian import Jira
+from pprint import pprint
+import logging
+
+jira = Jira(
+    url='http://localhost:8080',
+    username='admin',
+    password='admin',
+    advanced_mode=True  #  You can use it without advanced mode. 
+    )
+
+logging.basicConfig(level=logging.DEBUG)
+# deprecated_issue_worklog = jira.tempo_timesheets_get_worklogs_by_issue("PROJ-1234")
+latest_issue_worklog = jira.tempo_4_timesheets_find_worklogs(taskKey=["PROJ-1234"])
+# pprint(deprecated_issue_worklog.json())
+pprint(latest_issue_worklog.json())