Merge pull request #97 from box/dev_token_auth

Add developer token auth class.

Author: Jeff-Meadows

boxsdk/__init__.py

@@ -2,10 +2,6 @@
 
 from __future__ import unicode_literals
 
-try:
-    from .auth.jwt_auth import JWTAuth
-except ImportError:
-    JWTAuth = None  # If extras are not installed, JWTAuth won't be available.
-from .auth.oauth2 import OAuth2
-from .client import Client
+from .auth import JWTAuth, OAuth2
+from .client import Client, DeveloperTokenClient
 from .object import *  # pylint:disable=wildcard-import,redefined-builtin

boxsdk/auth/__init__.py

@@ -1,3 +1,13 @@
 # coding: utf-8
 
 from __future__ import unicode_literals
+
+from .cooperatively_managed_oauth2 import CooperativelyManagedOAuth2
+from .developer_token_auth import DeveloperTokenAuth
+try:
+    from .jwt_auth import JWTAuth
+except ImportError:
+    JWTAuth = None  # If extras are not installed, JWTAuth won't be available.
+from .oauth2 import OAuth2
+from .redis_managed_oauth2 import RedisManagedJWTAuth, RedisManagedOAuth2
+from .remote_managed_oauth2 import RemoteOAuth2

boxsdk/auth/cooperatively_managed_oauth2.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 from __future__ import unicode_literals
-from boxsdk import OAuth2
+from .oauth2 import OAuth2
 
 
 class CooperativelyManagedOAuth2Mixin(OAuth2):

boxsdk/auth/developer_token_auth.py

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+from __future__ import unicode_literals, absolute_import
+
+from .oauth2 import OAuth2
+
+
+class DeveloperTokenAuth(OAuth2):
+    ENTER_TOKEN_PROMPT = 'Enter developer token: '
+
+    def __init__(self, get_new_token_callback=None, **kwargs):
+        self._get_new_token = get_new_token_callback
+        super(DeveloperTokenAuth, self).__init__(
+            client_id=None,
+            client_secret=None,
+            access_token=self._refresh_developer_token(),
+            **kwargs
+        )
+
+    def _refresh_developer_token(self):
+        if self._get_new_token is not None:
+            return self._get_new_token()
+        else:
+            return raw_input(self.ENTER_TOKEN_PROMPT)
+
+    def _refresh(self, access_token):
+        """
+        Base class override.
+        Ask for a new developer token.
+        """
+        self._access_token = self._refresh_developer_token()
+        return self._access_token, None

boxsdk/auth/redis_managed_oauth2.py

@@ -7,7 +7,8 @@
 from redis import StrictRedis
 from redis.lock import Lock
 
-from boxsdk import JWTAuth, OAuth2
+from .jwt_auth import JWTAuth
+from .oauth2 import OAuth2
 
 
 class RedisManagedOAuth2Mixin(OAuth2):

boxsdk/auth/remote_managed_oauth2.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 from __future__ import unicode_literals
-from boxsdk import OAuth2
+from .oauth2 import OAuth2
 
 
 class RemoteOAuth2Mixin(OAuth2):

boxsdk/client.py

@@ -3,6 +3,7 @@
 from __future__ import unicode_literals
 import json
 
+from .auth import DeveloperTokenAuth
 from .config import API
 from .session.box_session import BoxSession
 from .network.default_network import DefaultNetwork
@@ -329,3 +330,8 @@ def with_shared_link(self, shared_link, shared_link_password):
             self._network,
             self._session.with_shared_link(shared_link, shared_link_password),
         )
+
+
+class DeveloperTokenClient(Client):
+    def __init__(self, oauth=None, network_layer=None, session=None):
+        super(DeveloperTokenClient, self).__init__(oauth or DeveloperTokenAuth(), network_layer, session)

docs/source/boxsdk.auth.rst

@@ -12,6 +12,14 @@ boxsdk.auth.cooperatively_managed_oauth2 module
     :undoc-members:
     :show-inheritance:
 
+boxsdk.auth.developer_token_auth module
+---------------------------------------
+
+.. automodule:: boxsdk.auth.developer_token_auth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 boxsdk.auth.jwt_auth module
 ---------------------------
 

test/unit/auth/test_developer_token_auth.py

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+from __future__ import unicode_literals, absolute_import
+
+from mock import Mock, patch
+from boxsdk.auth import developer_token_auth
+
+
+def test_developer_token_auth_calls_callback_during_init_and_refresh(access_token):
+    get_new_token_callback = Mock()
+    get_new_token_callback.return_value = access_token
+    auth = developer_token_auth.DeveloperTokenAuth(
+        get_new_token_callback=get_new_token_callback,
+    )
+    assert auth.access_token == access_token
+    get_new_token_callback.assert_called_once_with()
+    assert auth.refresh(access_token) == (access_token, None)
+    assert len(get_new_token_callback.mock_calls) == 2
+
+
+def test_developer_token_auth_uses_raw_input_by_default(access_token):
+    with patch('boxsdk.auth.developer_token_auth.raw_input', create=True) as mock_raw_input:
+        mock_raw_input.return_value = access_token
+        auth = developer_token_auth.DeveloperTokenAuth()
+        mock_raw_input.assert_called_once_with(auth.ENTER_TOKEN_PROMPT)
+        assert auth.access_token == access_token
+        assert auth.refresh(access_token) == (access_token, None)
+        assert len(mock_raw_input.mock_calls) == 2