onfido 1.0.0 → 2.0.2

data/spec/onfido/api_spec.rb

@@ -1,33 +1,22 @@
-describe Onfido::API do
-  subject(:api) { described_class.new }
-
-  describe 'given a single-word resource' do
-    specify { expect(api.address).to be_a(Onfido::Address) }
-  end
+# frozen_string_literal: true
 
-  describe 'given a multi-word resource' do
-    specify { expect(api.live_photo).to be_a(Onfido::LivePhoto) }
-  end
-
-  describe 'given an unknown resource' do
-    specify { expect { api.blood_test }.to raise_error(NameError) }
+describe Onfido::API do
+  before do
+    allow(Onfido::Options).to receive(:new).and_call_original
   end
 
-  describe 'given no API key' do
-    it 'uses nil for the resource API key' do
-      expect(Onfido::Address).to receive(:new).with(nil)
-      api.address
-    end
+  let(:options) do
+    {
+      api_key: 'test',
+      region: :eu,
+      open_timeout: 1,
+      read_timeout: 2
+    }
   end
 
-  describe 'given an API key' do
-    let(:api_key) { 'some_key' }
-
-    subject(:api) { described_class.new(api_key: api_key) }
+  it 'passes through options' do
+    described_class.new(**options)
 
-    it 'uses that key to create the resource' do
-      expect(Onfido::Address).to receive(:new).with(api_key)
-      api.address
-    end
+    expect(Onfido::Options).to have_received(:new).with(**options)
   end
 end

data/spec/onfido/connection_error_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 describe Onfido::ConnectionError do
   subject(:error) do
     described_class.new(
-      "Invalid response object from API",
+      'Invalid response object from API',
       response_code: response_code,
       response_body: response_body
     )
@@ -10,7 +12,7 @@ describe Onfido::ConnectionError do
   let(:response_code) { nil }
   let(:response_body) { nil }
 
-  context "without a response_body" do
+  context 'without a response_body' do
     its(:json_body) { is_expected.to be_nil }
     its(:type) { is_expected.to be_nil }
     its(:fields) { is_expected.to be_nil }

data/spec/onfido/options_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe Onfido::Options do
+  subject(:options) do
+    described_class.new(
+      api_key: 'test',
+      region: :us,
+      open_timeout: 1,
+      read_timeout: 2
+    )
+  end
+
+  it 'checks region is valid' do
+    expect { described_class.new(api_key: 'test', region: :aa) }.to raise_error 'Unknown region aa'
+  end
+
+  context 'when creating rest client resource' do
+    let(:rest_client) { options.rest_client }
+
+    it 'configures with headers' do
+      expect(rest_client.options[:headers]).to eq(
+        'Accept' => 'application/json',
+        'Authorization' => 'Token token=test',
+        'User-Agent' => "onfido-ruby/#{Onfido::VERSION}"
+      )
+    end
+
+    it 'configures with region' do
+      expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.1/'
+    end
+
+    it 'configures with timeouts' do
+      expect(rest_client.options).to include(
+        open_timeout: 1,
+        read_timeout: 2
+      )
+    end
+  end
+end

