Merge pull request #14 from Bynder/add/ua-header

[API-98] Send User-Agent header on API requests

.gitignore

@@ -91,3 +91,4 @@ ENV/
 
 # OS generated files
 .DS_Store
+.idea/

VERSION

@@ -1 +1 @@
-1.1.2
+1.1.3

bynder_sdk/oauth2.py

@@ -19,6 +19,8 @@ def __init__(self, bynder_domain, *args, **kwargs):
 
  super().__init__(*args, **kwargs)
 
+ self._set_ua_header()
+
  def authorization_url(self):
  state = ''.join([
  random.choice(string.ascii_letters + string.digits)

bynder_sdk/permanent_token.py

@@ -9,5 +9,7 @@ def __init__(self, bynder_domain, permanent_token):
 
  self.bynder_domain = bynder_domain
  self.headers.update({
- 'Authorization': 'Bearer {}'.format(permanent_token)
+ 'Authorization': 'Bearer {}'.format(permanent_token),
  })
+
+ self._set_ua_header()

bynder_sdk/util.py

@@ -1,3 +1,11 @@
+with open('VERSION') as fh:
+ SDK_VERSION = fh.read().strip()
+
+UA_HEADER = {
+ 'User-Agent': 'bynder-python-sdk/{}'.format(SDK_VERSION)
+}
+
+
 def api_endpoint_url(session, endpoint):
  return 'https://{}/api{}'.format(session.bynder_domain, endpoint)
 
@@ -12,7 +20,6 @@ def parse_json_for_response(response):
 class SessionMixin:
  def wrapped_request(self, func, endpoint, *args, **kwargs):
  endpoint = api_endpoint_url(self, endpoint)
-
  response = func(endpoint, *args, **kwargs)
  response.raise_for_status()
 
@@ -26,10 +33,14 @@ def post(self, url, *args, **kwargs):
  # Do not send the Authorization header to S3
  kwargs['headers'] = {'Authorization': None}
  return super().post(url, *args, **kwargs)
+
  return self.wrapped_request(super().post, url, *args, **kwargs)
 
  def put(self, url, *args, **kwargs):
  return self.wrapped_request(super().put, url, *args, **kwargs)
 
  def delete(self, url, *args, **kwargs):
  return self.wrapped_request(super().delete, url, *args, **kwargs)
+
+ def _set_ua_header(self):
+ self.headers.update(UA_HEADER)

test/oauth2_session_test.py

@@ -1,7 +1,7 @@
 from unittest import mock, TestCase
 
 from bynder_sdk.oauth2 import BynderOAuth2Session, oauth2_url
-from bynder_sdk.util import api_endpoint_url
+from bynder_sdk.util import api_endpoint_url, UA_HEADER
 
 
 TEST_DOMAIN = 'test.getbynder.com'
@@ -45,3 +45,7 @@ def test_fetch_token(self, mocked_func):
  include_client_id=True,
  code='code',
  )
+
+ def test_user_agent_header(self):
+ # The UA header is contained within the session headers
+ assert UA_HEADER.items() <= self.session.headers.items()