PENG-3689 - Introducing support for datasets functionality

Author: cpontes-ns1

examples/datasets.py

@@ -32,10 +32,7 @@
         "scope": "account",
     },
     repeat=None,
-    timeframe={
-        "aggregation": "monthly",
-        "cycles": 1
-    },
+    timeframe={"aggregation": "monthly", "cycles": 1},
     export_type="csv",
     recipient_emails=None,
 )

ns1/dataset.py

@@ -68,12 +68,12 @@ def loadFromDict(self, dt):
         :param dict dt: dictionary containing *at least* either an id or domain/path/target
         """
         if "id" in dt or (
-                "name" in dt
-                and "datatype" in dt
-                and "repeat" in dt
-                and "timeframe" in dt
-                and "export_type" in dt
-                and "recipient_emails" in dt
+            "name" in dt
+            and "datatype" in dt
+            and "repeat" in dt
+            and "timeframe" in dt
+            and "export_type" in dt
+            and "recipient_emails" in dt
         ):
             self.data = dt
             return self
@@ -88,8 +88,16 @@ def delete(self, callback=None, errback=None):
         return self._rest.delete(id, callback=callback, errback=errback)
 
     def create(
-            self, name, datatype, repeat, timeframe, export_type, recipient_emails, callback=None, errback=None,
-            **kwargs
+        self,
+        name,
+        datatype,
+        repeat,
+        timeframe,
+        export_type,
+        recipient_emails,
+        callback=None,
+        errback=None,
+        **kwargs
     ):
         """
         Create a new dataset. Pass a list of keywords and their values to
@@ -106,7 +114,15 @@ def create(
             raise DatasetException("dataset already loaded")
 
         return self._rest.create(
-            name, datatype, repeat, timeframe, export_type, recipient_emails, callback=None, errback=None, **kwargs
+            name,
+            datatype,
+            repeat,
+            timeframe,
+            export_type,
+            recipient_emails,
+            callback=None,
+            errback=None,
+            **kwargs
         )
 
     def listDatasets(self, callback=None, errback=None):
@@ -137,4 +153,6 @@ def retrieveReport(self, rp_id, dt_id=None, callback=None, errback=None):
         if dt_id is None:
             raise DatasetException("no dataset id: did you mean to create?")
 
-        return Datasets(self.config).retrieveReport(dt_id, rp_id, callback=callback, errback=errback)
+        return Datasets(self.config).retrieveReport(
+            dt_id, rp_id, callback=callback, errback=errback
+        )

tests/unit/test_datasets.py

@@ -28,12 +28,7 @@ def datasets_config(config):
     return config
 
 
-@pytest.mark.parametrize(
-    "url",
-    [(
-            "datasets"
-    )]
-)
+@pytest.mark.parametrize("url", [("datasets")])
 def test_rest_datasets_list(datasets_config, url):
     z = NS1(config=datasets_config).datasets()
     z._make_request = mock.MagicMock()
@@ -48,10 +43,12 @@ def test_rest_datasets_list(datasets_config, url):
 
 @pytest.mark.parametrize(
     "dtId, url",
-    [(
+    [
+        (
             "96529d62-fb0c-4150-b5ad-6e5b8b2736f6",
-            "datasets/96529d62-fb0c-4150-b5ad-6e5b8b2736f6"
-    )]
+            "datasets/96529d62-fb0c-4150-b5ad-6e5b8b2736f6",
+        )
+    ],
 )
 def test_rest_dataset_retrieve(datasets_config, dtId, url):
     z = NS1(config=datasets_config).datasets()
@@ -65,12 +62,7 @@ def test_rest_dataset_retrieve(datasets_config, dtId, url):
     )
 
 
-@pytest.mark.parametrize(
-    "url",
-    [(
-            "datasets"
-    )]
-)
+@pytest.mark.parametrize("url", [("datasets")])
 def test_rest_dataset_create(datasets_config, url):
     z = NS1(config=datasets_config).datasets()
     z._make_request = mock.MagicMock()
@@ -81,10 +73,7 @@ def test_rest_dataset_create(datasets_config, url):
             "scope": "account",
         },
         repeat=None,
-        timeframe={
-            "aggregation": "monthly",
-            "cycles": 1
-        },
+        timeframe={"aggregation": "monthly", "cycles": 1},
         export_type="csv",
         recipient_emails=None,
     )
@@ -98,10 +87,7 @@ def test_rest_dataset_create(datasets_config, url):
                 "type": "num_queries",
                 "scope": "account",
             },
-            "timeframe": {
-                "aggregation": "monthly",
-                "cycles": 1
-            },
+            "timeframe": {"aggregation": "monthly", "cycles": 1},
             "repeat": None,
             "export_type": "csv",
             "recipient_emails": None,
@@ -113,10 +99,12 @@ def test_rest_dataset_create(datasets_config, url):
 
 @pytest.mark.parametrize(
     "dtId, url",
-    [(
+    [
+        (
             "96529d62-fb0c-4150-b5ad-6e5b8b2736f6",
-            "datasets/96529d62-fb0c-4150-b5ad-6e5b8b2736f6"
-    )]
+            "datasets/96529d62-fb0c-4150-b5ad-6e5b8b2736f6",
+        )
+    ],
 )
 def test_rest_datasets_delete(datasets_config, dtId, url):
     z = NS1(config=datasets_config).datasets()
@@ -138,10 +126,7 @@ def test_rest_datasets_buildbody(datasets_config):
             "type": "num_queries",
             "scope": "account",
         },
-        "timeframe": {
-            "aggregation": "monthly",
-            "cycles": 1
-        },
+        "timeframe": {"aggregation": "monthly", "cycles": 1},
         "repeat": None,
         "recipient_emails": None,
         "export_type": "csv",
@@ -152,10 +137,7 @@ def test_rest_datasets_buildbody(datasets_config):
             "type": "num_queries",
             "scope": "account",
         },
-        "timeframe": {
-            "aggregation": "monthly",
-            "cycles": 1
-        },
+        "timeframe": {"aggregation": "monthly", "cycles": 1},
         "repeat": None,
         "recipient_emails": None,
         "export_type": "csv",