:meth:atomx.Atomx.get and delete accept non-keyword arguments that are used to compute the resource path.

Author: dakra

CHANGES.txt

@@ -2,7 +2,8 @@
 ----------------
 
 - add :meth:`atomx.Atomx.delete` to send a ``HTTP DELETE`` request to the api
-
+- :meth:`atomx.Atomx.get` and :meth:`atomx.Atomx.delete` accept non-keyword arguments
+    that are used to compute the final resource path.
 
 1.2
 ---

README.rst

@@ -47,7 +47,9 @@ Example Usage
 
 
     # you can also get attributes
-    profiles = atomx.get('advertiser/88/profiles')
+    profiles = atomx.get('advertiser', 88, 'profiles')
+    # equivalent is to pass the complete resource path as string instead of arguments
+    profiles = atomx.get('advertiser/88/profiles')  # same as above
     # profiles is now a list of `atomx.models.Profile` that you can
     # read, update, etc again.
     profiles[0].click_frequency_cap_per = 86400

atomx/__init__.py

@@ -252,7 +252,7 @@ def report_get(self, report, sort=None, limit=None, offset=None):
             raise APIError(r.json()['error'])
         return r.content.decode()
 
-    def get(self, resource, **kwargs):
+    def get(self, resource, *args, **kwargs):
         """Returns a list of models from :mod:`.models` if you query for
         multiple models or a single instance of a model from :mod:`.models`
         if you query for a specific `id`
@@ -271,6 +271,8 @@ def get(self, resource, **kwargs):
             Get publisher with id 23::
 
                 >>> publisher = atomx.get('publisher/23')
+                >>>> # or get the same publisher using the id as parameter
+                >>> publisher = atomx.get('publisher', 23)
                 >>> assert publisher.id == 23
                 >>> assert isinstance(publisher, atomx.models.Publisher)
 
@@ -281,6 +283,16 @@ def get(self, resource, **kwargs):
                 >>> assert isinstance(profiles[0], atomx.models.Profile)
                 >>> assert profiles[0].advertiser.id == 42
 
+        :param args: All non-keyword arguments will get used to compute the ``resource``.
+            This makes it easier if you want to work with a variable resource path.
+
+            .. code-block:: python
+
+                advertiser_id = 42
+                attribute = 'profiles'
+                profiles = atomx.get('advertiser', advertiser_id, attribute)
+                # is equivalent to atomx.get('advertiser/42/profiles')
+
         :param kwargs: Any argument is passed as URL parameter to the respective api endpoint.
             See `API URL Parameters <http://wiki.atomx.com/doku.php?id=api#url_parameters>`_
             in the wiki.
@@ -294,7 +306,10 @@ def get(self, resource, **kwargs):
 
         :return: a class from :mod:`.models` or a list of models depending on param `resource`
         """
-        r = self.session.get(self.api_endpoint + resource.strip('/'), params=kwargs)
+        resource = resource.strip('/')
+        for a in args:
+            resource += '/' + str(a)
+        r = self.session.get(self.api_endpoint + resource, params=kwargs)
         if not r.ok:
             raise APIError(r.json()['error'])
 
@@ -346,13 +361,19 @@ def put(self, resource, id, json, **kwargs):
             raise APIError(r_json['error'])
         return r_json[r_json['resource']]
 
-    def delete(self, resource, **kwargs):
+    def delete(self, resource, *args, **kwargs):
         """Send HTTP DELETE to ``resource``.
 
         :param resource: Name of the resource to `DELETE`.
+        :param args: All non-keyword arguments will be used to compute the final ``resource``.
+        :param kwargs: Optional keyword arguments will be passed as query string to the
+            delete request.
         :return: message or resource returned by the api.
         """
-        r = self.session.delete(self.api_endpoint + resource.strip('/'), params=kwargs)
+        resource = resource.strip('/')
+        for a in args:
+            resource += '/' + str(a)
+        r = self.session.delete(self.api_endpoint + resource, params=kwargs)
         r_json = r.json()
         if not r.ok:
             raise APIError(r_json['error'])

atomx/models.py

@@ -154,7 +154,7 @@ def reload(self, session=None):
         if not hasattr(self, 'id'):
             raise ModelNotFoundError("Can't reload without 'id' parameter. "
                                      "Forgot to save() first?")
-        res = session.get(self._resource_name + '/' + str(self.id))
+        res = session.get(self._resource_name, self.id)
         self.__init__(session=session, **res.json)
         return self
 

docs/usage.rst

@@ -56,6 +56,20 @@ Or query all profiles of advertiser 42 ordered by last updated:
     profiles = atomx.get('advertiser/42/profiles', order_by='updated_at.desc')
 
 
+All non-keyword arguments that you pass :meth:`atomx.Atomx.get` will get used
+to compute the ``resource``. This makes it easier if you have the ``id``
+(and/or attribute) stored in a variable.
+
+E.g.
+
+.. code-block:: python
+
+    advertiser_id = 42
+    attribute = 'profiles'
+    profiles = atomx.get('advertiser', advertiser_id, attribute)
+    # is equivalent to atomx.get('advertiser/42/profiles')
+
+
 Or get all domains where the hostname contains `atom`:
 
 .. code-block:: python