onfido 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5402f96702de9c0251f8c92ac14739b1cf54ad9a5336cf63c7088e4cc45dc0ae
-  data.tar.gz: 89c7091cf1059f7eb4db9d96ae6c8ace2ca7176961524ba886b12ba3969cf462
+  metadata.gz: e01591b4bd8952e983ea3f65ad8b534dcc43efa6e4243c33c340150771081b49
+  data.tar.gz: c40818067b6634ac7af1a0e4472163fbbd2538a462730d364b0b7de82e5de405
 SHA512:
-  metadata.gz: 6dce59eeee514ce3371b8c03367f7e2c772d26dfe57231b4f49c13a3073ca233b4089798ee7e3a7e451b2e0b7e64d035f7ee4307bb902876b160053107652664
-  data.tar.gz: 92dd31829e491e612556caaf098dba388d701dfade3e755625e2199d2fbb58eaa5f621f1bdc9b8a8c95adf4753b22bb740430933e7c6b4789ed9ff8388485d44
+  metadata.gz: 3774da7d757f4e3a48e1fecd437792d7dc69e39bb765b5828383b84ee8ecf508504deddb1cbd1770c600e01be3d610619049f7cbe1aa6b78113c5c699313c768
+  data.tar.gz: d27a782d5304688d4437ab8bf5d7218c25396502e71e802bf9af8d70b5ff55aaf59f2dafc5ad458e37db54614af769104f022aca4ff11dc0b9c42d200dabd9c4

data/.rubocop.yml

@@ -1,57 +1,13 @@
-# For all options see https://github.com/bbatsov/rubocop/tree/master/config
-
 AllCops:
-  DisplayCopNames: true
-  Exclude:
-    - vendor/**/*
-    - .*/**
-    - spec/fixtures/**/*
-  TargetRubyVersion: 2.2.0
-
-Style/StringLiterals:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Naming/FileName:
-  Exclude:
-    - Gemfile
+  NewCops: enable
+  TargetRubyVersion: 2.4.0
 
-Metrics/MethodLength:
-  CountComments: false
-  Max: 25
+Layout/LineLength:
+  Max: 100
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Metrics/AbcSize:
-  Max: 25
-
-# Don't require utf-8 encoding comment
-Style/Encoding:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 90
-
-Metrics/ClassLength:
-  Enabled: false
-
-Layout/DotPosition:
-  EnforcedStyle: trailing
-
-# Allow class and message or instance raises
-Style/RaiseArgs:
+Style/Documentation:
   Enabled: false
-
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - "spec/**/*"

data/.travis.yml

@@ -1,19 +1,13 @@
 language: ruby
-cache: bundler 
+cache: bundler
 
 rvm:
-  - 2.2
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
   - 2.7
+  - 3.0
 
 script:
   - bundle exec rubocop
   - bundle exec rspec spec
-
-# safelist
-branches:
-  only:
-  - master

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v2.0.0, 5 May 2021
+
+- Remove global configuration, all configuration is now per `Onfido::API` instance
+- Region is now a required argument (it previously defaulted to `:eu`)
+- Support Onfido API version 3.1
+- Drop support for Ruby 2.2 and 2.3
+
 ## v1.1.1, 12 March 2021
 
 - Send the postcode in the query string for the address picker endpoint

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 

data/README.md

@@ -1,180 +1,53 @@
 # Onfido
 
