yoti 1.6.4 → 1.10.0

data/lib/yoti/doc_scan/session/retrieve/file_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class FileResponse
+          # @return [MediaResponse]
+          attr_reader :media
+
+          #
+          # @param [Hash] file
+          #
+          def initialize(file)
+            @media = MediaResponse.new(file['media']) unless file['media'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/frame_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class FrameResponse
+          # @return [MediaResponse]
+          attr_reader :media
+
+          #
+          # @param [Hash] frame
+          #
+          def initialize(frame)
+            @media = MediaResponse.new(frame['media']) unless frame['media'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/generated_check_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class GeneratedCheckResponse
+          # @return [String]
+          attr_reader :id
+
+          # @return [String]
+          attr_reader :type
+
+          #
+          # @param [Hash] check
+          #
+          def initialize(check)
+            Validation.assert_is_a(String, check['id'], 'id', true)
+            @id = check['id']
+
+            Validation.assert_is_a(String, check['type'], 'type', true)
+            @type = check['type']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/generated_media.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class GeneratedMedia
+          # @return [String]
+          attr_reader :id
+
+          # @return [String]
+          attr_reader :type
+
+          #
+          # @param [Hash] media
+          #
+          def initialize(media)
+            Validation.assert_is_a(String, media['id'], 'id', true)
+            @id = media['id']
+
+            Validation.assert_is_a(String, media['type'], 'type', true)
+            @type = media['type']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/generated_supplementary_document_text_data_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class GeneratedSupplementaryDocumentTextDataCheckResponse < GeneratedCheckResponse
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/generated_text_data_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class GeneratedTextDataCheckResponse < GeneratedCheckResponse
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/get_session_result.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class GetSessionResult
+          # @return [Integer]
+          attr_reader :client_session_token_ttl
+
+          # @return [String]
+          attr_reader :client_session_token
+
+          # @return [String]
+          attr_reader :session_id
+
+          # @return [String]
+          attr_reader :user_tracking_id
+
+          # @return [String]
+          attr_reader :state
+
+          # @return [Array<CheckResponse>]
+          attr_reader :checks
+
+          # @return [ResourceContainer]
+          attr_reader :resources
+
+          # @return [DateTime]
+          attr_reader :biometric_consent_timestamp
+
+          #
+          # @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['session_id'], 'session_id', true)
+            @session_id = response['session_id']
+
+            Validation.assert_is_a(String, response['user_tracking_id'], 'user_tracking_id', true)
+            @user_tracking_id = response['user_tracking_id']
+
+            Validation.assert_is_a(String, response['state'], 'state', true)
+            @state = response['state']
+
+            Validation.assert_is_a(String, response['client_session_token'], 'client_session_token', true)
+            @client_session_token = response['client_session_token']
+
+            if response['checks'].nil?
+              @checks = []
+            else
+              Validation.assert_is_a(Array, response['checks'], 'checks')
+              @checks = map_checks(response['checks'])
+            end
+
+            @resources = ResourceContainer.new(response['resources']) unless response['resources'].nil?
+
+            @biometric_consent_timestamp = DateTime.parse(response['biometric_consent']) unless response['biometric_consent'].nil?
+          end
+
+          #
+          # @return [Array<AuthenticityCheckResponse>]
+          #
+          def authenticity_checks
+            @checks.select { |check| check.is_a?(AuthenticityCheckResponse) }
+          end
+
+          #
+          # @return [Array<FaceMatchCheckResponse>]
+          #
+          def face_match_checks
+            @checks.select { |check| check.is_a?(FaceMatchCheckResponse) }
+          end
+
+          #
+          # @deprecated replaced by id_document_text_data_checks
+          #
+          # @return [Array<TextDataCheckResponse>]
+          #
+          def text_data_checks
+            id_document_text_data_checks
+          end
+
+          #
+          # @return [Array<TextDataCheckResponse>]
+          #
+          def id_document_text_data_checks
+            @checks.select { |check| check.is_a?(TextDataCheckResponse) }
+          end
+
+          #
+          # @return [Array<SupplementaryDocumentTextDataCheckResponse>]
+          #
+          def supplementary_document_text_data_checks
+            @checks.select { |check| check.is_a?(SupplementaryDocumentTextDataCheckResponse) }
+          end
+
+          #
+          # @return [Array<LivenessCheckResponse>]
+          #
+          def liveness_checks
+            @checks.select { |check| check.is_a?(LivenessCheckResponse) }
+          end
+
+          #
+          # @return [Array<IdDocumentComparisonCheckResponse>]
+          #
+          def id_document_comparison_checks
+            @checks.select { |check| check.is_a?(IdDocumentComparisonCheckResponse) }
+          end
+
+          private
+
+          #
+          # @param [Array<Hash>] checks
+          #
+          # @return [Array<CheckResponse>]
+          #
+          def map_checks(checks)
+            checks.map do |check|
+              case check['type']
+              when Constants::ID_DOCUMENT_AUTHENTICITY
+                AuthenticityCheckResponse.new(check)
+              when Constants::ID_DOCUMENT_COMPARISON
+                IdDocumentComparisonCheckResponse.new(check)
+              when Constants::ID_DOCUMENT_FACE_MATCH
+                FaceMatchCheckResponse.new(check)
+              when Constants::ID_DOCUMENT_TEXT_DATA_CHECK
+                TextDataCheckResponse.new(check)
+              when Constants::LIVENESS
+                LivenessCheckResponse.new(check)
+              when Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK
+                SupplementaryDocumentTextDataCheckResponse.new(check)
+              else
+                CheckResponse.new(check)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/id_document_comparison_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class IdDocumentComparisonCheckResponse < CheckResponse
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/id_document_resource_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class IdDocumentResourceResponse < ResourceResponse
+          # @return [String]
+          attr_reader :document_type
+
+          # @return [String]
+          attr_reader :issuing_country
+
+          # @return [Array<PageResponse>]
+          attr_reader :pages
+
+          # @return [DocumentFieldsResponse]
+          attr_reader :document_fields
+
+          # @return [DocumentIdPhotoResponse]
+          attr_reader :document_id_photo
+
+          #
+          # @param [Hash] resource
+          #
+          def initialize(resource)
+            super(resource)
+
+            Validation.assert_is_a(String, resource['document_type'], 'document_type', true)
+            @document_type = resource['document_type']
+
+            Validation.assert_is_a(String, resource['issuing_country'], 'issuing_country', true)
+            @issuing_country = resource['issuing_country']
+
+            if resource['pages'].nil?
+              @pages = []
+            else
+              Validation.assert_is_a(Array, resource['pages'], 'pages')
+              @pages = resource['pages'].map { |page| PageResponse.new(page) }
+            end
+
+            @document_fields = DocumentFieldsResponse.new(resource['document_fields']) unless resource['document_fields'].nil?
+
+            @document_id_photo = DocumentIdPhotoResponse.new(resource['document_id_photo']) unless resource['document_id_photo'].nil?
+          end
+
+          #
+          # @return [Array<TextExtractionTaskResponse>]
+          #
+          def text_extraction_tasks
+            @tasks.select { |task| task.is_a?(TextExtractionTaskResponse) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/liveness_check_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class LivenessCheckResponse < CheckResponse
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/liveness_resource_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class LivenessResourceResponse < ResourceResponse
+          # @return [String]
+          attr_reader :liveness_type
+
+          #
+          # @param [Hash] resource
+          #
+          def initialize(resource)
+            super(resource)
+
+            Validation.assert_is_a(String, resource['liveness_type'], 'liveness_type', true)
+            @liveness_type = resource['liveness_type']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/media_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class MediaResponse
+          # @return [String]
+          attr_reader :id
+
+          # @return [String]
+          attr_reader :type
+
+          # @return [DateTime]
+          attr_reader :created
+
+          # @return [DateTime]
+          attr_reader :last_updated
+
+          #
+          # @param [Hash] media
+          #
+          def initialize(media)
+            Validation.assert_is_a(String, media['id'], 'id', true)
+            @id = media['id']
+
+            Validation.assert_is_a(String, media['type'], 'type', true)
+            @type = media['type']
+
+            @created = DateTime.parse(media['created']) unless media['created'].nil?
+
+            @last_updated = DateTime.parse(media['last_updated']) unless media['last_updated'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/page_response.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class PageResponse
+          # @return [String]
+          attr_reader :capture_method
+
+          # @return [MediaResponse]
+          attr_reader :media
+
+          # @return [Array<FrameResponse>]
+          attr_reader :frames
+
+          #
+          # @param [Hash] page
+          #
+          def initialize(page)
+            Validation.assert_is_a(String, page['capture_method'], 'capture_method', true)
+            @capture_method = page['capture_method']
+
+            @media = MediaResponse.new(page['media']) unless page['media'].nil?
+
+            if page['frames'].nil?
+              @frames = []
+            else
+              Validation.assert_is_a(Array, page['frames'], 'frames')
+              @frames = page['frames'].map { |frame| FrameResponse.new(frame) }
+            end
+          end
+        end
+      end
+    end
+  end
+end