edit attribute access

Author: Andy Harris

README.md

@@ -11,39 +11,16 @@ Set your API key and you're ready to go!
 ```python
    >>> import optimizely
    >>> optimizely.api_key = 'abcdefghijklmnopqrstuvwxyz:123456'
-   >>> optimizely.Project.all()
-   [
-      {
-        "code_revision": 8,
-        "installation_verified": true,
-        "project_name": "My new project",
-        "ip_filter": null,
-        "ip_anonymization": false,
-        "created": "2014-04-14T23:09:03.429630Z",
-        "library": "jquery-1.6.4-trim",
-        "last_modified": "2014-05-21T23:03:06.968520Z",
-        "project_status": "Active",
-        "include_jquery": true,
-        "js_file_size": 46176,
-        "id": 819000157,
-        "code_last_modified": "2014-05-21T23:03:04.918880Z",
-        "account_id": 555650815
-      },
-      {
-        "code_revision": 12,
-        "installation_verified": null,
-        "project_name": "My even newer project name",
-        "ip_filter": "1.2.3.4",
-        "ip_anonymization": false,
-        "created": "2014-04-16T21:33:34.408430Z",
-        "library": "jquery-1.6.4-trim",
-        "last_modified": "2014-06-10T22:12:21.707170Z",
-        "project_status": "Active",
-        "include_jquery": false,
-        "js_file_size": 23693,
-        "id": 859720118,
-        "code_last_modified": "2014-06-10T22:12:20.615820Z",
-        "account_id": 555650815
-      }
-    ]
+   >>> projects = optimizely.Project.list()
+   >>> projects
+   [<Project object with ID: 12345>]
+   
+   >>> my_project = projects[0]
+   >>> my_project.project_name
+   u'My Project'
+   
+   >>> my_project = optimizely.Project.update(12345, {'project_name': 'My Project (Updated)'})
+   >>> my_project.project_name
+   u'My Project (Updated)'
+   
 ```

optimizely/__init__.py

@@ -1,18 +1,31 @@
 import json
 import requests
 
+from errors import *
+
 api_key = ''
 api_base = 'https://www.optimizelyapis.com/experiment/v1/'
 
 
-class APIResource(dict):
+class APIResource(object):
     endpoint = ''
 
-    def __init__(self, *arg, **kw):
-        super(APIResource, self).__init__(*arg, **kw)
+    def __init__(self, params):
+        if type(params) == dict:
+            for (k, v) in params.iteritems():
+                self.__setattr__(k, v)
+        else:
+            raise ValueError('%s can only be initiated with a dict.' % self.__class__.__name__)
+
+    def __repr__(self):
+        if hasattr(self, 'id'):
+            return '<%s object with ID: %s>' % (self.__class__.__name__, self.id)
+        else:
+            return '<%s object without ID>' % self.__class__.__name__
+
 
     @classmethod
-    def from_json(cls, r):
+    def from_api_response(cls, r):
         if r.status_code in [200, 201, 202]:
             if type(r.json()) == list:
                 return [cls(resource) for resource in r.json()]
@@ -21,41 +34,41 @@ def from_json(cls, r):
         elif r.status_code == 204:
             return
         elif r.status_code == 400:
-            raise BadRequestError(r.text)
+            raise BadRequestError(r.json().get('message'))
         elif r.status_code == 401:
-            raise UnauthorizedError(r.text)
+            raise UnauthorizedError(r.json().get('message'))
         elif r.status_code == 403:
-            raise ForbiddenError(r.text)
+            raise ForbiddenError(r.json().get('message'))
         elif r.status_code == 404:
-            raise NotFoundError(r.text)
+            raise NotFoundError(r.json().get('message'))
         elif r.status_code == 429:
-            raise TooManyRequestsError(r.text)
+            raise TooManyRequestsError(r.json().get('message'))
         elif r.status_code == 503:
-            raise ServiceUnavailableError(r.text)
+            raise ServiceUnavailableError(r.json().get('message'))
         else:
             raise OptimizelyError(r.text)
 
     @classmethod
     def list(cls):
-        return cls.from_json(requests.get(api_base + cls.endpoint, headers={'Token': api_key}))
+        return cls.from_api_response(requests.get(api_base + cls.endpoint, headers={'Token': api_key}))
 
     @classmethod
-    def read(cls, pid):
-        return cls.from_json(requests.get(api_base + cls.endpoint + str(pid), headers={'Token': api_key}))
+    def get(cls, pid):
+        return cls.from_api_response(requests.get(api_base + cls.endpoint + str(pid), headers={'Token': api_key}))
 
     @classmethod
     def create(cls, data):
