yoti 1.6.0 → 1.7.0

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

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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class BreakdownResponse
+          # @return [String]
+          attr_reader :sub_check
+
+          # @return [String]
+          attr_reader :result
+
+          # @return [Array<DetailsResponse>]
+          attr_reader :details
+
+          #
+          # @param [Hash] breakdown
+          #
+          def initialize(breakdown)
+            Validation.assert_is_a(String, breakdown['sub_check'], 'sub_check', true)
+            @sub_check = breakdown['sub_check']
+
+            Validation.assert_is_a(String, breakdown['result'], 'result', true)
+            @result = breakdown['result']
+
+            if breakdown['details'].nil?
+              @details = []
+            else
+              Validation.assert_is_a(Array, breakdown['details'], 'details')
+              @details = breakdown['details'].map { |details| DetailsResponse.new(details) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class CheckResponse
+          # @return [String]
+          attr_reader :type
+
+          # @return [String]
+          attr_reader :id
+
+          # @return [String]
+          attr_reader :state
+
+          # @return [Array<String>]
+          attr_reader :resources_used
+
+          # @return [Array<GeneratedMedia>]
+          attr_reader :generated_media
+
+          # @return [<ReportResponse>]
+          attr_reader :report
+
+          # @return [<DateTime>]
+          attr_reader :created
+
+          # @return [<DateTime>]
+          attr_reader :last_updated
+
+          #
+          # @param [Hash] check
+          #
+          def initialize(check)
+            Validation.assert_is_a(String, check['type'], 'type', true)
+            @type = check['type']
+
+            Validation.assert_is_a(String, check['id'], 'id', true)
+            @id = check['id']
+
+            Validation.assert_is_a(String, check['state'], 'state', true)
+            @state = check['state']
+
+            Validation.assert_is_a(Array, check['resources_used'], 'resources_used', true)
+            @resources_used = check['resources_used']
+
+            if check['generated_media'].nil?
+              @generated_media = []
+            else
+              Validation.assert_is_a(Array, check['generated_media'], 'generated_media')
+              @generated_media = check['generated_media'].map { |media| GeneratedMedia.new(media) }
+            end
+
+            @report = ReportResponse.new(check['report']) unless check['report'].nil?
+            @created = DateTime.parse(check['created']) unless check['created'].nil?
+            @last_updated = DateTime.parse(check['last_updated']) unless check['last_updated'].nil?
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class FaceMatchCheckResponse < CheckResponse
+        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_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,113 @@
+# 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
+
+          #
+          # @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?
+          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
+
+          #
+          # @return [Array<TextDataCheckResponse>]
+          #
+          def text_data_checks
+            @checks.select { |check| check.is_a?(TextDataCheckResponse) }
+          end
+
+          #
+          # @return [Array<LivenessCheckResponse>]
+          #
+          def liveness_checks
+            @checks.select { |check| check.is_a?(LivenessCheckResponse) }
+          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_FACE_MATCH
+                FaceMatchCheckResponse.new(check)
+              when Constants::ID_DOCUMENT_TEXT_DATA_CHECK
+                TextDataCheckResponse.new(check)
+              when Constants::LIVENESS
+                LivenessCheckResponse.new(check)
+              else
+                CheckResponse.new(check)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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
+
+          #
+          # @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?
+          end
+
+          #
+          # @return [Array<TextExtractionTaskResponse>]
+          #
+          def text_extraction_tasks
+            @tasks.select { |task| task.is_a?(TextExtractionTaskResponse) }
+          end
+        end
+      end
+    end
+  end
+end