Fixing arguments and default arguments for several API methods

Author: Lev Rubel

HISTORY.rst

@@ -1,6 +1,12 @@
 History
 =================
 
+0.1.3 (2019-04-05)
+------------------
+
+* Fixed several API calls where default values should not be provided.
+* Fixed places where default values were different than default API values.
+
 0.1.2 (2019-04-01)
 ------------------
 

README.rst

@@ -19,7 +19,7 @@ A Python package for interacting with the Identix.one API
 * API documentation: https://kb.identix.one/
 * API changelog: https://kb.identix.one/#/apichangelog
 * Current supported most recent API version: **1.10.0**
-* Current stable package version: **0.1.2**
+* Current stable package version: **0.1.3**
 
 
 Installation

identixone/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Identix One"""
 __email__ = '[email protected]'
-__version__ = '0.1.2'
+__version__ = '0.1.3'

identixone/api/persons/v1/persons.py

@@ -6,8 +6,8 @@ class Persons(object):
     def __init__(self, http_client):
         self.http_client = http_client
 
-    def create(self, photo, source, facesize=None, create_on_ha=False,
-               create_on_junk=False, asm=False, liveness=False,
+    def create(self, photo, source, facesize=None, asm=None, liveness=None,
+               create_on_ha=False, create_on_junk=False,
                create_liveness_only=False):
         data = {
             'source': source,
@@ -31,14 +31,14 @@ def entry(self, id, facesize=None, create_on_ha=False,
         }
         return self.http_client.post('v1/persons/entry/', data=data)
 
-    def search(self, photo, asm=False, liveness=False):
+    def search(self, photo, asm=None, liveness=None):
         data = {'asm': asm, 'liveness': liveness}
         files = {'photo': photo}
         return self.http_client.post(
             'v1/persons/search/', data=data, files=files)
 
     def reinit_image(self, idxid, photo, source, conf=Conf.HA, facesize=None,
-                     liveness=False, reinit_liveness_only=False):
+                     liveness=None, reinit_liveness_only=False):
         data = {
             'source': source,
             'conf': conf,

identixone/api/users/v1/users.py

@@ -6,7 +6,7 @@ def __init__(self, http_client):
     def me(self):
         return self.http_client.get('v1/users/me/')
 
-    def change_password(self, password, password2, reset_tokens=True):
+    def change_password(self, password, password2, reset_tokens=None):
         data = {
             'password': password,
             'password2': password2,
@@ -24,10 +24,9 @@ def get_token(self, id_or_token):
         return self.http_client.get(
             'v1/users/tokens/{}/'.format(id_or_token))
 
-    def update_token(self, id_or_token, is_active=True):
-        data = {'is_active': is_active}
+    def update_token(self, id_or_token, **kwargs):
         return self.http_client.patch(
-            'v1/users/tokens/{}/'.format(id_or_token), data=data)
+            'v1/users/tokens/{}/'.format(id_or_token), data=kwargs)
 
     def delete_token(self, id_or_token):
         return self.http_client.delete(

identixone/api/utility/v1/utility.py

@@ -14,8 +14,8 @@ def liveness(self, photo):
         files = {'photo': photo}
         return self.http_client.post('v1/utility/liveness/', files=files)
 
-    def compare(self, photo1, photo2, liveness_photo1, liveness_photo2,
-                conf=Conf.HA):
+    def compare(self, photo1, photo2,
+                liveness_photo1=False, liveness_photo2=False, conf=Conf.HA):
         files = {'photo1': photo1, 'photo2': photo2}
         data = {
             'liveness_photo1': liveness_photo1,

setup.py

@@ -40,6 +40,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/identixone/identixone-python',
-    version='0.1.2',
+    version='0.1.3',
     zip_safe=False,
 )

tests/api/test_api_modules.py

@@ -101,25 +101,64 @@ def test_delete_notifications(self, mocked_send):
 class TestAPIPersonsModule(TestAPIModule):
 
     @patch.object(Session, 'send')
-    def test_create_persons(self, mocked_send):
+    def test_create_persons_no_none_values_in_request(self, mocked_send):
         status_code = 200
         resp_body = {'key': 'value'}
         mocked_send.return_value = self.response(resp_body, status_code)
         response = self.client.persons.create(photo='photo', source='source')
         self.assertEqual(response.json(), resp_body)
         self.assertEqual(response.status_code, status_code)
 
+        sent_request_body = mocked_send.mock_calls[0][1][0].body.decode('utf-8')
+        self.assertNotIn('name="asm"', sent_request_body)
+        self.assertNotIn('name="liveness"', sent_request_body)
+        self.assertNotIn('name="facesize"', sent_request_body)
+
+    @patch.object(Session, 'send')
+    def test_create_persons_fill_optional_values_in_request(self, mocked_send):
+        status_code = 200
+        resp_body = {'key': 'value'}
+        mocked_send.return_value = self.response(resp_body, status_code)
+        response = self.client.persons.create(
+            photo='photo', source='source',
+            asm=True, liveness=True, facesize=25000)
+        self.assertEqual(response.json(), resp_body)
+        self.assertEqual(response.status_code, status_code)
+
+        sent_request_body = mocked_send.mock_calls[0][1][0].body.decode('utf-8')
+        self.assertIn('name="asm"', sent_request_body)
+        self.assertIn('name="liveness"', sent_request_body)
+        self.assertIn('name="facesize"', sent_request_body)
+
     @patch.object(Session, 'send')
-    def test_search_persons(self, mocked_send):
+    def test_search_persons_no_none_values_in_request(self, mocked_send):
         status_code = 200
         resp_body = {'key': 'value'}
         mocked_send.return_value = self.response(resp_body, status_code)
         response = self.client.persons.search(photo='photo')
         self.assertEqual(response.json(), resp_body)
         self.assertEqual(response.status_code, status_code)
 
+        sent_request_body = mocked_send.mock_calls[0][1][0].body.decode('utf-8')
+        self.assertNotIn('name="asm"', sent_request_body)
+        self.assertNotIn('name="liveness"', sent_request_body)
+
     @patch.object(Session, 'send')
-    def test_reinit_image_persons(self, mocked_send):
+    def test_search_persons_fill_optional_values_in_request(self, mocked_send):
+        status_code = 200
+        resp_body = {'key': 'value'}
+        mocked_send.return_value = self.response(resp_body, status_code)
+        response = self.client.persons.search(
+            photo='photo', asm=True, liveness=True)
+        self.assertEqual(response.json(), resp_body)
+        self.assertEqual(response.status_code, status_code)
+
+        sent_request_body = mocked_send.mock_calls[0][1][0].body.decode('utf-8')
+        self.assertIn('name="asm"', sent_request_body)
+        self.assertIn('name="liveness"', sent_request_body)
+
+    @patch.object(Session, 'send')
+    def test_reinit_image_persons_no_none_values_in_request(self, mocked_send):
         status_code = 200
         resp_body = {'key': 'value'}
         mocked_send.return_value = self.response(resp_body, status_code)
@@ -128,6 +167,25 @@ def test_reinit_image_persons(self, mocked_send):
         self.assertEqual(response.json(), resp_body)
         self.assertEqual(response.status_code, status_code)
 
+        sent_request_body = mocked_send.mock_calls[0][1][0].body.decode('utf-8')
+        self.assertNotIn('name="facesize"', sent_request_body)
+        self.assertNotIn('name="liveness"', sent_request_body)
+
+    @patch.object(Session, 'send')
+    def test_reinit_image_persons_fill_optional_values_in_request(self, mocked_send):
+        status_code = 200
+        resp_body = {'key': 'value'}
+        mocked_send.return_value = self.response(resp_body, status_code)
+        response = self.client.persons.reinit_image(
+            idxid='1', photo='photo', source='source', conf=Conf.EXACT,
+            liveness=True, facesize=25000)
+        self.assertEqual(response.json(), resp_body)
+        self.assertEqual(response.status_code, status_code)
+
+        sent_request_body = mocked_send.mock_calls[0][1][0].body.decode('utf-8')
+        self.assertIn('name="facesize"', sent_request_body)
+        self.assertIn('name="liveness"', sent_request_body)
+
     @patch.object(Session, 'send')
     def test_reinit_id_persons(self, mocked_send):
         status_code = 200
@@ -308,15 +366,31 @@ def test_users_me(self, mocked_send):
         self.assertEqual(response.status_code, status_code)
 
     @patch.object(Session, 'send')
-    def test_users_change_password(self, mocked_send):
+    def test_users_change_password_no_none_values_in_request(self, mocked_send):
         status_code = 200
         resp_body = {'key': 'value'}
         mocked_send.return_value = self.response(resp_body, status_code)
         response = self.client.users.change_password(
-            password='p', password2='p', reset_tokens=False)
+            password='p', password2='p')
         self.assertEqual(response.json(), resp_body)
         self.assertEqual(response.status_code, status_code)
 
+        sent_request_body = mocked_send.mock_calls[0][1][0].body
+        self.assertNotIn('reset_tokens', sent_request_body)
+
+    @patch.object(Session, 'send')
+    def test_users_change_password_reset_tokens_in_request(self, mocked_send):
+        status_code = 200
+        resp_body = {'key': 'value'}
+        mocked_send.return_value = self.response(resp_body, status_code)
+        response = self.client.users.change_password(
+            password='p', password2='p', reset_tokens=True)
+        self.assertEqual(response.json(), resp_body)
+        self.assertEqual(response.status_code, status_code)
+
+        sent_request_body = mocked_send.mock_calls[0][1][0].body
+        self.assertIn('reset_tokens', sent_request_body)
+
     @patch.object(Session, 'send')
     def test_users_list_tokens(self, mocked_send):
         status_code = 200
@@ -410,9 +484,7 @@ def test_utility_compare(self, mocked_send):
         resp_body = {'key': 'value'}
         mocked_send.return_value = self.response(resp_body, status_code)
         response = self.client.utility.compare(
-            photo1='photo1', photo2='photo2',
-            liveness_photo1=False, liveness_photo2=False,
-            conf=Conf.JUNK)
+            photo1='photo1', photo2='photo2', conf=Conf.JUNK)
         self.assertEqual(response.json(), resp_body)
         self.assertEqual(response.status_code, status_code)