fix save, update

better example
add first tests

Author: dakra

README.rst

@@ -10,18 +10,44 @@ Example Usage:
 
     from atomx import Atomx
 
-    atomx = Atomx('daniel@atomx.com', 'password')
-    creatives = atomx.get('Creatives', limit=10)
+    # create atomx session
+    atomx = Atomx('user@example.com', 'password')
 
+    # get 10 creatives
+    creatives = atomx.get('Creatives', limit=10)
+    # the result is a list of `atomx.models.Creative` models
+    # that you can easily inspect, manipulate and update
     for creative in creatives:
         print('Creative ID: {c.id}, state: {c.state}, '
               'name: {c.name}, title: {c.title}'.format(c=creative))
 
+    # update title for the first creative in list
     creative = creatives[0]
     creative.title = 'shiny new title'
+    # the session is inherited from `atomx` that made the get request
     creative.update()
 
 
+    # create a new profile
+    from atomx.models import Profile
+    profile = Profile(advertiser_id=23, name='test profile')
+    # Note that you have to pass it a valid `Atomx` session for save
+    # or use `atomx.save(profile)`
+    profile.save(atomx)
+
+    # now you could alter and update it like the creative above
+    profile.name = 'changed name'
+    profile.update()
+
+
+    # you can also get attributes
+    profiles = atomx.get('advertiser/88/profiles')
+    # profiles is now a list of `atomx.models.Profile` that you can
+    # read, update, etc again.
+    profiles[0].click_frequency_cap_per = 86400
+    profiles[0].update()
+
+
 Installation
 ------------
 

atomx/__init__.py

@@ -16,9 +16,11 @@
 __author__ = 'Spot Media Solutions Sdn. Bhd.'
 __copyright__ = 'Copyright 2015 Spot Media Solutions Sdn. Bhd.'
 
+API_ENDPOINT = 'http://api.atomx.com/{}/'.format(API_VERSION)
+
 
 class Atomx(object):
-    def __init__(self, email, password, api_endpoint='http://api.atomx.com/{}/'.format(API_VERSION)):
+    def __init__(self, email, password, api_endpoint=API_ENDPOINT):
         self.email = email
         self.password = password
         self.api_endpoint = api_endpoint
@@ -48,25 +50,40 @@ def search(self, query):
             raise APIError(r.json()['error'])
         return r.json()['search']
 
-    def get(self, model, **kwargs):
-        model = get_model_name(model)
-        if not model:
-            raise ModelNotFoundError()
-        r = self.session.get(self.api_endpoint + model, params=kwargs)
+    def get(self, resource, **kwargs):
+        r = self.session.get(self.api_endpoint + resource, params=kwargs)
         if not r.ok:
             raise APIError(r.json()['error'])
 
         r_json = r.json()
-        model_name = model.lower()
-        if model_name in r_json:
-            return getattr(models, model)(self, **r_json[model_name])
-        return [getattr(models, model)(self, **m) for m in r_json[model_name + 's']]
+        model_name = r_json['resource']
+        res = r_json[model_name]
+        model = get_model_name(model_name)
+        if model:
+            if isinstance(res, list):
+                return [getattr(models, model)(self, **m) for m in res]
+            return getattr(models, model)(self, **res)
+        return res
 
     def post(self, model, json, **kwargs):
-        return self.session.post(self.api_endpoint + model, json=json, params=kwargs)
+        r = self.session.post(self.api_endpoint + model, json=json, params=kwargs)
+        r_json = r.json()
+        if not r.ok:
+            raise APIError(r_json['error'])
+        return r_json[r_json['resource']]
 
     def put(self, model, id, json, **kwargs):
-        return self.session.put(self.api_endpoint + model + '/' + str(id), json=json, params=kwargs)
+        r = self.session.put(self.api_endpoint + model + '/' + str(id), json=json, params=kwargs)
+        r_json = r.json()
+        if not r.ok:
+            raise APIError(r_json['error'])
+        return r_json[r_json['resource']]
 
     def delete(self, model, id, json, **kwargs):
         return self.session.put(self.api_endpoint + model + '/' + str(id), json=json, params=kwargs)
+
+    def save(self, model):
+        return model.save(self)
+
+    def update(self, model):
+        return model.update(self)

atomx/models.py

@@ -33,14 +33,20 @@ def json(self):
         return self._attributes
 
     def save(self, session=None):
-        if not session and not self.session:
+        session = session or self.session
+        if not session:
             raise NoSessionError
-        return self.session.post(self.__class__.__name__, json=self._dirty_json)
+        res = session.post(self.__class__.__name__, json=self.json)
+        self.__init__(session=session, **res)
+        return self
 
     def update(self, session=None):
-        if not session and not self.session:
+        session = session or self.session
+        if not session:
             raise NoSessionError
-        return self.session.put(self.__class__.__name__, self.id, json=self._dirty_json)
+        res = self.session.put(self.__class__.__name__, self.id, json=self._dirty_json)
+        self.__init__(session=session, **res)
+        return self
 
     def delete(self, session=None):
         if not session and not self.session:

tests.py

@@ -0,0 +1,28 @@
+import pytest
+
+
+@pytest.fixture(scope="session")
+def atomx():
+    from .atomx import Atomx
+    return Atomx('daniel@atomx.com', 'password')
+
+
+def test_limit(atomx):
+    creatives = atomx.get('creatives', limit=5)
+    assert len(creatives) == 5
+
+def test_update(atomx):
+    NEW_TITLE = 'test title'
+    creative = atomx.get('creatives', id=5)
+    creative.title = NEW_TITLE
+    creative.update()
+    creative = atomx.get('creatives', id=5)
+    assert creative.title == NEW_TITLE
+
+
+def test_save(atomx):
+    from .atomx.models import Profile
+    profile = Profile(advertiser_id=23, name='test advertiser')
+    profile.save()
+    profile_new = atomx.get(Profile, id=profile.id)
+    assert profile.name == profile_new.name