data/spec/onfido/request_error_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe Onfido::RequestError do
   subject(:error) do
     described_class.new(
@@ -20,8 +22,8 @@ describe Onfido::RequestError do
   end
 
   it 'returns the right message' do
-    expect { raise error }.
-      to raise_error('Authorization error: please re-check your credentials')
+    expect { raise error }
+      .to raise_error('Authorization error: please re-check your credentials')
   end
 
   its(:type) { is_expected.to eq('authorization_error') }

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-Dir[File.dirname(__FILE__).concat("/support/**/*.rb")].each { |f| require f }
+Dir[File.dirname(__FILE__).concat('/support/**/*.rb')].sort.each { |f| require f }
 
 require 'onfido'
 require 'webmock/rspec'
@@ -40,8 +42,4 @@ RSpec.configure do |config|
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand config.seed
-
-  config.before(:each) do
-    stub_request(:any, /onfido.com/).to_rack(FakeOnfidoAPI)
-  end
 end

data/spec/support/fake_onfido_api.rb

@@ -1,154 +1,177 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
-class FakeOnfidoAPI < Sinatra::Base
-  get '/v3/addresses/pick' do
+RSpec.shared_context 'fake onfido api' do
+  let(:onfido) { Onfido::API.new(api_key: 'test', region: :eu) }
+
+  before { stub_request(:any, /api.eu.onfido.com/).to_rack(FakeOnfidoAPI) }
+end
+
+class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
+  get '/v3.1/addresses/pick' do
     json_response(200, 'addresses.json')
   end
 
-  post '/v3/applicants' do
+  post '/v3.1/applicants' do
     json_response(201, 'applicant.json')
   end
 
-  put '/v3/applicants/:id' do
+  put '/v3.1/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v3/applicants/:id' do
+  get '/v3.1/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v3/applicants' do
+  get '/v3.1/applicants' do
     response = json_response(200, 'applicants.json')
     { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
   end
 
-  delete '/v3/applicants/:id' do
+  delete '/v3.1/applicants/:id' do
     status 204
   end
 
-  post '/v3/applicants/:id/restore' do
-    if params["id"] == "a2fb9c62-ab10-4898-a8ec-342c4b552ad5"
+  post '/v3.1/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 '/v3/documents' do
+  post '/v3.1/documents' do
     json_response(201, 'document.json')
   end
 
-  get '/v3/documents/:id' do
+  post '/v3.1/extractions' do
+    json_response(201, 'extraction.json')
+  end
+
+  get '/v3.1/documents/:id' do
     json_response(200, 'document.json')
   end
 
-  get '/v3/documents' do
+  get '/v3.1/documents' do
     json_response(200, 'documents.json')
   end
 
-  get '/v3/documents/:id/download' do
+  get '/v3.1/documents/:id/download' do
     status 200
     content_type 'application/octet-stream'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3/live_photos' do
+  post '/v3.1/live_photos' do
     json_response(201, 'live_photo.json')
   end
 
-  get '/v3/live_photos/:id' do
+  get '/v3.1/live_photos/:id' do
     json_response(200, 'live_photo.json')
   end
 
-  get '/v3/live_photos' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
+  get '/v3.1/live_photos' do
+    if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'live_photos.json')
+    else
+      status 404
     end
   end
 
-  get '/v3/live_photos/:id/download' do
+  get '/v3.1/live_photos/:id/download' do
     status 200
     content_type 'image/jpeg'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v3/live_videos/:id' do
+  get '/v3.1/live_videos/:id' do
     json_response(200, 'live_video.json')
   end
 
-  get '/v3/live_videos' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
+  get '/v3.1/live_videos' do
+    if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'live_videos.json')
+    else
+      status 404
     end
   end
 
-  get '/v3/live_videos/:id/download' do
+  get '/v3.1/live_videos/:id/download' do
     status 200
     content_type 'video/quicktime'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3/checks' do
-    params["applicant_id"].nil? ? status(422) : json_response(201, 'check.json')
+  post '/v3.1/checks' do
+    params['applicant_id'].nil? ? status(422) : json_response(201, 'check.json')
   end
 
-  get '/v3/checks/:id' do
-    json_response(200, "check.json")
+  get '/v3.1/checks/:id' do
+    json_response(200, 'check.json')
   end
 
-  get '/v3/checks' do
-    json_response(200, "checks.json")
+  get '/v3.1/checks' do
+    json_response(200, 'checks.json')
   end
 
-  post '/v3/checks/:id/resume' do
+  post '/v3.1/checks/:id/resume' do
     status 204 # no_content
   end
 
-  get '/v3/reports' do
+  get '/v3.1/checks/:id/download' do
+    status 200
+    content_type 'application/pdf'
+    "\x01\x02\x03" # acts as binary file data
+  end
+
+  get '/v3.1/reports' do
     json_response(200, 'reports.json')
   end
 
-  get '/v3/reports/:id' do
+  get '/v3.1/reports/:id' do
     json_response(200, 'report.json')
   end
 
-  post '/v3/reports/:id/resume' do
+  post '/v3.1/reports/:id/resume' do
     status 204
   end
 
-  post '/v3/reports/:id/cancel' do
+  post '/v3.1/reports/:id/cancel' do
     status 204
   end
 
-  post '/v3/sdk_token' do
+  post '/v3.1/sdk_token' do
     json_response(201, 'sdk_token.json')
   end
 
-  post '/v3/webhooks' do
+  post '/v3.1/webhooks' do
     json_response(201, 'webhook.json')
   end
 
-  get '/v3/webhooks/:id' do
+  get '/v3.1/webhooks/:id' do
     json_response(200, 'webhook.json')
   end
 
