smile-identity-core 2.2.1 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5436921cd5f8d337cec031b4b193f73a11d15389481ac860195e6c28164296a5
-  data.tar.gz: da6562fc3a5647137338336e5f9f710e042cba36451339e485a0f818532805a2
+  metadata.gz: 1b08d29788e9df7942697da8ef9391fdc7200e5d31ac8b0e6520649d9051fbc0
+  data.tar.gz: 4e27841299e6c26392883a14d38a72ae104195df8cc06492bb27457198a96e89
 SHA512:
-  metadata.gz: 28f93dbeab2f0aeb9a80145e245b583c0479dd6b17b0a96fdd0ef471623c401bcdd8112a407e90265716aa1bc4a51a84c7dade6b866a929001d9189c4c89e371
-  data.tar.gz: c910e027a0420cc594862676a42f4022b9ad1b45e657d63c5977a3f6b38db2f0280e079e74df233a63f5ba3c26fb4637eda6c30cb8bc7cde102ecb91878d2ae9
+  metadata.gz: b08f43d9d9849048f18adb39ef3553c442cdf5aa2ccb4e77a97048df1b2b1a0b72a36fa2d8c0750e13177d9b7a2db987d7f3746c5218f771402da047721cc73b
+  data.tar.gz: febc9a1df0e0535fc93f3fc4d7562ee118f0f87031445da6ddc2ec2c91e5a9c52df27c05e8bc0e4db4377b81924e9f26e8b87b1594583e8554495923e898be54

data/.github/workflows/test.yml

@@ -14,23 +14,21 @@ jobs:
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
         # See https://www.ruby-lang.org/en/downloads/ for latest stable releases.
-        ruby: ['2.6', '2.7', '3.0', '3.1']
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        bundler-cache: true
     - run: bundle exec rake
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby 3.1
-      uses: ruby/setup-ruby@v1
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    # NOTE: || true should be removed as soon as all offenses are fixed.
+        ruby-version: 3.2
+        bundler-cache: true
     - name: Run RuboCop
-      run: bundle exec rubocop --parallel || true
+      run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -3,4 +3,43 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.5
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+  
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.2

data/CHANGELOG.md

@@ -4,8 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.3] - 2023-10-20
+## Added
+- Adds support for Enhanced Document Verification
+
 ## [Unreleased]
 
+## [2.2.2] - 2023-10-05
+### Changed
+- Lint project. Enforce rubocop rules via github action
+
+## Added
+Support Ruby 3.2
+
 ## [2.2.1] - 2023-08-31
 ### Changed
 - Don't validate the presence of `id_type` and `id_number` for Document Verification jobs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (2.2.1)
+    smile-identity-core (2.2.3)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -10,10 +10,10 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.4.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     json (2.5.1)
     parallel (1.22.1)
     parser (3.1.2.1)
@@ -53,11 +53,12 @@ GEM
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     rubyzip (1.3.0)
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (2.3.0)
@@ -72,7 +73,7 @@ DEPENDENCIES
   rubocop (~> 1.37.1)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.14.1)
-  simplecov (~> 0.12.0)
+  simplecov (~> 0.18)
   smile-identity-core!
 
 BUNDLED WITH

data/examples/enhanced_document_verification.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+
+# See https://docs.smileidentity.com/server-to-server/ruby/products/enhanced_document-verification for
+# how to setup and retrieve configuation values for the WebApi class.
+
+# Initialize
+partner_id = '<Put your partner ID here>'; # login to the Smile Identity portal to view your partner id
+default_callback = '<Put your default callback url here>'
+api_key = '<Put your API key here>'; # copy your API key from the Smile Identity portal
+sid_server = '<0 | 1>'; # Use '0' for the sandbox server, use '1' for production server
+
+connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+
+# Create required tracking parameters
+partner_params = {
+  user_id: '<put your unique ID for the user here>',
+  job_id: '<put your unique job ID here>',
+  job_type: 11
+}
+
+# Create image list
+# image_type_id (Integer) - This infers to either a file or a base64 encoded image, but not both.
+# 0 - Selfie image jpg or png (if you have the full path of the selfie)
+# 2 - Selfie image jpg or png base64 encoded (if you have the base64image string of the selfie)
+# 4 - Liveness image jpg or png (if you have the full path of the liveness image)
+# 6 - Liveness image jpg or png base64 encoded (if you have the base64image string of the liveness image)
+# 1 - Front of ID document image jpg or png (if you have the full path of the selfie)
+# 3 - Front of ID document image jpg or png base64 encoded (if you have the base64image string of the selfie)
+# 5 - Back of ID document image jpg or png (if you have the full path of the selfie)
+# 7 - Back of ID document image jpg or png base64 encoded (if you have the base64image string of the selfie)
+image_details = [
+  {
+    image_type_id: '<0 | 2>',
+    image: '<full path to selfie image or base64image string>'
+  },
+  { # Not required if you don't require proof of life (note photo of photo check
+    # will still be performed on the uploaded selfie)
+    image_type_id: '<4 | 6>',
+    image: '<full path to liveness image or base64 image string>'
+  },
+  {
+    image_type_id: '<1 | 3>',
+    image: '<full path to front of id document image or base64image string>'
+  },
+  { # Optional, only use if you're uploading the back of the id document image
+    image_type_id: '<5 | 7>',
+    image: '<full path to back of id document image or base64image string>'
+  }
+]
+
+# The ID Document Information
+id_info = {
+  country: '<2-letter country code>', # The country where ID document was issued
+  id_type: '<id type>' # The ID document type
+}
+
+# Set options for the job
+options = {
+  # Set to true if you want to get the job result in sync (in addition to the result
+  # been sent to your callback). If set to false, result is sent to callback url only.
+  return_job_status: '<true | false>',
+  # Set to true to receive all of the updates you would otherwise have received in your
+  # callback as opposed to only the final result. You must set return_job_status to true to use this flag.
+  return_history: '<true | false>',
+  # Set to true to receive links to the selfie and the photo it was compared to.
+  # You must set return_job_status to true to use this flag.
+  return_image_links: '<true |false>',
+  signature: true
+}
+
+# Submit the job
+connection.submit_job(partner_params, image_details, id_info, options)

