smile-identity-core 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b08d29788e9df7942697da8ef9391fdc7200e5d31ac8b0e6520649d9051fbc0
-  data.tar.gz: 4e27841299e6c26392883a14d38a72ae104195df8cc06492bb27457198a96e89
+  metadata.gz: abb8ad5e4e436c109342eab8da6d4d24f497f5b3f7dca2ab368683b31a628624
+  data.tar.gz: 0d2c119d4d28d2ea8ef1b8e7ad96cf4293b64ae8fc6bb0399b0a7f198926a577
 SHA512:
-  metadata.gz: b08f43d9d9849048f18adb39ef3553c442cdf5aa2ccb4e77a97048df1b2b1a0b72a36fa2d8c0750e13177d9b7a2db987d7f3746c5218f771402da047721cc73b
-  data.tar.gz: febc9a1df0e0535fc93f3fc4d7562ee118f0f87031445da6ddc2ec2c91e5a9c52df27c05e8bc0e4db4377b81924e9f26e8b87b1594583e8554495923e898be54
+  metadata.gz: d6356d1c4f5b32060274bb87ab75959cc34b7bddb4446143ccecee1c62ef364c9825413ad8afb5725b23ade388b7861d0b0bdfc4c4499ca193bec2148d4ed846
+  data.tar.gz: 83be55109d9f4aa6bfb74278fd2c50dc4efe687aae53ef52fe85579dbde2d750ffd1765f6b73049f28b87e407b700a524129c671f771311f6f9a05278dfbd482

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: github-actions
+  directory: /
+  schedule:
+    interval: monthly
+    day: tuesday
+    time: '15:00'
+  groups:
+    github-actions:
+      patterns:
+      - '*'

data/.github/workflows/release.yml

@@ -10,7 +10,7 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         set-safe-directory: false
     - name: Release Gem

data/.rubocop.yml

@@ -1,9 +1,149 @@
+---
+
 require:
-  - rubocop-rake
-  - rubocop-rspec
+- rubocop-rake
+- rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/GemFilename:
+  Enabled: true
+
+Layout/ArgumentAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ArrayAlignment:
+  Enabled: true
+
+Layout/AssignmentIndentation:
+  Enabled: true
+
+Layout/BlockAlignment:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/ConditionPosition:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/EndAlignment:
+  Enabled: true
+
+Layout/EndOfLine:
+  Enabled: true
+
+Layout/ExtraSpacing:
+  Enabled: true
+  ForceEqualSignAlignment: false
+  AllowForAlignment: false
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: true
+
+Layout/IndentationConsistency:
+  Enabled: true
+
+Layout/IndentationStyle:
+  Enabled: true
+
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingEmptyLines:
+  Enabled: true
+
+Layout/MultilineBlockLayout:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
 
 Metrics/AbcSize:
   Max: 30
@@ -24,7 +164,8 @@ Naming/FileName:
   Enabled: false
 
 RSpec/ExampleLength:
-  Enabled: false
+  Enabled: true
+  Max: 150
 
 RSpec/FilePath:
   Enabled: false
@@ -33,13 +174,45 @@ RSpec/InstanceVariable:
   Enabled: false
 
 RSpec/MultipleExpectations:
-  Enabled: false
+  Enabled: true
+  Max: 10
 
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
-  
+
 RSpec/NestedGroups:
-  Enabled: false
+  Enabled: true
+  Max: 4
 
-RSpec/RepeatedExampleGroupDescription:
+RSpec/NoExpectationExample:
   Enabled: false
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantCondition:
+  Enabled: true
+
+Style/RedundantInterpolation:
+  Enabled: true
+
+Style/RedundantParentheses:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,125 +1,145 @@
 # Changelog
 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/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.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.3.0] - 2024-12-10
+### Added
+- Support for Address verification 
+
+## [2.2.5] - 2024-06-11
+### Fixed
+- No changes, fixed deployment issue
+
+## [2.2.4] - 2024-06-10
+### Added
+- Enhanced `strict_match` functionality in AML
+
+### Changed
+- Linted the project with internal RuboCop rules
+
+### Fixed
+- Removed support for Ruby 2.5 in RuboCop configuration and the gemspec file
+
+## [2.2.3] - 2023-10-20
+### Added
+- Support for Enhanced Document Verification
 
 ## [2.2.2] - 2023-10-05
 ### Changed
-- Lint project. Enforce rubocop rules via github action
+- Lint project. Enforce RuboCop rules via GitHub action
 
-## Added
-Support Ruby 3.2
+### Added
+- Support for 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
+- Removed the validation of `id_type` and `id_number` for Document Verification jobs
 
 ## [2.2.0] - 2023-04-05
 ### Added
-- Adds support for AML check
+- Support for AML check
+
 ### Changed
