Merge pull request #13 from corywright/pass-headers-to-requests

Add ability to pass additional headers to the api request

Author: anguenot

HISTORY.rst

@@ -7,6 +7,7 @@ History
 
 * Force iland API v0.8.
 * Update dev requirements.
+* Add support for passing additional headers with api requests.
 
 0.7.4 (2017-05-26)
 ------------------

iland/api.py

@@ -112,7 +112,7 @@ def _get_access_token_string(self):
         token_string = self._get_access_token()['access_token']
         return token_string
 
-    def _do_request(self, rpath, verb='GET', form_data=None):
+    def _do_request(self, rpath, verb='GET', form_data=None, headers=None):
         self._refresh_token()
         data = None
         if form_data is not None:
@@ -121,14 +121,24 @@ def _do_request(self, rpath, verb='GET', form_data=None):
 
         LOG.info("Request %s rpath %s" % (verb, url))
 
-        headers = {
+        default_headers = {
             'Authorization': 'Bearer %s' % self._get_access_token_string(),
             'Content-Type': 'application/vnd.ilandcloud.api.v0.8+json',
             'Accept': 'application/vnd.ilandcloud.api.v0.8+json'
         }
 
+        merged_headers = default_headers.copy()
+
+        if headers and isinstance(headers, dict):
+            for header, value in headers.items():
+                # don't allow overriding of our default headers
+                if header in default_headers:
+                    LOG.warning("Header '%s' can't be overridden" % header)
+                else:
+                    merged_headers[header] = value
+
         request_params = {
-            'headers': headers,
+            'headers': merged_headers,
             'verify':  self._verify_ssl
         }
 
@@ -156,59 +166,69 @@ def _do_request(self, rpath, verb='GET', form_data=None):
             raise ApiException(json_obj)
         return json_obj
 
-    def get(self, rpath):
+    def get(self, rpath, headers=None):
         """ Perform a GET request against the iland cloud API given its
         resource path.
 
         `iland.Api` will refresh the access token if non valid.
 
         :param rpath: the resource path as a Python builtin String object
+        :param headers: an optional dictionary of http headers to send with \
+                        the request
         :raises: ApiException: API requests returns an error
         :raises: UnauthorizedException: credentials / grants invalids
         :return: a JSON Object or a list of JSON Objects.
         """
-        return self._do_request(rpath)
+        return self._do_request(rpath, headers=headers)
 
-    def put(self, rpath, form_data=None):
+    def put(self, rpath, form_data=None, headers=None):
         """ Perform a PUT request against the iland cloud API given its
         resource path.
 
         `iland.Api` will refresh the access token if non valid.
 
         :param rpath: the resource path as a Python builtin String object
         :param form_data: a Python builtin dict object
+        :param headers: an optional dictionary of http headers to send with \
+                        the request
         :raises: ApiException: API requests returns an error
         :raises: UnauthorizedException: credentials / grants invalids
         :return: a JSON Object or a list of JSON Objects.
         """
-        return self._do_request(rpath, verb='PUT', form_data=form_data)
+        return self._do_request(rpath, verb='PUT', form_data=form_data,
+                                headers=headers)
 
-    def post(self, rpath, form_data=None):
+    def post(self, rpath, form_data=None, headers=None):
         """ Perform a POST request against the iland cloud API given its
         resource path.
 
         `iland.Api` will refresh the access token if non valid.
 
         :param rpath: the resource path as a Python builtin String object
         :param form_data: a Python builtin dict object
+        :param headers: an optional dictionary of http headers to send with \
+                        the request
         :raises: ApiException: API requests returns an error
         :raises: UnauthorizedException: credentials / grants invalids
         :return: a JSON Object or a list of JSON Objects.
         """
-        return self._do_request(rpath, verb='POST', form_data=form_data)
+        return self._do_request(rpath, verb='POST', form_data=form_data,
+                                headers=headers)
 
-    def delete(self, rpath):
+    def delete(self, rpath, headers=None):
         """ Perform a DELETE request against the iland cloud API given its
         resource path.
 
         `iland.Api` will refresh the access token if non valid.
 
         :param rpath:  the resource path as a Python builtin String object
+        :param headers: an optional dictionary of http headers to send with \
+                        the request
         :raises: ApiException: API requests returns an error
         :raises: UnauthorizedException: credentials / grants invalids
         :return: a JSON Object or a list of JSON Objects.
         """
-        return self._do_request(rpath, verb='DELETE')
+        return self._do_request(rpath, verb='DELETE', headers=headers)
 
     def get_access_token(self):
         """ Returns the access token in use for this session.

tests/test_iland.py

@@ -291,3 +291,29 @@ def test_with_default_base_url(self):
                   status_code=200)
             req = self.api.get(rpath)
             self.assertEquals(user_data, req)
+
+    def test_get_with_extra_header(self):
+        with requests_mock.mock() as m:
+            m.post(iland.ACCESS_URL,
+                   text=json.dumps(VALID_TOKEN_PAYLOAD),
+                   status_code=200)
+            rpath = '/user/jchirac'
+            user_data = {'username': 'jchirac'}
+            m.get(BASE_URL + rpath, text='XXXXX' + json.dumps(user_data),
+                  request_headers={'Host': 'api.ilandcloud.com'},
+                  status_code=200)
+            req = self.api.get(rpath, headers={'Host': 'api.ilandcloud.com'})
+            self.assertEquals(user_data, req)
+
+    def test_get_with_extra_disallowed_header(self):
+        with requests_mock.mock() as m:
+            m.post(iland.ACCESS_URL,
+                   text=json.dumps(VALID_TOKEN_PAYLOAD),
+                   status_code=200)
+            rpath = '/user/jchirac'
+            user_data = {'username': 'jchirac'}
+            m.get(BASE_URL + rpath, text='XXXXX' + json.dumps(user_data),
+                  status_code=200)
+            # Set Accept to text/csv but it's ignored by api, so we get json
+            req = self.api.get(rpath, headers={'Accept': 'text/csv'})
+            self.assertEquals(user_data, req)

tests/test_iland_int.py

@@ -104,6 +104,18 @@ def test_put_delete(self):
         updated_md = self._api.get('/vdc/' + vdc_uuid + '/metadata')
         self.assertEquals(len(updated_md), 0)
 
+    def test_get_with_host_header(self):
+        user = self._api.get('/user/' + USERNAME,
+                             headers={'Host': 'api.ilandcloud.com'})
+        self.assertEqual(USERNAME, user.get('name'))
+        self.assertTrue(len(user.keys()) > 5)
+
+    def test_get_with_disallowed_header(self):
+        user = self._api.get('/user/' + USERNAME,
+                             headers={'Accept': 'text/csv'})
+        self.assertEqual(USERNAME, user.get('name'))
+        self.assertTrue(len(user.keys()) > 5)
+
     def test_refresh_token(self):
         self._api.login()
         self.assertIsNotNone(self._api.get_access_token())