data/lib/smile-identity-core/aml_check.rb

@@ -18,14 +18,10 @@ module SmileIdentityCore
     # @param [String] :api_key your API key from the Smile Identity portal
     # @param [String] :sid_server Use 0 for the sandbox server, use 1 for production server
     def initialize(partner_id, api_key, sid_server)
-      @partner_id = partner_id.to_s
       @api_key = api_key
+      @partner_id = partner_id.to_s
       @sid_server = sid_server
-      @url = if sid_server !~ URI::DEFAULT_PARSER.make_regexp
-               SmileIdentityCore::ENV::SID_SERVER_MAPPING[sid_server.to_s]
-             else
-               sid_server
-             end
+      @url = SmileIdentityCore::ENV.determine_url(sid_server)
     end
 
     # Submit AML

data/lib/smile-identity-core/business_verification.rb

@@ -24,14 +24,10 @@ module SmileIdentityCore
     # @param [String] :api_key your API key from the Smile Identity portal
     # @param [String] :sid_server Use 0 for the sandbox server, use 1 for production server
     def initialize(partner_id, api_key, sid_server)
-      @partner_id = partner_id.to_s
       @api_key = api_key
+      @partner_id = partner_id.to_s
       @sid_server = sid_server
-      @url = if sid_server !~ URI::DEFAULT_PARSER.make_regexp
-               SmileIdentityCore::ENV::SID_SERVER_MAPPING[sid_server.to_s]
-             else
-               sid_server
-             end
+      @url = SmileIdentityCore::ENV.determine_url(sid_server)
     end
 
     # Submit business verification

