onfido 2.9.0 → 3.0.0

data/spec/shared_contexts/with_live_photo.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_applicant'
+
+RSpec.shared_context 'with live photo', shared_context: :metadata do
+  include_context 'with applicant'
+
+  let(:live_photo_file_name) { 'sample_photo.png' }
+  let(:live_photo_file) { File.open("spec/integrations/media/#{live_photo_file_name}") }
+
+  let(:live_photo) do
+    onfido_api.upload_live_photo(
+      applicant_id: applicant_id,
+      file: live_photo_file,
+    )
+  end
+  let!(:live_photo_id) { live_photo.id }
+end

data/spec/shared_contexts/with_onfido.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'onfido'
+
+RSpec.shared_context 'with onfido' do
+  let(:onfido_api) do
+    Onfido::DefaultApi.new
+  end
+
+  Onfido.configure do |config|
+    config.api_token = ENV['ONFIDO_API_TOKEN']
+    config.region = config.region[:EU]
+  end
+end

data/spec/shared_contexts/with_workflow_run.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_applicant'
+
+RSpec.shared_context 'with workflow run', shared_context: :metadata do
+  include_context 'with applicant'
+
+  let(:workflow_id) { 'e8c921eb-0495-44fe-b655-bcdcaffdafe5' }
+
+  let(:workflow_run_builder) do
+    Onfido::WorkflowRunBuilder.new({
+      applicant_id: applicant_id,
+      workflow_id: workflow_id,
+    })
+  end
+
+  let(:workflow_run) { onfido_api.create_workflow_run(workflow_run_builder) }
+  let!(:workflow_run_id) { workflow_run.id }
+end

data/spec/spec_helper.rb

@@ -2,14 +2,10 @@
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-Dir[File.dirname(__FILE__).concat('/support/**/*.rb')].sort.each { |f| require f }
 
 require 'onfido'
-require 'webmock/rspec'
 require 'rspec/its'
 
-WebMock.disable_net_connect!(allow_localhost: true)
-
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     # This option will default to `true` in RSpec 4. It makes the `description`
@@ -22,13 +18,6 @@ RSpec.configure do |config|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
   config.order = :random
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
@@ -37,9 +26,82 @@ RSpec.configure do |config|
   config.warnings = false
   config.expose_dsl_globally = true
 
+  config.after(:suite) do
+    # clean-up applicants and webhooks
+    sample_applicant_id = ENV['ONFIDO_SAMPLE_APPLICANT_ID']
+    onfido_api = Onfido::DefaultApi.new
+
+    applicants = onfido_api.list_applicants(
+      page: 1,
+      per_page: 100,
+      include_deleted: false,
+    ).applicants
+
+    applicants.each do |applicant|
+      if applicant.id != sample_applicant_id
+        begin
+          onfido_api.delete_applicant(applicant.id)
+        rescue Onfido::ApiError
+          # ignore failures during cleanup
+        end
+      end
+    end
+
+    webhooks = onfido_api.list_webhooks().webhooks
+
+    webhooks.each do |webhook|
+      begin
+        onfido_api.delete_webhook(webhook.id)
+      rescue Onfido::ApiError
+        # ignore failures during cleanup
+      end
+    end
+  end
+
   # Seed global randomization in this process using the `--seed` CLI option.
   # Setting this allows you to use `--seed` to deterministically reproduce
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand config.seed
 end
+
+def repeat_request_until_status_changes(expected_status, max_retries = 10,
+  interval = 1, &proc)
+  # expected_status --> desired status
+  # max_retries     --> how many times to retry the request
+  # interval        --> how many seconds to wait until the next retry
+  # proc            --> code containing the request
+
+  instance = proc.call
+
+  iteration = 0
+  while instance.status != expected_status
+    raise "status did not change in time" if iteration > max_retries
+
+    iteration += 1
+    sleep(interval)
+    instance = proc.call
+  end
+
+  instance
+end
+
+def repeat_request_unti_http_code_changes(max_retries = 10,
+  interval = 1, &proc)
+  # max_retries        --> how many times to retry the request
+  # interval           --> how many seconds to wait until the next retry
+  # proc               --> code containing the request
+
+  iteration = 0
+  while iteration <= max_retries
+    begin
+      instance = proc.call
+      break
+    rescue Onfido::ApiError
+      sleep(interval)
+      iteration += 1
+    end
+  end
+
+  instance
+end

data/spec/webhook_event_verifier_spec.rb

@@ -0,0 +1,29 @@
+require 'onfido/webhook_event_verifier'
+require 'spec_helper'
+
+describe Onfido::WebhookEventVerifier do
+  subject { described_class.new('wU99mE6jJ7nXOLFwZ0tJymM1lpI15pZh') }
+  describe "#read_payload" do
+    let(:event_body) { '{"payload":{"resource_type":"check","action":"check.completed","object":{"id":"f2302f45-227d-413d-ad61-09ec077a086a","status":"complete","completed_at_iso8601":"2024-04-04T09:21:21Z","href":"https://api.onfido.com/v3.6/checks/f2302f45-227d-413d-ad61-09ec077a086a"}}}' }
+    let(:sig) { "77ebc3e418f26be6eebb47f7ebe551321de26734fc273961e075fc9ab163d9c7" }
+    it "raises an exception when the signature is invalid" do
+      expect do
+        subject.read_payload(event_body, "77ebc3e418f26be6eebb47f7ebe551321de26734fc273961e075fc9ab163d9c8")
+      end.to raise_error(Onfido::OnfidoInvalidSignatureError, "Invalid signature for webhook event")
+    end
+
+    it "returns the decoded event payload" do
+      expected_payload = JSON.parse(event_body)["payload"]
+      expected_webhook_event = Onfido::WebhookEvent.new({ payload: Onfido::WebhookEventPayload.build_from_hash(expected_payload) })
+      
+      webhook_event = subject.read_payload(event_body, sig)
+      expect(webhook_event.payload).to eq(expected_webhook_event.payload)
+      expect(webhook_event.payload.resource_type).to eq('check')
+      expect(webhook_event.payload.action).to eq('check.completed')
+      expect(webhook_event.payload.object.id).to eq('f2302f45-227d-413d-ad61-09ec077a086a')
+      expect(webhook_event.payload.object.status).to eq('complete')
+      expect(webhook_event.payload.object.completed_at_iso8601).to eq(Time.parse('2024-04-04T09:21:21Z'))
+      expect(webhook_event.payload.object.href).to eq('https://api.onfido.com/v3.6/checks/f2302f45-227d-413d-ad61-09ec077a086a')
+    end
+  end
+end