-A thin wrapper for Onfido's API.
+The official Ruby library for integrating with the Onfido API.
 
 [![Gem Version](https://badge.fury.io/rb/onfido.svg)](http://badge.fury.io/rb/onfido)
 [![Build Status](https://travis-ci.org/onfido/onfido-ruby.svg?branch=master)](https://travis-ci.org/onfido/onfido-ruby)
 
-This gem supports only `v3` of Onfido's API from version `1.0.0` onwards. The latest version that supports `v2` of Onfido's API is `0.15.0`. `v1` of Onfido's API is deprecated.
+Documentation can be found at https://documentation.onfido.com
 
-The gem is compatible with Ruby 2.2.0 and onwards. Earlier versions of Ruby have [reached end-of-life](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/), are no longer supported and no longer receive security fixes.
-
-Refer to Onfido's [API documentation](https://documentation.onfido.com) for details of the expected requests and responses.
+This version uses Onfido API v3.1 and is compatible with Ruby 2.4 onwards. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'onfido', '~> 1.1.1'
+gem 'onfido', '~> 2.0.0'
 ```
 
-## Configuration
+## Getting started
 
-There are 5 configuration options:
+Configure with your API token and region:
 
 ```ruby
-Onfido.configure do |config|
-  config.api_key = '<YOUR_API_KEY>'
-  config.logger = Logger.new(STDOUT)
-  config.open_timeout = 30
-  config.read_timeout = 80
-  config.region = nil
-end
+onfido = Onfido::API.new(
+  api_key: ENV['ONFIDO_API_KEY'],
+  # Supports :eu, :us and :ca. Previously defaulted to :eu.
+  region: :eu
+)
 ```
 
-### Regions
-
-The gem will use the default region if no region is specified.
-
-To specify the US region do:
-`config.region = :us`
-
-To specify the CA region do:
-`config.region = :ca`
-
-See https://documentation.onfido.com/#regions for supported regions.
-
-## Usage
-
-You can make API calls by using an instance of the `API` class:
-
-```ruby
-onfido = Onfido::API.new
-```
-
-You can also set an API key as follows, instead of in the initializer configuration:
-
-```ruby
-onfido = Onfido::API.new(api_key: '<YOUR_API_KEY>')
-```
-
-### Resources
-
 All resources share the same interface when making API calls. Use `.create` to create a resource, `.find` to find one, and `.all` to fetch all resources.
 
-**Note:** *All param keys should be symbols e.g. `{ report_names: ['document'] }`*
-
-#### Applicants
-
-Applicants are the object upon which Onfido checks are performed.
-
-```ruby
-onfido.applicant.create(params)                  # => Creates an applicant
-onfido.applicant.update('<APPLICANT_ID>', params)  # => Updates an applicant
-onfido.applicant.destroy('<APPLICANT_ID>')         # => Schedule an applicant for deletion
-onfido.applicant.restore('<APPLICANT_ID>')         # => Restore an applicant scheduled for deletion
-onfido.applicant.find('<APPLICANT_ID>')            # => Finds a single applicant
-onfido.applicant.all                             # => Returns all applicants
-```
-
-**Note:** Calling `onfido.applicant.destroy` adds the applicant and all associated documents, photos, videos, checks, and reports to the deletion queue. They will be deleted 20 days after the request is made. An applicant that is scheduled for deletion can be restored but applicants that have been permanently deleted cannot.
-See https://documentation.onfido.com/#delete-applicant for more information.
-
-#### Documents
-
-Some report types require identity documents (passport, driving licence etc.) in order to be processed.
+For example, to create an applicant:
 
 ```ruby
-onfido.document.create(applicant_id: '<APPLICANT_ID>', file: <FILE>, type: 'passport') # => Creates a document
-onfido.document.find('<DOCUMENT_ID>')      # => Finds a document
-onfido.document.download('<DOCUMENT_ID>')  # => Downloads a document as a binary data
-onfido.document.all('<APPLICANT_ID>')      # => Returns all documents belonging to an applicant
+onfido.applicant.create(
+  first_name: 'Test',
+  last_name: 'Applicant'
+)
 ```
 
-**Note:** The file parameter must be a `File`-like object which responds to `#read` and `#path`.
-Previous versions of this gem supported providing a URL to a file accessible over HTTP or a path
-to a file in the local filesystem. You should instead load the file yourself and then pass it in
-to `#create`.
-
-See https://documentation.onfido.com/#document-types for example document types.
-
-#### Live Photos
-
-Live photos are images of the applicant’s face, typically taken at the same time as documents are provided. These photos are used to perform Facial Similarity Photo reports on the applicant.
-
-```ruby
-onfido.live_photo.create(applicant_id: '<APPLICANT_ID>', file: <FILE>) # => Creates a live photo
-onfido.live_photo.find('<LIVE_PHOTO_ID>')      # => Finds a live photo
-onfido.live_photo.download('<LIVE_PHOTO_ID>')  # => Downloads a live photo as binary data
-onfido.live_photo.all('<APPLICANT_ID>')        # => Returns all live photos belonging to an applicant
-```
-
-**Note:** The file parameter must be a `File`-like object which responds to `#read` and `#path`.
-Previous versions of this gem supported providing a URL to a file accessible over HTTP or a path
-to a file in the local filesystem. You should instead load the file yourself and then pass it in
-to `#create`.
-
-#### Checks
+Documentation and code examples can be found at https://documentation.onfido.com
 
-Checks are performed on an applicant. Depending on the type of check you wish to perform, different information will be required when you create an applicant. A check consists of one or more reports.
-
-```ruby
-onfido.check.create(applicant_id: '<APPLICANT_ID>', report_names: ['document', 'facial_similarity_photo']) # => Creates a check
-onfido.check.find('<CHECK_ID>')    # => Finds a check
-onfido.check.resume('<CHECK_ID>')  # => Resumes a paused check
-onfido.check.all('<APPLICANT_ID>') # => Returns all an applicant's checks
-```
-
-#### Reports
-
-Reports provide details of the results of some part of a check. They are
-created when a check is created, so the Onfido API only provides support for
-finding and listing them. For paused reports specifically, additional support for resuming and
- cancelling reports is also available.
-
-```ruby
-onfido.report.find('<REPORT_ID>')    # => Finds a report
-onfido.report.all('<CHECK_ID>')      # => Returns all the reports in a check
-onfido.report.resume('<REPORT_ID>')  # => Resumes a paused report
-onfido.report.cancel('<REPORT_ID>')  # => Cancels a paused report
-```
-
-#### Address Lookups
-
-Onfido provides an address lookup service, to help ensure well-formatted
-addresses are provided when creating applicants. To search for addresses
-by postcode, use:
-
-```ruby
-onfido.address.all('SE1 4NG') # => Returns all addresses in a given postcode
-```
-
-#### Webhook Endpoints
-
-Onfido allows you to set up and view your webhook endpoints via the API, as well
-as through the dashboard.
-
-```ruby
-onfido.webhook.create(url: "https://webhook.url", events: ['report.completed', 'check.completed']) # => Registers a webhook endpoint
-onfido.webhook.find('<WEBHOOK_ID>')  # => Finds a single webhook endpoint
-onfido.webhook.all                 # => Returns all webhook endpoints
-```
-
-#### SDK Tokens
-
-Onfido allows you to generate JSON Web Tokens via the API in order to authenticate
-with Onfido's [JavaScript SDK](https://github.com/onfido/onfido-sdk-ui).
-
-```ruby
-onfido.sdk_token.create(applicant_id: 'applicant_id', referrer: 'referrer') # => Creates a JWT
-```
-
-### Error Handling
+## Error Handling
 
 There are 3 classes of errors raised by the library, all of which subclass `Onfido::OnfidoError`:
+
+- `Onfido::RequestError` is raised whenever Onfido returns a `4xx` response
 - `Onfido::ServerError` is raised whenever Onfido returns a `5xx` response
-- `Onfido::RequestError` is raised whenever Onfido returns any other kind of error
 - `Onfido::ConnectionError` is raised whenever a network error occurs (e.g., a timeout)
 
 All 3 error classes provide the `response_code`, `response_body`, `json_body`, `type` and `fields` of the error (although for `Onfido::ServerError` and `Onfido::ConnectionError` the last 3 are likely to be `nil`).
@@ -189,7 +62,19 @@ rescue Onfido::RequestError => e
 end
 ```
 
-## Webhooks
+## Other configuration
+
+Optional configuration options with their defaults:
+
+```ruby
+onfido = Onfido::API.new(
+  # ...
+  open_timeout: 10,
+  read_timeout: 30
+)
+```
+
+## Verifying webhooks
 
 Each webhook endpoint has a secret token, generated automatically and [exposed](https://onfido.com/documentation#register-webhook) in the API. When sending a request, Onfido includes a signature computed using the request body and this token in the `X-SHA2-Signature` header.
 
@@ -214,3 +99,7 @@ Read more at https://onfido.com/documentation#webhook-security
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## More documentation
+
+More documentation and code examples can be found at https://documentation.onfido.com

data/lib/onfido.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'rack'
 require 'rest-client'
 require 'openssl'
 
 require 'onfido/version'
-require 'onfido/configuration'
 require 'onfido/errors/onfido_error'
 require 'onfido/errors/request_error'
 require 'onfido/errors/server_error'
 require 'onfido/errors/connection_error'
 require 'onfido/null_logger'
 require 'onfido/api'
+require 'onfido/options'
 require 'onfido/resource'
 require 'onfido/resources/address'
 require 'onfido/resources/applicant'
@@ -24,5 +26,4 @@ require 'onfido/resources/sdk_token'
 require 'onfido/resources/webhook'
 
 module Onfido
-  extend Configuration
 end

data/lib/onfido/api.rb

@@ -1,47 +1,53 @@
+# frozen_string_literal: true
+
 module Onfido
   class API
-    def initialize(options = {})
-      @api_key = options[:api_key]
+    def initialize(api_key:, region:, **extra_options)
+      @options = Onfido::Options.new(api_key: api_key, region: region, **extra_options)
     end
 
     def applicant
-      Onfido::Applicant.new(@api_key)
+      @applicant ||= Onfido::Applicant.new(options)
     end
 
     def check
-      Onfido::Check.new(@api_key)
+      @check ||= Onfido::Check.new(options)
     end
 
     def document
-      Onfido::Document.new(@api_key)
+      @document ||= Onfido::Document.new(options)
     end
 
     def live_photo
-      Onfido::LivePhoto.new(@api_key)
+      @live_photo ||= Onfido::LivePhoto.new(options)
     end
 
     def live_video
-      Onfido::LiveVideo.new(@api_key)
+      @live_video ||= Onfido::LiveVideo.new(options)
     end
 
     def report
-      Onfido::Report.new(@api_key)
+      @report ||= Onfido::Report.new(options)
     end
 
     def sdk_token
-      Onfido::SdkToken.new(@api_key)
+      @sdk_token ||= Onfido::SdkToken.new(options)
     end
 
     def webhook
-      Onfido::Webhook.new(@api_key)
+      @webhook ||= Onfido::Webhook.new(options)
     end
 
     def address
-      Onfido::Address.new(@api_key)
+      @address ||= Onfido::Address.new(options)
     end
 
     def extraction
-      Onfido::Extraction.new(@api_key)
+      @extraction ||= Onfido::Extraction.new(options)
     end
+
+    private
+
+    attr_reader :options
   end
 end

data/lib/onfido/errors/connection_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class ConnectionError < OnfidoError
   end

data/lib/onfido/errors/onfido_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class OnfidoError < StandardError
     attr_accessor :response_code, :response_body