smile-identity-core 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfb7b18b264e3489d0e51f3f9cae6c8557ef535fbf3b348e6b843695c748d76f
-  data.tar.gz: 0f1c92749d1a139f02bd8216136eab00842d718425e45a5ffbe7174a69d1cf8a
+  metadata.gz: 1cd1f7ec1f9a1c9418ce0e3d5501eb8e32fcfaf029da9b9188145a16dbbdf70b
+  data.tar.gz: 4bb53eafd0b561c05599a33fda6450099ab7208d1800a7ed19f5f304745e9985
 SHA512:
-  metadata.gz: 3d66bd0c015e777468b738e58116219ae48dfa99a98ef2b8a8d53abe2c7d6cc07804e23316aeb39aa0affc1c8be03307d4378c088831e37bb5084910d180713c
-  data.tar.gz: 5eec195935a7fbd2eaf0f85930f8ebbe5578a6be874ff7288b7cc43c120cae9e2666f40eaf043245824657bee3988a4deda19fc93fd59f35def7bb60430454ab
+  metadata.gz: fd09fe7c7e6117497dada79d8132eae2b08e58fd36def75626cd8883f151138d54868c16eb3b5ad5f45977c5d0fe6c1e01e9184350d8147bde3dee6513da0ea2
+  data.tar.gz: b442ba3c424a3d0eaf5f2fedba6596825da09053bf4d4a9221d8999c5e18c7359dde3c8abc2db6f23154d0e306cf220aa654a4ad3e4c1d9afe5fcb34f5e1038e

data/.github/workflows/release.yml

@@ -11,6 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
+      with:
+        set-safe-directory: false
     - name: Release Gem
       uses: cadwallion/publish-rubygems-action@master
       env:

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
 ## [2.1.1] - 2022-12-13
 ### Added
 - Adds UPDATE_PHOTO and COMPARE_USER_INFO to JobType

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (2.1.1)
+    smile-identity-core (2.2.0)
       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/examples/get_web_token.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+require 'random/formatter'
+
+# See https://docs.smileidentity.com/server-to-server/ruby/products/biometric-kyc 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)
+
+# Set up request payload
+request_params = {
+  user_id: '<your unique user id>',
+  job_id: '<your unique job id>',
+  product: '<smile identity product type>',
+  callback_url: '<your callback url>'
+}
+
+# Get web token
+connection.get_web_token(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.1'
+  VERSION = '2.2.0'
   SOURCE_SDK = 'Ruby'
 end

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

@@ -129,9 +129,9 @@ module SmileIdentityCore
     private
 
     def request_web_token(request_params)
-      request_params
+      request_params = request_params
         .merge(SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(Time.now.to_s))
-        .merge!(
+        .merge(
           { partner_id: @partner_id,
             source_sdk: SmileIdentityCore::SOURCE_SDK,
             source_sdk_version: SmileIdentityCore::VERSION }

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.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Smile Identity
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-04-05 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
@@ -177,8 +178,10 @@ files:
 - examples/example-project/README.md
 - examples/example-project/sample.env
 - examples/example-project/smart_bank.rb
+- 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
@@ -213,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+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