add report.get method with limit and sort params

fix api.get for advertisers/publishers/networkds_list

Author: dakra

atomx/__init__.py

@@ -7,7 +7,10 @@
 import requests
 from atomx.version import API_VERSION, VERSION
 from atomx import models
-from atomx.utils import get_model_name
+from atomx.utils import (
+    get_model_name,
+    model_name_to_rest,
+)
 from atomx.exceptions import (
     APIError,
     ModelNotFoundError,
@@ -213,7 +216,7 @@ def report_status(self, report):
             raise APIError(r.json()['error'])
         return r.json()['report']
 
-    def report_get(self, report):
+    def report_get(self, report, limit=None, sort=None):
         """Get the content (csv) of a :class:`.models.Report`
 
         Typically used by calling :meth:`.models.Report.content` or
@@ -229,7 +232,13 @@ def report_get(self, report):
         else:
             report_id = report
 
-        r = self.session.get(self.api_endpoint + 'report/' + report_id)
+        params = {}
+        if limit:
+            params['limit'] = int(limit)
+        if sort:
+            params['sort'] = sort
+
+        r = self.session.get(self.api_endpoint + 'report/' + report_id, params=params)
         if not r.ok:
             raise APIError(r.json()['error'])
         return r.content.decode()
@@ -286,6 +295,9 @@ def get(self, resource, **kwargs):
         model = get_model_name(model_name)
         if model:
             if isinstance(res, list):
+                if model_name.endswith('_list'):
+                    # special case for _list requests
+                    res = [{'id': id, 'name': name} for id, name in res]
                 return [getattr(models, model)(self, **m) for m in res]
             return getattr(models, model)(self, **res)
         return res

atomx/models.py

@@ -207,6 +207,19 @@ def status(self):
         self.__init__(session=self.session, **status)
         return self
 
+    def get(self, limit=None, sort=None):
+        """Get the first ``limit`` lines of the report ``content``
+        and in the specified ``sort`` order.
+
+        :param int limit: limit the amount of lines to return (defaults to no limit)
+        :param str sort: defines the sort order of the report content.
+            ``sort`` can be `column_name`[.asc|.desc][,column_name[.asc|.desc]]...
+        :return: report content
+        """
+        if not self.is_ready:
+            raise ReportNotReadyError()
+        return self.session.report_get(self, limit=limit, sort=sort)
+
     @property
     def content(self):
         """Returns the content (csv) of the `report`."""

atomx/utils.py

@@ -4,24 +4,30 @@
 
 def get_model_name(name):
     """Checks that :param:`name` is a valid model.
-    Converts plural `name` to capitalized singular form and '-' or '_' separation to camelCase.
+    Converts plural `name` to capitalized singular form,
+    rstrips '_list' (e.g. `advertisers_list`)
+    and '-' or '_' separation to camelCase.
     Returns the name of the model if found, False otherwise.
     E.g.
 
-    >>> check_model_name("countries")
+    >>> check_model_name('countries')
     "Country"
-    >>> check_model_name("ADVERTISERS")
+    >>> check_model_name('ADVERTISERS')
     "Advertiser"
-    >>> check_model_name("conversion-pixels")
+    >>> check_model_name('conversion-pixels')
     "ConversionPixel"
-    >>> check_model_name("operating_system")
+    >>> check_model_name('operating_system')
     "OperatingSystem"
-    >>> check_model_name("InvalidModel")
+    >>> check_model_name('InvalidModel')
     False
+    >>> check_model_name('advertisers_list')
+    "Advertiser"
 
     :param str name: model name to convert
     :return: name of the model or False
     """
+    if name.endswith('_list'):
+        name = name[:-5]
     if '-' in name:
         model_name = ''.join(m.capitalize() for m in name.split('-'))
     elif '_' in name:
@@ -55,7 +61,7 @@ def model_name_to_rest(name):
 
         >>> assert model_name_to_rest('ConversionPixels') ==  'conversion-pixels'
         >>> assert model_name_to_rest('OperatingSystem') == 'operating-system'
-        >>> assert model_name_to_rest('Advertiser') == 'Advertiser'
+        >>> assert model_name_to_rest('Advertiser') == 'advertiser'
 
     :param str name: Name of the model to convert
     :return: :class:`str` with the transformed name.