onfido 0.15.0 → 1.0.0

data/spec/integrations/live_photo_spec.rb

@@ -4,7 +4,7 @@ describe Onfido::LivePhoto do
   subject(:live_photo) { described_class.new }
 
   describe '#create' do
-    let(:params) { { file: file } }
+    let(:params) { { applicant_id: '123456', file: file } }
 
     context 'with a File-like object to upload' do
       let(:file) { Tempfile.new(['passport', '.jpg']) }
@@ -15,7 +15,8 @@ describe Onfido::LivePhoto do
       end
 
       it 'creates a new photo' do
-        response = live_photo.create('foobar', params)
+        response = live_photo.create(params)
+
         expect(response['id']).not_to be_nil
       end
     end
@@ -24,37 +25,35 @@ describe Onfido::LivePhoto do
       let(:file) { 'https://onfido.com/images/photo.jpg' }
 
       it 'raises an ArgumentError' do
-        expect { live_photo.create('foobar', params) }.
+        expect { live_photo.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(:live_photo_id) { '3538c8f6-fdce-4745-9d34-fc246bc05aa1' }
-
     it 'returns the expected live photo' do
-      response = live_photo.find(applicant_id, live_photo_id)
+      live_photo_id = '3538c8f6-fdce-4745-9d34-fc246bc05aa1'
+      response = live_photo.find(live_photo_id)
+
       expect(response['id']).to eq(live_photo_id)
     end
   end
 
   describe '#all' do
-    let(:applicant_id) { '1030303-123123-123123' }
-
     it 'returns list of documents' do
+      applicant_id = '1030303-123123-123123'
       response = live_photo.all(applicant_id)
+
       expect(response['live_photos']).not_to be_empty
     end
   end
 
   describe '#download' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:live_photo_id) { '3538c8f6-fdce-4745-9d34-fc246bc05aa1' }
-
     it 'returns the file data' do
-      response = live_photo.download(applicant_id, live_photo_id)
+      live_photo_id = '3538c8f6-fdce-4745-9d34-fc246bc05aa1'
+      response = live_photo.download(live_photo_id)
+
       expect(response).not_to be_nil
     end
   end

data/spec/integrations/live_video_spec.rb

@@ -2,32 +2,29 @@ require 'tempfile'
 
 describe Onfido::LiveVideo do
   subject(:live_video) { described_class.new }
+  let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
 
   describe '#find' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
-
     it 'returns the expected live photo' do
-      response = live_video.find(applicant_id, live_video_id)
+      response = live_video.find(live_video_id)
+
       expect(response['id']).to eq(live_video_id)
     end
   end
 
   describe '#all' do
-    let(:applicant_id) { '1030303-123123-123123' }
-
     it 'returns list of documents' do
+      applicant_id = '1030303-123123-123123'
       response = live_video.all(applicant_id)
+
       expect(response['live_videos']).not_to be_empty
     end
   end
 
   describe '#download' do
-    let(:applicant_id) { '1030303-123123-123123' }
-    let(:live_video_id) { 'c9701e9b-83aa-442f-995b-20320ee8fb01' }
-
     it 'returns the file data' do
-      response = live_video.download(applicant_id, live_video_id)
+      response = live_video.download(live_video_id)
+
       expect(response).not_to be_nil
     end
   end

data/spec/integrations/report_spec.rb

@@ -1,38 +1,36 @@
 describe Onfido::Report do
   subject(:report) { described_class.new }
-  let(:check_id) { '8546921-123123-123123' }
-
   describe '#find' do
-    let(:report_id) { '6951786-123123-422221' }
-
     it 'returns a report for an existing check' do
-      response = report.find(check_id, report_id)
+      report_id = '6951786-123123-422221'
+      response = report.find(report_id)
+
       expect(response['id']).to eq(report_id)
     end
   end
 
   describe '#all' do
     it 'lists all reports for an existing check' do
+      check_id = '8546921-123123-123123'
       response = report.all(check_id)
+
       expect(response['reports'].count).to eq(2)
     end
   end
 
   describe '#resume' do
-    let(:report_id) { '6951786-123123-422221' }
-    let(:check_id) { '1212121-123123-422221' }
-
     it 'returns a success response' do
-      expect { report.resume(check_id, report_id) }.not_to raise_error
+      report_id = '6951786-123123-422221'
+
+      expect { report.resume(report_id) }.not_to raise_error
     end
   end
 
   describe '#cancel' do
