Update based on CR.

Jeff-Meadows · Jeff-Meadows · commit dad00eecbee1 · 2016-03-17T16:49:27.000-07:00
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -6,12 +6,9 @@ Release History
 Upcoming
 ++++++++
 
-- Box objects have an improved ``__repr__``, making them easier to identify during debugging sessions.
-- Box objects now implement ``__dir__``, making them easier to explore. When created with a Box API response,
-  these objects will now include the API response fields as attributes.
 
 
-1.5.0 (2016-03-02)
+1.5.0 (2016-03-17)
 ++++++++++++++++++
 
 - Added a new class, ``LoggingClient``. It's a ``Client`` that uses the ``LoggingNetwork`` class so that
@@ -21,6 +18,9 @@ Upcoming
 - Made the ``oauth`` parameter to ``Client`` optional. The constructor now accepts new parameters that it will use
   to construct the ``OAuth2`` instance it needs to auth with the Box API.
 - Changed the default User Agent string sent with requests to the Box API. It is now 'box-python-sdk-<version>'.
+- Box objects have an improved ``__repr__``, making them easier to identify during debugging sessions.
+- Box objects now implement ``__dir__``, making them easier to explore. When created with a Box API response,
+  these objects will now include the API response fields as attributes.
 
 
 
diff --git a/README.rst b/README.rst
@@ -377,18 +377,19 @@ For more control over how the information is logged, use the ``LoggingNetwork``
     # Use a custom logger
     client = Client(oauth, network_layer=LoggingNetwork(logger))
 
+Developer Token Client
+~~~~~~~~~~~~~~~~~~~~~~
+
+The Box Developer Console allows for the creation of short-lived developer tokens. The SDK makes it easy to use these
+tokens. Use the ``get_new_token_callback`` parameter to control how the client will get new developer tokens as
+needed. The default is to prompt standard input for a token.
+
 Development Client
 ~~~~~~~~~~~~~~~~~~
 
 For exploring the Box API, or to quickly get going using the SDK, the ``DevelopmentClient`` class combines the
 ``LoggingClient`` with the ``DeveloperTokenClient``.
 
-Developer Token Client
-~~~~~~~~~~~~~~~~~~~~~~
-
-The Box Developer Console allows for the creation of short-lived developer tokens. The SDK makes it easy to use these
-tokens. Use the
-
 Contributing
 ------------
 
diff --git a/boxsdk/__init__.py b/boxsdk/__init__.py
@@ -1,9 +1,8 @@
 # coding: utf-8
 
-from __future__ import unicode_literals
+from __future__ import unicode_literals, absolute_import
 
 from .auth import JWTAuth, OAuth2
 from .client import *  # pylint:disable=wildcard-import,redefined-builtin
 from .object import *  # pylint:disable=wildcard-import,redefined-builtin
-from .config import Version
-__version__ = Version.VERSION
+from .version import __version__
diff --git a/boxsdk/client/__init__.py b/boxsdk/client/__init__.py
@@ -4,12 +4,5 @@
 
 from .client import Client
 from .developer_token_client import DeveloperTokenClient
+from .development_client import DevelopmentClient
 from .logging_client import LoggingClient
-
-
-class DevelopmentClient(DeveloperTokenClient, LoggingClient):
-    """
-    Client subclass that uses developer token auth and logs requests and responses.
-    Great for use in development!
-    """
-    pass
diff --git a/boxsdk/client/client.py b/boxsdk/client/client.py
@@ -1,9 +1,8 @@
 # coding: utf-8
 
-from __future__ import unicode_literals
+from __future__ import unicode_literals, absolute_import
 import json
 
-from ..auth import OAuth2
 from ..config import API
 from ..session.box_session import BoxSession
 from ..network.default_network import DefaultNetwork
@@ -16,7 +15,6 @@
 from ..object.group_membership import GroupMembership
 from ..util.shared_link import get_shared_link_header
 from ..util.translator import Translator
-from ..util.url import get_url
 
 
 class Client(object):
@@ -26,10 +24,6 @@ def __init__(
             oauth=None,
             network_layer=None,
             session=None,
-            client_id=None,
-            client_secret=None,
-            store_tokens=None,
-            **kwargs
     ):
         """
         :param oauth:
@@ -44,24 +38,9 @@ def __init__(
             The session object to use. If None is provided then an instance of :class:`BoxSession` will be used.
         :type session:
             :class:`BoxSession`
-        :param client_id:
-            Box API key used for identifying the application the user is authenticating with.
-            Ignored if oauth instance is passed into this constructor.
-        :type client_id:
-            `unicode`
-        :param client_secret:
-            Box API secret used for making OAuth2 requests.
-            Ignored if oauth instance is passed into this constructor.
-        :type client_secret:
-            `unicode`
-        :param store_tokens:
-            Optional callback for getting access to tokens for storing them.
-            Ignored if oauth instance is passed into this constructor.
-        :type store_tokens:
-            `callable`
         """
         network_layer = network_layer or DefaultNetwork()
