Merge pull request #14 from dynata/NameChanges

Name changes

Author: TheHatchetteMan

README.md

@@ -14,23 +14,23 @@ Package for building and interacting with the Dynata Respondent Exchange (REX)
 from dynata_rex import OpportunityRegistry
 registry = OpportunityRegistry('rex_access_key', 'rex_secret_key')
 ```
-### List opportunities from the registry
+### List opportunity notifications from the registry
 ```
-opportunities = registry.list_opportunities()
+opportunities = registry.receive_notifications()
 
 # [Opportunity(id=1,...), Opportunity(id=2,...), Opportunity(id=1,...)]
 ```
 ### Convert an opportunity to JSON
 ```
 opportunity_json = Opportunity.json()
 ```
-### Acknowledge a list of opportunities from the registry
+### Acknowledge a list of notifications from the registry
 ```
-registry.ack_opportunities([opportunity_1.id, ..., opportunity_N.id])
+registry.ack_notifications([opportunity_1.id, ..., opportunity_N.id])
 ```
-### Acknowledge a single opportunity from the registry
+### Acknowledge a single notification from the registry
 ```
-registry.ack_opportunity(opportunity.id)
+registry.ack_notification(opportunity.id)
 ```
 ### Get a list of corresponding opportunities from a project_id
 ```
@@ -209,9 +209,9 @@ gw.expire_context('super-unique-ctx-id')
 # }
 ```
 
-##### Get Attributes
+##### List Attributes
 ```
-gw.get_attributes('country', 'page_number', 'page_size')
+gw.list_attributes('country', 'page_number', 'page_size')
 
 # {
 #    'data':

dynata_rex/opportunity_registry.py

@@ -65,7 +65,9 @@ def _get_opportunity(self, opportunity_id: int) -> dict:
         return self.make_request.post(endpoint, data)
 
     def _list_opportunities(self, limit: int = 10) -> List[dict]:
-        """Raw get opportunities"""
+        """
+        [Deprecated - please use _receive_notifications()]
+        Raw get opportunities"""
         endpoint = f"{self.base_url}/list-opportunities"
         data = {
             "limit": limit,
@@ -76,9 +78,22 @@ def _list_opportunities(self, limit: int = 10) -> List[dict]:
         }
         return self.make_request.post(endpoint, data)
 
+    def _receive_notifications(self, limit: int = 10) -> List[dict]:
+        """Raw receive notifications"""
+        endpoint = f"{self.base_url}/receive-notifications"
+        data = {
+            "limit": limit,
+            "shards": {
+                "count": self.shard_count,
+                "current": self.current_shard
+            }
+        }
+        return self.make_request.post(endpoint, data)
+
     def list_opportunities(self, limit: int = 10) -> List[models.Opportunity]:
-        """Get opportunities from Opportunity Registry
         """
+        [Deprecated - please use receive_notifications()]
+        Get opportunities from Opportunity Registry"""
         opportunities = self._list_opportunities(limit=limit)
         out = []
         for opp in opportunities:
@@ -94,6 +109,24 @@ def list_opportunities(self, limit: int = 10) -> List[models.Opportunity]:
 
         return out
 
+    def receive_notifications(self,
+                              limit: int = 10) -> List[models.Opportunity]:
+        """Get opportunity notifications from Opportunity Registry"""
+        opportunities = self._receive_notifications(limit=limit)
+        out = []
+        for opp in opportunities:
+            try:
+                out.append(models.Opportunity(**opp))
+            except pydantic.error_wrappers.ValidationError:
+                opportunity_id = opp['id']
+                logger.warning(
+                    f"Unable to parse {opportunity_id}, excluding...")
+                logger.warning(json.dumps(opp, indent=4))
+                # Ack notification so we don't see it again
+                self.ack_notification(opportunity_id)
+
+        return out
+
     def get_opportunity(self, opportunity_id: int) -> models.Opportunity:
         """Get specific opportunity from SMOR
         """
@@ -107,18 +140,31 @@ def list_project_opportunities(self, project_id: int) -> List[int]:
         return self.make_request.post(endpoint, data)
 
     def ack_opportunity(self, opportunity_id: int) -> None:
-        """Acknowledge a single oppportunity
         """
+        [Deprecated - please use ack_notification()]
+        Acknowledge a single opportunity"""
         data = [opportunity_id]
         return self.ack_opportunities(data)
 
+    def ack_notification(self, opportunity_id: int) -> None:
+        """Acknowledge a single notification"""
+        data = [opportunity_id]
+        return self.ack_notifications(data)
+
     def ack_opportunities(self, opportunities: List[int]) -> None:
-        """Acknowledge a list of oppportunities
         """