-        return cls.from_json(requests.post(api_base + cls.endpoint, data=json.dumps(data),
-                                           headers={'Token': api_key, 'Content-Type': 'application/json'}))
+        return cls.from_api_response(requests.post(api_base + cls.endpoint, data=json.dumps(data),
+                                                   headers={'Token': api_key, 'Content-Type': 'application/json'}))
 
     @classmethod
-    def put(cls, rid, data):
-        return cls.from_json(requests.put(api_base + cls.endpoint + str(rid), data=json.dumps(data),
-                                          headers={'Token': api_key, 'Content-Type': 'application/json'}))
+    def update(cls, rid, data):
+        return cls.from_api_response(requests.put(api_base + cls.endpoint + str(rid), data=json.dumps(data),
+                                                  headers={'Token': api_key, 'Content-Type': 'application/json'}))
 
     @classmethod
     def delete(cls, pid):
-        return cls.from_json(requests.delete(api_base + cls.endpoint + str(pid), headers={'Token': api_key}))
+        return cls.from_api_response(requests.delete(api_base + cls.endpoint + str(pid), headers={'Token': api_key}))
 
 
 class Project(APIResource):
@@ -66,16 +79,16 @@ def delete(cls, pid):
         raise NotImplementedError('Projects may not be deleted through the API.')
 
     def experiments(self):
-        if not self.get('id'):
+        if not hasattr(self, 'id'):
             raise InvalidIDError('Project is missing its ID.')
-        return Experiment.from_json(requests.get(api_base + self.endpoint + str(self['id']) + '/experiments',
-                                                 headers={'Token': api_key}))
+        return Experiment.from_api_response(requests.get(api_base + self.endpoint + str(self.id) + '/experiments',
+                                                         headers={'Token': api_key}))
 
     def audiences(self):
-        if not self.get('id'):
+        if not hasattr(self, 'id'):
             raise InvalidIDError('Project is missing its ID.')
-        return Audience.from_json(requests.get(api_base + self.endpoint + str(self['id']) + '/audiences',
-                                               headers={'Token': api_key}))
+        return Audience.from_api_response(requests.get(api_base + self.endpoint + str(self.id) + '/audiences',
+                                                       headers={'Token': api_key}))
 
 
 class Experiment(APIResource):
@@ -88,44 +101,46 @@ def list(cls):
 
     @classmethod
     def create(cls, data):
-        return cls.from_json(requests.post(api_base + 'projects/' + str(data['project_id']) + '/' + cls.endpoint,
-                                           data=json.dumps(data),
-                                           headers={'Token': api_key, 'Content-Type': 'application/json'}))
+        return cls.from_api_response(requests.post(api_base + 'projects/' + str(data['project_id']) + '/' +
+                                                   cls.endpoint, data=json.dumps(data),
+                                                   headers={'Token': api_key, 'Content-Type': 'application/json'}))
 
     def results(self):
-        return Result.from_json(requests.get(api_base + self.endpoint + str(self['id']) + '/results',
-                                             headers={'Token': api_key}))
+        return Result.from_api_response(requests.get(api_base + self.endpoint + str(self.id) + '/results',
+                                                     headers={'Token': api_key}))
 
     def variations(self):
-        return Variation.from_json(requests.get(api_base + self.endpoint + str(self['id']) + '/variations',
-                                                headers={'Token': api_key}))
+        return Variation.from_api_response(requests.get(api_base + self.endpoint + str(self.id) + '/variations',
+                                                        headers={'Token': api_key}))
 
     def add_goal(self, gid):
-        goal = Goal.read(gid)
-        return Goal.from_json(Goal.put(goal.get('id'),
-                                       {'experiment_ids': goal.get('experiment_ids').append(self['id'])}))
+        goal = Goal.get(gid)
+        return Goal.from_api_response(Goal.update(goal.id, {'experiment_ids': goal.experiment_ids.append(self.id)}))
 
     def remove_goal(self, gid):
-        goal = Goal.read(gid)
-        experiment_ids = list(set(goal.get('experiment_ids')).remove(self['id']))
-        return Goal.from_json(Goal.put(goal.get('id'), {'experiment_ids': experiment_ids}))
+        goal = Goal.get(gid)
+        experiment_ids = list(set(goal.experiment_ids).remove(self.id))
+        return Goal.from_api_response(Goal.update(goal.id, {'experiment_ids': experiment_ids}))
 
 
 class Result(APIResource):
+    def __repr__(self):
+        return '<%s object>' % self.__class__.__name__
+
     @classmethod
     def list(cls):
         raise NotImplementedError('There is no method to list all results. Try using Experiment.results() instead.')
 
     @classmethod
-    def read(cls, pid):
+    def get(cls, pid):
         raise NotImplementedError('There is no method to get a single result.')
 
     @classmethod
     def create(cls, data):
         return NotImplementedError('There is no method to create a result.')
 
     @classmethod
