yoti 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62813310617665f67200974ba737f52d7c9bd2c1b139657b5ec672253ab3d133
-  data.tar.gz: 474d9dff07562499e19ec35d261dadbc056dbe7818bf35620ba7247ea7169569
+  metadata.gz: 76c473c29aaa7900698cd353fd4efbadf1d58e2e71e02e5ab13671a0da360334
+  data.tar.gz: 542da906f9709554119c66fa81d0b2629ab0c783f9412c70c4fa754330cc2199
 SHA512:
-  metadata.gz: 5c9c3ddc325973e5da3598c289428f01ccb7964ef7faed15b56faa7d9067b5f34f20a2b3336e1b357fb388898810595ccdc1bc2b2665213c44513b9ef493cf90
-  data.tar.gz: eb86020139c4e892f289f70a5eb9dfa15b8f2daee955d67ff16a3d93e6eab57e2847eac54f57545b9430b6c6373185fdf485c6fe726831d63b24c5e982b4931c
+  metadata.gz: c3fa9ca3fbe4953ca94543bac7bf5edb663b751065bdb8395f963274302c6290be51c45baa2c90a5094b9b7efb15f90c2e5b8af17531ecf25dd6b64691b3079d
+  data.tar.gz: dd28ffbcdfa70f9d9b4ccc95163582c41a2113189376912e68f3bd622b95931465f9ef68788b7ead2f4841240144811207bd6f1ca0df64ff011cb78c2d9fe9c9

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gem 'guard'
 gem 'guard-rspec'
-gem 'rubocop'
+gem 'rubocop', '~> 1.1', require: false
 gem 'rubocop-performance'
 
 gemspec

data/lib/yoti.rb

@@ -61,11 +61,15 @@ 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/requested_supplementary_doc_text_extraction_task'
+require_relative 'yoti/doc_scan/session/create/objective/objective'
+require_relative 'yoti/doc_scan/session/create/objective/proof_of_address_objective'
 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/required_supplementary_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'
@@ -80,12 +84,15 @@ require_relative 'yoti/doc_scan/session/retrieve/document_fields_response'
 require_relative 'yoti/doc_scan/session/retrieve/document_id_photo_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/file_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/generated_supplementary_document_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/supplementary_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'
@@ -97,6 +104,8 @@ 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/session/retrieve/supplementary_document_text_data_check_response'
+require_relative 'yoti/doc_scan/session/retrieve/supplementary_document_text_extraction_task_response'
 
 require_relative 'yoti/doc_scan/support/supported_documents'
 

data/lib/yoti/activity_details.rb

@@ -61,7 +61,7 @@ module Yoti
     #
     # The age under/over attribute
     #
-    # @deprecated 2.0.0 - replaced by:
+    # @deprecated will be removed in 2.0.0 - replaced by:
     # - Yoti::Profile#age_verifications
     # - Yoti::Profile#find_age_over_verification
     # - Yoti::Profile#find_age_under_verification
@@ -108,9 +108,7 @@ module Yoti
       @extended_user_profile = process_decrypted_profile(decrypted_profile)
       @extended_application_profile = process_decrypted_profile(decrypted_application_profile)
       @extra_data = extra_data
-      @user_profile = @extended_user_profile.map do |name, attribute|
-        [name, attribute.value]
-      end.to_h
+      @user_profile = @extended_user_profile.transform_values(&:value)
     end
 
     #
@@ -195,7 +193,7 @@ module Yoti
     #
     # Processes age verification
     #
-    # @deprecated 2.0.0
+    # @deprecated will be removed in 2.0.0
     #
     # @param [Yoti::Protobuf::Attrpubapi::Attribute] attribute
     #

data/lib/yoti/configuration.rb

@@ -56,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/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

@@ -3,7 +3,7 @@
 module Yoti
   class Image < Media
     def initialize(content, mime_type)
-      raise(TypeError, "#{self.class} is an abstract class, so cannot be instantiated") if self.class == Image
+      raise(TypeError, "#{self.class} is an abstract class, so cannot be instantiated") if instance_of?(Image)
 
       super(content, mime_type)
     end

data/lib/yoti/data_type/media.rb

@@ -4,7 +4,10 @@ require 'base64'
 
 module Yoti
   class Media
+    # @return [String|bin]
     attr_reader :content
+
+    # @return [String]
     attr_reader :mime_type
 
     def initialize(content, mime_type)

