sumsub-ruby-sdk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 507bfecc21b02884373eeaaf2ef76729711b710b348a7d6de2b289349b5cb1ae
+  data.tar.gz: e943a0860aa49188e629a87a43a8b09ecac65079cacd76e7ffb601c1b4d4aec9
+SHA512:
+  metadata.gz: 22eb29cf663da0995ae277ca39263b2c9e38a937c1b02a3ba7b750246b1292de7592ec336a772511555c34823e617506f8d4a9cc821560aed46dfc9be75695f7
+  data.tar.gz: 5a3c8f478845385fc6a6f326b9d13043d6dc20930a2353d555cd3853f9fa0f5118500e3b8bc43f42cb9d8aa9aaaabb358a65c91833590b12c0bca32e2e64d063

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:3.0.1
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.2.17
+            bundle install
+            bundle exec rake

data/.editorconfig

@@ -0,0 +1,20 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Set default charset
+charset = utf-8
+
+# General identation style
+[*]
+indent_style = space
+indent_size = 2
+
+# Makefile's only accept tab identations
+[Makefile]
+indent_style = tab
+indent_size = 2

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+test_script

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sumsub-ruby-sdk.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,105 @@
+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)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    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)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      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-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (5.0.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.0.1)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    ice_nine (0.11.2)
+    llhttp-ffi (0.0.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    timecop (0.9.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sumsub-ruby-sdk!
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Rodrigo W. Ehresmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# SumSub Ruby SDK
+
+This gem is an unnoficial 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'
+```
+
+And then execute:
+
+    $ bundle install
+
+## 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`.
+
+```ruby
+Sumsub.configure do |config|
+  config.token = your_token
+  config.secret_key = your_secret_key
+  config.production = false # is true by default
+end
+```
+
+Use the `Sumsub::Request` to call the methods that access SumSub API endpoints. Check it out the [implemented methods](https://github.com/rwehresmann/sumsub-ruby-sdk/blob/master/lib/sumsub/request.rb) to know what is already available to be used.
+
+For requests where you need to inform full objects in the request's body, `Sumsub::Struct` have some models you can use to easily fill the necessary data for the request. Check it out the models available [here](https://github.com/rwehresmann/sumsub-ruby-sdk/tree/master/lib/sumsub/struct). 
+
+**Note:** To use `Sumsub::Struct` or not is up to you. A simple [ruby hash](https://ruby-doc.org/core-3.0.1/Hash.html) is a viable option too. Under the hood we call `to_json` to serialize it, so just ensure that this method is available and does what we expect of him: transform your object in a json string.
+
+Usage example:
+
+An applicant is an user that will go into the KYC process. 
+
+- Create the applicant;
+- Add an ID document to it;
+- Retrieve the current applicant's status.
+
+```ruby
+request = Sumsub::Request.new
+
+# If you didn't set your configurations on Sumsub.configure block,
+# you have the option to inform it in the Request constructor, like this:
+#
+# request = Sumsub::Request.new(
+#   token: your_token, 
+#   secret_key: your_secret_key,
+#   production: false
+# )
+
+applicant = Sumsub::Struct::Applicant.new(
+  externalUserId: 'appt20', 
+  email: 'grivia@mail.com'
+)
+
+response = request.create_applicant('basic-kyc-level', applicant)
+
+applicant_id = response['id']
+
+metadata = Sumsub::Struct::DocumentMetadata.new(
+  idDocType: 'ID_CARD',
+  country: 'BRA'
+)
+
+request.add_id_doc(
+  applicant_id, 
+  metadata,
+  file_path: 'home/myself/Pictures/id_card.png'
+)
+
+request.get_applicant_status(applicant_id)
+```
+
+The return from `Sumsub::Request` method will always be a ruby hash (in case of success) or an instance of `Sumsub::Struct::ErrorResponse` (in case error).
+
+## Development
+
+Run `bin/setup` to install dependencies. For an interactive prompt that will allow you to experiment, run `bin/console`.
+
+Run `bundle exec rspec`, if none error appears you're ready to go.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sumsub"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sumsub.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'types'
+require 'mime/types'
+
+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'
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.error_response?(response)
+    response.class == Sumsub::Struct::ErrorResponse
+  end
+end

data/lib/sumsub/configuration.rb

@@ -0,0 +1,11 @@
+module Sumsub
+  class Configuration
+    attr_accessor :token, :secret_key, :production
+
+    def initialize
+      @token = nil
+      @secret_key = nil
+      @production = true
+    end
+  end
+end

data/lib/sumsub/message_signer.rb

@@ -0,0 +1,17 @@
+module Sumsub
+  # https://developers.sumsub.com/api-reference/#signing-a-request
+  class MessageSigner
+    def self.sign(
+      time:, 
+      resource:, 
+      method:, 
+      body: nil, 
+      secret_key: Sumsub.configuration.secret_key
+    )
+      data = time.to_s + method + '/resources/' + resource + body.to_s
+      digest = OpenSSL::Digest.new('sha256')
+
+      OpenSSL::HMAC.hexdigest(digest, secret_key, data)
+    end
+  end
+end

data/lib/sumsub/parser.rb

@@ -0,0 +1,18 @@
+module Sumsub
+  class Parser
+    def self.parse(json_payload)
+      payload = JSON.parse(json_payload)
+
+      # return unless is an error response
+      return payload unless (payload['code'] && payload['description'])
+
+      Sumsub::Struct::ErrorResponse.new(
+        description: payload['description'],
+        code: payload['code'],
+        correlation_id: payload['correlationId'],
+        error_code: payload['errorCode'],
+        error_name: payload['errorName']
+      )
+    end
+  end
+end

data/lib/sumsub/request.rb

@@ -0,0 +1,204 @@
+module Sumsub
+  class Request
+    PRODUCTION_URL = "https://api.sumsub.com/resources"
+    TEST_URL = "https://test-api.sumsub.com/resources"
+
+    attr_reader :url, :secret_key, :token
+
+    def initialize(
+      token: Sumsub.configuration.token, 
+      secret_key: Sumsub.configuration.secret_key,
+      production: Sumsub.configuration.production
+    )
+      @token = token
+      @secret_key = secret_key
+      @url = production ? PRODUCTION_URL : TEST_URL
+    end
+
+    # 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}"
+      headers = build_header(resource, body: applicant.to_json)
+      response = HTTP.headers(headers)
+                     .post("#{@url}/#{resource}", json: applicant)
+      
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#adding-an-id-document
+    # To understand how the body was build manually bellow: https://roytuts.com/boundary-in-multipart-form-data/
+    # Sumsub::Struct::DocumentMetadata can be used as metadata.
+    def add_id_doc(applicant_id, metadata, file_path: nil)
+      resource = "applicants/#{applicant_id}/info/idDoc"
+
+      boundary = '----XYZ'
+
+      body = + '--' + boundary + "\r\n"
+      body += 'Content-Disposition: form-data; name="metadata"'
+      body += "\r\nContent-type: application/json; charset=utf-8\r\n\r\n"
+      body += metadata.to_json
+      body += "\r\n"
+      body += '--' + boundary
+
+      if file_path
+        content = File.read(file_path)
+        file_name = File.basename(file_path)
+        content_type = MIME::Types.type_for(file_name).first.content_type
+
+        body += "\r\n" 
+        body += 'Content-Disposition: form-data; name="content"; filename="' + file_name + '"'
+        body += "\r\nContent-type: #{content_type}; charset=utf-8\r\n\r\n"
+        body += content + "\r\n"
+        body += '--' + boundary + '--'
+      else
+        body += '--'
+      end
+
+      headers = build_header(
+        resource, 
+        body: body, 
+        content_type: 'multipart/form-data; boundary=' + boundary
+      ).merge({ "X-Return-Doc-Warnings": true })
+      response = HTTP.headers(headers)
+                     .post("#{@url}/#{resource}", body: body)
+    
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#getting-applicant-status-api
+    def get_applicant_detailed_status(applicant_id)
+      resource = "applicants/#{applicant_id}/requiredIdDocsStatus"
+      headers = build_header(resource, method: 'GET')
+      response = HTTP.headers(headers)
+                     .get("#{@url}/#{resource}")
+
+      parse_response(response)
+    end
+    
+    # API docs: https://developers.sumsub.com/api-reference/#getting-applicant-data
+    def get_applicant_data(applicant_id, as_external_user_id: false) 
+      resource = as_external_user_id ? 
+        "applicants/-;externalUserId=#{applicant_id}/one" : 
+        "applicants/#{applicant_id}/one"
+      headers = build_header(resource, method: 'GET')
+      response = HTTP.headers(headers)
+                     .get("#{@url}/#{resource}")
+
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#getting-applicant-status-sdk
+    def get_applicant_status(applicant_id) 
+      resource = "applicants/#{applicant_id}/status"
+      headers = build_header(resource, method: 'GET')
+      response = HTTP.headers(headers)
+                     .get("#{@url}/#{resource}")
+      
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#requesting-an-applicant-check
+    def request_applicant_check(applicant_id, reason: nil)
+      resource = "applicants/#{applicant_id}/status/pending?reason=#{reason}"
+      headers = build_header(resource)
+      response = HTTP.headers(headers)
+                     .post("#{@url}/#{resource}")
+      
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#getting-document-images
+    def get_document_image(inspection_id, image_id)
+      resource = "inspections/#{inspection_id}/resources/#{image_id}"
+      headers = build_header(resource, method: 'GET')
+      response = HTTP.headers(headers)
+                     .get("#{@url}/#{resource}")
+
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#resetting-an-applicant
+    def reset_applicant(applicant_id)
+      resource = "applicants/#{applicant_id}/reset"
+      headers = build_header(resource)
+      response = HTTP.headers(headers)
+                     .post("#{@url}/#{resource}")
+
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#changing-top-level-info
+    # Sumsub::Struct::ApplicantUpdate can be used as applicant_new_values.
+    def change_applicant_top_level_info(applicant_new_values)
+      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)
+
+      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}"
+      headers = build_header(resource, method: 'POST')
+      response = HTTP.headers(headers)
+                     .post("#{@url}/#{resource}")
+
+      parse_response(response)
+    end
+
+    # API docs: https://developers.sumsub.com/api-reference/#verifying-webhook-sender
+    # Your payload need to be informed as a string.
+    def verify_webhook_sender(webhook_secret_key, payload)
+      resource = "inspectionCallbacks/testDigest?secretKey=#{webhook_secret_key}"
+      headers = build_header(
+        resource, 
+        method: 'POST', 
+        content_type: 'text/plain',
+        accept: 'text/plain',
+        body: payload
+      )
+
+      response = HTTP.headers(headers)
+                     .post("#{@url}/#{resource}", body: payload)
+
+      parse_response(response)
+    end
+
+    private
+
+    # More infos about the required header and the signing strategy:
+    # https://developers.sumsub.com/api-reference/#app-tokens
+    def build_header(
+      resource, 
+      body: nil, 
+      method: 'POST', 
+      content_type: 'application/json', 
+      accept: 'application/json'
+    )
+      epoch_time = Time.now.to_i
+      access_signature = Sumsub::MessageSigner.sign(
+        time: epoch_time, 
+        resource: resource, 
+        body: body, 
+        method: method,
+      )
+
+      {
+        "X-App-Token": @token.encode("UTF-8"),
+        "X-App-Access-Sig": access_signature.encode("UTF-8"),
+        "X-App-Access-Ts": epoch_time.to_s.encode("UTF-8"),
+        "Accept": accept,
+        "Content-Type": content_type
+      }
+    end
+
+    def parse_response(response)
+      Sumsub::Parser.parse(response.to_s)
+    end
+  end
+end
+
+

data/lib/sumsub/struct/address.rb

@@ -0,0 +1,20 @@
+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
+      attribute? :street, Types::String
+      attribute? :subStreet, Types::String
+      attribute? :state, Types::String
+      attribute? :buildingName, Types::String
+      attribute? :flatNumber, Types::String
+      attribute? :buildingNumber, Types::String
+      attribute? :startDate, Types::String
+      attribute? :endDate, Types::String    
+    end
+  end
+end

data/lib/sumsub/struct/applicant.rb

@@ -0,0 +1,16 @@
+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? :lang, Types::String
+      attribute? :metadata, Types::Array.of(Types::Hash)
+      attribute? :info, Types::Instance(Sumsub::Struct::Info)
+      attribute? :fixedInfo, Types::Instance(Sumsub::Struct::Info)
+    end
+  end
+end

data/lib/sumsub/struct/applicant_update.rb

@@ -0,0 +1,16 @@
+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? :lang, Types::String
+      attribute? :metadata, Types::Array.of(Types::Hash)
+      attribute? :type, Types::String
+    end
+  end
+end

data/lib/sumsub/struct/base_struct.rb

@@ -0,0 +1,11 @@
+module Sumsub
+  module Struct
+    class BaseStruct < Dry::Struct
+      include Types
+
+      def to_json
+        attributes.to_json
+      end
+    end
+  end
+end

data/lib/sumsub/struct/document_metadata.rb

@@ -0,0 +1,20 @@
+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 :country, Types::String # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
+      attribute? :firstName, Types::String
+      attribute? :middleName, Types::String
+      attribute? :lastName, Types::String
+      attribute? :issuedDate, Types::String
+      attribute? :validUntil, Types::String
+      attribute? :number, Types::String
+      attribute? :dob, Types::String
+      attribute? :placeOfBirth, Types::String
+    end
+  end
+end

data/lib/sumsub/struct/error_response.rb

@@ -0,0 +1,14 @@
+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
+      attribute? :error_code, Types::Coercible::String.optional
+      attribute? :error_name, Types::String.optional
+    end
+  end
+end

data/lib/sumsub/struct/info.rb

@@ -0,0 +1,25 @@
+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
+      attribute? :firstNameEn, Types::String
+      attribute? :lastNameEn, Types::String
+      attribute? :middleNameEn, Types::String
+      attribute? :legalName, Types::String
+      attribute? :gender, Types::String
+      attribute? :dob, Types::String
+      attribute? :placeOfBirth, Types::String
+      attribute? :countryOfBirth, Types::String
+      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
+end

data/lib/sumsub/version.rb

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

data/lib/types.rb

@@ -0,0 +1,39 @@
+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

data/sumsub-ruby-sdk.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/sumsub/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sumsub-ruby-sdk"
+  spec.version       = Sumsub::VERSION
+  spec.authors       = ["Rodrigo W. Ehresmann"]
+  spec.email         = ["igoehresmann@gmail.com"]
+
+  spec.summary       = "SumSub Ruby SDK"
+  spec.description   = "SDK written in Ruby to handle SumSub API."
+  spec.homepage      = "https://github.com/rwehresmann/sumsub-ruby-sdk"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  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"
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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"
+
+  # 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"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: sumsub-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Rodrigo W. Ehresmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-26 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+description: SDK written in Ruby to handle SumSub API.
+email:
+- igoehresmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sumsub.rb
+- lib/sumsub/configuration.rb
+- lib/sumsub/message_signer.rb
+- lib/sumsub/parser.rb
+- lib/sumsub/request.rb
+- lib/sumsub/struct/address.rb
+- lib/sumsub/struct/applicant.rb
+- lib/sumsub/struct/applicant_update.rb
+- lib/sumsub/struct/base_struct.rb
+- lib/sumsub/struct/document_metadata.rb
+- lib/sumsub/struct/error_response.rb
+- lib/sumsub/struct/info.rb
+- lib/sumsub/version.rb
+- lib/types.rb
+- sumsub-ruby-sdk.gemspec
+homepage: https://github.com/rwehresmann/sumsub-ruby-sdk
+licenses:
+- MIT
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: SumSub Ruby SDK
+test_files: []