kallithea Changeset - 98d26beb0965

Changeset - 98d26beb0965

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

domruf - 9 years ago 2017-03-29 22:10:27
dominikruf@gmail.com

api: add optional branches, tags and bookmarks information to get_repo API data

Modified by Mads Kiilerich to make these revision names optional - there can be
a lot of them.

4 files changed with 51 insertions and 11 deletions:

docs/api/api.rst

kallithea/controllers/api/api.py

kallithea/model/db.py

kallithea/tests/api/api_base.py

0 comments (0 inline, 0 general)

docs/api/api.rst

➞

Show inline comments

@@ @@ -583,13 +583,14 @@ or that of a regular user with at least @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repo"
     args:     {
                 "repoid" : "<reponame or repo_id>"
                 "repoid" : "<reponame or repo_id>",
                 "with_revision_names": "<bool> = Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: None if repository does not exist or
@@ @@ -609,13 +610,13 @@ OUTPUT:: @@
                                        "author":   "<full_author>",
                                        "date":     "<date_time_of_commit>",
                                        "message":  "<commit_message>",
                                        "raw_id":   "<raw_id>",
                                        "revision": "<numeric_revision>",
                                        "short_id": "<short_id>"
+                                     }
+                                     },
                 "owner":             "<repo_owner>",
                 "fork_of":           "<name_of_fork_parent>",
                 "members" :     [
+                                  {
                                     "type":        "user",
                                     "user_id" :    "<user_id>",
@@ @@ -637,13 +638,13 @@ OUTPUT:: @@
                                     "id" :       "<usersgroupid>",
                                     "name" :     "<usersgroupname>",
                                     "active":    "<bool>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …
+                                ]
+                                ],
                  "followers":   [
+                                  {
                                     "user_id" :     "<user_id>",
                                     "username" :    "<username>",
                                     "api_key" :     "<api_key>",
                                     "firstname":    "<firstname>",
@@ @@ -654,13 +655,26 @@ OUTPUT:: @@
                                     "active" :      "<bool>",
                                     "admin" :       "<bool>",
                                     "ldap_dn" :     "<ldap_dn>",
                                     "last_login":   "<last_login>",
                                   },
                                   …
+                 ]
                                 ],
                  <if with_revision_names == True>
                  "tags": {
                             "<tagname>": "<raw_id>",
                             ...
                          },
                  "branches": {
                             "<branchname>": "<raw_id>",
                             ...
                          },
                  "bookmarks": {
                             "<bookmarkname>": "<raw_id>",
                             ...
                          },
+            }
     error:  null
 get_repos
 ^^^^^^^^^

kallithea/controllers/api/api.py

➞

Show inline comments

@@ @@ -1122,13 +1122,14 @@ class ApiController(JSONRPCController): @@
                 'failed to remove member from user group `%s`' % (
                     user_group.users_group_name,
+                )
+            )
     # permission check inside
     def get_repo(self, repoid):
     def get_repo(self, repoid,
                  with_revision_names=Optional(False)):
         """
         Gets an existing repository by it's name or repository_id. Members will return
         either users_group or user associated to that repository. This command can be
         executed only using api_key belonging to user with admin
         rights or regular user that have at least read access to repository.
@@ @@ -1172,14 +1173,26 @@ class ApiController(JSONRPCController): @@
                                     "name":     "<usergroup name>",
                                     "type" :    "user_group",
                                     "permission" : "usergroup.(read|write|admin)"
                                   },
                                   …
+                                ]
                  "followers":   [<user_obj>, ...]
+                 ]
                  "followers":   [<user_obj>, ...],
                  <if with_revision_names == True>
                  "tags": {
                             "<tagname>": "<raw_id>",
                             ...
                          },
                  "branches": {
                             "<branchname>": "<raw_id>",
                             ...
                          },
                  "bookmarks": {
                             "<bookmarkname>": "<raw_id>",
                             ...
                          },
+            }
+          }
           error :  null
         """
         repo = get_repo_or_error(repoid)
@@ @@ -1211,13 +1224,13 @@ class ApiController(JSONRPCController): @@
         followers = [
             uf.user.get_api_data()
             for uf in repo.followers
+        ]
         data = repo.get_api_data()
+        data = repo.get_api_data(with_revision_names=Optional.extract(with_revision_names))
         data['members'] = members
         data['followers'] = followers
         return data
     # permission check inside
     def get_repos(self):

kallithea/model/db.py

➞

Show inline comments

@@ @@ -1243,16 +1243,16 @@ class Repository(Base, BaseDbModel): @@
         :param repo_name:
         """
         from kallithea.lib.utils import is_valid_repo
         return is_valid_repo(repo_name, cls.base_path())
     def get_api_data(self):
+    def get_api_data(self, with_revision_names=False):
         """
         Common function for generating repo api data
         Common function for generating repo api data.
         Optionally, also return tags, branches and bookmarks.
         """
         repo = self
         data = dict(
             repo_id=repo.repo_id,
             repo_name=repo.repo_name,
             repo_type=repo.repo_type,
@@ @@ -1269,12 +1269,19 @@ class Repository(Base, BaseDbModel): @@
             last_changeset=repo.changeset_cache,
             locked_by=User.get(self.locked[0]).get_api_data() \
                 if self.locked[0] else None,
             locked_date=time_to_datetime(self.locked[1]) \
                 if self.locked[1] else None
+        )
         if with_revision_names:
             scm_repo = repo.scm_instance_no_cache()
             data.update(dict(
                 tags=scm_repo.tags,
                 branches=scm_repo.branches,
                 bookmarks=scm_repo.bookmarks,
             ))
         rc_config = Setting.get_app_settings()
         repository_fields = str2bool(rc_config.get('repository_fields'))
         if repository_fields:
             for f in self.extra_fields:
                 data[f.field_key_prefixed] = f.field_value

kallithea/tests/api/api_base.py

➞

Show inline comments

@@ @@ -773,12 +773,13 @@ class _BaseTestApi(object): @@
                                                 group_name=new_group,
                                                 perm='repository.read')
         Session().commit()
         id_, params = _build_data(self.apikey, 'get_repo',
                                   repoid=self.REPO)
         response = api_call(self, params)
         assert u"tags" not in response.json[u'result']
         repo = RepoModel().get_by_repo_name(self.REPO)
         ret = repo.get_api_data()
         members = []
         followers = []
@@ @@ -803,12 +804,17 @@ class _BaseTestApi(object): @@
         ret['followers'] = followers
         expected = ret
         self._compare_ok(id_, expected, given=response.body)
         fixture.destroy_user_group(new_group)
         id_, params = _build_data(self.apikey, 'get_repo', repoid=self.REPO,
                                   with_revision_names=True)
         response = api_call(self, params)
         assert u"v0.2.0" in response.json[u'result'][u'tags']
     @parametrize('grant_perm', [
         ('repository.admin'),
         ('repository.write'),
         ('repository.read'),
     ])
     def test_api_get_repo_by_non_admin(self, grant_perm):

0 comments (0 inline, 0 general)