[Bitbucket] Add OO interface for projects and repositories in bitbucket server. (#640)

Author: Spacetown

atlassian-python-api.code-workspace

@@ -11,6 +11,12 @@
 			"**/__pycache__": true,
 			"**/*.pyc": true,
 			"atlassian_python_api.egg-info": true
+		},
+		"files.associations": {
+			"DELETE": "python",
+			"GET": "python",
+			"POST": "python",
+			"PUT": "python",
 		}
 	}
 }

atlassian/bitbucket/__init__.py

@@ -10,8 +10,6 @@
 
 
 class Bitbucket(BitbucketBase):
-    bulk_headers = {"Content-Type": "application/vnd.atl.bitbucket.bulk+json"}
-
     def __init__(self, url, *args, **kwargs):
         if "cloud" not in kwargs and ("bitbucket.org" in url):
             kwargs["cloud"] = True

atlassian/bitbucket/base.py

@@ -1,12 +1,11 @@
 # coding=utf-8
-import copy
-
-from pprint import PrettyPrinter
 
 from ..rest_client import AtlassianRestAPI
 
 
 class BitbucketBase(AtlassianRestAPI):
+    bulk_headers = {"Content-Type": "application/vnd.atl.bitbucket.bulk+json"}
+
     def __init__(self, url, *args, **kwargs):
         """
         Init the rest api wrapper
@@ -16,28 +15,19 @@ def __init__(self, url, *args, **kwargs):
 
         :return: nothing
         """
-        if "data" in kwargs:
-            self.__data = kwargs.pop("data")
-            expected_type = kwargs.pop("expected_type")
-            if not self.get_data("type") == expected_type:
-                raise ValueError(
-                    "Expected type of data is [{}], got [{}].".format(expected_type, self.get_data("type"))
-                )
-        if url is None:
-            url = self.get_link("self")
         super(BitbucketBase, self).__init__(url, *args, **kwargs)
 
-    def __str__(self):
-        return PrettyPrinter(indent=4).pformat(self.__data)
-
     def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, absolute=False):
         """
         Used to get the paged data
         :param url:       The url to retrieve.
         :param params:    The parameters (optional).
         :param data:      The data (optional).
+        :param flags:     The flags (optional).
+        :param trailing:  If True, a trailing slash is added to the url (optional).
+        :param absolute:  If True, the url is used absolute and not relative to the root (optional).
 
-        :return: nothing
+        :return: A generator for the project objects
         """
 
         if params is None:
@@ -48,7 +38,15 @@ def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, abs
             if "values" not in response:
                 return
 
-            for value in response.get("values", []):
+            values = response.get("values", [])
+            if not response.get("size", -1) == len(values):
+                raise AssertionError(
+                    "Wrong response for url [{}], the size attribute doesn't match the number of recieved values:\n{}".format(
+                        self.url, response
+                    )
+                )
+
+            for value in values:
                 yield value
 
             if self.cloud:
@@ -72,20 +70,3 @@ def _new_session_args(self):
             api_root=self.api_root,
             api_version=self.api_version,
         )
-
-    def update(self, **kwargs):
-        """
-        Fields not present in the request body are ignored.
-        """
-        self.__data = super(BitbucketBase, self).put(None, data=kwargs)
-        return self
-
-    @property
-    def data(self):
-        return copy.copy(self.__data)
-
-    def get_data(self, id):
-        return copy.copy(self.__data[id])
-
-    def get_link(self, link):
-        return self.__data["links"][link]["href"]

atlassian/bitbucket/cloud/__init__.py

@@ -6,8 +6,6 @@
 
 
 class Cloud(BitbucketCloudBase):
-    bulk_headers = {"Content-Type": "application/vnd.atl.bitbucket.bulk+json"}
-
     def __init__(self, url, *args, **kwargs):
         kwargs["cloud"] = True
         kwargs["api_root"] = None

atlassian/bitbucket/cloud/base.py

@@ -1,4 +1,7 @@
 # coding=utf-8
+import copy
+
+from pprint import PrettyPrinter
 
 from ..base import BitbucketBase
 
@@ -9,20 +12,35 @@ def __init__(self, url, *args, **kwargs):
         Init the rest api wrapper
         :param url:       The base url used for the rest api.
         :param *args:     The fixed arguments for the AtlassianRestApi.
