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 @@
 	"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 @@
 }
 
 // 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 @@
 		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) {
+// CreateShareSession creates a sharing session to initiate a sharing process based on a policy
+func (client *DigitalIdentityClient) CreateShareSession(shareSession digitalidentity.ShareSessionRequest) (share digitalidentity.ShareSession, err error) {
 	return digitalidentity.CreateShareSession(client.HTTPClient, shareSession, client.GetSdkID(), client.getAPIURL(), client.Key)
 }
+
+// GetShareSession retrieves the sharing session.
+func (client *DigitalIdentityClient) GetSession(sessionID string) (shareSession *digitalidentity.ShareSession, err error) {
+	return digitalidentity.GetSession(client.HTTPClient, sessionID, client.GetSdkID(), client.getAPIURL(), client.Key)
+}

digital_identity_client_test.go

@@ -1,21 +1,23 @@
 package yoti
 
 import (
+	"encoding/json"
+	"fmt"
 	"io"
 	"net/http"
 	"os"
 	"strings"
 	"testing"
 
-	"github.com/getyoti/yoti-go-sdk/v3/dynamic"
+	"github.com/getyoti/yoti-go-sdk/v3/digitalidentity"
 	"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,60 @@ 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)
+
+	session, err := (&digitalidentity.ShareSessionBuilder{}).WithPolicy(policy).Build()
+	assert.NilError(t, err)
+
+	result, err := client.CreateShareSession(session)
 
-	scenario, scenarioErr := (&dynamic.ScenarioBuilder{}).WithPolicy(policy).Build()
-	assert.NilError(t, scenarioErr)
+	b, err := json.Marshal(result)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(string(b))
 
-	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_ReturnsApplicationNotFound(t *testing.T) {
+	key := getValidKey()
+
+	client := DigitalIdentityClient{
+		HTTPClient: &mockHTTPClient{
+			do: func(*http.Request) (*http.Response, error) {
+				return &http.Response{
+					StatusCode: 404,
+				}, nil
+			},
+		},
+		Key: key,
+	}
+
+	_, err := client.GetSession("SOME ID")
+
+	assert.ErrorContains(t, err, "Application was not found")
+	tempError, temporary := err.(interface {
+		Temporary() bool
+	})
+	assert.Check(t, !temporary || !tempError.Temporary())
 }

digitalidentity/service.go

@@ -10,20 +10,23 @@ import (
 	"github.com/getyoti/yoti-go-sdk/v3/yotierror"
 )
 
-const identitySesssionCreationEndpoint = "/v2/sessions"
+const identitySesssionCreationEndpoint = "v2/sessions"
+const identitySessionRetrieval = "v2/sessions/%s"
 
 // SessionResult contains the information about a created session
-type SessionResult struct {
+
+/*type SessionResult struct {
 	Id     int    `json:"id"`
 	Status string `json:"status"`
 	Expiry string `json:"expiry"`
 }
+*/
 
 // CreateShareSession creates session using the supplied session specification
-func CreateShareSession(httpClient requests.HttpClient, shareSession *ShareSession, clientSdkId, apiUrl string, key *rsa.PrivateKey) (share ShareURL, err error) {
+func CreateShareSession(httpClient requests.HttpClient, shareSessionRequest ShareSessionRequest, clientSdkId, apiUrl string, key *rsa.PrivateKey) (share ShareSession, err error) {
 	endpoint := identitySesssionCreationEndpoint
 
-	payload, err := shareSession.MarshalJSON()
+	payload, err := shareSessionRequest.MarshalJSON()
 	if err != nil {
 		return share, err
 	}
@@ -33,14 +36,47 @@ func CreateShareSession(httpClient requests.HttpClient, shareSession *ShareSessi
 		HTTPMethod: http.MethodPost,
 		BaseURL:    apiUrl,
 		Endpoint:   endpoint,
-		Headers:    nil,
+		Headers:    requests.AuthHeader(clientSdkId),
 		Body:       payload,
 	}.Request()
 	if err != nil {
 		return share, err
 	}
 
-	response, err := requests.Execute(httpClient, request, ShareURLHTTPErrorMessages, yotierror.DefaultHTTPErrorMessages)
+	response, err := requests.Execute(httpClient, request, ShareSessionHTTPErrorMessages, yotierror.DefaultHTTPErrorMessages)
+	if err != nil {
+		return share, err
+	}
+
+	defer response.Body.Close()
+
+	responseBytes, err := io.ReadAll(response.Body)
+	if err != nil {
+		return share, err
+	}
+
+	err = json.Unmarshal(responseBytes, &share)
+
+	return share, err
+}
+
+// GetSession get session info using the supplied sessionID
+func GetSession(httpClient requests.HttpClient, sessionID string, clientSdkId, apiUrl string, key *rsa.PrivateKey) (share ShareSession, err error) {
+	endpoint := identitySesssionCreationEndpoint
+	headers := requests.AuthHeader(clientSdkId)
+	request, err := requests.SignedRequest{
+		Key:        key,
+		HTTPMethod: http.MethodGet,
+		BaseURL:    apiUrl,
+		Endpoint:   endpoint,
+		Headers:    headers,
+	}.Request()
+	if err != nil {
+		return share, err
+	}
+
+	response, err := requests.Execute(httpClient, request, ShareSessionHTTPErrorMessages, yotierror.DefaultHTTPErrorMessages)
+
 	if err != nil {
 		return share, err
 	}

digitalidentity/service_test.go

@@ -29,7 +29,7 @@
 		do: func(*http.Request) (*http.Response, error) {
 			return &http.Response{
 				StatusCode: 201,
-				Body:       io.NopCloser(strings.NewReader(`{"qrcode":"https://code.yoti.com/CAEaJDQzNzllZDc0LTU0YjItNDkxMy04OTE4LTExYzM2ZDU2OTU3ZDAC","ref_id":"0"}`)),
+				Body:       io.NopCloser(strings.NewReader(`{"id":"0","status":"success","expiry": ""}`)),
 			}, nil
 		},
 	}
@@ -46,19 +46,19 @@
 		return
 	}
 
-	result, err := CreateShareSession(client, &session, "sdkId", "https://apiurl", key)
+	result, err := CreateShareSession(client, session, "sdkId", "https://apiurl", key)
 
 	if err != nil {
 		fmt.Printf("error: %s", err.Error())
 		return
 	}
 
-	fmt.Printf("QR code: %s", result.ShareURL)
-	// Output: QR code: https://code.yoti.com/CAEaJDQzNzllZDc0LTU0YjItNDkxMy04OTE4LTExYzM2ZDU2OTU3ZDAC
+	fmt.Printf("Status code: %s", result.Status)
+	// Output: Status code: success
 }
 
 func TestCreateShareURL_Unsuccessful_503(t *testing.T) {
 	_, err := createShareUrlWithErrorResponse(503, "some service unavailable response")
 
 	assert.ErrorContains(t, err, "503: unknown HTTP error - some service unavailable response")
 
@@ -69,7 +69,7 @@
 }
 
 func TestCreateShareURL_Unsuccessful_404(t *testing.T) {
 	_, err := createShareUrlWithErrorResponse(404, "some not found response")
 
 	assert.ErrorContains(t, err, "404: Application was not found - some not found response")
 
@@ -80,7 +80,7 @@
 }
 
 func TestCreateShareURL_Unsuccessful_400(t *testing.T) {
 	_, err := createShareUrlWithErrorResponse(400, "some invalid JSON response")
 
 	assert.ErrorContains(t, err, "400: JSON is incorrect, contains invalid data - some invalid JSON response")
 
@@ -90,7 +90,7 @@
 	assert.Check(t, !temporary || !tempError.Temporary())
 }
 
-func createShareUrlWithErrorResponse(statusCode int, responseBody string) (share ShareURL, err error) {
+func createShareSessionWithErrorResponse(statusCode int, responseBody string) (share *ShareSession, err error) {
 	key := test.GetValidKey("../test/test-key.pem")
 
 	client := &mockHTTPClient{
@@ -106,10 +106,32 @@
 	if err != nil {
 		return
 	}
-	scenario, err := (&ShareSessionBuilder{}).WithPolicy(policy).Build()
+	session, err := (&ShareSessionBuilder{}).WithPolicy(policy).Build()
 	if err != nil {
 		return
 	}
 
-	return CreateShareSession(client, &scenario, "sdkId", "https://apiurl", key)
+	return CreateShareSession(client, session, "sdkId", "https://apiurl", key)
+}
+
+func ExampleGetSession() {
+	key := test.GetValidKey("../test/test-key.pem")
+	mockSessionID := "SOME_SESSION_ID"
+	mockClientSdkId := "SOME_CLIENT_SDK_ID"
+	mockApiUrl := "https://example.com/api"
+	client := &mockHTTPClient{
+		do: func(*http.Request) (*http.Response, error) {
+			return &http.Response{
+				StatusCode: 201,
+				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 := GetSession(client, mockSessionID, mockClientSdkId, mockApiUrl, key)
+	if err != nil {
+		return
+	}
+	fmt.Printf("Status code: %s", result.Status)
+	// Output:Status code: SOME_STATUS
 }

digitalidentity/share_session.go

@@ -0,0 +1,31 @@
+package digitalidentity
+
+var (
+	// ShareURLHTTPErrorMessages specifies the HTTP error status codes used
+	// by the Share URL API
+	ShareSessionHTTPErrorMessages = map[int]string{
+		400: "JSON is incorrect, contains invalid data",
+		404: "Application was not found",
+	}
+)
+
+// ShareSession object
+type ShareSession struct {
+	Id      string   `json:"id"`
+	Status  string   `json:"status"`
+	Expiry  string   `json:"expiry"`
+	Created string   `json:"created"`
+	Updated string   `json:"updated"`
+	QrCode  qrCode   `json:"qrCode"`
+	Receipt *receipt `json:"receipt"`
+}
+
+// ShareSession contains QR code as string
+type qrCode struct {
+	Id string `json:"id"`
+}
+
+// receipt containing the receipt id as a string.
+type receipt struct {
+	Id string `json:"id"`
+}