data/lib/yoti/doc_scan/client.rb

@@ -84,7 +84,7 @@ module Yoti
         # @param [String] session_id
         # @param [String] media_id
         #
-        # @return [Yoti::Media]
+        # @return [Yoti::Media|nil]
         #
         def get_media_content(session_id, media_id)
           Validation.assert_is_a(String, session_id, 'session_id')
@@ -99,9 +99,13 @@ module Yoti
           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,
-              response.get_fields('content-type')[0]
+              content_type[0]
             )
           rescue Yoti::RequestError => e
             raise Yoti::DocScan::Error.wrap(e)

data/lib/yoti/doc_scan/constants.rb

@@ -6,10 +6,13 @@ module Yoti
       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'
@@ -26,6 +29,7 @@ module Yoti
       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/session/create/document_filter.rb

@@ -9,7 +9,7 @@ module Yoti
           # @param [String] type
           #
           def initialize(type)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == DocumentFilter
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DocumentFilter)
 
             Validation.assert_is_a(String, type, 'type')
             @type = type

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class Objective
+          #
+          # @param [String] type
+          #
+          def initialize(type)
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(Objective)
+
+            Validation.assert_is_a(String, type, 'type')
+            @type = type
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              type: @type
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/create/objective/proof_of_address_objective.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class ProofOfAddressObjective < Objective
+          def initialize
+            super(Constants::PROOF_OF_ADDRESS)
+          end
+
+          #
+          # @return [ProofOfAddressObjectiveBuilder]
+          #
+          def self.builder
+            ProofOfAddressObjectiveBuilder.new
+          end
+        end
+
+        class ProofOfAddressObjectiveBuilder
+          #
+          # @return [ProofOfAddressObjective]
+          #
+          def build
+            ProofOfAddressObjective.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Yoti
           # @param [#as_json] config The configuration to apply to the Check
           #
           def initialize(type, config)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == RequestedCheck
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(RequestedCheck)
 
             Validation.assert_is_a(String, type, 'type')
             @type = type

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class RequestedSupplementaryDocTextExtractionTask < RequestedTask
+          #
+          # @param [RequestedSupplementaryDocTextExtractionTaskConfig] config
+          #
+          def initialize(config)
+            Validation.assert_is_a(
+              RequestedSupplementaryDocTextExtractionTaskConfig,
+              config,
+              'config'
+            )
+
+            super(Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION, config)
+          end
+
+          #
+          # @return [RequestedSupplementaryDocTextExtractionTaskBuilder]
+          #
+          def self.builder
+            RequestedSupplementaryDocTextExtractionTaskBuilder.new
+          end
+        end
+
+        #
+        # The configuration applied when creating each SupplementaryDocTextExtractionTask
+        #
+        class RequestedSupplementaryDocTextExtractionTaskConfig
+          #
+          # @param [String] manual_check
+          #   Describes the manual fallback behaviour applied to each Task
+          #
+          def initialize(manual_check)
+            Validation.assert_is_a(String, manual_check, 'manual_check')
+            @manual_check = manual_check
+          end
+
+          def as_json(*_args)
+            {
+              manual_check: @manual_check
+            }.compact
+          end
+        end
+
+        #
+        # Builder to assist creation of {RequestedSupplementaryDocTextExtractionTask}
+        #
+        class RequestedSupplementaryDocTextExtractionTaskBuilder
+          #
+          # Requires that the Task is always followed by a manual TextDataCheck
+          #
+          # @return [self]
+          #
+          def with_manual_check_always
+            @manual_check = Constants::ALWAYS
+            self
+          end
+
+          #
+          # Requires that only failed Tasks are followed by a manual TextDataCheck
+          #
+          # @return [self]
+          #
+          def with_manual_check_fallback
+            @manual_check = Constants::FALLBACK
+            self
+          end
+
+          #
+          # The SupplementaryDocTextExtractionTask will never fallback to a manual TextDataCheck
+          #
+          # @return [self]
+          #
+          def with_manual_check_never
+            @manual_check = Constants::NEVER
+            self
+          end
+
+          #
+          # @return [RequestedSupplementaryDocTextExtractionTask]
+          #
+          def build
+            config = RequestedSupplementaryDocTextExtractionTaskConfig.new(@manual_check)
+            RequestedSupplementaryDocTextExtractionTask.new(config)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Yoti
           # @param [#as_json] config Configuration to apply to the Task
           #
           def initialize(type, config)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == RequestedTask
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(RequestedTask)
 
             Validation.assert_is_a(String, type, 'type')
             @type = type

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

