smile-identity-core 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cd1f7ec1f9a1c9418ce0e3d5501eb8e32fcfaf029da9b9188145a16dbbdf70b
-  data.tar.gz: 4bb53eafd0b561c05599a33fda6450099ab7208d1800a7ed19f5f304745e9985
+  metadata.gz: ab854f61f188586b70f98ef4a0766575e308343bae0fc5e73b2c748c876ce83e
+  data.tar.gz: e8c2f3ac08e780dff638e8754aab74567ddccc84ac97d68e95d2fb5fa596c97e
 SHA512:
-  metadata.gz: fd09fe7c7e6117497dada79d8132eae2b08e58fd36def75626cd8883f151138d54868c16eb3b5ad5f45977c5d0fe6c1e01e9184350d8147bde3dee6513da0ea2
-  data.tar.gz: b442ba3c424a3d0eaf5f2fedba6596825da09053bf4d4a9221d8999c5e18c7359dde3c8abc2db6f23154d0e306cf220aa654a4ad3e4c1d9afe5fcb34f5e1038e
+  metadata.gz: 8f98bb6732acb0ac767590b6c15beb41c32cf411dc95b9d18a3a4af1cc92a672717442398d049efffbfd000f84c83ab9e71d2403342cda79cf4f504a5900fdd4
+  data.tar.gz: 102f5e6e96c23e3407600591697eaf0f0bc26cf55bd37061eff5555544a07452927988f9001227a60874a2ec3107b9b47a38c75591cd5698852df2b9f1ed9d4d

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

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [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
+
 ## [2.2.0] - 2023-04-05
 ### Added
 - Adds support for AML check

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (2.2.0)
+    smile-identity-core (2.2.2)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -10,7 +10,7 @@ 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)
@@ -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/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/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.0'
+  VERSION = '2.2.2'
   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
 
@@ -91,8 +87,15 @@ module SmileIdentityCore
       # if it's a boolean
       updated_id_info[:entered] = id_info[:entered].to_s if !updated_id_info[:entered].nil? == updated_id_info[:entered]
 
-      if updated_id_info[:entered] && updated_id_info[:entered] == 'true'
-        %i[country id_type id_number].each do |key|
+      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
+
+      if updated_id_info[:entered] == 'true' || is_jt6
+        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
       end
@@ -130,12 +133,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(
@@ -154,9 +157,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.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Smile Identity
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-10-04 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
@@ -201,7 +201,7 @@ metadata:
   source_code_uri: https://github.com/smileidentity/smile-identity-core-ruby
   documentation_uri: https://docs.smileidentity.com
   changelog_uri: https://github.com/smileidentity/smile-identity-core-ruby/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The Smile Identity Web API allows the user to access\ most of the features
   of the Smile Identity system through direct server to server queries.