+        [Deprecated - please use ack_notifications()]
+        Acknowledge a list of opportunities"""
         endpoint = f"{self.base_url}/ack-opportunities"
         res = self.make_request.post(endpoint, opportunities)
         return res
 
+    def ack_notifications(self, opportunities: List[int]) -> None:
+        """Acknowledge a list of notifications"""
+        endpoint = f"{self.base_url}/ack-notifications"
+        res = self.make_request.post(endpoint, opportunities)
+        return res
+
     def download_collection(self, collection_id: str) -> list:
         """Download targeting from a collection cell"""
         endpoint = f"{self.base_url}/download-collection"

dynata_rex/respondent_gateway.py

@@ -261,6 +261,8 @@ def get_attributes(self,
                        page_number: int,
                        page_size: int) -> dict:
         """
+        [Deprecated - please use list_attributes()]
+
         Get a list of attribute id's and their statuses
 
         @country: Country code for which you would like attributes
@@ -276,3 +278,24 @@ def get_attributes(self,
             "page_size": page_size
         }
         return self.make_request.post(endpoint, data)
+
+    def list_attributes(self,
+                        country: str,
+                        page_number: int,
+                        page_size: int) -> dict:
+        """
+        Get a list of attribute id's and their statuses
+
+        @country: Country code for which you would like attributes
+
+        @page_number: What page number you are requesting (for pagination)
+
+        @page_size: How many id's you would like returned in each page
+        """
+        endpoint = f"{self.base_url}/list-attributes"
+        data = {
+            "country": country,
+            "page_number": page_number,
+            "page_size": page_size
+        }
+        return self.make_request.post(endpoint, data)

…tunity_registry/02_list_opportunities.py …ity_registry/02_receive_notifications.pyexamples/opportunity_registry/02_list_opportunities.py renamed to examples/opportunity_registry/02_receive_notifications.py examples/opportunity_registry/02_list_opportunities.py renamed to examples/opportunity_registry/02_receive_notifications.py

@@ -2,7 +2,7 @@
 
 registry = OpportunityRegistry('rex_access_key', 'rex_secret_key')
 
-opportunities = registry.list_opportunities()
+opportunities = registry.receive_notifications()
 
-# Returns a list of Opportunities
+# Returns a list of Opportunity notifications
 # [Opportunity(id=1,...), Opportunity(id=2,...), Opportunity(id=1,...)]

…04_acknowledge_multiple_opportunities.py …04_acknowledge_multiple_notifications.pyexamples/opportunity_registry/04_acknowledge_multiple_opportunities.py renamed to examples/opportunity_registry/04_acknowledge_multiple_notifications.py examples/opportunity_registry/04_acknowledge_multiple_opportunities.py renamed to examples/opportunity_registry/04_acknowledge_multiple_notifications.py

@@ -2,8 +2,8 @@
 
 registry = OpportunityRegistry('rex_access_key', 'rex_secret_key')
 
-opportunities = registry.list_opportunities()
+opportunities = registry.receive_notifications()
 
 opportunity_ids = [opportunity.id for opportunity in opportunities]
 
-registry.ack_opportunities(opportunity_ids)
+registry.ack_notifications(opportunity_ids)

…try/05_acknowledge_single_opportunity.py …ry/05_acknowledge_single_notification.pyexamples/opportunity_registry/05_acknowledge_single_opportunity.py renamed to examples/opportunity_registry/05_acknowledge_single_notification.py examples/opportunity_registry/05_acknowledge_single_opportunity.py renamed to examples/opportunity_registry/05_acknowledge_single_notification.py

@@ -2,8 +2,8 @@
 
 registry = OpportunityRegistry('rex_access_key', 'rex_secret_key')
 
-opportunities = registry.list_opportunities()
+opportunities = registry.receive_notifications()
 
 opportunity = opportunities[0]
 
-registry.ack_opportunity(opportunity.id)
+registry.ack_notification(opportunity.id)

…/respondent_gateway/11_get_attributes.py …respondent_gateway/11_list_attributes.pyexamples/respondent_gateway/11_get_attributes.py renamed to examples/respondent_gateway/11_list_attributes.py examples/respondent_gateway/11_get_attributes.py renamed to examples/respondent_gateway/11_list_attributes.py

@@ -7,7 +7,7 @@
 
 page_size = 100  # Number of Items Being Requested
 
-gateway.get_attributes(country, page_number, page_size)
+gateway.list_attributes(country, page_number, page_size)
 
 # {
 #   "data": [

setup.py

