onfido 2.9.0 → 3.0.0

data/spec/integrations/address_spec.rb

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

data/spec/integrations/monitor_spec.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-describe Onfido::Monitor do
-  include_context 'fake onfido api'
-
-  subject(:monitor) { onfido.monitor }
-
-  let(:monitor_id) { '2748c4fc-c6b8-4c1e-a383-21efa241ce1e' }
-
-  describe '#create' do
-    let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-    let(:report_name) { 'watchlist_standard' }
-
-    it 'creates a monitor for the applicant' do
-      response = monitor.create(applicant_id: applicant_id, report_name: report_name)
-      expect(response).to be_a(Hash).and include('id' => monitor_id, 'report_name' => report_name)
-    end
-  end
-
-  describe '#find' do
-    it 'returns the expected monitor' do
-      response = monitor.find(monitor_id)
-
-      expect(response).to be_a(Hash).and include('id' => monitor_id)
-    end
-  end
-
-  describe '#all' do
-    it 'returns a list of monitors' do
-      applicant_id = '1030303-123123-123123'
-      response = monitor.all(applicant_id)
-
-      expect(response['monitors']).to be_an(Array).and contain_exactly(an_instance_of(Hash))
-    end
-  end
-
-  describe '#destroy' do
-    it 'returns success code' do
-      expect { monitor.destroy(monitor_id) }.not_to raise_error
-    end
-  end
-
-  describe '#list_matches' do
-    subject(:list_matches) { monitor.list_matches(monitor_id) }
-
-    it do
-      is_expected
-        .to include('matches' => [hash_including('id' => anything, 'enabled' => true), anything])
-    end
-
-    context 'when the monitor_id does not exist' do
-      let(:monitor_id) { '00000000-c6b8-4c1e-a383-21efa241ce1e' }
-
-      it 'raises an error' do
-        expect { list_matches }.to raise_error(Onfido::RequestError, /404/)
-      end
-    end
-  end
-
-  describe '#set_match_status' do
-    subject(:set_match_status) { monitor.set_match_status(monitor_id, **payload) }
-
-    let(:payload) do
-      {
-        disabled: ['925e47d3-9e21-48d4-b570-9564c4282cec'],
-        enabled: ['37afcacb-5ff0-4b09-831d-5bcc672ca1fb']
-      }
-    end
-
-    it do
-      is_expected
-        .to include('matches' => [hash_including('id' => anything, 'enabled' => true), anything])
-    end
-
-    context 'when a match id is both in enabled and disabled' do
-      before { payload[:disabled] << payload[:enabled][0] }
-
-      it 'raises an error' do
-        expect { set_match_status }
-          .to raise_error(
-            an_instance_of(Onfido::RequestError).and(having_attributes(response_code: 422))
-          )
-      end
-    end
-
-    context 'when not passing any enabled or disabled ids' do
-      let(:payload) { {} }
-
-      it { is_expected.to be_nil }
-    end
-
-    context 'when the monitor_id does not exist' do
-      let(:monitor_id) { '00000000-c6b8-4c1e-a383-21efa241ce1e' }
-
-      it 'raises an error' do
-        expect { set_match_status }.to raise_error(Onfido::RequestError, /404/)
-      end
-    end
-  end
-end

data/spec/integrations/resource_spec.rb

@@ -1,106 +0,0 @@
-# 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/onfido/api_spec.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-describe Onfido::API do
-  before do
-    allow(Onfido::Options).to receive(:new).and_call_original
-  end
-
-  let(:options) do
-    {
-      api_key: 'test',
-      region: :eu,
-      open_timeout: 1,
-      read_timeout: 2
-    }
-  end
-
-  it 'passes through options' do
-    described_class.new(**options)
-
-    expect(Onfido::Options).to have_received(:new).with(**options)
-  end
-end

data/spec/onfido/connection_error_spec.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-describe Onfido::ConnectionError do
-  subject(:error) do
-    described_class.new(
-      'Invalid response object from API',
-      response_code: response_code,
-      response_body: response_body
-    )
-  end
-
-  let(:response_code) { nil }
-  let(:response_body) { nil }
-
-  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 }
-  end
-end

data/spec/onfido/options_spec.rb

@@ -1,39 +0,0 @@
-# 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.6/'
-    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,36 +0,0 @@
-# frozen_string_literal: true
-
-describe Onfido::RequestError do
-  subject(:error) do
-    described_class.new(
-      failed_response['error']['message'],
-      response_code: 401,
-      response_body: failed_response.to_json
-    )
-  end
-
-  let(:failed_response) do
-    {
-      'error' =>
-      {
-        'id' => '551722cc964860653c00c202',
-        'type' => 'authorization_error',
-        'message' => 'Authorization error: please re-check your credentials',
-        'fields' => { 'name' => { 'messages' => ['cannot be blank'] } }
-      }
-    }
-  end
-
-  it 'returns the right message' do
-    expect { raise error }
-      .to raise_error('Authorization error: please re-check your credentials')
-  end
-
-  its(:type) { is_expected.to eq('authorization_error') }
-  its(:response_code) { is_expected.to eq(401) }
-  its(:response_body) { is_expected.to eq(failed_response.to_json) }
-  its(:json_body) { is_expected.to eq(failed_response) }
-  its(:fields) do
-    is_expected.to eq('name' => { 'messages' => ['cannot be blank'] })
-  end
-end

