onfido 0.15.1 → 1.0.0

data/lib/onfido/resources/webhook.rb

@@ -1,18 +1,16 @@
 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
 
     # As well as being a normal resource, Onfido::Webhook also supports
@@ -29,7 +27,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.15.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/onfido.gemspec

@@ -7,14 +7,14 @@ 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")

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,6 +76,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,17 +84,15 @@ 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
+        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')

data/spec/integrations/check_spec.rb

@@ -1,103 +1,49 @@
 describe Onfido::Check do
   subject(:check) { described_class.new }
   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}" }
+      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['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' }
-
     it 'returns success response' do
       expect { check.resume(check_id) }.not_to raise_error
     end

data/spec/integrations/document_spec.rb

@@ -6,15 +6,15 @@ describe Onfido::Document do
   describe '#create' do
     let(:params) do
       {
-        type: 'passport',
-        side: 'back',
-        file: file
+        applicant_id: '1030303-123123-123123',
+        type: 'driving_licence',
+        file: file,
+        side: 'front'
       }
     end
-    let(:applicant_id) { '1030303-123123-123123' }
 
     context 'with a File-like object to upload' do
-      let(:file) { Tempfile.new(['passport', '.jpg']) }
+      let(:file) { Tempfile.new(['driving_licence', '.jpg']) }
 
       after do
         file.close
@@ -22,7 +22,8 @@ describe Onfido::Document do
       end
 
       it 'creates a new document' do
-        response = document.create('foobar', params)
+        response = document.create(params)
+
         expect(response['id']).not_to be_nil
       end
     end
@@ -31,37 +32,35 @@ describe Onfido::Document do
       let(:file) { 'https://onfido.com/images/logo.png' }
 
       it 'raises an ArgumentError' do
-        expect { document.create('foobar', params) }.
+        expect { document.create(params) }.
           to raise_error(ArgumentError, /must be a `File`-like object/)
       end
     end
   end
 
   describe '#find' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:document_id) { '7568415-123123-123123' }
-
     it 'returns the expected document' do
-      response = document.find(applicant_id, document_id)
+      document_id = '7568415-123123-123123'
+      response = document.find(document_id)
+
       expect(response['id']).to eq(document_id)
     end
   end
 
   describe '#all' do
-    let(:applicant_id) { '1030303-123123-123123' }
-
     it 'returns list of documents' do
+      applicant_id = '1030303-123123-123123'
       response = document.all(applicant_id)
+
       expect(response['documents']).not_to be_empty
     end
   end
 
   describe '#download' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:document_id) { '1212121-123123-123123' }
-
     it 'returns the file data' do
-      response = document.download(applicant_id, document_id)
+      document_id = '1212121-123123-123123'
+      response = document.download(document_id)
+
       expect(response).not_to be_nil
     end
   end

data/spec/integrations/exceptions_spec.rb

@@ -1,34 +1,33 @@
 describe Onfido::Resource do
   let(:resource) { described_class.new }
-  let(:url) { Onfido.endpoint + path }
   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
-    let(:path) { '4xx_response' }
-
     it 'raises a custom error' do
-      expect { resource.get(url: url, payload: payload) }.
+      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
-    let(:path) { 'unexpected_error_format' }
-
     it 'raises a custom error' do
-      expect { resource.get(url: url, payload: payload) }.
+      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
-    let(:path) { 'unparseable_response' }
-
     it 'raises a server error' do
-      expect { resource.get(url: url, payload: payload) }.
+      path = 'unparseable_response'
+
+      expect { resource.get(path: path, payload: payload) }.
         to raise_error(Onfido::ServerError, /response code was 504/)
     end
   end
@@ -41,7 +40,7 @@ describe Onfido::Resource do
     end
 
     it 'raises a ConnectionError' do
-      expect { resource.get(url: Onfido.endpoint, payload: payload) }.
+      expect { resource.get(path: Onfido.endpoint, payload: payload) }.
         to raise_error(Onfido::ConnectionError, /Could not connect/)
     end
   end
@@ -54,7 +53,7 @@ describe Onfido::Resource do
     end
 
     it 'raises a ConnectionError' do
-      expect { resource.get(url: Onfido.endpoint, payload: payload) }.
+      expect { resource.get(path: Onfido.endpoint, payload: payload) }.
         to raise_error(Onfido::ConnectionError, /connection to the server/)
     end
   end
@@ -67,7 +66,7 @@ describe Onfido::Resource do
     end
 
     it 'raises a ConnectionError' do
-      expect { resource.get(url: Onfido.endpoint, payload: payload) }.
+      expect { resource.get(path: Onfido.endpoint, payload: payload) }.
         to raise_error(Onfido::ConnectionError, /SSL certificate/)
     end
   end