add missing optional properties for the user signup endpoint

lbalmaceda · lbalmaceda · commit c46a3ca0fc13 · 2020-07-08T14:07:54.000-03:00
diff --git a/auth0/v3/authentication/database.py b/auth0/v3/authentication/database.py
@@ -1,9 +1,9 @@
-from .base import AuthenticationBase
 import warnings
 
+from .base import AuthenticationBase
 
-class Database(AuthenticationBase):
 
+class Database(AuthenticationBase):
     """Database & Active Directory / LDAP Authentication.
 
     Args:
@@ -35,10 +35,10 @@ def login(self, client_id, username, password, connection, id_token=None,
             }
         )
 
-    def signup(self, client_id, email, password, connection, username=None,
-             user_metadata=None):
+    def signup(self, client_id, email, password, connection, username=None, user_metadata=None,
+               given_name=None, family_name=None, name=None, nickname=None, picture=None):
         """Signup using email and password.
-        
+
         Args:
            client_id (str): ID of the application to use.
 
@@ -53,6 +53,17 @@ def signup(self, client_id, email, password, connection, username=None,
            user_metadata (dict, optional): Additional key-value information to store for the user.
                     Some limitations apply, see: https://auth0.com/docs/metadata#metadata-restrictions
 
+           given_name (str, optional): The user's given name(s).
+
+           family_name (str, optional): The user's family name(s).
+
+           name (str, optional): The user's full name.
+
+           nickname (str, optional): The user's nickname.
+
+           picture (str, optional): A URI pointing to the user's picture.
+
+
         See: https://auth0.com/docs/api/authentication#signup
         """
         body = {
@@ -64,6 +75,21 @@ def signup(self, client_id, email, password, connection, username=None,
             'user_metadata': user_metadata
         }
 
+        if username:
+            body.update({'username': username})
+        if user_metadata:
+            body.update({'user_metadata': user_metadata})
+        if given_name:
+            body.update({'given_name': given_name})
+        if family_name:
+            body.update({'family_name': family_name})
+        if name:
+            body.update({'name': name})
+        if nickname:
+            body.update({'nickname': nickname})
+        if picture:
+            body.update({'picture': picture})
+
         return self.post(
             'https://{}/dbconnections/signup'.format(self.domain),
             data=body
diff --git a/auth0/v3/test/authentication/test_database.py b/auth0/v3/test/authentication/test_database.py
@@ -1,13 +1,14 @@
 import unittest
+
 import mock
+
 from ...authentication.database import Database
 
 
 class TestDatabase(unittest.TestCase):
 
     @mock.patch('auth0.v3.authentication.database.Database.post')
     def test_login(self, mock_post):
-
         d = Database('my.domain.com')
 
         d.login(client_id='cid',
@@ -35,7 +36,6 @@ def test_login(self, mock_post):
 
     @mock.patch('auth0.v3.authentication.database.Database.post')
     def test_signup(self, mock_post):
-
         d = Database('my.domain.com')
 
         # using only email and password
@@ -48,16 +48,15 @@ def test_signup(self, mock_post):
 
         self.assertEqual(args[0], 'https://my.domain.com/dbconnections/signup')
         self.assertEqual(kwargs['data'], {
-                         'client_id': 'cid',
-                         'email': 'a@b.com',
-                         'password': 'pswd',
-                         'connection': 'conn',
-                         'username': None,
-                         'user_metadata': None
-                        })
-
+            'client_id': 'cid',
+            'email': 'a@b.com',
+            'password': 'pswd',
+            'connection': 'conn',
+            'username': None,
+            'user_metadata': None
+        })
 
-        # Using also username and metadata
+        # Using also optional properties
         sample_meta = {
             'hobby': 'surfing',
             'preference': {
@@ -69,23 +68,32 @@ def test_signup(self, mock_post):
                  password='pswd',
                  connection='conn',
                  username='usr',
-                 user_metadata=sample_meta)
+                 user_metadata=sample_meta,
+                 given_name='john',
+                 family_name='doe',
+                 name='john doe',
+                 nickname='johnny',
+                 picture='avatars.com/john-doe')
 
         args, kwargs = mock_post.call_args
 
         self.assertEqual(args[0], 'https://my.domain.com/dbconnections/signup')
         self.assertEqual(kwargs['data'], {
-                         'client_id': 'cid',
-                         'email': 'a@b.com',
-                         'password': 'pswd',
-                         'connection': 'conn',
-                         'username': 'usr',
-                         'user_metadata': sample_meta
-                        })
+            'client_id': 'cid',
+            'email': 'a@b.com',
+            'password': 'pswd',
+            'connection': 'conn',
+            'username': 'usr',
+            'user_metadata': sample_meta,
+            'given_name': 'john',
+            'family_name': 'doe',
+            'name': 'john doe',
+            'nickname': 'johnny',
+            'picture': 'avatars.com/john-doe',
+        })
 
     @mock.patch('auth0.v3.authentication.database.Database.post')
     def test_change_password(self, mock_post):
-
         d = Database('my.domain.com')
 
         d.change_password(client_id='cid',
