onfido 0.11.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25182eb1c80a27c7f3fbd914c640e277e973e71d0f24f8760c4c28894b243622
-  data.tar.gz: 9f2a71605568b28890ac8ad6113050a9f6e2a947e19964a70a2144fe51571e93
+  metadata.gz: 4a3a4754fe9f0896451df78eed5bf0af851ddffad2d4992e59d68fd5a3dc5e1d
+  data.tar.gz: 4c51e178c11a4a60cda311c517803cd890d90c383b5fef10250e2064f372649b
 SHA512:
-  metadata.gz: 16f99cd52f76371e5fee1aef34d0c33752eb772ae6ffbd514644ee84eb5baf50fb126d4a00726fe7b15f802f8efbc7f3ff3a654bae875a0af992cfac6663d63b
-  data.tar.gz: e1df5fd7ca79a84cd33942d59271b68ccedaca41d49dfdf1ef107a07d199e8688299da824c7d32722a1350f6137c7bfd5ad3907449e5a93ec28f2d288d137edd
+  metadata.gz: be9b5b35882b37be5d70e0004191c10ba67c069ac99b86b7382abb6924b8e6d29f557340d4ff18e38f9bcd8f898f0ae60c57daea5ebac1037e781aa551fc38ae
+  data.tar.gz: 5d2cd866567a2159a661ae3ec7af29d2d620b47f5ba44e681fb84e8ca1798c0c8b13c8eb0da829ccd9b46861038f0a89d6ccd1b4ec4de576b61d45fe78ea9c30

data/.rubocop.yml

@@ -2,9 +2,6 @@
 
 AllCops:
   DisplayCopNames: true
