Merge pull request #303 from getyoti/SDK-2422-go-fix-code-smells

getyoti · Jan 9, 2024 · 2839077 · 2839077
2 parents 7dc79f0 + f3a1654
commit 2839077
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ import "github.com/getyoti/yoti-go-sdk/v3"
 or add the following line to your go.mod file (check https://github.com/getyoti/yoti-go-sdk/releases for the latest version)
 ```
 
-require github.com/getyoti/yoti-go-sdk/v3 v3.11.0
+require github.com/getyoti/yoti-go-sdk/v3 v3.12.0
 ```
 
 ## Setup

diff --git a/consts/version.go b/consts/version.go
@@ -2,5 +2,5 @@ package consts
 
 const (
 	SDKIdentifier        = "Go"
-	SDKVersionIdentifier = "3.11.0"
+	SDKVersionIdentifier = "3.12.0"
 )
diff --git a/digitalidentity/requests/signed_message_test.go b/digitalidentity/requests/signed_message_test.go
@@ -80,7 +80,7 @@ func TestRequestShouldBuildForValid(t *testing.T) {
 	assert.Check(t, urlCheck)
 	assert.Check(t, signed.Header.Get("X-Yoti-Auth-Digest") != "")
 	assert.Equal(t, signed.Header.Get("X-Yoti-SDK"), "Go")
-	assert.Equal(t, signed.Header.Get("X-Yoti-SDK-Version"), "3.11.0")
+	assert.Equal(t, signed.Header.Get("X-Yoti-SDK-Version"), "3.12.0")
 }
 
 func TestRequestShouldAddHeaders(t *testing.T) {

diff --git a/digitalidentity/service.go b/digitalidentity/service.go
@@ -20,6 +20,9 @@ const identitySessionQrCodeCreation = "/v2/sessions/%s/qr-codes"
 const identitySessionQrCodeRetrieval = "/v2/qr-codes/%s"
 const identitySessionReceiptRetrieval = "/v2/receipts/%s"
 const identitySessionReceiptKeyRetrieval = "/v2/wrapped-item-keys/%s"
+const errorFailedToGetSignedRequest = "failed to get signed request: %v"
+const errorFailedToExecuteRequest = "failed to execute request: %v"
+const errorFailedToReadBody = "failed to read response body: %v"
 
 // CreateShareSession creates session using the supplied session specification
 func CreateShareSession(httpClient requests.HttpClient, shareSessionRequest *ShareSessionRequest, clientSdkId, apiUrl string, key *rsa.PrivateKey) (*ShareSession, error) {
@@ -40,20 +43,20 @@ func CreateShareSession(httpClient requests.HttpClient, shareSessionRequest *Sha
 		Params:     map[string]string{"sdkID": clientSdkId},
 	}.Request()
 	if err != nil {
-		return nil, fmt.Errorf("failed to get signed request: %v", err)
+		return nil, fmt.Errorf(errorFailedToGetSignedRequest, err)
 	}
 
 	response, err := requests.Execute(httpClient, request)
 	if err != nil {
-		return nil, fmt.Errorf("failed to execute request: %v", err)
+		return nil, fmt.Errorf(errorFailedToExecuteRequest, err)
 	}
 
 	defer response.Body.Close()
 	shareSession := &ShareSession{}
 
 	responseBytes, err := io.ReadAll(response.Body)
 	if err != nil {
-		return nil, fmt.Errorf("failed to read response body: %v", err)
+		return nil, fmt.Errorf(errorFailedToReadBody, err)
 	}
 	err = json.Unmarshal(responseBytes, shareSession)
 	return shareSession, err
@@ -72,19 +75,19 @@ func GetShareSession(httpClient requests.HttpClient, sessionID string, clientSdk
 		Params:     map[string]string{"sdkID": clientSdkId},
 	}.Request()
 	if err != nil {
-		return nil, fmt.Errorf("failed to get signed request: %v", err)
+		return nil, fmt.Errorf(errorFailedToGetSignedRequest, err)
 	}
 
 	response, err := requests.Execute(httpClient, request)
 
 	if err != nil {
-		return nil, fmt.Errorf("failed to execute request: %v", err)
+		return nil, fmt.Errorf(errorFailedToExecuteRequest, err)
 	}
 	defer response.Body.Close()
 	shareSession := &ShareSession{}
 	responseBytes, err := io.ReadAll(response.Body)
 	if err != nil {
-		return nil, fmt.Errorf("failed to read response body: %v", err)
+		return nil, fmt.Errorf(errorFailedToReadBody, err)
 	}
 	err = json.Unmarshal(responseBytes, shareSession)
 	return shareSession, err
@@ -104,19 +107,19 @@ func CreateShareQrCode(httpClient requests.HttpClient, sessionID string, clientS
 		Params:     map[string]string{"sdkID": clientSdkId},
 	}.Request()
 	if err != nil {
-		return nil, fmt.Errorf("failed to get signed request: %v", err)
+		return nil, fmt.Errorf(errorFailedToGetSignedRequest, err)
 	}
 
 	response, err := requests.Execute(httpClient, request)
 	if err != nil {
-		return nil, fmt.Errorf("failed to execute request: %v", err)
+		return nil, fmt.Errorf(errorFailedToExecuteRequest, err)
 	}
 
 	defer response.Body.Close()
 	qrCode := &QrCode{}
 	responseBytes, err := io.ReadAll(response.Body)
 	if err != nil {
-		return nil, fmt.Errorf("failed to read response body: %v", err)
+		return nil, fmt.Errorf(errorFailedToReadBody, err)
 	}
 	err = json.Unmarshal(responseBytes, qrCode)
 	return qrCode, err
@@ -134,18 +137,18 @@ func GetShareSessionQrCode(httpClient requests.HttpClient, qrCodeId string, clie
 		Headers:    headers,
 	}.Request()
 	if err != nil {
-		return fetchedQrCode, fmt.Errorf("failed to get signed request: %v", err)
+		return fetchedQrCode, fmt.Errorf(errorFailedToGetSignedRequest, err)
 	}
 
 	response, err := requests.Execute(httpClient, request)
 	if err != nil {
-		return fetchedQrCode, fmt.Errorf("failed to execute request: %v", err)
+		return fetchedQrCode, fmt.Errorf(errorFailedToExecuteRequest, err)
 	}
 	defer response.Body.Close()
 
 	responseBytes, err := io.ReadAll(response.Body)
 	if err != nil {
-		return fetchedQrCode, fmt.Errorf("failed to read response body: %v", err)
+		return fetchedQrCode, fmt.Errorf(errorFailedToReadBody, err)
 	}
 
 	err = json.Unmarshal(responseBytes, &fetchedQrCode)
@@ -167,18 +170,18 @@ func getReceipt(httpClient requests.HttpClient, receiptId string, clientSdkId, a
 		Headers:    headers,
 	}.Request()
 	if err != nil {
-		return receipt, fmt.Errorf("failed to get signed request: %v", err)
+		return receipt, fmt.Errorf(errorFailedToGetSignedRequest, err)
 	}
 
 	response, err := requests.Execute(httpClient, request)
 	if err != nil {
-		return receipt, fmt.Errorf("failed to execute request: %v", err)
+		return receipt, fmt.Errorf(errorFailedToExecuteRequest, err)
 	}
 	defer response.Body.Close()
 
 	responseBytes, err := io.ReadAll(response.Body)
 	if err != nil {
-		return receipt, fmt.Errorf("failed to read response body: %v", err)
+		return receipt, fmt.Errorf(errorFailedToReadBody, err)
 	}
 
 	err = json.Unmarshal(responseBytes, &receipt)
@@ -198,7 +201,7 @@ func getReceiptItemKey(httpClient requests.HttpClient, receiptItemKeyId string,
 		Headers:    headers,
 	}.Request()
 	if err != nil {
-		return receiptItemKey, fmt.Errorf("failed to get signed request: %v", err)
+		return receiptItemKey, fmt.Errorf(errorFailedToGetSignedRequest, err)
 	}
 
 	response, err := requests.Execute(httpClient, request)

diff --git a/requests/signed_message.go b/requests/signed_message.go
@@ -41,13 +41,6 @@ func JSONHeaders() map[string][]string {
 	}
 }
 
-// AuthHeader is a header prototype including the App/SDK ID
-func AuthHeader(clientSdkId string, key *rsa.PublicKey) map[string][]string {
-	return map[string][]string{
-		"X-Yoti-Auth-Id": {clientSdkId},
-	}
-}
-
 // AuthKeyHeader is a header prototype including an encoded RSA PublicKey
 func AuthKeyHeader(key *rsa.PublicKey) map[string][]string {
 	return map[string][]string{

diff --git a/requests/signed_message_test.go b/requests/signed_message_test.go
@@ -80,7 +80,7 @@ func TestRequestShouldBuildForValid(t *testing.T) {
 	assert.Check(t, urlCheck)
 	assert.Check(t, signed.Header.Get("X-Yoti-Auth-Digest") != "")
 	assert.Equal(t, signed.Header.Get("X-Yoti-SDK"), "Go")
-	assert.Equal(t, signed.Header.Get("X-Yoti-SDK-Version"), "3.11.0")
+	assert.Equal(t, signed.Header.Get("X-Yoti-SDK-Version"), "3.12.0")
 }
 
 func TestRequestShouldAddHeaders(t *testing.T) {

diff --git a/sonar-project.properties b/sonar-project.properties
@@ -1,7 +1,7 @@
 sonar.organization = getyoti
 sonar.projectKey = getyoti:go
 sonar.projectName = Go SDK
-sonar.projectVersion = 3.11.0
+sonar.projectVersion = 3.12.0
 sonar.exclusions = **/yotiprotoattr/*.go,**/yotiprotocom/*.go,**/yotiprotoshare/*.go,**/**_test.go,_examples/**/*
 sonar.links.scm = https://github.com/getyoti/yoti-go-sdk
 sonar.host.url = https://sonarcloud.io