sumsub-ruby-sdk 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 507bfecc21b02884373eeaaf2ef76729711b710b348a7d6de2b289349b5cb1ae
-  data.tar.gz: e943a0860aa49188e629a87a43a8b09ecac65079cacd76e7ffb601c1b4d4aec9
+  metadata.gz: 9413196d575bbddc26d58047d48137b768f70aa7b257187073338b468c109068
+  data.tar.gz: 6a291133d2e3a5417ec4f83ca3f30f24130d2e2018f3d768e068345ecf20198d
 SHA512:
-  metadata.gz: 22eb29cf663da0995ae277ca39263b2c9e38a937c1b02a3ba7b750246b1292de7592ec336a772511555c34823e617506f8d4a9cc821560aed46dfc9be75695f7
-  data.tar.gz: 5a3c8f478845385fc6a6f326b9d13043d6dc20930a2353d555cd3853f9fa0f5118500e3b8bc43f42cb9d8aa9aaaabb358a65c91833590b12c0bca32e2e64d063
+  metadata.gz: bda4bb1f88238b57859559b6fcf740550b92225a0290b764a6c29560e6567da41fc5b994b9caac0ec5d273304108abc800d8da2fb5a4d536c2cf2553a75beebd
+  data.tar.gz: f36d963aae4ef9416227e85893fcb58369d40a9302916ddd74eeca8e2c532ada9608ac12296a7625525b8123f70f8607812ae8b54829ac9b63df63d08620bacc

data/.gitignore

@@ -1,3 +1,13 @@
+# See https://help.github.com/articles/ignoring-files
+# for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+*.gem
+*.rbc
+
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -10,4 +20,18 @@
 # rspec failure tracking
 .rspec_status
 
+# Other
 test_script