-        self._oauth = oauth or OAuth2(client_id, client_secret, store_tokens=store_tokens, **kwargs)
+        self._oauth = oauth
         self._network = network_layer
         self._session = session or BoxSession(oauth=oauth, network_layer=network_layer)
 
@@ -411,4 +390,4 @@ def get_url(self, endpoint, *args):
             `unicode`
         """
         # pylint:disable=no-self-use
-        return get_url(endpoint, *args)
+        return self._session.get_url(endpoint, *args)
diff --git a/boxsdk/client/developer_token_client.py b/boxsdk/client/developer_token_client.py
@@ -10,10 +10,9 @@ class DeveloperTokenClient(Client):
     """
     Box client subclass which authorizes with a developer token.
     """
-    def __init__(self, oauth=None, network_layer=None, session=None, **kwargs):
+    def __init__(self, oauth=None, network_layer=None, session=None):
         super(DeveloperTokenClient, self).__init__(
             oauth=oauth or DeveloperTokenAuth(),
             network_layer=network_layer,
             session=session,
-            **kwargs
         )
diff --git a/boxsdk/client/development_client.py b/boxsdk/client/development_client.py
@@ -0,0 +1,14 @@
+# coding: utf-8
+
+from __future__ import unicode_literals, absolute_import
+
+from .developer_token_client import DeveloperTokenClient
+from .logging_client import LoggingClient
+
+
+class DevelopmentClient(DeveloperTokenClient, LoggingClient):
+    """
+    Client subclass that uses developer token auth and logs requests and responses.
+    Great for use in development!
+    """
+    pass
diff --git a/boxsdk/client/logging_client.py b/boxsdk/client/logging_client.py
@@ -10,10 +10,9 @@ class LoggingClient(Client):
     """
     Box client subclass which logs requests and responses.
     """
-    def __init__(self, oauth=None, network_layer=None, session=None, **kwargs):
+    def __init__(self, oauth=None, network_layer=None, session=None):
         super(LoggingClient, self).__init__(
-            oauth,
+            oauth=oauth,
             network_layer=network_layer or LoggingNetwork(),
             session=session,
-            **kwargs
         )
diff --git a/boxsdk/config.py b/boxsdk/config.py
@@ -1,6 +1,8 @@
 # coding: utf-8
 
-from __future__ import unicode_literals
+from __future__ import unicode_literals, absolute_import
+
+from . import version
 
 
 class API(object):
@@ -11,7 +13,7 @@ class API(object):
     OAUTH2_AUTHORIZE_URL = 'https://app.box.com/api/oauth2/authorize'  # <https://developers.box.com/docs/#oauth-2-authorize>
 
 
-class Version(object):
-    """Configuration object containing the package version and user agent string."""
-    VERSION = '1.5.0'
+class Client(object):
+    """Configuration object containing the user agent string."""
+    VERSION = version.__version__
     USER_AGENT_STRING = 'box-python-sdk-{0}'.format(VERSION)
diff --git a/boxsdk/object/base_endpoint.py b/boxsdk/object/base_endpoint.py
@@ -2,8 +2,6 @@
 
 from __future__ import unicode_literals
 
-from boxsdk.util.url import get_url
-
 
 class BaseEndpoint(object):
     """A Box API endpoint."""
@@ -34,7 +32,7 @@ def get_url(self, endpoint, *args):
             `unicode`
         """
         # pylint:disable=no-self-use
-        return get_url(endpoint, *args)
+        return self._session.get_url(endpoint, *args)
 
     def as_user(self, user):
         """
diff --git a/boxsdk/object/base_object.py b/boxsdk/object/base_object.py
@@ -57,8 +57,18 @@ def __getitem__(self, item):
 
     def __repr__(self):
         """Base class override. Return a human-readable representation using the Box ID or name of the object."""
-        description = self.name if 'name' in self._response_object else self.object_id  # pylint:disable=no-member
-        return '<Box {0} ({1})>'.format(self.__class__.__name__, description)
+        description = '<Box {0} - {1}>'.format(self.__class__.__name__, self._description)
+        if six.PY2:
+            return description.encode('utf-8')
+        else:
+            return description
+
+    @property
+    def _description(self):
+        if 'name' in self._response_object:
+            return '{0} ({1})'.format(self._object_id, self.name)  # pylint:disable=no-member
+        else:
+            return '{0}'.format(self._object_id)
 
     def get_url(self, *args):
         """
