Dataset.json use dataset frequency as the default one

Author: Dario Varotto

ravenpackapi/core.py

@@ -14,7 +14,7 @@
 from ravenpackapi.utils.constants import JSON_AVAILABLE_FIELDS
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete')
-VERSION = '1.0.20'
+VERSION = '1.0.21'
 
 logger = logging.getLogger("ravenpack.core")
 
@@ -64,7 +64,8 @@ def request(self, endpoint, data=None, params=None, method='get'):
             logger.error("Error calling the API, we tried: %s" % to_curl(response.request))
             raise APIException(
                 'Got an error {status}: body was \'{error_message}\''.format(
-                    status=response.status_code, error_message=response.text
+                    status=response.status_code,
+                    error_message=response.text
                 ), response=response)
         return response
 

ravenpackapi/models/dataset.py

@@ -57,9 +57,13 @@ def __getattr__(self, field):
             if field not in self._data and 'uuid' in self._data:
                 # get the missing fields
                 self.get_from_server()
-            if field == 'uuid' and field not in self._data:
-                # we can't get the uuid of a new dataset
-                return None
+            if field not in self._data:
+                if field == 'uuid':  # we can't get the uuid of a new dataset
+                    return None
+                elif field == 'fields':
+                    return None
+                elif field == 'frequency':
+                    return None
             return self._data[field]
         else:
             return self.__getattribute__(field)
@@ -133,7 +137,7 @@ def json(self,
              end_date,
              fields=None,
              time_zone=None,
-             frequency='granular',
+             frequency=None,
              having=None,
              ):
         """ Use the dataset filters to request a data
@@ -148,6 +152,7 @@ def json(self,
             # fields are required, if it's not provided we use
             # the dataset ones
             fields = self.fields
+            frequency = frequency or self.frequency
 
         # let's build the body, with all the defined fields
         body = {}

ravenpackapi/tests/test_dataset_json.py

@@ -1,4 +1,4 @@
-from ravenpackapi import RPApi
+from ravenpackapi import RPApi, Dataset
 from ravenpackapi.models.results import Results
 
 
@@ -13,3 +13,39 @@ def test_known_swiss(self):
         )
         assert isinstance(data, Results)
         assert len(data) > 500, 'We should have more data in 1 day of swiss20'
+
+    def test_indicator_dataset(self):
+        indicator_dataset = Dataset(
+            name='Test-indicator-dataset',
+            filters={"$and": [{"rp_entity_id": {"$in": ["D8442A"]}}]},
+            fields=[{"average": {"avg": {"field": "EVENT_SENTIMENT_SCORE"}}}],
+            frequency='daily',
+        )
+        indicator_dataset = self.api.create_dataset(indicator_dataset)
+        try:
+
+            # ask the indicator dataset for its data
+            response = indicator_dataset.json('2018-01-01 00:00', '2018-01-02 00:00')
+            assert len(response) == 2  # we should get 2 rows
+            assert {r['rp_entity_id'] for r in response} == {'D8442A', 'ROLLUP'}
+
+            # do a request overriding fields and frequency to see the underlying data
+            response = indicator_dataset.json('2018-01-01 00:00', '2018-01-02 00:00',
+                                              fields=['rp_story_id', 'rp_entity_id'],
+                                              frequency='granular')
+            assert len(response) > 200, "We should have many granular analytics rows"
+            assert {r['rp_entity_id'] for r in response} == {'D8442A'}, "All rows should be D8442A"
+        finally:
+            indicator_dataset.delete()
+
+    def test_granular_dataset(self):
+        self.api.log_curl_commands = True
+        granular_dataset = Dataset(
+            name='Test-granular-dataset',
+            filters={"$and": [{"rp_entity_id": {"$in": ["D8442A"]}}, {"relevance": 90}]},
+        )
+        granular_dataset = self.api.create_dataset(granular_dataset)
+        try:
+            granular_dataset.json('2018-01-01 00:00', '2018-01-02 00:00')
+        finally:
+            granular_dataset.delete()

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '1.0.20'
+VERSION = '1.0.21'
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()