Skip to content

Commit c43a73a

Browse files
committed
rename firstname and lastname params to reflect API
1 parent c735a2c commit c43a73a

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

tests/test_connections.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -443,9 +443,9 @@ def test_split_add_user():
443443
:return:
444444
"""
445445
user = UserAction(user="user@example.com")
446-
user.create(id_type=IdentityType.enterpriseID, first_name="Example", last_name="User",
446+
user.create(id_type=IdentityType.enterpriseID, firstname="Example", lastname="User",
447447
country="US", email="user@example.com")
448-
user.update(first_name="EXAMPLE")
448+
user.update(firstname="EXAMPLE")
449449
assert user.maybe_split_groups(10) is False
450450
assert len(user.commands) == 2
451451
assert user.wire_dict() == {'do': [{'createEnterpriseID': {'country': 'US',

tests/test_functional.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def test_create_user_adobeid_country():
7373

7474
def test_create_user_enterpriseid():
7575
user = UserAction(user="user@example.com")
76-
user.create(email="user@example.com", first_name="Example", last_name="User",
76+
user.create(email="user@example.com", firstname="Example", lastname="User",
7777
id_type=IdentityType.enterpriseID)
7878
assert user.wire_dict() == {"do": [{"createEnterpriseID": {"email": "user@example.com",
7979
"firstname": "Example", "lastname": "User",
@@ -83,7 +83,7 @@ def test_create_user_enterpriseid():
8383

8484
def test_create_user_federatedid():
8585
user = UserAction(user="user@example.com")
86-
user.create(email="user@example.com", first_name="Example", last_name="User",
86+
user.create(email="user@example.com", firstname="Example", lastname="User",
8787
country="US", id_type=IdentityType.federatedID)
8888
assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "user@example.com",
8989
"firstname": "Example", "lastname": "User",
@@ -92,7 +92,7 @@ def test_create_user_federatedid():
9292
"user": "user@example.com"}
9393

9494
user = UserAction(user="user@example.com")
95-
user.create(email="user@example.com", first_name="Example", last_name="User",
95+
user.create(email="user@example.com", firstname="Example", lastname="User",
9696
country="US")
9797
assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "user@example.com",
9898
"firstname": "Example", "lastname": "User",
@@ -103,7 +103,7 @@ def test_create_user_federatedid():
103103

104104
def test_create_user_federatedid_username():
105105
user = UserAction(user="user", domain="example.com")
106-
user.create(first_name="Example", last_name="User", country="US", email="user@example.com")
106+
user.create(firstname="Example", lastname="User", country="US", email="user@example.com")
107107
assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "user@example.com",
108108
"firstname": "Example", "lastname": "User",
109109
"country": "US",
@@ -124,7 +124,7 @@ def test_create_user_email_username_domain():
124124
def test_different_email_username():
125125
# pass username to identify user on create
126126
user = UserAction(user="user.username@example.com")
127-
user.create(email="user.email@example.com", first_name="User", last_name="Name", country="US")
127+
user.create(email="user.email@example.com", firstname="User", lastname="Name", country="US")
128128
assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "user.email@example.com",
129129
"firstname": "User",
130130
"lastname": "Name",
@@ -135,15 +135,15 @@ def test_different_email_username():
135135

136136
def test_update_user_adobeid():
137137
user = UserAction(user="user@example.com", use_adobe_id=True)
138-
user.update(first_name="User Updated", last_name="Name Updated")
138+
user.update(firstname="User Updated", lastname="Name Updated")
139139
assert user.wire_dict() == {"do": [{"update": {"firstname": "User Updated", "lastname": "Name Updated"}}],
140140
"user": "user@example.com",
141141
"useAdobeID": True}
142142

143143

144144
def test_update_user():
145145
user = UserAction(user="user@example.com")
146-
user.update(first_name="User Updated", last_name="Name Updated")
146+
user.update(firstname="User Updated", lastname="Name Updated")
147147
assert user.wire_dict() == {"do": [{"update": {"firstname": "User Updated", "lastname": "Name Updated"}}],
148148
"user": "user@example.com"}
149149

umapi_client/functional.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,16 @@ def __str__(self):
7777
def __repr__(self):
7878
return "UserAction "+str(self.__dict__)
7979

80-
def create(self, email, first_name=None,
81-
last_name=None, country=None, id_type=IdentityType.federatedID,
80+
def create(self, email, firstname=None,
81+
lastname=None, country=None, id_type=IdentityType.federatedID,
8282
on_conflict=IfAlreadyExistsOption.ignoreIfAlreadyExists):
8383
"""
8484
Create the user on the Adobe back end.
8585
See [Issue 32](https://github.com/adobe-apiplatform/umapi-client.py/issues/32): because
8686
we retry create calls if they time out, the default conflict handling for creation is to ignore the
8787
create call if the user already exists (possibly from an earlier call that timed out).
88-
:param first_name: (optional) user first name
89-
:param last_name: (optional) user last name
88+
:param firstname: (optional) user first name
89+
:param lastname: (optional) user last name
9090
:param country: (optional except for Federated ID) user 2-letter ISO country code
9191
:param email: user email, if not already specified at create time
9292
:param on_conflict: IfAlreadyExistsOption (or string name thereof) controlling creation of existing users
@@ -96,7 +96,7 @@ def create(self, email, first_name=None,
9696
id_type = IdentityType[id_type]
9797
if id_type not in IdentityType:
9898
raise ArgumentError("Identity type (%s) must be one of %s" % (id_type, [i.name for i in IdentityType]))
99-
# first validate the params: email, on_conflict, first_name, last_name, country
99+
# first validate the params: email, on_conflict, firstname, lastname, country
100100
create_params = {}
101101
create_params["email"] = email
102102
if on_conflict in IfAlreadyExistsOption.__members__:
@@ -105,8 +105,8 @@ def create(self, email, first_name=None,
105105
raise ArgumentError("on_conflict must be one of {}".format([o.name for o in IfAlreadyExistsOption]))
106106
if on_conflict != IfAlreadyExistsOption.errorIfAlreadyExists:
107107
create_params["option"] = on_conflict.name
108-
if first_name: create_params["firstname"] = first_name
109-
if last_name: create_params["lastname"] = last_name
108+
if firstname: create_params["firstname"] = firstname
109+
if lastname: create_params["lastname"] = lastname
110110
if country: create_params["country"] = country
111111

112112
# each type is created using a different call
@@ -118,18 +118,18 @@ def create(self, email, first_name=None,
118118
else:
119119
return self.insert(createFederatedID=dict(**create_params))
120120

121-
def update(self, email=None, username=None, first_name=None, last_name=None):
121+
def update(self, email=None, username=None, firstname=None, lastname=None):
122122
"""
123123
Update values on an existing user. See the API docs for what kinds of update are possible.
124124
:param email: new email for this user
125125
:param username: new username for this user
126-
:param first_name: new first name for this user
127-
:param last_name: new last name for this user
126+
:param firstname: new first name for this user
127+
:param lastname: new last name for this user
128128
:return: the User, so you can do User(...).update(...).add_to_groups(...)
129129
"""
130130
updates = {}
131131
for k, v in dict(email=email, username=username,
132-
firstname=first_name, lastname=last_name).items():
132+
firstname=firstname, lastname=lastname).items():
133133
if v:
134134
updates[k] = v
135135
return self.append(update=updates)

0 commit comments

Comments
 (0)