-    def put(cls, pid, data):
+    def update(cls, pid, data):
         return NotImplementedError('There is no method to update a result.')
 
     @classmethod
@@ -142,9 +157,9 @@ def list(cls):
 
     @classmethod
     def create(cls, data):
-        return cls.from_json(requests.post(api_base + 'experiments/' + str(data['experiment_id']) + '/' + cls.endpoint,
-                                           data=json.dumps(data),
-                                           headers={'Token': api_key, 'Content-Type': 'application/json'}))
+        return cls.from_api_response(requests.post(api_base + 'experiments/' + str(data['experiment_id']) + '/' +
+                                                   cls.endpoint, data=json.dumps(data),
+                                                   headers={'Token': api_key, 'Content-Type': 'application/json'}))
 
 
 class Goal(APIResource):
@@ -156,9 +171,9 @@ def list(cls):
 
     @classmethod
     def create(cls, data):
-        return cls.from_json(requests.post(api_base + 'projects/' + str(data['project_id']) + '/' + cls.endpoint,
-                                           data=json.dumps(data),
-                                           headers={'Token': api_key, 'Content-Type': 'application/json'}))
+        return cls.from_api_response(requests.post(api_base + 'projects/' + str(data['project_id']) + '/' +
+                                                   cls.endpoint, data=json.dumps(data),
+                                                   headers={'Token': api_key, 'Content-Type': 'application/json'}))
 
 
 class Audience(APIResource):
@@ -170,47 +185,6 @@ def list(cls):
 
     @classmethod
     def create(cls, data):
-        return cls.from_json(requests.post(api_base + 'projects/' + str(data['project_id']) + '/' + cls.endpoint,
-                                           data=json.dumps(data),
-                                           headers={'Token': api_key, 'Content-Type': 'application/json'}))
-
-
-class OptimizelyError(Exception):
-    """ General exception for all Optimizely Experiments API related issues."""
-    pass
-
-
-class BadRequestError(OptimizelyError):
-    """ Exception for when request was not sent in valid JSON."""
-    pass
-
-
-class UnauthorizedError(OptimizelyError):
-    """ Exception for when API token is missing or included in the body rather than the header."""
-    pass
-
-
-class ForbiddenError(OptimizelyError):
-    """ Exception for when API token is provided but it is invalid or revoked."""
-    pass
-
-
-class NotFoundError(OptimizelyError):
-    """ Exception for when the id used in request is inaccurate or token user doesn't have permission to
-    view/edit it."""
-    pass
-
-
-class TooManyRequestsError(OptimizelyError):
-    """ Exception for when a rate limit for the API is hit."""
-    pass
-
-
-class ServiceUnavailableError(OptimizelyError):
-    """ Exception for when the API is overloaded or down for maintenance."""
-    pass
-
-
-class InvalidIDError(OptimizelyError):
-    """ Exception for when object is missing its ID."""
-    pass
+        return cls.from_api_response(requests.post(api_base + 'projects/' + str(data['project_id']) + '/' +
+                                                   cls.endpoint, data=json.dumps(data),
+                                                   headers={'Token': api_key, 'Content-Type': 'application/json'}))

optimizely/errors.py

@@ -0,0 +1,39 @@
+class OptimizelyError(Exception):
+    """ General exception for all Optimizely Experiments API related issues."""
+    pass
+
+
+class BadRequestError(OptimizelyError):
+    """ Exception for when request was not sent in valid JSON."""
+    pass
+
+
+class UnauthorizedError(OptimizelyError):
+    """ Exception for when API token is missing or included in the body rather than the header."""
+    pass
+
+
+class ForbiddenError(OptimizelyError):
+    """ Exception for when API token is provided but it is invalid or revoked."""
+    pass
+
+
+class NotFoundError(OptimizelyError):
+    """ Exception for when the id used in request is inaccurate or token user doesn't have permission to
+    view/edit it."""
+    pass
+
+
+class TooManyRequestsError(OptimizelyError):
+    """ Exception for when a rate limit for the API is hit."""
+    pass
+
+
+class ServiceUnavailableError(OptimizelyError):
+    """ Exception for when the API is overloaded or down for maintenance."""
+    pass
+
+
+class InvalidIDError(OptimizelyError):
+    """ Exception for when object is missing its ID."""
+    pass

tests/README.md

@@ -0,0 +1,14 @@
+# Optimizely Python Client Tests #
+
+(THIS IS CURRENTLY A PLACEHOLDER FILE)
+
+To run these tests in Python 2.7, use the `unittest` test runner:
+
+    $ python -m unittest discover -s tests
+
+Under Python 2.6 or earlier, install the `unittest2` distribution and use it
+instead:
+
+    $ pip install unittest2  # or easy_install
+    $ python -m unittest2 discover -s tests
+