onfido 0.12.0 → 1.1.0

data/lib/onfido/resource.rb

@@ -7,15 +7,11 @@ module Onfido
       @api_key = api_key || Onfido.api_key
     end
 
-    def url_for(path)
-      Onfido.endpoint + path
-    end
-
     VALID_HTTP_METHODS.each do |method|
       define_method method do |*args|
         make_request(
           method: method.to_sym,
-          url: args.first.fetch(:url),
+          url: Onfido.endpoint + args.first.fetch(:path),
           payload: build_query(args.first.fetch(:payload, {}))
         )
       end
@@ -69,7 +65,8 @@ module Onfido
     def headers
       {
         'Authorization' => "Token token=#{@api_key}",
-        'Accept' => "application/json"
+        'Accept' => "application/json",
+        'User-Agent' => "onfido-ruby/#{Onfido::VERSION}"
       }
     end
 

data/lib/onfido/resources/address.rb

@@ -2,7 +2,7 @@ module Onfido
   class Address < Resource
     def all(postcode)
       get(
-        url: url_for('addresses/pick'),
+        path: 'addresses/pick',
         payload: { postcode: postcode.delete(' ') }
       )
     end

data/lib/onfido/resources/applicant.rb

@@ -1,23 +1,27 @@
 module Onfido
   class Applicant < Resource
     def create(payload)
-      post(url: url_for('applicants'), payload: payload)
+      post(path: 'applicants', payload: payload)
     end
 
     def update(applicant_id, payload)
-      put(url: url_for("applicants/#{applicant_id}"), payload: payload)
+      put(path: "applicants/#{applicant_id}", payload: payload)
     end
 
     def destroy(applicant_id)
-      delete(url: url_for("applicants/#{applicant_id}"))
+      delete(path: "applicants/#{applicant_id}")
     end
 
     def find(applicant_id)
-      get(url: url_for("applicants/#{applicant_id}"))
+      get(path: "applicants/#{applicant_id}")
     end
 
     def all(page: 1, per_page: 20)
-      get(url: url_for("applicants?page=#{page}&per_page=#{per_page}"))
+      get(path: "applicants?page=#{page}&per_page=#{per_page}")
+    end
+
+    def restore(applicant_id)
+      post(path: "applicants/#{applicant_id}/restore")
     end
   end
 end

data/lib/onfido/resources/check.rb

@@ -1,26 +1,22 @@
 module Onfido
   class Check < Resource
-    def create(applicant_id, payload)
-      post(
-        url: url_for("applicants/#{applicant_id}/checks"),
-        payload: payload
-      )
+    def create(applicant_id:, report_names:, **payload)
+      payload[:applicant_id] = applicant_id
+      payload[:report_names] = report_names
+
+      post(path: 'checks', payload: payload)
     end
 
-    def find(applicant_id, check_id, expand: nil)
-      querystring = "&expand=#{expand}" if expand
-      get(url: url_for("applicants/#{applicant_id}/checks/#{check_id}?" \
-                       "#{querystring}"))
+    def find(check_id)
+      get(path: "checks/#{check_id}")
     end
 
-    def all(applicant_id, page: 1, per_page: 20, expand: nil)
-      querystring = "page=#{page}&per_page=#{per_page}"
-      querystring += "&expand=#{expand}" if expand
-      get(url: url_for("applicants/#{applicant_id}/checks?#{querystring}"))
+    def all(applicant_id)
+      get(path: "checks?applicant_id=#{applicant_id}")
     end
 
     def resume(check_id)
-      post(url: url_for("checks/#{check_id}/resume"))
+      post(path: "checks/#{check_id}/resume")
     end
   end
 end

data/lib/onfido/resources/document.rb

@@ -2,25 +2,25 @@ module Onfido
   class Document < 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:, type:, **payload)
+      validate_file!(file)
+      payload[:applicant_id] = applicant_id
+      payload[:file] = file
+      payload[:type] = type
 
-      post(
-        url: url_for("applicants/#{applicant_id}/documents"),
-        payload: payload
-      )
+      post(path: 'documents', payload: payload)
     end
 
-    def find(applicant_id, document_id)
-      get(url: url_for("applicants/#{applicant_id}/documents/#{document_id}"))
+    def find(document_id)
+      get(path: "documents/#{document_id}")
     end
 
-    def download(applicant_id, document_id)
-      get(url: url_for("applicants/#{applicant_id}/documents/#{document_id}/download"))
+    def download(document_id)
+      get(path: "documents/#{document_id}/download")
     end
 
     def all(applicant_id)
-      get(url: url_for("applicants/#{applicant_id}/documents"))
+      get(path: "documents?applicant_id=#{applicant_id}")
     end
   end
 end

data/lib/onfido/resources/extraction.rb

@@ -0,0 +1,9 @@
+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

@@ -2,29 +2,24 @@ 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,15 @@
 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,19 @@
 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,8 @@
 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,20 @@
 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(page: 1, per_page: 20)
-      get(url: url_for("webhooks?page=#{page}&per_page=#{per_page}"))
+    def all
+      get(path: 'webhooks')
+    end
+
+    def destroy(webhook_id)
+      delete(path: "webhooks/#{webhook_id}")
     end
 
     # As well as being a normal resource, Onfido::Webhook also supports
@@ -29,7 +31,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,3 @@
 module Onfido
-  VERSION = '0.12.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/onfido.gemspec

@@ -1,20 +1,20 @@
 # coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 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 "\
+  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 for both."
-  spec.homepage      = 'http://github.com/hvssle/onfido'
+                       "requests and responses."
+  spec.homepage      = 'http://github.com/onfido/onfido-ruby'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -23,11 +23,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = ">= 2.2.0"
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
   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.52.0'
+  spec.add_development_dependency 'rubocop', '~> 0.57.0'
   spec.add_development_dependency 'sinatra', '~> 1.4'
   spec.add_development_dependency 'webmock', '~> 3.0'
 

data/spec/integrations/address_spec.rb

@@ -4,6 +4,7 @@ describe Onfido::Address do
   describe '#all' do
     it 'returns the addresses matching the postcode' do
       response = api.address.all('SW1 4NG')
+
       expect(response['addresses'].count).to eq(2)
     end
   end

data/spec/integrations/applicant_spec.rb

@@ -1,38 +1,24 @@
 describe Onfido::Applicant do
   subject(:applicant) { described_class.new }
+  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,7 +29,7 @@ describe Onfido::Applicant do
 
     it 'serializes the payload correctly' do
       WebMock.after_request do |request_signature, _response|
-        if request_signature.uri.path == 'v2/applicants'
+        if request_signature.uri.path == 'v3/applicants'
           expect(Rack::Utils.parse_nested_query(request_signature.body)).
             to eq(params)
         end
@@ -57,26 +43,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 +68,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,8 +76,31 @@ 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
   end
+
+  describe '#restore' do
+    context 'an applicant scheduled for deletion' do
+      it 'returns nil' do
+        expect(applicant.restore(applicant_id)).to be_nil
+      end
+    end
+
+    context 'an applicant not scheduled for deletion' do
+      it 'returns an error' do
+        applicant_id = 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
+
+        expect { applicant.restore(applicant_id) }.to raise_error { |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"
+          )
+        }
+      end
+    end
+  end
 end