onfido 0.15.0 → 2.0.0

data/lib/onfido/resources/extraction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Onfido
+  class Extraction < Resource
+    def create(document_id:)
+      payload = { document_id: document_id }
+
+      post(path: 'extractions', payload: payload)
+    end
+  end
+end

data/lib/onfido/resources/live_photo.rb

@@ -1,30 +1,27 @@
+# frozen_string_literal: true
+
 module Onfido
   class LivePhoto < Resource
     # with open-uri the file can be a link or an actual file
 
-    def create(applicant_id, payload)
-      validate_file!(payload.fetch(:file))
+    def create(applicant_id:, file:, **payload)
+      validate_file!(file)
       payload[:applicant_id] = applicant_id
+      payload[:file] = file
 
-      post(
-        url: url_for("/live_photos"),
-        payload: payload
-      )
+      post(path: 'live_photos', payload: payload)
     end
 
-    def find(applicant_id, live_photo_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_photos/#{live_photo_id}?#{query_string}"))
+    def find(live_photo_id)
+      get(path: "live_photos/#{live_photo_id}")
     end
 
-    def download(applicant_id, live_photo_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_photos/#{live_photo_id}/download?#{query_string}"))
+    def download(live_photo_id)
+      get(path: "live_photos/#{live_photo_id}/download")
     end
 
     def all(applicant_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_photos?#{query_string}"))
+      get(path: "live_photos?applicant_id=#{applicant_id}")
     end
   end
 end

data/lib/onfido/resources/live_video.rb

@@ -1,18 +1,17 @@
+# frozen_string_literal: true
+
 module Onfido
   class LiveVideo < Resource
-    def find(applicant_id, live_video_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_videos/#{live_video_id}?#{query_string}"))
+    def find(live_video_id)
+      get(path: "live_videos/#{live_video_id}")
     end
 
-    def download(applicant_id, live_video_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_videos/#{live_video_id}/download?#{query_string}"))
+    def download(live_video_id)
+      get(path: "live_videos/#{live_video_id}/download")
     end
 
     def all(applicant_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_videos?#{query_string}"))
+      get(path: "live_videos?applicant_id=#{applicant_id}")
     end
   end
 end

data/lib/onfido/resources/report.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
+
 module Onfido
   class Report < Resource
-    def find(check_id, report_id)
-      get(url: url_for("checks/#{check_id}/reports/#{report_id}"))
+    def find(report_id)
+      get(path: "reports/#{report_id}")
     end
 
-    def all(check_id, page: 1, per_page: 20)
-      querystring = "page=#{page}&per_page=#{per_page}"
-      get(url: url_for("checks/#{check_id}/reports?#{querystring}"))
+    def all(check_id)
+      get(path: "reports?check_id=#{check_id}")
     end
 
-    def resume(check_id, report_id)
-      post(url: url_for("checks/#{check_id}/reports/#{report_id}/resume"))
+    def resume(report_id)
+      post(path: "reports/#{report_id}/resume")
     end
 
-    def cancel(check_id, report_id)
-      post(url: url_for("checks/#{check_id}/reports/#{report_id}/cancel"))
+    def cancel(report_id)
+      post(path: "reports/#{report_id}/cancel")
     end
   end
 end

data/lib/onfido/resources/sdk_token.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module Onfido
   class SdkToken < Resource
-    def create(payload)
-      post(
-        url: url_for("sdk_token"),
-        payload: payload
-      )
+    def create(applicant_id:, **payload)
+      payload[:applicant_id] = applicant_id
+      post(path: 'sdk_token', payload: payload)
     end
   end
 end

data/lib/onfido/resources/webhook.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 module Onfido
   class Webhook < Resource
-    def create(payload)
-      post(
-        url: url_for('webhooks'),
-        payload: payload
-      )
+    def create(url:, **payload)
+      payload[:url] = url
+      post(path: 'webhooks', payload: payload)
     end
 
     def find(webhooks_id)
-      get(url: url_for("webhooks/#{webhooks_id}"))
+      get(path: "webhooks/#{webhooks_id}")
+    end
+
+    def all
+      get(path: 'webhooks')
     end
 
-    def all(page: 1, per_page: 20)
-      get(url: url_for("webhooks?page=#{page}&per_page=#{per_page}"))
+    def destroy(webhook_id)
+      delete(path: "webhooks/#{webhook_id}")
     end
 
     # As well as being a normal resource, Onfido::Webhook also supports
@@ -20,8 +24,8 @@ module Onfido
     # request to one computed from the body
     def self.valid?(request_body, request_signature, token)
       if [request_body, request_signature, token].any?(&:nil?)
-        raise ArgumentError, "A request body, request signature and token " \
-                             "must be provided"
+        raise ArgumentError, 'A request body, request signature and token ' \
+                             'must be provided'
       end
 
       computed_signature = generate_signature(request_body, token)
@@ -29,7 +33,7 @@ module Onfido
     end
 
     def self.generate_signature(request_body, token)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), token, request_body)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), token, request_body)
     end
     private_class_method :generate_signature
   end

data/lib/onfido/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
-  VERSION = '0.15.0'.freeze
+  VERSION = '2.0.0'
 end

data/onfido.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -7,27 +7,25 @@ require 'onfido/version'
 Gem::Specification.new do |spec|
   spec.name          = 'onfido'
   spec.version       = Onfido::VERSION
-  spec.authors       = ['Pericles Theodorou', 'Grey Baker']
-  spec.email         = ['periclestheo@gmail.com', 'grey@gocardless.com']
+  spec.authors       = ['Onfido']
+  spec.email         = ['engineering@onfido.com']
   spec.summary       = 'A wrapper for Onfido API'
-  spec.description   = "A thin wrapper for Onfido's API. This gem supports "\
-                       "both v1 and v2 of the Onfido API. Refer to Onfido's "\
-                       "API documentation for details of the expected "\
-                       "requests and responses for both."
-  spec.homepage      = 'http://github.com/hvssle/onfido'
+  spec.description   = "A thin wrapper for Onfido's API. This gem only supports "\
+                       "v3 of the Onfido API. Refer to Onfido's "\
+                       'API documentation for details of the expected '\
+                       'requests and responses.'
+  spec.homepage      = 'http://github.com/onfido/onfido-ruby'
   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.required_ruby_version = ">= 2.2.0"
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '~> 0.57.0'
+  spec.add_development_dependency 'rubocop', '~> 1.11'
   spec.add_development_dependency 'sinatra', '~> 1.4'
   spec.add_development_dependency 'webmock', '~> 3.0'
 

data/spec/integrations/address_spec.rb

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

data/spec/integrations/applicant_spec.rb

@@ -1,38 +1,29 @@
+# frozen_string_literal: true
+
 describe Onfido::Applicant do
-  subject(:applicant) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:applicant) { onfido.applicant }
+
+  let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
   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'
-        }
-      ]
+      'address' => {
+        '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'
+      }
     }
   end
 
