onfido 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c107bba12384d55217719e5283953f0a0111f927
-  data.tar.gz: 4d77e8f946b6d035e3b126b4d9b01b3807a4c295
+  metadata.gz: 7f348aa18fa199997614263dda1be6a615a48191
+  data.tar.gz: 8e8d3b9cefb576187b9c49666492958f8793a533
 SHA512:
-  metadata.gz: cef79ba60503372169905e3abf66b2ac4d55b46141a9758abce82cf8a91ed72aa02e6635d7675d7a37280818605b5843f62d47d99a5c72164a850b15282c9559
-  data.tar.gz: adc95bedaa0ef4e1d75e3ee87a21a765383d9e39b4f19b0f7779741c1e65c7b514934d243c7644567933bc25139b61f5eee596a29456bf8d58fcd2fef732fec3
+  metadata.gz: 69bda930664b166633e1454a7a48828d59a90c66ac9fc38b66bcbd0e4bfa52628660114e192cfa9b056986418fa05d191977617dc37718c7b3eb2adb8e0f84ec
+  data.tar.gz: 8623820a91b599ef02c7508e311275e8cd71163e2c72770811c77cb79e5aa1ae4a838cd3c900a9fcd31e6990bce58835f639d2b7a8e9f4d310b52a88d1d3d9cd

data/.gitignore

@@ -1,161 +1,18 @@
-# Created by https://www.gitignore.io
-
-### Emacs ###
-# -*- mode: gitignore; -*-
-*~
-\#*\#
-/.emacs.desktop
-/.emacs.desktop.lock
-*.elc
-auto-save-list
-tramp
-.\#*
-
-# Org-mode
-.org-id-locations
-*_archive
-
-# flymake-mode
-*_flymake.*
-
-# eshell files
-/eshell/history
-/eshell/lastdir
-
-# elpa packages
-/elpa/
-
-# reftex files
-*.rel
-
-# AUCTeX auto folder
-/auto/
-
-# cask packages
-.cask/
-
-
-### OSX ###
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-
-### Linux ###
-*~
-
-# KDE directory preferences
-.directory
-
-# Linux trash folder which might appear on any partition or disk
-.Trash-*
-
-
-### RubyMine ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
-
-*.iml
-
-## Directory-based project format:
-.idea/
-# if you remove the above rule, at least ignore the following:
-
-# User-specific stuff:
-# .idea/workspace.xml
-# .idea/tasks.xml
-# .idea/dictionaries
-
-# Sensitive or high-churn files:
-# .idea/dataSources.ids
-# .idea/dataSources.xml
-# .idea/sqlDataSources.xml
-# .idea/dynamic.xml
-# .idea/uiDesigner.xml
-
-# Gradle:
-# .idea/gradle.xml
-# .idea/libraries
-
-# Mongo Explorer plugin:
-# .idea/mongoSettings.xml
-
-## File-based project format:
-*.ipr
-*.iws
-
-## Plugin-specific files:
-
-# IntelliJ
-/out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-
-
-### Ruby ###
 *.gem
 *.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
+.bundle
+.config
+.rspec
+.yardoc
 Gemfile.lock
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---format documentation

data/.rubocop.yml

@@ -0,0 +1,43 @@
+# For all options see https://github.com/bbatsov/rubocop/tree/master/config
+
+AllCops:
+  Include:
+    - Rakefile
+    - lib/tasks/*.rake
+  Exclude:
+    - vendor/**/*
+    - .*/**
+    - spec/fixtures/**/*
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 25
+
+# Don't require utf-8 encoding comment
+Style/Encoding:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 80
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Allow class and message or instance raises
+Style/RaiseArgs:
+  Enabled: false

data/.travis.yml

@@ -13,4 +13,5 @@ rvm:
   - rbx-2
 
 script:
+  - bundle exec rubocop
   - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.1.0 11 November 2015
