onfido 1.0.0 → 2.0.2

data/spec/support/fixtures/live_photo.json

@@ -4,6 +4,6 @@
   "file_name": "onfido_captured_image.jpg",
   "file_type": "image/jpeg",
   "file_size": 47544,
-  "href": "/v3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
-  "download_href": "/v3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+  "href": "/v3.1/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+  "download_href": "/v3.1/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
 }

data/spec/support/fixtures/live_photos.json

@@ -6,8 +6,8 @@
       "file_name": "onfido_captured_image.jpg",
       "file_type": "image/jpeg",
       "file_size": 47544,
-      "href": "/v3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
-      "download_href": "/v3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+      "href": "/v3.1/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+      "download_href": "/v3.1/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
     },
     {
         "id": "5134c12a-555a-1234-5e12-9d34fcbc11ba",
@@ -15,8 +15,8 @@
         "file_name": "onfido_captured_image.jpg",
         "file_type": "image/jpeg",
         "file_size": 47544,
-        "href": "/v3/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
-        "download_href": "/v3/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
+        "href": "/v3.1/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
+        "download_href": "/v3.1/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
       }
   ]
 }

data/spec/support/fixtures/live_video.json

@@ -18,6 +18,6 @@
   "file_name" : "output-29-05-2018_11_00_24.mov",
   "file_type" : "video/quicktime",
   "file_size" : 3348421,
-  "href" : "/v3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
-  "download_href" : "/v3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
+  "href" : "/v3.1/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+  "download_href" : "/v3.1/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
 }

data/spec/support/fixtures/live_videos.json

@@ -16,11 +16,11 @@
         }
       ],
       "created_at": "2019-11-29T09:00:39Z",
-      "download_href": "/v3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
+      "download_href": "/v3.1/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
       "file_name": "output-29-11-2019_11_00_24.mov",
       "file_size": 3348421,
       "file_type": "video/quicktime",
-      "href": "/v3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+      "href": "/v3.1/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
       "id": "c9701e9b-83aa-442f-995b-20320ee8fb01"
     }
   ]

data/spec/support/fixtures/report.json

@@ -4,7 +4,7 @@
   "created_at": "2019-11-23T13:50:45Z",
   "status": "in_progress",
   "result": "pending",
-  "href": "/v3/reports/6951786-123123-422221",
+  "href": "/v3.1/reports/6951786-123123-422221",
   "breakdown": {},
   "properties": {}
 }

data/spec/support/fixtures/reports.json

@@ -6,7 +6,7 @@
       "created_at": "2019-11-23T13:50:45Z",
       "status": "in_progress",
       "result": "pending",
-      "href": "/v3/reports/6951786-123123-422221",
+      "href": "/v3.1/reports/6951786-123123-422221",
       "breakdown": {},
       "properties": {}
     },
@@ -16,7 +16,7 @@
       "created_at": "2019-11-23T13:50:45Z",
       "status": "in_progress",
       "result": "pending",
-      "href": "/v3/reports/6951786-123123-316712",
+      "href": "/v3.1/reports/6951786-123123-316712",
       "breakdown": {},
       "properties": {}
     }

data/spec/support/fixtures/webhook.json

@@ -3,7 +3,7 @@
   "url": "https://webhookendpoint.url",
   "token": "yV85IsmuYwmjQGlZ",
   "enabled": true,
-  "href": "/v3/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "href": "/v3.1/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
   "environments": [
     "live"
   ],

data/spec/support/fixtures/webhooks.json

@@ -4,7 +4,7 @@
       "id": "dd0a89e4-d44e-417a-aec4-01137d01ae59",
       "url": "https://demo.com",
       "enabled":false,
-      "href": "/v3/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
+      "href": "/v3.1/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
       "environments": [
         "live"
       ],
@@ -18,7 +18,7 @@
       "id": "bfc727a8-f7bf-4073-b123-ed70a70f58e5",
       "url": "https://demo2.com",
       "enabled": true,
-      "href": "/v3/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
+      "href": "/v3.1/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
       "environments": [
         "live"
       ],

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Onfido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +117,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -153,20 +127,19 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/onfido.rb
 - lib/onfido/api.rb
-- lib/onfido/configuration.rb
 - 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/options.rb
 - lib/onfido/resource.rb
 - lib/onfido/resources/address.rb
 - lib/onfido/resources/applicant.rb
 - lib/onfido/resources/check.rb
 - lib/onfido/resources/document.rb
+- lib/onfido/resources/extraction.rb
 - lib/onfido/resources/live_photo.rb
 - lib/onfido/resources/live_video.rb
 - lib/onfido/resources/report.rb
@@ -178,17 +151,17 @@ files:
 - spec/integrations/applicant_spec.rb
 - spec/integrations/check_spec.rb
 - spec/integrations/document_spec.rb
-- spec/integrations/exceptions_spec.rb
+- spec/integrations/extraction_spec.rb
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/live_video_spec.rb
 - spec/integrations/report_spec.rb
+- spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
+- spec/onfido/options_spec.rb
 - spec/onfido/request_error_spec.rb
-- spec/onfido/resource_spec.rb
-- spec/onfido_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_onfido_api.rb
 - spec/support/fixtures/4xx_response.json
@@ -199,6 +172,7 @@ files:
 - spec/support/fixtures/checks.json
 - spec/support/fixtures/document.json
 - spec/support/fixtures/documents.json
+- spec/support/fixtures/extraction.json
 - spec/support/fixtures/live_photo.json
 - spec/support/fixtures/live_photos.json
 - spec/support/fixtures/live_video.json
@@ -222,14 +196,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A wrapper for Onfido API
@@ -238,17 +212,17 @@ test_files:
 - spec/integrations/applicant_spec.rb
 - spec/integrations/check_spec.rb
 - spec/integrations/document_spec.rb
