version 1.0.52: Entity-type-reference: retrieve reference by day

Author: dariosky

CHANGELOG.md

@@ -1,25 +1,34 @@
 # Changelog
+
+## v1.0.52 (2021-08-20)
+
+Entity-type-reference: support to retrieve a reference in the past. It also supports to specify `reference_type="delta"`
+to retrieve just a daily difference of the changes (only for Edge).
+
 ## v1.0.51 (2021-08-11)
+
 Insider-transactions and Earnings-Dates API support:
 list the available files and download them to automate your process
 
 ## v1.0.49 (2021-07-16)
+
 Text analytics: support for uploading via source_url
 
 ## v1.0.48 (2021-07-10)
+
 Text analytics: support for the /text-extraction endpoint
 
 ## v1.0.47 (2021-04-12)
+
 Text analytics: Handle retry if too early on /metadata endpoint
 
 ## v1.0.46 (2021-04-05)
+
 Compatibility with RavenPack Edge
 
-* loosen validation for entity-types (in Edge we have various dynamical
-  EDETs)
-  
-* loosen validation for RT fields (in Edge we have several new fields)
+* loosen validation for entity-types (in Edge we have various dynamical EDETs)
 
+* loosen validation for RT fields (in Edge we have several new fields)
 
 ## v1.0.43 (2020-11-04)
 

ravenpackapi/core.py

@@ -11,11 +11,11 @@
 from ravenpackapi.models.results import Results
 from ravenpackapi.upload.module import UploadApi
 from ravenpackapi.util import to_curl
-from ravenpackapi.utils.date_formats import as_datetime_str
+from ravenpackapi.utils.date_formats import as_datetime_str, as_date_str
 from ravenpackapi.utils.dynamic_sessions import DynamicSession
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete', 'patch')
-VERSION = '1.0.51'
+VERSION = '1.0.52'
 
 logger = logging.getLogger("ravenpack.core")
 
@@ -174,13 +174,19 @@ def get_entity_reference(self, rp_entity_id):
         data = response.json()
         return RpEntityReference(rp_entity_id, data)
 
-    def get_entity_type_reference(self, entity_type=None):
+    def get_entity_type_reference(self,
+                                  entity_type=None,
+                                  reference_type='full',
+                                  date=None):
         if entity_type:
             entity_type = entity_type.upper()
+        params = {"entity_type": entity_type,
+                  "type": reference_type,
+                  "date": as_date_str(date) if date else None}
         response = self.request(
             endpoint="/entity-reference",
             method='get',
-            params={"entity_type": entity_type} if entity_type else None,
+            params={k: v for k, v in params.items() if v},  # exclude missing params
             stream=True,
         )
         return EntityTypeReference(http_response=response)

ravenpackapi/tests/test_entity_reference.py

@@ -67,10 +67,11 @@ class TestEntityTypeReference(object):
     team_reference = api.get_entity_type_reference('team')
 
     @pytest.mark.slow
-    def test_save_team_reference(self):
+    @pytest.mark.parametrize("date", [None, datetime.date(2017, 8, 2)])
+    def test_save_team_reference(self, date):
         """ Get the team reference as a CSV """
 
-        team_reference = self.api.get_entity_type_reference('team')
+        team_reference = self.api.get_entity_type_reference('team', date=date)
         f = tempfile.NamedTemporaryFile(prefix='test_reference', delete=False)
         filepath = f.name
         team_reference.write_to_file(filepath)

ravenpackapi/utils/date_formats.py

@@ -47,3 +47,9 @@ def as_datetime_str(s):
     if isinstance(s, datetime.date):
         return s.strftime(DATETIME_FORMAT)
     return s
+
+
+def as_date_str(s):
+    if isinstance(s, datetime.date):
+        return s.strftime(DATE_FORMAT)
+    return s

setup.py

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