+
+- BREAKING: remove `throws_exceptions` option. We now always throw exceptions
+  for errors. This option had become confusing since `Onfido::ConnectionError`
+  was added in v0.0.4, since timeout errors were raised regardless of its value.
+- Add base errors class (`Onfido::OnfidoError`)
+- Add rubocop, and fix style inconsistencies
+
 ## v0.0.4 10 November 2015
 
 - Split out connection errors so they can be automatically retried

data/Gemfile

@@ -6,9 +6,3 @@ group :development, :test do
   gem 'pry-byebug'
   gem 'pry-stack_explorer'
 end
-
-group :test do
-  gem 'rspec', '~> 3.1.0'
-  gem 'webmock', '~> 1.20.4'
-  gem 'sinatra', '~> 1.4.6'
-end

data/README.md

@@ -2,10 +2,8 @@
 
 A wrapper for Onfido's [API](https://onfido.com/documentation#introduction). You should always refer to the documentation for valid API calls.
 
-[![Build Status](https://snap-ci.com/hvssle/onfido/branch/master/build_image)](https://snap-ci.com/hvssle/onfido/branch/master)
 [![Gem Version](https://badge.fury.io/rb/onfido.svg)](http://badge.fury.io/rb/onfido)
 [![Build Status](https://travis-ci.org/hvssle/onfido.svg?branch=master)](https://travis-ci.org/hvssle/onfido)
-[!['gitter room'][2]][1]
 
 
   [1]: https://gitter.im/hvssle/onfido
@@ -30,13 +28,12 @@ Or install it yourself as:
 
 ## Usage
 
-There are 5 configuration options for Onfido, including your `api_key`, throwing exceptions for failed responses and logging the requests. By default, `throws_exceptions` is set to `true`. If set to `false` and Onfido responds with a valid JSON body the response body will be returned instead.
+There are 4 configuration options for Onfido, including your `api_key`, timeout details and logging.
 
 ```ruby
   Onfido.configure do |config|
     config.api_key = 'MY_API_KEY'
     config.logger = Logger.new(STDOUT)
-    config.throws_exceptions = false
     config.open_timeout = 30
     config.read_timeout = 80
   end
@@ -52,7 +49,7 @@ Assuming you have a valid key, you can conveniently make API calls by using an i
 
 All resources share the same interface when making API calls. For creating a resource you can use `.create`, for finding one `.find` and for fetching all records for a resource `.all`.
 
-**Note:** *All param keys should be a symbol e.g. `{type: 'express', reports: [{name: 'identity'}]}`*
+**Note:** *All param keys should be a symbol e.g. `{ type: 'express', reports: [{ name: 'identity' }] }`*
 
 
 ### Applicant
@@ -80,7 +77,7 @@ To get all applicants
 To upload a document for an applicant, you can simply use
 
 ```ruby
-  api.document.create('applicant_id', {file: 'http://example.com', type: 'passport')
+  api.document.create('applicant_id', file: 'http://example.com', type: 'passport')
 ```
 
 The file can both be a `File` object or a link to an image.
@@ -90,7 +87,7 @@ The file can both be a `File` object or a link to an image.
 To create a check for an applicant, you can simply use
 
 ```ruby
-  api.check.create('applicant_id', {type: 'express', reports: [{name: 'identity'}]})
+  api.check.create('applicant_id', type: 'express', reports: [{ name: 'identity' }])
 ```
 
 To find an existing check for an applicant
@@ -147,23 +144,19 @@ api.check.all('applicant_id', page: 2, per_page: 10)
 
 ## Error Handling
 
-By default, Onfido will attempt to raise errors returned by the API automatically.
-
-If you set the `throws_exceptions` to false, it will simply return the response body. This allows you to handle errors manually.
-
-If you rescue `Onfido::RequestError`, you are provided with the error message itself as well as the type of error, response code and fields that have errored. Here's how you might do that:
+If you rescue `Onfido::RequestError`, you are provided with the response code, response body and parsed JSON body, the type of error the the fields that have errored.
 
 ```ruby
   def create_applicant
     api.applicant.create(params)
   rescue Onfido::RequestError => e
-    e.type # returns 'validation_error'
-    e.fields # returns {"email": {"messages": ["invalid format"]}
-    e.response_code # returns '401'
+    e.type          # => 'validation_error'
+    e.fields        # => { "email": { "messages": ["invalid format"] } }
+    e.response_code # => '422'
   end
 ```
 
-You can also rescue `Onfido::ConnectionError`, which is raised whenever something goes wrong with the connection to Onfido - you may wish to automatically retry these requests.
+You can also rescue `Onfido::ConnectionError`, which is raised when something goes wrong with the connection to Onfido. This is useful for adding automatic retries to your background jobs.
 
 ### Roadmap
 

data/Rakefile

@@ -1,2 +1 @@
 require 'bundler/gem_tasks'
-

data/lib/onfido.rb

@@ -5,6 +5,7 @@ require 'open-uri'
 
 require 'onfido/version'
 require 'onfido/configuration'
+require 'onfido/errors/onfido_error'
 require 'onfido/errors/request_error'
 require 'onfido/errors/connection_error'
 require 'onfido/null_logger'
@@ -16,7 +17,6 @@ require 'onfido/check'
 require 'onfido/report'
 require 'onfido/api'
 
-
 module Onfido
   extend Configuration
 end

data/lib/onfido/address.rb

@@ -3,7 +3,7 @@ module Onfido
     def all(postcode)
       get(
         url: url_for('addresses/pick'),
-        payload: {postcode: postcode.delete(' ')}
+        payload: { postcode: postcode.delete(' ') }
       )
     end
   end

data/lib/onfido/applicant.rb

@@ -12,7 +12,10 @@ module Onfido
     end
 
     def all(page: 1, per_page: 20)
-      get(url: url_for("applicants?page=#{page}&per_page=#{per_page}"), payload: {})
+      get(
+        url: url_for("applicants?page=#{page}&per_page=#{per_page}"),
+        payload: {}
+      )
     end
   end
 end

data/lib/onfido/check.rb

@@ -2,8 +2,8 @@ module Onfido
   class Check < Resource
     def create(applicant_id, payload)
       post(
-         url: url_for("applicants/#{applicant_id}/checks"),
-         payload: payload
+        url: url_for("applicants/#{applicant_id}/checks"),
+        payload: payload
       )
     end
 
@@ -15,8 +15,9 @@ module Onfido
     end
 
     def all(applicant_id, page: 1, per_page: 20)
+      querystring = "page=#{page}&per_page=#{per_page}"
       get(
-        url: url_for("applicants/#{applicant_id}/checks?page=#{page}&per_page=#{per_page}"),
+        url: url_for("applicants/#{applicant_id}/checks?#{querystring}"),
         payload: {}
       )
     end

data/lib/onfido/configuration.rb

@@ -1,6 +1,6 @@
 module Onfido
   module Configuration
-    attr_accessor :api_key, :throws_exceptions, :open_timeout, :read_timeout
+    attr_accessor :api_key, :open_timeout, :read_timeout
 
     def self.extended(base)
       base.reset
@@ -12,7 +12,6 @@ module Onfido
 
     def reset
       self.api_key = nil
-      self.throws_exceptions = true
       self.open_timeout = 30
       self.read_timeout = 80
       RestClient.log = nil

data/lib/onfido/errors/connection_error.rb

@@ -1,4 +1,4 @@
 module Onfido
-  class ConnectionError < StandardError
+  class ConnectionError < OnfidoError
   end
 end

data/lib/onfido/errors/onfido_error.rb

@@ -0,0 +1,28 @@
+module Onfido
+  class OnfidoError < StandardError
+    attr_accessor :response_code, :response_body
+
+    def initialize(message = nil,
+                   response_code: nil,
+                   response_body: nil)
+      @response_code = response_code
+      @response_body = response_body
+
+      super(message)
+    end
+
+    def json_body
+      JSON.parse(response_body.to_s)
+    rescue JSON::ParserError
+      nil
+    end
+
+    def type
+      json_body && json_body['error'] && json_body['error']['type']
+    end
+
+    def fields
+      json_body && json_body['error'] && json_body['error']['fields']
+    end
+  end
+end

data/lib/onfido/errors/request_error.rb

@@ -1,31 +1,4 @@
-=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
-
-    def initialize(message=nil, type: nil, fields: nil, response_code: nil)
-      @type = type
-      @fields = fields
-      @response_code = response_code
-
-      super(message)
-    end
+  class RequestError < OnfidoError
   end
 end

data/lib/onfido/resource.rb

@@ -46,7 +46,7 @@ module Onfido
     end
 
     def parse(response)
-      JSON.parse(response.body)
+      JSON.parse(response.body.to_s)
     rescue JSON::ParserError
       general_api_error(response.code, response.body)
     end
@@ -77,22 +77,19 @@ module Onfido
         general_api_error(response.code, response.body)
       end
 
-      if Onfido.throws_exceptions
-        raise RequestError.new(
-          parsed_response["error"]['message'],
-          type: parsed_response["error"]["type"],
-          fields: parsed_response["error"]["fields"],
-          response_code: response.code)
-      else
-        parsed_response
-      end
+      raise RequestError.new(
+        parsed_response["error"]['message'],
+        response_code: response.code,
+        response_body: response.body
+      )
     end
 
     def general_api_error(response_code, response_body)
       raise RequestError.new(
         "Invalid response object from API: #{response_body} " \
         "(HTTP response code was #{response_code})",
-        response_code: response_code
+        response_code: response_code,
+        response_body: response_body
       )
     end
 
@@ -111,15 +108,15 @@ module Onfido
           "request completed. #{connection_message}"
 
         when RestClient::SSLCertificateNotVerified
-            "Could not verify Onfido's SSL certificate. Please make sure " \
-            "that your network is not intercepting certificates. " \
-            "(Try going to #{Onfido.endpoint} in your browser.) " \
-            "If this problem persists, let us know at info@onfido.com."
+          "Could not verify Onfido's SSL certificate. Please make sure " \
+          "that your network is not intercepting certificates. " \
+          "(Try going to #{Onfido.endpoint} in your browser.) " \
+          "If this problem persists, let us know at info@onfido.com."
 
         when SocketError
-            "Unexpected error when trying to connect to Onfido. " \
-            "You may be seeing this message because your DNS is not working. " \
-            "To check, try running 'host onfido.com' from the command line."
+          "Unexpected error when trying to connect to Onfido. " \
+          "You may be seeing this message because your DNS is not working. " \
+          "To check, try running 'host onfido.com' from the command line."
 
         else
           "Unexpected error communicating with Onfido. " \

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/onfido.gemspec

@@ -6,10 +6,10 @@ 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.authors       = ['Pericles Theodorou', 'Grey Baker']
+  spec.email         = ['periclestheo@gmail.com', 'grey@gocardless.com']
+  spec.summary       = %q{A wrapper for Onfido API}
+  spec.description   = %q{A wrapper for Onfido API}
   spec.homepage      = 'http://github.com/hvssle/onfido'
   spec.license       = 'MIT'
 
@@ -21,6 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'rubocop', '~> 0.35.1'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
 
   spec.add_dependency 'rest-client', '~> 1.8.0'
 end

data/spec/integrations/applicant_spec.rb

@@ -13,24 +13,24 @@ describe Onfido::Applicant do
       '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' => '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'
+          'flat_number' => '1',
+          'building_number' => '10',
+          'building_name' => 'Great Building',
+          'street' => 'Old Street',
+          'sub_street' => 'Sub Street',
+          'town' => 'London',
+          'postcode' => 'SW1 4NG',
+          'country' => 'GBR'
         }
       ]
     }
@@ -42,9 +42,10 @@ describe Onfido::Applicant do
     # is only for semantic reasons
 
     it 'serializes the payload correctly' do
-      WebMock.after_request do |request_signature, response|
+      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)
+          expect(Rack::Utils.parse_nested_query(request_signature.body)).
+            to eq(params)
         end
       end
     end

data/spec/integrations/check_spec.rb

@@ -3,12 +3,7 @@ describe Onfido::Check do
   let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
 
   describe '#create' do
-    let(:params) do
-      {
-        type: 'express',
-        reports: [{name: 'identity'}]
-      }
-    end
+    let(:params) { { type: 'express', reports: [{ name: 'identity' }] } }
 
     it 'creates a new check for an applicant' do
       response = check.create(applicant_id, params)

data/spec/integrations/document_spec.rb

@@ -10,18 +10,19 @@ describe Onfido::Document do
     end
 
     let(:file) { Tempfile.new(['passport', '.jpg']) }
+    before { allow(document).to receive(:open).and_return(:file) }
     let(:params) do
       {
         type: 'passport',
         side: 'back',
         file: file
       }
-      let(:applicant_id) { '1030303-123123-123123' }
+    end
+    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
+    it 'creates a new document' do
+      response = document.create('foobar', params)
+      expect(response['id']).not_to be_nil
     end
   end
 end

data/spec/integrations/exceptions_spec.rb

@@ -4,74 +4,32 @@ describe Onfido::Resource do
   let(:api_key) { 'some_key' }
   let(:payload) { { postcode: 'SE1 4NG' } }
 
-
-  before do
-    allow(Onfido).to receive(:api_key).and_return(api_key)
-  end
+  before { allow(Onfido).to receive(:api_key).and_return(api_key) }
 
   context '4xx response' do
     let(:path) { '4xx_response' }
 
-    context "when 'throws_exceptions' is true" do
-      before { allow(Onfido).to receive(:throws_exceptions).and_return(true) }
-
-      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 { allow(Onfido).to receive(:throws_exceptions).and_return(false) }
-
-      it 'returns the body as a hash' do
-        response = resource.get({ url: url, payload: payload })
-        expect(response['error']).not_to be_nil
-      end
+    it 'raises a custom error' do
+      expect { resource.get(url: url, payload: payload) }.
+        to raise_error(Onfido::RequestError, 'Something went wrong')
     end
   end
 
   context 'unexpected error format' do
     let(:path) { 'unexpected_error_format' }
 
-    context "when 'throws_exceptions' is true" do
-      before { allow(Onfido).to receive(:throws_exceptions).and_return(true) }
-
-      it 'raises a custom error' do
-        expect { resource.get({ url: url, payload: payload }) }.
-          to raise_error(Onfido::RequestError, /response code was 400/)
-      end
-    end
-
-    context "when 'throws_exceptions' is false" do
-      before { allow(Onfido).to receive(:throws_exceptions).and_return(false) }
-
-      it 'still raises a custom error' do
-        expect { resource.get({ url: url, payload: payload }) }.
-          to raise_error(Onfido::RequestError, /response code was 400/)
-      end
+    it 'raises a custom error' do
+      expect { resource.get(url: url, payload: payload) }.
+        to raise_error(Onfido::RequestError, /response code was 400/)
     end
   end
 
   context 'unparseable JSON' do
     let(:path) { 'unparseable_response' }
 
-    context "when 'throws_exceptions' is true" do
-      before { allow(Onfido).to receive(:throws_exceptions).and_return(true) }
-
-      it 'raises a custom error' do
-        expect { resource.get({ url: url, payload: payload }) }.
-          to raise_error(Onfido::RequestError, /response code was 504/)
-      end
-    end
-
-    context "when 'throws_exceptions' is false" do
-      before { allow(Onfido).to receive(:throws_exceptions).and_return(false) }
-
-      it 'still raises a custom error' do
-        expect { resource.get({ url: url, payload: payload }) }.
-          to raise_error(Onfido::RequestError, /response code was 504/)
-      end
+    it 'raises a custom error' do
+      expect { resource.get(url: url, payload: payload) }.
+        to raise_error(Onfido::RequestError, /response code was 504/)
     end
   end
 
@@ -83,7 +41,7 @@ describe Onfido::Resource do
     end
 
     it 'raises a ConnectionError' do
-      expect { resource.get({ url: Onfido.endpoint, payload: payload }) }.
+      expect { resource.get(url: Onfido.endpoint, payload: payload) }.
         to raise_error(Onfido::ConnectionError, /Could not connect/)
     end
   end
@@ -96,7 +54,7 @@ describe Onfido::Resource do
     end
 
     it 'raises a ConnectionError' do
-      expect { resource.get({ url: Onfido.endpoint, payload: payload }) }.
+      expect { resource.get(url: Onfido.endpoint, payload: payload) }.
         to raise_error(Onfido::ConnectionError, /connection to the server/)
     end
   end
@@ -109,7 +67,7 @@ describe Onfido::Resource do
     end
 
     it 'raises a ConnectionError' do
-      expect { resource.get({ url: Onfido.endpoint, payload: payload }) }.
+      expect { resource.get(url: Onfido.endpoint, payload: payload) }.
         to raise_error(Onfido::ConnectionError, /SSL certificate/)
     end
   end

data/spec/integrations/report_spec.rb

@@ -3,7 +3,7 @@ describe Onfido::Report do
   let(:check_id) { '8546921-123123-123123' }
 
   describe '#find' do
-    let(:report_id) {'6951786-123123-422221' }
+    let(:report_id) { '6951786-123123-422221' }
 
     it 'returns a report for an existing check' do
       response = report.find(check_id, report_id)

data/spec/onfido/connection_error_spec.rb

@@ -0,0 +1,18 @@
+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/request_error_spec.rb

@@ -1,10 +1,10 @@
 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
+    described_class.new(
+      failed_response['error']['message'],
+      response_code: 401,
+      response_body: failed_response.to_json
+    )
   end
 
   let(:failed_response) do
@@ -14,26 +14,21 @@ describe Onfido::RequestError do
         'id' => '551722cc964860653c00c202',
         'type' => 'authorization_error',
         'message' => 'Authorization error: please re-check your credentials',
-        'fields' => {'name' => {'messages' => ['cannot be blank']} }
+        '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 'returns the right message' do
+    expect { raise error }.
+      to raise_error('Authorization error: please re-check your credentials')
+  end
 
-    it 'has the right response code' do
-      expect(error.response_code).to eq(401)
-    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/onfido/resource_spec.rb

@@ -4,10 +4,8 @@ describe Onfido::Resource do
   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
+  before { allow(Onfido).to receive(:endpoint).and_return(endpoint) }
+  before { allow(Onfido).to receive(:api_key).and_return(api_key) }
 
   describe '#url_for' do
     it 'composes the full api url' do
@@ -19,9 +17,9 @@ describe Onfido::Resource do
     %i(put delete patch).each do |method|
       context "for unsupported HTTP method: #{method}" do
         it 'raises an error' do
-          expect {
+          expect do
             resource.public_send(method)
-          }.to raise_error(NoMethodError)
+          end.to raise_error(NoMethodError)
         end
       end
     end
@@ -31,7 +29,7 @@ describe Onfido::Resource do
     %i(get post).each do |method|
       context "for supported HTTP method: #{method}" do
         let(:url) { endpoint + path }
-        let(:payload) { {postcode: 'SE1 4NG'} }
+        let(:payload) { { postcode: 'SE1 4NG' } }
         let(:response) do
           {
             'addresses' => [
@@ -46,8 +44,8 @@ describe Onfido::Resource do
         end
 
         before do
-          expect(RestClient::Request).to receive(:execute)
-            .with(
+          expect(RestClient::Request).to receive(:execute).
+            with(
               url: url,
               payload: Rack::Utils.build_query(payload),
               method: method,
@@ -61,7 +59,7 @@ describe Onfido::Resource do
         end
 
         it 'makes a request to an endpoint' do
-          expect(resource.public_send(method, {url: url, payload: payload})).
+          expect(resource.public_send(method, url: url, payload: payload)).
             to eq(response)
         end
       end

data/spec/onfido_spec.rb

@@ -2,34 +2,33 @@ describe Onfido do
   subject(:onfido) { described_class }
 
   context 'configuration' do
-    before do
-      onfido.reset
-    end
+    before { onfido.reset }
 
-    {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
+    describe "default values" do
+      describe ".api_key" do
+        subject { onfido.api_key }
+        it { is_expected.to be_nil }
       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
+      describe ".endpoint" do
+        subject { onfido.endpoint }
+        it { is_expected.to eq('https://api.onfido.com/v1/') }
+      end
+
+      describe ".logger" do
+        subject { onfido.logger }
+        it { is_expected.to be_an_instance_of(Onfido::NullLogger) }
       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
+    describe "setting an API key" do
+      it 'changes the configuration to the new value' do
+        onfido.api_key = 'some_key'
+        expect(onfido.api_key).to eq('some_key')
       end
+    end
 
+    describe '.logger' do
       context 'when an option is passed' do
         context 'when the option passed behaves like a logger' do
           let(:logger_like) { double('LoggerLike', :<< => nil) }
@@ -44,9 +43,10 @@ describe Onfido 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!")
+            expect { onfido.logger = non_logger }.
+              to raise_error(
+                "#{non_logger.class} doesn't seem to behave like a logger!"
+              )
           end
         end
       end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 $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")].each { |f| require f }
 
 require 'onfido'
 require 'webmock/rspec'
+require 'rspec/its'
 
 WebMock.disable_net_connect!(allow_localhost: true)
 
@@ -30,6 +31,7 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
   config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
   config.warnings = false
   config.expose_dsl_globally = true
 

data/spec/support/fake_onfido_api.rb

@@ -15,7 +15,7 @@ class FakeOnfidoAPI < Sinatra::Base
 
   get '/v1/applicants' do
     response = json_response(200, 'applicants.json')
-    {applicants: JSON.parse(response)['applicants'][pagination_range]}.to_json
+    { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
   end
 
   post '/v1/applicants/:id/documents' do
@@ -32,7 +32,7 @@ class FakeOnfidoAPI < Sinatra::Base
 
   get '/v1/applicants/:id/checks' do
     response = json_response(200, 'checks.json')
-    {checks: JSON.parse(response)['checks'][pagination_range]}.to_json
+    { checks: JSON.parse(response)['checks'][pagination_range] }.to_json
   end
 
   get '/v1/checks/:id/reports' do

data/spec/support/fixtures/document.json

@@ -6,5 +6,5 @@
   "file_type": "png",
   "file_size": 282870,
   "type": "passport",
-  "side": 'back'
+  "side": "back"
 }

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Pericles Theodorou
+- Grey Baker
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -52,6 +53,62 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +123,21 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-description: A wrapper for Onfido API 1.0
+description: A wrapper for Onfido API
 email:
 - periclestheo@gmail.com
+- grey@gocardless.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/onfido.rb
@@ -90,6 +148,7 @@ files:
 - lib/onfido/configuration.rb
 - lib/onfido/document.rb
 - lib/onfido/errors/connection_error.rb
+- lib/onfido/errors/onfido_error.rb
 - lib/onfido/errors/request_error.rb
 - lib/onfido/null_logger.rb
 - lib/onfido/report.rb
@@ -102,6 +161,7 @@ files:
 - spec/integrations/document_spec.rb
 - spec/integrations/exceptions_spec.rb
 - spec/integrations/report_spec.rb
+- spec/onfido/connection_error_spec.rb
 - spec/onfido/request_error_spec.rb
 - spec/onfido/resource_spec.rb
 - spec/onfido_spec.rb
@@ -140,7 +200,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A wrapper for Onfido API 1.0
+summary: A wrapper for Onfido API
 test_files:
 - spec/integrations/address_spec.rb
 - spec/integrations/applicant_spec.rb
@@ -148,6 +208,7 @@ test_files:
 - spec/integrations/document_spec.rb
 - spec/integrations/exceptions_spec.rb
 - spec/integrations/report_spec.rb
+- spec/onfido/connection_error_spec.rb
 - spec/onfido/request_error_spec.rb
 - spec/onfido/resource_spec.rb
 - spec/onfido_spec.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 Pericles Theodorou
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.