@@ -43,9 +34,9 @@ describe Onfido::Applicant do
 
     it 'serializes the payload correctly' do
       WebMock.after_request do |request_signature, _response|
-        if request_signature.uri.path == 'v2/applicants'
-          expect(Rack::Utils.parse_nested_query(request_signature.body)).
-            to eq(params)
+        if request_signature.uri.path == 'v3.1/applicants'
+          expect(Rack::Utils.parse_nested_query(request_signature.body))
+            .to eq(params)
         end
       end
     end
@@ -57,26 +48,22 @@ describe Onfido::Applicant do
   end
 
   describe '#update' do
-    let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-
     it 'updates an applicant' do
       response = applicant.update(applicant_id, params)
+
       expect(response['id']).to eq(applicant_id)
     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 '#destroy' do
-    let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-
     it 'returns success code' do
       expect { applicant.destroy(applicant_id) }.not_to raise_error
     end
@@ -86,6 +73,7 @@ describe Onfido::Applicant do
     context 'with the default page and per page params' do
       it 'returns all the applicants' do
         response = applicant.all
+
         expect(response['applicants'].size).to eq(2)
       end
     end
@@ -93,6 +81,7 @@ describe Onfido::Applicant do
     context 'with specific range of results for a page' do
       it 'returns the specified applicants' do
         response = applicant.all(page: 1, per_page: 1)
+
         expect(response['applicants'].size).to eq(1)
       end
     end
@@ -100,24 +89,22 @@ describe Onfido::Applicant do
 
   describe '#restore' do
     context 'an applicant scheduled for deletion' do
