add refresh token support

Author: kireet

.gitignore

@@ -105,3 +105,5 @@ venv.bak/
 
 # PyCharm
 .idea/
+
+upload-instructions

README.md

@@ -15,11 +15,11 @@ If we assume you saved the token value in a `access.token` file in your home dir
 initalize the client as follows:
 
 ```
-from pathlib import path
+from pathlib import Path
 from feedly.session import FeedlySession
 
 token = (Path.home() / 'access.token').read_text().strip()
-sess = FeedlySession(auth_token=token)
+sess = FeedlySession(token)
 ```
 Clients are lightweight -- you can keep a client around for the lifetime of your program,
 or you can create a new one when needed. It's a bit more efficient to keep it around. If you
@@ -112,3 +112,9 @@ quite a few entries at a time, see the previous section for details. Once you ge
 the client will stop any attempted requests until you have available quota.
 
 To debug things, set the log level to `DEBUG`. This will print log messages on every API request.
+
+### Token Management
+The above examples assume the auth (access) token is valid. However these tokens do expire. Instead 
+of passing the auth token itself, you can create a `feedly.session.Auth` implementation to refresh
+the auth token. A file based implementation is already provided (`FileAuthStore`). Once this is done
+the client will automatically try to refresh the auth token if a `401` response is encountered.  

feedly/session.py

@@ -11,32 +11,87 @@
 from requests.exceptions import HTTPError
 
 from requests import Session
-import urllib
 
 from feedly.data import FeedlyUser
 from feedly.protocol import RateLimitedAPIError, BadRequestAPIError, UnauthorizedAPIError, ServerAPIError, APIClient, WrappedHTTPError
-from feedly.stream import EnterpriseStreamId
+
+
+class Auth:
+    """
+    simple class to manage tokens
+    """
+    def __init__(self, client_id:str='feedlydev', client_secret:str='feedlydev'):
+        self.client_id:str = client_id
+        self.client_secret:str = client_secret
+        self._auth_token:str = None
+        self.refresh_token:str = None
+
+    @property
+    def auth_token(self):
+        return self._auth_token
+
+    @auth_token.setter
+    def auth_token(self, token:str):
+        self._auth_token = token
+
+
+class FileAuthStore(Auth):
+    """
+    a file based token storage scheme
+    """
+    def __init__(self, token_dir:Path, client_id:str='feedlydev', client_secret:str='feedlydev'):
+        """
+
+        :param token_dir: the directory to store the tokens
+        :param client_id: the client id to use when refreshing the auth token. the default value works for developer tokens.
+        :param client_secret: the client secret to use when refreshing the auth token. the default value works for developer tokens.
+        """
+        super().__init__(client_id, client_secret)
+        if not token_dir.is_dir():
+            raise ValueError(f'{token_dir.absolute()} does not exist!')
+
+        refresh_path = token_dir / 'refresh.token'
+        if refresh_path.is_file():
+            self.refresh_token = refresh_path.read_text().strip()
+
+        self.auth_token_path:Path = token_dir / 'access.token'
+        self._auth_token = self.auth_token_path.read_text().strip()
+
+    @Auth.auth_token.setter
+    def auth_token(self, token:str):
+        self._auth_token = token
+        self.auth_token_path.write_text(token)
 
 
 class FeedlySession(APIClient):
-    def __init__(self, auth_token:str, api_host:str='https://feedly.com', name:str='feedly.python.client',
-                 user_id:str=None, client_name='feedly.python.client'):
+    def __init__(self, auth:Union[str, Auth], api_host:str='https://feedly.com', user_id:str=None, client_name='feedly.python.client'):
+        """
+        :param auth: either the access token str to use when making requests or an Auth object to manage tokens
+        :param api_host: the feedly api server host.
+        :param user_id: the user id to use when making requests. If not set, a request will be made to determine the user from the auth token.
+        :param client_name: the name of your client, set this to something that can identify your app.
+        """
         super().__init__()
         if not client_name:
             raise ValueError('you must identify your client!')
 
