yoti 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d2cbb57b376a252d798c35820fcee63a46eb99809422441e592ed25bc0f9da
-  data.tar.gz: 1e31e86853d8e419cad2bec50a260d9e26a9c8043299ff6dc10620635c9169c9
+  metadata.gz: 02fe8b8e97eb660a8f100add12f7a07591fd78c39a0b476ce386b01af9d8c18e
+  data.tar.gz: b37386c172ecf56164d5e8b18129c41698444459e4611b35e8aeda4da9176287
 SHA512:
-  metadata.gz: 88a932e08b8b73b81ef7153935e984df1d0816c9cfdf0fe912342a57ca8b12a91892aec6b226520cd48f94b660264dca2cadd593ef85008dc2564c97c811a409
-  data.tar.gz: 1b0bdb68176391c56302aff5bda6040aece1d891d6b4491ea605af30029c079de046ea6e03df81c49c99100a1500a0730adfbc6e705c69f18c2a6c96172f0c09
+  metadata.gz: 36f47a7c8728ccdde726c67d7ecde1282051f128e63ffd685c6981634d660bba98ff7de9c0aed53dee950112a392978c5ffce44d3a130d16d7487eb5fd22431c
+  data.tar.gz: bbbee64ecc44ce41a204c8109fb673339972886d5818db20d3952009b76fedf12222e705b7eb090c4da0fb0f9c8375fc4402e0ed9c595a8a72974e3f37ea5397

data/README.md

