onfido 0.0.1

data/spec/integrations/report_spec.rb

@@ -0,0 +1,20 @@
+describe Onfido::Report do
+  subject(:report) { described_class.new }
+  let(:check_id) { '8546921-123123-123123' }
+
+  describe '#find' do
+    let(:report_id) {'6951786-123123-422221' }
+
+    it 'returns a report for an existing check' do
+      response = report.find(check_id, report_id)
+      expect(response['id']).to eq(report_id)
+    end
+  end
+
+  describe '#all' do
+    it 'lists all reports for an existing check' do
+      response = report.all(check_id)
+      expect(response['reports'].count).to eq(2)
+    end
+  end
+end

data/spec/onfido/request_error_spec.rb

@@ -0,0 +1,39 @@
+describe Onfido::RequestError do
+  subject(:error) do
+    described_class.new(failed_response['error']['message']).tap do |e|
+      e.type = failed_response['error']['type']
+      e.fields = failed_response['error']['fields']
+      e.response_code = 401
+    end
+  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
+
+  context 'when there is a request error' do
+    it 'returns the right message' do
+      expect { raise error }.to raise_error('Authorization error: please re-check your credentials')
+    end
+
+    it 'has the right error type' do
+      expect(error.type).to eq('authorization_error')
+    end
+
+    it 'has the right affected fields' do
+      expect(error.fields).to eq({'name' => {'messages' => ['cannot be blank']} })
+    end
+
+    it 'has the right response code' do
+      expect(error.response_code).to eq(401)
+    end
+  end
+end

data/spec/onfido/resource_spec.rb

@@ -0,0 +1,63 @@
+describe Onfido::Resource do
+  subject(:resource) { described_class.new }
+  let(:endpoint) { 'https://api.onfido.com/v1/' }
+  let(:path) { 'addresses/pick' }
+  let(:api_key) { 'some_key' }
+
+  before do
+    allow(Onfido).to receive(:endpoint).and_return(endpoint)
+    allow(Onfido).to receive(:api_key).and_return(api_key)
+  end
+
+  describe '#url_for' do
+    it 'composes the full api url' do
+      expect(resource.url_for(path)).to eq(endpoint + path)
+    end
+  end
+
+  describe '#method_missing' do
+    %i(put delete patch).each do |method|
+      context "for unsupported HTTP method: #{method}" do
+        it 'raises an error' do
+          expect {
+            resource.public_send(method)
+          }.to raise_error(NoMethodError)
+        end
+      end
+    end
+
+    %i(get post).each do |method|
+      context "for supported HTTP method: #{method}" do
+        let(:url) { endpoint + path }
+        let(:payload) { {postcode: 'SE1 4NG'} }
+        let(:response) do
+          {
+            'addresses' => [
+              {
+                'street' => 'Main Street',
+                'town' => 'London',
+                'postcode' => 'SW4 6EH',
+                'country' => 'GBR'
+              }
+            ]
+          }
+        end
+
+        before do
+          expect(RestClient::Request).to receive(:execute)
+            .with(
+              url: url,
+              payload: Rack::Utils.build_query(payload),
+              method: method,
+              headers: resource.headers
+            )
+            .and_return(response)
+        end
+
+        it 'makes a request to an endpoint' do
+          expect(resource.public_send(method, {url: url, payload: payload})).to eq(response)
+        end
+      end
+    end
+  end
+end

data/spec/onfido/response_handler_spec.rb

