onfido 1.0.0 → 2.0.2

data/lib/onfido/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
-  VERSION = '1.0.0'.freeze
+  VERSION = '2.0.2'
 end

data/onfido.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A wrapper for Onfido API'
   spec.description   = "A thin wrapper for Onfido's API. This gem only supports "\
                        "v3 of the Onfido API. Refer to Onfido's "\
-                       "API documentation for details of the expected "\
-                       "requests and responses."
+                       'API documentation for details of the expected '\
+                       'requests and responses.'
   spec.homepage      = 'http://github.com/onfido/onfido-ruby'
   spec.license       = 'MIT'
 
@@ -21,13 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = ">= 2.2.0"
+  spec.required_ruby_version = '>= 2.4.0'
 
-  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.57.0'
+  spec.add_development_dependency 'rubocop', '~> 1.11'
   spec.add_development_dependency 'sinatra', '~> 1.4'
   spec.add_development_dependency 'webmock', '~> 3.0'
 

data/spec/integrations/address_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 describe Onfido::Address do
-  subject(:api) { Onfido::API.new }
+  include_context 'fake onfido api'
 
   describe '#all' do
     it 'returns the addresses matching the postcode' do
-      response = api.address.all('SW1 4NG')
+      response = onfido.address.all('SW1 4NG')
 
       expect(response['addresses'].count).to eq(2)
     end

data/spec/integrations/applicant_spec.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 describe Onfido::Applicant do
-  subject(:applicant) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:applicant) { onfido.applicant }
+
   let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
   let(:params) do
     {
@@ -29,9 +34,9 @@ describe Onfido::Applicant do
 
     it 'serializes the payload correctly' do
       WebMock.after_request do |request_signature, _response|
-        if request_signature.uri.path == 'v3/applicants'
-          expect(Rack::Utils.parse_nested_query(request_signature.body)).
-            to eq(params)
+        if request_signature.uri.path == 'v3.1/applicants'
+          expect(Rack::Utils.parse_nested_query(request_signature.body))
+            .to eq(params)
         end
       end
     end
@@ -93,13 +98,13 @@ describe Onfido::Applicant do
       it 'returns an error' do
         applicant_id = 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
 
-        expect { applicant.restore(applicant_id) }.to raise_error { |error|
+        expect { applicant.restore(applicant_id) }.to raise_error do |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"
+            'Applicant a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion'
           )
-        }
+        end
       end
     end
   end

data/spec/integrations/check_spec.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 describe Onfido::Check do
-  subject(:check) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:check) { onfido.check }
+
   let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
   let(:check_id) { '8546921-123123-123123' }
 
@@ -20,7 +25,7 @@ describe Onfido::Check do
       expect(response['id']).to eq(check_id)
     end
 
-    it "returns report_ids" do
+    it 'returns report_ids' do
       response = check.find(check_id)
 
       expect(response['report_ids'].first).to be_a(String)
@@ -36,16 +41,24 @@ describe Onfido::Check do
       end
     end
 
-    it "returns report_ids" do
+    it 'returns report_ids' do
       response = check.all(applicant_id)
 
       expect(response['checks'].first['report_ids'].first).to be_a(String)
     end
   end
 
-  describe "#resume" do
+  describe '#resume' do
     it 'returns success response' do
       expect { check.resume(check_id) }.not_to raise_error
     end
   end
+
+  describe '#download' do
+    it 'returns the file data' do
+      response = check.download(check_id)
+
+      expect(response).not_to be_nil
+    end
+  end
 end

data/spec/integrations/document_spec.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 
 describe Onfido::Document do
-  subject(:document) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:document) { onfido.document }
 
   describe '#create' do
     let(:params) do
@@ -22,7 +26,7 @@ describe Onfido::Document do
       end
 
       it 'creates a new document' do
-        response = document.create(params)
+        response = document.create(**params)
 
         expect(response['id']).not_to be_nil
       end
@@ -32,8 +36,8 @@ describe Onfido::Document do
       let(:file) { 'https://onfido.com/images/logo.png' }
 
       it 'raises an ArgumentError' do
-        expect { document.create(params) }.
-          to raise_error(ArgumentError, /must be a `File`-like object/)
+        expect { document.create(**params) }
+          .to raise_error(ArgumentError, /must be a `File`-like object/)
       end
     end
   end

