Merge pull request #1086 from pettermk/main

Add function for getting repos for github app

Author: staticdev

AUTHORS.rst

@@ -214,3 +214,5 @@ Contributors
 - Greg Gilbert (@greggilbert)
 
 - Philipp Heil (@zkdev)
+
+- Petter Kvalvaag (@pettermk)

src/github3/github.py

@@ -383,6 +383,35 @@ def app_installation_for_user(self, user):
         )
         return self._instance_or_null(apps.Installation, json)
 
+    @decorators.requires_app_installation_auth
+    def app_installation_repos(self, number=-1, etag=None):
+        """Retrieve repositories accessible by app installation.
+
+        .. versionadded:: 3.2.1
+
+        .. seealso::
+
+            `List repositories accessible to the app installation`_
+                API Documentation
+
+        :returns:
+            The repositories accessible to the app installation
+        :rtype:
+            :class:`~github3.repos.repo.ShortRepository`
+
+        .. _List repositories accessible to the app installation:
+            https://docs.github.com/en/rest/apps/installations#list-repositories-accessible-to-the-app-installation
+        """
+        url = self._build_url("installation", "repositories")
+        return self._iter(
+            count=int(number),
+            url=url,
+            cls=repo.ShortRepository,
+            params=None,
+            etag=etag,
+            list_key="repositories",
+        )
+
     @decorators.requires_app_bearer_auth
     def authenticated_app(self):
         """Retrieve information about the current app.

tests/cassettes/GitHub_app_installation_repos.json

@@ -0,0 +1 @@
+{"http_interactions": [{"response": {"url": "https://api.github.com/installation/repositories?per_page=100", "status": {"code": 200, "message": "OK"}, "body": {"base64_string": "H4sIAAAAAAAAA9Way27rNhCGX8XQtnYk+ZKTCChO+wTdpJsWhUHLtEVEEgWKcuAIeffOkLpZoWyLchfdnGPL/D+OSA45/JG/S4ftneDFX7+ufM+fOylJqBM4yXmR0o+FoBl35s6hiONt9csxWkmaS/eyBf9IqXCC0on5kaUAqJqBGPnL1Wa92nhzh5yIJGJbiBjaRFJmeeC6+mH+dGQyKnZFTkXIU0lT+RTyxC3cSv3z9OsKeEdRQRDswIMeLGMVSKuBlrttNJFM4l73ulvVum134HHMP0Dbj/UK3m1EOGYKwNLjeACISpfLiMJAQfhf+NIsl6NCUYLSxf+2bI+IHAZe0P2YcCoJBIPT+1W6uB4Uq9jloWCZZDwdFdaFEEBcHEnKPsloEAhz0GNAowJQAhDSE6yvUUqtKN1MsBMJzzgMgoaUnWBMx9N6UoDJc4aZ9yfMOI4wk3RL9gkm04HEOf2aO6pnCY3Ugznkzx1ruZeoe9pMHHT2Bpk8wyGZhYKqSYCuD1y8N31cTS41mHXS9DpCyo3xHZRDIoEYQnmnZ2sGaksX/q3WfwgJSXZcEMlvZfVwYBeQ0u1+xQUhKUmsA1ZigESc24+cEgOE5XlB71qXwy+rGLlbL/y0SHZ6N7pnuQ9jtRpiJHnOjiml1iPWAEq33ih3gqRhZI+s9aWrP6lZJUfrEFELiF3Md9YMOKBcBSjdPCL6OJDbKVEhEfUXQEEPk0JEfQOUYsK8qvAQ0ODgJJIwxdbx1Xq3rEYwJumxIEd7YgOA2cVz8kg+b1YLwznREgCH1Y9gu2LaRtUyMEJ9YEP+2g9hi2iBqgK4XlJceelOFaFeO0nYrTN5mFbJL5b0RCSuwz4Wv98uHa6HifrSbfdTvVlXZNvRrHbrOr4uvyqnrae+1rvlLxmREe5A0E1GBLUNtpK75Y5AafP09FRGlKgyNaFiQlZqNWCICCMozWzjK2s9VCIJkar0PWB4eyiFY0721mPZAACmp8w2Rq3uznMG9zTrwJS4S0tYDOUhT+33yJbQ5aZcsgML76n5h9PoAlL+zFka0jmJ4zmsSslCBusUrlE4Y1D0UftR0WoIH+7FuuSPKSxZ61EWVOtLV9/K9jSL+XnSjtJBYGJiIQ9XEiKhvl96/o+Ft1x4r29LL1ivA2/zF7Qpsv3NNlmRR8OYZ8TA9litXfgE9/jvF+nunQBv5SDK86gV/dZKAoOxUEnCGBZhL0vu6+vUP5uuyyC8iCc0g7pAWws5+4RP4Ft0TviQFymMLTz8IBJKTThR20d1VeAEKaQT4Ei+1XnqBFIUeGmDJ+0e0Hn4wd5ZtxFGkTf3MH2dajtKmBC8MlJ0VzyjadVXJyB9k8JoO79fRK++7OmBFLHc6qIXDSCSS3URzahI4A3gmIdgSqe6kup3wTVSh4zbh/789TXXrtLmxX9+fVk3phLGspURw4L4wlJSvs8qO6t7X93iu6VUNwM5ej/+j5elv3m2NJUq9RRTqRPPjat4p+U4Y6kzMpUfhWM3ylrqISaZSw1rmr3UYB5oMLXMrjcFozXeYmpQo02mRqkOLuj8npsyXl3BRWm0DzKaOrFcuFQQVWU1/dEx3+DpAyynzlprE/nScvpd+U3QFxfnmeQzNJNnmPewMGf8oJb3SP/J2KveMO+xr77Lx/tPBsZ0/8kAfZj/ZGCP958MEGv/ycB6hP9kwFr6TwbSVP/JgJzkPxl4o/0nAwO2pin+0wDR3n8aAFr6TwO0Cf6TgTjRfzIQJ/hPBto0/8kA7HpYeLaM9J8MxA6iBd7vPw0TFQOQY8wiA61vFEHWQB1+v6VlQGLi9bG1v3OXa2Bgmvyh8f6TAfwo/8mAnug/GYnKvprmPxm4Vv6TgfMg/8lAtvSfDKQp/pMBN9V/MiAf5T8Z0P+J/2ToZ5L/ZOBN9Z8MyOv+E5pPC3/z5i2DtResVib/ab3w/cVy/eatAv812KyxTc9/2mATz0cby/8ReMtb/tP3OG/6T4OSW/7ToDC/6j99l8Frt/6TdnW0A+V7r/9XD2qjL3RgHvU9KPildtCsPKjqryCGTKh//gUm1zlH3CQAAA==", "encoding": "utf-8", "string": ""}, "headers": {"X-GitHub-Request-Id": "AA6C:551F:22CC15E:2BFE670:589E3E01", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "X-Content-Type-Options": "nosniff", "Cache-Control": "private, max-age=60, s-maxage=60", "X-RateLimit-Reset": "1486769170", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Date": "Fri, 10 Feb 2017 22:26:10 GMT", "Content-Type": "application/json; charset=utf-8", "Transfer-Encoding": "chunked", "X-XSS-Protection": "1; mode=block", "Content-Security-Policy": "default-src 'none'", "X-Served-By": "9e60649f02cd840ee8baa9960690f79f", "ETag": "W/\"76db007ba542433cdc6420dc03a50839\"", "Server": "GitHub.com", "X-Frame-Options": "deny", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "Access-Control-Allow-Origin": "*", "Status": "200 OK", "Content-Encoding": "gzip", "X-RateLimit-Limit": "5000", "X-RateLimit-Remaining": "4999", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP"}}, "request": {"method": "GET", "uri": "https://api.github.com/installation/repositories?per_page=100", "body": {"encoding": "utf-8", "string": ""}, "headers": {"Content-Type": "application/json", "Accept": "application/vnd.github.v3.full+json", "Connection": "keep-alive", "Accept-Encoding": "gzip, deflate", "Authorization": "Basic <BASIC_AUTH>", "User-Agent": "github3.py/1.0.0a4", "Accept-Charset": "utf-8"}}, "recorded_at": "2017-02-10T22:26:10"}], "recorded_with": "betamax/0.8.0"}

tests/integration/test_github.py

@@ -68,6 +68,15 @@ def test_authenticated_app(self):
 
         assert isinstance(app, github3.apps.App)
 
+    def test_app_installation_repos(self):
+        """Validate an app can retrieve its repositories."""
+        cassette_name = self.cassette_name("app_installation_repos")
+        with self.recorder.use_cassette(cassette_name):
+            self.app_installation_login()
+
+            for r in self.gh.app_installation_repos(number=100):
+                assert isinstance(r, github3.repos.ShortRepository)
+
     def test_authorize(self):
         """Test the ability to create an authorization."""
         from ..conftest import credentials