onfido 0.0.1

data/lib/onfido/applicant.rb

@@ -0,0 +1,18 @@
+module Onfido
+  class Applicant < Resource
+    def create(payload)
+      post(
+        url: url_for('applicants'),
+        payload: payload
+      )
+    end
+
+    def find(applicant_id)
+      get(url: url_for("applicants/#{applicant_id}"), payload: {})
+    end
+
+    def all
+      get(url: url_for("applicants"), payload: {})
+    end
+  end
+end

data/lib/onfido/check.rb

@@ -0,0 +1,21 @@
+module Onfido
+  class Check < Resource
+    def create(applicant_id, payload)
+      post(
+         url: url_for("applicants/#{applicant_id}/checks"),
+         payload: payload
+      )
+    end
+
+    def find(applicant_id, check_id)
+      get(
+        url: url_for("applicants/#{applicant_id}/checks/#{check_id}"),
+        payload: {}
+      )
+    end
+
+    def all(applicant_id)
+      get(url: url_for("applicants/#{applicant_id}/checks"), payload: {})
+    end
+  end
+end

data/lib/onfido/configuration.rb

@@ -0,0 +1,35 @@
+module Onfido
+  module Configuration
+    attr_accessor :api_key, :throws_exceptions
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.api_key = nil
+      self.throws_exceptions = true
+      RestClient.log = nil
+    end
+
+    def logger=(log)
+      if log.respond_to?(:<<)
+        RestClient.log = log
+      else
+        raise "#{log.class} doesn't seem to behave like a logger!"
+      end
+    end
+
+    def logger
+      RestClient.log ||= NullLogger.new
+    end
+
+    def endpoint
+      'https://api.onfido.com/v1/'
+    end
+  end
+end

data/lib/onfido/document.rb

@@ -0,0 +1,13 @@
+module Onfido
+  class Document < Resource
+    # with open-uri the file can be a link or an actual file
+
+    def create(applicant_id, payload)
+      payload[:file] = open(payload.fetch(:file), 'r')
+      post(
+        url: url_for("applicants/#{applicant_id}/documents"),
+        payload: payload
+      )
+    end
+  end
+end

data/lib/onfido/null_logger.rb

@@ -0,0 +1,6 @@
+module Onfido
+  class NullLogger
+    def <<
+    end
+  end
+end

data/lib/onfido/report.rb

@@ -0,0 +1,11 @@
+module Onfido
+  class Report < Resource
+    def find(check_id, report_id)
+      get(url: url_for("checks/#{check_id}/reports/#{report_id}"), payload: {})
+    end
+
+    def all(check_id)
+      get(url: url_for("checks/#{check_id}/reports"), payload: {})
+    end
+  end
+end

data/lib/onfido/request_error.rb

@@ -0,0 +1,23 @@
+=begin
+The class will handle response failures coming from Onfido
+It's main purpose is to produce meaningful error messages to the user e.g.
+
+  RequestError: Authorization error: please re-check your credentials
+
+Users can also rescue the error and insect its type and affected fields as
+specified in the Onfido documentation e.g.
+
+  begin
+    # error being raised
+  rescue Onfido::RequestError => e
+    e.type
+    e.fields
+  end
+
+=end
+
+module Onfido
+  class RequestError < StandardError
+    attr_accessor :type, :fields, :response_code
+  end
+end

data/lib/onfido/requestable.rb

@@ -0,0 +1,12 @@
+module Onfido
+  module Requestable
+    def make_request(options)
+      url = options.fetch(:url)
+      payload = options.fetch(:payload)
+      method = options.fetch(:method)
+      RestClient::Request.execute(url: url, payload: payload, method: method, headers: headers) do |response, *|
+        ResponseHandler.new(response).parse!
+      end
+    end
+  end
+end

data/lib/onfido/resource.rb

@@ -0,0 +1,48 @@
+module Onfido
+  class Resource
+    VALID_HTTP_METHODS = %i(get post)
+
+    include Requestable
+
+    def url_for(path)
+      Onfido.endpoint + path
+    end
+
+    def method_missing(method, *args)
+      if VALID_HTTP_METHODS.include?(method.to_sym)
+        make_request(
+          url: args.first.fetch(:url),
+          payload: build_query(args.first.fetch(:payload)),
+          method: method.to_sym
+        )
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      VALID_HTTP_METHODS.include?(method.to_sym) || super
+    end
+
+    def headers
+      {
+        'Authorization' => "Token token=#{Onfido.api_key}",
+        'Accept' => "application/json"
+      }
+    end
+
+    private
+
+    # There seems to be a serialization issue with the HTTP client
+    # which does not serialize the payload properly.
+    # Have a look here https://gist.github.com/PericlesTheo/cb35139c57107ab3c84a
+
+    def build_query(payload)
+      if payload[:file]
+        payload
+      else
+        Rack::Utils.build_nested_query(payload)
+      end
+    end
+  end
+end

data/lib/onfido/response_handler.rb

@@ -0,0 +1,38 @@
+module Onfido
+  class ResponseHandler
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def parse!
+      if Onfido.throws_exceptions && parsed_response["error"]
+        raise request_error
+      else
+        parsed_response
+      end
+    end
+
+    private
+
+    def parsed_response
+      @parsed_response ||=
+        begin
+          JSON.parse(response)
+        rescue JSON::ParserError
+          {
+            'error' => {"message" => "Unparseable response: #{response}"}
+          }
+        end
+    end
+
+    def request_error
+      RequestError.new(parsed_response['error']['message']).tap do |error|
+        error.type = parsed_response['error']["type"]
+        error.fields = parsed_response['error']["fields"]
+        error.response_code = response.code if response.respond_to?(:code)
+      end
+    end
+  end
+end

