Merge pull request #1 from optimizely/aharris/refactor-code

Refactor to use client

Author: ajrharris

README.md

@@ -10,18 +10,17 @@ Usage
 Set your API key and you're ready to go!
 ```python
    >>> import optimizely
-   >>> optimizely.api_key = 'abcdefghijklmnopqrstuvwxyz:123456'
+   >>> client = optimizely.Client('abcdefghijklmnopqrstuvwxyz:123456')
 
-   >>> projects = optimizely.Project.list()
+   >>> projects = client.Projects.get()
    >>> projects
-   [<Project object with ID: 12345>]
+   # [<optimizely.resource.Project object at 0x000000000>, <optimizely.resource.Project object at 0x000000010>]
 
    >>> my_project = projects[0]
    >>> my_project.project_name
-   u'My Project'
+   # 'My Project'
 
-   >>> my_project = optimizely.Project.update(12345, {'project_name': 'My Project (Updated)'})
-   >>> my_project.project_name
-   u'My Project (Updated)'
+   >>> my_project.project_name = 'My Project (Updated)'
+   >>> my_project.save()
 
 ```

optimizely/__init__.py

@@ -3,14 +3,11 @@
 # Authors:
 # Andy Harris <andy.harris@optimizely.com>
 
-# configuration variables
-api_key = None
-api_base = 'https://www.optimizelyapis.com/experiment/v1/'
+# Client
+from optimizely.client import *
 
 # Resources
-from optimizely.resource import Project, Experiment, Result, Variation, Goal, Audience
+from optimizely.resource import *
 
 # Errors
-from optimizely.error import (
-    OptimizelyError, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, TooManyRequestsError,
-    ServiceUnavailableError, InvalidIDError)
+from optimizely.error import *

optimizely/api_requester.py

@@ -0,0 +1,65 @@
+__all__ = ['Client']
+
+import urlparse
+import requests
+
+from optimizely import error
+from optimizely import resource
+
+BASE_URL = 'https://www.optimizelyapis.com/experiment/v1/'
+
+
+class Client(object):
+    ALLOWED_REQUESTS = ['get', 'post', 'put', 'delete']
+
+    def __init__(self, api_key, api_base=BASE_URL):
+        # set API information
+        self.api_key = api_key
+        self.api_base = api_base
+
+        # instantiate resource generators for the relevant API resources
+        self.Projects = resource.ResourceGenerator(client=self, resource=resource.Project)
+        self.Experiments = resource.ResourceGenerator(client=self, resource=resource.Experiment)
+        self.Variations = resource.ResourceGenerator(client=self, resource=resource.Variation)
+        self.Goals = resource.ResourceGenerator(client=self, resource=resource.Goal)
+        self.Audiences = resource.ResourceGenerator(client=self, resource=resource.Audience)
+        self.Dimensions = resource.ResourceGenerator(client=self, resource=resource.Dimension)
+        self.Schedules = resource.ResourceGenerator(client=self, resource=resource.Schedule)
+
+    def request(self, method, url_parts, headers=None, data=None):
+        """ Method for making requests to the Optimizely API
+        """
+        if method in self.ALLOWED_REQUESTS:
+            # add request token header
+            headers = headers or {}
+            headers.update({'Token': self.api_key})
+
+            # make request and return parsed response
+            url = urlparse.urljoin(self.api_base, '/'.join([str(url_part) for url_part in url_parts]))
+            return self.parse_response(getattr(requests, method)(url, headers=headers, data=data))
+        else:
+            raise error.BadRequestError('%s is not a valid request type.' % method)
+
+    @staticmethod
+    def parse_response(resp):
+        """ Method to parse response from the Optimizely API and return results as JSON. Errors are thrown for various
+        errors that the API can throw.
+        """
+        if resp.status_code in [200, 201, 202]:
+            return resp.json()
+        elif resp.status_code == 204:
+            return None
+        elif resp.status_code == 400:
+            raise error.BadRequestError(resp.json().get('message'))
+        elif resp.status_code == 401:
+            raise error.UnauthorizedError(resp.json().get('message'))
+        elif resp.status_code == 403:
+            raise error.ForbiddenError(resp.json().get('message'))
+        elif resp.status_code == 404:
+            raise error.NotFoundError(resp.json().get('message'))
+        elif resp.status_code == 429:
+            raise error.TooManyRequestsError(resp.json().get('message'))
+        elif resp.status_code == 503:
+            raise error.ServiceUnavailableError(resp.json().get('message'))
+        else:
+            raise error.OptimizelyError(resp.text)

optimizely/client.py

@@ -1,3 +1,8 @@
+__all__ = [
+    'OptimizelyError', 'BadRequestError', 'UnauthorizedError', 'ForbiddenError', 'NotFoundError',
+    'TooManyRequestsError', 'ServiceUnavailableError', 'InvalidIDError']
+
+
 class OptimizelyError(Exception):
     """ General exception for all Optimizely Experiments API related issues."""
     pass