smile-identity-core 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84fcac3562348da2011a2ccb7d84c2ca44ae2927284212f3430dbc164bd1a704
-  data.tar.gz: 487c49c050a929a5339bc8dccbc44d3b117eca7af717d7a73e0fe6303a86608d
+  metadata.gz: cfb7b18b264e3489d0e51f3f9cae6c8557ef535fbf3b348e6b843695c748d76f
+  data.tar.gz: 0f1c92749d1a139f02bd8216136eab00842d718425e45a5ffbe7174a69d1cf8a
 SHA512:
-  metadata.gz: afda841be8343b9c9708e08e2fefc57e384ef5e6adc3223f1b173371199dbdeba68a8a9bbbf89f5ece247c607ecb3f7b614f1ad973ecffc537443c59fe102e30
-  data.tar.gz: 9f7b159ca49672cae6a81d6e6ce76259d5582592ee8b9bb924747161b7c829e562a866f9365d7774544790074bd5c96c1bde5566b41fb3765e4863839f2f428a
+  metadata.gz: 3d66bd0c015e777468b738e58116219ae48dfa99a98ef2b8a8d53abe2c7d6cc07804e23316aeb39aa0affc1c8be03307d4378c088831e37bb5084910d180713c
+  data.tar.gz: 5eec195935a7fbd2eaf0f85930f8ebbe5578a6be874ff7288b7cc43c120cae9e2666f40eaf043245824657bee3988a4deda19fc93fd59f35def7bb60430454ab

data/CHANGELOG.md

@@ -6,16 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.1] - 2022-12-13
+### Added
+- Adds UPDATE_PHOTO and COMPARE_USER_INFO to JobType
+### Changed
+- Fix wrong constant values for JobType SMART_SELFIE_AUTHENTICATION and SMART_SELFIE_REGISTRATION
+
+# [2.1.0] - 2022-10-28
+## Changed
+- Moved Business verification to IDApi
+
 # [2.0.0] - 2022-10-24
 ### Added
 - build: Adds support for ruby 3.1
 - docs: adds "examples" folder
-- Adds Business Verfication product
+- Adds Business Verification product
 
 ### Changed
 - ci: Move from TravisCI to Github Actions
 - core: Enforces the use of signature on all API calls
-- core: Adds helper constants SMILE_IDENTITY_CORE::ENV, SMILE_IDENTITY_CORE::IMAGE_TYPE, SMILE_IDENTITY_CORE::JOB_TYPE
+- core: Adds helper constants SMILE_IDENTITY_CORE::ENV, SMILE_IDENTITY_CORE::ImageType, SMILE_IDENTITY_CORE::JobType
 - Fixes invalid links in gemspec
 
 ### Removed

data/Gemfile.lock

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

data/examples/business_verification.rb

@@ -11,12 +11,12 @@ 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)
+connection = SmileIdentityCore::IDApi.new(partner_id, default_callback, api_key, sid_server)
 
 # Create required tracking parameters
 partner_params = {
-  job_id: "job-#{SecureRandom.uuid}",
-  user_id: "user-#{SecureRandom.uuid}",
+  job_id: '<put your unique job ID here>',
+  user_id: '<put your unique ID for the user here>',
   job_type: SmileIdentityCore::JobType::BUSINESS_VERIFICATION
 }
 
@@ -25,13 +25,21 @@ id_info = {
   # The country where ID document was issued
   country: '<2-letter country code>',
   # The ID document type
+  # Available types BASIC_BUSINESS_REGISTRATION, BUSINESS_REGISTRATION and TAX_INFORMATION
   id_type: '<id type>',
   # The business registration or tax number
-  id_number: '<id number>',
+  id_number: '0000000',
   # The business incorporation type bn - business name, co - private/public limited, it - incorporated trustees
   # Only required for BASIC_BUSINESS_REGISTRATION and BUSINESS_REGISTRATION in Nigeria
-  business_type: '<co | bn | it>'
+  business_type: 'co',
+  # Postal address of business. Only Required for BUSINESS_REGISTRATION in Kenya
+  postal_address: '<postal address>',
+  # Postal code of business. Only Required for BUSINESS_REGISTRATION in Kenya
+  postal_code: '<postal code>'
 }
 
+# Set the options for the job
+options = {}
+
 # Submit the job
-connection.submit_job(partner_params, [], id_info, {})
+connection.submit_job(partner_params, id_info, options)

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

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'base64'
-require 'openssl'
-require 'uri'
 require 'typhoeus'
 require_relative 'validations'
 

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

@@ -2,12 +2,25 @@
 
 module SmileIdentityCore
   module JobType
+    # Compares a selfie to a selfie on file.
     BIOMETRIC_KYC = 1
