Don't require identifiers when there is an email address

Author: benedikt

pyproject.toml

@@ -2,21 +2,21 @@
 name = "userlist-python"
 version = "0.1.0"
 description = "Official UserList SDK for Python"
-authors = ["Maksym Sugonyaka <maksym@newscatcherapi.com>"]
+authors = ["Maksym Sugonyaka <maksym@newscatcherapi.com>", "Benedikt Deicke <benedikt@userlist.com>"]
 readme = "README.md"
 
 homepage = "https://userlist.com/"
 license = "MIT"
 keywords = ["Emailing", "Userlist", "marketing"]
 
 [tool.poetry.dependencies]
-python = ">=3.6.0"
+python = "^3.7"
 pendulum = "^1.4"
-
+requests = "^2.24.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"
-requests="^2.24.0"
+responses = "^0.18.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/test_userlist.py

@@ -1,20 +1,62 @@
 from userlist_python.userlist_auth import UserlistApiAuth
+from userlist_python.userlist_client import UserlistApiClient
 
 import os
 import unittest
-from userlist_python.userlist_client import UserlistApiClient
+import responses
 
 class UserlistApiTest(unittest.TestCase):
     def setUp(self):
         self.key = "push_key"
-        self.api = UserlistApiClient(self.key)
-
-    # def test_headers_auth(self):
-    #     userlist = UserlistApiClient(self.key)
-    #     try:
-    #         request = userlist.push_companies('123456')
-    #     except:
-    #         pass
-    #     assert userlist.request_method['Content-Type'] == 'application/json; charset=utf-8'
-    #     assert userlist.request_method['Accept'] == 'application/json'
-    #     assert userlist.request_method['Authorization'] == 'Push ' + self.key
+        self.client = UserlistApiClient(self.key)
+
+        responses.add(responses.POST, 'https://push.userlist.com/users', status=201)
+        responses.add(responses.POST, 'https://push.userlist.com/companies', status=201)
+
+
+    def test_users_missing_identifier_and_email(self):
+        with self.assertRaises(ValueError) as context:
+            self.client.push_users(properties={ 'name': 'Testing' })
+
+        self.assertEqual(str(context.exception), 'Missing required parameter identifier or email')
+
+    @responses.activate
+    def test_user_missing_identifier_with_email(self):
+        try:
+            self.client.push_users(email='test@example.com')
+        except ValueError:
+            self.self.fail('Unexpected ValueError')
+
+    @responses.activate
+    def test_user_missing_email_with_identifier(self):
+        try:
+            self.client.push_users(identifier='user-identifier')
+        except ValueError:
+            self.self.fail('Unexpected ValueError')
+
+    @responses.activate
+    def test_user_valid_request(self):
+        self.client.push_users(email='test@example.com', identifier='user-identifier', properties={ 'name': 'Testing' })
+
+        self.assertEqual(len(responses.calls), 1)
+        self.assertEqual(responses.calls[0].request.url, 'https://push.userlist.com/users')
+        self.assertEqual(responses.calls[0].request.method, 'POST')
+        self.assertEqual(responses.calls[0].request.headers['Authorization'], f'Push {self.key}')
+        self.assertEqual(responses.calls[0].request.body, b'{"identifier": "user-identifier", "email": "test@example.com", "properties": {"name": "Testing"}}')
+
+
+    def test_companies_missing_identifier(self):
+        with self.assertRaises(TypeError) as context:
+            self.client.push_companies(properties={ 'name': 'Testing' })
+
+        self.assertEqual(str(context.exception), "push_companies() missing 1 required positional argument: 'identifier'")
+
+    @responses.activate
+    def test_company_valid_request(self):
+        self.client.push_companies(identifier='company-identifier', properties={ 'name': 'Testing' })
+
+        self.assertEqual(len(responses.calls), 1)
+        self.assertEqual(responses.calls[0].request.url, 'https://push.userlist.com/companies')
+        self.assertEqual(responses.calls[0].request.method, 'POST')
+        self.assertEqual(responses.calls[0].request.headers['Authorization'], f'Push {self.key}')
+        self.assertEqual(responses.calls[0].request.body, b'{"identifier": "company-identifier", "properties": {"name": "Testing"}}')

userlist_python/userlist_client.py

@@ -38,24 +38,23 @@ def __init__(self, push_key, session=None):
 
     def push_users(
             self,
-            identifier,
+            identifier=None,
             email=None,
             signed_up_at=None,
             last_seen_at=None,
             properties=None,
             company=None,
             companies=None,
             relationships=None
-
     ):
 
         """Call the `/users` endpoint.
 
           Push users data into Userlist
 
 
-          :param identifier: A unique identifier for that user within your application. (required)
-          :type identifier: str
+          :param identifier: A unique identifier for that user within your application.
+          :type identifier: str or None
 
           :param email: Email of a user
           :type email: str or None
@@ -87,9 +86,10 @@ def push_users(
 
 
         # identifier
-        if not identifier:
-            raise ValueError("identifier is a required param. Please fill it in.")
-        else:
+        if not identifier and not email:
+            raise ValueError("Missing required parameter identifier or email")
+
+        if identifier is not None:
             payload["identifier"] = identifier
 
         if email is not None: