onfido 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b61261e90bcef73d04ec7083f84be636932a17c
-  data.tar.gz: cad7dae9a3f2be1a49b0ac66ba23203a98df84d4
+SHA256:
+  metadata.gz: 27279800cfff5a840ce97b9e8de9dc74a5083ea1c57f8a10b87e5bc2950f1067
+  data.tar.gz: 922fdbde05fe24981a5e2cf6d6be173f6db0c8966521e07a7271c15df3849440
 SHA512:
-  metadata.gz: 2c0d1cee16e88e9f0a926732ac58a06385b4455f543603007c75c86ec266267b5a003b90ce801fb15d46b6c025cf37a854b99a67863eaf232ed460450640ba5a
-  data.tar.gz: 98b15700b77aaa1025892723195afac34902033b72e2e586186fe3b93e97984392a9a8f640cb72d4a91231244f772cf7ba8ee8075c698299f469d817d9dbb83f
+  metadata.gz: 0982bae64d5589a5909f03f92904445ea0f1912c554912a46893b61647756794522b11dbc46bb8e562712572c5459bd8f1a819e3e10d539bbbf6e5e7c077b5be
+  data.tar.gz: 8b741438cefff280b5ad6c1c6a7db958910f78553fd3e7315943a00247b6badc993154991c6866242dd2342eb31f8bc937904672fd4a01594f5feb1f454664d0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.14.0, 28 Jan 2019
+
+- Add support for applicant deletion and restore endpoints
+
+## v0.13.0, 5 Nov 2018
+
+- Add support for region-specific environments (@stephencookdev)
+
 ## v0.12.0, 29 May 2018
 
 - Add support for the Live Video resource (#55) (@Intrepidd)

data/README.md

@@ -12,14 +12,14 @@ This gem supports both `v1` and `v2` of the Onfido API. Refer to Onfido's [API d
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'onfido', '~> 0.12.0'
+gem 'onfido', '~> 0.13.0'
 ```
 
 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.
 
 ## Configuration
 
-There are 5 configuration options:
+There are 6 configuration options:
 
 ```ruby
 Onfido.configure do |config|
@@ -28,9 +28,19 @@ Onfido.configure do |config|
   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:
@@ -58,11 +68,15 @@ 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')         # => Destroy 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 be restored.
+See https://documentation.onfido.com/#delete-applicant for more information.
+
 #### Documents
 
 Documents provide supporting evidence for Onfido checks.

data/lib/onfido/resources/applicant.rb

@@ -19,5 +19,9 @@ module Onfido
     def all(page: 1, per_page: 20)
       get(url: url_for("applicants?page=#{page}&per_page=#{per_page}"))
     end
+
+    def restore(applicant_id)
+      post(url: url_for("applicants/#{applicant_id}/restore"))
+    end
   end
 end

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

data/spec/integrations/applicant_spec.rb

@@ -97,4 +97,26 @@ describe Onfido::Applicant do
       end
     end
   end
+
+  describe '#restore' do
+    context 'an applicant scheduled for deletion' do
+      let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
+
+      it 'returns nil' do
+        expect(applicant.restore(applicant_id)).to be_nil
+      end
+    end
+
+    context 'an applicant not scheduled for deletion' do
+      let(:applicant_id) { 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5' }
+
+      it 'returns an error' do
+        expect { applicant.restore(applicant_id) }.to raise_error { |error|
+          expect(error).to be_a(Onfido::RequestError)
+          expect(error.message).to eq('There was a validation error on this request')
+          expect(error.fields).to eq("Applicant #{applicant_id} is not scheduled for deletion")
+        }
+      end
+    end
+  end
 end

data/spec/support/fake_onfido_api.rb

@@ -26,6 +26,14 @@ class FakeOnfidoAPI < Sinatra::Base
     status 204
   end
 
+  post '/v2/applicants/:id/restore' do
+    if params["id"] == "a2fb9c62-ab10-4898-a8ec-342c4b552ad5"
+      json_response(422, 'not_scheduled_for_deletion_error.json')
+    else
+      status 204
+    end
+  end
+
   post '/v2/applicants/:id/documents' do
     json_response(201, 'document.json')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Pericles Theodorou
@@ -9,132 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.57.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.57.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: A thin wrapper for Onfido's API. This gem supports both v1 and v2 of
@@ -147,10 +147,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -227,17 +227,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A wrapper for Onfido API