-    SMART_SELFIE_REGISTRATION = 2
-    SMART_SELFIE_AUTHENTICATION = 4
+    # Compares a selfie to a selfie on file.
+    SMART_SELFIE_AUTHENTICATION = 2
+    # Creates an enrollee, associates a selfie with a partner_id, user_id
+    SMART_SELFIE_REGISTRATION = 4
+    # Verifies identity information of a person with their personal
+    # information and ID number from one of our supported ID Types.
     BASIC_KYC = 5
+    # Queries Identity Information of user using ID_number.
     ENHANCED_KYC = 5
+    # Verifies user info retrieved from the ID issuing authority.
     DOCUMENT_VERIFICATION = 6
+    # Verifies authenticity of Document IDs, confirms it's linked to the user
+    # using facial biometrics.
     BUSINESS_VERIFICATION = 7
+    # Updates the photo on file for an enrolled user
+    UPDATE_PHOTO = 8
+    # Compares document verification to an id check
+    COMPARE_USER_INFO = 9
   end
 end

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

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'validations'
+
 module SmileIdentityCore
   # Allows you to query the Identity Information for an individual using their ID number
   class IDApi
+    include Validations
+
+    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
@@ -15,47 +21,23 @@ module SmileIdentityCore
     end
 
     def submit_job(partner_params, id_info, options = {})
-      self.partner_params = symbolize_keys partner_params
-      self.id_info = symbolize_keys id_info
-      options = symbolize_keys(options || {})
-      @use_async_endpoint = options.fetch(:async, false)
+      @partner_params = validate_partner_params(symbolize_keys(partner_params))
+      @id_info = validate_id_info(symbolize_keys(id_info), REQUIRED_ID_INFO_FIELD)
 
-      if @partner_params[:job_type].to_i != 5
-        raise ArgumentError, 'Please ensure that you are setting your job_type to 5 to query ID Api'
+      unless [JobType::ENHANCED_KYC, JobType::BUSINESS_VERIFICATION].include?(@partner_params[:job_type].to_i)
+        raise ArgumentError, 'Please ensure that you are setting your job_type to 5 or 7 to query ID Api'
       end
 
-      setup_requests
-    end
-
-    def partner_params=(partner_params)
-      raise ArgumentError, 'Please ensure that you send through partner params' if partner_params.nil?
-
-      raise ArgumentError, 'Partner params needs to be a hash' unless partner_params.is_a?(Hash)
-
-      %i[user_id job_id job_type].each do |key|
-        if partner_params[key].to_s.empty?
-          raise ArgumentError,
-                "Please make sure that #{key} is included in the partner params"
-        end
+      if partner_params[:job_type] == JobType::BUSINESS_VERIFICATION
+        return SmileIdentityCore::BusinessVerification
+               .new(@partner_id, @api_key, @url)
+               .submit_job(partner_params, id_info)
       end
 
-      @partner_params = partner_params
-    end
-
-    def id_info=(id_info)
-      updated_id_info = id_info
-
-      if updated_id_info.nil? || updated_id_info.keys.length.zero?
-        raise ArgumentError, 'Please make sure that id_info not empty or nil'
-      end
-
-      %i[country id_type id_number].each do |key|
-        unless updated_id_info[key] && !updated_id_info[key].nil? && !updated_id_info[key].empty?
-          raise ArgumentError, "Please make sure that #{key} is included in the id_info"
-        end
-      end
+      options = symbolize_keys(options || {})
+      @use_async_endpoint = options.fetch(:async, false)
 
-      @id_info = updated_id_info
+      setup_requests
     end
 
     private

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

@@ -18,7 +18,7 @@ module SmileIdentityCore
     end
 
     def validate_id_info(id_info, required_id_info_fields)
-      raise ArgumentError, 'Please make sure that id_info not empty or nil' if id_info.nil? || id_info.empty?
+      raise ArgumentError, 'Please make sure that id_info is not empty or nil' if id_info.nil? || id_info.empty?
 
       raise ArgumentError, 'Id info needs to be a hash' unless id_info.is_a?(Hash)
 

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

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

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

@@ -25,14 +25,9 @@ module SmileIdentityCore
 
     def submit_job(partner_params, images, id_info, options)
       self.partner_params = symbolize_keys partner_params
-      if @partner_params[:job_type].to_i == JobType::ENHANCED_KYC
-        return SmileIdentityCore::IDApi.new(@partner_id, @api_key, @sid_server).submit_job(partner_params, id_info)
-      end
 
-      if @partner_params[:job_type].to_i == JobType::BUSINESS_VERIFICATION
-        return SmileIdentityCore::BusinessVerification.new(@partner_id, @api_key, @sid_server).submit_job(
-          partner_params, id_info
-        )
+      if [JobType::ENHANCED_KYC, JobType::BUSINESS_VERIFICATION].include?(@partner_params[:job_type].to_i)
+        return SmileIdentityCore::IDApi.new(@partner_id, @api_key, @sid_server).submit_job(partner_params, id_info)
       end
 
       self.images = images

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smile-identity-core
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Smile Identity
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -213,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: The Smile Identity Web API allows the user to access\ most of the features