onfido 1.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c2b7ace145ea9b4804afb24664f452851753bb15dca4221e94c43cf1db6f96e
-  data.tar.gz: c0477b41310dc691e99a218d03a40777c5e91d3e1cc72d90884f9d6d01772a3e
+  metadata.gz: 7983a2913b8ae4c7a1e53d92b8b62028b57e6e05705f6e5cef13028e77d7a30d
+  data.tar.gz: e923fe60b61214229d3546868a82128607147fb462a7966552ebc67e5d1263e8
 SHA512:
-  metadata.gz: 598a9e0fcf166be224cf0b28dd0f8ca92f8e285ac3955d7ff06ad450bd018741ce580f99de6e506100f879ef5002e485926fec8d741d7bb313d496486f4ffb48
-  data.tar.gz: 1786150e8f9b3d8d7b1bec8aad0ff35565c77e3000c70534757aec49ae85fff9c15deb398e53d2676337b3ff9432a25ed48a690833112304ad91d249ae82f550
+  metadata.gz: 2ab79a44f5d86fbb3fd17c56e3d876ce256f95f88508300d571ebd6a068973323082f7c1a32cf1edd44bbcec5351a073363c08d4950cae6e0510e54263cff448
+  data.tar.gz: a02418a2e5db122bf0fcf3bce2d5547033e4c8e71b18f7a39006674e0a55cd46fb658986224c6f025c3b028e8bac48d19370c903abaa41e874456420ab2c0bf2

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec spec

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,20 +1,13 @@
 language: ruby
+cache: bundler
 
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
-
-before_install:
-    - gem update --system
-    - gem install bundler
+  - 2.7
+  - 3.0
 
 script:
   - bundle exec rubocop
   - bundle exec rspec spec
-
-# safelist
-branches:
-  only:
-  - master

data/CHANGELOG.md

@@ -1,7 +1,34 @@
+## v2.0.2, 10 June 2021
+
+- Add error coverage for errors RestClient:BadGateway
+
+## v2.0.1, 27 May 2021
+
+- Remove onfido/null_logger
+
+## 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
+
+## v1.1.0, 14 Aug 2020
+
+- Add User-Agent header
+- Add support for CA region
+- Add extractions endpoint
+- Add webhook deletion endpoint
+
 ## v1.0.0, 13 Jan 2020
 
 - Support Onfido API version 3
 - Drop support for Onfido API version 2