@@ -0,0 +1,79 @@
+describe Onfido::ResponseHandler do
+  subject(:handler) { described_class.new(response) }
+
+  describe '#parse!' do
+    before do
+      allow(Onfido).to receive(:throws_exceptions).and_return(throws_exceptions)
+    end
+
+    let(:throws_exceptions) { true }
+
+    context 'when the response is successful' do
+      let(:response) { hashified_response.to_json }
+      let(:hashified_response) do
+        {'success' => 'applicant was successfully created'}
+      end
+
+      it 'parses the body and returns it' do
+        expect(handler.parse!).to eq(hashified_response)
+      end
+    end
+
+    context 'when the response has gracefully errored' do
+      let(:response) { hashified_response.to_json }
+      let(:hashified_response) do
+        {
+          'error' => {
+            'message' => 'Authorization error: please re-check your credentials'
+          }
+        }
+      end
+
+      context 'when throw_exceptions configuration is set to true' do
+        it 'raises an error' do
+          expect { handler.parse! }.to raise_error(
+            Onfido::RequestError,
+            'Authorization error: please re-check your credentials'
+          )
+        end
+      end
+
+      context 'when throw_exceptions configuration is set to false' do
+        let(:throws_exceptions) { false }
+
+
+        it 'parses the body and returns it' do
+          expect(handler.parse!).to eq(hashified_response)
+        end
+      end
+    end
+
+    context 'when the response is unparseable' do
+      let(:response) { 'something : wrong' }
+
+      context 'when throw_exceptions configuration is set to true' do
+        it 'raises an error' do
+          expect { handler.parse! }.to raise_error(
+            Onfido::RequestError,
+            'Unparseable response: something : wrong'
+          )
+        end
+      end
+
+      context 'when throw_exceptions configuration is set to false' do
+        let(:throws_exceptions) { false }
+
+
+        it 'parses the body and returns it' do
+          expect(handler.parse!).to eq(
+            {
+              'error' => {
+                'message' => 'Unparseable response: something : wrong'
+              }
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/spec/onfido_spec.rb

@@ -0,0 +1,55 @@
+describe Onfido do
+  subject(:onfido) { described_class }
+
+  context 'configuration' do
+    before do
+      onfido.reset
+    end
+
+    {api_key: nil, endpoint: 'https://api.onfido.com/v1/', throws_exceptions: true}.each do |config_key, value|
+      describe ".#{config_key}" do
+        it 'returns the default value' do
+          expect(onfido.public_send(config_key)).to eq(value)
+        end
+      end
+    end
+
+    {api_key: 'some_key', throws_exceptions: false}.each do |config_key, new_value|
+      describe ".#{config_key}=" do
+        it 'changes the configuration to the new value' do
+          onfido.public_send("#{config_key}=", new_value)
+          expect(onfido.public_send(config_key)).to eq(new_value)
+        end
+      end
+    end
+
+    describe '.logger' do
+      context 'when no option is passed' do
+        it 'returns the default value' do
+          expect(onfido.logger).to be_an_instance_of(Onfido::NullLogger)
+        end
+      end
+
+      context 'when an option is passed' do
+        context 'when the option passed behaves like a logger' do
+          let(:logger_like) { double('LoggerLike', :<< => nil) }
+
+          it 'returns the option' do
+            onfido.logger = logger_like
+            expect(onfido.logger).to eq(logger_like)
+          end
+        end
+
+        context 'when the option passed does not behave like a logger' do
+          let(:non_logger) { double('NotLogger') }
+
+          it 'raises an error' do
+            expect {
+              onfido.logger = non_logger
+            }.to raise_error("#{non_logger.class} doesn't seem to behave like a logger!")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+$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}
+
+require 'onfido'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = false
+  config.expose_dsl_globally = true
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # 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

@@ -0,0 +1,55 @@
+require 'sinatra/base'
+
+class FakeOnfidoAPI < Sinatra::Base
+  get '/v1/addresses/pick' do
+    json_response(200, 'addresses.json')
+  end
+
+  post '/v1/applicants' do
+    json_response(201, 'applicant.json')
+  end
+
+  get '/v1/applicants/:id' do
+    json_response(200, 'applicant.json')
+  end
+
+  get '/v1/applicants' do
+    json_response(200, 'applicants.json')
+  end
+
+  post '/v1/applicants/:id/documents' do
+    json_response(201, 'document.json')
+  end
+
+  post '/v1/applicants/:id/checks' do
+    json_response(201, 'check.json')
+  end
+
+  get '/v1/applicants/:id/checks/:id' do
+    json_response(200, 'check.json')
+  end
+
+  get '/v1/applicants/:id/checks' do
+    json_response(200, 'checks.json')
+  end
+
+  get '/v1/checks/:id/reports' do
+    json_response(200, 'reports.json')
+  end
+
+  get '/v1/checks/:id/reports/:id' do
+    json_response(200, 'report.json')
+  end
+
+  get '/v1/4xx_response' do
+    json_response(422, '4xx_response.json')
+  end
+
+  private
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+end

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

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

data/spec/support/fixtures/addresses.json

@@ -0,0 +1,24 @@
+{
+  "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

@@ -0,0 +1,44 @@
+{
+    "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",
+    "gender":"Male",
+    "dob":"1968-04-08",
+    "telephone":"555555555",
+    "mobile":"77777777",
+    "country":"gbr",
+    "href":"/v1/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
+    "id_numbers":[],
+    "addresses": [
+        {
+            "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",
+            "start_date":"",
+            "end_date":""
+        },
+        {
+            "flat_number":"1",
+            "building_number":"10",
+            "building_name":"Great Building",
+            "street":"Old Street",
+            "sub_street":"Sub Street",
+            "town":"London",
+            "state":"",
+            "postcode":"SW1 4NG",
+            "country":"GBR",
+            "start_date":"",
+            "end_date":""
+        }
+    ]
+}