yoti_sandbox 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60f6434723e625e3bbf2148d1af084c6800f4a7e682305f3eb731325174ac75a
-  data.tar.gz: 72205e69a037a63094fe043b5ce4fd5108f3f76ded8da6ef82ee96dc4865c066
+  metadata.gz: 3b95016e63022dda0044df80a5000d043a84cab4df3091ac4089c7e2dff44f5c
+  data.tar.gz: 9d613fdbcc9a92c06e311236e74c0f17d7c2753ea728c98ebe58ea9005141ca7
 SHA512:
-  metadata.gz: 9a042d5227329c22a0e60af7e5c44e4875af419a05e1e1816992194ff49382b4e7a23cc10028ebaf9fbf63a3d7d7614b9d4f2f4992c3c810e4f1f244003e1166
-  data.tar.gz: 0471a65f852b28fb64533842483587232d2051c7859a6c343e708b542999f1b119ec9b8bb7dc3e2aff450a2545f419e2642cdaf369212e2ebfbb70a8a6c12280
+  metadata.gz: bd050c465f05d84b43d1b95155618467a1fa6dd8e7a2ea630c35822b87321aa2331bcc31343b202d98d6c5c9ce5b9b06f849541e521b40786a6a02c32b8ef4f3
+  data.tar.gz: 8f6eca8ad30da0dcfaab8f9909703ce12fa465e1fe43e4958464f53a47ee00719e33009152cd8db9054492644a2d63ab2f59fa631b4b36ada06f800a3a6aeac2

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 3
+  target-branch: development
+  reviewers:
+  - echarrod
+  - davidgrayston
+  assignees:
+  - davidgrayston

data/lib/yoti_sandbox/doc_scan.rb

@@ -1,6 +1,7 @@
 require 'yoti'
 
 require_relative 'doc_scan/client'
+require_relative 'doc_scan/errors'
 require_relative 'doc_scan/request/task_results'
 require_relative 'doc_scan/request/check_reports'
 require_relative 'doc_scan/request/response_config'

data/lib/yoti_sandbox/doc_scan/client.rb

@@ -19,29 +19,39 @@ module Yoti
         # @param [Yoti::SandboxDocScan::Request::ResponseConfig] response_config
         #
         def configure_session_response(session_id, response_config)
-          Yoti::Request
-            .builder
-            .with_http_method('PUT')
-            .with_base_url(@base_url)
-            .with_endpoint("sessions/#{session_id}/response-config")
-            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
-            .with_payload(response_config)
-            .build
-            .execute
+          request = Yoti::Request
+                    .builder
+                    .with_http_method('PUT')
+                    .with_base_url(@base_url)
+                    .with_endpoint("sessions/#{session_id}/response-config")
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .with_payload(response_config)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::Sandbox::DocScan::Error.wrap(e)
+          end
         end
 
         #
         # @param [Yoti::SandboxDocScan::Request::ResponseConfig] response_config
         #
         def configure_application_response(response_config)
-          Yoti::Request
-            .builder
-            .with_http_method('PUT')
-            .with_base_url(@base_url)
-            .with_endpoint("apps/#{Yoti.configuration.client_sdk_id}/response-config")
-            .with_payload(response_config)
-            .build
-            .execute
+          request = Yoti::Request
+                    .builder
+                    .with_http_method('PUT')
+                    .with_base_url(@base_url)
+                    .with_endpoint("apps/#{Yoti.configuration.client_sdk_id}/response-config")
+                    .with_payload(response_config)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::Sandbox::DocScan::Error.wrap(e)
+          end
         end
       end
     end

data/lib/yoti_sandbox/doc_scan/errors.rb

@@ -0,0 +1,83 @@
+require 'json'
+
+module Yoti
+  module Sandbox
+    module DocScan
+      #
+      # Raises exceptions related to Doc Scan Sandbox 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
+end

data/lib/yoti_sandbox/profile.rb