data/spec/integrations/extraction_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+describe Onfido::Extraction do
+  include_context 'fake onfido api'
+
+  subject(:extraction) { onfido.extraction }
+
+  describe '#create' do
+    let(:params) do
+      {
+        document_id: '7568415-123123-123123'
+      }
+    end
+
+    it 'creates a new extraction' do
+      response = extraction.create(**params)
+
+      expect(response['document_id']).to eq('7568415-123123-123123')
+    end
+  end
+end

data/spec/integrations/live_photo_spec.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 
 describe Onfido::LivePhoto do
-  subject(:live_photo) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:live_photo) { onfido.live_photo }
 
   describe '#create' do
     let(:params) { { applicant_id: '123456', file: file } }
@@ -15,7 +19,7 @@ describe Onfido::LivePhoto do
       end
 
       it 'creates a new photo' do
-        response = live_photo.create(params)
+        response = live_photo.create(**params)
 
         expect(response['id']).not_to be_nil
       end
@@ -25,8 +29,8 @@ describe Onfido::LivePhoto do
       let(:file) { 'https://onfido.com/images/photo.jpg' }
 
       it 'raises an ArgumentError' do
-        expect { live_photo.create(params) }.
-          to raise_error(ArgumentError, /must be a `File`-like object/)
+        expect { live_photo.create(**params) }
+          .to raise_error(ArgumentError, /must be a `File`-like object/)
       end
     end
   end

data/spec/integrations/live_video_spec.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 
 describe Onfido::LiveVideo do
-  subject(:live_video) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:live_video) { onfido.live_video }
+
   let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
 
   describe '#find' do

data/spec/integrations/report_spec.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 describe Onfido::Report do
-  subject(:report) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:report) { onfido.report }
+
   describe '#find' do
     it 'returns a report for an existing check' do
       report_id = '6951786-123123-422221'

data/spec/integrations/resource_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+class TestResource < Onfido::Resource
+  def get(path:)
+    super(path: path)
+  end
+end
+
+describe Onfido::Resource do
+  include_context 'fake onfido api'
+
+  subject(:resource) { TestResource.new(Onfido::Options.new(api_key: 'test', region: :eu)) }
+
+  context '4xx response' do
+    it 'raises a custom error' do
+      path = '4xx_response'
+
+      expect { resource.get(path: path) }
+        .to raise_error(Onfido::RequestError, 'Something went wrong')
+    end
+  end
+
+  context 'unexpected error format' do
+    it 'raises a custom error' do
+      path = 'unexpected_error_format'
+
+      expect { resource.get(path: path) }
+        .to raise_error(Onfido::RequestError, /response code was 400/)
+    end
+  end
+
+  context 'unparseable JSON 5xx' do
+    it 'raises a server error' do
+      path = 'unparseable_response'
+
+      expect { resource.get(path: path) }
+        .to raise_error(Onfido::ServerError, /response code was 504/)
+    end
+  end
+
+  context 'timeout' do
+    before do
+      allow(RestClient::Request)
+        .to receive(:execute)
+        .and_raise(RestClient::RequestTimeout)
+    end
+
+    it 'raises a ConnectionError' do
+      expect { resource.get(path: '') }
+        .to raise_error(Onfido::ConnectionError, /Could not connect/)
+    end
+  end
+
+  context 'RestClient : BadGateway' do
+    before do
+      allow(RestClient::Request)
+        .to receive(:execute)
+        .and_raise(RestClient::BadGateway)
+    end
+
+    it 'raises a ConnectionError' do
+      expect { resource.get(path: '') }
+        .to raise_error(Onfido::ConnectionError, /Could not connect/)
+    end
+  end
+
+  context 'broken connection' do
+    before do
+      allow(RestClient::Request)
+        .to receive(:execute)
+        .and_raise(RestClient::ServerBrokeConnection)
+    end
+
+    it 'raises a ConnectionError' do
+      expect { resource.get(path: '') }
+        .to raise_error(Onfido::ConnectionError, /connection to the server/)
+    end
+  end
+
+  context 'bad SSL certificate' do
+    before do
+      allow(RestClient::Request)
+        .to receive(:execute)
+        .and_raise(RestClient::SSLCertificateNotVerified.new(nil))
+    end
+
+    it 'raises a ConnectionError' do
+      expect { resource.get(path: '') }
+        .to raise_error(Onfido::ConnectionError, /SSL certificate/)
+    end
+  end
+
+  context 'with a timeout error response' do
+    before do
+      allow_any_instance_of(RestClient::ExceptionWithResponse)
+        .to receive(:response).and_return(double(body: '', code: '408'))
+      expect(RestClient::Request).to receive(:execute)
+        .and_raise(RestClient::ExceptionWithResponse)
+    end
+
+    it 'raises a ConnectionError' do
+      expect { resource.get(path: '') }
+        .to raise_error(Onfido::ConnectionError)
+    end
+  end
+end