-- Fix business verification docstrings
+- Fixed business verification docstrings
 
 ## [2.1.2] - 2023-03-09
 ### Changed
-- Fix `get_web_token` by ensuring signature merges to request_params
+- Fixed `get_web_token` by ensuring signature merges into request_params
 
 ## [2.1.1] - 2022-12-13
 ### Added
-- Adds UPDATE_PHOTO and COMPARE_USER_INFO to JobType
+- UPDATE_PHOTO and COMPARE_USER_INFO to JobType
+
 ### Changed
-- Fix wrong constant values for JobType SMART_SELFIE_AUTHENTICATION and SMART_SELFIE_REGISTRATION
+- Fixed incorrect constant values for JobType SMART_SELFIE_AUTHENTICATION and SMART_SELFIE_REGISTRATION
 
-# [2.1.0] - 2022-10-28
-## Changed
+## [2.1.0] - 2022-10-28
+### Changed
 - Moved Business verification to IDApi
 
-# [2.0.0] - 2022-10-24
+## [2.0.0] - 2022-10-24
 ### Added
-- build: Adds support for ruby 3.1
-- docs: adds "examples" folder
-- Adds Business Verification product
+- Support for Ruby 3.1
+- "Examples" folder in documentation
+- 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::ImageType, SMILE_IDENTITY_CORE::JobType
-- Fixes invalid links in gemspec
+- Transition from TravisCI to GitHub Actions
+- Enforced the use of signature on all API calls
+- Added helper constants SMILE_IDENTITY_CORE::ENV, SMILE_IDENTITY_CORE::ImageType, SMILE_IDENTITY_CORE::JobType
+- Fixed invalid links in gemspec
 
 ### Removed
-- build: Drops support for ruby 2.5.1
-- core: Removes support for `sec_key` as an authentication method
-  
+- Support for Ruby 2.5.1
+- `sec_key` as an authentication method
+
 ## [1.2.1] - 2021-12-02
 ### Changed
-- Revert changes to version SmileIdentityCore.version_as_hash
-- Uses hard coded apiVersion
+- Reverted changes to version SmileIdentityCore.version_as_hash
+- Used hardcoded apiVersion
 
 ## [1.2.0] - 2021-10-08
 ### Added
-- Add Signature option for signing requests
+- Signature option for signing requests
 
 ## [1.1.0] - 2021-09-29
-Set version information from SmileIdentityCore.version_as_hash
-- Change the urls for both test and prod aa55a72d10854f05a35db4dad3ea63930e8996f6
+### Added
+- Version information from SmileIdentityCore.version_as_hash
+- Changed URLs for both test and production environments
 
 ## [1.0.2] - 2020-01-16
-Add {"success":true,"smile_job_id":"job_id"} to the response when we poll job status too
+### Added
+- {"success":true,"smile_job_id":"job_id"} to the response when polling job status
 
 ## [1.0.1] - 2019-10-24
-## Updated
-Remove first_name and last_name validations from id information in Web Api
-Add country, id_number and id_type validations for id information in ID Api
+### Updated
+- Removed first_name and last_name validations from ID information in Web API
+- Added country, id_number, and id_type validations for ID information in ID API
 
 ## [1.0.0] - 2019-10-11
-## Updated
-Amend the success response when job status is false to be a JSON String containing {"success":true,"smile_job_id":"job_id"}
-Add the ID API Class
-Add the ability to query ID Api from the Web API class
-Update the documentation
+### Updated
+- Amended the success response when job status is false to be a JSON String containing {"success":true,"smile_job_id":"job_id"}
+- Added the ID API Class
+- Added the ability to query ID API from the Web API class
+- Updated the documentation
 
 ## [0.2.3] - 2019-09-17
 ### Changed
-- Lenient Decoding of the api key
+- Lenient decoding of the API key
 
 ## [0.2.2] - 2019-09-17
 ### Added
-- Add the language to the package information
+- Language to the package information
 
 ## [0.2.1] - 2019-09-05
-
 ### Added
-- Accept more formats as inputs
-- Use the signature class in the Web API class
-- Add a Utilities class with get_job_status that we use internally to expose a public get_job_status method on WebApi
+- Support for additional formats as inputs
+- Usage of the signature class in the Web API class
+- Utilities class with a public `get_job_status` method on WebApi
 
 ### Updated
-- Updates to the readme
-- Update some error messages
+- Readme updates
+- Updated some error messages
 
 ### Fixed
-- Fix the loss of optional_callback
-- Ensure that we allow nil inputs or empty hashes for options and id_info
-- Confirm the signature when querying the job status
+- Issue with the loss of optional_callback
+- Ensured allowance for nil inputs or empty hashes for options and id_info
+- Confirmation of signature when querying job status
 
 ## [0.2.0] - 2019-08-14
 ### Added
