Merge pull request #38 from philips-software/bugfix/user-management

Support limited user updates using legacy API

Author: loafoe

iam/user.go

@@ -1,17 +1,16 @@
 package iam
 
-import "time"
+import (
+	"time"
+)
 
 // User represents a user profile in IAM
 type User struct {
-	PreferredLanguage string `json:"preferredLanguage"`
-	EmailAddress      string `json:"emailAddress"`
-	ID                string `json:"id"`
-	LoginID           string `json:"loginId"`
-	Name              struct {
-		Given  string `json:"given"`
-		Family string `json:"family"`
-	} `json:"name"`
+	PreferredLanguage    string `json:"preferredLanguage"`
+	EmailAddress         string `json:"emailAddress"`
+	ID                   string `json:"id"`
+	LoginID              string `json:"loginId"`
+	Name                 Name   `json:"name"`
 	ManagingOrganization string `json:"managingOrganization"`
 	PasswordStatus       struct {
 		PasswordExpiresOn time.Time `json:"passwordExpiresOn"`
@@ -49,16 +48,17 @@ type Person struct {
 	ManagingOrganization string         `json:"managingOrganization,omitempty"`
 	PreferredLanguage    string         `json:"preferredLanguage,omitempty"`
 	IsAgeValidated       string         `json:"isAgeValidated,omitempty"`
+	Password             string         `json:"password,omitempty"`
 	Disabled             bool           `json:"disabled"`
 	Loaded               bool           `json:"-"`
 }
 
 // Contact describes contact details of a Profile
 type Contact struct {
-	EmailAddress string
-	MobilePhone  string
-	WorkPhone    string
-	HomePhone    string
+	EmailAddress string `json:"emailAddress,omitempty"`
+	MobilePhone  string `json:"mobilePhone,omitempty"`
+	WorkPhone    string `json:"workPhone,omitempty"`
+	HomePhone    string `json:"homePhone,omitempty"`
 }
 
 // Address describes an address of a Profile
@@ -83,15 +83,30 @@ type Period struct {
 // Profile describes the response from legacy User APIs
 // The response does not correspond to the object that is used to create a user
 type Profile struct {
-	GivenName         string    `json:"givenName"`
-	MiddleName        string    `json:"middleName"`
-	FamilyName        string    `json:"familyName"`
-	BirthDay          string    `json:"birthDay"`
-	DisplayName       string    `json:"displayName"`
-	Gender            string    `json:"gender" enum:"Male|Female"`
-	Country           string    `json:"country"`
-	Addresses         []Address `json:"addresses"`
-	PreferredLanguage string    `json:"preferredLanguage"`
+	ID                string     `json:"-"`
+	GivenName         string     `json:"givenName"`
+	MiddleName        string     `json:"middleName"`
+	FamilyName        string     `json:"familyName"`
+	BirthDay          *time.Time `json:"birthDay,omitempty"`
+	DisplayName       string     `json:"displayName,omitempty"`
+	Gender            string     `json:"gender,omitempty" enum:"Male|Female"`
+	Country           string     `json:"country,omitempty"`
+	Contact           Contact    `json:"contact,omitempty"`
+	Addresses         []Address  `json:"addresses,omitempty,omitempty"`
+	PreferredLanguage string     `json:"preferredLanguage,omitempty"`
+}
+
+// MergeUser merges User into legacy Profile
+func (p *Profile) MergeUser(user *User) {
+	p.GivenName = user.Name.Given
+	p.FamilyName = user.Name.Family
+	// See INC0058741 for backround for this workaround
+	if p.MiddleName == "" {
+		p.MiddleName = " "
+	}
+	p.ID = user.ID
+	p.Contact.EmailAddress = user.EmailAddress
+	p.PreferredLanguage = user.PreferredLanguage
 }
 
 // Name entity
@@ -110,9 +125,11 @@ type TelecomEntry struct {
 
 // AddressEntry entity
 type AddressEntry struct {
-	Use        string `json:"use"`
-	City       string `json:"city"`
-	State      string `json:"state"`
-	Country    string `json:"country"`
-	Postalcode string `json:"postalcode"`
+	Use        string   `json:"use"`
+	Text       string   `json:"text"`
+	Line       []string `json:"line"`
+	City       string   `json:"city"`
+	State      string   `json:"state"`
+	Country    string   `json:"country"`
+	Postalcode string   `json:"postalcode"`
 }

iam/users_service.go

@@ -2,10 +2,9 @@ package iam
 
 import (
 	"fmt"
+	validator "github.com/go-playground/validator/v10"
 	"net/http"
 	"strconv"
-
-	validator "github.com/go-playground/validator/v10"
 )
 
 const (
@@ -75,7 +74,7 @@ func (u *UsersService) CreateUser(person Person) (*User, *Response, error) {
 	if err != nil {
 		return nil, nil, err
 	}
-	req.Header.Set("api-version", userAPIVersion)
+	req.Header.Set("api-version", "3")
 
 	var bundleResponse interface{}
 
@@ -313,6 +312,47 @@ func (u *UsersService) GetUserIDByLoginID(loginID string) (string, *Response, er
 	return user.ID, resp, nil
 }
 
+// LegacyUpdateUser updates the user profile
+func (u *UsersService) LegacyUpdateUser(profile Profile) (*Profile, *Response, error) {
+	req, _ := u.client.newRequest(IDM, "PUT", "security/users/"+profile.ID, profile, nil)
+	req.Header.Set("api-version", "1")
+
+	var responseStruct struct {
+		Exchange struct {
+			UserUUID string  `json:"userUUID"`
+			LoginID  string  `json:"loginId"`
+			Profile  Profile `json:"profile"`
+		} `json:"exchange"`
+		ResponseCode    string `json:"responseCode"`
+		ResponseMessage string `json:"responseMessage"`
+	}
+	resp, err := u.client.do(req, &responseStruct)
+	if err != nil {
+		return nil, resp, err
+	}
+	return &responseStruct.Exchange.Profile, resp, err
+}
+
+// LegacyGetUserByUUID looks the a user by UUID using the legacy API
+func (u *UsersService) LegacyGetUserByUUID(uuid string) (*Profile, *Response, error) {
+	req, _ := u.client.newRequest(IDM, "GET", "security/users/"+uuid, nil, nil)
+	req.Header.Set("api-version", "1")
+
+	var responseStruct struct {
+		Exchange struct {
+			LoginID string  `json:"loginId"`
+			Profile Profile `json:"profile"`
+		} `json:"exchange"`
+		ResponseCode    string `json:"responseCode"`
+		ResponseMessage string `json:"responseMessage"`
+	}
+	resp, err := u.client.do(req, &responseStruct)
+	if err != nil {
+		return nil, resp, err
+	}
+	return &responseStruct.Exchange.Profile, resp, err
+}
+
 // LegacyGetUserIDByLoginID looks up the UUID of a user by LoginID (email address)
 func (u *UsersService) LegacyGetUserIDByLoginID(loginID string) (string, *Response, error) {
 	opt := &GetUserOptions{

iam/users_service_test.go

@@ -135,11 +135,13 @@ func TestCreateUserSelfRegistration(t *testing.T) {
 		IsAgeValidated: "true",
 	}
 	user, resp, err := client.Users.CreateUser(person)
+	if !assert.Nil(t, err) {
+		return
+	}
 	if !assert.NotNil(t, resp) {
 		return
 	}
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
-	assert.Nil(t, err)
 	if !assert.NotNil(t, user) {
 		return
 	}
@@ -503,3 +505,118 @@ func actionRequestHandler(t *testing.T, paramName, informationalMessage string,
 		}
 	}
 }
+
+func TestLegacyPaths(t *testing.T) {
+	teardown := setup(t)
+	defer teardown()
+
+	userUUID := "44d20214-7879-4e35-923d-f9d4e01c9746"
+
+	muxIDM.HandleFunc("/authorize/identity/User", func(w http.ResponseWriter, request *http.Request) {
+		switch request.Method {
+		case http.MethodGet:
+			w.WriteHeader(http.StatusOK)
+			_, _ = w.Write([]byte(`{
+  "total": 1,
+  "entry": [
+    {
+      "preferredLanguage": "en-us",
+      "loginId": "ron",
+      "emailAddress": "[email protected]",
+      "id": "` + userUUID + `",
+      "managingOrganization": "daedbeaf-888d-4a26-8c1d-578e97365aaa",
+      "name": {
+        "given": "Ron",
+        "family": "Swanson"
+      },
+      "memberships": [],
+      "passwordStatus": {
+        "passwordExpiresOn": "2023-05-09T16:41:29Z",
+        "passwordChangedOn": "2020-05-09T16:41:29Z"
+      },
+      "accountStatus": {
+        "mfaStatus": "REQUIRED",
+        "lastLoginTime": null,
+        "emailVerified": true,
+        "disabled": false
+      },
+      "consentedApps": [
+        "default default default"
+      ]
+    }
+  ]
+}`))
+
+		}
+	})
+
+	muxIDM.HandleFunc("/security/users/"+userUUID,
+		func(w http.ResponseWriter, request *http.Request) {
+			switch request.Method {
+			case http.MethodGet:
+				w.WriteHeader(http.StatusOK)
+				_, _ = w.Write([]byte(`{
+  "exchange": {
+    "loginId": "ron",
+    "profile": {
+      "contact": {
+        "emailAddress": "[email protected]",
+        "mobilePhone": "1234567890"
+      },
+      "givenName": "Ron",
+      "familyName": "Swanson",
+      "addresses": [],
+      "disabled": false,
+      "preferredLanguage": "en-US"
+    }
+  },
+  "responseCode": "200",
+  "responseMessage": "Success"
+}`))
+			case http.MethodPut:
+				w.WriteHeader(http.StatusOK)
+				_, _ = w.Write([]byte(`{
+  "exchange": {
+    "userUUID": "` + userUUID + `",
+    "loginId": "ron",
+    "profile": {
+      "contact": {
+        "emailAddress": "[email protected]",
+        "mobilePhone": "31612345678"
+      },
+      "givenName": "Ron",
+      "familyName": "Swanson",
+      "addresses": [],
+      "disabled": false,
+      "preferredLanguage": "en-US"
+    }
+  },
+  "responseCode": "200",
+  "responseMessage": "Success"
+}`))
+			}
+		})
+
+	user, resp, err := client.Users.LegacyGetUserByUUID(userUUID)
+	if !assert.NotNil(t, resp) {
+		return
+	}
+	if !assert.NotNil(t, user) {
+		return
+	}
+	assert.Nil(t, err)
+	assert.Equal(t, "Swanson", user.FamilyName)
+	user.GivenName = "Ron"
+	user.ID = userUUID
+	profile, resp, err := client.Users.LegacyUpdateUser(*user)
+	if !assert.Nil(t, err) {
+		return
+	}
+	if !assert.NotNil(t, resp) {
+		return
+	}
+	if !assert.NotNil(t, profile) {
+		return
+	}
+	assert.Equal(t, "Swanson", profile.FamilyName)
+}