yoti_sandbox 1.0.0 → 1.4.0

data/lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_reason.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class TextDataExtractionReason
+          #
+          # @param [String] value
+          # @param [String] detail
+          #
+          def initialize(value, detail)
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+
+            Validation.assert_is_a(String, detail, 'detail', true)
+            @detail = detail
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              value: @value,
+              detail: @detail
+            }.compact
+          end
+
+          #
+          # @return [TextDataExtractionReasonBuilder]
+          #
+          def self.builder
+            TextDataExtractionReasonBuilder.new
+          end
+        end
+
+        class TextDataExtractionReasonBuilder
+          #
+          # @return [self]
+          #
+          def for_quality
+            @value = 'QUALITY'
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def for_user_error
+            @value = 'USER_ERROR'
+            self
+          end
+
+          #
+          # @param [String] detail
+          #
+          # @return [self]
+          #
+          def with_detail(detail)
+            @detail = detail
+            self
+          end
+
+          #
+          # @return [TextDataExtractionReason]
+          #
+          def build
+            TextDataExtractionReason.new(@value, @detail)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task/text_data_extraction_recommendation.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class TextDataExtractionRecommendation
+          #
+          # @param [String] value
+          # @param [TextDataExtractionReason] reason
+          #
+          def initialize(value, reason)
+            Validation.assert_is_a(String, value, 'value')
+            @value = value
+
+            Validation.assert_is_a(TextDataExtractionReason, reason, 'reason', true)
+            @reason = reason
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              value: @value,
+              reason: @reason
+            }.compact
+          end
+
+          #
+          # @return [TextDataExtractionRecommendationBuilder]
+          #
+          def self.builder
+            TextDataExtractionRecommendationBuilder.new
+          end
+        end
+
+        class TextDataExtractionRecommendationBuilder
+          #
+          # @return [self]
+          #
+          def for_progress
+            @value = 'PROGRESS'
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def for_should_try_again
+            @value = 'SHOULD_TRY_AGAIN'
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def for_must_try_again
+            @value = 'MUST_TRY_AGAIN'
+            self
+          end
+
+          #
+          # @param [TextDataExtractionReason] reason
+          #
+          # @return [self]
+          #
+          def with_reason(reason)
+            @reason = reason
+            self
+          end
+
+          #
+          # @return [TextDataExtractionRecommendation]
+          #
+          def build
+            TextDataExtractionRecommendation.new(@value, @reason)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/doc_scan/request/task_results.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module DocScan
+      module Request
+        class TaskResults
+          #
+          # @param [Array<DocumentTextDataExtractionTask>] document_text_data_extraction_tasks
+          # @param [Array<SupplementaryDocumentTextDataExtractionTask>] supplementary_document_text_data_extraction_tasks
+          #
+          def initialize(
+            document_text_data_extraction_tasks,
+            supplementary_document_text_data_extraction_tasks
+          )
+            Validation.assert_is_a(
+              Array,
+              document_text_data_extraction_tasks,
+              'document_text_data_extraction_tasks'
+            )
+            @document_text_data_extraction_tasks = document_text_data_extraction_tasks
+
+            Validation.assert_is_a(
+              Array,
+              supplementary_document_text_data_extraction_tasks,
+              'supplementary_document_text_data_extraction_tasks'
+            )
+            @supplementary_document_text_data_extraction_tasks = supplementary_document_text_data_extraction_tasks
+          end
+
+          def self.builder
+            TaskResultsBuilder.new
+          end
+
+          def to_json(*_args)
+            as_json.to_json
+          end
+
+          def as_json(*_args)
+            {
+              ID_DOCUMENT_TEXT_DATA_EXTRACTION: @document_text_data_extraction_tasks,
+              SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION: @supplementary_document_text_data_extraction_tasks
+            }
+          end
+        end
+
+        class TaskResultsBuilder
+          def initialize
+            @document_text_data_extraction_tasks = []
+            @supplementary_document_text_data_extraction_tasks = []
+          end
+
+          #
+          # @param [DocumentTextDataExtractionTask] document_text_data_extraction_task
+          #
+          # @return [self]
+          #
+          def with_document_text_data_extraction_task(document_text_data_extraction_task)
+            Validation.assert_is_a(
+              DocumentTextDataExtractionTask,
+              document_text_data_extraction_task,
+              'document_text_data_extraction_task'
+            )
+            @document_text_data_extraction_tasks << document_text_data_extraction_task
+            self
+          end
+
+          #
+          # @param [SupplementaryDocumentTextDataExtractionTask] supplementary_document_text_data_extraction_task
+          #
+          # @return [self]
+          #
+          def with_supplementary_document_text_data_extraction_task(supplementary_document_text_data_extraction_task)
+            Validation.assert_is_a(
+              SupplementaryDocumentTextDataExtractionTask,
+              supplementary_document_text_data_extraction_task,
+              'supplementary_document_text_data_extraction_task'
+            )
+            @supplementary_document_text_data_extraction_tasks << supplementary_document_text_data_extraction_task
+            self
+          end
+
+          #
+          # @return [TaskResults]
+          #
+          def build
+            TaskResults.new(
+              @document_text_data_extraction_tasks,
+              @supplementary_document_text_data_extraction_tasks
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/profile.rb

@@ -1,5 +1,10 @@
+require 'yoti'
+
 require_relative 'profile/age_verification'
 require_relative 'profile/anchor'
 require_relative 'profile/attribute'
 require_relative 'profile/client'
 require_relative 'profile/token_request'
+require_relative 'profile/extra_data'
+require_relative 'profile/third_party'
+require_relative 'profile/document_images'

data/lib/yoti_sandbox/profile/age_verification.rb

@@ -25,6 +25,13 @@ module Yoti
           @anchors = anchors
         end
 
+        #
+        # @return [AgeVerificationBuilder]
+        #
+        def self.builder
+          AgeVerificationBuilder.new
+        end
+
         #
         # @return [Attribute]
         #

data/lib/yoti_sandbox/profile/client.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'yoti'
-require 'securerandom'
-
 module Yoti
   module Sandbox
     module Profile
@@ -23,30 +20,15 @@ module Yoti
         # @return [String]
         #
         def setup_sharing_profile(token_request)
-          endpoint = "/apps/#{Yoti.configuration.client_sdk_id}/tokens?\
-nonce=#{SecureRandom.uuid}&timestamp=#{Time.now.to_i}"
-          uri = URI(
-            "#{@base_url}#{endpoint}"
-          )
-
-          response = Net::HTTP.start(
-            uri.hostname,
-            uri.port,
-            use_ssl: true
-          ) do |http|
-            unsigned = Net::HTTP::Post.new uri
-            unsigned.body = token_request.to_json
-            signed_request = Yoti::SignedRequest.new(
-              unsigned,
-              endpoint,
-              token_request
-            ).sign
-            http.request signed_request
-          end
-
-          raise "Failed to share profile #{response.code}: #{response.body}" unless response.code == '201'
+          request = Yoti::Request
+                    .builder
+                    .with_base_url(@base_url)
+                    .with_endpoint("apps/#{Yoti.configuration.client_sdk_id}/tokens")
+                    .with_http_method('POST')
+                    .with_payload(token_request)
+                    .build
 
-          JSON.parse(response.body)['token']
+          JSON.parse(request.execute.body)['token']
         end
       end
     end

data/lib/yoti_sandbox/profile/document_images.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module Profile
+      class DocumentImages
+        #
+        # @param [Array<Image>] images
+        #
+        def initialize(images)
+          Validation.assert_is_a(Array, images, 'images')
+          @images = images
+        end
+
+        #
+        # @return [DocumentImagesBuilder]
+        #
+        def self.builder
+          DocumentImagesBuilder.new
+        end
+
+        #
+        # @return [String]
+        #
+        def value
+          @images
+            .map(&:base64_content)
+            .join('&')
+        end
+      end
+
+      #
+      # Builder for {DocumentImages}
+      #
+      class DocumentImagesBuilder
+        def initialize
+          @images = []
+        end
+
+        #
+        # @param [bin] content
+        #
+        # @return [self]
+        #
+        def with_jpeg_content(content)
+          @images << Yoti::ImageJpeg.new(content)
+          self
+        end
+
+        #
+        # @param [bin] content
+        #
+        # @return [self]
+        #
+        def with_png_content(content)
+          @images << Yoti::ImagePng.new(content)
+          self
+        end
+
+        #
+        # @return [DocumentImages]
+        #
+        def build
+          DocumentImages.new(@images)
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/profile/extra_data.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Yoti
+  module Sandbox
+    module Profile
+      class ExtraData
+        def initialize(data_entries)
+          @data_entries = data_entries
+        end
+
+        #
+        # @return [Hash]
+        #
+        def as_json(*_args)
+          {
+            data_entry: @data_entries
+          }
+        end
+
+        #
+        # @return [String]
+        #
+        def to_json(*args)
+          as_json.to_json(*args)
+        end
+
+        #
+        # @return [ExtraDataBuilder]
+        #
+        def self.builder
+          ExtraDataBuilder.new
+        end
+      end
+
+      #
+      # Base DataEntry
+      #
+      class DataEntry
+        #
+        # @param [String] type
+        # @param [#as_json] value
+        #
+        def initialize(type, value)
+          raise(TypeError, "#{self.class} cannot be instantiated") if instance_of?(DataEntry)
+
+          Validation.assert_is_a(String, type, 'type')
+          @type = type
+
+          Validation.assert_respond_to(:as_json, value, 'value')
+          @value = value
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          {
+            type: @type,
+            value: @value.as_json
+          }
+        end
+      end
+
+      #
+      # Builder for ExtraData
+      #
+      class ExtraDataBuilder
+        def initialize
+          @data_entries = []
+        end
+
+        #
+        # @param [DataEntry] data_entry
+        #
+        # @return [self]
+        #
+        def with_data_entry(data_entry)
+          @data_entries << data_entry
+          self
+        end
+
+        #
+        # @return [ExtraData]
+        #
+        def build
+          ExtraData.new(@data_entries)
+        end
+      end
+    end
+  end
+end