+
+# Environment normalization:
+/.bundle/
+/vendor/bundle/*
+!/vendor/bundle/.keep
+
+# For a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+/.ruby-version
+/.ruby-gemset
+
+# Unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+/.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+### 0.1.2
+  - An instance of `Sumsub::Request` returns now only the url without `/resources` (e.g., `sumsub.url` was `https://api.sumsub.com/resources` and now it is `https://api.sumsub.com`).
+
+### 0.1.3
+  - Require level name as argument in `get_access_token` of `Sumsub::Request`. This change makes the method compatible with the [recent updates in the Sumsub SDK](https://developers.sumsub.com/migrations/sdk.html#sdk-migration-guide).
+
+### 0.2.0
+  - General minor fixes (don't require dev gems in the production build, add extra ignored files in `.gitignore`, etc);
+  - Move the `require 'dry-struct'` to the `lib/sumsub.rb`, so we don't need to always require it in our structs;
+  - Add [`generate_external_link`](https://developers.sumsub.com/api-reference/additional-methods.html#generating-websdk-external-link-for-particular-user);
+  - Updated structs with new fields;
+  - Add `WebhookSender` with `get_payload` class method to format the payload before informing it to the `verify_webhook_sender` method (those strange string transformations are necessary in order to receive the right answer from Sumsub).

data/Gemfile.lock

@@ -1,36 +1,32 @@
 PATH
   remote: .
   specs:
-    sumsub-ruby-sdk (0.1.1)
-      dry-struct (~> 1.4.0)
-      http (~> 5.0.0)
-      mime-types (~> 3.3.1)
-      pry (~> 0.14.1)
-      rspec (~> 3.10.0)
-      timecop (~> 0.9.4)
-      webmock (~> 3.13.0)
+    sumsub-ruby-sdk (0.1.3)
+      dry-struct (~> 1.4)
+      http (>= 4.0)
+      mime-types (~> 3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dry-configurable (0.12.1)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.7.2)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
+    dry-inflector (0.2.1)
     dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
@@ -44,7 +40,7 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    ffi (1.15.0)
+    ffi (1.15.4)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -54,7 +50,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       llhttp-ffi (~> 0.0.1)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     ice_nine (0.11.2)
@@ -62,14 +58,14 @@ GEM
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
     method_source (1.0.0)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    mime-types-data (3.2021.1115)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    rake (13.0.3)
+    rake (13.0.6)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -83,23 +79,27 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     timecop (0.9.4)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
+    unf_ext (0.0.8)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
+  pry (~> 0.14)
   rake (~> 13.0)
   rspec (~> 3.0)
   sumsub-ruby-sdk!
+  timecop (~> 0.9)
+  webmock (~> 3.13)
 
 BUNDLED WITH
-   2.2.17
+   2.2.32

data/README.md

@@ -1,13 +1,13 @@
 # SumSub Ruby SDK
 
-This gem is an unnoficial SDK for the [SumSub API](https://developers.sumsub.com/api-reference/).
+This gem is an unofficial SDK for the [SumSub API](https://developers.sumsub.com/api-reference/).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sumsub-ruby-sdk', '~> 0.1.1', require: 'sumsub'
+gem 'sumsub-ruby-sdk', '~> 0.1.3', require: 'sumsub'
 ```
 
 And then execute:
@@ -16,7 +16,7 @@ And then execute:
 
 ## Configuration and Usage
 
-You can configure your credentials using `Sumsub::Configure` block. There are three keys you can inform: *token*, *secret_key* and *production*. The token and secret key you need to generate from your SumSub account, and *production* is a boolean value where you specify if you wanna use SumSub production or test environtment. To use the test environment, just set production as `false`.
+You can configure your credentials using `Sumsub::Configure` block. There are three keys you can inform: *token*, *secret_key* and *production*. The token and secret key you need to generate from your SumSub account, and *production* is a boolean value where you specify if you wanna use SumSub production or test environment. To use the test environment, just set production as `false`.
 
 ```ruby
 Sumsub.configure do |config|

data/lib/sumsub/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sumsub
   class Configuration
     attr_accessor :token, :secret_key, :production

data/lib/sumsub/message_signer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sumsub
   # https://developers.sumsub.com/api-reference/#signing-a-request
   class MessageSigner

data/lib/sumsub/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sumsub
   class Parser
     def self.parse(json_payload)

data/lib/sumsub/request.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Sumsub
   class Request
-    PRODUCTION_URL = "https://api.sumsub.com/resources"
-    TEST_URL = "https://test-api.sumsub.com/resources"
+    PRODUCTION_URL = "https://api.sumsub.com"
+    TEST_URL = "https://test-api.sumsub.com"
 
     attr_reader :url, :secret_key, :token
 
@@ -17,11 +19,11 @@ module Sumsub
 
     # API docs: https://developers.sumsub.com/api-reference/#creating-an-applicant
     # Sumsub::Struct::Applicant can be used as applicant.
-    def create_applicant(lvl_name, applicant)
-      resource = "applicants?levelName=#{lvl_name}"
+    def create_applicant(level_name, applicant)
+      resource = "applicants?levelName=#{level_name}"
       headers = build_header(resource, body: applicant.to_json)
       response = HTTP.headers(headers)
-                     .post("#{@url}/#{resource}", json: applicant)
+                     .post("#{@url}/resources/#{resource}", json: applicant)
       
       parse_response(response)
     end
@@ -61,7 +63,7 @@ module Sumsub
         content_type: 'multipart/form-data; boundary=' + boundary
       ).merge({ "X-Return-Doc-Warnings": true })
       response = HTTP.headers(headers)
-                     .post("#{@url}/#{resource}", body: body)
+                     .post("#{@url}/resources/#{resource}", body: body)
     
       parse_response(response)
     end
@@ -71,7 +73,7 @@ module Sumsub
       resource = "applicants/#{applicant_id}/requiredIdDocsStatus"
       headers = build_header(resource, method: 'GET')
       response = HTTP.headers(headers)
-                     .get("#{@url}/#{resource}")
+                     .get("#{@url}/resources/#{resource}")
 
       parse_response(response)
     end
@@ -83,7 +85,7 @@ module Sumsub
         "applicants/#{applicant_id}/one"
       headers = build_header(resource, method: 'GET')
       response = HTTP.headers(headers)
-                     .get("#{@url}/#{resource}")
+                     .get("#{@url}/resources/#{resource}")
 
       parse_response(response)
     end
@@ -93,7 +95,7 @@ module Sumsub
       resource = "applicants/#{applicant_id}/status"
       headers = build_header(resource, method: 'GET')
       response = HTTP.headers(headers)
-                     .get("#{@url}/#{resource}")
+                     .get("#{@url}/resources/#{resource}")
       
       parse_response(response)
     end
@@ -103,7 +105,7 @@ module Sumsub
       resource = "applicants/#{applicant_id}/status/pending?reason=#{reason}"
       headers = build_header(resource)
       response = HTTP.headers(headers)
-                     .post("#{@url}/#{resource}")
+                     .post("#{@url}/resources/#{resource}")
       
       parse_response(response)
     end
@@ -113,7 +115,7 @@ module Sumsub
       resource = "inspections/#{inspection_id}/resources/#{image_id}"
       headers = build_header(resource, method: 'GET')
       response = HTTP.headers(headers)
-                     .get("#{@url}/#{resource}")
+                     .get("#{@url}/resources/#{resource}")
 
       parse_response(response)
     end
@@ -123,7 +125,7 @@ module Sumsub
       resource = "applicants/#{applicant_id}/reset"
       headers = build_header(resource)
       response = HTTP.headers(headers)
-                     .post("#{@url}/#{resource}")
+                     .post("#{@url}/resources/#{resource}")
 
       parse_response(response)
     end
@@ -134,17 +136,28 @@ module Sumsub
       resource = "applicants/"
       headers = build_header(resource, method: 'PATCH', body: applicant_new_values.to_json)
       response = HTTP.headers(headers)
-                     .patch("#{@url}/#{resource}", json: applicant_new_values)
+                     .patch("#{@url}/resources/#{resource}", json: applicant_new_values)
 
       parse_response(response)
     end
 
     # API docs: https://developers.sumsub.com/api-reference/#access-tokens-for-sdks
-    def get_access_token(user_id, ttl_in_seconds: nil, external_action_id: nil)
-      resource = "accessTokens?userId=#{user_id}&ttlInSecs=#{ttl_in_seconds}&external_action_id=#{external_action_id}"
+    def get_access_token(user_id, level_name, ttl_in_seconds: nil, external_action_id: nil)
+      resource = "accessTokens?userId=#{user_id}&levelName=#{level_name}&ttlInSecs=#{ttl_in_seconds}&external_action_id=#{external_action_id}"
       headers = build_header(resource, method: 'POST')
       response = HTTP.headers(headers)
-                     .post("#{@url}/#{resource}")
+                     .post("#{@url}/resources/#{resource}")
+
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#testing-on-the-test-environment
+    # Sumsub::Struct::Applicant can be used as review_result.
+    def testing_on_test_environment(applicant_id, review_result)
+      resource = "applicants/#{applicant_id}/status/testCompleted"
+      headers = build_header(resource, body: review_result.to_json)
+      response = HTTP.headers(headers)
+                     .post("#{@url}/resources/#{resource}", json: review_result)
 
       parse_response(response)
     end
@@ -162,7 +175,19 @@ module Sumsub
       )
 
       response = HTTP.headers(headers)
-                     .post("#{@url}/#{resource}", body: payload)
+                     .post("#{@url}/resources/#{resource}", body: payload)
+
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/additional-methods.html#generating-websdk-external-link-for-particular-user
+    # Sumsub::Struct::Applicant can be used as body.
+    def generate_external_link(level_name, ttl_in_seconds, external_user_id, locale: nil, body: {})
+      resource = "sdkIntegrations/levels/#{level_name}/websdkLink?ttlInSecs=#{ttl_in_seconds}&externalUserId=#{external_user_id}&lang=#{locale}"
+      headers = build_header(resource, method: 'POST', body: body.to_json)
+
+      response = HTTP.headers(headers)
+                     .post("#{@url}/resources/#{resource}", json: body)
 
       parse_response(response)
     end
@@ -184,6 +209,7 @@ module Sumsub
         resource: resource, 
         body: body, 
         method: method,
+        secret_key: @secret_key,
       )
 
       {

data/lib/sumsub/struct/address.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Sumsub
   module Struct
     # https://developers.sumsub.com/api-reference/#addresses-elements-fields
     class Address < BaseStruct
-      include Types
-
       attribute? :country, Types::String
       attribute? :postCode, Types::String
       attribute? :town, Types::String

data/lib/sumsub/struct/applicant.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module Sumsub
   module Struct
     # https://developers.sumsub.com/api-reference/#request-body
     class Applicant < BaseStruct
-      include Types
-
       attribute :externalUserId, Types::Coercible::String
       attribute? :sourceKey, Types::String
       attribute? :email, Types::String
+      attribute? :phone, Types::String
       attribute? :lang, Types::String
       attribute? :metadata, Types::Array.of(Types::Hash)
       attribute? :info, Types::Instance(Sumsub::Struct::Info)

data/lib/sumsub/struct/applicant_update.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 module Sumsub
   module Struct
     # https://developers.sumsub.com/api-reference/#request-body-2
     class ApplicantUpdate < BaseStruct
-      include Types
-
       attribute :id, Types::String
       attribute? :externalUserId, Types::String
-      attribute? :sourceKey, Types::String
       attribute? :email, Types::String
+      attribute? :phone, Types::String
+      attribute? :sourceKey, Types::String
+      attribute? :type, Types::String
       attribute? :lang, Types::String
+      attribute? :questionnaires, Types::Array.of(Types::Hash)
       attribute? :metadata, Types::Array.of(Types::Hash)
-      attribute? :type, Types::String
+      attribute? :deleted, Types::Bool
     end
   end
 end

data/lib/sumsub/struct/base_struct.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Sumsub
+  include Types
+
   module Struct
     class BaseStruct < Dry::Struct
-      include Types
 
       def to_json
         attributes.to_json

data/lib/sumsub/struct/document_metadata.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Sumsub
   module Struct
     # https://developers.sumsub.com/api-reference/#request-metadata-body-part-fields
     class DocumentMetadata < BaseStruct
-      include Types
-
       attribute :idDocType, Types::IdDocTypes
-      attribute? :idDocSubType, Types::IdDocSubType
+      attribute? :idDocSubType, Types::IdDocSubTypes
       attribute :country, Types::String # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
       attribute? :firstName, Types::String
       attribute? :middleName, Types::String

data/lib/sumsub/struct/error_response.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Sumsub
   module Struct
     # https://developers.sumsub.com/api-reference/#response-body
     class ErrorResponse < BaseStruct
-      include Types
-
       attribute :description, Types::String.optional
       attribute :code, Types::Coercible::String.optional
       attribute :correlation_id, Types::Coercible::String.optional

data/lib/sumsub/struct/info.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Sumsub
   module Struct
     # https://developers.sumsub.com/api-reference/#fixedinfo-and-info-attributes
     class Info < BaseStruct
-      include Types
-
       attribute? :firstName, Types::String
       attribute? :lastName, Types::String
       attribute? :middleName, Types::String
@@ -18,7 +18,6 @@ module Sumsub
       attribute? :stateOfBirth, Types::String
       attribute? :country, Types::String
       attribute? :nationality, Types::String
-      attribute? :phone, Types::String     
       attribute? :addresses, Types::Array.of(Sumsub::Struct::Address)
     end
   end

data/lib/sumsub/struct/review_result.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sumsub
+  module Struct
+    # https://developers.sumsub.com/api-reference/#request-body-4
+    class ReviewResult < BaseStruct
+      attribute :reviewAnswer, Types::ReviewAnswers
+      attribute? :rejectLabels, Types::Array.of(Types::RejectLabels)
+      attribute? :reviewRejectType, Types::ReviewRejectTypes
+      attribute? :clientComment, Types::String
+      attribute? :moderationComment, Types::String
+    end
+  end
+end

data/lib/sumsub/struct/webhook_payload.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Sumsub
+  module Struct
+    # https://developers.sumsub.com/api-reference/#webhook-payload-attributes
+    class WebhookPayload < BaseStruct
+      attribute :applicantId, Types::String
+      attribute :inspectionId, Types::String
+      attribute :correlationId, Types::String
+      attribute :externalUserId, Types::String
+      attribute :type, Types::String
+      attribute :reviewStatus, Types::String
+      attribute :createdAt, Types::String
+      attribute? :applicantType, Types::String
+      attribute? :reviewResult, Types::Instance(Sumsub::Struct::ReviewResult)
+      attribute? :applicantMemberOf, Types::Array.of(Types::Hash)
+      attribute? :videoIdentReviewStatus, Types::String
+      attribute? :applicantActionId, Types::String
+      attribute? :externalApplicantActionId, Types::String
+      attribute :clientId, Types::String
+    end
+  end
+end

data/lib/sumsub/types.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Sumsub
+  module Types
+    include Dry.Types()
+
+    # https://developers.sumsub.com/api-reference/#supported-document-types
+    IdDocTypes = Types::Strict::Symbol
+      .constructor(&:to_sym)
+      .enum(
+        :ID_CARD,
+        :PASSPORT,
+        :DRIVERS, # Driving license
+        :RESIDENCE_PERMIT,
+        :UTILITY_BILL,
+        :SELFIE,
+        :VIDEO_SELFIE,
+        :PROFILE_IMAGE,
+        :ID_DOC_PHOTO,
+        :AGREEMENT,
+        :CONTRACT,
+        :DRIVERS_TRANSLATION,
+        :INVESTOR_DOC,
+        :VEHICLE_REGISTRATION_CERTIFICATE,
+        :INCOME_SOURCE, # Proof of income
+        :PAYMENT_METHOD,
+        :BANK_CARD,
+        :COVID_VACCINATION_FORM,
+        :OTHER,
+        nil,
+      )
+
+    # https://developers.sumsub.com/api-reference/#request-metadata-body-part-fields
+    IdDocSubTypes = Types::Strict::Symbol
+      .constructor(&:to_sym)
+      .enum(
+        :FRONT_SIDE,
+        :BACK_SIDE,
+        nil,
+      )
+
+    # https://developers.sumsub.com/api-reference/#getting-verification-results
+    ReviewAnswers = Types::Strict::Symbol
+      .constructor(&:to_sym)
+      .enum(
+        :GREEN,
+        :RED,
+      )
+
+    # https://developers.sumsub.com/api-reference/#getting-verification-results
+    RejectLabels = Types::Strict::Symbol
+      .constructor(&:to_sym)
+      .enum(
+        :FORGERY,
+        :DOCUMENT_TEMPLATE,
+        :LOW_QUALITY,
+        :SPAM,
+        :NOT_DOCUMENT,
+        :SELFIE_MISMATCH,
+        :ID_INVALID,
+        :FOREIGNER,
+        :DUPLICATE,
+        :BAD_AVATAR,
+        :WRONG_USER_REGION,
+        :INCOMPLETE_DOCUMENT,
+        :BLACKLIST,
+        :UNSATISFACTORY_PHOTOS,
+        :DOCUMENT_PAGE_MISSING,
+        :DOCUMENT_DAMAGED,
+        :REGULATIONS_VIOLATIONS,
+        :INCONSISTENT_PROFILE,
+        :PROBLEMATIC_APPLICANT_DATA,
+        :ADDITIONAL_DOCUMENT_REQUIRED,
+        :AGE_REQUIREMENT_MISMATCH,
+        :EXPERIENCE_REQUIREMENT_MISMATCH,
+        :CRIMINAL,
+        :WRONG_ADDRESS,
+        :GRAPHIC_EDITOR,
+        :DOCUMENT_DEPRIVED,
+        :COMPROMISED_PERSONS,
+        :PEP,
+        :ADVERSE_MEDIA,
+        :FRAUDULENT_PATTERNS,
+        :SANCTIONS,
+        :NOT_ALL_CHECKS_COMPLETED,
+        :FRONT_SIDE_MISSING,
+        :BACK_SIDE_MISSING,
+        :SCREENSHOTS,
+        :BLACK_AND_WHITE,
+        :INCOMPATIBLE_LANGUAGE,
+        :EXPIRATION_DATE,
+        :UNFILLED_ID,
+        :BAD_SELFIE,
+        :BAD_VIDEO_SELFIE,
+        :BAD_FACE_MATCHING,
+        :BAD_PROOF_OF_IDENTITY,
+        :BAD_PROOF_OF_ADDRESS,
+        :BAD_PROOF_OF_PAYMENT,
+        :SELFIE_WITH_PAPER,
+        :FRAUDULENT_LIVENESS,
+        :OTHER,
+        :REQUESTED_DATA_MISMATCH,
+        :OK,
+        :COMPANY_NOT_DEFINED_STRUCTURE,
+        :COMPANY_NOT_DEFINED_BENEFICIARIES,
+        :COMPANY_NOT_VALIDATED_BENEFICIARIES,
+        :COMPANY_NOT_DEFINED_REPRESENTATIVES,
+        :COMPANY_NOT_VALIDATED_REPRESENTATIVES,
+      )
+
+    # https://developers.sumsub.com/api-reference/#getting-verification-results
+    ReviewRejectTypes = Types::Strict::Symbol
+      .constructor(&:to_sym)
+      .enum(
+        :FINAL,
+        :RETRY,
+      )
+
+    # https://developers.sumsub.com/api-reference/#webhook-types
+    WebhookTypes = Types::Strict::Symbol
+      .constructor(&:to_sym)
+      .enum(
+        :applicantReviewed,
+        :applicantPending,
+        :applicantCreated,
+        :applicantOnHold,
+        :applicantPersonalInfoChanged,
+        :applicantPrechecked,
+        :applicantDeleted,
+        :videoIdentStatusChanged,
+        :applicantReset,
+        :applicantActionPending,
+        :applicantActionReviewed,
+        :applicantActionOnHold,
+      )
+  end
+end

data/lib/sumsub/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sumsub
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/sumsub/webhook_sender.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Sumsub
+  # https://developers.sumsub.com/api-reference/#verifying-webhook-sender
+  class WebhookSender
+    def self.get_payload(params)
+      JSON.pretty_generate(
+        params,
+        space_before: ' ',
+      )
+      .gsub("[\n      \"", "[ \"")
+      .gsub("\n    ]", " ]")
+    end
+  end
+end

data/lib/sumsub.rb

@@ -1,23 +1,36 @@
 # frozen_string_literal: true
 
+########
+# Gems #
+########
+
 require 'http'
-require 'types'
 require 'mime/types'
+require 'dry-struct'
+
+################
+# Own requires #
+################
+
+require 'sumsub/version'
 
-module Sumsub  
-  require 'sumsub/message_signer'
-  require 'sumsub/configuration'
-  require 'sumsub/parser'
-  require 'sumsub/request'
-  require 'sumsub/struct/base_struct'
-  require 'sumsub/struct/error_response'
-  require 'sumsub/struct/address'
-  require 'sumsub/struct/info'
-  require 'sumsub/struct/applicant'
-  require 'sumsub/struct/applicant_update'
-  require 'sumsub/struct/document_metadata'
-  require 'sumsub/version'
+require 'sumsub/types'
+require 'sumsub/message_signer'
+require 'sumsub/configuration'
+require 'sumsub/parser'
+require 'sumsub/request'
+require 'sumsub/webhook_sender'
+require 'sumsub/struct/base_struct'
+require 'sumsub/struct/error_response'
+require 'sumsub/struct/address'
+require 'sumsub/struct/info'
+require 'sumsub/struct/applicant'
+require 'sumsub/struct/applicant_update'
+require 'sumsub/struct/document_metadata'
+require 'sumsub/struct/review_result'
+require 'sumsub/struct/webhook_payload'
 
+module Sumsub
   class << self
     attr_accessor :configuration
   end

data/sumsub-ruby-sdk.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/rwehresmann/sumsub-ruby-sdk"
-  spec.metadata["changelog_uri"] = "https://github.com/rwehresmann/sumsub-ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/rwehresmann/sumsub-ruby-sdk/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,17 +29,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "http", ">= 4.0"
+  spec.add_dependency "dry-struct", "~> 1.4"
+  spec.add_dependency "mime-types", "~> 3.3"
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-
-  spec.add_dependency "http", "~> 5.0.0"
-  spec.add_dependency "dry-struct", "~> 1.4.0"
-  spec.add_dependency "rspec", "~> 3.10.0"
-  spec.add_dependency "pry", "~> 0.14.1"
-  spec.add_dependency "webmock", "~> 3.13.0"
-  spec.add_dependency "timecop", "~> 0.9.4"
-  spec.add_dependency "mime-types", "~> 3.3.1"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "webmock", "~> 3.13"
+  spec.add_development_dependency "timecop", "~> 0.9"
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: sumsub-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo W. Ehresmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
-  type: :runtime
+        version: '3.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
-  type: :runtime
+        version: '0.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
-  type: :runtime
+        version: '3.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.1
-  type: :runtime
+        version: '0.9'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '0.9'
 description: SDK written in Ruby to handle SumSub API.
 email:
 - igoehresmann@gmail.com
@@ -119,6 +119,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -138,8 +139,11 @@ files:
 - lib/sumsub/struct/document_metadata.rb
 - lib/sumsub/struct/error_response.rb
 - lib/sumsub/struct/info.rb
+- lib/sumsub/struct/review_result.rb
+- lib/sumsub/struct/webhook_payload.rb
+- lib/sumsub/types.rb
 - lib/sumsub/version.rb
-- lib/types.rb
+- lib/sumsub/webhook_sender.rb
 - sumsub-ruby-sdk.gemspec
 homepage: https://github.com/rwehresmann/sumsub-ruby-sdk
 licenses:
@@ -148,7 +152,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/rwehresmann/sumsub-ruby-sdk
   source_code_uri: https://github.com/rwehresmann/sumsub-ruby-sdk
-  changelog_uri: https://github.com/rwehresmann/sumsub-ruby-sdk
+  changelog_uri: https://github.com/rwehresmann/sumsub-ruby-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -164,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: SumSub Ruby SDK

data/lib/types.rb

@@ -1,39 +0,0 @@
-require 'dry-struct'
-
-module Types
-  include Dry.Types()
-
-  # https://developers.sumsub.com/api-reference/#supported-document-types
-  IdDocTypes = Types::Strict::Symbol
-    .constructor(&:to_sym)
-    .enum(
-      :ID_CARD,
-      :PASSPORT,
-      :DRIVERS, # Driving license
-      :BANK_CARD,
-      :UTILITY_BILL,
-      :BANK_STATEMENT,
-      :SELFIE,
-      :VIDEO_SELFIE,
-      :PROFILE_IMAGE,
-      :ID_DOC_PHOTO,
-      :AGREEMENT,
-      :CONTRACT,
-      :RESIDENCE_PERMIT,
-      :EMPLOYMENT_CERTIFICATE,
-      :DRIVERS_TRANSLATION, 
-      :INVESTOR_DOC,
-      :VEHICLE_REGISTRATION_CERTIFICATE,
-      :INCOME_SOURCE, # Proof of income
-      :PAYMENT_METHOD,
-      :OTHER,
-      nil,
-    )
-
-  IdDocSubType = Types::Strict::Symbol
-    .constructor(&:to_sym)
-    .enum(
-      :FRONT_SIDE,
-      :BACK_SIDE,
-    )
-end