diff --git a/boxsdk/session/box_session.py b/boxsdk/session/box_session.py
@@ -2,7 +2,7 @@
 
 from __future__ import unicode_literals
 
-from boxsdk.config import Version
+from boxsdk.config import API, Client
 from boxsdk.exception import BoxAPIException
 from boxsdk.util.multipart_stream import MultipartStream
 from boxsdk.util.shared_link import get_shared_link_header
@@ -82,7 +82,29 @@ def __init__(self, oauth, network_layer, default_headers=None):
         """
         self._oauth = oauth
         self._network_layer = network_layer
-        self._default_headers = default_headers or {'User-Agent': Version.USER_AGENT_STRING}
+        self._default_headers = {'User-Agent': Client.USER_AGENT_STRING}
+        if default_headers:
+            self._default_headers.update(default_headers)
+
+    def get_url(self, endpoint, *args):
+        """
+        Return the URL for the given Box API endpoint.
+
+        :param endpoint:
+            The name of the endpoint.
+        :type endpoint:
+            `url`
+        :param args:
+            Additional parts of the endpoint URL.
+        :type args:
+            `Iterable`
+        :rtype:
+            `unicode`
+        """
+        # pylint:disable=no-self-use
+        url = ['{0}/{1}'.format(API.BASE_API_URL, endpoint)]
+        url.extend(['/{0}'.format(x) for x in args])
+        return ''.join(url)
 
     def as_user(self, user):
         """
diff --git a/boxsdk/util/url.py b/boxsdk/util/url.py
diff --git a/boxsdk/version.py b/boxsdk/version.py
@@ -0,0 +1,6 @@
+# coding: utf-8
+
+from __future__ import unicode_literals, absolute_import
+
+
+__version__ = '1.5.0'
diff --git a/docs/source/boxsdk.client.rst b/docs/source/boxsdk.client.rst
@@ -20,6 +20,14 @@ boxsdk.client.developer_token_client module
     :undoc-members:
     :show-inheritance:
 
+boxsdk.client.development_client module
+---------------------------------------
+
+.. automodule:: boxsdk.client.development_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 boxsdk.client.logging_client module
 -----------------------------------
 
diff --git a/docs/source/boxsdk.rst b/docs/source/boxsdk.rst
@@ -32,6 +32,14 @@ boxsdk.exception module
     :undoc-members:
     :show-inheritance:
 
+boxsdk.version module
+---------------------
+
+.. automodule:: boxsdk.version
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 Module contents
 ---------------
diff --git a/docs/source/boxsdk.util.rst b/docs/source/boxsdk.util.rst
@@ -84,14 +84,6 @@ boxsdk.util.translator module
     :undoc-members:
     :show-inheritance:
 
-boxsdk.util.url module
-----------------------
-
-.. automodule:: boxsdk.util.url
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 
 Module contents
 ---------------
diff --git a/setup.py b/setup.py
@@ -81,8 +81,8 @@ def main():
             python_conditional = 'python_version=="{0}"'.format(python_version)
             key = ':{0}'.format(python_conditional)
             extra_requires[key].append(requirement)
-    with open('boxsdk/config.py', 'r', 'utf-8') as config_py:
-        version = re.search(r'^\s+VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', config_py.read(), re.MULTILINE).group(1)
+    with open('boxsdk/version.py', 'r', encoding='utf-8') as config_py:
+        version = re.search(r'^\s+__version__\s*=\s*[\'"]([^\'"]*)[\'"]', config_py.read(), re.MULTILINE).group(1)
     setup(
         name='boxsdk',
         version=version,
diff --git a/test/integration/test_as_user.py b/test/integration/test_as_user.py
@@ -3,7 +3,7 @@
 from __future__ import unicode_literals
 from mock import call, patch
 import pytest
-from boxsdk.config import API, Version
+from boxsdk.config import API, Client
 from boxsdk.object.group_membership import GroupMembership
 from boxsdk.object.user import User
 
@@ -13,7 +13,7 @@ def as_user_headers(mock_user_id, access_token):
     return {
         'Authorization': 'Bearer {0}'.format(access_token),
         'As-User': mock_user_id,
-        'User-Agent': Version.USER_AGENT_STRING,
+        'User-Agent': Client.USER_AGENT_STRING,
     }
 
 
diff --git a/test/integration/test_with_shared_link.py b/test/integration/test_with_shared_link.py
diff --git a/test/unit/conftest.py b/test/unit/conftest.py
