Merge pull request #50 from scrapinghub/drop-activity-post-method

Merge Activity post() logic into add()

Author: chekunkov

README.rst

@@ -385,6 +385,32 @@ To retrieve all samples for a job::
     [1482233732452, 0, 0, 0, 0, 0]
 
 
+Activity
+--------
+
+To retrieve all activity events from a project::
+
+    >>> project.activity.iter()
+    <generator object jldecode at 0x1049ee990>
+
+    >>> project.activity.list()
+    [{'event': 'job:completed', 'job': '123/2/3', 'user': 'jobrunner'},
+     {'event': 'job:cancelled', 'job': '123/2/3', 'user': 'john'}]
+
+To post a new activity event::
+
+    >>> event = {'event': 'job:completed', 'job': '123/2/4', 'user': 'john'}
+    >>> project.activity.add(event)
+
+Or post multiple events at once::
+
+    >>> events = [
+        {'event': 'job:completed', 'job': '123/2/5', 'user': 'john'},
+        {'event': 'job:cancelled', 'job': '123/2/6', 'user': 'john'},
+    ]
+    >>> project.activity.add(events)
+
+
 Collections
 -----------
 

scrapinghub/client.py

@@ -1031,24 +1031,41 @@ class Activity(_Proxy):
 
     - get only last 2 events from a project::
 
-        >>> p.activity.list(count=2)
+        >>> project.activity.list(count=2)
         [{'event': 'job:completed', 'job': '123/2/3', 'user': 'jobrunner'},
-         {'event': 'job:cancelled', 'job': '123/2/3', 'user': 'john'}]
+         {'event': 'job:started', 'job': '123/2/3', 'user': 'john'}]
+
+    - post a new event::
+
+        >>> event = {'event': 'job:completed',
+                     'job': '123/2/4',
+                     'user': 'jobrunner'}
+        >>> project.activity.add(event)
+
+    - post multiple events at once::
+
+        >>> events = [
+            {'event': 'job:completed', 'job': '123/2/5', 'user': 'jobrunner'},
+            {'event': 'job:cancelled', 'job': '123/2/6', 'user': 'john'},
+        ]
+        >>> project.activity.add(events)
+
     """
     def __init__(self, *args, **kwargs):
         super(Activity, self).__init__(*args, **kwargs)
         self._proxy_methods([('iter', 'list')])
         self._wrap_iter_methods(['iter'])
 
-    def add(self, *args, **kwargs):
-        entry = dict(*args, **kwargs)
-        return self.post(entry)
-
-    def post(self, _value, **kwargs):
-        jobkey = _value.get('job') or kwargs.get('job')
-        if jobkey and parse_job_key(jobkey).projectid != self.key:
-            raise ValueError('Please use same project id')
-        self._origin.post(_value, **kwargs)
+    def add(self, values, **kwargs):
+        if not isinstance(values, list):
+            values = list(values)
+        for activity in values:
+            if not isinstance(activity, dict):
+                raise ValueError("Please pass events as dictionaries")
+            jobkey = activity.get('job')
+            if jobkey and parse_job_key(jobkey).projectid != self.key:
+                raise ValueError('Please use same project id')
+        self._origin.post(values, **kwargs)
 
 
 class Collections(_Proxy):

tests/client/test_proxy.py

@@ -272,14 +272,15 @@ def test_items_list(spider):
 def _add_test_activity(project):
     activity = project.activity
     jobkey = TEST_PROJECT_ID + '/2/3'
-    activity.add(event='job:completed', job=jobkey, user='jobrunner')
-    activity.add(event='job:cancelled', job=jobkey, user='john')
+    events = [{'event': 'job:completed', 'job': jobkey, 'user': 'jobrunner'},
+              {'event': 'job:cancelled', 'job': jobkey, 'user': 'john'}]
+    activity.add(events)
 
 
 def test_activity_wrong_project(project):
+    event = {'event': 'job:completed', 'job': '123/1/1', 'user': 'user'}
     with pytest.raises(ValueError):
-        project.activity.add(event='job:completed',
-                             job='123/1/1', user='user')
+        project.activity.add(event)
 
 
 def test_activity_iter(project):