Merge pull request #16 from transcovo/add-contact-list-endpoints

TECH implement and test contact list endpoints

Author: Augustin

pymarsys/contact_list.py

@@ -0,0 +1,77 @@
+from .base_endpoint import BaseEndpoint
+
+
+class ContactList(BaseEndpoint):
+    """
+    Class representation of the ContactList endpoint.
+
+    Examples:
+    If you want to use contact lists' methods through an instance of the Emarsys
+    client:
+    >>> from pymarsys import SyncConnection, Emarsys
+    >>> connection = SyncConnection('username', 'password')
+    >>> client = Emarsys(connection)
+    >>> client.contact_list
+    <pymarsys.contact_list.ContactList at 0x1050f7048>
+
+    If you want to use contact lists' methods trough an instance of the ContactList
+    endpoint class:
+    >>> from pymarsys import SyncConnection
+    >>> from pymarsys.contact_list import ContactList
+    >>> connection = SyncConnection('username', 'password')
+    >>> contact_list = ContactList(connection)
+    >>> contact_list
+    <pymarsys.contact_list.ContactList at 0x10333ec88>
+    """
+
+    def __init__(self, connection, endpoint="api/v2/contactlist/"):
+        super().__init__(connection, endpoint)
+
+    def create(self, name, key_id=3, with_contacts_ids=None, description=None):
+        """
+        Create a contact list.
+        https://dev.emarsys.com/v2/contact-lists/create-a-contact-list
+        :param name: name of the list to create
+        :param key_id: Key which identifies the contact. This can be a field
+        id, id, uid or eid. If left empty, the email address (field ID 3) will
+        be used by default.
+        :param with_contacts_ids: list of key's value to add to the list. e.g. ['squirrel@squirrelmail.com',]
+        :param description: Additional information about the contact list.
+        :return: The API response payload.
+.
+        Examples:
+        If you want to create a list which name is test_list and assign squirrel@squirrelmail.com to this list:
+        >>> client.lists.create("test_list", ['squirrel@squirrelmail.com',])
+        {'data': {'id': 123}, 'replyCode': 0, 'replyText': 'OK'}
+        """
+        payload = {
+            "key_id": key_id,
+            "name": name,
+            "description": description,
+            "external_ids": with_contacts_ids,
+        }
+
+        return self.connection.make_call("POST", self.endpoint, payload=payload)
+
+    def add_contacts(self, list_id, contacts_ids, key_id=3):
+        """
+        Add multiple contacts to an existing list.
+        https://dev.emarsys.com/v2/contact-lists/add-contacts-to-a-contact-list
+
+        :param list_id: Identifier of the list you want to add a contact to.
+        :param contacts_ids: List of contact identifier you want to add to the list
+        :param key_id: Key which identifies the contact. This can be a field
+        id, id, uid or eid. If left empty, the email address (field ID 3) will
+        be used by default.
+        :return: The API response payload.
+
+        Examples:
+        If you want to add two squirrel1@squirrelmail.com to the list test_list:
+        >>> client.contact_list.add('test_list', ['squirrel1@squirrelmail.com',])
+        {'data': {'inserted_contacts': 123}, 'replyCode': 0, 'replyText': 'OK'}
+        """
+
+        payload = {"key_id": key_id, "external_ids": contacts_ids}
+
+        endpoint = "{}{}/add/".format(self.endpoint, list_id)
+        return self.connection.make_call("POST", endpoint, payload=payload)

tests/test_contact_list.py

@@ -0,0 +1,64 @@
+import pytest
+import responses
+from urllib.parse import urljoin
+
+from pymarsys.connections import SyncConnection
+from pymarsys.contact_list import ContactList
+
+EMARSYS_URI = "https://api.emarsys.net/"
+CONTACT_LIST_ENDPOINT = "api/v2/contactlist/"
+TEST_USERNAME = "test_username"
+TEST_SECRET = "test_secret"
+
+EMARSYS_CONTACT_LIST_CREATE_RESPONSE = {
+    "replyCode": 0,
+    "replyText": "OK",
+    "data": {"id": 1},
+}
+
+ADD_TO_CONTACT_LIST_ENDPOINT = "api/v2/contactlist/1/add/"
+
+
+EMARSYS_ADD_TO_CONTACT_LIST_RESPONSE = {
+    "replyCode": 0,
+    "replyText": "OK",
+    "data": {"inserted_contacts": 1},
+}
+
+class TestContactList:
+    def test_init_no_exception(self):
+        connection = SyncConnection(TEST_USERNAME, TEST_SECRET)
+        ContactList(connection)
+
+    def test_init_exception(self):
+        with pytest.raises(TypeError):
+            ContactList(123)
+
+    @responses.activate
+    def test_create(self):
+        responses.add(
+            responses.POST,
+            urljoin(EMARSYS_URI, CONTACT_LIST_ENDPOINT),
+            json=EMARSYS_CONTACT_LIST_CREATE_RESPONSE,
+            status=200,
+            content_type="application/json",
+        )
+        connection = SyncConnection(TEST_USERNAME, TEST_SECRET)
+        contact_list = ContactList(connection)
+        response = contact_list.create("test_list")
+        assert response == EMARSYS_CONTACT_LIST_CREATE_RESPONSE
+
+    @responses.activate
+    def test_add_contacts(self):
+        responses.add(
+            responses.POST,
+            urljoin(EMARSYS_URI, ADD_TO_CONTACT_LIST_ENDPOINT),
+            json=EMARSYS_ADD_TO_CONTACT_LIST_RESPONSE,
+            status=200,
+            content_type="application/json",
+        )
+        connection = SyncConnection(TEST_USERNAME, TEST_SECRET)
+        contact_list = ContactList(connection)
+
+        response = contact_list.add_contacts(1, ["squirrel1@squirrelmail.com"])
+        assert response == EMARSYS_ADD_TO_CONTACT_LIST_RESPONSE