Merge pull request #85 from orcasgit/oauth2-support-only

OAuth2 support only

Author: brad

.travis.yml

@@ -7,9 +7,7 @@ env:
   - TOX_ENV=py35
   - TOX_ENV=py34
   - TOX_ENV=py33
-  - TOX_ENV=py32
   - TOX_ENV=py27
-  - TOX_ENV=py26
   - TOX_ENV=docs
 install:
   - pip install coveralls tox

CHANGELOG.rst

@@ -1,3 +1,9 @@
+0.2 (2016-03-23)
+================
+
+* Drop OAuth1 support. See `OAuth1 deprecated <https://dev.fitbit.com/docs/oauth2/#oauth-1-0a-deprecated>`_
+* Drop py26 and py32 support
+
 0.1.3 (2015-02-04)
 ==================
 

README.rst

@@ -18,7 +18,7 @@ For documentation: `http://python-fitbit.readthedocs.org/ <http://python-fitbit.
 Requirements
 ============
 
-* Python 2.6+
+* Python 2.7+
 * `python-dateutil`_ (always)
 * `requests-oauthlib`_ (always)
 * `Sphinx`_ (to create the documention)

docs/index.rst

@@ -21,18 +21,11 @@ If you are only retrieving data that doesn't require authorization, then you can
     # certain methods do not require user keys
     unauth_client.food_units()
 
-Here is an example of authorizing with OAuth 1.0::
-
-    # You'll have to gather the user keys on your own, or try
-    # ./gather_keys_cli.py <consumer_key> <consumer_secret> for development
-    authd_client = fitbit.Fitbit('<consumer_key>', '<consumer_secret>', resource_owner_key='<user_key>', resource_owner_secret='<user_secret>')
-    authd_client.sleep()
-
 Here is an example of authorizing with OAuth 2.0::
 
     # You'll have to gather the tokens on your own, or use
     # ./gather_keys_oauth2.py
-    authd_client = fitbit.Fitbit('<consumer_key>', '<consumer_secret>', oauth2=True,
+    authd_client = fitbit.Fitbit('<consumer_key>', '<consumer_secret>',
                                  access_token='<access_token>', refresh_token='<refresh_token>')
     authd_client.sleep()
 

fitbit/__init__.py

@@ -7,7 +7,7 @@
 :license: BSD, see LICENSE for more details.
 """
 
-from .api import Fitbit, FitbitOauthClient, FitbitOauth2Client
+from .api import Fitbit, FitbitOauth2Client
 
 # Meta.
 
@@ -17,8 +17,8 @@
 __copyright__ = 'Copyright 2012-2015 ORCAS'
 __license__ = 'Apache 2.0'
 
-__version__ = '0.1.3'
-__release__ = '0.1.3'
+__version__ = '0.2'
+__release__ = '0.2'
 
 # Module namespace.
 

fitbit/api.py

@@ -10,7 +10,7 @@
     # Python 2.x
     from urllib import urlencode
 
-from requests_oauthlib import OAuth1, OAuth1Session, OAuth2, OAuth2Session
+from requests_oauthlib import OAuth2, OAuth2Session
 from oauthlib.oauth2 import TokenExpiredError
 from fitbit.exceptions import (BadResponse, DeleteError, HTTPBadRequest,
                                HTTPUnauthorized, HTTPForbidden,
@@ -19,130 +19,6 @@
 from fitbit.utils import curry
 
 
-class FitbitOauthClient(object):
-    API_ENDPOINT = "https://api.fitbit.com"
-    AUTHORIZE_ENDPOINT = "https://www.fitbit.com"
-    API_VERSION = 1
-
-    request_token_url = "%s/oauth/request_token" % API_ENDPOINT
-    access_token_url = "%s/oauth/access_token" % API_ENDPOINT
-    authorization_url = "%s/oauth/authorize" % AUTHORIZE_ENDPOINT
-
-    def __init__(self, client_key, client_secret, resource_owner_key=None,
-                 resource_owner_secret=None, user_id=None, callback_uri=None,
-                 *args, **kwargs):
-        """
-        Create a FitbitOauthClient object. Specify the first 5 parameters if
-        you have them to access user data. Specify just the first 2 parameters
-        to access anonymous data and start the set up for user authorization.
-
-        Set callback_uri to a URL and when the user has granted us access at
-        the fitbit site, fitbit will redirect them to the URL you passed.  This
-        is how we get back the magic verifier string from fitbit if we're a web
-        app. If we don't pass it, then fitbit will just display the verifier
-        string for the user to copy and we'll have to ask them to paste it for
-        us and read it that way.
-        """
-
-        self.session = requests.Session()
-        self.client_key = client_key
-        self.client_secret = client_secret
-        self.resource_owner_key = resource_owner_key
-        self.resource_owner_secret = resource_owner_secret
-        if user_id:
-            self.user_id = user_id
-        params = {'client_secret': client_secret}
-        if callback_uri:
-            params['callback_uri'] = callback_uri
-        if self.resource_owner_key and self.resource_owner_secret:
-            params['resource_owner_key'] = self.resource_owner_key
-            params['resource_owner_secret'] = self.resource_owner_secret
-        self.oauth = OAuth1Session(client_key, **params)
-
-    def _request(self, method, url, **kwargs):
-        """
-        A simple wrapper around requests.
-        """
-        return self.session.request(method, url, **kwargs)
-
-    def make_request(self, url, data={}, method=None, **kwargs):
-        """
-        Builds and makes the OAuth Request, catches errors
-
-        https://wiki.fitbit.com/display/API/API+Response+Format+And+Errors
-        """
-        if not method:
-            method = 'POST' if data else 'GET'
-        auth = OAuth1(
-            self.client_key, self.client_secret, self.resource_owner_key,
-            self.resource_owner_secret, signature_type='auth_header')
-        response = self._request(method, url, data=data, auth=auth, **kwargs)
-
-        if response.status_code == 401:
-            raise HTTPUnauthorized(response)
-        elif response.status_code == 403:
-            raise HTTPForbidden(response)
-        elif response.status_code == 404:
-            raise HTTPNotFound(response)
-        elif response.status_code == 409:
-            raise HTTPConflict(response)
-        elif response.status_code == 429:
-            exc = HTTPTooManyRequests(response)
-            exc.retry_after_secs = int(response.headers['Retry-After'])
-            raise exc
-
-        elif response.status_code >= 500:
-            raise HTTPServerError(response)
-        elif response.status_code >= 400:
-            raise HTTPBadRequest(response)
-        return response
-
-    def fetch_request_token(self):
-        """
-        Step 1 of getting authorized to access a user's data at fitbit: this
-        makes a signed request to fitbit to get a token to use in step 3.
-        Returns that token.}
-        """
-
-        token = self.oauth.fetch_request_token(self.request_token_url)
-        self.resource_owner_key = token.get('oauth_token')
-        self.resource_owner_secret = token.get('oauth_token_secret')
-        return token
-
-    def authorize_token_url(self, **kwargs):
-        """Step 2: Return the URL the user needs to go to in order to grant us
-        authorization to look at their data.  Then redirect the user to that
-        URL, open their browser to it, or tell them to copy the URL into their
-        browser.  Allow the client to request the mobile display by passing
-        the display='touch' argument.
-        """
-
-        return self.oauth.authorization_url(self.authorization_url, **kwargs)
-
-    def fetch_access_token(self, verifier, token=None):
-        """Step 3: Given the verifier from fitbit, and optionally a token from
-        step 1 (not necessary if using the same FitbitOAuthClient object) calls
-        fitbit again and returns an access token object. Extract the needed
-        information from that and save it to use in future API calls.
-        """
-        if token:
-            self.resource_owner_key = token.get('oauth_token')
-            self.resource_owner_secret = token.get('oauth_token_secret')
-
-        self.oauth = OAuth1Session(
-            self.client_key,
-            client_secret=self.client_secret,
-            resource_owner_key=self.resource_owner_key,
-            resource_owner_secret=self.resource_owner_secret,
-            verifier=verifier)
-        response = self.oauth.fetch_access_token(self.access_token_url)
-
-        self.user_id = response.get('encoded_user_id')
-        self.resource_owner_key = response.get('oauth_token')
-        self.resource_owner_secret = response.get('oauth_token_secret')
-        return response
-
-
 class FitbitOauth2Client(object):
     API_ENDPOINT = "https://api.fitbit.com"
     AUTHORIZE_ENDPOINT = "https://www.fitbit.com"
@@ -205,7 +81,7 @@ def make_request(self, url, data={}, method=None, **kwargs):
             try:
                 if(d['errors'][0]['errorType'] == 'oauth' and
                     d['errors'][0]['fieldName'] == 'access_token' and
-                    d['errors'][0]['message'].find('Access token invalid or expired:')==0):
+                    d['errors'][0]['message'].find('Access token invalid or expired:') == 0):
                             self.refresh_token()
                             auth = OAuth2(client_id=self.client_id, token=self.token)
                             response = self._request(method, url, data=data, auth=auth, **kwargs)
@@ -322,17 +198,12 @@ class Fitbit(object):
         'frequent',
     ]
 
-    def __init__(self, client_key, client_secret, oauth2=False, system=US, **kwargs):
+    def __init__(self, client_id, client_secret, system=US, **kwargs):
         """
-            oauth1: Fitbit(<key>, <secret>, resource_owner_key=<key>, resource_owner_secret=<key>)
-            oauth2: Fitbit(<id>, <secret>, oauth2=True, access_token=<token>, refresh_token=<token>)
+        Fitbit(<id>, <secret>, access_token=<token>, refresh_token=<token>)
         """
         self.system = system
-
-        if oauth2:
-            self.client = FitbitOauth2Client(client_key, client_secret, **kwargs)
-        else:
-            self.client = FitbitOauthClient(client_key, client_secret, **kwargs)
+        self.client = FitbitOauth2Client(client_id, client_secret, **kwargs)
 
         # All of these use the same patterns, define the method for accessing
         # creating and deleting records once, and use curry to make individual
@@ -1114,10 +985,3 @@ def list_subscriptions(self, collection=''):
             collection='/{0}'.format(collection) if collection else ''
         )
         return self.make_request(url)
-
-    @classmethod
-    def from_oauth_keys(self, client_key, client_secret, user_key=None,
-                        user_secret=None, user_id=None, system=US):
-        client = FitbitOauthClient(client_key, client_secret, user_key,
-                                   user_secret, user_id)
-        return self(client, system)

fitbit_tests/__init__.py

@@ -1,6 +1,6 @@
 import unittest
 from .test_exceptions import ExceptionTest
-from .test_auth import AuthTest, Auth2Test
+from .test_auth import Auth2Test
 from .test_api import (
     APITest,
     CollectionResourceTest,
@@ -12,15 +12,8 @@
 
 
 def all_tests(consumer_key="", consumer_secret="", user_key=None, user_secret=None):
-    kwargs = {
-        "consumer_key": consumer_key,
-        "consumer_secret": consumer_secret,
-        "user_key": user_key,
-        "user_secret": user_secret,
-    }
     suite = unittest.TestSuite()
     suite.addTest(unittest.makeSuite(ExceptionTest))
-    suite.addTest(unittest.makeSuite(AuthTest))
     suite.addTest(unittest.makeSuite(Auth2Test))
     suite.addTest(unittest.makeSuite(APITest))
     suite.addTest(unittest.makeSuite(CollectionResourceTest))