+- To upgrade from 0.15.0 see the v2 to v3 migration [guide](https://developers.onfido.com/guide/v2-to-v3-migration-guide)
 
 ## v0.15.0, 4 Feb 2019
 

data/Gemfile

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

data/README.md

@@ -1,184 +1,60 @@
 # 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` ownards.
-The latest version that supports `v2` of Onfido's API is `0.15.0`. `v1` of Onfido's API is deprecated
-Refer to Onfido's [API documentation](https://documentation.onfido.com) for details of the expected requests and responses.
+Documentation can be found at https://documentation.onfido.com
 
+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.0.0'
+gem 'onfido', '~> 2.0.1'
 ```
 
-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.
+## Getting started
 
-## Configuration
-
-There are 5 configuration options:
-
-```ruby
-Onfido.configure do |config|
-  config.api_key = 'MY_API_KEY'
-  config.logger = Logger.new(STDOUT)
-  config.open_timeout = 30
-  config.read_timeout = 80
-  config.region = nil
-end
-```
-
-### Regions
-
-The gem will use the default region if no region is specified.
-
-To specify the US region do:
-`config.region = :us`
-
-See https://documentation.onfido.com/#regions for supported regions.
-
-## Usage
-
-You can make API calls by using an instance of the `API` class:
-
-```ruby
-api = Onfido::API.new
-```
-
-Alternatively, you can set an API key here instead of in the initializer:
+Configure with your API token and region:
 
 ```ruby
-api = Onfido::API.new(api_key: 'API_KEY')
+onfido = Onfido::API.new(
+  api_key: ENV['ONFIDO_API_KEY'],
+  # Supports :eu, :us and :ca. Previously defaulted to :eu.
+  region: :eu
+)
 ```
 
-### 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 a symbol e.g. `{ report_names: ['document'] }`*
-
-#### Applicants
-
-Applicants are the object upon which Onfido checks are performed.
-
-```ruby
-api.applicant.create(params)                  # => Creates an applicant
-api.applicant.update('applicant_id', params)  # => Updates an applicant
-api.applicant.destroy('applicant_id')         # => Schedule an applicant for deletion
-api.applicant.restore('applicant_id')         # => Restore an applicant scheduled for deletion
-api.applicant.find('applicant_id')            # => Finds a single applicant
-api.applicant.all                             # => Returns all applicants
-```
-
-**Note:** Calling `api.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
-
-Documents provide supporting evidence for Onfido checks.
-
-```ruby
-api.document.create('applicant_id', file: 'http://example.com', type: 'passport') # => Creates a document
-api.document.find('document_id') # => Finds a document
-api.document.download('document_id') # => Downloads a document as a binary data
-api.document.all('applicant_id') # => Returns all applicant's documents
-```
-
-**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`.
-
-#### Live Photos
-
-Live Photos, like documents, can provide supporting evidence for Onfido checks.
-
-```ruby
-api.live_photo.create('applicant_id', file: 'http://example.com')
-api.live_photo.find(live_photo_id) # => Finds a live photo
-api.live_photo.download(live_photo_id) # => Downloads a live photo as binary data
-api.live_photo.all(applicant_id) # => Returns all applicant's live photos
-```
-
-**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
-
-Checks are requests for Onfido to check an applicant, by commissioning one or
-more "reports" on them.
-
-```ruby
-api.check.create('applicant_id', report_names: ['document'])
-api.check.find('check_id')
-api.check.resume('check_id')
-api.check.all('applicant_id')
-```
-
-#### 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.
+For example, to create an applicant:
 
 ```ruby
-api.report.find('report_id')
-api.report.all('check_id')
-api.report.resume('report_id')
-api.report.cancel('report_id')
+onfido.applicant.create(
+  first_name: 'Test',
+  last_name: 'Applicant'
+)
 ```
 
-#### 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
-api.address.all('SE1 4NG')
-```
+Documentation and code examples can be found at https://documentation.onfido.com
 
-#### Webhook Endpoints
+## Error Handling
 
-Onfido allows you to set up and view your webhook endpoints via the API, as well
-as through the dashboard.
+There are 3 classes of errors raised by the library, all of which subclass `Onfido::OnfidoError`:
 
-```ruby
-api.webhook.create(params)          # => Creates a webhook endpoint
-api.webhook.find('webhook_id')      # => Finds a single webhook endpoint
-api.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
-api.sdk_token.create(applicant_id: 'applicant_id', referrer: 'referrer')
-```
-
-### Error Handling
-
-There are three 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 three 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 three are likely to be `nil`).
+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`).
 
 ```ruby
 def create_applicant
-  api.applicant.create(params)
+  onfido.applicant.create(params)
 rescue Onfido::RequestError => e
   e.type          # => 'validation_error'
   e.fields        # => { "email": { "messages": ["invalid format"] } }
@@ -186,15 +62,27 @@ rescue Onfido::RequestError => e
 end
 ```
 
-## Webhooks
+## Other configuration
 
-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-Signature` header.
+Optional configuration options with their defaults:
 
-This provided signature [should](https://onfido.com/documentation#webhook-security) be compared to one you generate yourself with the token to check that a webhook is a genuine request from Onfido.
+```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.
+
+You should compare this provided signature to one you generate yourself with the token to verify that a webhook is a genuine request from Onfido.
 
 ```ruby
 if Onfido::Webhook.valid?(request.raw_post,
-                          request.headers["X-Signature"],
+                          request.headers["X-SHA2-Signature"],
                           ENV['ONFIDO_WEBHOOK_TOKEN'])
   process_webhook
 else
@@ -202,16 +90,16 @@ else
 end
 ```
 
-## Roadmap
-
-- Improve test coverage with more scenarios
-- Add custom errors based on the response code
-- Improve pagination handling (use information passed in link header)
+Read more at https://onfido.com/documentation#webhook-security
 
 ## Contributing
 
-1. Fork it ( https://github.com/onfido/onfido/fork )
+1. Fork it ( https://github.com/onfido/onfido-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 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