Merge pull request Clever#43 from Clever/remove-api-key

Remove references to API key

Author: meliaj

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.3.0 (2017-01-19)
+ * Added bindings for Contact resource. [#41](https://github.com/Clever/clever-python/pull/41)
+ * Updated CLI [#43](https://github.com/Clever/clever-python/pull/43)
+
 ## 2.2.0 (2016-02-03)
  * Added bindings for DistrictAdmin and SchoolAdmin resources. [#37](https://github.com/Clever/clever-python/pull/37)
 

README.md

@@ -31,8 +31,6 @@ Get started by importing the `clever` module and setting your authentication met
 ```python
     import clever
     clever.set_token('YOUR_OAUTH_TOKEN')
-    # or if you're using API key auth
-    # clever.set_api_key('YOUR_API_KEY')
 ```
 
 The `clever` module exposes classes corresponding to resources:
@@ -84,11 +82,11 @@ The `retrieve` class method takes in a Clever ID and returns a specific resource
 The library comes with a basic command-line interface:
 
 ```bash
-    $ export CLEVER_API_KEY=DEMO_KEY
+    $ export CLEVER_API_TOKEN=DEMO_TOKEN
     $ clever districts all
     Running the equivalent of:
     --
-    curl https://api.clever.com/v1.1/districts -H "Authorization: Basic REVNT19LRVk="
+    curl https://api.clever.com/v1.1/districts -H "Authorization: Bearer DEMO_TOKEN"
     --
     Starting new HTTPS connection (1): api.clever.com
     API request to https://api.clever.com/v1.1/districts returned (response code, response body)     of (200, '{"data":[{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"uri":"/v1.1/districts/4fd43cc56d11340000000005"}],"links":[{"rel":"self","uri":"/v1.1/districts"}]}')
@@ -113,3 +111,7 @@ Questions, feature requests, or feedback of any kind is always welcome! We're av
 ### Testing
 
     python -m unittest discover test
+
+## Publishing
+
+Update VERSION and CHANGELOG.md and run `publish.sh` to publish a new version of the library.

bin/clever

@@ -5,7 +5,6 @@ import os
 import re
 import subprocess
 import sys
-import base64
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
 import clever
@@ -46,9 +45,9 @@ class APIResourceClient(object):
       term = ' \\'
     else:
       term = ''
-    api_key = clever.get_api_key()
-    curl = ['curl %s%s -H "Authorization: Basic %s"%s' %
-            (clever.api_base, url, base64.b64encode(api_key), term)]
+    api_token = clever.get_token()
+    curl = ['curl %s%s -H "Authorization: Bearer %s"%s' %
+            (clever.api_base, url, api_token, term)]
     if isinstance(ordered_params, list):
       for i, (k, v) in enumerate(ordered_params):
         if i == len(ordered_params) - 1:
@@ -124,6 +123,9 @@ class TeacherClient(ListableAPIResourceClient):
 class EventClient(ListableAPIResourceClient):
   client_for = clever.Event
 
+class ContactClient(ListableAPIResourceClient):
+  client_for = clever.Contact
+
 def main():
   klasses = {
     'district' : DistrictClient,
@@ -134,6 +136,7 @@ def main():
     'student' : StudentClient,
     'teacher' : TeacherClient,
     'event' : EventClient,
+    'contact': ContactClient,
   }
   klasses_plural = { '{0}s'.format(key) : value for key, value in klasses.iteritems() }
   klasses = dict(klasses.items() + klasses_plural.items())
@@ -170,11 +173,15 @@ teacher
   retrieve
 
 event
+  all
+  retrieve
+
+contact
   all
   retrieve""")
   parser.add_option('-v', '--verbosity', help='Verbosity of debugging output.',
                     dest='verbosity', action='count', default=0)
-  parser.add_option('-k', '--api-key', help="API key.  Defaults to value of environment variable CLEVER_API_KEY", dest='api_key')
+  parser.add_option('-t', '--api-token', help="API token.  Defaults to value of environment variable CLEVER_API_TOKEN", dest='api_token')
   parser.add_option('-b', '--api-base', help='API base URL', dest='api_base')
   parser.add_option('-i', '--id', help="Object ID", dest='id')
   opts, args = parser.parse_args()
@@ -188,11 +195,11 @@ event
 
   klass_name = args[0]
   method_name = args[1]
-  api_key = opts.api_key or os.environ.get('CLEVER_API_KEY')
-  if not api_key:
-    parser.error('No API key provided (use -k option or set the CLEVER_API_KEY environment variable')
+  api_token = opts.api_token or os.environ.get('CLEVER_API_TOKEN')
+  if not api_token:
+    parser.error('No API token provided (use -t option or set the CLEVER_API_TOKEN environment variable')
     return 1
-  clever.set_api_key(api_key)
+  clever.set_token(api_token)
 
   if opts.api_base:
     clever.api_base = opts.api_base

clever/VERSION

@@ -1 +1 @@
-2.2.0
+2.3.0

clever/__init__.py

@@ -100,16 +100,6 @@ def get_token():
   global global_auth
   return global_auth.get('token', None)
 
-
-def set_api_key(api_key):
-  global global_auth
-  global_auth = {'api_key': api_key}
-
-
-def get_api_key():
-  global global_auth
-  return global_auth.get('api_key', None)
-
 # Exceptions
 
 
@@ -244,9 +234,9 @@ def request_raw(self, meth, url, params={}):
     my_auth = self._auth or global_auth
     if my_auth is None:
       raise AuthenticationError(
-          'No authentication method provided. (HINT: "clever.api_key = <API-KEY>" is deprecated. Set your API key using "clever.set_api_key(<API-KEY>)" or "clever.set_token(<OAUTH-TOKEN>)". You can generate API keys from the Clever web interface.  See https://clever.com/developers/docs for details, or email support@clever.com if you have any questions.')
-    if my_auth.get('token') is None and my_auth.get('api_key') is None:
-      raise AuthenticationError('Must provide either api_key or token auth. {}'.format(my_auth))
+          'No authentication method provided. (HINT: "clever.api_key = <API-KEY>" is deprecated. Set your API token using "clever.set_token(<OAUTH-TOKEN>)". You can generate API tokens from the Clever web interface.  See https://clever.com/developers/docs for details, or email support@clever.com if you have any questions.')
+    if my_auth.get('token') is None:
+      raise AuthenticationError('Must provide api token auth. {}'.format(my_auth))
 
     abs_url = self.api_url(url)
     params = params.copy()

test/test_cert_pinning.py

@@ -10,7 +10,7 @@
 class CleverTestCase(unittest.TestCase):
   def setUp(self):
     super(CleverTestCase, self).setUp()
-    clever.set_api_key('DEMO_KEY')
+    clever.set_token('DEMO_TOKEN')
 
 class CertPinning(CleverTestCase):
   def test_prod_api(self):

test/test_clever.py

@@ -30,7 +30,7 @@ class CleverTestCase(unittest.TestCase):
   def setUp(self):
     super(CleverTestCase, self).setUp()
     clever.api_base = os.environ.get('CLEVER_API_BASE', 'https://api.clever.com')
-    clever.set_api_key('DEMO_KEY')
+    clever.set_token('DEMO_TOKEN')
 
 
 class FunctionalTests(CleverTestCase):
@@ -104,16 +104,16 @@ def test_empty_list_on_no_data(self):
 class AuthenticationErrorTest(CleverTestCase):
 
   def test_invalid_credentials(self):
-    key = clever.get_api_key()
+    token = clever.get_token()
     try:
-      clever.set_api_key('invalid')
+      clever.set_token('invalid')
       clever.District.all()
     except clever.AuthenticationError, e:
       self.assertEqual(401, e.http_status)
       self.assertTrue(isinstance(e.http_body, str))
       self.assertTrue(isinstance(e.json_body, dict))
     finally:
-      clever.set_api_key(key)
+      clever.set_token(token)
 
 
 class InvalidRequestErrorTest(CleverTestCase):

test/test_cli_clever.py

@@ -15,7 +15,7 @@ def run_clever(self, args='', env=None):
     process = subprocess.Popen(CLI_CLEVER + args, shell=True, env=env,
                                stdout=subprocess.PIPE,
                                stderr=subprocess.PIPE)
-    
+
     out, err = process.communicate()
     code = process.returncode
     return out, err, code
@@ -28,14 +28,14 @@ def test_help(self):
     out, err, code = self.run_clever('-h')
     self.assertEqual(code, 0)
 
-  # def test_api_key(self):
-  #   # Check for error when key is not provided
-  #   out, err, code = self.run_clever('district all')
-  #   self.assertEqual(code, 2)
-  #   # Check for no error when key is provided via -k
-  #   out, err, code = self.run_clever('district all -k DEMO_KEY')
-  #   self.assertEqual(code, 0)
-  #   # Check for no error when key is provided via CLEVER_API_KEY
-  #   env = {'CLEVER_API_KEY':'DEMO_KEY'}
-  #   out, err, code = self.run_clever('district all', env)
-  #   self.assertEqual(code, 0)
+  def test_api_token(self):
+    # Check for error when key is not provided
+    out, err, code = self.run_clever('district all')
+    self.assertEqual(code, 2)
+    # Check for no error when key is provided via -t
+    out, err, code = self.run_clever('district all -t DEMO_TOKEN')
+    self.assertEqual(code, 0)
+    # Check for no error when key is provided via CLEVER_API_TOKEN
+    env = {'CLEVER_API_TOKEN':'DEMO_TOKEN'}
+    out, err, code = self.run_clever('district all', env)
+    self.assertEqual(code, 0)