Merge pull request #22 from hellofresh/feature/out-in

 Add support to opt into channels

Author: anvth

README.md

@@ -34,6 +34,11 @@ Library supports next methods:
 **Events management**
 - `send_events(self, events, email=None, user_id=None, business_unit=None)` | v1
 
+**Opt-Out Management**
+ - `get_user_opt_out_status(self, user_id)` | v1
+ - `update_user_opt_out_status(self, user_id, channel_name)` | v1
+ - `update_user_opt_in_status(self, user_id, channel_name)` | v1
+
 ### Owner
 [Alexander Zhilyaev](mailto:azh@hellofresh.com)
 

crossengage/client.py

@@ -381,6 +381,23 @@ def update_user_opt_out_status(self, user_id, channel_name):
         )
         return self.__create_request(payload={"optOut": True}, request_type=self.REQUEST_PUT, version="v1")
 
+    def update_user_opt_in_status(self, user_id, channel_name):
+        # type: (str, str) -> dict
+        """
+        Fetch User Opt-In status by id.
+        :param user_id: User ID
+        :param channel_name: Name of the channel to opt in user to. It has to be one of MAIL, BROWSER_NOTIFICATION,
+                             ONSITE_DISPLAY, EXIT_INTENT, PUSH_NOTIFICATION, DIRECT_MAIL or SMS
+        :return: json dict response, for example:
+            {
+                "optOut": false
+            }
+        """
+        self.request_url = "{0}/{1}/{2}/{3}?channelType={4}".format(
+            self.API_URL, self.USER_ENDPOINT, user_id, self.OPTOUT_ENDPOINT, channel_name
+        )
+        return self.__create_request(payload={"optOut": False}, request_type=self.REQUEST_PUT, version="v1")
+
     def __create_request(self, payload, request_type, version):
         headers = update_dict(self.default_headers, {self.API_VERSION_HEADER: self.API_VERSIONS[version]})
         try:

tests/test_client.py

@@ -679,3 +679,30 @@ def test_update_user_opt_out_status(self):
         )
 
         self.assertEqual(expected_response, result)
+
+    def test_update_user_opt_in_status(self):
+        """Crossengage returns status code 200"""
+        # GIVEN
+        expected_response = self.user.copy()
+        expected_response.update({"status_code": codes.ok})
+        response = Mock(status_code=codes.ok)
+        response.json.return_value = expected_response
+        requests = Mock()
+        requests.get.return_value = response
+
+        requests = Mock()
+        requests.put.return_value = response
+        self.client.requests = requests
+
+        # WHEN
+        result = self.client.update_user_opt_in_status(self.user['id'], self.user['channel'])
+
+        # THEN
+        requests.put.assert_called_once_with(
+            self.CROSSENGAGE_URL + 'users/1234/optout-status?channelType=' + self.user['channel'],
+            data='{"optOut": false}',
+            headers=self.default_headers_api_v1,
+            timeout=30
+        )
+
+        self.assertEqual(expected_response, result)