-    let(:report_id) { '6951786-123123-422221' }
-    let(:check_id) { '1212121-123123-422221' }
-
     it 'returns a success response' do
-      expect { report.cancel(check_id, report_id) }.not_to raise_error
+      report_id = '6951786-123123-422221'
+
+      expect { report.cancel(report_id) }.not_to raise_error
     end
   end
 end

data/spec/integrations/sdk_token_spec.rb

@@ -1,13 +1,13 @@
 describe Onfido::SdkToken do
   subject(:sdk_token) { described_class.new }
-  let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
-  let(:referrer) { 'http://*.mywebsite.com/*' }
 
   describe '#create' do
-    let(:params) { { applicant_id: applicant_id, referrer: referrer } }
-
     it 'creates a new SDK token for the applicant' do
-      response = sdk_token.create(params)
+      applicant_id = '61f659cb-c90b-4067-808a-6136b5c01351'
+      referrer = 'http://*.mywebsite.com/*'
+
+      response = sdk_token.create(applicant_id: applicant_id, referrer: referrer)
+
       expect(response['token']).not_to be_nil
     end
   end

data/spec/integrations/webhook_spec.rb

@@ -1,35 +1,37 @@
 describe Onfido::Webhook do
   subject(:webhook) { described_class.new }
-  let(:params) do
-    {
-      "url" => "https://webhookendpoint.url",
-      "enabled" => true,
-      "events" => [
-        "report completion",
-        "report withdrawal",
-        "check completion",
-        "check in progress"
-      ]
-    }
-  end
 
   describe "#create" do
-    it "cretes the webhook" do
+    let(:params) do
+      {
+        url: "https://webhookendpoint.url",
+        enabled: true,
+        events: [
+          "report.completed",
+          "check.completed"
+        ]
+      }
+    end
+
+    it "creates the webhook" do
       response = webhook.create(params)
+
       expect(response['id']).to_not be_nil
     end
 
     it "responds with the right url" do
       response = webhook.create(params)
-      expect(response["url"]).to eq params["url"]
+
+      expect(response["url"]).to eq params[:url]
     end
   end
 
   describe '#find' do
-    let(:webhook_id) { 'fcb73186-0733-4f6f-9c57-d9d5ef979443' }
-
     it 'returns the webhook' do
+      webhook_id = 'fcb73186-0733-4f6f-9c57-d9d5ef979443'
+
       response = webhook.find(webhook_id)
+
       expect(response['id']).to eq(webhook_id)
     end
   end
@@ -37,11 +39,13 @@ describe Onfido::Webhook do
   describe "#all" do
     it "returns all the registered webhooks" do
       response = webhook.all
+
       expect(response["webhooks"].count).to eq 2
     end
 
     it "returns with id" do
       response = webhook.all
+
       expect(response["webhooks"][0]["id"]).to_not be_nil
       expect(response["webhooks"][1]["id"]).to_not be_nil
     end
@@ -53,13 +57,17 @@ describe Onfido::Webhook do
     end
 
     let(:request_body) { '{"foo":"bar"}' }
-    let(:request_signature) { 'fdab9db604d33297741b43b9fc9536028d09dca3' }
+    let(:request_signature) do
+      '89e60408fec20bfb26bb0f993d5e88307818982f50f23b361a00d679bae8b1dc'
+    end
     let(:token) { 'very_secret_token' }
 
     it { is_expected.to be(true) }
 
     context "with an invalid signature" do
-      let(:request_signature) { '2f3d7727ff9a32a7c87072ce514df1f6d3228bec' }
+      let(:request_signature) do
+        's21fd54ew2w1f5d15642132f3d7727ff9a32a7c87072ce514df1f6d3228bec'
+      end
       it { is_expected.to be(false) }
     end
 

data/spec/onfido/resource_spec.rb

@@ -3,7 +3,7 @@ require 'onfido/errors/connection_error'
 describe Onfido::Resource do
   subject(:resource) { described_class.new }
 
-  let(:endpoint) { 'https://api.onfido.com/v2/' }
+  let(:endpoint) { 'https://api.onfido.com/v3/' }
   let(:path)     { 'addresses/pick' }
   let(:url)      { endpoint + path }
   let(:payload)  { { postcode: 'SE1 4NG' } }
@@ -25,18 +25,12 @@ describe Onfido::Resource do
   before { allow(Onfido).to receive(:endpoint).and_return(endpoint) }
   before { allow(Onfido).to receive(:api_key).and_return(api_key) }
 