-- Introduced return_history and image_links
+- Return_history and image_links features
 
 ### Removed
-- Removed two parameters: optional_callback and return_job_status in the submit_job function in favour of an options hash.
+- Two parameters: optional_callback and return_job_status in the submit_job function in favor of an options hash
 
 ## [0.1.1] - 2019-07-23
 ### Added
-- Some package configurations were added.
+- Additional package configurations
 
 ## [0.1.0] - 2019-07-19
 ### Added
-- The first release version of Web Api.
+- The first release version of Web API

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (2.2.3)
+    smile-identity-core (2.3.0)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -21,7 +21,7 @@ GEM
     rainbow (3.1.1)
     rake (12.3.3)
     regexp_parser (2.6.0)
-    rexml (3.2.5)
+    rexml (3.3.9)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)

data/README.md

@@ -2,7 +2,7 @@
 
 Smile Identity provides the best solutions for real time Digital KYC, identity verification, user onboarding, and user authentication across Africa. Our server side libraries make it easy to integrate us on the server-side. Since the library is server-side, you will be required to pass the images (if required) to the library.
 
-If you haven’t already, [sign up for a free Smile Identity account](https://www.smileidentity.com/schedule-a-demo/), which comes with Sandbox access.
+If you haven’t already, [sign up for a free Smile Identity account](https://usesmileid.com/talk-to-an-expert/), which comes with Sandbox access.
 
 Please see [CHANGELOG.md](CHANGELOG.md) for release versions and changes.
 
@@ -12,12 +12,12 @@ The library exposes four classes namely; the WebApi class, the IDApi class, the
 
 The WebApi class has the following public methods:
 
-- `submit_job` - handles submission of any of Smile Identity products that requires an image i.e. [Biometric KYC](https://docs.smileidentity.com/products/biometric-kyc), [Document Verification](https://docs.smileidentity.com/products/document-verification), [SmartSelfieTM Authentication](https://docs.smileidentity.com/products/biometric-authentication) and [Business Verification](https://docs.smileidentity.com/products/for-businesses-kyb/business-verification).
-- `get_web_token` - handles generation of web token, if you are using the [Hosted Web Integration](https://docs.smileidentity.com/web-mobile-web/web-integration-beta).
+- `submit_job` - handles submission of any of Smile Identity products that requires an image i.e. [Biometric KYC](https://docs.usesmileid.com/products/biometric-kyc), [Document Verification](https://docs.usesmileid.com/products/document-verification), [SmartSelfieTM Authentication](https://docs.usesmileid.com/products/biometric-authentication) and [Business Verification](https://docs.usesmileid.com/products/for-businesses-kyb/business-verification).
+- `get_web_token` - handles generation of web token, if you are using the [Hosted Web Integration](https://docs.usesmileid.com/web-mobile-web/web-integration-beta).
 
 The IDApi class has the following public method:
 
-- `submit_job` - handles submission of [Enhanced KYC](https://docs.smileidentity.com/products/identity-lookup) and [Basic KYC](https://docs.smileidentity.com/products/id-verification).
+- `submit_job` - handles submission of [Enhanced KYC](https://docs.usesmileid.com/products/identity-lookup) and [Basic KYC](https://docs.usesmileid.com/products/id-verification).
 
 The Signature class has the following public methods:
 
@@ -26,7 +26,7 @@ The Signature class has the following public methods:
 
 The Utilities Class allows you as the Partner to have access to our general Utility functions to gain access to your data. It has the following public methods:
 
-- `get_job_status` - retrieve information & results of a job. Read more on job status in the [Smile Identity documentation](https://docs.smileidentity.com/further-reading/job-status).
+- `get_job_status` - retrieve information & results of a job. Read more on job status in the [Smile Identity documentation](https://docs.usesmileid.com/further-reading/job-status).
 
 ## Installation
 
@@ -52,13 +52,13 @@ gem install smile-identity-core
 
 ## Documentation
 
-For extensive instructions on usage of the library and sample codes, please refer to the official Smile Identity [documentation](https://docs.smileidentity.com/server-to-server/ruby).
+For extensive instructions on usage of the library and sample codes, please refer to the official Smile Identity [documentation](https://docs.usesmileid.com/server-to-server/ruby).
 
 Before that, you should take a look at the examples in the [examples](/examples) folder.
 
 ## Getting Help
 
-For usage questions, the best resource is [our official documentation](https://docs.smileidentity.com). However, if you require further assistance, you can file a [support ticket via our portal](https://portal.smileidentity.com/partner/support/tickets) or visit the [contact us page](https://portal.smileidentity.com/partner/support/tickets) on our website.
+For usage questions, the best resource is [our official documentation](https://docs.usesmileid.com). However, if you require further assistance, you can file a [support ticket via our portal](https://portal.usesmileid.com/partner/support/tickets) or visit the [contact us page](https://portal.usesmileid.com/partner/support/tickets) on our website.
 
 ## Contributing
 

data/examples/address_verification.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+# See https://docs.usesmileid.com/products/for-individuals-kyc/address-verification for
+# more information on address 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
+
+# Array of example cases for different countries
+example_cases = [
+  {
+    description: 'Example for South Africa (ZA)',
+    request_params: {
+      country: 'ZA', # (Required) Must be 'NG' or 'ZA'.
+      address: 'Cape Town', # (Required) A valid and complete address.
+      id_number: '1234567891234', # (Required for ZA) The 13-digit national ID number.
+      full_name: 'Doe Joe Leo', # (Optional) Full name for additional verification.
+      callback_url: 'https://webhook.site', # (Required) Callback URL for the response.
+    },
+  },
+  {
+    description: 'Example for Nigeria (NG)',
+    request_params: {
+      country: 'NG', # (Required) Must be 'NG' or 'ZA'.
+      address: 'Lagos', # (Required) A valid and complete address.
+      utility_number: '12345678911', # (Required for NG) Utility account number.
+      utility_provider: 'IkejaElectric', # (Required for NG) Utility provider name.
+      full_name: 'John Doe', # (Optional) Full name for additional verification.
+      callback_url: 'https://webhook.site', # (Required) Callback URL for the response.
+    },
+  },
+]
+
+# Create a connection object
+connection = SmileIdentityCore::AddressVerification.new(partner_id, api_key, sid_server)
+
+# Loop through the example cases and make requests
+example_cases.each do |example|
+  puts example[:description]
+  response = connection.submit_job(example[:request_params])
+  pp response
+end

data/examples/aml_check.rb

@@ -2,7 +2,7 @@
 
 require 'smile-identity-core'
 require 'securerandom'
-# See https://docs.smileidentity.com/products/for-individuals-kyc/aml-check for
+# See https://docs.usesmileid.com/products/for-individuals-kyc/aml-check for
 # more information on business verification
 
 # Initialize
@@ -18,7 +18,8 @@ request_params = {
   full_name: 'John Leo Doe',
   countries: ['US'],
   birth_year: '1984', # yyyy
-  search_existing_user: false
+  search_existing_user: false,
+  strict_match: true, # optional - default is true
 }
 
 # Submit the job

data/examples/biometric_kyc.rb

@@ -2,7 +2,7 @@
 
 require 'smile-identity-core'
 
-# See https://docs.smileidentity.com/server-to-server/ruby/products/biometric-kyc for
+# See https://docs.usesmileid.com/server-to-server/ruby/products/biometric-kyc for
 # how to setup and retrieve configuation values for the WebApi class.
 
 # Initialize
@@ -17,7 +17,7 @@ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key
 partner_params = {
   user_id: '<put your unique ID for the user here>',
   job_id: '<put your unique job ID here>',
-  job_type: 1
+  job_type: 1,
 }
 
 # Create image list
@@ -29,13 +29,13 @@ partner_params = {
 image_details = [
   {
     image_type_id: '<0 | 2>',
-    image: '<full path to selfie image or base64image string>'
+    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: '<full path to liveness image or base64 image string>',
+  },
 ]
 
 # Create ID number info
@@ -46,7 +46,7 @@ id_info = {
   id_type: '<id type>',
   id_number: '<valid id number>',
   dob: '<date of birth>', # yyyy-mm-dd
-  entered: 'true' # must be a string
+  entered: 'true', # must be a string
 }
 
 # Set options for the job
@@ -60,7 +60,7 @@ options = {
   # 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
+  signature: true,
 }
 
 # Submit the job

data/examples/business_verification.rb

@@ -2,7 +2,7 @@
 
 require 'smile-identity-core'
 require 'securerandom'
-# See https://docs.smileidentity.com/products/for-businesses-kyb/business-verification for
+# See https://docs.usesmileid.com/products/for-businesses-kyb/business-verification for
 # more information on business verification
 
 # Initialize
@@ -17,7 +17,7 @@ connection = SmileIdentityCore::IDApi.new(partner_id, default_callback, api_key,
 partner_params = {
   job_id: '<put your unique job ID here>',
   user_id: '<put your unique ID for the user here>',
-  job_type: SmileIdentityCore::JobType::BUSINESS_VERIFICATION
+  job_type: SmileIdentityCore::JobType::BUSINESS_VERIFICATION,
 }
 
 # Create ID info
@@ -35,7 +35,7 @@ id_info = {
   # 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>'
+  postal_code: '<postal code>',
 }
 
 # Set the options for the job