-  Include:
-    - Rakefile
-    - lib/tasks/*.rake
   Exclude:
     - vendor/**/*
     - .*/**
@@ -54,3 +51,7 @@ Layout/DotPosition:
 # Allow class and message or instance raises
 Style/RaiseArgs:
   Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"

data/.travis.yml

@@ -1,18 +1,20 @@
 language: ruby
 
-matrix:
-  allow_failures:
-    - rvm: jruby
-    - rvm: rbx-2
-
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
-  - jruby
-  - rbx-2
+  - 2.6
+
+before_install:
+    - gem update --system
+    - gem install bundler
 
 script:
   - bundle exec rubocop
   - bundle exec rspec spec
+
+# safelist
+branches:
+  only:
+  - master

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## v0.15.0, 4 Feb 2019
+
+- Add Check#find_by_url method (@ctrlaltdylan)
+
+## 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)
+
 ## v0.11.0, 18 April 2018
 
 - Automatically detect the correct Onfido API region to use based on the provided API

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.11.0'
+gem 'onfido', '~> 0.15.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.
 
 ## 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.
+See https://documentation.onfido.com/#delete-applicant for more information.
+
 #### Documents
 
 Documents provide supporting evidence for Onfido checks.
@@ -103,6 +117,7 @@ more "reports" on them.
 ```ruby
 api.check.create('applicant_id', type: 'express', reports: [{ name: 'identity' }])
 api.check.find('applicant_id', 'check_id')
+api.check.find_by_url('applicants/a90e7a17-677a-49ab-a171-281f96c77bde/checks/c9f41bef-0610-4d2f-9982-ae9387876edc')
 api.check.resume('check_id')
 api.check.all('applicant_id')
 ```

data/lib/onfido.rb

@@ -17,6 +17,7 @@ require 'onfido/resources/applicant'
 require 'onfido/resources/check'
 require 'onfido/resources/document'
 require 'onfido/resources/live_photo'
+require 'onfido/resources/live_video'
 require 'onfido/resources/report'
 require 'onfido/resources/report_type_group'
 require 'onfido/resources/sdk_token'

data/lib/onfido/api.rb

@@ -20,6 +20,10 @@ module Onfido
       Onfido::LivePhoto.new(@api_key)
     end
 
+    def live_video
+      Onfido::LiveVideo.new(@api_key)
+    end
+
     def report
       Onfido::Report.new(@api_key)
     end

data/lib/onfido/configuration.rb

@@ -1,6 +1,10 @@
 module Onfido
   module Configuration
-    attr_accessor :api_key, :open_timeout, :read_timeout, :api_version
+    REGION_HOSTS = {
+      us: "api.us.onfido.com"
+    }.freeze
+
+    attr_accessor :api_key, :region, :open_timeout, :read_timeout, :api_version
 
     def self.extended(base)
       base.reset
@@ -12,6 +16,7 @@ module Onfido
 
     def reset
       self.api_key = nil
+      self.region = nil
       self.open_timeout = 30
       self.read_timeout = 80
       self.api_version = 'v2'
@@ -30,22 +35,13 @@ module Onfido
       RestClient.log ||= NullLogger.new
     end
 
-    def region
-      return unless api_key
-
-      first_bit = api_key.split("_")[0]
-
-      return if %w(live test).include?(first_bit)
-
-      first_bit
-    end
-
     def endpoint
-      if region
-        "https://api.#{region}.onfido.com/#{api_version}/"
-      else
-        "https://api.onfido.com/#{api_version}/"
+      region_host = region ? REGION_HOSTS[region.downcase.to_sym] : "api.onfido.com"
+      unless region_host
+        raise "The region \"#{region.downcase}\" is not currently supported"
       end
+
+      "https://#{region_host}/#{api_version}/"
     end
   end
 end

data/lib/onfido/resources/address.rb

@@ -1,10 +1,8 @@
 module Onfido
   class Address < Resource
     def all(postcode)
-      get(
-        url: url_for('addresses/pick'),
-        payload: { postcode: postcode.delete(' ') }
-      )
+      query_string = "postcode=#{postcode.delete(' ')}"
+      get(url: url_for("addresses/pick?#{query_string}"))
     end
   end
 end

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/resources/check.rb

@@ -13,6 +13,12 @@ module Onfido
                        "#{querystring}"))
     end
 
+    def find_by_url(url, expand: nil)
+      url_path = url.sub(%r/^https\:\/\/api\.onfido\.com\/v2\//, '')
+      querystring = "&expand=#{expand}" if expand
+      get(url: url_for("#{url_path}?#{querystring}"))
+    end
+
     def all(applicant_id, page: 1, per_page: 20, expand: nil)
       querystring = "page=#{page}&per_page=#{per_page}"
       querystring += "&expand=#{expand}" if expand

data/lib/onfido/resources/live_video.rb

@@ -0,0 +1,18 @@
+module Onfido
+  class LiveVideo < Resource
+    def find(applicant_id, live_video_id)
+      query_string = "applicant_id=#{applicant_id}"
+      get(url: url_for("live_videos/#{live_video_id}?#{query_string}"))
+    end
+
+    def download(applicant_id, live_video_id)
+      query_string = "applicant_id=#{applicant_id}"
+      get(url: url_for("live_videos/#{live_video_id}/download?#{query_string}"))
+    end
+
+    def all(applicant_id)
+      query_string = "applicant_id=#{applicant_id}"
+      get(url: url_for("live_videos?#{query_string}"))
+    end
+  end
+end

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.15.1'.freeze
 end

data/onfido.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'onfido/version'
 
@@ -23,11 +23,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = ">= 2.2.0"
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '~> 0.52.0'
+  spec.add_development_dependency 'rubocop', '~> 0.57.0'
   spec.add_development_dependency 'sinatra', '~> 1.4'
   spec.add_development_dependency 'webmock', '~> 3.0'
 

data/spec/integrations/applicant_spec.rb

@@ -97,4 +97,28 @@ 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 a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion"
+          )
+        }
+      end
+    end
+  end
 end

data/spec/integrations/check_spec.rb

@@ -30,6 +30,50 @@ describe Onfido::Check do
     end
   end
 
+  describe '#find_by_url' do
+    let(:check_id) { '8546921-123123-123123' }
+
+    context 'partial url' do
+      let(:url) { "applicants/#{applicant_id}/checks/#{check_id}" }
+
+      it 'returns an existing check for the applicant with the partial url' do
+        response = check.find_by_url(url)
+        expect(response['id']).to eq(check_id)
+      end
+
+      it "returns unexpanded reports" do
+        response = check.find_by_url(url)
+        expect(response['reports'].first).to be_a(String)
+      end
+
+      it 'allows you to expand the reports' do
+        response = check.find_by_url(url, expand: "reports")
+        expect(response['reports'].first).to be_a(Hash)
+      end
+    end
+
+    context 'full url' do
+      let(:url) do
+        "https://api.onfido.com/v2/applicants/#{applicant_id}/checks/#{check_id}"
+      end
+
+      it 'returns an existing check for the applicant with the partial url' do
+        response = check.find_by_url(url)
+        expect(response['id']).to eq(check_id)
+      end
+
+      it "returns unexpanded reports" do
+        response = check.find_by_url(url)
+        expect(response['reports'].first).to be_a(String)
+      end
+
+      it 'allows you to expand the reports' do
+        response = check.find_by_url(url, expand: "reports")
+        expect(response['reports'].first).to be_a(Hash)
+      end
+    end
+  end
+
   describe '#all' do
     let(:check_id) { '8546921-123123-123123' }
 

data/spec/integrations/live_video_spec.rb

@@ -0,0 +1,34 @@
+require 'tempfile'
+
+describe Onfido::LiveVideo do
+  subject(:live_video) { described_class.new }
+
+  describe '#find' do
+    let(:applicant_id) { '1030303-123123-123123' }
+    let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
+
+    it 'returns the expected live photo' do
+      response = live_video.find(applicant_id, live_video_id)
+      expect(response['id']).to eq(live_video_id)
+    end
+  end
+
+  describe '#all' do
+    let(:applicant_id) { '1030303-123123-123123' }
+
+    it 'returns list of documents' do
+      response = live_video.all(applicant_id)
+      expect(response['live_videos']).not_to be_empty
+    end
+  end
+
+  describe '#download' do
+    let(:applicant_id) { '1030303-123123-123123' }
+    let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
+
+    it 'returns the file data' do
+      response = live_video.download(applicant_id, live_video_id)
+      expect(response).not_to be_nil
+    end
+  end
+end

data/spec/onfido_spec.rb

@@ -35,17 +35,18 @@ describe Onfido do
       end
     end
 
-    describe 'using a US API token' do
+    describe 'using the US region' do
       it 'should change endpoint' do
-        onfido.api_key = "us_live_asdfghjkl1234567890qwertyuiop"
+        onfido.region = 'us'
         expect(onfido.endpoint).to eq('https://api.us.onfido.com/v2/')
       end
     end
 
-    describe 'using a EU API token' do
+    describe 'using an unsupported region' do
       it 'should change endpoint' do
-        onfido.api_key = "eu_live_asdfghjkl1234567890qwertyuiop"
-        expect(onfido.endpoint).to eq('https://api.eu.onfido.com/v2/')
+        onfido.region = 'de'
+        expect { onfido.endpoint }.
+          to raise_error('The region "de" is not currently supported')
       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
@@ -74,6 +82,32 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
+  get '/v2/live_videos/:id' do
+    if params["applicant_id"] != "1030303-123123-123123"
+      status 404
+    else
+      json_response(200, 'live_video.json')
+    end
+  end
+
+  get '/v2/live_videos' do
+    if params["applicant_id"] != "1030303-123123-123123"
+      status 404
+    else
+      json_response(200, 'live_videos.json')
+    end
+  end
+
+  get '/v2/live_videos/:id/download' do
+    if params["applicant_id"] != "1030303-123123-123123"
+      status 404
+    else
+      status 200
+      content_type 'video/quicktime'
+      "\x01\x02\x03" # acts as binary file data
+    end
+  end
+
   post '/v2/applicants/:id/checks' do
     json_response(201, 'check.json')
   end

data/spec/support/fixtures/live_video.json

@@ -0,0 +1,23 @@
+{
+  "id" : "c9701e9b-83aa-442f-995b-20320ee8fb01",
+  "challenge" : [
+    {
+      "type" : "movement",
+      "query" : "turnLeft"
+    },
+    {
+      "type" : "recite",
+      "query" : [
+        9,
+        5,
+        9
+      ]
+    }
+  ],
+  "created_at" : "2018-05-29T09:00:39Z",
+  "file_name" : "output-29-05-2018_11_00_24.mov",
+  "file_type" : "video/quicktime",
+  "file_size" : 3348421,
+  "href" : "/v2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+  "download_href" : "/v2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
+}

data/spec/support/fixtures/live_videos.json

@@ -0,0 +1,27 @@
+{
+  "live_videos": [
+    {
+      "challenge": [
+        {
+          "query": "turnLeft",
+          "type": "movement"
+        },
+        {
+          "query": [
+            9,
+            5,
+            9
+          ],
+          "type": "recite"
+        }
+      ],
+      "created_at": "2018-05-29T09:00:39Z",
+      "download_href": "/v2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
+      "file_name": "output-29-05-2018_11_00_24.mov",
+      "file_size": 3348421,
+      "file_type": "video/quicktime",
+      "href": "/v2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+      "id": "c9701e9b-83aa-442f-995b-20320ee8fb01"
+    }
+  ]
+}

data/spec/support/fixtures/not_scheduled_for_deletion_error.json

@@ -0,0 +1,7 @@
+{
+    "error": {
+        "type": "validation_error",
+        "message": "There was a validation error on this request",
+        "fields": "Applicant a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion"
+    }
+}

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Pericles Theodorou
 - Grey Baker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.57.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.57.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,7 @@ files:
 - lib/onfido/resources/check.rb
 - lib/onfido/resources/document.rb
 - lib/onfido/resources/live_photo.rb
+- lib/onfido/resources/live_video.rb
 - lib/onfido/resources/report.rb
 - lib/onfido/resources/report_type_group.rb
 - lib/onfido/resources/sdk_token.rb
@@ -182,6 +183,7 @@ files:
 - spec/integrations/document_spec.rb
 - spec/integrations/exceptions_spec.rb
 - spec/integrations/live_photo_spec.rb
+- spec/integrations/live_video_spec.rb
 - spec/integrations/report_spec.rb
 - spec/integrations/report_type_group_spec.rb
 - spec/integrations/sdk_token_spec.rb
@@ -205,6 +207,9 @@ files:
 - spec/support/fixtures/documents.json
 - spec/support/fixtures/live_photo.json
 - spec/support/fixtures/live_photos.json
+- spec/support/fixtures/live_video.json
+- spec/support/fixtures/live_videos.json
+- spec/support/fixtures/not_scheduled_for_deletion_error.json
 - spec/support/fixtures/report.json
 - spec/support/fixtures/report_type_group.json
 - spec/support/fixtures/report_type_groups.json
@@ -217,7 +222,7 @@ homepage: http://github.com/hvssle/onfido
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,9 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A wrapper for Onfido API
 test_files:
@@ -244,6 +248,7 @@ test_files:
 - spec/integrations/document_spec.rb
 - spec/integrations/exceptions_spec.rb
 - spec/integrations/live_photo_spec.rb
+- spec/integrations/live_video_spec.rb
 - spec/integrations/report_spec.rb
 - spec/integrations/report_type_group_spec.rb
 - spec/integrations/sdk_token_spec.rb
@@ -267,6 +272,9 @@ test_files:
 - spec/support/fixtures/documents.json
 - spec/support/fixtures/live_photo.json
 - spec/support/fixtures/live_photos.json
+- spec/support/fixtures/live_video.json
+- spec/support/fixtures/live_videos.json
+- spec/support/fixtures/not_scheduled_for_deletion_error.json
 - spec/support/fixtures/report.json
 - spec/support/fixtures/report_type_group.json
 - spec/support/fixtures/report_type_groups.json