onfido 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c63f7c25eb6a4d6a774be396edf561175a9ab3f1
-  data.tar.gz: b1dadefd0aaf4971077671d52b816b699e7217f1
+  metadata.gz: dc0898839314c34c40e417562dee6591d2972a96
+  data.tar.gz: 587d19739d05918ce9346af1a8adef01a8703207
 SHA512:
-  metadata.gz: 77a4f0fe6dbd99bb4c93c57cfb8bce13a2c4172fc767cdb446cb6694357fbef51b639cd1cfc7cd3120b2890634b701a249704dcfc93333e3c39fcf30724a1c32
-  data.tar.gz: ea7725d553e7ad385c24d8ba1e52ba3b5b08b9bc10c11ac871de5df87d3c8f066b976b7f82efbde071eb84d494a2dd3e79ae2f184730da8a7b1297c1963893e2
+  metadata.gz: 9c5e9a7b81593a84b9dc420aed0e07436d49950b3424dde6daa53875c9a41e2d55a3640ccaebf6904d2ca51d9d809d09e9fb20429e0613fd0bb5199863642ab1
+  data.tar.gz: e554fbca86a69f397d14fb6d82b7cefab9f524a96c27623823bae25d2e40bf9c1609b26a5739836d6b4a366ced3824660e31193b93afa035afa6665d67021326

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.7.0, 8 August 2016
+
+- Add support for dynamic API keys
+  (see https://github.com/hvssle/onfido#usage)
+- Fix `Onfido::Resource` so it raises `Onfido::ConnectionError` on
+  HTTP Error 408 Request Timeout
+
 ## v0.6.1, 15 July 2016
 
 - Fix `Onfido::API.live_photo` so it returns an `Onfido::LivePhoto` instance

data/README.md

@@ -37,6 +37,12 @@ You can make API calls by using an instance of the `API` class:
 api = Onfido::API.new
 ```
 
+Alternatively, you can set an API key here instead of in the initializer:
+
+```ruby
+api = Onfido::API.new(api_key: 'API_KEY')
+```
+
 ### Resources
 
 All resources share the same interface when making API calls. Use `.create` to create a resource, `.find` to find one, and `.all` to fetch all resources.

data/lib/onfido/api.rb

@@ -1,8 +1,12 @@
 module Onfido
   class API
+    def initialize(options = {})
+      @api_key = options[:api_key]
+    end
+
     def method_missing(method, *args)
       klass = method.to_s.split('_').collect(&:capitalize).join
-      Object.const_get("Onfido::#{klass}").new
+      Object.const_get("Onfido::#{klass}").new(@api_key)
     rescue NameError
       super
     end

data/lib/onfido/resource.rb

@@ -1,6 +1,11 @@
 module Onfido
   class Resource
     VALID_HTTP_METHODS = %i(get post).freeze
+    REQUEST_TIMEOUT_HTTP_CODE = 408
+
+    def initialize(api_key = nil)
+      @api_key = api_key || Onfido.api_key
+    end
 
     def url_for(path)
       Onfido.endpoint + path
@@ -36,7 +41,7 @@ module Onfido
 
       parse(response)
     rescue RestClient::ExceptionWithResponse => error
-      if error.response
+      if error.response && !timeout_response?(error.response)
         handle_api_error(error.response)
       else
         handle_restclient_error(error, url)
@@ -51,9 +56,13 @@ module Onfido
       general_api_error(response.code, response.body)
     end
 
+    def timeout_response?(response)
+      response.code.to_i == REQUEST_TIMEOUT_HTTP_CODE
+    end
+
     def headers
       {
-        'Authorization' => "Token token=#{Onfido.api_key}",
+        'Authorization' => "Token token=#{@api_key}",
         'Accept' => "application/json"
       }
     end

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/spec/onfido/api_spec.rb

@@ -12,4 +12,22 @@ describe Onfido::API do
   describe 'given an unknown resource' do
     specify { expect { api.blood_test }.to raise_error(NameError) }
   end
+
+  describe 'given no API key' do
+    it 'uses nil for the resource API key' do
+      expect(Onfido::Address).to receive(:new).with(nil)
+      api.address
+    end
+  end
+
+  describe 'given an API key' do
+    let(:api_key) { 'some_key' }
+
+    subject(:api) { described_class.new(api_key: api_key) }
+
+    it 'uses that key to create the resource' do
+      expect(Onfido::Address).to receive(:new).with(api_key)
+      api.address
+    end
+  end
 end

data/spec/onfido/resource_spec.rb

@@ -1,8 +1,26 @@
+require 'onfido/errors/connection_error'
+
 describe Onfido::Resource do
   subject(:resource) { described_class.new }
+
   let(:endpoint) { 'https://api.onfido.com/v2/' }
-  let(:path) { 'addresses/pick' }
-  let(:api_key) { 'some_key' }
+  let(:path)     { 'addresses/pick' }
+  let(:url)      { endpoint + path }
+  let(:payload)  { { postcode: 'SE1 4NG' } }
+  let(:api_key)  { 'some_key' }
+
+  let(:response) do
+    {
+      'addresses' => [
+        {
+          'street' => 'Main Street',
+          'town' => 'London',
+          'postcode' => 'SW4 6EH',
+          'country' => 'GBR'
+        }
+      ]
+    }
+  end
 
   before { allow(Onfido).to receive(:endpoint).and_return(endpoint) }
   before { allow(Onfido).to receive(:api_key).and_return(api_key) }
@@ -25,42 +43,88 @@ describe Onfido::Resource do
     end
   end
 
+  describe "API key" do
+    subject(:resource) { described_class.new(specific_api_key) }
+
+    before do
+      expect(RestClient::Request).to receive(:execute).
+        with(
+          url: url,
+          payload: Rack::Utils.build_query(payload),
+          method: :get,
+          headers: resource.send(:headers),
+          open_timeout: 30,
+          timeout: 80
+      ).and_call_original
+
+      WebMock.stub_request(:get, url).
+        to_return(body: response.to_json, status: 200)
+    end
+
+    context "when using a specific key" do
+      let(:specific_api_key) { "specific_key" }
+
+      it "uses that key when making the request" do
+        resource.get(url: url, payload: payload)
+
+        expect(WebMock).to have_requested(:get, url).with(headers: {
+          'Authorization' => "Token token=#{specific_api_key}",
+          'Accept' => "application/json"
+        })
+      end
+    end
+
+    context "when not using a specific key" do
+      let(:specific_api_key) { nil }
+
+      it "uses the general config key when making the request" do
+        resource.get(url: url, payload: payload)
+
+        expect(WebMock).to have_requested(:get, url).with(headers: {
+          'Authorization' => "Token token=#{api_key}",
+          'Accept' => "application/json"
+        })
+      end
+    end
+  end
+
   describe "valid http methods" do
     %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
+        context "with a success response" do
+          before do
+            expect(RestClient::Request).to receive(:execute).
+              with(
+                url: url,
+                payload: Rack::Utils.build_query(payload),
+                method: method,
+                headers: resource.send(:headers),
+                open_timeout: 30,
+                timeout: 80
+              ).and_call_original
 
-        before do
-          expect(RestClient::Request).to receive(:execute).
-            with(
-              url: url,
-              payload: Rack::Utils.build_query(payload),
-              method: method,
-              headers: resource.send(:headers),
-              open_timeout: 30,
-              timeout: 80
-            ).and_call_original
-
-          WebMock.stub_request(method, url).
-            to_return(body: response.to_json, status: 200)
+            WebMock.stub_request(method, url).
+              to_return(body: response.to_json, status: 200)
+          end
+
+          it 'makes a request to an endpoint' do
+            expect(resource.public_send(method, url: url, payload: payload)).
+              to eq(response)
+          end
         end
 
-        it 'makes a request to an endpoint' do
-          expect(resource.public_send(method, url: url, payload: payload)).
-            to eq(response)
+        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.public_send(method, url: url, payload: payload) }.
+              to raise_error(Onfido::ConnectionError)
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Pericles Theodorou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler