onfido 0.15.0 → 2.0.0

data/spec/integrations/document_spec.rb

@@ -1,20 +1,24 @@
+# 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
       {
-        type: 'passport',
-        side: 'back',
-        file: file
+        applicant_id: '1030303-123123-123123',
+        type: 'driving_licence',
+        file: file,
+        side: 'front'
       }
     end
-    let(:applicant_id) { '1030303-123123-123123' }
 
     context 'with a File-like object to upload' do
-      let(:file) { Tempfile.new(['passport', '.jpg']) }
+      let(:file) { Tempfile.new(['driving_licence', '.jpg']) }
 
       after do
         file.close
@@ -22,7 +26,8 @@ describe Onfido::Document do
       end
 
       it 'creates a new document' do
-        response = document.create('foobar', params)
+        response = document.create(**params)
+
         expect(response['id']).not_to be_nil
       end
     end
@@ -31,37 +36,35 @@ describe Onfido::Document do
       let(:file) { 'https://onfido.com/images/logo.png' }
 
       it 'raises an ArgumentError' do
-        expect { document.create('foobar', 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
 
   describe '#find' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:document_id) { '7568415-123123-123123' }
-
     it 'returns the expected document' do
-      response = document.find(applicant_id, document_id)
+      document_id = '7568415-123123-123123'
+      response = document.find(document_id)
+
       expect(response['id']).to eq(document_id)
     end
   end
 
   describe '#all' do
-    let(:applicant_id) { '1030303-123123-123123' }
-
     it 'returns list of documents' do
+      applicant_id = '1030303-123123-123123'
       response = document.all(applicant_id)
+
       expect(response['documents']).not_to be_empty
     end
   end
 
   describe '#download' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:document_id) { '1212121-123123-123123' }
-
     it 'returns the file data' do
-      response = document.download(applicant_id, document_id)
+      document_id = '1212121-123123-123123'
+      response = document.download(document_id)
+
       expect(response).not_to be_nil
     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,10 +1,14 @@
+# 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) { { file: file } }
+    let(:params) { { applicant_id: '123456', file: file } }
 
     context 'with a File-like object to upload' do
       let(:file) { Tempfile.new(['passport', '.jpg']) }
@@ -15,7 +19,8 @@ describe Onfido::LivePhoto do
       end
 
       it 'creates a new photo' do
-        response = live_photo.create('foobar', params)
+        response = live_photo.create(**params)
+
         expect(response['id']).not_to be_nil
       end
     end
@@ -24,37 +29,35 @@ describe Onfido::LivePhoto do
       let(:file) { 'https://onfido.com/images/photo.jpg' }
 
       it 'raises an ArgumentError' do
-        expect { live_photo.create('foobar', 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
 
   describe '#find' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:live_photo_id) { '3538c8f6-fdce-4745-9d34-fc246bc05aa1' }
-
     it 'returns the expected live photo' do
-      response = live_photo.find(applicant_id, live_photo_id)
+      live_photo_id = '3538c8f6-fdce-4745-9d34-fc246bc05aa1'
+      response = live_photo.find(live_photo_id)
+
       expect(response['id']).to eq(live_photo_id)
     end
   end
 
   describe '#all' do
-    let(:applicant_id) { '1030303-123123-123123' }
-
     it 'returns list of documents' do
+      applicant_id = '1030303-123123-123123'
       response = live_photo.all(applicant_id)
+
       expect(response['live_photos']).not_to be_empty
     end
   end
 
   describe '#download' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:live_photo_id) { '3538c8f6-fdce-4745-9d34-fc246bc05aa1' }
-
     it 'returns the file data' do
-      response = live_photo.download(applicant_id, live_photo_id)
+      live_photo_id = '3538c8f6-fdce-4745-9d34-fc246bc05aa1'
+      response = live_photo.download(live_photo_id)
+
       expect(response).not_to be_nil
     end
   end

data/spec/integrations/live_video_spec.rb

@@ -1,33 +1,35 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 
 describe Onfido::LiveVideo do
-  subject(:live_video) { described_class.new }
+  include_context 'fake onfido api'
 
-  describe '#find' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
+  subject(:live_video) { onfido.live_video }
+
+  let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
 
+  describe '#find' do
     it 'returns the expected live photo' do
-      response = live_video.find(applicant_id, live_video_id)
+      response = live_video.find(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
+      applicant_id = '1030303-123123-123123'
       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)
+      response = live_video.download(live_video_id)
+
       expect(response).not_to be_nil
     end
   end

data/spec/integrations/report_spec.rb