data/lib/smile-identity-core/constants/env.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module SmileIdentityCore
+  # The ENV module contains constants and utility methods for mapping
+  # managing aliases to Smile Identity servers.
   module ENV
     SID_SERVER_MAPPING = {
       '0' => 'https://testapi.smileidentity.com/v1',
@@ -9,5 +11,15 @@ module SmileIdentityCore
 
     TEST = '0'
     LIVE = '1'
+
+    module_function
+
+    def determine_url(sid_server)
+      if sid_server.to_s !~ URI::DEFAULT_PARSER.make_regexp
+        SID_SERVER_MAPPING[sid_server.to_s] || sid_server
+      else
+        sid_server
+      end
+    end
   end
 end

data/lib/smile-identity-core/constants/job_type.rb

@@ -25,5 +25,9 @@ module SmileIdentityCore
     # Performs due diligence by screening against global watchlists,
     # politically exposed persons lists, and adverse media publications
     AML = 10
+    # Verifies the authenticity of Document IDs and confirms their validity
+    # with an ID authority, and uses biometric checks to confirm they
+    # belong to the user.
+    ENHANCED_DOCUMENT_VERIFICATION = 11
   end
 end

data/lib/smile-identity-core/id_api.rb

@@ -10,14 +10,9 @@ module SmileIdentityCore
     REQUIRED_ID_INFO_FIELD = %i[country id_type id_number].freeze
 
     def initialize(partner_id, api_key, sid_server)
-      @partner_id = partner_id.to_s
       @api_key = api_key
-
-      @url = if sid_server !~ URI::DEFAULT_PARSER.make_regexp
-               SmileIdentityCore::ENV::SID_SERVER_MAPPING[sid_server.to_s]
-             else
-               sid_server
-             end
+      @partner_id = partner_id.to_s
+      @url = SmileIdentityCore::ENV.determine_url(sid_server)
     end
 
     def submit_job(partner_params, id_info, options = {})

data/lib/smile-identity-core/utilities.rb

@@ -4,14 +4,9 @@ module SmileIdentityCore
   # A utility class to query job status
   class Utilities
     def initialize(partner_id, api_key, sid_server)
-      @partner_id = partner_id.to_s
       @api_key = api_key
-
-      @url = if sid_server !~ URI::DEFAULT_PARSER.make_regexp
-               SmileIdentityCore::ENV::SID_SERVER_MAPPING[sid_server.to_s]
-             else
-               sid_server
-             end
+      @partner_id = partner_id.to_s
+      @url = SmileIdentityCore::ENV.determine_url(sid_server)
 
       @signature_connection = SmileIdentityCore::Signature.new(@partner_id, @api_key)
     end

data/lib/smile-identity-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module SmileIdentityCore
-  VERSION = '2.2.1'
+  VERSION = '2.2.3'
   SOURCE_SDK = 'Ruby'
 end

data/lib/smile-identity-core/web_api.rb

@@ -12,15 +12,11 @@ module SmileIdentityCore
   # Allows Identity verifications of ids with images
   class WebApi
     def initialize(partner_id, default_callback, api_key, sid_server)
-      @partner_id = partner_id.to_s
-      @callback_url = default_callback
       @api_key = api_key
+      @callback_url = default_callback
+      @partner_id = partner_id.to_s
       @sid_server = sid_server
-      @url = if sid_server !~ URI::DEFAULT_PARSER.make_regexp
-               SmileIdentityCore::ENV::SID_SERVER_MAPPING[sid_server.to_s]
-             else
-               sid_server
-             end
+      @url = SmileIdentityCore::ENV.determine_url(sid_server)
     end
 
     def submit_job(partner_params, images, id_info, options)
@@ -75,7 +71,7 @@ module SmileIdentityCore
       raise ArgumentError, 'Image details needs to be an array' unless images.is_a?(Array)
 
       # all job types require atleast a selfie
-      if images.length.zero? || images.none? { |h| (h[:image_type_id]).zero? || h[:image_type_id] == 2 }
+      if images.empty? || images.none? { |h| (h[:image_type_id]).zero? || h[:image_type_id] == 2 }
         raise ArgumentError, 'You need to send through at least one selfie image'
       end
 
@@ -89,16 +85,18 @@ module SmileIdentityCore
       updated_id_info[:entered] = 'false' if !updated_id_info.key?(:entered) || id_info[:entered].empty?
 
       # if it's a boolean
-      updated_id_info[:entered] = id_info[:entered].to_s if !updated_id_info[:entered].nil? == updated_id_info[:entered]
+      updated_id_info[:entered] = id_info[:entered].to_s
 
       is_jt6 = @partner_params[:job_type].to_i == JobType::DOCUMENT_VERIFICATION
-      keys = if is_jt6
-        %i[country]
-      else
-        %i[country id_type id_number]
-      end
+      is_jt11 = @partner_params[:job_type].to_i == JobType::ENHANCED_DOCUMENT_VERIFICATION
+      keys = if is_jt6 || is_jt11
+               %i[country]
+             else
+               %i[country id_type id_number]
+             end
+      keys.push(:id_type) if is_jt11
 
-      if updated_id_info[:entered] == 'true' || is_jt6
+      if updated_id_info[:entered] == 'true' || is_jt6 || is_jt11
         keys.each do |key|
           raise ArgumentError, "Please make sure that #{key} is included in the id_info" if id_info[key].to_s.empty?
         end
@@ -137,12 +135,12 @@ module SmileIdentityCore
 
     def request_web_token(request_params)
       request_params = request_params
-        .merge(SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(Time.now.to_s))
-        .merge(
-          { partner_id: @partner_id,
-            source_sdk: SmileIdentityCore::SOURCE_SDK,
-            source_sdk_version: SmileIdentityCore::VERSION }
-        )
+                       .merge(SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(Time.now.to_s))
+                       .merge(
+                         { partner_id: @partner_id,
+                           source_sdk: SmileIdentityCore::SOURCE_SDK,
+                           source_sdk_version: SmileIdentityCore::VERSION }
+                       )
       url = "#{@url}/token"
 
       response = Typhoeus.post(
@@ -161,9 +159,9 @@ module SmileIdentityCore
     end
 
     def validate_return_data
-      if (!@callback_url || @callback_url.empty?) && !@options[:return_job_status]
-        raise ArgumentError, 'Please choose to either get your response via the callback or job status query'
-      end
+      return unless (!@callback_url || @callback_url.empty?) && !@options[:return_job_status]
+
+      raise ArgumentError, 'Please choose to either get your response via the callback or job status query'
     end
 
     def validate_enroll_with_id

data/smile-identity-core.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 1.37.1'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.14.1'
-  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18'
 
   spec.add_dependency 'rubyzip', '~> 1.2', '>= 1.2.3'
   spec.add_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smile-identity-core
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.3
 platform: ruby
 authors:
 - Smile Identity
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ files:
 - examples/biometric_kyc.rb
 - examples/business_verification.rb
 - examples/document_verification.rb
+- examples/enhanced_document_verification.rb
 - examples/enhanced_kyc.rb
 - examples/example-project/Gemfile
 - examples/example-project/Gemfile.lock