refactor for review

Author: Andy Harris

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

@@ -4,12 +4,10 @@
 # Andy Harris <andy.harris@optimizely.com>
 
 # Client
-from optimizely.client import 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/client.py

@@ -1,44 +1,54 @@
+__all__ = ['Client']
+
 import urlparse
 import requests
 
 from optimizely import error
 from optimizely import resource
 
-base = 'https://www.optimizelyapis.com/experiment/v1/'
+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):
+    def __init__(self, api_key, api_base=BASE_URL):
+        # set API information
         self.api_key = api_key
         self.api_base = api_base
 
-        self.Project = resource.ResourceGenerator(client=self, resource=resource.Project)
-        self.Experiment = resource.ResourceGenerator(client=self, resource=resource.Experiment)
-        self.Variation = resource.ResourceGenerator(client=self, resource=resource.Variation)
-        self.Goal = resource.ResourceGenerator(client=self, resource=resource.Goal)
-        self.Audience = resource.ResourceGenerator(client=self, resource=resource.Audience)
-
-    def request(self, method, url_parts, headers=None, data=''):
+        # 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
-            return self.parse_response(getattr(requests, method)(urlparse.urljoin(
-                self.api_base, '/'.join([str(url_part) for url_part in url_parts])), headers=headers, data=data))
+            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 BadRequestError('%s is not a valid request type.' % method)
+            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
+            return None
         elif resp.status_code == 400:
             raise error.BadRequestError(resp.json().get('message'))
         elif resp.status_code == 401:

optimizely/error.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

optimizely/resource.py

@@ -1,3 +1,5 @@
+__all__ = ['Project', 'Experiment', 'Result', 'Variation', 'Goal', 'Audience']
+
 import json
 import urllib
 
@@ -26,7 +28,7 @@ def get(self, optimizely_ids=None):
             return response_list
 
     def create(self, data):
-        return self.resource.create(data, client=self.client)
+        return self.resource.create(data, self.client)
 
     def update(self, rid, data):
         return self.resource.update(rid, data, self.client)
@@ -112,7 +114,7 @@ class UpdatableObject(APIObject):
     editable_fields = []
 
     def save(self):
-        return self._refresh_from(self.update(self.id, self.__dict__, self.client).__dict__)
+        self._refresh_from(self.update(self.id, self.__dict__, self.client).__dict__)
 
     @classmethod
     def update(cls, rid, data, client):
@@ -130,7 +132,7 @@ def update(cls, rid, data, client):
 class DeletableObject(APIObject):
 
     def delete(self):
-        return self.client.request('delete', [self.class_url(), self.id])
+        self.client.request('delete', [self.class_url(), self.id])
 
 
 class Project(ListableObject, CreatableObject, UpdatableObject):
@@ -146,6 +148,12 @@ def experiments(self):
     def goals(self):
         return self.get_child_objects(Goal)
 
+    def audiences(self):
+        return self.get_child_objects(Audience)
+
+    def dimensions(self):
+        return self.get_child_objects(Dimension)
+
 
 class Experiment(CreatableChildObject, UpdatableObject, DeletableObject):
 
@@ -166,8 +174,8 @@ def results(self):
     def variations(self):
         return self.get_child_objects(Variation)
 
-    def audiences(self):
-        return self.get_child_objects(Audience)
+    def schedules(self):
+        return self.get_child_objects(Schedule)
 
     def add_goal(self, gid):
         goal = Goal(self.client, gid)
@@ -220,3 +228,18 @@ class Audience(CreatableChildObject, UpdatableObject):
                        'description',
                        'conditions',
                        'segmentation']
+
+
+class Dimension(CreatableChildObject, UpdatableObject, DeletableObject):
+
+    parent_resource = Project
+    editable_fields = ['name',
+                       'client_api_name',
+                       'description']
+
+
+class Schedule(CreatableChildObject, UpdatableObject, DeletableObject):
+
+    parent_resource = Experiment
+    editable_fields = ['start_time',
+                       'stop_time']

requirements.txt

@@ -1,2 +1,3 @@
 optimizely
+mock
 requests>2.4.1