@@ -1,6 +1,10 @@
 # Yoti Ruby SDK
 
 [![Build Status](https://travis-ci.com/getyoti/yoti-ruby-sdk.svg?branch=master)](https://travis-ci.com/getyoti/yoti-ruby-sdk)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=coverage)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=bugs)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=code_smells)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Aruby&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=getyoti%3Aruby)
 
 Welcome to the Yoti Ruby SDK. This repository contains the tools you need to quickly integrate your Ruby back-end with Yoti so that your users can share their identity details with your application in a secure and trusted way.
 

data/Rakefile

@@ -14,14 +14,6 @@ RSpec::Core::RakeTask.new(:test_generators) do |t|
   t.pattern = ['spec/generators']
 end
 
-################################
-# Coveralls                    #
-################################
-
-require 'coveralls/rake/task'
-Coveralls::RakeTask.new
-task test_with_coveralls: [:spec, 'coveralls:push']
-
 ################################
 # Rubocop                      #
 ################################

data/lib/yoti.rb

@@ -18,6 +18,7 @@ require_relative 'yoti/data_type/application_profile'
 require_relative 'yoti/data_type/profile'
 require_relative 'yoti/data_type/attribute'
 require_relative 'yoti/data_type/signed_time_stamp'
+require_relative 'yoti/data_type/media'
 require_relative 'yoti/data_type/image'
 require_relative 'yoti/data_type/image_jpeg'
 require_relative 'yoti/data_type/image_png'
@@ -26,7 +27,8 @@ require_relative 'yoti/data_type/document_details'
 
 require_relative 'yoti/util/age_processor'
 require_relative 'yoti/util/anchor_processor'
-require_relative 'yoti/util/log.rb'
+require_relative 'yoti/util/log'
+require_relative 'yoti/util/validation'
 
 require_relative 'yoti/activity_details'
 require_relative 'yoti/client'
@@ -47,6 +49,53 @@ require_relative 'yoti/dynamic_share_service/extension/thirdparty_attribute_exte
 require_relative 'yoti/share/extra_data'
 require_relative 'yoti/share/attribute_issuance_details'
 
+require_relative 'yoti/doc_scan/client'
+require_relative 'yoti/doc_scan/constants'
+
+require_relative 'yoti/doc_scan/session/create/create_session_result'
+require_relative 'yoti/doc_scan/session/create/requested_check'
+require_relative 'yoti/doc_scan/session/create/requested_document_authenticity_check'
+require_relative 'yoti/doc_scan/session/create/requested_face_match_check'
+require_relative 'yoti/doc_scan/session/create/requested_liveness_check'
+require_relative 'yoti/doc_scan/session/create/requested_task'
+require_relative 'yoti/doc_scan/session/create/requested_text_extraction_task'
+require_relative 'yoti/doc_scan/session/create/document_filter'
+require_relative 'yoti/doc_scan/session/create/document_restrictions_filter'
+require_relative 'yoti/doc_scan/session/create/orthogonal_restrictions_filter'
+require_relative 'yoti/doc_scan/session/create/required_document'
+require_relative 'yoti/doc_scan/session/create/required_id_document'
+require_relative 'yoti/doc_scan/session/create/sdk_config'
+require_relative 'yoti/doc_scan/session/create/notification_config'
+require_relative 'yoti/doc_scan/session/create/session_specification'
+
+require_relative 'yoti/doc_scan/session/retrieve/check_response'
+require_relative 'yoti/doc_scan/session/retrieve/resource_response'
+require_relative 'yoti/doc_scan/session/retrieve/authenticity_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/breakdown_response'
+require_relative 'yoti/doc_scan/session/retrieve/details_response'
+require_relative 'yoti/doc_scan/session/retrieve/document_fields_response'
+require_relative 'yoti/doc_scan/session/retrieve/face_map_response'
+require_relative 'yoti/doc_scan/session/retrieve/face_match_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/frame_response'
+require_relative 'yoti/doc_scan/session/retrieve/generated_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/generated_media'
+require_relative 'yoti/doc_scan/session/retrieve/generated_text_data_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/get_session_result'
+require_relative 'yoti/doc_scan/session/retrieve/id_document_resource_response'
+require_relative 'yoti/doc_scan/session/retrieve/liveness_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/liveness_resource_response'
+require_relative 'yoti/doc_scan/session/retrieve/media_response'
+require_relative 'yoti/doc_scan/session/retrieve/page_response'
+require_relative 'yoti/doc_scan/session/retrieve/recommendation_response'
+require_relative 'yoti/doc_scan/session/retrieve/report_response'
+require_relative 'yoti/doc_scan/session/retrieve/resource_container'
+require_relative 'yoti/doc_scan/session/retrieve/task_response'
+require_relative 'yoti/doc_scan/session/retrieve/text_data_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/text_extraction_task_response'
+require_relative 'yoti/doc_scan/session/retrieve/zoom_liveness_resource_response'
+
+require_relative 'yoti/doc_scan/support/supported_documents'
+
 # The main module namespace of the Yoti gem
 module Yoti
   class << self

data/lib/yoti/client.rb

@@ -1,15 +1,17 @@
 module Yoti
   #
-  # Handles all the publicly accesible Yoti methods for
-  # geting data using an encrypted connect token
+  # Handles all the publicly accessible Yoti methods for
+  # getting data using an encrypted connect token
   #
   module Client
     #
     # Performs all the steps required to get the decrypted profile from an API request
     #
-    # @param encrypted_connect_token [String] token provided as a base 64 string
+    # @param [String] encrypted_connect_token
+    #   Token provided as a base 64 string
     #
-    # @return [Object] an ActivityDetails instance encapsulating the user profile
+    # @return [ActivityDetails]
+    #   An ActivityDetails instance encapsulating the user profile
     #
     def self.get_activity_details(encrypted_connect_token)
       receipt = Yoti::ProfileRequest.new(encrypted_connect_token).receipt
@@ -22,6 +24,13 @@ module Yoti
       ActivityDetails.new(receipt, user_profile, application_profile, extra_data)
     end
 
+    #
+    # Perform AML check
+    #
+    # @param [AmlProfile] aml_profile
+    #
+    # @return [<Hash>]
+    #
     def self.aml_check(aml_profile)
       Yoti::AmlCheckRequest.new(aml_profile).response
     end

data/lib/yoti/configuration.rb

@@ -3,7 +3,7 @@ module Yoti
     attr_accessor :client_sdk_id, :key_file_path, :key, :sdk_identifier,
                   :api_url, :api_port, :api_version
 
-    attr_writer :api_endpoint
+    attr_writer :api_endpoint, :doc_scan_api_endpoint
 
     # Set config variables by using a configuration block
     def initialize
@@ -18,7 +18,12 @@ module Yoti
 
     # @return [String] the API endpoint for the selected API version
     def api_endpoint
-      @api_endpoint ||= "#{@api_url}/api/#{@api_version}"
+      @api_endpoint ||= ENV['YOTI_API_URL'] || "#{@api_url}/api/#{@api_version}"
+    end
+
+    # @return [String] the Doc Scan API endpoint
+    def doc_scan_api_endpoint
+      @doc_scan_api_endpoint ||= ENV['YOTI_DOC_SCAN_API_URL'] || "#{@api_url}/idverify/#{@api_version}"
     end
 
     # Validates the configuration values set in instance variables

data/lib/yoti/data_type/age_verification.rb

@@ -37,7 +37,7 @@ module Yoti
     attr_reader :age
 
     #
-    # @param [Yoti::Attribute]
+    # @param [Yoti::Attribute] attribute
     #
     def initialize(attribute)
       raise(ArgumentError, "'#{attribute.name}' is not a valid age verification") unless /^[^:]+:(?!.*:)[0-9]+$/.match?(attribute.name)

data/lib/yoti/data_type/base_profile.rb

@@ -37,7 +37,7 @@ module Yoti
     #
     # @param [String] name
     #
-    # @returns [Array]
+    # @return [Array]
     #
     def find_attributes_starting_with(name)
       @attributes.select { |key| key.to_s.start_with?(name) }

data/lib/yoti/data_type/image.rb

@@ -1,19 +1,11 @@
-require 'base64'
+# frozen_string_literal: true
 
 module Yoti
-  class Image
-    attr_reader :content
-    attr_reader :mime_type
-
+  class Image < Media
     def initialize(content, mime_type)
-      raise(TypeError, 'Image is an abstract class, so cannot be instantiated') if self.class == Yoti::Image
-
-      @content = content
-      @mime_type = mime_type
-    end
+      raise(TypeError, "#{self.class} is an abstract class, so cannot be instantiated") if self.class == Image
 
-    def base64_content
-      "data:#{mime_type};base64,#{Base64.strict_encode64(content)}"
+      super(content, mime_type)
     end
   end
 end

data/lib/yoti/data_type/image_jpeg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Yoti
   class ImageJpeg < Image
     def initialize(content)

data/lib/yoti/data_type/image_png.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Yoti
   class ImagePng < Image
     def initialize(content)

data/lib/yoti/data_type/media.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Yoti
+  class Media
+    attr_reader :content
+    attr_reader :mime_type
+
+    def initialize(content, mime_type)
+      @content = content
+      @mime_type = mime_type
+    end
+
+    def base64_content
+      "data:#{mime_type};base64,#{Base64.strict_encode64(content)}"
+    end
+  end
+end

data/lib/yoti/doc_scan/client.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    class Client
+      class << self
+        #
+        # Creates a Doc Scan session using the supplied session specification
+        #
+        # @param [Yoti::DocScan::Session::Create::SessionSpecification] session_specification
+        #
+        # @return [Yoti::DocScan::Session::Create::CreateSessionResult]
+        #
+        def create_session(session_specification)
+          Validation.assert_is_a(
+            Yoti::DocScan::Session::Create::SessionSpecification,
+            session_specification,
+            'session_specification'
+          )
+
+          response = create_request
+                     .with_http_method('POST')
+                     .with_endpoint('sessions')
+                     .with_payload(session_specification)
+                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                     .build
+                     .execute
+
+          Yoti::DocScan::Session::Create::CreateSessionResult.new(JSON.parse(response.body))
+        end
+
+        #
+        # Retrieves the state of a previously created Yoti Doc Scan session
+        #
+        # @param [String] session_id
+        #
+        # @return [Yoti::DocScan::Session::Retrieve::GetSessionResult]
+        #
+        def get_session(session_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+
+          response = create_request
+                     .with_http_method('GET')
+                     .with_endpoint(session_path(session_id))
+                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                     .build
+                     .execute
+
+          Yoti::DocScan::Session::Retrieve::GetSessionResult.new(JSON.parse(response.body))
+        end
+
+        #
+        # Deletes a previously created Yoti Doc Scan session and all
+        # of its related resources
+        #
+        # @param [String] session_id
+        #
+        def delete_session(session_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+
+          create_request
+            .with_http_method('DELETE')
+            .with_endpoint(session_path(session_id))
+            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+            .build
+            .execute
+        end
+
+        #
+        # Retrieves media related to a Yoti Doc Scan session based
+        # on the supplied media ID
+        #
+        # @param [String] session_id
+        # @param [String] media_id
+        #
+        # @return [Yoti::Media]
+        #
+        def get_media_content(session_id, media_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+          Validation.assert_is_a(String, media_id, 'media_id')
+
+          response = create_request
+                     .with_http_method('GET')
+                     .with_endpoint(media_path(session_id, media_id))
+                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                     .build
+                     .execute
+
+          Yoti::Media.new(
+            response.body,
+            response.get_fields('content-type')[0]
+          )
+        end
+
+        #
+        # Deletes media related to a Yoti Doc Scan session based
+        # on the supplied media ID
+        #
+        # @param [String] session_id
+        # @param [String] media_id
+        #
+        def delete_media_content(session_id, media_id)
+          Validation.assert_is_a(String, session_id, 'session_id')
+          Validation.assert_is_a(String, media_id, 'media_id')
+
+          create_request
+            .with_http_method('DELETE')
+            .with_endpoint(media_path(session_id, media_id))
+            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+            .build
+            .execute
+        end
+
+        #
+        # Gets a list of supported documents.
+        #
+        # @return [Yoti::DocScan::Support::SupportedDocumentsResponse]
+        #
+        def supported_documents
+          response = create_request
+                     .with_http_method('GET')
+                     .with_endpoint('supported-documents')
+                     .build
+                     .execute
+
+          Yoti::DocScan::Support::SupportedDocumentsResponse.new(JSON.parse(response.body))
+        end
+
+        private
+
+        #
+        # @param [String] session_id
+        #
+        # @return [String]
+        #
+        def session_path(session_id)
+          "sessions/#{session_id}"
+        end
+
+        #
+        # @param [String] session_id
+        # @param [String] media_id
+        #
+        # @return [String]
+        #
+        def media_path(session_id, media_id)
+          "#{session_path(session_id)}/media/#{media_id}/content"
+        end
+
+        #
+        # Create a base Doc Scan request
+        #
+        # @return [Yoti::Request]
+        #
+        def create_request
+          Yoti::Request
+            .builder
+            .with_base_url(Yoti.configuration.doc_scan_api_endpoint)
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/constants.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    class Constants
+      ID_DOCUMENT_AUTHENTICITY = 'ID_DOCUMENT_AUTHENTICITY'
+      ID_DOCUMENT_TEXT_DATA_CHECK = 'ID_DOCUMENT_TEXT_DATA_CHECK'
+      ID_DOCUMENT_FACE_MATCH = 'ID_DOCUMENT_FACE_MATCH'
+      LIVENESS = 'LIVENESS'
+      ID_DOCUMENT_TEXT_DATA_EXTRACTION = 'ID_DOCUMENT_TEXT_DATA_EXTRACTION'
+      ID_DOCUMENT = 'ID_DOCUMENT'
+      ORTHOGONAL_RESTRICTIONS = 'ORTHOGONAL_RESTRICTIONS'
+      DOCUMENT_RESTRICTIONS = 'DOCUMENT_RESTRICTIONS'
+      INCLUDE = 'WHITELIST'
+      EXCLUDE = 'BLACKLIST'
+      ALWAYS = 'ALWAYS'
+      FALLBACK = 'FALLBACK'
+      NEVER = 'NEVER'
+      ZOOM = 'ZOOM'
+      CAMERA = 'CAMERA'
+      CAMERA_AND_UPLOAD = 'CAMERA_AND_UPLOAD'
+      RESOURCE_UPDATE = 'RESOURCE_UPDATE'
+      TASK_COMPLETION = 'TASK_COMPLETION'
+      CHECK_COMPLETION = 'CHECK_COMPLETION'
+      SESSION_COMPLETION = 'SESSION_COMPLETION'
+    end
+  end
+end

data/lib/yoti/doc_scan/session/create/create_session_result.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        #
+        # The response to a successful CreateSession call
+        #
+        class CreateSessionResult
+          #
+          # Returns the time-to-live (TTL) for the client session
+          # token for the created session
+          #
+          # @return [Integer]
+          #
+          attr_reader :client_session_token_ttl
+
+          #
+          # Returns the client session token for the created session
+          #
+          # @return [String]
+          #
+          attr_reader :client_session_token
+
+          #
+          # Session ID of the created session
+          #
+          # @return [String]
+          #
+          attr_reader :session_id
+
+          #
+          # @param [Hash] response
+          #
+          def initialize(response)
+            Validation.assert_is_a(Integer, response['client_session_token_ttl'], 'client_session_token_ttl', true)
+            @client_session_token_ttl = response['client_session_token_ttl']
+
+            Validation.assert_is_a(String, response['client_session_token'], 'client_session_token', true)
+            @client_session_token = response['client_session_token']
+
+            Validation.assert_is_a(String, response['session_id'], 'session_id', true)
+            @session_id = response['session_id']
+          end
+        end
+      end
+    end
+  end
+end