-  get '/v3/webhooks' do
+  delete '/v3.1/webhooks/:id' do
+    content_type 'application/json; charset=utf-8'
+    status 204
+  end
+
+  get '/v3.1/webhooks' do
     json_response(200, 'webhooks.json')
   end
 
-  get '/v3/4xx_response' do
+  get '/v3.1/4xx_response' do
     json_response(422, '4xx_response.json')
   end
 
-  get '/v3/unexpected_error_format' do
+  get '/v3.1/unexpected_error_format' do
     json_response(400, 'unexpected_error_format.json')
   end
 
-  get '/v3/unparseable_response' do
+  get '/v3.1/unparseable_response' do
     content_type :json
     status 504
     ''
@@ -157,9 +180,9 @@ class FakeOnfidoAPI < Sinatra::Base
   private
 
   def json_response(response_code, file_name)
-    content_type "application/json; charset=utf-8"
+    content_type 'application/json; charset=utf-8'
     status response_code
-    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+    File.open("#{File.dirname(__FILE__)}/fixtures/#{file_name}", 'rb').read
   end
 
   def pagination_range

data/spec/support/fixtures/applicant.json

@@ -7,7 +7,7 @@
   "last_name":"Bing",
   "email":"chandler_bing_6@friends.com",
   "dob":"1968-04-08",
-  "href":"/v3/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
+  "href":"/v3.1/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
   "id_numbers":[],
   "address": {
     "flat_number":"4",

data/spec/support/fixtures/check.json

@@ -1,7 +1,7 @@
 {
   "id": "8546921-123123-123123",
   "created_at": "2019-05-23T13:50:33Z",
-  "href": "/v3/checks/8546921-123123-123123",
+  "href": "/v3.1/checks/8546921-123123-123123",
   "applicant_provides_data": "false",
   "status": "pending",
   "result": "pending",

data/spec/support/fixtures/checks.json

@@ -3,7 +3,7 @@
         {
             "id": "8546921-123123-123123",
             "created_at": "2019-11-23T13:50:33Z",
-            "href": "/v3/checks/8546921-123123-123123",
+            "href": "/v3.1/checks/8546921-123123-123123",
             "applicant_provides_data": "false",
             "status": "pending",
             "result": "pending",

data/spec/support/fixtures/document.json

@@ -1,7 +1,7 @@
 {
   "id": "7568415-123123-123123",
   "created_at": "2019-11-23 13:50:33Z",
-  "href": "/v3/documents/7568415-123123-123123",
+  "href": "/v3.1/documents/7568415-123123-123123",
   "file_name": "passport.jpg",
   "file_type": "png",
   "file_size": 282870,

data/spec/support/fixtures/documents.json

@@ -3,7 +3,7 @@
     {
       "id": "7568415-123123-123123",
       "created_at": "2019-11-23 13:50:33Z",
-      "href": "/v3/documents/7568415-123123-123123",
+      "href": "/v3.1/documents/7568415-123123-123123",
       "file_name": "passport.jpg",
       "file_type": "png",
       "file_size": 282870,
@@ -12,7 +12,7 @@
     {
       "id": "121122-123123-123123",
       "created_at": "2019-11-23 13:50:40Z",
-      "href": "/v3/documents/7568415-123123-123123",
+      "href": "/v3.1/documents/7568415-123123-123123",
       "file_name": "driving_licence.png",
       "file_type": "png",
       "file_size": 282870,

data/spec/support/fixtures/extraction.json

@@ -0,0 +1,23 @@
+{
+  "document_id": "7568415-123123-123123",
+  "document_classification": {
+    "issuing_country": "FRA",
+    "document_type": "national_identity_card"
+  },
+  "extracted_data": {
+    "date_of_birth": "1965-09-08",
+    "document_number": "400925733",
+    "first_name": "MARIE",
+    "gender": "Female",
+    "last_name": "MAVARINE",
+    "mrz_line1": "P<GBRDU<MARIE<<MAVARINE<<<<<<<<<<<<<<<<<<<<<",
+    "mrz_line2": "4009257333GBR6509088F1307072<<<<<<<<<<<<<<06",
+    "nationality": "BRITISH CITIZEN",
+    "full_name": "MAVARINE DU MARIE",
+    "date_of_expiry": "2013-07-07",
+    "middle_name": "DU",
+    "address_line_1": "52 RUE DES FLEURS",
+    "address_line_2": "33500 BORDEAUX",
+    "address_line_3": "FRANCE"
+  }
+}