Add support for custom read/write credentials path (#90)

Author: sserrata

.travis.yml

@@ -23,7 +23,7 @@ python:
 - 2.7
 script:
 - tox
-- coverage run --source pancloud -m py.test
+- coverage run --source pancloud -m py.test --ignore=examples
 - coverage report -m
 
 # safelist

pancloud/adapters/tinydb_adapter.py

@@ -14,7 +14,9 @@
 
 class TinyDBStore(StorageAdapter):
 
-    def __init__(self):
+    def __init__(self, **kwargs):
+        self._storage_params = kwargs.get('storage_params') or {}
+        self.dbfile = self._storage_params.get('dbfile')
         self.query = Query()
         self.db = self.init_store()
         self.lock = RLock()
@@ -35,17 +37,22 @@ def fetch_credential(self, credential=None, profile=None):
             return q.get(credential)
 
     def init_store(self):
-        path = os.path.join(
-            os.path.expanduser('~'), '.config', 'pancloud',
-            'credentials.json'
-        )
-        if not os.path.exists(os.path.dirname(path)):
+        if self.dbfile:
+            dbfile = self.dbfile
+        elif os.getenv('PAN_CREDENTIALS_DBFILE'):
+            dbfile = os.getenv('PAN_CREDENTIALS_DBFILE')
+        else:
+            dbfile = os.path.join(
+                os.path.expanduser('~'), '.config', 'pancloud',
+                'credentials.json'
+            )
+        if not os.path.exists(os.path.dirname(dbfile)):
             try:
-                os.makedirs(os.path.dirname(path), 0o700)
+                os.makedirs(os.path.dirname(dbfile), 0o700)
             except OSError as e:
                 raise PanCloudError("{}".format(e))
         return TinyDB(
-            path, sort_keys=True, indent=4,
+            dbfile, sort_keys=True, indent=4,
             default_table='profiles'
         )
 

pancloud/credentials.py

@@ -32,7 +32,8 @@ def __init__(self, access_token=None, auth_base_url=None, cache_token=True,
                  client_id=None, client_secret=None, instance_id=None,
                  profile=None, redirect_uri=None, region=None,
                  refresh_token=None, scope=None, storage_adapter=None,
-                 token_url=None, token_revoke_url=None, **kwargs):
+                 storage_params=None, token_url=None, token_revoke_url=None,
+                 **kwargs):
         """Persist Session() and credentials attributes.
 
         Built on top of the ``Requests`` library, ``Credentials``
@@ -59,6 +60,7 @@ def __init__(self, access_token=None, auth_base_url=None, cache_token=True,
             region (str): Region. Defaults to ``None``.
             refresh_token (str): OAuth2 refresh token. Defaults to ``None``.
             scope (str): OAuth2 scope. Defaults to ``None``.
+            storage_params (dict) = Storage adapter parameters. Defaults to ``None``.
             token_url (str): Refresh URL. Defaults to ``None``.
             token_revoke_url (str): Revoke URL. Defaults to ``None``.
             **kwargs: Supported :class:`~requests.Session` parameters.
@@ -78,7 +80,7 @@ def __init__(self, access_token=None, auth_base_url=None, cache_token=True,
         self.state = uuid.uuid4()
         self.adapter = storage_adapter or \
                        'pancloud.adapters.tinydb_adapter.TinyDBStore'
-        self.storage = self._init_adapter()
+        self.storage = self._init_adapter(storage_params)
         self.token_lock = Lock()
         self.token_url = token_url or TOKEN_URL
         self.token_revoke_url = token_revoke_url or REVOKE_URL
@@ -149,7 +151,7 @@ def _credentials_found_in_envars():
                     os.getenv('PAN_CLIENT_SECRET'),
                     os.getenv('PAN_REFRESH_TOKEN')])
 
-    def _init_adapter(self):
+    def _init_adapter(self, storage_params=None):
         module_path = self.adapter.rsplit('.', 1)[0]
         adapter = self.adapter.split('.')[-1]
         try:
@@ -163,7 +165,7 @@ def _init_adapter(self):
         except AttributeError:
             raise PanCloudError('Class not found: %s' % adapter)
 
-        return class_  # Returns 'TinyDBStore' as class
+        return class_(storage_params=storage_params)
 
     def _resolve_credential(self, credential):
         """Resolve credential from envars or credentials store.
@@ -180,7 +182,7 @@ def _resolve_credential(self, credential):
         elif self._credentials_found_in_envars():
             return os.getenv('PAN_' + credential.upper())
         else:
-            return self.storage().fetch_credential(
+            return self.storage.fetch_credential(
                 credential=credential, profile=self.profile)
 
     def fetch_tokens(self, client_id=None, client_secret=None, code=None,
@@ -289,7 +291,7 @@ def remove_profile(self, profile):
             int: Result of operation.
 
         """
-        return self.storage().remove_profile(profile=profile)
+        return self.storage.remove_profile(profile=profile)
 
     def refresh(self, timeout=None, access_token=None):
         """Refresh access and refresh tokens.
@@ -391,7 +393,7 @@ def write_credentials(self):
 
         """
         c = self.get_credentials()
-        return self.storage().write_credentials(
+        return self.storage.write_credentials(
             credentials=c, profile=self.profile,
             cache_token=self.cache_token_
         )