@@ -9,7 +9,7 @@
 
 setuptools.setup(
     name="dynata_rex",
-    version="1.1.0",
+    version="1.2.0",
     author="REX Maintainers",
     author_email="[email protected]",
     description=("Package for building and interacting with the "

tests/data/test_list_opportunities.json …sts/data/test_receive_notifications.jsontests/data/test_list_opportunities.json renamed to tests/data/test_receive_notifications.json tests/data/test_list_opportunities.json renamed to tests/data/test_receive_notifications.json

@@ -70,15 +70,15 @@ def test_get_opportunity(session_post):
 
 
 @patch.object(requests.Session, "post")
-def test__list_opportunities(session_post):
-    """_list_opportunities should return the json data from response as a
+def test__receive_notifications(session_post):
+    """_receive_notifications should return the json data from response as a
     list of dicts"""
-    data = TEST_DATA['test_list_opportunities']
+    data = TEST_DATA['test_receive_notifications']
     session_post.return_value = ResponseMock._response_mock(
         200, content=json.dumps(data), content_type="application/json"
     )
 
-    r = REGISTRY._list_opportunities()
+    r = REGISTRY._receive_notifications()
 
     assert isinstance(r, list)
 
@@ -87,28 +87,28 @@ def test__list_opportunities(session_post):
 
 
 @patch.object(requests.Session, "post")
-def test_list_opportunities(session_post):
-    """_get_opportunity should return the json data from response as a
+def test_receive_notifications(session_post):
+    """_receive_notifications should return the json data from response as a
     list of Opportunity objects"""
-    data = TEST_DATA['test_list_opportunities']
+    data = TEST_DATA['test_receive_notifications']
     session_post.return_value = ResponseMock._response_mock(
         200, content=json.dumps(data), content_type="application/json"
     )
-    r = REGISTRY.list_opportunities()
+    r = REGISTRY.receive_notifications()
 
     assert isinstance(r, list)
 
     for opportunity in r:
         assert isinstance(opportunity, dynata_rex.models.Opportunity)
 
 
-@patch.object(dynata_rex.OpportunityRegistry, "ack_opportunity")
+@patch.object(dynata_rex.OpportunityRegistry, "ack_notification")
 @patch.object(requests.Session, "post")
-def test_list_opportunities_assert_ack_for_invalid_opportunity(session_post,
-                                                               ack_method):
-    """list opportunities should 'ack' an opportunity returned
+def test_receive_notifications_assert_ack_for_invalid_opportunity(session_post,
+                                                                  ack_method):
+    """receive notifications should 'ack' a notification returned
     that it cannot convert into an Opportunity object"""
-    data = TEST_DATA['test_list_opportunities']
+    data = TEST_DATA['test_receive_notifications']
 
     # Append an invalid Opportunity
     data.append(
@@ -123,41 +123,41 @@ def test_list_opportunities_assert_ack_for_invalid_opportunity(session_post,
     session_post.return_value = ResponseMock._response_mock(
         200, content=json.dumps(data), content_type="application/json"
     )
-    REGISTRY.list_opportunities()
+    REGISTRY.receive_notifications()
 
     # Make sure the ack method was called for the invalid opportunity
     assert ack_method.call_count == 1
 
 
-@patch.object(dynata_rex.OpportunityRegistry, "ack_opportunities")
+@patch.object(dynata_rex.OpportunityRegistry, "ack_notifications")
 @patch.object(requests.Session, "post")
-def test_ack_opportunity(session_post, ack_method):
-    data = TEST_DATA['test_list_opportunities'][0]
+def test_ack_notification(session_post, ack_method):
+    data = TEST_DATA['test_receive_notifications'][0]
 
     session_post.return_value = ResponseMock._response_mock(
         200, content=json.dumps(data), content_type="application/json"
     )
-    REGISTRY.ack_opportunity(data['id'])
+    REGISTRY.ack_notification(data['id'])
 
     assert ack_method.call_count == 1
 
-    # Make sure we called parent `ack_opportunities` method with
+    # Make sure we called parent `ack_notifications` method with
     # [ data['id'] ]
     assert ack_method.call_args == (([data['id']],),)
 
 
 @patch.object(requests.Session, "post")
-def test_ack_opportunities(session_post):
-    """list opportunities should 'ack' an opportunity returned
+def test_ack_notifications(session_post):
+    """receive notifications should 'ack' an opportunity returned
        that it cannot convert into an Opportunity object"""
 
-    data = [x['id'] for x in TEST_DATA['test_list_opportunities']]
+    data = [x['id'] for x in TEST_DATA['test_receive_notifications']]
 
     session_post.return_value = ResponseMock._response_mock(
         204, content_type="application/json"
     )
 
-    REGISTRY.ack_opportunities(data)
+    REGISTRY.ack_notifications(data)
 
     assert session_post.call_count == 1
     assert session_post.call_args[1]['data'] == json.dumps(data)