-        self.auth_token:str = auth_token
+        if isinstance(auth, str):
+            token:str = auth
+            auth = Auth()
+            auth.auth_token = token
+
+        self.auth:Auth = auth
         self.api_host:str = api_host
         self.session = Session()
         self.session.mount('https://feedly.com', HTTPAdapter(max_retries=1)) # as to treat feedly server and connection errors identically
         self.client_name = client_name
         self.timeout:int = 10
         self.max_tries:int = 3
-        self.name = urllib.parse.quote_plus(name)
 
         user_data = {'id': user_id} if user_id else {}
         self._user:FeedlyUser = FeedlyUser(user_data, self)
         self._valid:bool = None
+        self._last_token_refresh_attempt:float = 0
 
     def __repr__(self):
         return f'<feedly client user={self.user.id}>'
@@ -75,14 +130,13 @@ def do_api_request(self, relative_url:str, method:str=None, data:Dict=None,
         :raises: requests.exceptions.HTTPError on failure. An appropriate subclass may be raised when appropriate,
          (see the ones defined in this module).
         """
-
         if self.timeout is None:
             timeout = self.timeout
 
         if max_tries is None:
             max_tries = self.max_tries
 
-        if self.auth_token is None:
+        if self.auth.auth_token is None:
             raise ValueError('authorization token required!')
 
         if relative_url[0] != '/':
@@ -113,7 +167,7 @@ def do_api_request(self, relative_url:str, method:str=None, data:Dict=None,
                 if self.rate_limiter.rate_limited:
                     until = datetime.datetime.fromtimestamp(self.rate_limiter.until).isoformat()
                     raise ValueError(f'Too many requests. Client is rate limited until {until}')
-                headers = {'Authorization': self.auth_token}
+                headers = {'Authorization': self.auth.auth_token}
                 if data:
                     headers['Content-Type'] = 'application/json'
 
@@ -142,6 +196,17 @@ def do_api_request(self, relative_url:str, method:str=None, data:Dict=None,
             if code == 400:
                 raise BadRequestAPIError(e)
             elif code == 401:
+                if not relative_url.startswith('/v3/auth') and self.auth.refresh_token and time.time() - self._last_token_refresh_attempt > 86400:
+                    try:
+                        self._last_token_refresh_attempt = time.time()
+                        auth_data = {'refresh_token': self.auth.refresh_token, 'grant_type': 'refresh_token',
+                                     'client_id': self.auth.client_id, 'client_secret': self.auth.client_secret}
+                        token_data = self.do_api_request('/v3/auth/token', data=auth_data)
+                        self.auth.auth_token = token_data['access_token']
+                        return self.do_api_request(relative_url=relative_url, method=method, data=data, timeout=timeout, max_tries=max_tries)
+                    except Exception as e2:
+                        logging.info('error refreshing access token', exc_info=e2)
+                        # fall through to raise auth error
                 raise UnauthorizedAPIError(e)
             elif code == 429:
                 if not self.rate_limiter.rate_limited:
@@ -154,13 +219,13 @@ def do_api_request(self, relative_url:str, method:str=None, data:Dict=None,
 
 if __name__ == '__main__':
         logging.basicConfig(level='DEBUG')
-        token = (Path.home() / 'access.token').read_text().strip()
+        # token = (Path.home() / 'access.token').read_text().strip()
+        auth = FileAuthStore(Path.home())
         # print(sess.user['fullName'])
 
-        uid = 'uid'
-        sess = FeedlySession(auth_token=token, user_id=uid)
+        sess = FeedlySession(auth)
 
-        # sess.user.get_enterprise_tags()
+        sess.user.get_enterprise_tags()
         # sess.user.get_enterprise_categories()
 
         # with FeedlySession(auth_token=token, user_id=uid) as sess:

setup.py

@@ -18,12 +18,9 @@
 EMAIL = 'kireet@feedly.com'
 AUTHOR = 'Kireet'
 REQUIRES_PYTHON = '>=3.6.0'
-VERSION = 0.13
+VERSION = 0.14
 
 # What packages are required for this module to be executed?
-#REQUIRED = [
-    # 'requests', 'maya', 'records',
-#]
 with open('requirements.txt') as f:
     REQUIRED = f.read().splitlines()