smile-identity-core 2.1.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f65644b6f79351210a6712dda9f2cd2ad4ac79018b07e7aaa7d1291fce0e64
-  data.tar.gz: ce5e5242fac1cc29376d81f7ed10862d8b97011d09dfe49f4fb32079c87d709b
+  metadata.gz: 5436921cd5f8d337cec031b4b193f73a11d15389481ac860195e6c28164296a5
+  data.tar.gz: da6562fc3a5647137338336e5f9f710e042cba36451339e485a0f818532805a2
 SHA512:
-  metadata.gz: d00a98b441dcf5b90a23256d6984320dce1045de4a2a7fc17d6cf4895c0b7f35d4f96ca4f9a027a6787906839407dcf1b029c93f80693069ecea6530baf0e146
-  data.tar.gz: ad0d04857af60204f7f603debd7391aadab187311c46691f1d43eae213c043c5fc76dfd79093ef56f23580f48a1f345a5b22a3a5fd592c8ae6a0a626598207f2
+  metadata.gz: 28f93dbeab2f0aeb9a80145e245b583c0479dd6b17b0a96fdd0ef471623c401bcdd8112a407e90265716aa1bc4a51a84c7dade6b866a929001d9189c4c89e371
+  data.tar.gz: c910e027a0420cc594862676a42f4022b9ad1b45e657d63c5977a3f6b38db2f0280e079e74df233a63f5ba3c26fb4637eda6c30cb8bc7cde102ecb91878d2ae9

data/.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       with:
         set-safe-directory: false
     - name: Release Gem
-      uses: powerhome/publish-rubygems-action@git-safe-directory
+      uses: cadwallion/publish-rubygems-action@master
       env:
         RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+### Changed
+- Fix business verification docstrings
+
 ## [2.1.2] - 2023-03-09
 ### Changed
 - Fix `get_web_token` by ensuring signature merges to request_params

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (2.1.2)
+    smile-identity-core (2.2.1)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/examples/aml_check.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+require 'securerandom'
+# See https://docs.smileidentity.com/products/for-individuals-kyc/aml-check for
+# more information on business verification
+
+# Initialize
+partner_id = '' # login to the Smile Identity portal to view your partner id
+api_key = '' # copy your API key from the Smile Identity portal
+sid_server = '0' # Use 0 for the sandbox server, use 1 for production server
+
+connection = SmileIdentityCore::AmlCheck.new(partner_id, api_key, sid_server)
+
+request_params = {
+  job_id: "job-#{SecureRandom.uuid}",
+  user_id: "user-#{SecureRandom.uuid}",
+  full_name: 'John Leo Doe',
+  countries: ['US'],
+  birth_year: '1984', # yyyy
+  search_existing_user: false
+}
+
+# Submit the job
+pp connection.submit_job(request_params)

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'typhoeus'
+require_relative 'validations'
+
+module SmileIdentityCore
+  ##
+  # The AML Check product allows you to perform due diligence on your customers by screening them against
+  # global watchlists, politically exposed persons lists, and adverse media publications.
+  # For more info visit https://docs.smileidentity.com/products/for-individuals-kyc/aml-check
+  class AmlCheck
+    include Validations
+
+    ###
+    # Submit AML
+    # @param [String] :partner_id A unique number assigned by Smile ID to your account. Can be found in the portal
+    # @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
+      @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
+    end
+
+    # Submit AML
+    # @param [Hash] params the options to create a job with.
+    # @option opts [String] :job_id A unique value generated by you to track jobs on your end.
+    # @option opts [String] :user_id A unique value generated by you.
+    # @option opts [String] :full_name The full name of the customer.
+    # @option opts [String] :birth_year The customer’s year of birth, in the format yyyy
+    # @option opts [Array] :countries An array that takes the customer’s known nationalities in 2-character
+    # (ISO 3166-1 alpha-2) format e.g. Nigeria is NG, Kenya is KE, etc
+    # @option opts [boolean] :search_existing_user If you intend to re-use the name and year of birth
+    # of a user’s previous KYC job
+    # @option opts [Hash] :optional_info Any optional data, this will be returned
+    # in partner_params.
+    def submit_job(params)
+      @params = symbolize_keys(params)
+      @optional_info = @params[:optional_info]
+      submit_requests
+    end
+
+    private
+
+    def symbolize_keys(params)
+      params.is_a?(Hash) ? params.transform_keys(&:to_sym) : params
+    end
+
+    def build_payload
+      @payload = generate_signature
+      @payload.merge!(@params)
+      add_partner_info
+      add_sdk_info
+      @payload
+    end
+
+    def add_partner_info
+      @payload[:partner_id] = @partner_id
+      @payload[:job_type] = SmileIdentityCore::JobType::AML
+      @payload[:partner_params] = @optional_info if @optional_info
+    end
+
+    def add_sdk_info
+      @payload[:source_sdk] = SmileIdentityCore::SOURCE_SDK
+      @payload[:source_sdk_version] = SmileIdentityCore::VERSION
+    end
+
+    def generate_signature
+      SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature
+    end
+
+    def submit_requests
+      request = Typhoeus::Request.new("#{@url}/aml", method: 'POST',
+                                                     headers: { 'Content-Type' => 'application/json' },
+                                                     body: build_payload.to_json)
+
+      request.on_complete do |response|
+        return response.body if response.success?
+
+        raise "#{response.code}: #{response.body}"
+      end
+      request.run
+    end
+  end
+end

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

