[Bitbucket Cloud] Add basic pull request support (#655)

* Add basic pull request support for Bitbucket Cloud

* fixes for py2.7 support

* remove typing import

* - Rename DefaultReviewer to User
- PullRequest -> state replaced by
 is_declined, is_merged, is_open, is_superseded
 - Participant -> role replaced by is_participant, is_reviewer

* Participant -> state replaced by
has_approved/has_changes_requested

* Add comment, merge, approve, unapporve to PullRequest

* - Add raw_timeformat parameter
- PullRequest decline
- User placed in common
- DefaultReviewer inherits from User
- Use get_time() Method for date values

* - Fix decline API endpoint cant receive a reason
- Fix raw_timeformat in Bitbucket()

* use get_time()

* add const.py

* const correction

* add timeformat to const

* - Replaced raw_timeformat with timeformat_func
- Possibility to specify a lamda function for time convert

* fix flake8

* - Remove const.py
- timeformat_lambda centralized
- Remove duplicate approved() method in participant

* fix DefaultReviewer + test

* fix black

* add (un)request_changes , fix test

* - API doc links
- timeformat_lambda behavior changed as discussed in #655

* - use default merge strategy as default on pr merge
- CONF_TIMEFORMAT as class CONSTANT

* - remove default_merge_strategy
- fix decline()

* add unit tests

* fix py27

Author: sti0

atlassian/bitbucket/__init__.py

@@ -17,6 +17,7 @@ def __init__(self, url, *args, **kwargs):
             kwargs["api_version"] = "2.0" if "cloud" in kwargs and kwargs["cloud"] else "1.0"
         if "cloud" in kwargs:
             kwargs["api_root"] = "" if "api.bitbucket.org" in url else "rest/api"
+
         super(Bitbucket, self).__init__(url, *args, **kwargs)
 
     def markup_preview(self, data):

atlassian/bitbucket/base.py

@@ -1,9 +1,11 @@
 # coding=utf-8
 
+from datetime import datetime
 from ..rest_client import AtlassianRestAPI
 
 
 class BitbucketBase(AtlassianRestAPI):
+    CONF_TIMEFORMAT = "%Y-%m-%dT%H:%M:%S.%f%z"
     bulk_headers = {"Content-Type": "application/vnd.atl.bitbucket.bulk+json"}
 
     def __init__(self, url, *args, **kwargs):
@@ -15,6 +17,8 @@ def __init__(self, url, *args, **kwargs):
 
         :return: nothing
         """
+        self.timeformat_lambda = kwargs.pop("timeformat_lambda", lambda x: self._default_timeformat_lambda(x))
+        self._check_timeformat_lambda()
         super(BitbucketBase, self).__init__(url, *args, **kwargs)
 
     def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, absolute=False):
@@ -54,11 +58,37 @@ def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, abs
 
         return
 
+    def _check_timeformat_lambda(self):
+        LAMBDA = lambda: 0  # noqa: E731
+        if self.timeformat_lambda is None or (
+            isinstance(self.timeformat_lambda, type(LAMBDA)) and self.timeformat_lambda.__name__ == LAMBDA.__name__
+        ):
+            return True
+        else:
+            ValueError("Expected [None] or [lambda function] for argument [timeformat_func]")
+
+    @staticmethod
+    def _default_timeformat_lambda(timestamp):
+        return timestamp if isinstance(timestamp, datetime) else None
+
+    def get_time(self, id):
+        value_str = self.get_data(id)
+        if self.timeformat_lambda is None:
+            return value_str
+
+        if isinstance(value_str, str):
+            value = datetime.strptime(value_str, self.CONF_TIMEFORMAT)
+        else:
+            value = value_str
+
+        return self.timeformat_lambda(value)
+
     @property
     def _new_session_args(self):
         return dict(
             session=self._session,
             cloud=self.cloud,
             api_root=self.api_root,
             api_version=self.api_version,
+            timeformat_lambda=self.timeformat_lambda,
         )

atlassian/bitbucket/cloud/base.py

@@ -1,16 +1,16 @@
 # coding=utf-8
 import copy
-
 from pprint import PrettyPrinter
 
 from ..base import BitbucketBase
 
 
 class BitbucketCloudBase(BitbucketBase):
-    def __init__(self, url, *args, **kwargs):
+    def __init__(self, url, link="self", *args, **kwargs):
         """
         Init the rest api wrapper
         :param url:       The base url used for the rest api.
+        :param link:      Attribute to resolve a url based on input data. If None, no tries to receive an url from input data
         :param *args:     The fixed arguments for the AtlassianRestApi.
         :param **kwargs:  The keyword arguments for the AtlassianRestApi.
 
@@ -23,8 +23,9 @@ def __init__(self, url, *args, **kwargs):
                 raise ValueError(
                     "Expected type of data is [{}], got [{}].".format(expected_type, self.get_data("type"))
                 )
-        if url is None:
-            url = self.get_link("self")
+        if url is None and link is not None:
+            url = self.get_link(link)
+
         super(BitbucketCloudBase, self).__init__(url, *args, **kwargs)
 
     def __str__(self):

atlassian/bitbucket/cloud/common/__init__.py

@@ -0,0 +1 @@
+""" Bitbucket Cloud common package """

atlassian/bitbucket/cloud/common/users.py

@@ -0,0 +1,22 @@
+from ..base import BitbucketCloudBase
+
+
+class User(BitbucketCloudBase):
+    def __init__(self, url, data, *args, **kwargs):
+        super(User, self).__init__(url, *args, data=data, expected_type="user", **kwargs)
+
+    @property
+    def display_name(self):
+        return str(self.get_data("display_name"))
+
+    @property
+    def nickname(self):
+        return self.get_data("nickname")
+
+    @property
+    def account_id(self):
+        return self.get_data("account_id")
+
+    @property
+    def uuid(self):
+        return self.get_data("uuid")

atlassian/bitbucket/cloud/repositories/__init__.py

@@ -5,6 +5,7 @@
 from .branchRestrictions import BranchRestrictions
 from .defaultReviewers import DefaultReviewers
 from .pipelines import Pipelines
+from .pullRequests import PullRequests
 
 
 class RepositoriesBase(BitbucketCloudBase):
@@ -57,7 +58,7 @@ def each(self, after=None, role=None, q=None, sort=None):
         if sort is not None:
             params["sort"] = sort
         for repository in self._get_paged(None, params):
-            yield self._get_repository_object(repository)
+            yield self._get_object(repository)
 
 
 class WorkspaceRepositories(RepositoriesBase):
@@ -159,6 +160,7 @@ def __init__(self, data, *args, **kwargs):
         self.__default_reviewers = DefaultReviewers("{}/default-reviewers".format(self.url), **self._new_session_args)
         self.__issues = Issues("{}/issues".format(self.url), **self._new_session_args)
         self.__pipelines = Pipelines("{}/pipelines".format(self.url), **self._new_session_args)
+        self.__pullrequests = PullRequests("{}/pullrequests".format(self.url), **self._new_session_args)
 
     @property
     def branch_restrictions(self):
@@ -176,6 +178,10 @@ def issues(self):
     def pipelines(self):
         return self.__pipelines
 
+    @property
+    def pullrequests(self):
+        return self.__pullrequests
+
     @property
     def name(self):
         return self.get_data("name")

atlassian/bitbucket/cloud/repositories/defaultReviewers.py

@@ -3,6 +3,7 @@
 from requests import HTTPError
 
 from ..base import BitbucketCloudBase
+from ..common.users import User
 
 
 class DefaultReviewers(BitbucketCloudBase):
@@ -70,25 +71,9 @@ def get(self, user):
         return default_reviewer
 
 
-class DefaultReviewer(BitbucketCloudBase):
+class DefaultReviewer(User):
     def __init__(self, url, data, *args, **kwargs):
-        super(DefaultReviewer, self).__init__(url, *args, data=data, expected_type="user", **kwargs)
-
-    @property
-    def display_name(self):
-        return str(self.get_data("display_name"))
-
-    @property
-    def nickname(self):
-        return self.get_data("nickname")
-
-    @property
-    def account_id(self):
-        return self.get_data("account_id")
-
-    @property
-    def uuid(self):
-        return self.get_data("uuid")
+        super(DefaultReviewer, self).__init__(url, data, *args, **kwargs)
 
     def delete(self):
         """
@@ -97,4 +82,4 @@ def delete(self):
         data = super(DefaultReviewer, self).delete(None)
         if data is None or "errors" in data:
             return
-        return DefaultReviewer(self.url, data, **self._new_session_args)
+        return True

atlassian/bitbucket/cloud/repositories/issues.py

@@ -113,15 +113,15 @@ def content(self):
 
     @property
     def created_on(self):
-        return self.get_data("created_on")
+        return self.get_time("created_on")
 
     @property
     def edited_on(self):
-        return self.get_data("edited_on", "never edited")
+        return self.get_time("edited_on")
 
     @property
     def updated_on(self):
-        return self.get_data("updated_on", "never updated")
+        return self.get_time("updated_on")
 
     def delete(self):
         """

atlassian/bitbucket/cloud/repositories/pipelines.py

@@ -113,11 +113,11 @@ def build_seconds_used(self):
 
     @property
     def created_on(self):
-        return self.get_data("created_on")
+        return self.get_time("created_on")
 
     @property
     def completed_on(self):
-        return self.get_data("completed_on", "never completed")
+        return self.get_time("completed_on")
 
     def stop(self):
         return self.post("stopPipeline")
@@ -156,11 +156,11 @@ def run_number(self):
 
     @property
     def started_on(self):
-        return self.get_data("started_on")
+        return self.get_time("started_on")
 
     @property
     def completed_on(self):
-        return self.get_data("completed_on")
+        return self.get_time("completed_on")
 
     @property
     def duration_in_seconds(self):