@@ -1,38 +1,41 @@
+# frozen_string_literal: true
+
 describe Onfido::Report do
-  subject(:report) { described_class.new }
-  let(:check_id) { '8546921-123123-123123' }
+  include_context 'fake onfido api'
 
-  describe '#find' do
-    let(:report_id) { '6951786-123123-422221' }
+  subject(:report) { onfido.report }
 
+  describe '#find' do
     it 'returns a report for an existing check' do
-      response = report.find(check_id, report_id)
+      report_id = '6951786-123123-422221'
+      response = report.find(report_id)
+
       expect(response['id']).to eq(report_id)
     end
   end
 
   describe '#all' do
     it 'lists all reports for an existing check' do
+      check_id = '8546921-123123-123123'
       response = report.all(check_id)
+
       expect(response['reports'].count).to eq(2)
     end
   end
 
   describe '#resume' do
-    let(:report_id) { '6951786-123123-422221' }
-    let(:check_id) { '1212121-123123-422221' }
-
     it 'returns a success response' do
-      expect { report.resume(check_id, report_id) }.not_to raise_error
+      report_id = '6951786-123123-422221'
+
+      expect { report.resume(report_id) }.not_to raise_error
     end
   end
 
   describe '#cancel' do
-    let(:report_id) { '6951786-123123-422221' }
-    let(:check_id) { '1212121-123123-422221' }
-
     it 'returns a success response' do
-      expect { report.cancel(check_id, report_id) }.not_to raise_error
+      report_id = '6951786-123123-422221'
+
+      expect { report.cancel(report_id) }.not_to raise_error
     end
   end
 end

data/spec/integrations/resource_spec.rb

@@ -0,0 +1,93 @@
+# 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 '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,13 +1,17 @@
+# frozen_string_literal: true
+
 describe Onfido::SdkToken do
-  subject(:sdk_token) { described_class.new }
-  let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-  let(:referrer) { 'http://*.mywebsite.com/*' }
+  include_context 'fake onfido api'
 
-  describe '#create' do
-    let(:params) { { applicant_id: applicant_id, referrer: referrer } }
+  subject(:sdk_token) { onfido.sdk_token }
 
+  describe '#create' do
     it 'creates a new SDK token for the applicant' do
-      response = sdk_token.create(params)
+      applicant_id = '61f659cb-c90b-4067-808a-6136b5c01351'
+      referrer = 'http://*.mywebsite.com/*'
+
+      response = sdk_token.create(applicant_id: applicant_id, referrer: referrer)
+
       expect(response['token']).not_to be_nil
     end
   end

data/spec/integrations/webhook_spec.rb

@@ -1,89 +1,108 @@
+# frozen_string_literal: true
+
 describe Onfido::Webhook do
-  subject(:webhook) { described_class.new }
-  let(:params) do
-    {
-      "url" => "https://webhookendpoint.url",
-      "enabled" => true,
-      "events" => [
-        "report completion",
-        "report withdrawal",
-        "check completion",
-        "check in progress"
-      ]
-    }
-  end
+  include_context 'fake onfido api'
+
+  subject(:webhook) { onfido.webhook }
+
+  describe '#create' do
+    let(:params) do
+      {
+        url: 'https://webhookendpoint.url',
+        enabled: true,
+        events: [
+          'report.completed',
+          'check.completed'
+        ]
+      }
+    end
+
+    it 'creates the webhook' do
+      response = webhook.create(**params)
 
-  describe "#create" do
-    it "cretes 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)
-      expect(response["url"]).to eq params["url"]
+    it 'responds with the right url' do
+      response = webhook.create(**params)
+
+      expect(response['url']).to eq params[:url]
     end
   end
 
   describe '#find' do
-    let(:webhook_id) { 'fcb73186-0733-4f6f-9c57-d9d5ef979443' }
-
     it 'returns the webhook' do
+      webhook_id = 'fcb73186-0733-4f6f-9c57-d9d5ef979443'
+
       response = webhook.find(webhook_id)
+
       expect(response['id']).to eq(webhook_id)
     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
 
     let(:request_body) { '{"foo":"bar"}' }
-    let(:request_signature) { 'fdab9db604d33297741b43b9fc9536028d09dca3' }
+    let(:request_signature) do
+      '89e60408fec20bfb26bb0f993d5e88307818982f50f23b361a00d679bae8b1dc'
+    end
     let(:token) { 'very_secret_token' }
 
     it { is_expected.to be(true) }
 
-    context "with an invalid signature" do
-      let(:request_signature) { '2f3d7727ff9a32a7c87072ce514df1f6d3228bec' }
+    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