@@ -9,7 +9,7 @@ module Yoti
           # @param [String] type
           #
           def initialize(type)
-            raise(TypeError, "#{self.class} cannot be instantiated") if self.class == RequiredDocument
+            raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(RequiredDocument)
 
             Validation.assert_is_a(String, type, 'type')
             @type = type

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Create
+        class RequiredSupplementaryDocument < RequiredDocument
+          #
+          # @param [Objective] objective
+          # @param [Array<String>] document_types
+          # @param [Array<String>] country_codes
+          #
+          def initialize(objective, document_types, country_codes)
+            super(Constants::SUPPLEMENTARY_DOCUMENT)
+
+            Validation.assert_is_a(Objective, objective, 'objective')
+            @objective = objective
+
+            Validation.assert_is_a(Array, document_types, 'document_types', true)
+            @document_types = document_types
+
+            Validation.assert_is_a(Array, country_codes, 'country_codes', true)
+            @country_codes = country_codes
+          end
+
+          def as_json(*_args)
+            json = super
+            json[:objective] = @objective.as_json
+            json[:document_types] = @document_types unless @document_types.nil?
+            json[:country_codes] = @country_codes unless @country_codes.nil?
+            json
+          end
+
+          #
+          # @return [RequiredSupplementaryDocumentBuilder]
+          #
+          def self.builder
+            RequiredSupplementaryDocumentBuilder.new
+          end
+        end
+
+        class RequiredSupplementaryDocumentBuilder
+          #
+          # @param [Objective] objective
+          #
+          # @return [self]
+          #
+          def with_objective(objective)
+            Validation.assert_is_a(Objective, objective, 'objective')
+            @objective = objective
+            self
+          end
+
+          #
+          # @param [Array<String>] country_codes
+          #
+          # @return [self]
+          #
+          def with_country_codes(country_codes)
+            Validation.assert_is_a(Array, country_codes, 'country_codes')
+            @country_codes = country_codes
+            self
+          end
+
+          #
+          # @param [Array<String>] document_types
+          #
+          # @return [self]
+          #
+          def with_document_types(document_types)
+            Validation.assert_is_a(Array, document_types, 'document_types')
+            @document_types = document_types
+            self
+          end
+
+          #
+          # @return [RequiredSupplementaryDocument]
+          #
+          def build
+            RequiredSupplementaryDocument.new(
+              @objective,
+              @document_types,
+              @country_codes
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -74,13 +74,29 @@ module Yoti
             @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>]
           #
@@ -115,6 +131,8 @@ module Yoti
                 TextDataCheckResponse.new(check)
               when Constants::LIVENESS
                 LivenessCheckResponse.new(check)
+              when Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK
+                SupplementaryDocumentTextDataCheckResponse.new(check)
               else
                 CheckResponse.new(check)
               end

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

@@ -11,6 +11,9 @@ module Yoti
           # @return [MediaResponse]
           attr_reader :media
 
+          # @return [Array<FrameResponse>]
+          attr_reader :frames
+
           #
           # @param [Hash] page
           #
@@ -19,6 +22,13 @@ module Yoti
             @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

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

@@ -8,6 +8,9 @@ module Yoti
           # @return [Array<IdDocumentResourceResponse>]
           attr_reader :id_documents
 
+          # @return [Array<SupplementaryDocumentResourceResponse>]
+          attr_reader :supplementary_documents
+
           # @return [Array<LivenessResourceResponse>]
           attr_reader :liveness_capture
 
@@ -15,12 +18,8 @@ module Yoti
           # @param [Hash] resources
           #
           def initialize(resources)
-            if resources['id_documents'].nil?
-              @id_documents = []
-            else
-              Validation.assert_is_a(Array, resources['id_documents'], 'id_documents')
-              @id_documents = resources['id_documents'].map { |resource| IdDocumentResourceResponse.new(resource) }
-            end
+            @id_documents = parse_id_documents(resources)
+            @supplementary_documents = parse_supplementary_documents(resources)
 
             if resources['liveness_capture'].nil?
               @liveness_capture = []
