yoti 1.6.4 → 1.10.0

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
@@ -51,7 +56,7 @@ module Yoti
 
       return if valid.any?
 
-      config_list = required_configs.map { |conf| '`' + conf + '`' }.join(', ')
+      config_list = required_configs.map { |conf| "`#{conf}`" }.join(', ')
       message = "At least one of the configuration values has to be set: #{config_list}."
       raise ConfigurationError, message
     end

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/document_details.rb

@@ -1,7 +1,7 @@
 module Yoti
   class DocumentDetails
     #
-    # @deprecated 2.0.0 pattern is no longer used for validation.
+    # @deprecated will be removed in 2.0.0 - pattern is no longer used for validation.
     #
     VALIDATION_PATTERN = '^([A-Za-z_]*) ([A-Za-z]{3}) ([A-Za-z0-9]{1}).*$'
 

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 instance_of?(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,22 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Yoti
+  class Media
+    # @return [String|bin]
+    attr_reader :content
+
+    # @return [String]
+    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/data_type/signed_time_stamp.rb

@@ -5,7 +5,7 @@ module Yoti
 
     def initialize(version, time_stamp)
       @version = version
-      @time_stamp = time_stamp
+      @time_stamp = time_stamp.utc
     end
   end
 end

data/lib/yoti/doc_scan/client.rb

@@ -0,0 +1,191 @@
+# 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'
+          )
+
+          request = create_request
+                    .with_http_method('POST')
+                    .with_endpoint('sessions')
+                    .with_payload(session_specification)
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            Yoti::DocScan::Session::Create::CreateSessionResult.new(JSON.parse(request.execute.body))
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
+        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')
+
+          request = create_request
+                    .with_http_method('GET')
+                    .with_endpoint(session_path(session_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            Yoti::DocScan::Session::Retrieve::GetSessionResult.new(JSON.parse(request.execute.body))
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
+        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')
+
+          request = create_request
+                    .with_http_method('DELETE')
+                    .with_endpoint(session_path(session_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
+        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|nil]
+        #
+        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')
+
+          request = create_request
+                    .with_http_method('GET')
+                    .with_endpoint(media_path(session_id, media_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            response = request.execute
+
+            content_type = response.get_fields('content-type')
+
+            return nil if response.code == 204 || content_type.nil?
+
+            Yoti::Media.new(
+              response.body,
+              content_type[0]
+            )
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
+        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')
+
+          request = create_request
+                    .with_http_method('DELETE')
+                    .with_endpoint(media_path(session_id, media_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
+        end
+
+        #
+        # Gets a list of supported documents.
+        #
+        # @return [Yoti::DocScan::Support::SupportedDocumentsResponse]
+        #
+        def supported_documents
+          request = create_request
+                    .with_http_method('GET')
+                    .with_endpoint('supported-documents')
+                    .build
+
+          begin
+            Yoti::DocScan::Support::SupportedDocumentsResponse.new(JSON.parse(request.execute.body))
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
+        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,35 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    class Constants
+      ID_DOCUMENT_AUTHENTICITY = 'ID_DOCUMENT_AUTHENTICITY'
+      ID_DOCUMENT_COMPARISON = 'ID_DOCUMENT_COMPARISON'
+      ID_DOCUMENT_TEXT_DATA_CHECK = 'ID_DOCUMENT_TEXT_DATA_CHECK'
+      SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK = 'SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK'
+      ID_DOCUMENT_FACE_MATCH = 'ID_DOCUMENT_FACE_MATCH'
+      LIVENESS = 'LIVENESS'
+      ID_DOCUMENT_TEXT_DATA_EXTRACTION = 'ID_DOCUMENT_TEXT_DATA_EXTRACTION'
+      SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION = 'SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION'
+      ID_DOCUMENT = 'ID_DOCUMENT'
+      SUPPLEMENTARY_DOCUMENT = 'SUPPLEMENTARY_DOCUMENT'
+      ORTHOGONAL_RESTRICTIONS = 'ORTHOGONAL_RESTRICTIONS'
+      DOCUMENT_RESTRICTIONS = 'DOCUMENT_RESTRICTIONS'
+      INCLUDE = 'WHITELIST'
+      EXCLUDE = 'BLACKLIST'
+      ALWAYS = 'ALWAYS'
+      FALLBACK = 'FALLBACK'
+      DESIRED = 'DESIRED'
+      IGNORE = 'IGNORE'
+      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'
+      PROOF_OF_ADDRESS = 'PROOF_OF_ADDRESS'
+    end
+  end
+end

data/lib/yoti/doc_scan/errors.rb

@@ -0,0 +1,81 @@
+require 'json'
+
+module Yoti
+  module DocScan
+    #
+    # Raises exceptions related to Doc Scan API requests
+    #
+    class Error < RequestError
+      def initialize(msg = nil, response = nil)
+        super(msg, response)
+
+        @default_message = msg
+      end
+
+      def message
+        @message ||= format_message
+      end
+
+      #
+      # Wraps an existing error
+      #
+      # @param [Error] error
+      #
+      # @return [self]
+      #
+      def self.wrap(error)
+        new(error.message, error.response)
+      end
+
+      private
+
+      #
+      # Formats error message from response.
+      #
+      # @return [String]
+      #
+      def format_message
+        return @default_message if @response.nil? || @response['Content-Type'] != 'application/json'
+
+        json = JSON.parse(@response.body)
+        format_response(json) || @default_message
+      end
+
+      #
+      # Format JSON error response.
+      #
+      # @param [Hash] json
+      #
+      # @return [String, nil]
+      #
+      def format_response(json)
+        return nil if json['code'].nil? || json['message'].nil?
+
+        code_message = "#{json['code']} - #{json['message']}"
+
+        unless json['errors'].nil?
+          property_errors = format_property_errors(json['errors'])
+
+          return "#{code_message}: #{property_errors.compact.join(', ')}" if property_errors.count.positive?
+        end
+
+        code_message
+      end
+
+      #
+      # Format property errors.
+      #
+      # @param [Array<Hash>] errors
+      #
+      # @return [Array<String>]
+      #
+      def format_property_errors(errors)
+        errors
+          .map do |e|
+            "#{e['property']} \"#{e['message']}\"" if e['property'] && e['message']
+          end
+          .compact
+      end
+    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