Add history support atomx.models.AtomxModel.history

Author: dakra

CHANGES.txt

@@ -7,7 +7,6 @@
 - Add new models:
 
   * :class:`atomx.models.AccountManager` (alias for `User`)
-  * :class:`atomx.models.BanReason`
   * :class:`atomx.models.PlacementType`
   * :class:`atomx.models.CampaignDebugReason`
   * :class:`atomx.models.Visibility`
@@ -18,6 +17,7 @@
   E.g.: ``atomx_api.get(atomx.models.Advertiser)`` or ``atomx_api.get(atomx.models.Advertiser(42))``
 - Add :mod:`pickle` support for :mod:`atomx.models`.
 - Save HTTP headers in :attr:`atomx.Atomx.last_response`.
+- Add history support. :meth:`atomx.models.AtomxModel.history`.
 
 
 1.4

README.rst

@@ -64,6 +64,7 @@ Example Usage
     publisher = s['publisher'][0]  # get the first publisher..
     publisher.reload()  # .. and load all the data
     print(publisher)  # now all publisher data is there
+    publisher.history()  # gets all changes made to this publisher
 
 
     # reporting example

atomx/models.py

@@ -17,7 +17,7 @@
     NoPandasInstalledError,
 )
 
-__all__ = ['AccountManager', 'Advertiser', 'BanReason', 'Bidder', 'Browser', 'CampaignDebugReason',
+__all__ = ['AccountManager', 'Advertiser', 'Bidder', 'Browser', 'CampaignDebugReason',
            'Campaign', 'Category', 'ConnectionType', 'ConversionPixel', 'Country', 'Creative',
            'Datacenter', 'DeviceType', 'Domain', 'Fallback', 'Isp', 'Languages', 'Network',
            'OperatingSystem', 'Placement', 'PlacementType', 'Profile', 'Publisher', 'Reason',
@@ -81,9 +81,9 @@ def __setattr__(self, key, value):
     def __delattr__(self, item):
         if item in self._dirty:
             self._dirty.remove(item)
-        else:
-            self._attributes[item] = None
-            self._dirty.add(item)
+
+        self._attributes[item] = [] if isinstance(self._attributes[item], list) else None
+        self._dirty.add(item)
 
     def __dir__(self):
         """Manually add dynamic attributes for autocomplete"""
@@ -190,6 +190,27 @@ def reload(self, session=None):
         self.__init__(session=session, **res.json)
         return self
 
+    def history(self, session=None, offset=0, limit=100, sort='date.asc'):
+        """Show the changelog of the model.
+
+        :param session: The :class:`atomx.Atomx` session to use for the api call.
+            (Optional if you specified a `session` at initialization)
+        :param int offset: Skip first ``offset`` history entries. (default: 0)
+        :param int limit: Only return ``limit`` history entries. (default: 100)
+        :param str sort: Sort by `date.asc` or `date.desc`. (default: 'date.asc')
+        :return: `list` of `dict`s with `date`, `user` and the attributes that changed (`history`).
+        :rtype: list
+        """
+        session = session or self.session
+        if not session:
+            raise NoSessionError
+        if not hasattr(self, 'id'):
+            raise ModelNotFoundError("Can't reload without 'id' parameter. "
+                                     "Forgot to save() first?")
+        res = session.get('history', self._resource_name, self.id,
+                          offset=offset, limit=limit, sort=sort)
+        return res
+
 
 for m in __all__:
     locals()[m] = type(m, (AtomxModel,),

docs/usage.rst

@@ -95,6 +95,13 @@ Or to get the advertiser for a profile, just:
     advertiser = profiles[0].advertiser
 
 
+You can get a list of all changes with :meth:`atomx.models.AtomxModel.history`.
+
+.. code-block:: python
+
+    advertiser.history()
+
+
 Updating models
 ---------------