-        :param **kwargs:  The fixed arguments for the AtlassianRestApi.
+        :param **kwargs:  The keyword arguments for the AtlassianRestApi.
 
         :return: nothing
         """
+        if "data" in kwargs:
+            self.__data = kwargs.pop("data")
+            expected_type = kwargs.pop("expected_type")
+            if not self.get_data("type") == expected_type:
+                raise ValueError(
+                    "Expected type of data is [{}], got [{}].".format(expected_type, self.get_data("type"))
+                )
+        if url is None:
+            url = self.get_link("self")
         super(BitbucketCloudBase, self).__init__(url, *args, **kwargs)
 
+    def __str__(self):
+        return PrettyPrinter(indent=4).pformat(self.__data)
+
     def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, absolute=False):
         """
         Used to get the paged data
         :param url:       The url to retrieve.
         :param params:    The parameters (optional).
         :param data:      The data (optional).
+        :param flags:     The flags (optional).
+        :param trailing:  If True, a trailing slash is added to the url (optional).
+        :param absolute:  If True, the url is used absolute and not relative to the root (optional).
 
-        :return: nothing
+        :return: A generator for the project objects
         """
 
         if params is None:
@@ -40,7 +58,15 @@ def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, abs
             if "values" not in response:
                 return
 
-            for value in response.get("values", []):
+            values = response.get("values", [])
+            if not response.get("size", -1) == len(values):
+                raise AssertionError(
+                    "Wrong response for url [{}], the size attribute doesn't match the number of recieved values:\n{}".format(
+                        self.url, response
+                    )
+                )
+
+            for value in values:
                 yield value
 
             url = response.get("next")
@@ -50,3 +76,20 @@ def _get_paged(self, url, params=None, data=None, flags=None, trailing=None, abs
             absolute = True
 
         return
+
+    def update(self, **kwargs):
+        """
+        Fields not present in the request body are ignored.
+        """
+        self.__data = super(BitbucketBase, self).put(None, data=kwargs)
+        return self
+
+    @property
+    def data(self):
+        return copy.copy(self.__data)
+
+    def get_data(self, id):
+        return copy.copy(self.__data[id])
+
+    def get_link(self, link):
+        return self.__data["links"][link]["href"]

atlassian/bitbucket/cloud/repositories/__init__.py

@@ -23,7 +23,7 @@ def __init__(self, url, *args, **kwargs):
 
     def each(self, after=None, role=None, q=None, sort=None):
         """
-        Returns a list of repositories accessible by the authenticated user.
+        Get all repositories matching the criteria.
 
         The result can be narrowed down based on the authenticated user"s role.
         E.g. with ?role=contributor, only those repositories that the authenticated user has write access to
@@ -44,7 +44,6 @@ def each(self, after=None, role=None, q=None, sort=None):
 
         :return: A generator for the Rorkspace objects
         """
-        url = None
         if q is not None and role is None:
             raise ValueError("Argument [q] requires argument [role].")
 
@@ -57,7 +56,7 @@ def each(self, after=None, role=None, q=None, sort=None):
             params["q"] = q
         if sort is not None:
             params["sort"] = sort
-        for repository in self._get_paged(url, params):
+        for repository in self._get_paged(None, params):
             yield self._get_repository_object(repository)
 
 
@@ -67,7 +66,7 @@ def __init__(self, url, *args, **kwargs):
 
     def each(self, role=None, q=None, sort=None):
         """
-        Returns a list of repositories which belong to the workspace.
+        Get all repositories in the workspace matching the criteria.
 
         :param role: string: Filters the workspaces based on the authenticated user"s role on each workspace.
                              * member: returns a list of all the workspaces which the caller is a member of
@@ -82,15 +81,14 @@ def each(self, role=None, q=None, sort=None):
 
         :return: A generator for the Rorkspace objects
         """
-        url = None
         params = {}
         if role is not None:
             params["role"] = role
         if q is not None:
             params["q"] = q
         if sort is not None:
             params["sort"] = sort
-        for repository in self._get_paged(url, params):
+        for repository in self._get_paged(None, params):
             yield self._get_object(repository)
 
     def get(self, repository, by="slug"):
@@ -120,18 +118,17 @@ def __init__(self, url, *args, **kwargs):
 
     def each(self, sort=None):
         """
