Merge pull request #10 from soda480/0.0.7

Add version parameter and disable chunkedencodingerror retry

build.py

@@ -34,7 +34,7 @@
 ]
 summary = 'An advanced REST client for the GitHub API'
 url = 'https://github.com/soda480/github3api'
-version = '0.0.6'
+version = '0.0.7'
 default_task = [
     'clean',
     'analyze',

src/main/python/github3api/githubapi.py

@@ -27,6 +27,7 @@
 logging.getLogger('urllib3.connectionpool').setLevel(logging.CRITICAL)
 
 HOSTNAME = 'api.github.com'
+VERSION = 'v3'
 
 
 class GitHubAPI(RESTclient):
@@ -36,6 +37,7 @@ class GitHubAPI(RESTclient):
     def __init__(self, **kwargs):
         logger.debug('executing GitHubAPI constructor')
         hostname = kwargs.pop('hostname', HOSTNAME)
+        self.version = kwargs.pop('version', VERSION)
         super(GitHubAPI, self).__init__(hostname, **kwargs)
 
     def get_response(self, response, **kwargs):
@@ -50,7 +52,7 @@ def get_headers(self, **kwargs):
         """ return headers to pass to requests method
         """
         headers = super(GitHubAPI, self).get_headers(**kwargs)
-        headers['Accept'] = 'application/vnd.github.v3+json'
+        headers['Accept'] = f'application/vnd.github.{self.version}+json'
         return headers
 
     def _get_next_endpoint(self, link_header):
@@ -175,7 +177,7 @@ def retry_ratelimit_error(exception):
         return False
 
     @staticmethod
-    def retry_chunkedencodingerror_error(exception):
+    def _retry_chunkedencodingerror_error(exception):
         """ return True if exception is ChunkedEncodingError, False otherwise
             retry:
                 wait_fixed:10000

src/unittest/python/test_githubapi.py

@@ -165,6 +165,11 @@ def test__get_headers_Should_SetAcceptHeader_When_Called(self, *patches):
         result = client.get_headers()
         self.assertEqual(result['Accept'], 'application/vnd.github.v3+json')
 
+    def test__get_headers_Should_SetAcceptHeader_When_Version(self, *patches):
+        client = GitHubAPI(bearer_token='bearer-token', version='v2')
+        result = client.get_headers()
+        self.assertEqual(result['Accept'], 'application/vnd.github.v2+json')
+
     def test__get_next_endpoint_Should_ReturnNone_When_NoLinkHeader(self, *patches):
         client = GitHubAPI(bearer_token='bearer-token')
         self.assertIsNone(client._get_next_endpoint(None))
@@ -328,11 +333,11 @@ def test__get_client_Should_CallAndReturnExpected_When_Called(self, githubapi_pa
     def test__get_retries_Should_ReturnExpected_When_Called(self, *patches):
         client = GitHubAPI(bearer_token='bearer-token')
         expected_retries = [
-            {
-                'retry_on_exception': client.retry_chunkedencodingerror_error,
-                'stop_max_attempt_number': 120,
-                'wait_fixed': 10000
-            },
+            # {
+            #     'retry_on_exception': client.retry_chunkedencodingerror_error,
+            #     'stop_max_attempt_number': 120,
+            #     'wait_fixed': 10000
+            # },
             {
                 'retry_on_exception': client.retry_ratelimit_error,
                 'stop_max_attempt_number': 60,
@@ -344,8 +349,8 @@ def test__get_retries_Should_ReturnExpected_When_Called(self, *patches):
 
     def test__retry_chunkedencodingerror_error_Should_Return_False_When_NotChunkEncodingError(self, *patches):
 
-        self.assertFalse(GitHubAPI.retry_chunkedencodingerror_error(Exception('test')))
+        self.assertFalse(GitHubAPI._retry_chunkedencodingerror_error(Exception('test')))
 
     def test__retry_chunkedencodingerror_error_Should_Return_True_When_ChunkEncodingError(self, *patches):
 
-        self.assertTrue(GitHubAPI.retry_chunkedencodingerror_error(ChunkedEncodingError()))
+        self.assertTrue(GitHubAPI._retry_chunkedencodingerror_error(ChunkedEncodingError()))