Add session-specific conf. (#264)

Currently, configuration values like user-agent
and API urls are essentially global variables.

This commit adds config to the BoxSession, allowing
each session to override config values.

Author: Jeff-Meadows

HISTORY.rst

@@ -116,6 +116,7 @@ Release History
 - Added methods for configuring ``JWTAuth`` from config file: ``JWTAuth.from_settings_file`` and
   ``JWTAuth.from_settings_dictionary``.
 - Added ``network_response`` property to ``BoxOAuthException``.
+- API Configuration can now be done per ``BoxSession`` instance.
 
 **Other**
 

boxsdk/auth/oauth2.py

@@ -109,6 +109,7 @@ def __init__(
         self._box_device_id = box_device_id
         self._box_device_name = box_device_name
         self._closed = False
+        self._api_config = API()
 
     @property
     def access_token(self):
@@ -132,6 +133,14 @@ def closed(self):
         """
         return self._closed
 
+    @property
+    def api_config(self):
+        """
+
+        :rtype:     :class:`API`
+        """
+        return self._api_config
+
     def get_authorization_url(self, redirect_url):
         """
         Get the authorization url based on the client id and the redirect url passed in
@@ -162,7 +171,7 @@ def get_authorization_url(self, redirect_url):
         # encode the parameters as ASCII bytes.
         params = [(key.encode('utf-8'), value.encode('utf-8')) for (key, value) in params]
         query_string = urlencode(params)
-        return urlunsplit(('', '', API.OAUTH2_AUTHORIZE_URL, query_string, '')), csrf_token
+        return urlunsplit(('', '', self._api_config.OAUTH2_AUTHORIZE_URL, query_string, '')), csrf_token
 
     def authenticate(self, auth_code):
         """
@@ -320,7 +329,7 @@ def _execute_token_request(self, data, access_token, expect_refresh_token=True):
             :class:`TokenResponse`
         """
         self._check_closed()
-        url = '{base_auth_url}/token'.format(base_auth_url=API.OAUTH2_API_URL)
+        url = '{base_auth_url}/token'.format(base_auth_url=self._api_config.OAUTH2_API_URL)
         headers = {'content-type': 'application/x-www-form-urlencoded'}
         network_response = self._network_layer.request(
             'POST',
@@ -373,7 +382,7 @@ def revoke(self):
             token_to_revoke = access_token or refresh_token
             if token_to_revoke is None:
                 return
-            url = '{base_auth_url}/revoke'.format(base_auth_url=API.OAUTH2_API_URL)
+            url = '{base_auth_url}/revoke'.format(base_auth_url=self._api_config.OAUTH2_API_URL)
             network_response = self._network_layer.request(
                 'POST',
                 url,

boxsdk/client/client.py

@@ -4,7 +4,6 @@
 import json
 
 from ..auth.oauth2 import TokenResponse
-from ..config import API
 from ..session.box_session import BoxSession
 from ..network.default_network import DefaultNetwork
 from ..object.cloneable import Cloneable
@@ -166,7 +165,7 @@ def users(self, limit=None, offset=0, filter_term=None):
         :rtype:
             `list` of :class:`User`
         """
-        url = '{0}/users'.format(API.BASE_API_URL)
+        url = self.get_url('users')
         params = dict(offset=offset)
         if limit is not None:
             params['limit'] = limit
@@ -278,7 +277,7 @@ def groups(self):
         :rtype:
             `list` of :class:`Group`
         """
-        url = '{0}/groups'.format(API.BASE_API_URL)
+        url = self.get_url('groups')
         box_response = self._session.get(url)
         response = box_response.json()
         group_class = self.translator.translate('group')
@@ -304,7 +303,7 @@ def create_group(self, name):
         :raises:
             :class:`BoxAPIException` if current user doesn't have permissions to create a group.
         """
-        url = '{0}/groups'.format(API.BASE_API_URL)
+        url = self.get_url('groups')
         body_attributes = {
             'name': name,
         }
@@ -375,7 +374,7 @@ def get_shared_item(self, shared_link, password=None):
         """
         response = self.make_request(
             'GET',
-            '{0}/shared_items'.format(API.BASE_API_URL),
+            self.get_url('shared_items'),
             headers=get_shared_link_header(shared_link, password),
         ).json()
         return self.translator.translate(response['type'])(
@@ -425,7 +424,7 @@ def create_user(self, name, login=None, **user_attributes):
             https://box-content.readme.io/#create-an-enterprise-user for enterprise users
             or https://box-content.readme.io/docs/app-users for app users.
         """
-        url = '{0}/users'.format(API.BASE_API_URL)
+        url = self.get_url('users')
         user_attributes['name'] = name
         if login is not None:
             user_attributes['login'] = login
@@ -461,7 +460,7 @@ def downscope_token(self, scopes, item=None, additional_data=None):
         :rtype:
             :class:`TokenResponse`
         """
-        url = '{base_auth_url}/token'.format(base_auth_url=API.OAUTH2_API_URL)
+        url = '{base_auth_url}/token'.format(base_auth_url=self._session.api_config.OAUTH2_API_URL)
         data = {
             'subject_token': self.auth.access_token,
             'subject_token_type': 'urn:ietf:params:oauth:token-type:access_token',

boxsdk/object/file.py

@@ -2,7 +2,6 @@
 
 from __future__ import unicode_literals
 
-from boxsdk.config import API
 from .item import Item
 from ..util.api_call_decorator import api_call
 
@@ -122,7 +121,10 @@ def update_contents_with_stream(
         if preflight_check:
             self.preflight_check(size=preflight_expected_size)
 
-        url = self.get_url('content').replace(API.BASE_API_URL, API.UPLOAD_URL)
+        url = self.get_url('content').replace(
+            self._session.api_config.BASE_API_URL,
+            self._session.api_config.UPLOAD_URL,
+        )
         if upload_using_accelerator:
             accelerator_upload_url = self._get_accelerator_upload_url_for_update()
             if accelerator_upload_url:

boxsdk/object/folder.py

@@ -5,7 +5,6 @@
 import os
 from six import text_type
 
-from boxsdk.config import API
 from boxsdk.object.group import Group
 from boxsdk.object.item import Item
 from boxsdk.object.user import User
@@ -266,7 +265,7 @@ def upload_stream(
         if preflight_check:
             self.preflight_check(size=preflight_expected_size, name=file_name)
 
-        url = '{0}/files/content'.format(API.UPLOAD_URL)
+        url = '{0}/files/content'.format(self._session.api_config.UPLOAD_URL)
         if upload_using_accelerator:
             accelerator_upload_url = self._get_accelerator_upload_url_fow_new_uploads()
             if accelerator_upload_url:
@@ -418,7 +417,7 @@ def add_collaborator(self, collaborator, role, notify=False, can_view_path=False
             :class:`Collaboration`
         """
         collaborator_helper = _Collaborator(collaborator)
-        url = API.BASE_API_URL + '/collaborations'
+        url = self._session.get_url('collaborations')
         item = {'id': self._object_id, 'type': 'folder'}
         access_key, access_value = collaborator_helper.access
         accessible_by = {

boxsdk/object/group.py

@@ -5,7 +5,6 @@
 import json
 
 from .base_object import BaseObject
-from ..config import API
 from ..util.api_call_decorator import api_call
 
 
@@ -73,7 +72,7 @@ def add_member(self, user, role):
         :rtype:
             :class:`GroupMembership`
         """
-        url = '{0}/group_memberships'.format(API.BASE_API_URL)
+        url = self._session.get_url('group_memberships')
         body_attributes = {
             'user': {'id': user.object_id},
             'group': {'id': self.object_id},

boxsdk/object/item.py

@@ -4,7 +4,6 @@
 import json
 
 from .base_object import BaseObject
-from ..config import API
 from ..exception import BoxAPIException
 from .metadata import Metadata
 from ..util.api_call_decorator import api_call
@@ -27,7 +26,7 @@ def _get_accelerator_upload_url(self, file_id=None):
             `unicode` or None
         """
         endpoint = '{0}/content'.format(file_id) if file_id else 'content'
-        url = '{0}/files/{1}'.format(API.BASE_API_URL, endpoint)
+        url = '{0}/files/{1}'.format(self._session.api_config.BASE_API_URL, endpoint)
         try:
             response_json = self._session.options(
                 url=url,
@@ -63,7 +62,7 @@ def _preflight_check(self, size, name=None, file_id=None, parent_id=None):
             :class:`BoxAPIException` when preflight check fails.
         """
         endpoint = '{0}/content'.format(file_id) if file_id else 'content'
-        url = '{0}/files/{1}'.format(API.BASE_API_URL, endpoint)
+        url = '{0}/files/{1}'.format(self._session.api_config.BASE_API_URL, endpoint)
         data = {'size': size}
         if name:
             data['name'] = name

boxsdk/session/box_session.py

@@ -18,7 +18,16 @@ class BoxSession(object):
     Box API session. Provides auth, automatic retry of failed requests, and session renewal.
     """
 
-    def __init__(self, oauth, network_layer, default_headers=None, translator=None, default_network_request_kwargs=None):
+    def __init__(
+            self,
+            oauth,
+            network_layer,
+            default_headers=None,
+            translator=None,
+            default_network_request_kwargs=None,
+            api_config=None,
+            client_config=None,
+    ):
         """
         :param oauth:
             OAuth2 object used by the session to authorize requests.
@@ -43,13 +52,23 @@ def __init__(self, oauth, network_layer, default_headers=None, translator=None,
             when this session makes an API request.
         :type default_network_request_kwargs:
             `dict` or None
+        :param api_config:
+            Object containing URLs for the Box API.
+        :type api_config:
+            :class:`API`
+        :param client_config:
+            Object containing client information, including user agent string.
+        :type client_config:
+            :class:`Client`
         """
         if translator is None:
             translator = Translator(extend_default_translator=True, new_child=True)
+        self._api_config = api_config or API()
+        self._client_config = client_config or Client()
         super(BoxSession, self).__init__()
         self._oauth = oauth
         self._network_layer = network_layer
-        self._default_headers = {'User-Agent': Client.USER_AGENT_STRING}
+        self._default_headers = {'User-Agent': self._client_config.USER_AGENT_STRING}
         self._translator = translator
         self._default_network_request_kwargs = {}
         if default_headers:
@@ -75,6 +94,22 @@ def translator(self):
         """
         return self._translator
 
+    @property
+    def api_config(self):
+        """
+
+        :rtype:     :class:`API`
+        """
+        return self._api_config
+
+    @property
+    def client_config(self):
+        """
+
+        :rtype:     :class:`Client`
+        """
+        return self._client_config
+
     def get_url(self, endpoint, *args):
         """
         Return the URL for the given Box API endpoint.
@@ -91,7 +126,7 @@ def get_url(self, endpoint, *args):
             `unicode`
         """
         # pylint:disable=no-self-use
-        url = ['{0}/{1}'.format(API.BASE_API_URL, endpoint)]
+        url = ['{0}/{1}'.format(self._api_config.BASE_API_URL, endpoint)]
         url.extend(['/{0}'.format(x) for x in args])
         return ''.join(url)
 
@@ -112,6 +147,8 @@ def as_user(self, user):
             default_headers=headers,
             translator=self._translator,
             default_network_request_kwargs=self._default_network_request_kwargs.copy(),
+            api_config=self._api_config,
+            client_config=self._client_config,
         )
 
     def with_shared_link(self, shared_link, shared_link_password=None):
@@ -135,6 +172,8 @@ def with_shared_link(self, shared_link, shared_link_password=None):
             default_headers=headers,
             translator=self._translator,
             default_network_request_kwargs=self._default_network_request_kwargs.copy(),
+            api_config=self._api_config,
+            client_config=self._client_config,
         )
 
     def with_default_network_request_kwargs(self, extra_network_parameters):
@@ -144,6 +183,8 @@ def with_default_network_request_kwargs(self, extra_network_parameters):
             default_headers=self._default_headers.copy(),
             translator=self._translator,
             default_network_request_kwargs=extra_network_parameters,
+            api_config=self._api_config,
+            client_config=self._client_config,
         )
 
     def _renew_session(self, access_token_used):

test/unit/conftest.py

@@ -7,7 +7,9 @@
 
 from mock import Mock, MagicMock
 import pytest
+
 from boxsdk.auth.oauth2 import DefaultNetwork
+from boxsdk.config import API, Client
 from boxsdk.network import default_network
 from boxsdk.network.default_network import DefaultNetworkResponse
 from boxsdk.session.box_response import BoxResponse
@@ -46,6 +48,10 @@ def translator(default_translator):   # pylint:disable=unused-argument
 @pytest.fixture(scope='function')
 def mock_box_session(translator):
     mock_session = MagicMock(BoxSession)
+    # pylint:disable=protected-access
+    mock_session._api_config = mock_session.api_config = API()
+    mock_session._client_config = mock_session.client_config = Client()
+    # pylint:enable=protected-access
     mock_session.get_url.side_effect = lambda *args, **kwargs: BoxSession.get_url(mock_session, *args, **kwargs)
     mock_session.translator = translator
     return mock_session
@@ -54,6 +60,10 @@ def mock_box_session(translator):
 @pytest.fixture()
 def mock_box_session_2():
     mock_session = MagicMock(BoxSession)
+    # pylint:disable=protected-access
+    mock_session._api_config = API()
+    mock_session._client_config = Client()
+    # pylint:enable=protected-access
     mock_session.get_url.side_effect = lambda *args, **kwargs: BoxSession.get_url(mock_session, *args, **kwargs)
     return mock_session
 

test/unit/session/test_box_session.py

@@ -10,6 +10,7 @@
 import pytest
 
 from boxsdk.auth.oauth2 import OAuth2
+from boxsdk.config import API
 from boxsdk.exception import BoxAPIException
 from boxsdk.network.default_network import DefaultNetwork, DefaultNetworkResponse
 from boxsdk.session.box_response import BoxResponse
@@ -252,3 +253,18 @@ class Foo(object):
     # Test that adding new registrations does not affect global state.
     assert default_translator == original_default_translator
     assert (set(box_session.translator) - set(default_translator)) == set([item_type])
+
+
+def test_session_uses_global_config(box_session, mock_network_layer, generic_successful_response, monkeypatch):
+    mock_network_layer.request.side_effect = generic_successful_response
+    example_dot_com = 'https://example.com/'
+    monkeypatch.setattr(API, 'BASE_API_URL', example_dot_com)
+    assert example_dot_com in box_session.get_url('foo', 'bar')
+
+
+def test_session_uses_local_config(box_session, mock_network_layer, generic_successful_response, monkeypatch):
+    mock_network_layer.request.side_effect = generic_successful_response
+    example_dot_com = 'https://example.com/'
+    box_session.api_config.BASE_API_URL = example_dot_com
+    monkeypatch.setattr(API, 'BASE_API_URL', 'https://api.box.com')
+    assert example_dot_com in box_session.get_url('foo', 'bar')