SDK-2259:added retrieve qr code

.gitignore

@@ -17,6 +17,4 @@ report.json
 # idea files
 .idea
 
-# Generated binaries
-/_examples/docscan/docscan
 

_examples/.gitignore

@@ -1 +1,9 @@
 .env
+# Generated binaries
+docscan/docscan
+idv/idv
+aml/aml
+docscansandbox/docscansandbox
+profile/profile
+profilesandbox/profilesandbox
+digitalidentity/digitalidentity

_examples/idv/handlers.session.go

@@ -1,14 +1,11 @@
 package main
 
 import (
-	"encoding/json"
 	"errors"
 	"fmt"
 	"net/http"
 	"os"
 
-	"github.com/getyoti/yoti-go-sdk/v3"
-	"github.com/getyoti/yoti-go-sdk/v3/digitalidentity"
 	"github.com/getyoti/yoti-go-sdk/v3/docscan"
 	"github.com/getyoti/yoti-go-sdk/v3/docscan/session/create"
 	"github.com/gin-gonic/gin"
@@ -24,7 +21,6 @@ var (
 	key                 []byte
 	client              *docscan.Client
 	createSessionResult *create.SessionResult
-	didClient           *yoti.DigitalIdentityClient
 )
 
 func showIndexPage(c *gin.Context) {
@@ -212,83 +208,3 @@ func showPrivacyPolicyPage(c *gin.Context) {
 	render(c, gin.H{}, "privacy.html")
 	return
 }
-
-/* For Testing */
-
-func showDigitalPage(c *gin.Context) {
-	sessionReq, err := buildDigitalIdentitySessionReq()
-	if err != nil {
-		c.HTML(
-			http.StatusInternalServerError,
-			"error.html",
-			gin.H{
-				"ErrorTitle":   "Error when building sessions spec",
-				"ErrorMessage": err.Error()})
-		return
-	}
-	pageFromShareSessionReq(c, sessionReq)
-}
-
-func initialiseDigitalIdentityClient() error {
-	var err error
-	sdkID = os.Getenv("YOTI_CLIENT_SDK_ID")
-	keyFilePath := os.Getenv("YOTI_KEY_FILE_PATH")
-	key, err = os.ReadFile(keyFilePath)
-	if err != nil {
-		return fmt.Errorf("failed to get key from YOTI_KEY_FILE_PATH :: %w", err)
-	}
-
-	didClient, err = yoti.NewDigitalIdentityClient(sdkID, key)
-	if err != nil {
-		return fmt.Errorf("failed to initialise Share client :: %w", err)
-	}
-	//didClient.OverrideAPIURL("https://connect.public.stg1.dmz.yoti.com/share/")
-	didClient.OverrideAPIURL("https://api.yoti.com/share")
-
-	return nil
-}
-
-func pageFromShareSessionReq(c *gin.Context, sessionReq *digitalidentity.ShareSessionRequest) {
-	err := initialiseDigitalIdentityClient()
-	if err != nil {
-		c.HTML(
-			http.StatusUnprocessableEntity,
-			"error.html",
-			gin.H{
-				"ErrorTitle":   "Error initialising DID Client",
-				"ErrorMessage": errors.Unwrap(err)})
-		return
-	}
-	b, err := json.Marshal(sessionReq)
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
-	fmt.Println(string(b))
-
-	shareSession, err := didClient.CreateShareSession(sessionReq)
-
-	createQr, err := didClient.CreateShareQrCode(shareSession.Id)
-
-	b, err = json.Marshal(createQr)
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
-	fmt.Println(string(b))
-
-	if err != nil {
-		c.HTML(
-			http.StatusInternalServerError,
-			"error.html",
-			gin.H{
-				"ErrorTitle":   "Error when creating Share session",
-				"ErrorMessage": err.Error()})
-		return
-	}
-
-	c.SetCookie("session_id", shareSession.Id, 60*20, "/", "localhost", true, false)
-	return
-}
-
-/* For Testing */

_examples/idv/models.sessionspec.go

@@ -1,10 +1,8 @@
 package main
 
 import (
-	"encoding/json"
 	"time"
 
-	"github.com/getyoti/yoti-go-sdk/v3/digitalidentity"
 	"github.com/getyoti/yoti-go-sdk/v3/docscan/session/create"
 	"github.com/getyoti/yoti-go-sdk/v3/docscan/session/create/check"
 	"github.com/getyoti/yoti-go-sdk/v3/docscan/session/create/filter"
@@ -214,29 +212,3 @@ func buildDBSSessionSpec() (sessionSpec *create.SessionSpecification, err error)
 	}
 	return sessionSpec, nil
 }
-
-/* For Testing */
-func buildDigitalIdentitySessionReq() (sessionSpec *digitalidentity.ShareSessionRequest, err error) {
-	identityProfile := json.RawMessage(`{
-		"trust_framework": "UK_TFIDA",
-		"scheme": {
-    		"type": "RTW"
-		}
-	}`)
-	policy, err := (&digitalidentity.PolicyBuilder{}).WithIdentityProfileRequirements(identityProfile).Build()
-	if err != nil {
-		return nil, err
-	}
-
-	subject := []byte(`{
-		"subject_id": "unique-user-id-for-examples"
-	}`)
-
-	sessionReq, err := (&digitalidentity.ShareSessionRequestBuilder{}).WithPolicy(policy).WithRedirectUri("https:/www.yoti.com").WithSubject(subject).Build()
-	if err != nil {
-		return nil, err
-	}
-	return &sessionReq, nil
-}
-
-/* For Testing */

_examples/idv/routes.go

@@ -12,7 +12,4 @@ func initializeRoutes() {
 	router.GET("/success", showSuccessPage)
 	router.GET("/media", getMedia)
 	router.GET("/privacy-policy", showPrivacyPolicyPage)
-	/* For Testing */
-	router.GET("/digital-identity", showDigitalPage)
-	/* For Testing */
 }

digital_identity_client.go

@@ -72,7 +72,12 @@ func (client *DigitalIdentityClient) GetShareSession(sessionID string) (*digital
 	return digitalidentity.GetShareSession(client.HTTPClient, sessionID, client.GetSdkID(), client.getAPIURL(), client.Key)
 }
 
-// Create a sharing session QR code to initiate a sharing process based on session ID
+// CreateShareQrCode generates a sharing session QR code to initiate a sharing process based on session ID
 func (client *DigitalIdentityClient) CreateShareQrCode(sessionID string) (share *digitalidentity.QrCode, err error) {
 	return digitalidentity.CreateShareQrCode(client.HTTPClient, sessionID, client.GetSdkID(), client.getAPIURL(), client.Key)
 }
+
+// Get session QR code based on generated Qr ID
+func (client *DigitalIdentityClient) GetQrCode(qrCodeId string) (share digitalidentity.ShareSessionQrCode, err error) {
+	return digitalidentity.GetShareSessionQrCode(client.HTTPClient, qrCodeId, client.GetSdkID(), client.getAPIURL(), client.Key)
+}

digitalidentity/service.go

@@ -13,6 +13,7 @@ import (
 const identitySessionCreationEndpoint = "/v2/sessions"
 const identitySessionRetrieval = "/v2/sessions/%s"
 const identitySessionQrCodeCreation = "/v2/sessions/%s/qr-codes"
+const identitySessionQrCodeRetrieval = "/v2/qr-codes/%s"
 
 // CreateShareSession creates session using the supplied session specification
 func CreateShareSession(httpClient requests.HttpClient, shareSessionRequest *ShareSessionRequest, clientSdkId, apiUrl string, key *rsa.PrivateKey) (*ShareSession, error) {
@@ -82,7 +83,7 @@ func GetShareSession(httpClient requests.HttpClient, sessionID string, clientSdk
 	return shareSession, err
 }
 
-// CreateQrCode using the supplied sessionID parameter
+// CreateShareQrCode generates a sharing qr code using the supplied sessionID parameter
 func CreateShareQrCode(httpClient requests.HttpClient, sessionID string, clientSdkId, apiUrl string, key *rsa.PrivateKey) (*QrCode, error) {
 	endpoint := fmt.Sprintf(identitySessionQrCodeCreation, sessionID)
 
@@ -113,3 +114,34 @@ func CreateShareQrCode(httpClient requests.HttpClient, sessionID string, clientS
 	err = json.Unmarshal(responseBytes, qrCode)
 	return qrCode, err
 }
+
+// GetShareSessionQrCode is used to fetch the qr code by  id.
+func GetShareSessionQrCode(httpClient requests.HttpClient, qrCodeId string, clientSdkId, apiUrl string, key *rsa.PrivateKey) (fetchedQrCode ShareSessionQrCode, err error) {
+	endpoint := fmt.Sprintf(identitySessionQrCodeRetrieval, qrCodeId)
+	headers := requests.AuthHeader(clientSdkId)
+	request, err := requests.SignedRequest{
+		Key:        key,
+		HTTPMethod: http.MethodGet,
+		BaseURL:    apiUrl,
+		Endpoint:   endpoint,
+		Headers:    headers,
+	}.Request()
+	if err != nil {
+		return fetchedQrCode, err
+	}
+
+	response, err := requests.Execute(httpClient, request)
+	if err != nil {
+		return fetchedQrCode, err
+	}
+	defer response.Body.Close()
+
+	responseBytes, err := io.ReadAll(response.Body)
+	if err != nil {
+		return fetchedQrCode, err
+	}
+
+	err = json.Unmarshal(responseBytes, &fetchedQrCode)
+
+	return fetchedQrCode, err
+}

digitalidentity/service_test.go

@@ -111,7 +111,7 @@ func TestGetShareSession(t *testing.T) {
 
 }
 
-func TestCreateQrCode(t *testing.T) {
+func TestCreateShareQrCode(t *testing.T) {
 	key := test.GetValidKey("../test/test-key.pem")
 	mockSessionID := "SOME_SESSION_ID"
 
@@ -127,3 +127,22 @@ func TestCreateQrCode(t *testing.T) {
 	_, err := CreateShareQrCode(client, mockSessionID, "sdkId", "https://apiurl", key)
 	assert.NilError(t, err)
 }
+
+func TestGetQrCode(t *testing.T) {
+	key := test.GetValidKey("../test/test-key.pem")
+	mockQrId := "SOME_QR_CODE_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(`{}`)),
+			}, nil
+		},
+	}
+
+	_, err := GetShareSessionQrCode(client, mockQrId, mockClientSdkId, mockApiUrl, key)
+	assert.NilError(t, err)
+
+}

digitalidentity/share_retrieve_qr.go

@@ -0,0 +1,10 @@
+package digitalidentity
+
+type ShareSessionFetchedQrCode struct {
+	ID          string              `json:"id"`
+	Expiry      string              `json:"expiry"`
+	Policy      string              `json:"policy"`
+	Extensions  []interface{}       `json:"extensions"`
+	Session     ShareSessionCreated `json:"session"`
+	RedirectURI string              `json:"redirectUri"`
+}

digitalidentity/share_session_created.go

@@ -0,0 +1,8 @@
+package digitalidentity
+
+// ShareSessionCreated Share Session QR Result
+type ShareSessionCreated struct {
+	ID     string `json:"id"`
+	Satus  string `json:"status"`
+	Expiry string `json:"expiry"`
+}