@@ -43,6 +42,26 @@ module Yoti
           def zoom_liveness_resources
             @liveness_capture.select { |resource| resource.is_a?(ZoomLivenessResourceResponse) }
           end
+
+          private
+
+          def parse_id_documents(resources)
+            return [] if resources['id_documents'].nil?
+
+            Validation.assert_is_a(Array, resources['id_documents'], 'id_documents')
+            resources['id_documents'].map do |resource|
+              IdDocumentResourceResponse.new(resource)
+            end
+          end
+
+          def parse_supplementary_documents(resources)
+            return [] if resources['supplementary_documents'].nil?
+
+            Validation.assert_is_a(Array, resources['supplementary_documents'], 'supplementary_documents')
+            resources['supplementary_documents'].map do |resource|
+              SupplementaryDocumentResourceResponse.new(resource)
+            end
+          end
         end
       end
     end

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

@@ -26,6 +26,8 @@ module Yoti
                 case task['type']
                 when Constants::ID_DOCUMENT_TEXT_DATA_EXTRACTION
                   TextExtractionTaskResponse.new(task)
+                when Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION
+                  SupplementaryDocumentTextExtractionTaskResponse.new(task)
                 else
                   TaskResponse.new(task)
                 end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class SupplementaryDocumentResourceResponse < 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 [FileResponse]
