Add api_version to Client config (#21)

* Add api_version to Client config

* add trailing commas

Author: Will Myers

CHANGELOG.md

@@ -1,4 +1,5 @@
 Current Version
+  - Add api_version to Client config
   - Add tox
   - Add support for python3.6
   - Add flake8 to test suite

pybutton/client.py

@@ -27,6 +27,7 @@ class Client(object):
               Defaults to None.
               (N.B: Button's API is only exposed through HTTPS. This option is
               provided purely as a convenience for testing and development.)
+            api_version: A specific API version label to use for the request
 
     Attributes:
         orders (pybutton.Resource): Resource for managing Button Orders.
@@ -63,4 +64,5 @@ def config_with_defaults(config):
         'timeout': config.get('timeout'),
         'hostname': config.get('hostname', 'api.usebutton.com'),
         'port': config.get('port', defaultPort),
+        'api_version': config.get('api_version'),
     }

pybutton/resources/resource.py

@@ -82,6 +82,23 @@ def api_delete(self, path):
         '''
         return self._api_request(path, 'DELETE')
 
+    def _headers(self):
+        '''Generate the HTTP headers used for a request
+        '''
+
+        api_key_bytes = '{0}:'.format(self.api_key).encode()
+        authorization = b64encode(api_key_bytes).decode()
+
+        headers = {
+            'Authorization': 'Basic {0}'.format(authorization),
+            'User-Agent': USER_AGENT,
+        }
+
+        if self.config['api_version']:
+            headers['X-Button-API-Version'] = self.config['api_version']
+
+        return headers
+
     def _api_request(self, path, method, data=None, query=None):
         '''Make an HTTP request
 
@@ -107,19 +124,12 @@ def _api_request(self, path, method, data=None, query=None):
             path,
             query,
         )
-        api_key_bytes = '{0}:'.format(self.api_key).encode()
-        authorization = b64encode(api_key_bytes).decode()
-
-        headers = {
-            'Authorization': 'Basic {0}'.format(authorization),
-            'User-Agent': USER_AGENT,
-        }
 
         try:
             resp = request(
                 url,
                 method,
-                headers,
+                self._headers(),
                 data,
                 self.config['timeout'],
             )

pybutton/test/client_test.py

@@ -44,6 +44,7 @@ def test_config(self):
             'port': 443,
             'secure': True,
             'timeout': None,
+            'api_version': None,
         })
 
         # Port and timeout overrides
@@ -57,6 +58,7 @@ def test_config(self):
             'port': 88,
             'secure': True,
             'timeout': 5,
+            'api_version': None,
         })
 
         # Hostname and secure overrides
@@ -70,4 +72,17 @@ def test_config(self):
             'port': 80,
             'secure': False,
             'timeout': None,
+            'api_version': None,
+        })
+
+        config = config_with_defaults({
+            'api_version': '2017-01-01',
+        })
+
+        self.assertEqual(config, {
+            'hostname': 'api.usebutton.com',
+            'port': 443,
+            'secure': True,
+            'timeout': None,
+            'api_version': '2017-01-01',
         })

pybutton/test/resources/resource_test.py

@@ -16,6 +16,7 @@
     'secure': True,
     'port': 443,
     'timeout': None,
+    'api_version': None,
 }
 
 
@@ -34,6 +35,7 @@ def test_api_request(self, request):
         self.assertEqual(args[1], 'GET')
         self.assertTrue(len(args[2]['User-Agent']) != 0)
         self.assertEqual(args[2]['Authorization'], 'Basic c2stWFhYOg==')
+        self.assertTrue('X-Button-API-Version' not in args[2])
         self.assertEqual(args[3], None)
 
     @patch('pybutton.resources.resource.request')
@@ -82,6 +84,23 @@ def test_api_request_with_data(self, request):
         self.assertEqual(args[2]['Authorization'], 'Basic c2stWFhYOg==')
         self.assertEqual(args[3], data)
 
+    @patch('pybutton.resources.resource.request')
+    def test_api_request_with_api_version(self, request):
+        config = {
+            'hostname': 'api.usebutton.com',
+            'secure': True,
+            'port': 443,
+            'timeout': None,
+            'api_version': '2017-01-01',
+        }
+
+        request.return_value = {'object': {}}
+        resource = Resource('sk-XXX', config)
+        resource._api_request('/v2/api', 'GET')
+
+        args = request.call_args[0]
+        self.assertEqual(args[2]['X-Button-API-Version'], '2017-01-01')
+
     @patch('pybutton.resources.resource.request')
     def test_api_request_with_error(self, request):
         data = {'c': 3}