Ad-hoc json - method updated to support conditions and custom_fields

Author: dariosky

ravenpackapi/core.py

@@ -11,10 +11,11 @@
 from ravenpackapi.models.reference import RpEntityReference, EntityTypeReference
 from ravenpackapi.models.results import Results
 from ravenpackapi.util import to_curl
-from ravenpackapi.utils.constants import JSON_AVAILABLE_FIELDS, ENTITY_TYPES
+from ravenpackapi.utils.constants import ENTITY_TYPES
+from ravenpackapi.utils.date_formats import as_datetime_str
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete')
-VERSION = '1.0.30'
+VERSION = '1.0.31'
 
 logger = logging.getLogger("ravenpack.core")
 
@@ -105,24 +106,35 @@ def get_dataset(self, dataset_id):
     def json(self,
              start_date,
              end_date,
-             fields,
+             fields=None,
              filters=None,
              time_zone=None,
              frequency='granular',
              having=None,
+             custom_fields=None,
+             conditions=None,
              product='rpa',
              product_version='1.0',
              ):
         # let's build the body, with all the defined fields
-        body = {}
-        for k in JSON_AVAILABLE_FIELDS:
-            if locals().get(k) is not None:
-                body[k] = locals().get(k)
+        body = {"start_date": as_datetime_str(start_date),
+                "end_date": as_datetime_str(end_date),
+                "time_zone": time_zone}
+        body.update(dict(
+            frequency=frequency,
+            fields=fields,
+            custom_fields=custom_fields,
+            filters=filters,
+            conditions=conditions,
+            having=having,
+            product=product,
+            product_version=product_version,
+        ))
 
         response = self.request(
             endpoint="/json",
             method='post',
-            data=body,
+            data={k: v for k, v in body.items() if v is not None},  # remove null values
         )
         data = response.json()
         return Results(data['records'],

ravenpackapi/models/dataset.py

@@ -166,7 +166,7 @@ def save(self):
                 )
         }
 
-        if 'frequency' in data and not 'fields' in data:
+        if 'frequency' in data and 'fields' not in data:
             # fields can be null, we specify it only when frequency is also given
             data['fields'] = self.fields
 

ravenpackapi/utils/constants.py

@@ -1,9 +1,2 @@
-JSON_AVAILABLE_FIELDS = {
-    'start_date', 'end_date', 'time_zone',
-    'frequency', 'fields',
-    'having', 'filters',
-    'product', 'product_version',
-}
-
 ENTITY_TYPES = {None, "CMDT", "COMP", "CURR", "NATL", "ORGA",
                 "ORGT", "PEOP", "PLCE", "PROD", "TEAM", "POSI", "SRCE"}

setup.py

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