@@ -5,3 +5,6 @@ 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/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 self.class == 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

data/lib/yoti_sandbox/profile/third_party.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Yoti
+  module Sandbox
+    module Profile
+      #
+      # Provides attribute issuance details data entry
+      #
+      class AttributeIssuanceDetails < DataEntry
+        #
+        # @param [AttributeIssuanceDetailsValue] value
+        #
+        def initialize(value)
+          Validation.assert_is_a(AttributeIssuanceDetailsValue, value, 'value')
+          super('THIRD_PARTY_ATTRIBUTE', value)
+        end
+
+        #
+        # @return [AttributeIssuanceDetailsBuilder]
+        #
+        def self.builder
+          AttributeIssuanceDetailsBuilder.new
+        end
+      end
+
+      #
+      # Builder for AttributeIssuanceDetails
+      #
+      class AttributeIssuanceDetailsBuilder
+        def initialize
+          @definitions = []
+        end
+
+        #
+        # @param [String] issuance_token
+        #
+        # @return [self]
+        #
+        def with_issuance_token(issuance_token)
+          Validation.assert_is_a(String, issuance_token, 'issuance_token')
+          @issuance_token = issuance_token
+          self
+        end
+
+        #
+        # @param [Time, DateTime] expiry_date
+        #
+        # @return [self]
+        #
+        def with_expiry_date(expiry_date)
+          Validation.assert_respond_to(:to_time, expiry_date, 'expiry_date')
+          @expiry_date = expiry_date
+          self
+        end
+
+        #
+        # @param [String] definition
+        #
+        # @return [self]
+        #
+        def with_definition(definition)
+          @definitions << AttributeDefinition.new(definition)
+          self
+        end
+
+        #
+        # @return [AttributeIssuanceDetails]
+        #
+        def build
+          issuing_attributes = IssuingAttributes.new(@expiry_date, @definitions)
+          value = AttributeIssuanceDetailsValue.new(@issuance_token, issuing_attributes)
+          AttributeIssuanceDetails.new(value)
+        end
+      end
+
+      #
+      # Provides attribute issuance details value consisting of token and attributes.
+      #
+      class AttributeIssuanceDetailsValue
+        #
+        # @param [String] issuance_token
+        # @param [IssuingAttributes] issuing_attributes
+        #
+        def initialize(issuance_token, issuing_attributes)
+          Validation.assert_is_a(String, issuance_token, 'issuance_token')
+          @issuance_token = issuance_token
+
+          Validation.assert_is_a(IssuingAttributes, issuing_attributes, 'issuing_attributes')
+          @issuing_attributes = issuing_attributes
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          {
+            issuance_token: @issuance_token,
+            issuing_attributes: @issuing_attributes
+          }
+        end
+      end
+
+      #
+      # Provides issuing attributes, consisting of expiry date and list of definitions.
+      #
+      class IssuingAttributes
+        #
+        # @param [Time, DateTime] expiry_date
+        # @param [Array<AttributeDefinition>] definitions
+        #
+        def initialize(expiry_date, definitions)
+          Validation.assert_respond_to(:to_time, expiry_date, 'expiry_date')
+          @expiry_date = expiry_date
+
+          Validation.assert_is_a(Array, definitions, 'definitions')
+          @definitions = definitions
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          json = {}
+          json[:expiry_date] = @expiry_date.to_time.utc.strftime('%FT%T.%3NZ') unless @expiry_date.nil?
+          json[:definitions] = @definitions.map(&:as_json)
+          json
+        end
+      end
+
+      #
+      # Provides a single attribute definition.
+      #
+      class AttributeDefinition
+        #
+        # @param [String] name
+        #
+        def initialize(name)
+          Validation.assert_is_a(String, name, 'name')
+          @name = name
+        end
+
+        def to_json(*_args)
+          as_json.to_json
+        end
+
+        def as_json(*_args)
+          {
+            name: @name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/yoti_sandbox/profile/token_request.rb

@@ -14,12 +14,19 @@ module Yoti
       #
       class TokenRequest
         #
-        # @param [String] remember_me_id
+        # @param [String, nil] remember_me_id
         # @param [Array<Attribute>] attributes
+        # @param [ExtraData, nil] extra_data
         #
-        def initialize(remember_me_id, attributes)
+        def initialize(remember_me_id, attributes, extra_data = nil)
+          Validation.assert_is_a(String, remember_me_id, 'remember_me_id', true)
           @remember_me_id = remember_me_id
+
+          Validation.assert_is_a(Array, attributes, 'attributes')
           @attributes = attributes
+
+          Validation.assert_is_a(ExtraData, extra_data, 'extra_data', true)
+          @extra_data = extra_data
         end
 
         #
@@ -35,8 +42,9 @@ module Yoti
         def as_json(*_args)
           {
             remember_me_id: @remember_me_id,
-            profile_attributes: @attributes.map(&:as_json)
-          }
+            profile_attributes: @attributes.map(&:as_json),
+            extra_data: @extra_data
+          }.compact
         end
 
         #