data/spec/integrations/sdk_token_spec.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 describe Onfido::SdkToken do
-  subject(:sdk_token) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:sdk_token) { onfido.sdk_token }
 
   describe '#create' do
     it 'creates a new SDK token for the applicant' do

data/spec/integrations/webhook_spec.rb

@@ -1,28 +1,32 @@
+# frozen_string_literal: true
+
 describe Onfido::Webhook do
-  subject(:webhook) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:webhook) { onfido.webhook }
 
-  describe "#create" do
+  describe '#create' do
     let(:params) do
       {
-        url: "https://webhookendpoint.url",
+        url: 'https://webhookendpoint.url',
         enabled: true,
         events: [
-          "report.completed",
-          "check.completed"
+          'report.completed',
+          'check.completed'
         ]
       }
     end
 
-    it "creates the webhook" do
-      response = webhook.create(params)
+    it 'creates the webhook' do
+      response = webhook.create(**params)
 
       expect(response['id']).to_not be_nil
     end
 
-    it "responds with the right url" do
-      response = webhook.create(params)
+    it 'responds with the right url' do
+      response = webhook.create(**params)
 
-      expect(response["url"]).to eq params[:url]
+      expect(response['url']).to eq params[:url]
     end
   end
 
@@ -36,22 +40,29 @@ describe Onfido::Webhook do
     end
   end
 
-  describe "#all" do
-    it "returns all the registered webhooks" do
+  describe '#destroy' do
+    it 'removes the webhook' do
+      webhook_id = 'fcb73186-0733-4f6f-9c57-d9d5ef979443'
+      expect { webhook.destroy(webhook_id) }.not_to raise_error
+    end
+  end
+
+  describe '#all' do
+    it 'returns all the registered webhooks' do
       response = webhook.all
 
-      expect(response["webhooks"].count).to eq 2
+      expect(response['webhooks'].count).to eq 2
     end
 
-    it "returns with id" do
+    it 'returns with id' do
       response = webhook.all
 
-      expect(response["webhooks"][0]["id"]).to_not be_nil
-      expect(response["webhooks"][1]["id"]).to_not be_nil
+      expect(response['webhooks'][0]['id']).to_not be_nil
+      expect(response['webhooks'][1]['id']).to_not be_nil
     end
   end
 
-  describe ".valid?" do
+  describe '.valid?' do
     subject(:valid?) do
       described_class.valid?(request_body, request_signature, token)
     end
@@ -64,34 +75,34 @@ describe Onfido::Webhook do
 
     it { is_expected.to be(true) }
 
-    context "with an invalid signature" do
+    context 'with an invalid signature' do
       let(:request_signature) do
         's21fd54ew2w1f5d15642132f3d7727ff9a32a7c87072ce514df1f6d3228bec'
       end
       it { is_expected.to be(false) }
     end
 
-    context "with a nil request signature" do
+    context 'with a nil request signature' do
       let(:request_signature) { nil }
       specify { expect { valid? }.to raise_error(ArgumentError) }
     end
 
-    context "with a token other than the one used to sign the request" do
-      let(:token) { "quite_secret_token" }
+    context 'with a token other than the one used to sign the request' do
+      let(:token) { 'quite_secret_token' }
       it { is_expected.to be(false) }
     end
 
-    context "with a nil token" do
+    context 'with a nil token' do
       let(:token) { nil }
       specify { expect { valid? }.to raise_error(ArgumentError) }
     end
 
-    context "with a modified request body" do
+    context 'with a modified request body' do
       let(:request_body) { '{"bar":"baz"}' }
       it { is_expected.to be(false) }
     end
 
-    context "with a nil request body" do
+    context 'with a nil request body' do
       let(:request_body) { nil }
       specify { expect { valid? }.to raise_error(ArgumentError) }
     end