Sdk 2246 go retrieve session

client_test.go

@@ -26,10 +26,10 @@ func (mock *mockHTTPClient) Do(request *http.Request) (*http.Response, error) {
 }
 
 func TestNewClient(t *testing.T) {
-	key, readErr := os.ReadFile("./test/test-key.pem")
-	assert.NilError(t, readErr)
+	key, err := os.ReadFile("./test/test-key.pem")
+	assert.NilError(t, err)
 
-	_, err := NewClient("some-sdk-id", key)
+	_, err = NewClient("some-sdk-id", key)
 	assert.NilError(t, err)
 }
 
@@ -48,11 +48,11 @@ func TestNewClient_KeyLoad_Failure(t *testing.T) {
 }
 
 func TestYotiClient_PerformAmlCheck(t *testing.T) {
-	key, readErr := os.ReadFile("./test/test-key.pem")
-	assert.NilError(t, readErr)
+	key, err := os.ReadFile("./test/test-key.pem")
+	assert.NilError(t, err)
 
-	client, clientErr := NewClient("some-sdk-id", key)
-	assert.NilError(t, clientErr)
+	client, err := NewClient("some-sdk-id", key)
+	assert.NilError(t, err)
 
 	client.HTTPClient = &mockHTTPClient{
 		do: func(*http.Request) (*http.Response, error) {
@@ -78,11 +78,11 @@ func TestYotiClient_PerformAmlCheck(t *testing.T) {
 }
 
 func TestYotiClient_CreateShareURL(t *testing.T) {
-	key, readErr := os.ReadFile("./test/test-key.pem")
-	assert.NilError(t, readErr)
+	key, err := os.ReadFile("./test/test-key.pem")
+	assert.NilError(t, err)
 
-	client, clientErr := NewClient("some-sdk-id", key)
-	assert.NilError(t, clientErr)
+	client, err := NewClient("some-sdk-id", key)
+	assert.NilError(t, err)
 
 	client.HTTPClient = &mockHTTPClient{
 		do: func(*http.Request) (*http.Response, error) {
@@ -93,11 +93,11 @@ func TestYotiClient_CreateShareURL(t *testing.T) {
 		},
 	}
 
-	policy, policyErr := (&dynamic.PolicyBuilder{}).WithFullName().WithWantedRememberMe().Build()
-	assert.NilError(t, policyErr)
+	policy, err := (&dynamic.PolicyBuilder{}).WithFullName().WithWantedRememberMe().Build()
+	assert.NilError(t, err)
 
-	scenario, scenarioErr := (&dynamic.ScenarioBuilder{}).WithPolicy(policy).Build()
-	assert.NilError(t, scenarioErr)
+	scenario, err := (&dynamic.ScenarioBuilder{}).WithPolicy(policy).Build()
+	assert.NilError(t, err)
 
 	result, err := client.CreateShareURL(&scenario)
 	assert.NilError(t, err)

digital_identity_client.go

@@ -9,7 +9,7 @@ import (
 	"github.com/getyoti/yoti-go-sdk/v3/requests"
 )
 
-const DefaultURL = "https://api.yoti.com/api/"
+const DefaultURL = "https://api.yoti.com/share"
 
 // DigitalIdentityClient represents a client that can communicate with yoti and return information about Yoti users.
 type DigitalIdentityClient struct {
@@ -27,14 +27,14 @@ type DigitalIdentityClient struct {
 }
 
 // NewDigitalIdentityClient constructs a Client object
-func NewDigitalIdentityClient(sdkID string, key []byte) (*Client, error) {
+func NewDigitalIdentityClient(sdkID string, key []byte) (*DigitalIdentityClient, error) {
 	decodedKey, err := cryptoutil.ParseRSAKey(key)
 
 	if err != nil {
 		return nil, err
 	}
 
-	return &Client{
+	return &DigitalIdentityClient{
 		SdkID: sdkID,
 		Key:   decodedKey,
 	}, err
@@ -54,15 +54,20 @@ func (client *DigitalIdentityClient) getAPIURL() string {
 		return value
 	}
 
-	return apiDefaultURL
+	return DefaultURL
 }
 
 // GetSdkID gets the Client SDK ID attached to this client instance
 func (client *DigitalIdentityClient) GetSdkID() string {
 	return client.SdkID
 }
 
-// CreateShareURL creates a QR code for a specified share session configuration.
-func (client *DigitalIdentityClient) CreateShareURL(shareSession *digitalidentity.ShareSession) (share digitalidentity.ShareURL, err error) {
-	return digitalidentity.CreateShareSession(client.HTTPClient, shareSession, client.GetSdkID(), client.getAPIURL(), client.Key)
+// CreateShareSession creates a sharing session to initiate a sharing process based on a policy
+func (client *DigitalIdentityClient) CreateShareSession(shareSessionRequest *digitalidentity.ShareSessionRequest) (shareSession *digitalidentity.ShareSession, err error) {
+	return digitalidentity.CreateShareSession(client.HTTPClient, shareSessionRequest, client.GetSdkID(), client.getAPIURL(), client.Key)
+}
+
+// GetShareSession retrieves the sharing session.
+func (client *DigitalIdentityClient) GetShareSession(sessionID string) (*digitalidentity.ShareSession, error) {
+	return digitalidentity.GetShareSession(client.HTTPClient, sessionID, client.GetSdkID(), client.getAPIURL(), client.Key)
 }

digital_identity_client_test.go

@@ -1,21 +1,23 @@
 package yoti
 
 import (
+	"crypto/rsa"
 	"io"
 	"net/http"
 	"os"
 	"strings"
 	"testing"
 
-	"github.com/getyoti/yoti-go-sdk/v3/dynamic"
+	"github.com/getyoti/yoti-go-sdk/v3/digitalidentity"
+	"github.com/getyoti/yoti-go-sdk/v3/test"
 	"gotest.tools/v3/assert"
 )
 
 func TestDigitalIDClient(t *testing.T) {
-	key, readErr := os.ReadFile("./test/test-key.pem")
-	assert.NilError(t, readErr)
+	key, err := os.ReadFile("./test/test-key.pem")
+	assert.NilError(t, err)
 
-	_, err := NewDigitalIdentityClient("some-sdk-id", key)
+	_, err = NewDigitalIdentityClient("some-sdk-id", key)
 	assert.NilError(t, err)
 }
 
@@ -33,29 +35,134 @@ func TestDigitalIDClient_KeyLoad_Failure(t *testing.T) {
 	assert.Check(t, !temporary || !tempError.Temporary())
 }
 
-func TestDigitalIDClient_CreateShareURL(t *testing.T) {
-	key, readErr := os.ReadFile("./test/test-key.pem")
-	assert.NilError(t, readErr)
+func TestYotiClient_CreateShareSession(t *testing.T) {
+	key, err := os.ReadFile("./test/test-key.pem")
+	assert.NilError(t, err)
 
-	client, clientErr := NewDigitalIdentityClient("some-sdk-id", key)
-	assert.NilError(t, clientErr)
+	client, err := NewDigitalIdentityClient("some-sdk-id", key)
+	assert.NilError(t, err)
 
 	client.HTTPClient = &mockHTTPClient{
 		do: func(*http.Request) (*http.Response, error) {
 			return &http.Response{
 				StatusCode: 201,
-				Body:       io.NopCloser(strings.NewReader(`{"qrcode":"https://code.yoti.com/some-qr","ref_id":"0"}`)),
+				Body:       io.NopCloser(strings.NewReader(`{"id":"SOME_ID","status":"SOME_STATUS","expiry":"SOME_EXPIRY","created":"SOME_CREATED","updated":"SOME_UPDATED","qrCode":{"id":"SOME_QRCODE_ID"},"receipt":{"id":"SOME_RECEIPT_ID"}}`)),
 			}, nil
 		},
 	}
 
-	policy, policyErr := (&dynamic.PolicyBuilder{}).WithFullName().WithWantedRememberMe().Build()
-	assert.NilError(t, policyErr)
+	policy, err := (&digitalidentity.PolicyBuilder{}).WithFullName().WithWantedRememberMe().Build()
+	assert.NilError(t, err)
 
-	scenario, scenarioErr := (&dynamic.ScenarioBuilder{}).WithPolicy(policy).Build()
-	assert.NilError(t, scenarioErr)
+	session, err := (&digitalidentity.ShareSessionRequestBuilder{}).WithPolicy(policy).Build()
+	assert.NilError(t, err)
+
+	result, err := client.CreateShareSession(&session)
 
-	result, err := client.CreateShareURL(&scenario)
 	assert.NilError(t, err)
-	assert.Equal(t, result.ShareURL, "https://code.yoti.com/some-qr")
+	assert.Equal(t, result.Status, "SOME_STATUS")
+}
+
+func TestDigitalIDClient_HttpFailure_ReturnsUnKnownHttpError(t *testing.T) {
+	key := getDigitalValidKey()
+	client := DigitalIdentityClient{
+		HTTPClient: &mockHTTPClient{
+			do: func(*http.Request) (*http.Response, error) {
+				return &http.Response{
+					StatusCode: 401,
+				}, nil
+			},
+		},
+		Key: key,
+	}
+
+	_, err := client.GetShareSession("SOME ID")
+
+	assert.ErrorContains(t, err, "unknown HTTP error")
+	tempError, temporary := err.(interface {
+		Temporary() bool
+	})
+	assert.Check(t, !temporary || !tempError.Temporary())
+}
+
+func TestDigitalIDClient_GetSession(t *testing.T) {
+	key, err := os.ReadFile("./test/test-key.pem")
+	if err != nil {
+		t.Fatalf("failed to read pem file :: %v", err)
+	}
+
+	mockSessionID := "SOME_SESSION_ID"
+	client, err := NewDigitalIdentityClient("some-sdk-id", key)
+	if err != nil {
+		t.Fatalf("failed to build the DigitalIdClient :: %v", err)
+	}
+
+	client.HTTPClient = &mockHTTPClient{
+		do: func(*http.Request) (*http.Response, error) {
+			return &http.Response{
+				StatusCode: 200,
+				Body:       io.NopCloser(strings.NewReader(`{"id":"SOME_ID","status":"SOME_STATUS","expiry":"SOME_EXPIRY","created":"SOME_CREATED","updated":"SOME_UPDATED","qrCode":{"id":"SOME_QRCODE_ID"},"receipt":{"id":"SOME_RECEIPT_ID"}}`)),
+			}, nil
+		},
+	}
+
+	result, err := client.GetShareSession(mockSessionID)
+	if err != nil {
+		t.Fatalf("failed to GetShareSesssion :: %v", err)
+	}
+
+	assert.Equal(t, result.Id, "SOME_ID")
+	assert.Equal(t, result.Status, "SOME_STATUS")
+	assert.Equal(t, result.Created, "SOME_CREATED")
+
+}
+
+func TestDigitalIDClient_OverrideAPIURL_ShouldSetAPIURL(t *testing.T) {
+	client := &DigitalIdentityClient{}
+
+	expectedURL := "expectedurl.com"
+	client.OverrideAPIURL(expectedURL)
+
+	assert.Equal(t, client.getAPIURL(), expectedURL)
+}
+
+func TestDigitalIDClient_GetAPIURLUsesOverriddenBaseUrlOverEnvVariable(t *testing.T) {
+	client := DigitalIdentityClient{}
+	client.OverrideAPIURL("overridenBaseUrl")
+
+	os.Setenv("YOTI_API_URL", "envBaseUrl")
+	result := client.getAPIURL()
+
+	assert.Equal(t, "overridenBaseUrl", result)
+}
+
+func TestDigitalIDClient_GetAPIURLUsesEnvVariable(t *testing.T) {
+	client := DigitalIdentityClient{}
+
+	os.Setenv("YOTI_API_URL", "envBaseUrl")
+	result := client.getAPIURL()
+
+	assert.Equal(t, "envBaseUrl", result)
+}
+
+func TestDigitalIDClient_GetAPIURLUsesDefaultUrlAsFallbackWithEmptyEnvValue(t *testing.T) {
+	client := DigitalIdentityClient{}
+
+	os.Setenv("YOTI_API_URL", "")
+	result := client.getAPIURL()
+
+	assert.Equal(t, "https://api.yoti.com/share", result)
+}
+
+func TestDigitalIDClient_GetAPIURLUsesDefaultUrlAsFallbackWithNoEnvValue(t *testing.T) {
+	client := DigitalIdentityClient{}
+
+	os.Unsetenv("YOTI_API_URL")
+	result := client.getAPIURL()
+
+	assert.Equal(t, "https://api.yoti.com/share", result)
+}
+
+func getDigitalValidKey() *rsa.PrivateKey {
+	return test.GetValidKey("test/test-key.pem")
 }

digitalidentity/requests/client.go

@@ -0,0 +1,10 @@
+package requests
+
+import (
+	"net/http"
+)
+
+// HttpClient is a mockable HTTP Client Interface
+type HttpClient interface {
+	Do(*http.Request) (*http.Response, error)
+}

digitalidentity/requests/request.go

@@ -0,0 +1,38 @@
+package requests
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/getyoti/yoti-go-sdk/v3/digitalidentity/yotierror"
+)
+
+// Execute makes a request to the specified endpoint, with an optional payload
+func Execute(httpClient HttpClient, request *http.Request) (response *http.Response, err error) {
+	if response, err = doRequest(request, httpClient); err != nil {
+		return
+	}
+
+	statusCodeIsFailure := response.StatusCode >= 300 || response.StatusCode < 200
+
+	if statusCodeIsFailure {
+		return response, yotierror.NewResponseError(response)
+	}
+
+	return response, nil
+}
+
+func doRequest(request *http.Request, httpClient HttpClient) (*http.Response, error) {
+	httpClient = ensureHttpClientTimeout(httpClient)
+	return httpClient.Do(request)
+}
+
+func ensureHttpClientTimeout(httpClient HttpClient) HttpClient {
+	if httpClient == nil {
+		httpClient = &http.Client{
+			Timeout: time.Second * 10,
+		}
+	}
+
+	return httpClient
+}