@@ -52,7 +60,6 @@ module Yoti
       #
       class TokenRequestBuilder
         def initialize
-          @remember_me_id = ''
           @attributes = []
         end
 
@@ -290,11 +297,38 @@ module Yoti
           )
         end
 
+        #
+        # @param [DocumentImages] document_images
+        # @param [Array<Anchor>] anchors
+        #
+        # @return [self]
+        #
+        def with_document_images(document_images, anchors: [])
+          with_attribute(
+            create_attribute(
+              name: Yoti::Attribute::DOCUMENT_IMAGES,
+              value: document_images.value,
+              anchors: anchors
+            )
+          )
+        end
+
+        #
+        # @param [ExtraData] extra_data
+        #
+        # @return [self]
+        #
+        def with_extra_data(extra_data)
+          Validation.assert_is_a(ExtraData, extra_data, 'extra_data')
+          @extra_data = extra_data
+          self
+        end
+
         #
         # @return [TokenRequest]
         #
         def build
-          TokenRequest.new(@remember_me_id, @attributes)
+          TokenRequest.new(@remember_me_id, @attributes, @extra_data)
         end
 
         private

data/rubocop.yml

@@ -42,7 +42,3 @@ Style/MutableConstant:
 
 Layout/LineLength:
   Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Exclude:
-    - examples/**/*.rb

data/yoti_sandbox.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'yoti_sandbox'
-  spec.version       = '1.1.0'
+  spec.version       = '1.2.0'
   spec.authors       = ['Yoti']
   spec.email         = ['websdk@yoti.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti_sandbox
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yoti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yoti
@@ -132,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE.md"
+- ".github/dependabot.yml"
 - ".gitignore"
 - CONTRIBUTING.md
 - Gemfile
@@ -142,6 +143,7 @@ files:
 - lib/yoti_sandbox.rb
 - lib/yoti_sandbox/doc_scan.rb
 - lib/yoti_sandbox/doc_scan/client.rb
+- lib/yoti_sandbox/doc_scan/errors.rb
 - lib/yoti_sandbox/doc_scan/request/check/check.rb
 - lib/yoti_sandbox/doc_scan/request/check/document_authenticity_check.rb
 - lib/yoti_sandbox/doc_scan/request/check/document_check.rb
@@ -162,6 +164,9 @@ files:
 - lib/yoti_sandbox/profile/anchor.rb
 - lib/yoti_sandbox/profile/attribute.rb
 - lib/yoti_sandbox/profile/client.rb
+- lib/yoti_sandbox/profile/document_images.rb
+- lib/yoti_sandbox/profile/extra_data.rb
+- lib/yoti_sandbox/profile/third_party.rb
 - lib/yoti_sandbox/profile/token_request.rb
 - rubocop.yml
 - yardstick.yml