feat: added model param and remove jobIdentifier params on jobHistory (#4)

Author: raul-casallas

modzy/jobs.py

@@ -61,7 +61,7 @@ def get(self, job):
         json_obj = self._api_client.http.get('{}/{}'.format(self._base_route, identifier))
         return Job(json_obj, self._api_client)
 
-    def get_history(self, user=None, access_key=None, start_date=None, end_date=None, job_identifiers=None,
+    def get_history(self, user=None, access_key=None, start_date=None, end_date=None, model=None,
                     status='all', sort_by=None, direction=None, page=None, per_page=None):
         """Gets a list of `Job` instances within a set of parameters.
 
@@ -70,7 +70,7 @@ def get_history(self, user=None, access_key=None, start_date=None, end_date=None
             access_key (Optional[str]): Identifier of the access key to be assigned to the user
             start_date (Optional[datetime, str]): initial date to filter recods
             end_date (Optional[datetime, str]): final date to filter recods
-            job_identifiers (Optional[Union[List[str], Tuple[str]]]): Array of unique job identifiers
+            model (Optional[str]): Model name or version identifier
             status (Optional[str]): Status of the jobs (all, pending, terminated)
             sort_by (Optional[str]): attribute name to sort results
             direction (Optional[str]): Direction of the sorting algorithm (asc, desc)
@@ -99,8 +99,8 @@ def get_history(self, user=None, access_key=None, start_date=None, end_date=None
                 raise TypeError("the end_date param should be a datetime or string")
         if status is not None and not isinstance(status, str):
             raise TypeError("the status param should be a string")
-        if job_identifiers is not None and not isinstance(job_identifiers, (list, tuple)):
-            raise TypeError("the job_identifiers param should be a list or tuple")
+        if model is not None and not isinstance(model, str):
+            raise TypeError("the model param should be a string")
         if sort_by is not None and not isinstance(sort_by, str):
             raise TypeError("the sort_by param should be a string")
         if direction is not None and not isinstance(direction, str):
@@ -120,7 +120,7 @@ def get_history(self, user=None, access_key=None, start_date=None, end_date=None
             "accessKey": access_key,
             "startDate": start_date,
             "endDate": end_date,
-            "jobIdentifiers": job_identifiers,
+            "model": model,
             "status": status,
             "sort-by": sort_by,
             "direction": direction,

tests/test_jobs.py

@@ -42,7 +42,7 @@ def test_get_job_history(client, logger):
 
 
 def test_get_job_history_by_user(client, logger):
-    params = {'user': API_KEY.split('.')[0]}
+    params = {'user': 'a'}
     jobs = client.jobs.get_history(**params)
     logger.debug("jobs history: by %s %d", params, len(jobs))
     for job in jobs:
@@ -102,25 +102,13 @@ def test_get_job_history_by_date(client, logger):
     assert api_error
 
 
-def test_get_job_history_by_job_identifiers(client, logger):
-    # by unexisting identifiers
-    params = {'job_identifiers': ["a", "b", "c"]}
+def test_get_job_history_by_model(client, logger):
+    # by model
+    params = {'model': 'Sentiment Analysis'}
     jobs = client.jobs.get_history(**params)
     logger.debug("jobs history: by %s %d", params, len(jobs))
-    assert len(jobs) == 0
-    # by valid identificators
-    job1 = client.jobs.submit_text(MODEL_ID, '0.0.27', {'input.txt': 'Modzy is great!'})
-    job2 = client.jobs.submit_text(MODEL_ID, '0.0.27', {'input.txt': 'Modzy is great!'})
-    params = {'job_identifiers': [job1.job_identifier, job2.job_identifier]}
-    jobs = client.jobs.get_history(**params)
     logger.debug("jobs history: by %s %d", params, len(jobs))
     assert len(jobs)
-    # by empty array
-    params = {'job_identifiers': []}
-    jobs = client.jobs.get_history(**params)
-    logger.debug("jobs history: by %s %d", params, len(jobs))
-    assert len(jobs)
-
 
 def test_get_job_history_by_status(client, logger):
     # by all