-      let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-
       it 'returns nil' do
         expect(applicant.restore(applicant_id)).to be_nil
       end
     end
 
     context 'an applicant not scheduled for deletion' do
-      let(:applicant_id) { 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5' }
-
       it 'returns an error' do
-        expect { applicant.restore(applicant_id) }.to raise_error { |error|
+        applicant_id = 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
+
+        expect { applicant.restore(applicant_id) }.to raise_error do |error|
           expect(error).to be_a(Onfido::RequestError)
           expect(error.message).to eq('There was a validation error on this request')
           expect(error.fields).to eq(
-            "Applicant a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion"
+            'Applicant a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion'
           )
-        }
+        end
       end
     end
   end

data/spec/integrations/check_spec.rb

@@ -1,105 +1,64 @@
+# frozen_string_literal: true
+
 describe Onfido::Check do
-  subject(:check) { described_class.new }
+  include_context 'fake onfido api'
+
+  subject(:check) { onfido.check }
+
   let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
+  let(:check_id) { '8546921-123123-123123' }
 
   describe '#create' do
-    let(:params) { { type: 'express', reports: [{ name: 'identity' }] } }
-
     it 'creates a new check for an applicant' do
-      response = check.create(applicant_id, params)
+      response = check.create(
+        applicant_id: applicant_id,
+        report_names: ['identity_enhanced']
+      )
       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
-
-    it "returns unexpanded reports" do
-      response = check.find(applicant_id, check_id)
-      expect(response['reports'].first).to be_a(String)
-    end
-
-    it 'allows you to expand the reports' do
-      response = check.find(applicant_id, check_id, expand: "reports")
-      expect(response['reports'].first).to be_a(Hash)
-    end
-  end
-
-  describe '#find_by_url' do
-    let(:check_id) { '8546921-123123-123123' }
-
-    context 'partial url' do
-      let(:url) { "applicants/#{applicant_id}/checks/#{check_id}" }
-
-      it 'returns an existing check for the applicant with the partial url' do
-        response = check.find_by_url(url)
-        expect(response['id']).to eq(check_id)
-      end
-
-      it "returns unexpanded reports" do
-        response = check.find_by_url(url)
-        expect(response['reports'].first).to be_a(String)
-      end
+      response = check.find(check_id)
 
-      it 'allows you to expand the reports' do
-        response = check.find_by_url(url, expand: "reports")
-        expect(response['reports'].first).to be_a(Hash)
-      end
+      expect(response['id']).to eq(check_id)
     end
 
-    context 'full url' do
-      let(:url) do
-        "https://api.onfido.com/v2/applicants/#{applicant_id}/checks/#{check_id}"
-      end
+    it 'returns report_ids' do
+      response = check.find(check_id)
 
-      it 'returns an existing check for the applicant with the partial url' do
-        response = check.find_by_url(url)
-        expect(response['id']).to eq(check_id)
-      end
-
-      it "returns unexpanded reports" do
-        response = check.find_by_url(url)
-        expect(response['reports'].first).to be_a(String)
-      end
-
-      it 'allows you to expand the reports' do
-        response = check.find_by_url(url, expand: "reports")
-        expect(response['reports'].first).to be_a(Hash)
-      end
+      expect(response['report_ids'].first).to be_a(String)
     end
   end
 
   describe '#all' do
-    let(:check_id) { '8546921-123123-123123' }
-
     context 'with the default page and per page params' do
       it 'returns all existing checks for the applicant' do
         response = check.all(applicant_id)
+
         expect(response['checks'].size).to eq(1)
       end
     end
 
-    it "returns unexpanded reports" do
+    it 'returns report_ids' do
       response = check.all(applicant_id)
-      expect(response['checks'].first['reports'].first).to be_a(String)
-    end
 
-    it 'allows you to expand the reports' do
-      response = check.all(applicant_id, expand: "reports")
-      expect(response['checks'].first['reports'].first).to be_a(Hash)
+      expect(response['checks'].first['report_ids'].first).to be_a(String)
     end
   end
 
-  describe "#resume" do
-    let(:check_id) { '8546921-123123-123123' }
-
+  describe '#resume' do
     it 'returns success response' do
       expect { check.resume(check_id) }.not_to raise_error
     end
   end
+
+  describe '#download' do
+    it 'returns the file data' do
+      response = check.download(check_id)
+
+      expect(response).not_to be_nil
+    end
+  end
 end