onfido 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f348aa18fa199997614263dda1be6a615a48191
-  data.tar.gz: 8e8d3b9cefb576187b9c49666492958f8793a533
+  metadata.gz: e3159a3e9bff94cd01155eabee9d77b7785c3eab
+  data.tar.gz: a67a5dd889545159c742a15fe12ac89630fb31a1
 SHA512:
-  metadata.gz: 69bda930664b166633e1454a7a48828d59a90c66ac9fc38b66bcbd0e4bfa52628660114e192cfa9b056986418fa05d191977617dc37718c7b3eb2adb8e0f84ec
-  data.tar.gz: 8623820a91b599ef02c7508e311275e8cd71163e2c72770811c77cb79e5aa1ae4a838cd3c900a9fcd31e6990bce58835f639d2b7a8e9f4d310b52a88d1d3d9cd
+  metadata.gz: 8577a2bc2a1f1b176f3a487f6ae16a8a9ea3dfeff4db962f63475e5c5a1942bb92c80f076d7e2a78f2551b36208a905e3e6406f094be7df8660f03f287f864fc
+  data.tar.gz: 6eccfff6eb4d0b663420680d60034afbf9346559c74eea5a7f0cd059c458f320e7bb639f45456103f666bf1fb64800a91b27891863168659667b6eb848f2c583

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## v0.1.0 11 November 2015
+## v0.2.0, 9 February 2015
+
+- BREAKING: adds `Onfido::ServerError`, which is raised whenever Onfido responds
+  with a 5xx code. Previously `Onfido::RequestError` would have been raised, but
+  this is now reserved for non-5xx responses.
+
+## 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`
@@ -6,6 +12,6 @@
 - Add base errors class (`Onfido::OnfidoError`)
 - Add rubocop, and fix style inconsistencies
 
-## v0.0.4 10 November 2015
+## v0.0.4, 10 November 2015
 
 - Split out connection errors so they can be automatically retried

data/README.md

@@ -144,7 +144,12 @@ api.check.all('applicant_id', page: 2, per_page: 10)
 
 ## Error Handling
 
-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.
+There are three classes of errors raised by the library, all of which subclass `Onfido::Error`.
+- `Onfido::ServerError` is raised whenever Onfido returns a `5xx` response
+- `Onfido::RequestError` is raised whenever Onfido returns any other kind of error
+- `Onfido::ConnectionError` is raised whenever a network error occurs (e.g., a timeout)
+
+All three error classes provide the `response_code`, `response_body`, `json_body`, `type` and `fields` of the error (although for `Onfido::ServerError` and `Onfido::ConnectionError` the last three are likely to be `nil`).
 
 ```ruby
   def create_applicant
@@ -156,8 +161,6 @@ If you rescue `Onfido::RequestError`, you are provided with the response code, r
   end
 ```
 
-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
 
 - Improve test coverage with more scenarios

data/lib/onfido.rb

@@ -7,6 +7,7 @@ require 'onfido/version'
 require 'onfido/configuration'
 require 'onfido/errors/onfido_error'
 require 'onfido/errors/request_error'
+require 'onfido/errors/server_error'
 require 'onfido/errors/connection_error'
 require 'onfido/null_logger'
 require 'onfido/resource'

data/lib/onfido/errors/server_error.rb

@@ -0,0 +1,4 @@
+module Onfido
+  class ServerError < OnfidoError
+  end
+end

data/lib/onfido/resource.rb

@@ -1,6 +1,6 @@
 module Onfido
   class Resource
-    VALID_HTTP_METHODS = %i(get post)
+    VALID_HTTP_METHODS = %i(get post).freeze
 
     def url_for(path)
       Onfido.endpoint + path
@@ -77,7 +77,9 @@ module Onfido
         general_api_error(response.code, response.body)
       end
 
-      raise RequestError.new(
+      error_class = response.code.to_i >= 500 ? ServerError : RequestError
+
+      raise error_class.new(
         parsed_response["error"]['message'],
         response_code: response.code,
         response_body: response.body
@@ -85,7 +87,9 @@ module Onfido
     end
 
     def general_api_error(response_code, response_body)
-      raise RequestError.new(
+      error_class = response_code.to_i >= 500 ? ServerError : RequestError
+
+      raise error_class.new(
         "Invalid response object from API: #{response_body} " \
         "(HTTP response code was #{response_code})",
         response_code: response_code,

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

data/onfido.gemspec

@@ -21,7 +21,7 @@ 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 'rubocop', '~> 0.37.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'sinatra', '~> 1.4'

data/spec/integrations/exceptions_spec.rb

@@ -24,12 +24,12 @@ describe Onfido::Resource do
     end
   end
 
-  context 'unparseable JSON' do
+  context 'unparseable JSON 5xx' do
     let(:path) { 'unparseable_response' }
 
-    it 'raises a custom error' do
+    it 'raises a server error' do
       expect { resource.get(url: url, payload: payload) }.
-        to raise_error(Onfido::RequestError, /response code was 504/)
+        to raise_error(Onfido::ServerError, /response code was 504/)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pericles Theodorou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.37.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,7 @@ files:
 - lib/onfido/errors/connection_error.rb
 - lib/onfido/errors/onfido_error.rb
 - lib/onfido/errors/request_error.rb
+- lib/onfido/errors/server_error.rb
 - lib/onfido/null_logger.rb
 - lib/onfido/report.rb
 - lib/onfido/resource.rb