-  describe '#url_for' do
-    it 'composes the full api url' do
-      expect(resource.url_for(path)).to eq(endpoint + path)
-    end
-  end
-
   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, url: endpoint)
+            resource.public_send(method, path: endpoint)
           end.to raise_error(NoMethodError)
         end
       end
@@ -64,7 +58,7 @@ describe Onfido::Resource do
       let(:specific_api_key) { "specific_key" }
 
       it "uses that key when making the request" do
-        resource.get(url: url, payload: payload)
+        resource.get(path: path, payload: payload)
 
         expect(WebMock).to have_requested(:get, url).with(
           headers: {
@@ -79,7 +73,7 @@ describe Onfido::Resource do
       let(:specific_api_key) { nil }
 
       it "uses the general config key when making the request" do
-        resource.get(url: url, payload: payload)
+        resource.get(path: path, payload: payload)
 
         expect(WebMock).to have_requested(:get, url).with(
           headers: {
@@ -113,7 +107,7 @@ describe Onfido::Resource do
           end
 
           it 'makes a request to an endpoint' do
-            expect(resource.public_send(method, url: url, payload: payload)).
+            expect(resource.public_send(method, path: path, payload: payload)).
               to eq(response)
           end
         end
@@ -127,7 +121,7 @@ describe Onfido::Resource do
           end
 
           it "raises a ConnectionError" do
-            expect { resource.public_send(method, url: url, payload: payload) }.
+            expect { resource.public_send(method, path: path, payload: payload) }.
               to raise_error(Onfido::ConnectionError)
           end
         end

data/spec/onfido_spec.rb

@@ -11,7 +11,7 @@ describe Onfido do
 
       describe ".endpoint" do
         subject { onfido.endpoint }
-        it { is_expected.to eq('https://api.onfido.com/v2/') }
+        it { is_expected.to eq('https://api.onfido.com/v3/') }
       end
 
       describe ".logger" do
@@ -27,18 +27,10 @@ describe Onfido do
       end
     end
 
-    describe "setting the API version" do
-      it 'changes the configuration to the new value' do
-        onfido.api_version = 'v1'
-        expect(onfido.api_version).to eq('v1')
-        expect(onfido.endpoint).to eq('https://api.onfido.com/v1/')
-      end
-    end
-
     describe 'using the US region' do
       it 'should change endpoint' do
         onfido.region = 'us'
-        expect(onfido.endpoint).to eq('https://api.us.onfido.com/v2/')
+        expect(onfido.endpoint).to eq('https://api.us.onfido.com/v3/')
       end
     end
 
@@ -53,7 +45,7 @@ describe Onfido do
     describe 'using an old API token' do
       it 'should use old endpoint' do
         onfido.api_key = "live_asdfghjkl1234567890qwertyuiop"
-        expect(onfido.endpoint).to eq('https://api.onfido.com/v2/')
+        expect(onfido.endpoint).to eq('https://api.onfido.com/v3/')
       end
     end
 

data/spec/support/fake_onfido_api.rb

@@ -1,32 +1,32 @@
 require 'sinatra/base'
 
 class FakeOnfidoAPI < Sinatra::Base
-  get '/v2/addresses/pick' do
+  get '/v3/addresses/pick' do
     json_response(200, 'addresses.json')
   end
 
-  post '/v2/applicants' do
+  post '/v3/applicants' do
     json_response(201, 'applicant.json')
   end
 
-  put '/v2/applicants/:id' do
+  put '/v3/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v2/applicants/:id' do
+  get '/v3/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v2/applicants' do
+  get '/v3/applicants' do
     response = json_response(200, 'applicants.json')
     { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
   end
 
-  delete '/v2/applicants/:id' do
+  delete '/v3/applicants/:id' do
     status 204
   end
 
-  post '/v2/applicants/:id/restore' do
+  post '/v3/applicants/:id/restore' do
     if params["id"] == "a2fb9c62-ab10-4898-a8ec-342c4b552ad5"
       json_response(422, 'not_scheduled_for_deletion_error.json')
     else
@@ -34,37 +34,33 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
-  post '/v2/applicants/:id/documents' do
+  post '/v3/documents' do
     json_response(201, 'document.json')
   end
 
-  get '/v2/applicants/:id/documents/:id' do
+  get '/v3/documents/:id' do
     json_response(200, 'document.json')
   end
 
-  get '/v2/applicants/:id/documents' do
+  get '/v3/documents' do
     json_response(200, 'documents.json')
   end
 
-  get '/v2/applicants/:id/documents/:id/download' do
+  get '/v3/documents/:id/download' do
     status 200
     content_type 'application/octet-stream'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v2/live_photos' do
+  post '/v3/live_photos' do
     json_response(201, 'live_photo.json')
   end
 
-  get '/v2/live_photos/:id' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      json_response(200, 'live_photo.json')
-    end
+  get '/v3/live_photos/:id' do
+    json_response(200, 'live_photo.json')
   end
 
-  get '/v2/live_photos' do
+  get '/v3/live_photos' do
     if params["applicant_id"] != "1030303-123123-123123"
       status 404
     else
@@ -72,25 +68,17 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
-  get '/v2/live_photos/:id/download' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      status 200
-      content_type 'image/jpeg'
-      "\x01\x02\x03" # acts as binary file data
-    end
+  get '/v3/live_photos/:id/download' do
+    status 200
+    content_type 'image/jpeg'
+    "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v2/live_videos/:id' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      json_response(200, 'live_video.json')
-    end
+  get '/v3/live_videos/:id' do
+    json_response(200, 'live_video.json')
   end
 
-  get '/v2/live_videos' do
+  get '/v3/live_videos' do
     if params["applicant_id"] != "1030303-123123-123123"
       status 404
     else
@@ -98,91 +86,69 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
-  get '/v2/live_videos/:id/download' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      status 200
-      content_type 'video/quicktime'
-      "\x01\x02\x03" # acts as binary file data
-    end
+  get '/v3/live_videos/:id/download' do
+    status 200
+    content_type 'video/quicktime'
+    "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v2/applicants/:id/checks' do
-    json_response(201, 'check.json')
+  post '/v3/checks' do
+    params["applicant_id"].nil? ? status(422) : json_response(201, 'check.json')
   end
 
-  get '/v2/applicants/:id/checks/:id' do
-    if params["expand"] == "reports"
-      json_response(200, "check_with_expanded_reports.json")
-    else
-      json_response(200, "check.json")
-    end
+  get '/v3/checks/:id' do
+    json_response(200, "check.json")
   end
 
-  get '/v2/applicants/:id/checks' do
-    response = if params["expand"] == "reports"
-                 json_response(200, "checks_with_expanded_reports.json")
-               else
-                 json_response(200, "checks.json")
-               end
-
-    { checks: JSON.parse(response)['checks'][pagination_range] }.to_json
+  get '/v3/checks' do
+    json_response(200, "checks.json")
   end
 
-  post '/v2/checks/:id/resume' do
+  post '/v3/checks/:id/resume' do
     status 204 # no_content
   end
 
-  get '/v2/checks/:id/reports' do
+  get '/v3/reports' do
     json_response(200, 'reports.json')
   end
 
-  get '/v2/checks/:id/reports/:id' do
+  get '/v3/reports/:id' do
     json_response(200, 'report.json')
   end
 
-  post '/v2/checks/:id/reports/:id/resume' do
+  post '/v3/reports/:id/resume' do
     status 204
   end
 
-  post '/v2/checks/:id/reports/:id/cancel' do
+  post '/v3/reports/:id/cancel' do
     status 204
   end
 
-  get '/v2/report_type_groups/:id' do
-    json_response(200, 'report_type_group.json')
-  end
-
-  get '/v2/report_type_groups' do
-    json_response(200, 'report_type_groups.json')
-  end
-
-  post '/v2/sdk_token' do
+  post '/v3/sdk_token' do
     json_response(201, 'sdk_token.json')
   end
 
-  post '/v2/webhooks' do
+  post '/v3/webhooks' do
     json_response(201, 'webhook.json')
   end
 
-  get '/v2/webhooks/:id' do
+  get '/v3/webhooks/:id' do
     json_response(200, 'webhook.json')
   end
 
-  get '/v2/webhooks' do
+  get '/v3/webhooks' do
     json_response(200, 'webhooks.json')
   end
 
-  get '/v2/4xx_response' do
+  get '/v3/4xx_response' do
     json_response(422, '4xx_response.json')
   end
 
-  get '/v2/unexpected_error_format' do
+  get '/v3/unexpected_error_format' do
     json_response(400, 'unexpected_error_format.json')
   end
 
-  get '/v2/unparseable_response' do
+  get '/v3/unparseable_response' do
     content_type :json
     status 504
     ''