@@ -20,10 +20,9 @@ module SmileIdentityCore
 
     ###
     # Submit business verification
-    # @param [Hash] partner_params the options to create a message with.
-    # @option opts [String] :job_type The job type, this should be 7
-    # @option opts [String] :job_id A unique value generated by you to track jobs on your end.
-    # @option opts [String] :user_id A unique value generated by you.
+    # @param [String] :partner_id A unique number assigned by Smile ID to your account. Can be found in the portal
+    # @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

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

@@ -22,5 +22,8 @@ module SmileIdentityCore
     UPDATE_PHOTO = 8
     # Compares document verification to an id check
     COMPARE_USER_INFO = 9
+    # Performs due diligence by screening against global watchlists,
+    # politically exposed persons lists, and adverse media publications
+    AML = 10
   end
 end

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

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

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

@@ -91,8 +91,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

data/lib/smile-identity-core.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require 'smile-identity-core/version'
-require 'smile-identity-core/web_api'
-require 'smile-identity-core/id_api'
-require 'smile-identity-core/signature'
-require 'smile-identity-core/utilities'
-require 'smile-identity-core/business_verification'
-require 'smile-identity-core/constants/env'
-require 'smile-identity-core/constants/image_type'
-require 'smile-identity-core/constants/job_type'
+require_relative 'smile-identity-core/version'
+require_relative 'smile-identity-core/web_api'
+require_relative 'smile-identity-core/id_api'
+require_relative 'smile-identity-core/aml_check'
+require_relative 'smile-identity-core/signature'
+require_relative 'smile-identity-core/utilities'
+require_relative 'smile-identity-core/business_verification'
+require_relative 'smile-identity-core/constants/env'
+require_relative 'smile-identity-core/constants/image_type'
+require_relative 'smile-identity-core/constants/job_type'
 
 module SmileIdentityCore
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smile-identity-core
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.1
 platform: ruby
 authors:
 - Smile Identity
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/aml_check.rb
 - examples/biometric_kyc.rb
 - examples/business_verification.rb
 - examples/document_verification.rb
@@ -180,6 +181,7 @@ files:
 - examples/get_web_token.rb
 - examples/smart_selfie_authentication.rb
 - lib/smile-identity-core.rb
+- lib/smile-identity-core/aml_check.rb
 - lib/smile-identity-core/business_verification.rb
 - lib/smile-identity-core/constants/env.rb
 - lib/smile-identity-core/constants/image_type.rb
@@ -199,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
@@ -214,8 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.4.10
+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.