-        Returns a list of repositories which belong to the project.
+        Get all repositories in the project matching the criteria.
 
         :param sort: string: Name of a response property to sort results.
                              See https://developer.atlassian.com/bitbucket/api/2/reference/meta/filtering for details.
 
         :return: A generator for the Rorkspace objects
         """
-        url = None
         params = {}
         if sort is not None:
             params["sort"] = sort
-        for repository in self._get_paged(url, params):
+        for repository in self._get_paged(None, params):
             yield self._get_object(repository)
 
     def get(self, repository, by="slug"):

atlassian/bitbucket/cloud/repositories/branchRestrictions.py

@@ -7,7 +7,7 @@ class BranchRestrictions(BitbucketCloudBase):
     def __init__(self, url, *args, **kwargs):
         super(BranchRestrictions, self).__init__(url, *args, **kwargs)
 
-    def _get_object(self, data):
+    def __get_object(self, data):
         if "errors" in data:
             return
         return BranchRestriction(data, **self._new_session_args)
@@ -63,7 +63,7 @@ def create(
         if value is not None:
             data["value"] = value
 
-        return self._get_object(self.post(None, data=data))
+        return self.__get_object(self.post(None, data=data))
 
     def each(self, kind=None, pattern=None, q=None, sort=None):
         """
@@ -88,7 +88,7 @@ def each(self, kind=None, pattern=None, q=None, sort=None):
         if q is not None:
             params["q"] = q
         for branch_restriction in self._get_paged(None, params=params):
-            yield self._get_object(branch_restriction)
+            yield self.__get_object(branch_restriction)
 
         return
 
@@ -100,7 +100,7 @@ def get(self, id):
 
         :return: The requested BranchRestriction objects
         """
-        return self._get_object(super(BranchRestrictions, self).get(id))
+        return self.__get_object(super(BranchRestrictions, self).get(id))
 
 
 class BranchRestriction(BitbucketCloudBase):

atlassian/bitbucket/cloud/repositories/defaultReviewers.py

@@ -9,7 +9,7 @@ class DefaultReviewers(BitbucketCloudBase):
     def __init__(self, url, *args, **kwargs):
         super(DefaultReviewers, self).__init__(url, *args, **kwargs)
 
-    def _get_object(self, data):
+    def __get_object(self, data):
         if "errors" in data:
             return
         return DefaultReviewer(self.url_joiner(self.url, data["display_name"]), data, **self._new_session_args)
@@ -25,7 +25,7 @@ def add(self, user):
         :return: The added DefaultReviewer object
         """
         # the mention_id parameter is undocumented but if missed, leads to 400 statuses
-        return self._get_object(self.put(user, data={"mention_id": user}))
+        return self.__get_object(self.put(user, data={"mention_id": user}))
 
     def each(self, q=None, sort=None):
         """
@@ -46,7 +46,7 @@ def each(self, q=None, sort=None):
         if q is not None:
             params["q"] = q
         for default_reviewer in self._get_paged(None, params=params):
-            yield self._get_object(default_reviewer)
+            yield self.__get_object(default_reviewer)
 
         return
 
@@ -60,7 +60,7 @@ def get(self, user):
         """
         default_reviewer = None
         try:
-            default_reviewer = self._get_object(super(DefaultReviewers, self).get(user))
+            default_reviewer = self.__get_object(super(DefaultReviewers, self).get(user))
         except HTTPError as e:
             # A 404 indicates that the specified user is not a default reviewer.
             if not e.response.status_code == 404:

atlassian/bitbucket/cloud/repositories/issues.py

@@ -7,7 +7,7 @@ class Issues(BitbucketCloudBase):
     def __init__(self, url, *args, **kwargs):
         super(Issues, self).__init__(url, *args, **kwargs)
 
-    def _get_object(self, data):
+    def __get_object(self, data):
         if "errors" in data:
             return
         return Issue(data, **self._new_session_args)
@@ -29,7 +29,7 @@ def create(self, title, description, kind, priority):
             "priority": priority,
             "content": {"raw": description},
         }
-        return self._get_object(self.post(None, data=data))
+        return self.__get_object(self.post(None, data=data))
 
     def each(self, q=None, sort=None):
         """
@@ -48,7 +48,7 @@ def each(self, q=None, sort=None):
         if q is not None:
             params["q"] = q
         for issue in self._get_paged(None, params=params):
-            yield self._get_object(issue)
+            yield self.__get_object(issue)
 
         return
 
@@ -60,7 +60,7 @@ def get(self, id):
 
         :return: The requested Issue objects
         """
-        return self._get_object(super(Issues, self).get(id))
+        return self.__get_object(super(Issues, self).get(id))
 
 
 class Issue(BitbucketCloudBase):