data/spec/support/fake_onfido_api.rb

@@ -1,295 +0,0 @@
-# frozen_string_literal: true
-
-require 'sinatra/base'
-
-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
-  before do
-    begin
-      if request.content_type == 'application/json; charset=utf-8'
-        body_parameters = JSON.parse(request.body.read)
-        params.merge!(body_parameters) if body_parameters
-      end
-    rescue JSON::ParserError
-    end
-  end
-
-  get '/v3.6/addresses/pick' do
-    json_response(200, 'addresses.json')
-  end
-
-  post '/v3.6/applicants' do
-    json_response(201, 'applicant.json')
-  end
-
-  put '/v3.6/applicants/:id' do
-    json_response(200, 'applicant.json')
-  end
-
-  get '/v3.6/applicants/:id' do
-    json_response(200, 'applicant.json')
-  end
-
-  get '/v3.6/applicants' do
-    response = json_response(200, 'applicants.json')
-    { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
-  end
-
-  delete '/v3.6/applicants/:id' do
-    status 204
-  end
-
-  post '/v3.6/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.6/documents' do
-    json_response(201, 'document.json')
-  end
-
-  post '/v3.6/extractions' do
-    json_response(201, 'extraction.json')
-  end
-
-  get '/v3.6/documents/:id' do
-    json_response(200, 'document.json')
-  end
-
-  get '/v3.6/documents' do
-    json_response(200, 'documents.json')
-  end
-
-  get '/v3.6/documents/:id/download' do
-    status 200
-    content_type 'application/octet-stream'
-    "\x01\x02\x03" # acts as binary file data
-  end
-
-  post '/v3.6/live_photos' do
-    json_response(201, 'live_photo.json')
-  end
-
-  get '/v3.6/live_photos/:id' do
-    json_response(200, 'live_photo.json')
-  end
-
-  get '/v3.6/live_photos' do
-    if params['applicant_id'] == '1030303-123123-123123'
-      json_response(200, 'live_photos.json')
-    else
-      status 404
-    end
-  end
-
-  get '/v3.6/live_photos/:id/download' do
-    status 200
-    content_type 'image/jpeg'
-    "\x01\x02\x03" # acts as binary file data
-  end
-
-  get '/v3.6/live_videos/:id' do
-    json_response(200, 'live_video.json')
-  end
-
-  get '/v3.6/live_videos' do
-    if params['applicant_id'] == '1030303-123123-123123'
-      json_response(200, 'live_videos.json')
-    else
-      status 404
-    end
-  end
-
-  get '/v3.6/live_videos/:id/download' do
-    status 200
-    content_type 'video/quicktime'
-    "\x01\x02\x03" # acts as binary file data
-  end
-
-  post '/v3.6/watchlist_monitors' do
-    json_response(201, 'monitor.json')
-  end
-
-  get '/v3.6/watchlist_monitors/:id' do
-    json_response(200, 'monitor.json')
-  end
-
-  get '/v3.6/watchlist_monitors' do
-    if params['applicant_id'] == '1030303-123123-123123'
-      json_response(200, 'monitors.json')
-    else
-      status 404
-    end
-  end
-
-  delete '/v3.6/watchlist_monitors/:id' do
-    status 204
-  end
-
-  get '/v3.6/watchlist_monitors/:monitor_id/matches' do
-    if params['monitor_id'] == '2748c4fc-c6b8-4c1e-a383-21efa241ce1e'
-      json_response(200, 'monitor_matches.json')
-    else
-      status 404
-    end
-  end
-
-  patch '/v3.6/watchlist_monitors/:monitor_id/matches' do
-    if params['monitor_id'] == '2748c4fc-c6b8-4c1e-a383-21efa241ce1e'
-      enabled, disabled = params.values_at('enabled', 'disabled')
-      if enabled&.any? || disabled&.any?
-        if (enabled.to_a & disabled.to_a).any?
-          json_response(422, '4xx_response.json')
-        else
-          json_response(200, 'monitor_matches.json')
-        end
-      else
-        status 204
-      end
-    else
-      status 404
-    end
-  end
-
-  get '/v3.6/motion_captures/:id' do
-    json_response(200, 'motion_capture.json')
-  end
-
-  get '/v3.6/motion_captures' do
-    if params['applicant_id'] == '1030303-123123-123123'
-      json_response(200, 'motion_captures.json')
-    else
-      status 404
-    end
-  end
-
-  get '/v3.6/motion_captures/:id/download' do
-    status 200
-    content_type 'video/mp4'
-    "\x01\x02\x03" # acts as binary file data
-  end
-
-  get '/v3.6/motion_captures/:id/frame' do
-    status 200
-    content_type 'image/jpeg'
-    "\x01\x02\x03" # acts as binary file data
-  end
-
-  post '/v3.6/checks' do
-    params['applicant_id'].nil? ? status(422) : json_response(201, 'check.json')
-  end
-
-  get '/v3.6/checks/:id' do
-    json_response(200, 'check.json')
-  end
-
-  get '/v3.6/checks' do
-    json_response(200, 'checks.json')
-  end
-
-  post '/v3.6/checks/:id/resume' do
-    status 204 # no_content
-  end
-
-  get '/v3.6/checks/:id/download' do
-    status 200
-    content_type 'application/pdf'
-    "\x01\x02\x03" # acts as binary file data
-  end
-
-  get '/v3.6/reports' do
-    json_response(200, 'reports.json')
-  end
-
-  get '/v3.6/reports/:id' do
-    json_response(200, 'report.json')
-  end
-
-  post '/v3.6/reports/:id/resume' do
-    status 204
-  end
-
-  post '/v3.6/reports/:id/cancel' do
-    status 204
-  end
-
-  post '/v3.6/sdk_token' do
-    json_response(201, 'sdk_token.json')
-  end
-
-  post '/v3.6/webhooks' do
-    json_response(201, 'webhook.json')
-  end
-
-  get '/v3.6/webhooks/:id' do
-    json_response(200, 'webhook.json')
-  end
-
-  delete '/v3.6/webhooks/:id' do
-    status 204
-  end
-
-  get '/v3.6/webhooks' do
-    json_response(200, 'webhooks.json')
-  end
-
-  post '/v3.6/workflow_runs' do
-    json_response(201, 'workflow_run.json')
-  end
-
-  get '/v3.6/workflow_runs/:id' do
-    json_response(200, 'workflow_run.json')
-  end
-
-  get '/v3.6/workflow_runs/:id/signed_evidence_file' do
-    pdf_response(200, 'signed_workflow_run.pdf')
-  end
-
-  get '/v3.6/workflow_runs' do
-    json_response(200, 'workflow_runs.json')
-  end
-
-  get '/v3.6/4xx_response' do
-    json_response(422, '4xx_response.json')
-  end
-
-  get '/v3.6/unexpected_error_format' do
-    json_response(400, 'unexpected_error_format.json')
-  end
-
-  get '/v3.6/unparseable_response' do
-    content_type :json
-    status 504
-    ''
-  end
-
-  private
-
-  def json_response(response_code, file_name)
-    fixture_response(response_code, file_name, 'application/json')
-  end
-
-  def fixture_response(response_code, file_name, custom_content_type)
-    content_type "#{custom_content_type}; charset=utf-8"
-    status response_code
-    File.binread("#{File.dirname(__FILE__)}/fixtures/#{file_name}")
-  end
-
-  def pdf_response(response_code, file_name)
-    fixture_response(response_code, file_name, 'application/pdf')
-  end
-
-  def pagination_range
-    start = (params.fetch('page').to_i - 1) * 20
-    limit = start + params.fetch('per_page').to_i - 1
-    start..limit
-  end
-end

data/spec/support/fixtures/4xx_response.json

@@ -1,14 +0,0 @@
-{
-  "error": {
-    "id": "544f95539648607d03001542",
-    "type": "validation_error",
-    "message": "Something went wrong",
-    "fields": {
-      "email": {
-        "messages": [
-          "invalid format"
-        ]
-      }
-    }
-  }
-}

data/spec/support/fixtures/addresses.json

@@ -1,24 +0,0 @@
-{
-  "addresses": [
-    {
-      "flat_number": "",
-      "building_number": "100",
-      "building_name": "",
-      "street": "Main Street",
-      "sub_street": "",
-      "town": "London",
-      "postcode": "SW4 6EH",
-      "country": "GBR"
-    },
-    {
-      "flat_number": "",
-      "building_number": "101",
-      "building_name": "",
-      "street": "Main Street",
-      "sub_street": "",
-      "town": "London",
-      "postcode": "SW4 6EH",
-      "country": "GBR"
-    }
-  ]
-}

data/spec/support/fixtures/applicant.json

@@ -1,28 +0,0 @@
-{
-  "id":"61f659cb-c90b-4067-808a-6136b5c01351",
-  "created_at":"2015-04-10T13:16:01Z",
-  "title":"Mr",
-  "first_name":"Chandler",
-  "middle_name":"Muriel",
-  "last_name":"Bing",
-  "email":"chandler_bing_6@friends.com",
-  "dob":"1968-04-08",
-  "href":"/v3.6/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
-  "id_numbers":[],
-  "address": {
-    "flat_number":"4",
-    "building_number":"100",
-    "building_name":"Awesome Building",
-    "street":"Main Street",
-    "sub_street":"A sub street",
-    "town":"London",
-    "state":"",
-    "postcode":"SW4 6EH",
-    "country":"GBR"
-  },
-  "location": {
-    "ip_address": "127.0.0.1",
-    "country_of_residence": "GBR"
-  },
-  "phone_number": "910100100"
-}