add project and experiment support

Author: Andy Harris

.gitignore

@@ -2,11 +2,9 @@
 __pycache__/
 *.py[cod]
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
+.idea/
 env/
 build/
 develop-eggs/
@@ -31,24 +29,3 @@ var/
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.cache
-nosetests.xml
-coverage.xml
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/

README.md

@@ -2,3 +2,48 @@ Optimizely Python Client
 =================
 
 Optimizely's Python client library is an interface to its [REST API](http://developers.optimizely.com/rest/).
+
+
+Usage
+-----
+
+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
+      }
+    ]
+```

optimizely/__init__.py

@@ -0,0 +1,112 @@
+import json
+import requests
+
+api_key = ''
+api_base = 'https://www.optimizelyapis.com/experiment/v1/'
+
+
+class APIResource(object):
+    endpoint = ''
+
+    def __init__(self):
+        raise NotImplementedError(self.__class__.__name__ +
+                                  ' contains only class methods and should not be instantiated.')
+
+    @staticmethod
+    def _parse_response(r):
+        if r.status_code in [200, 201, 202, 204]:
+            return r.json()
+        elif r.status_code == 400:
+            raise BadRequestError(r.text)
+        elif r.status_code == 401:
+            raise UnauthorizedError(r.text)
+        elif r.status_code == 403:
+            raise ForbiddenError(r.text)
+        elif r.status_code == 404:
+            raise NotFoundError(r.text)
+        elif r.status_code == 429:
+            raise TooManyRequestsError(r.text)
+        elif r.status_code == 503:
+            raise ServiceUnavailableError(r.text)
+        else:
+            raise OptimizelyError(r.text)
+
+    @classmethod
+    def all(cls):
+        return cls._parse_response(requests.get(api_base + cls.endpoint, headers={'Token': api_key}))
+
+    @classmethod
+    def get(cls, pid):
+        return cls._parse_response(requests.get(api_base + cls.endpoint + str(pid), headers={'Token': api_key}))
+
+    @classmethod
+    def create(cls, data):
+        return cls._parse_response(requests.post(api_base + cls.endpoint, data=json.dumps(data),
+                                                 headers={'Token': api_key, 'Content-Type': 'application/json'}))
+
+    @classmethod
+    def update(cls, pid, data):
+        return cls._parse_response(requests.put(api_base + cls.endpoint + str(pid), data=json.dumps(data),
+                                                headers={'Token': api_key, 'Content-Type': 'application/json'}))
+
+    @classmethod
+    def delete(cls, pid):
+        return cls._parse_response(requests.delete(api_base + cls.endpoint + str(pid), headers={'Token': api_key}))
+
+
+class Project(APIResource):
+    endpoint = 'projects/'
+
+
+class Experiment(APIResource):
+    endpoint = 'experiments/'
+
+    @classmethod
+    def all(cls):
+        raise NotImplementedError('There is no method to get all experiments. Try using get_from_project() instead.')
+
+    @classmethod
+    def get_from_project(cls, pid):
+        return cls._parse_response(requests.get(api_base + Project.endpoint + str(pid) + '/' + cls.endpoint,
+                                                headers={'Token': api_key}))
+
+    @classmethod
+    def get_results(cls, eid):
+        return cls._parse_response(requests.get(api_base + cls.endpoint + str(eid) + '/results',
+                                                headers={'Token': api_key}))
+
+
+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