add api_key method to retrieve information about the current API key (#…

…127)

Lets you retrieve information about the API key that was used to
make the request, e.g. to which user it belongs to.

closeio/closeio.py

@@ -37,6 +37,12 @@ def _api(self):
 
         return self._api_cache
 
+    # undocumented, hidden API - use with care
+    @parse_response
+    @handle_errors
+    def api_key(self):
+        return self._api.api_key.get()
+
     @parse_response
     @handle_errors
     def me(self):

closeio/contrib/testing_stub.py

@@ -550,3 +550,16 @@ def create_lead_export(self, query='*', format='json', fields=(),
         export['id'] = len(exports) + 1
         exports.append(export)
         return self.get_export(export['id'])
+
+    @parse_response
+    def api_key(self):
+        return Item({
+            'has_more': False,
+            'data': [{
+                'date_updated': datetime.now(timezone.utc),
+                'date_created': datetime.now(timezone.utc),
+                'user_id': self.get_user(0)['id'],
+                'organization_id': 'xx',
+                'key': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+            }],
+        })

tests/test_end_to_end.py

@@ -182,3 +182,6 @@ def test_create_lead_export(self, client, random_string):
 
     def test_get_export(self, client, export):
         assert client.get_export(export['id'])
+
+    def test_api_key(self, client):
+        assert client.api_key()