data/lib/onfido/version.rb

@@ -0,0 +1,3 @@
+module Onfido
+  VERSION = '0.0.1'
+end

data/onfido.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onfido/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'onfido'
+  spec.version       = Onfido::VERSION
+  spec.authors       = ['Pericles Theodorou']
+  spec.email         = ['periclestheo@gmail.com']
+  spec.summary       = %q{A wrapper for Onfido API 1.0}
+  spec.description   = %q{A wrapper for Onfido API 1.0}
+  spec.homepage      = 'http://github.com/hvssle/onfido'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'rest-client', '~> 1.8.0'
+end

data/spec/integrations/4xx_response_spec.rb

@@ -0,0 +1,35 @@
+describe Onfido::Resource do
+  let(:resource) { described_class.new }
+  let(:url) { Onfido.endpoint + path }
+  let(:api_key) { 'some_key' }
+  let(:payload) { {postcode: 'SE1 4NG'} }
+
+
+  before do
+    allow(Onfido).to receive(:api_key).and_return(api_key)
+  end
+
+  context 'when a response is a 4xx' do
+    let(:path) { '4xx_response' }
+
+    context "when 'throws_exceptions' is true" do
+      it 'raises a custom error' do
+        expect {
+          resource.get({url: url, payload: payload})
+        }.to raise_error(
+        Onfido::RequestError, 'Something went wrong')
+      end
+    end
+
+    context "when 'throws_exceptions' is false" do
+      before do
+        allow(Onfido).to receive(:throws_exceptions).and_return(false)
+      end
+
+      it 'returns the body as a hash' do
+        response = resource.get({url: url, payload: payload})
+        expect(response['error']).not_to be_nil
+      end
+    end
+  end
+end

data/spec/integrations/address_spec.rb

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

data/spec/integrations/applicant_spec.rb

@@ -0,0 +1,73 @@
+describe Onfido::Applicant do
+  subject(:applicant) { described_class.new }
+  let(:params) do
+    {
+      'title' => 'Mr',
+      'first_name' => 'Chandler',
+      'last_name' => 'Bing',
+      'gender' => 'male',
+      'middle_name' => 'Muriel',
+      'dob' => '1968-04-08',
+      'telephone' => '555555555',
+      'mobile' => '77777777',
+      'email' => 'chandler_bing_6@friends.com',
+      'addresses' => [
+        {
+         'flat_number' => '4',
+         'building_number' => '100',
+         'building_name' => 'Awesome Building',
+         'street' => 'Main Street',
+         'sub_street' => 'A sub street',
+         'town' => 'London',
+         'postcode' => 'SW4 6EH',
+         'country' => 'GBR'
+        },
+        {
+         'flat_number' => '1',
+         'building_number' => '10',
+         'building_name' => 'Great Building',
+         'street' => 'Old Street',
+         'sub_street' => 'Sub Street',
+         'town' => 'London',
+         'postcode' => 'SW1 4NG',
+         'country' => 'GBR'
+        }
+      ]
+    }
+  end
+
+  describe '#create' do
+    # Need to find a better way of testing that the request is not malformed.
+    # Currently this runs for every feature spec. The fact that it's under here
+    # is only for semantic reasons
+
+    it 'serializes the payload correctly' do
+      WebMock.after_request do |request_signature, response|
+        if request_signature.uri.path == 'v1/applicants'
+          expect(Rack::Utils.parse_nested_query(request_signature.body)).to eq(params)
+        end
+      end
+    end
+
+    it 'creates an applicant' do
+      response = applicant.create(params)
+      expect(response['id']).not_to be_nil
+    end
+  end
+
+  describe '#find' do
+    let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
+
+    it 'returns the applicant' do
+      response = applicant.find(applicant_id)
+      expect(response['id']).to eq(applicant_id)
+    end
+  end
+
+  describe '#all' do
+    it 'returns all the applicants' do
+      response = applicant.all
+      expect(response['applicants'].size).to eq(2)
+    end
+  end
+end

data/spec/integrations/check_spec.rb

@@ -0,0 +1,36 @@
+describe Onfido::Check do
+  subject(:check) { described_class.new }
+  let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
+
+  describe '#create' do
+    let(:params) do
+      {
+        type: 'express',
+        reports: [{name: 'identity'}]
+      }
+    end
+
+    it 'creates a new check for an applicant' do
+      response = check.create(applicant_id, params)
+      expect(response['id']).not_to be_nil
+    end
+  end
+
+  describe '#find' do
+    let(:check_id) { '8546921-123123-123123' }
+
+    it 'returns an existing check for the applicant' do
+      response = check.find(applicant_id, check_id)
+      expect(response['id']).to eq(check_id)
+    end
+  end
+
+  describe '#all' do
+    let(:check_id) { '8546921-123123-123123' }
+
+    it 'returns all existing checks for the applicant' do
+      response = check.all(applicant_id)
+      expect(response['checks'].size).to eq(1)
+    end
+  end
+end

data/spec/integrations/document_spec.rb

@@ -0,0 +1,27 @@
+require 'tempfile'
+
+describe Onfido::Document do
+  subject(:document) { described_class.new }
+
+  describe '#create' do
+    after do
+      file.close
+      file.unlink
+    end
+
+    let(:file) { Tempfile.new(['passport', '.jpg']) }
+    let(:params) do
+      {
+        type: 'passport',
+        side: 'back',
+        file: file
+      }
+      let(:applicant_id) { '1030303-123123-123123' }
+
+      it 'creates a new document' do
+        response = document.create('foobar', params)
+        expect(response['id']).not_to be_nil
+      end
+    end
+  end
+end