atomx.Atomx.get also accepts a model class or instance as resource argument

Author: dakra

CHANGES.txt

@@ -14,6 +14,8 @@
 
 - Add :meth:`atomx.models.ScheduledReport.save` to edit ``name`` and ``emails``
   of a :class:`atomx.models.ScheduledReport`
+- :meth:`atomx.Atomx.get` also accepts a model class or instance as resource argument.
+  E.g.: ``atomx_api.get(atomx.models.Advertiser)`` or ``atomx_api.get(atomx.models.Advertiser(42))``
 
 
 1.4

atomx/__init__.py

@@ -4,6 +4,7 @@
     datetime,
     timedelta,
 )
+from inspect import isclass
 import requests
 from atomx.version import API_VERSION, VERSION
 from atomx import models
@@ -78,7 +79,7 @@ def login(self, email=None, password=None):
                 raise InvalidCredentials
             raise APIError(r.json()['error'])
         self.auth_tkt = r.json()['auth_tkt']
-        self.user = models.User(**r.json()['user'])
+        self.user = models.User(session=self, **r.json()['user'])
 
     def logout(self):
         """Removes authentication token from session."""
@@ -236,9 +237,9 @@ def report(self, scope=None, groups=None, metrics=None, where=None, from_=None,
             self.last_response = r_json
 
         if is_scheduled_report:
-            return models.ScheduledReport(self, **report)
+            return models.ScheduledReport(session=self, **report)
 
-        return models.Report(self, **report)
+        return models.Report(session=self, **report)
 
     def report_status(self, report):
         """Get the status for a `report`.
@@ -314,6 +315,8 @@ def get(self, resource, *args, **kwargs):
                 >>> publisher = atomx.get('publisher/23')
                 >>>> # or get the same publisher using the id as parameter
                 >>> publisher = atomx.get('publisher', 23)
+                >>>> # or use an atomx model
+                >>> publisher = atomx.get(atomx.models.Publisher(23))
                 >>> assert publisher.id == 23
                 >>> assert isinstance(publisher, atomx.models.Publisher)
 
@@ -347,7 +350,15 @@ def get(self, resource, *args, **kwargs):
 
         :return: a class from :mod:`.models` or a list of models depending on param `resource`
         """
-        resource = resource.strip('/')
+        if isclass(resource) and issubclass(resource, models.AtomxModel):
+            resource = resource._resource_name
+        elif isinstance(resource, models.AtomxModel):
+            resource_path = resource._resource_name
+            if hasattr(resource, 'id'):
+                resource_path += '/' + str(resource.id)
+            resource = resource_path
+        else:
+            resource = resource.strip('/')
         for a in args:
             resource += '/' + str(a)
         r = self.session.get(self.api_endpoint + resource, params=kwargs)
@@ -363,12 +374,12 @@ def get(self, resource, *args, **kwargs):
         model = get_model_name(model_name)
         if model and res:
             if isinstance(res, list):
-                return [getattr(models, model)(self, **m) for m in res]
-            return getattr(models, model)(self, **res)
+                return [getattr(models, model)(session=self, **m) for m in res]
+            return getattr(models, model)(session=self, **res)
         elif model_name == 'reporting':  # special case for `/reports` status
             return {
-                'reports': [models.Report(self, **m) for m in res['reports']],
-                'scheduled': [models.ScheduledReport(self, **m) for m in res['scheduled']]
+                'reports': [models.Report(session=self, **m) for m in res['reports']],
+                'scheduled': [models.ScheduledReport(session=self, **m) for m in res['scheduled']]
             }
         return res
 
@@ -394,7 +405,7 @@ def post(self, resource, json, **kwargs):
             self.last_response = r_json
         model = get_model_name(model_name)
         if model and isinstance(res, list):
-            return [getattr(models, model)(self, **m) for m in res]
+            return [getattr(models, model)(session=self, **m) for m in res]
         return res
 
     def put(self, resource, id, json, **kwargs):

atomx/models.py

@@ -8,6 +8,7 @@
     from io import StringIO
 except ImportError:  # py2
     from StringIO import StringIO
+from atomx.utils import _class_property
 from atomx.exceptions import (
     NoSessionError,
     ModelNotFoundError,
@@ -26,15 +27,11 @@
 class AtomxModel(object):
     """A generic atomx model that the other models from :mod:`atomx.models` inherit from.
 
+    :param int id: Optional model ID. Can also be passed in via `attributes` as `id`.
     :param atomx.Atomx session: The :class:`atomx.Atomx` session to use for the api requests.
     :param attributes: model attributes
     """
-    def __init__(self, session=None, **attributes):
-        """Atomx model for {model}. test
-        :param session: session
-        :param attributes: attributes
-        :return: model.{model}
-        """
+    def __init__(self, id=None, session=None, **attributes):
         for k, v in attributes.items():
             if k.endswith('_at'):
                 try:
@@ -46,6 +43,8 @@ def __init__(self, session=None, **attributes):
                     attributes[k] = datetime.strptime(v, '%Y-%m-%d')
                 except (ValueError, TypeError):
                     pass
+        if id is not None:
+            attributes['id'] = id
 
         super(AtomxModel, self).__setattr__('session', session)
         super(AtomxModel, self).__setattr__('_attributes', attributes)
@@ -96,10 +95,10 @@ def __repr__(self):
     def __eq__(self, other):
         return self.id == getattr(other, 'id', 'INVALID')
 
-    @property
-    def _resource_name(self):
+    @_class_property
+    def _resource_name(cls):
         from atomx.utils import model_name_to_rest
-        return model_name_to_rest(self.__class__.__name__)
+        return model_name_to_rest(cls.__name__)
 
     @property
     def _dirty_json(self):
@@ -196,7 +195,7 @@ class ScheduledReport(object):
     <https://wiki.atomx.com/reporting#scheduling_reports>`_.
     """
 
-    def __init__(self, session, id, name, emails, query, **kwargs):
+    def __init__(self, id, session, name, emails, query, **kwargs):
         self.session = session
         self.id = id
         self.name = name
@@ -229,7 +228,7 @@ def delete(self, session=None):
 class Report(object):
     """Represents a `report` you get back from :meth:`atomx.Atomx.report`."""
 
-    def __init__(self, session, query, fast, id, lines, error, link,
+    def __init__(self, id, session, query, fast, lines, error, link,
                  started, finished, is_ready, duration, name, **kwargs):
         self.session = session
         self.query = query

atomx/utils.py

@@ -72,3 +72,12 @@ def model_name_to_rest(name):
             r += '-'
         r += name[i]
     return r.lower()
+
+
+class _class_property(object):
+    """Decorator to create @classmethod and @property"""
+    def __init__(self, f):
+        self.f = f
+
+    def __get__(self, obj, owner):
+        return self.f(owner)