-- spec/integrations/exceptions_spec.rb
+- spec/integrations/extraction_spec.rb
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/live_video_spec.rb
 - spec/integrations/report_spec.rb
+- spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
+- spec/onfido/options_spec.rb
 - spec/onfido/request_error_spec.rb
-- spec/onfido/resource_spec.rb
-- spec/onfido_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_onfido_api.rb
 - spec/support/fixtures/4xx_response.json
@@ -259,6 +233,7 @@ test_files:
 - spec/support/fixtures/checks.json
 - spec/support/fixtures/document.json
 - spec/support/fixtures/documents.json
+- spec/support/fixtures/extraction.json
 - spec/support/fixtures/live_photo.json
 - spec/support/fixtures/live_photos.json
 - spec/support/fixtures/live_video.json

data/Rakefile

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

data/lib/onfido/configuration.rb

@@ -1,46 +0,0 @@
-module Onfido
-  module Configuration
-    REGION_HOSTS = {
-      us: "api.us.onfido.com"
-    }.freeze
-
-    attr_accessor :api_key, :region, :open_timeout, :read_timeout
-
-    def self.extended(base)
-      base.reset
-    end
-
-    def configure
-      yield self
-    end
-
-    def reset
-      self.api_key = nil
-      self.region = nil
-      self.open_timeout = 30
-      self.read_timeout = 80
-      RestClient.log = nil
-    end
-
-    def logger=(log)
-      unless log.respond_to?(:<<)
-        raise "#{log.class} doesn't seem to behave like a logger!"
-      end
-
-      RestClient.log = log
-    end
-
-    def logger
-      RestClient.log ||= NullLogger.new
-    end
-
-    def endpoint
-      region_host = region ? REGION_HOSTS[region.downcase.to_sym] : "api.onfido.com"
-      unless region_host
-        raise "The region \"#{region.downcase}\" is not currently supported"
-      end
-
-      "https://#{region_host}/v3/"
-    end
-  end
-end

data/lib/onfido/null_logger.rb

@@ -1,5 +0,0 @@
-module Onfido
-  class NullLogger
-    def <<(*args); end
-  end
-end

data/spec/integrations/exceptions_spec.rb

@@ -1,73 +0,0 @@
-describe Onfido::Resource do
-  let(:resource) { described_class.new }
-  let(:api_key) { 'some_key' }
-  let(:payload) { { postcode: 'SE1 4NG' } }
-
-  before { allow(Onfido).to receive(:api_key).and_return(api_key) }
-
-  context '4xx response' do
-    it 'raises a custom error' do
-      path = '4xx_response'
-
-      expect { resource.get(path: path, payload: payload) }.
-        to raise_error(Onfido::RequestError, 'Something went wrong')
-    end
-  end
-
-  context 'unexpected error format' do
-    it 'raises a custom error' do
-      path = 'unexpected_error_format'
-
-      expect { resource.get(path: path, payload: payload) }.
-        to raise_error(Onfido::RequestError, /response code was 400/)
-    end
-  end
-
-  context 'unparseable JSON 5xx' do
-    it 'raises a server error' do
-      path = 'unparseable_response'
-
-      expect { resource.get(path: path, payload: payload) }.
-        to raise_error(Onfido::ServerError, /response code was 504/)
-    end
-  end
-
-  context 'timeout' do
-    before do
-      allow(RestClient::Request).
-        to receive(:execute).
-        and_raise(RestClient::RequestTimeout)
-    end
-
-    it 'raises a ConnectionError' do
-      expect { resource.get(path: Onfido.endpoint, payload: payload) }.
-        to raise_error(Onfido::ConnectionError, /Could not connect/)
-    end
-  end
-
-  context 'broken connection' do
-    before do
-      allow(RestClient::Request).
-        to receive(:execute).
-        and_raise(RestClient::ServerBrokeConnection)
-    end
-
-    it 'raises a ConnectionError' do
-      expect { resource.get(path: Onfido.endpoint, payload: payload) }.
-        to raise_error(Onfido::ConnectionError, /connection to the server/)
-    end
-  end
-
-  context "bad SSL certificate" do
-    before do
-      allow(RestClient::Request).
-        to receive(:execute).
-        and_raise(RestClient::SSLCertificateNotVerified.new(nil))
-    end
-
-    it 'raises a ConnectionError' do
-      expect { resource.get(path: Onfido.endpoint, payload: payload) }.
-        to raise_error(Onfido::ConnectionError, /SSL certificate/)
-    end
-  end
-end

data/spec/onfido/resource_spec.rb

@@ -1,131 +0,0 @@
-require 'onfido/errors/connection_error'
-
-describe Onfido::Resource do
-  subject(:resource) { described_class.new }
-
-  let(:endpoint) { 'https://api.onfido.com/v3/' }
-  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) }
-
-  describe '#method_missing' do
-    %i(patch).each do |method|
-      context "for unsupported HTTP method: #{method}" do
-        it 'raises an error' do
-          expect do
-            resource.public_send(method, path: endpoint)
-          end.to raise_error(NoMethodError)
-        end
-      end
-    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(path: path, 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(path: path, 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 put delete).each do |method|
-      context "for supported HTTP method: #{method}" do
-        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
-
-            WebMock.stub_request(method, url).
-              to_return(body: response.to_json,
-                        status: 200,
-                        headers: { "Content-Type" => "application/json" })
-          end
-
-          it 'makes a request to an endpoint' do
-            expect(resource.public_send(method, path: path, payload: payload)).
-              to eq(response)
-          end
-        end
-
-        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, path: path, payload: payload) }.
-              to raise_error(Onfido::ConnectionError)
-          end
-        end
-      end
-    end
-  end
-end