+          attr_reader :document_file
+
+          #
+          # @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_file = FileResponse.new(resource['file']) unless resource['file'].nil?
+          end
+
+          #
+          # @return [Array<SupplementaryDocumentTextExtractionTaskResponse>]
+          #
+          def text_extraction_tasks
+            @tasks.select { |task| task.is_a?(SupplementaryDocumentTextExtractionTaskResponse) }
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class SupplementaryDocumentTextExtractionTaskResponse < TaskResponse
+          #
+          # @return [Array<GeneratedSupplementaryDocumentTextDataCheckResponse>]
+          #
+          def generated_text_data_checks
+            @generated_checks.select { |check| check.is_a?(GeneratedSupplementaryDocumentTextDataCheckResponse) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -75,6 +75,8 @@ module Yoti
               case check['type']
               when Constants::ID_DOCUMENT_TEXT_DATA_CHECK
                 GeneratedTextDataCheckResponse.new(check)
+              when Constants::SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK
+                GeneratedSupplementaryDocumentTextDataCheckResponse.new(check)
               else
                 GeneratedCheckResponse.new(check)
               end

data/lib/yoti/dynamic_share_service/dynamic_scenario.rb

@@ -4,8 +4,13 @@ module Yoti
   module DynamicSharingService
     # Describes a dynamic share
     class DynamicScenario
+      # @return [Yoti::DynamicSharingService::DynamicPolicy]
       attr_reader :policy
+
+      # @return [Array<Yoti::DynamicSharingService::Extension>]
       attr_reader :extensions
+
+      # @return [String]
       attr_reader :callback_endpoint
 
       def initialize

data/lib/yoti/dynamic_share_service/extension/extension.rb

@@ -3,7 +3,10 @@
 module Yoti
   module DynamicSharingService
     class Extension
+      # @return [String]
       attr_reader :type
+
+      # @return [#to_json]
       attr_reader :content
 
       def to_json(*_args)

data/lib/yoti/dynamic_share_service/extension/location_constraint_extension.rb

@@ -6,7 +6,10 @@ module Yoti
     class LocationConstraintExtension
       EXTENSION_TYPE = 'LOCATION_CONSTRAINT'
 
+      # @return [#to_json]
       attr_reader :content
+
+      # @return [String]
       attr_reader :type
 
       def initialize

data/lib/yoti/dynamic_share_service/extension/transactional_flow_extension.rb

@@ -5,7 +5,11 @@ module Yoti
     # Extension for transactional flows
     class TransactionalFlowExtension
       EXTENSION_TYPE = 'TRANSACTIONAL_FLOW'
+
+      # @return [#to_json]
       attr_reader :content
+
+      # @return [String]
       attr_reader :type
 
       def initialize

data/lib/yoti/dynamic_share_service/policy/dynamic_policy.rb

@@ -7,7 +7,10 @@ module Yoti
       SELFIE_AUTH_TYPE = 1
       PIN_AUTH_TYPE = 2
 
+      # @return [Array<Integer>]
       attr_reader :wanted_auth_types
+
+      # @return [Array<Yoti::DynamicSharingService::WantedAttribute>]
       attr_reader :wanted
 
       def wanted_remember_me

data/lib/yoti/dynamic_share_service/policy/wanted_anchor.rb

@@ -4,7 +4,10 @@ module Yoti
   module DynamicSharingService
     # A wanted anchor for a source based constraint
     class WantedAnchor
+      # @return [String]
       attr_reader :value
+
+      # @return [String]
       attr_reader :sub_type
 
       def initialize

data/lib/yoti/dynamic_share_service/policy/wanted_attribute.rb

@@ -4,8 +4,13 @@ module Yoti
   module DynamicSharingService
     # Describes a wanted attribute in a dynamic sharing policy
     class WantedAttribute
+      # @return [String]
       attr_reader :name
+
+      # @return [String]
       attr_reader :derivation
+
+      # @return [Array<#as_json>]
       attr_reader :constraints
 
       def initialize

data/lib/yoti/http/request.rb

@@ -186,7 +186,7 @@ module Yoti
       end
 
       params.map do |k, v|
-        CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
+        "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
       end.join('&')
     end
   end

data/lib/yoti/http/signed_request.rb

@@ -40,7 +40,7 @@ module Yoti
 
       payload_string = @payload.is_a?(String) ? @payload : @payload.to_json
 
-      '&' + Base64.strict_encode64(payload_string)
+      "&#{Base64.strict_encode64(payload_string)}"
     end
   end
 end

data/lib/yoti/protobuf/main.rb

@@ -3,12 +3,12 @@ $LOAD_PATH.unshift File.expand_path('./attrpubapi/', __dir__)
 require 'google/protobuf'
 require 'json'
 
-require_relative 'attrpubapi/List_pb.rb'
-require_relative 'compubapi/EncryptedData_pb.rb'
-require_relative 'compubapi/SignedTimestamp_pb.rb'
-require_relative 'sharepubapi/ExtraData_pb.rb'
-require_relative 'sharepubapi/IssuingAttributes_pb.rb'
-require_relative 'sharepubapi/ThirdPartyAttribute_pb.rb'
+require_relative 'attrpubapi/List_pb'
+require_relative 'compubapi/EncryptedData_pb'
+require_relative 'compubapi/SignedTimestamp_pb'
+require_relative 'sharepubapi/ExtraData_pb'
+require_relative 'sharepubapi/IssuingAttributes_pb'
+require_relative 'sharepubapi/ThirdPartyAttribute_pb'
 
 module Yoti
   module Protobuf
@@ -91,9 +91,9 @@ module Yoti
       private
 
       def convert_multi_value(value)
-        proto_multi_value = Yoti::Protobuf::Attrpubapi::MultiValue.decode(value)
+        proto_multi_values = Yoti::Protobuf::Attrpubapi::MultiValue.decode(value).values
         items = []
-        proto_multi_value.values.each do |item|
+        proto_multi_values.each do |item|
           items << value_based_on_content_type(item.data, item.content_type)
         end
         MultiValue.new(items)

data/lib/yoti/share/attribute_issuance_details.rb

@@ -5,6 +5,7 @@ require 'base64'
 module Yoti
   module Share
     class Definition
+      # @return [String]
       attr_reader :name
 
       #
@@ -18,8 +19,13 @@ module Yoti
     end
 
     class AttributeIssuanceDetails
+      # @return [String]
       attr_reader :token
+
+      # @return [Array<Yoti::Share::Definition>]
       attr_reader :attributes
+
+      # @return [DateTime|nil]
       attr_reader :expiry_date
 
       #

data/lib/yoti/ssl.rb

@@ -42,7 +42,7 @@ module Yoti
       # @param message [String] message to be signed
       # @return [String] signed message encoded in base 64
       def get_secure_signature(message)
-        digest = OpenSSL::Digest::SHA256.new
+        digest = OpenSSL::Digest.new('SHA256')
         Base64.strict_encode64(private_key.sign(digest, message))
       end
 
@@ -60,7 +60,7 @@ module Yoti
       end
 
       # Reset and reload the Private Key used for SSL functions
-      # @deprecated 2.0.0
+      # @deprecated will be removed in 2.0.0
       def reload!
         @private_key = nil
         @pem = nil

data/lib/yoti/util/age_processor.rb

@@ -2,7 +2,7 @@ module Yoti
   #
   # Process age attribute
   #
-  # @deprecated 2.0.0 - replaced by Yoti::AgeVerification
+  # @deprecated will be removed in 2.0.0 - replaced by Yoti::AgeVerification
   #
   class AgeProcessor
     AGE_PATTERN = 'age_(over|under):[1-9][0-9]?[0-9]?'

data/lib/yoti/util/anchor_processor.rb

@@ -20,7 +20,7 @@ module Yoti
     # @return [Array<Yoti::Anchor>]
     #
     def process
-      result_data = ANCHOR_LIST_KEYS.map { |key, _value| [key, []] }.to_h
+      result_data = ANCHOR_LIST_KEYS.transform_values { |_value| [] }
 
       @anchors_list.each do |anchor|
         x509_certs_list = convert_certs_list_to_X509(anchor.origin_server_certs)

data/lib/yoti/util/log.rb

@@ -4,7 +4,7 @@ module Yoti
   module Log
     class << self
       def logger
-        @logger || create_logger(STDOUT)
+        @logger || create_logger($stdout)
       end
 
       def output(output_stream)

data/lib/yoti/version.rb

@@ -1,4 +1,4 @@
 module Yoti
   # @return [String] the gem's current version
-  VERSION = '1.9.0'.freeze
+  VERSION = '1.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Yoti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -189,16 +189,20 @@ files:
 - lib/yoti/doc_scan/session/create/document_filter.rb
 - lib/yoti/doc_scan/session/create/document_restrictions_filter.rb
 - lib/yoti/doc_scan/session/create/notification_config.rb
+- lib/yoti/doc_scan/session/create/objective/objective.rb
+- lib/yoti/doc_scan/session/create/objective/proof_of_address_objective.rb
 - lib/yoti/doc_scan/session/create/orthogonal_restrictions_filter.rb
 - lib/yoti/doc_scan/session/create/requested_check.rb
 - lib/yoti/doc_scan/session/create/requested_document_authenticity_check.rb
 - lib/yoti/doc_scan/session/create/requested_face_match_check.rb
 - lib/yoti/doc_scan/session/create/requested_id_document_comparison_check.rb
 - lib/yoti/doc_scan/session/create/requested_liveness_check.rb
+- lib/yoti/doc_scan/session/create/requested_supplementary_doc_text_extraction_task.rb
 - lib/yoti/doc_scan/session/create/requested_task.rb
 - lib/yoti/doc_scan/session/create/requested_text_extraction_task.rb
 - lib/yoti/doc_scan/session/create/required_document.rb
 - lib/yoti/doc_scan/session/create/required_id_document.rb
+- lib/yoti/doc_scan/session/create/required_supplementary_document.rb
 - lib/yoti/doc_scan/session/create/sdk_config.rb
 - lib/yoti/doc_scan/session/create/session_specification.rb
 - lib/yoti/doc_scan/session/retrieve/authenticity_check_response.rb
@@ -209,9 +213,11 @@ files:
 - lib/yoti/doc_scan/session/retrieve/document_id_photo_response.rb
 - lib/yoti/doc_scan/session/retrieve/face_map_response.rb
 - lib/yoti/doc_scan/session/retrieve/face_match_check_response.rb
+- lib/yoti/doc_scan/session/retrieve/file_response.rb
 - lib/yoti/doc_scan/session/retrieve/frame_response.rb
 - lib/yoti/doc_scan/session/retrieve/generated_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/generated_media.rb
+- lib/yoti/doc_scan/session/retrieve/generated_supplementary_document_text_data_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/generated_text_data_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/get_session_result.rb
 - lib/yoti/doc_scan/session/retrieve/id_document_comparison_check_response.rb
@@ -224,6 +230,9 @@ files:
 - lib/yoti/doc_scan/session/retrieve/report_response.rb
 - lib/yoti/doc_scan/session/retrieve/resource_container.rb
 - lib/yoti/doc_scan/session/retrieve/resource_response.rb
+- lib/yoti/doc_scan/session/retrieve/supplementary_document_resource_response.rb
+- lib/yoti/doc_scan/session/retrieve/supplementary_document_text_data_check_response.rb
+- lib/yoti/doc_scan/session/retrieve/supplementary_document_text_extraction_task_response.rb
 - lib/yoti/doc_scan/session/retrieve/task_response.rb
 - lib/yoti/doc_scan/session/retrieve/text_data_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/text_extraction_task_response.rb