onfido 3.4.0 → 4.6.0

data/spec/media/studio_webhook_event_with_object_in_output.json

@@ -0,0 +1,264 @@
+{
+  "payload": {
+    "resource_type": "workflow_task",
+    "action": "workflow_task.completed",
+    "object": {
+      "id": "document_check_75329",
+      "task_spec_id": "document_check_75329",
+      "task_def_id": "document_check",
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "status": "completed",
+      "completed_at_iso8601": "2024-12-18T18:13:13Z",
+      "href": "https://api.eu.onfido.com/v3.6/workflow_runs/b48fdff9-66a1-405d-9912-54780799bd68/tasks/document_check_75329"
+    },
+    "resource": {
+      "task_def_version": null,
+      "task_def_id": "document_check",
+      "updated_at": "2024-12-18T18:13:13Z",
+      "id": "document_check_75329",
+      "output": {
+        "status": "complete",
+        "result": "clear",
+        "sub_result": "clear",
+        "uuid": "95c8cc09-db72-42ff-85ef-ee6c82020a24",
+        "properties": {
+          "date_of_birth": "1990-01-01",
+          "date_of_expiry": "2031-05-28",
+          "document_numbers": [
+            {
+              "type": "document_number",
+              "value": "999999999"
+            }
+          ],
+          "document_type": "passport",
+          "first_name": "Jane",
+          "issuing_country": "GBR",
+          "last_name": "Doe",
+          "document_number": "999999999"
+        },
+        "breakdown": {
+          "data_validation": {
+            "result": "clear",
+            "breakdown": {
+              "mrz": {
+                "result": "clear",
+                "properties": {}
+              },
+              "expiry_date": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_expiration": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_numbers": {
+                "result": "clear",
+                "properties": {}
+              },
+              "date_of_birth": {
+                "result": "clear",
+                "properties": {}
+              },
+              "gender": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "visual_authenticity": {
+            "result": "clear",
+            "breakdown": {
+              "face_detection": {
+                "result": "clear",
+                "properties": {}
+              },
+              "other": {
+                "result": "clear",
+                "properties": {}
+              },
+              "digital_tampering": {
+                "result": "clear",
+                "properties": {}
+              },
+              "original_document_present": {
+                "result": "clear",
+                "properties": {}
+              },
+              "security_features": {
+                "result": "clear",
+                "properties": {}
+              },
+              "template": {
+                "result": "clear",
+                "properties": {}
+              },
+              "picture_face_integrity": {
+                "result": "clear",
+                "properties": {}
+              },
+              "fonts": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "compromised_document": {
+            "result": "clear",
+            "breakdown": {
+              "repeat_attempts": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_database": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "data_consistency": {
+            "result": "clear",
+            "breakdown": {
+              "nationality": {
+                "result": "clear",
+                "properties": {}
+              },
+              "last_name": {
+                "result": "clear",
+                "properties": {}
+              },
+              "first_name": {
+                "result": "clear",
+                "properties": {}
+              },
+              "multiple_data_sources_present": {
+                "result": "clear",
+                "properties": {}
+              },
+              "gender": {
+                "result": "clear",
+                "properties": {}
+              },
+              "date_of_birth": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_type": {
+                "result": "clear",
+                "properties": {}
+              },
+              "issuing_country": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_numbers": {
+                "result": "clear",
+                "properties": {}
+              },
+              "date_of_expiry": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "data_comparison": {
+            "result": "clear",
+            "breakdown": {
+              "date_of_birth": {
+                "result": "clear",
+                "properties": {}
+              },
+              "first_name": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_numbers": {
+                "result": "clear",
+                "properties": {}
+              },
+              "document_type": {
+                "result": "clear",
+                "properties": {}
+              },
+              "last_name": {
+                "result": "clear",
+                "properties": {}
+              },
+              "date_of_expiry": {
+                "result": "clear",
+                "properties": {}
+              },
+              "gender": {
+                "result": "clear",
+                "properties": {}
+              },
+              "issuing_country": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "image_integrity": {
+            "result": "clear",
+            "breakdown": {
+              "colour_picture": {
+                "result": "clear",
+                "properties": {}
+              },
+              "supported_document": {
+                "result": "clear",
+                "properties": {}
+              },
+              "conclusive_document_quality": {
+                "result": "clear",
+                "properties": {}
+              },
+              "image_quality": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "police_record": {
+            "result": "clear",
+            "breakdown": {
+              "document_has_not_been_recorded_as_lost,_stolen_or_compromised": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          },
+          "age_validation": {
+            "result": "clear",
+            "breakdown": {
+              "minimum_accepted_age": {
+                "result": "clear",
+                "properties": {}
+              }
+            }
+          }
+        },
+        "repeat_attempts": {
+          "report_id": "00000000-0000-0000-0000-000000000000",
+          "repeat_attempts": [],
+          "attempts_count": 1,
+          "attempts_clear_rate": 0,
+          "unique_mismatches_count": 0
+        }
+      },
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "input": {
+        "document_ids": [
+          {
+            "checksum_sha256": "hiwV2PLmeQZzeySPGGwVL48sxVXcyfpXy9LDl1u3lWU=",
+            "id": "7af75a3a-ba34-4aa5-9e3e-096c9f56256b",
+            "type": "document_photo"
+          }
+        ],
+        "first_name": "Jane",
+        "last_name": "Doe"
+      },
+      "created_at": "2024-12-18T18:13:11Z"
+    }
+  }
+}

data/spec/shared_contexts/with_check.rb

@@ -10,6 +10,7 @@ RSpec.shared_context 'with check', shared_context: :metadata do
       applicant_id: applicant_id,
       document_ids: [document_id],
       report_names: [Onfido::ReportName::DOCUMENT, Onfido::ReportName::IDENTITY_ENHANCED],
+      privacy_notices_read_consent_given: true
     })
   end
 

data/spec/shared_contexts/with_document.rb

@@ -8,6 +8,6 @@ RSpec.shared_context 'with document', shared_context: :metadata do
   let(:document_file_name) { 'sample_driving_licence.png' }
   let(:document_file) { File.open("spec/integrations/media/#{document_file_name}") }
 
-  let(:document) { onfido_api.upload_document('passport', applicant_id, document_file) }
+  let(:document) { onfido_api.upload_document(Onfido::DocumentTypes::PASSPORT, applicant_id, document_file) }
   let!(:document_id) { document.id }
 end

data/spec/spec_helper.rb

@@ -65,7 +65,7 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 end
 
-def repeat_request_until_status_changes(expected_status, max_retries = 10,
+def repeat_request_until_status_changes(expected_status, max_retries = 15,
   interval = 1, &proc)
   # expected_status --> desired status
   # max_retries     --> how many times to retry the request
@@ -86,7 +86,7 @@ def repeat_request_until_status_changes(expected_status, max_retries = 10,
   instance
 end
 
-def repeat_request_until_task_output_changes(max_retries = 10,
+def repeat_request_until_task_output_changes(max_retries = 15,
   interval = 1, &proc)
   # max_retries     --> how many times to retry the request
   # interval        --> how many seconds to wait until the next retry
@@ -106,7 +106,7 @@ def repeat_request_until_task_output_changes(max_retries = 10,
   instance
 end
 
-def repeat_request_unti_http_code_changes(max_retries = 10,
+def repeat_request_unti_http_code_changes(max_retries = 15,
   interval = 1, &proc)
   # max_retries        --> how many times to retry the request
   # interval           --> how many seconds to wait until the next retry

data/spec/studio_webhook_event_verifier_spec.rb

@@ -0,0 +1,78 @@
+require 'onfido/webhook_event_verifier'
+require 'spec_helper'
+
+describe Onfido::WebhookEventVerifier do
+  subject { described_class.new('YKOC6mkBxi6yK2zlUIrLMvsJMFEZObP5') }
+  describe "#read_payload" do
+    let(:event_body) { '{"payload":{"resource_type":"workflow_task","action":"workflow_task.started","object":{"id":"profile_1eb92","task_spec_id":"profile_1eb92","task_def_id":"profile_data","workflow_run_id":"bc77c6e5-753a-4580-96a6-aaed3e5a8d19","status":"started","started_at_iso8601":"2024-07-10T12:49:09Z","href":"https://api.eu.onfido.com/v3.6/workflow_runs/bc77c6e5-753a-4580-96a6-aaed3e5a8d19/tasks/profile_1eb92"},"resource":{"created_at":"2024-07-10T12:49:09Z","id":"profile_1eb92","workflow_run_id":"bc77c6e5-753a-4580-96a6-aaed3e5a8d19","updated_at":"2024-07-10T12:49:09Z","input":{},"task_def_version":null,"task_def_id":"profile_data","output":null}}}' }
+    let(:sig) { "c95a5b785484f6fa1bc25f381b5595d66bf85cb442eefb06aa007802ee6a4dfa" }
+    it "raises an exception when the signature is invalid" do
+      expect do
+        subject.read_payload(event_body, "c95a5b785484f6fa1bc25f381b5595d66bf85cb442eefb06aa007802ee6a4dfb")
+      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(Onfido::WebhookEventResourceType::WORKFLOW_TASK)
+      expect(webhook_event.payload.action).to eq(Onfido::WebhookEventType::WORKFLOW_TASK_STARTED)
+
+      expect(webhook_event.payload.object.id).to eq('profile_1eb92')
+      expect(webhook_event.payload.object.status).to eq(Onfido::WebhookEventObjectStatus::STARTED)
+      expect(webhook_event.payload.object.started_at_iso8601).to eq(Time.parse('2024-07-10T12:49:09Z'))
+      expect(webhook_event.payload.object.href).to eq('https://api.eu.onfido.com/v3.6/workflow_runs/bc77c6e5-753a-4580-96a6-aaed3e5a8d19/tasks/profile_1eb92')
+
+      expect(webhook_event.payload.resource.created_at).to eq(Time.parse('2024-07-10T12:49:09Z'))
+      expect(webhook_event.payload.resource.id).to eq('profile_1eb92')
+      expect(webhook_event.payload.resource.workflow_run_id).to eq('bc77c6e5-753a-4580-96a6-aaed3e5a8d19')
+      expect(webhook_event.payload.resource.updated_at).to eq(Time.parse('2024-07-10T12:49:09Z'))
+      expect(webhook_event.payload.resource.input).to eq({})
+      expect(webhook_event.payload.resource.task_def_version).to eq(nil)
+      expect(webhook_event.payload.resource.task_def_id).to eq('profile_data')
+      expect(webhook_event.payload.resource.output).to eq(nil)
+    end
+
+    context "when webhook event output is an object" do
+      it "is able to decode and read the output field" do
+        signature = "e3e5565647f5ccf07b2fd8ac22eab94a0a0619413d981fb768295c820523f7d7"
+
+        event = subject.read_payload(File.read('spec/media/studio_webhook_event_with_object_in_output.json'), signature)
+
+        expect(event.payload.resource.output['properties']).to eq({
+          "date_of_birth" => "1990-01-01",
+          "date_of_expiry" => "2031-05-28",
+          "document_number" => "999999999",
+          "document_numbers" => [
+            {
+              "type"=>"document_number",
+              "value"=>"999999999"
+            }
+          ],
+          "document_type" => "passport",
+          "first_name" => "Jane",
+          "issuing_country" => "GBR",
+          "last_name" => "Doe",
+        })
+      end
+    end
+
+    context "when webhook event output is an array" do
+      it "is able to decode and read the output field" do
+        signature = "f3a5170acfcecf8c1bf6d9cb9995c0d9dec941af83056a721530f8de7af2c293"
+        event = subject.read_payload(File.read('spec/media/studio_webhook_event_with_list_in_output.json'), signature)
+
+        expect(event.payload.resource.output).to eq([
+          {
+            "checksum_sha256"=>"hiwV2PLmeQZzeySPGGwVL48sxVXcyfpXy9LDl1u3lWU=",
+            "id"=>"7af75a3a-ba34-4aa5-9e3e-096c9f56256b",
+            "type"=>"document_photo"
+          }
+        ])
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.6.0
 platform: ruby
 authors:
 - OpenAPI-Generator
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +130,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- MIGRATION.md
 - README.md
 - Rakefile
 - lib/onfido.rb
@@ -143,6 +144,8 @@ files:
 - lib/onfido/models/addresses_list.rb
 - lib/onfido/models/applicant.rb
 - lib/onfido/models/applicant_builder.rb
+- lib/onfido/models/applicant_consent_builder.rb
+- lib/onfido/models/applicant_consent_name.rb
 - lib/onfido/models/applicant_create.rb
 - lib/onfido/models/applicant_request.rb
 - lib/onfido/models/applicant_response.rb
@@ -155,11 +158,10 @@ files:
 - lib/onfido/models/check_request.rb
 - lib/onfido/models/check_response.rb
 - lib/onfido/models/check_shared.rb
+- lib/onfido/models/check_status.rb
 - lib/onfido/models/checks_list.rb
 - lib/onfido/models/complete_task_builder.rb
 - lib/onfido/models/complete_task_data_builder.rb
-- lib/onfido/models/consent_item.rb
-- lib/onfido/models/consents_builder.rb
 - lib/onfido/models/country_codes.rb
 - lib/onfido/models/device_intelligence_breakdown.rb
 - lib/onfido/models/device_intelligence_breakdown_breakdown.rb
@@ -270,6 +272,8 @@ files:
 - lib/onfido/models/facial_similarity_photo_fully_auto_report.rb
 - lib/onfido/models/facial_similarity_photo_properties.rb
 - lib/onfido/models/facial_similarity_photo_report.rb
+- lib/onfido/models/facial_similarity_report_media.rb
+- lib/onfido/models/facial_similarity_report_shared.rb
 - lib/onfido/models/facial_similarity_video_breakdown.rb
 - lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb
 - lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb
@@ -403,8 +407,11 @@ files:
 - lib/onfido/models/webhook_builder.rb
 - lib/onfido/models/webhook_create.rb
 - lib/onfido/models/webhook_event.rb
+- lib/onfido/models/webhook_event_object_status.rb
 - lib/onfido/models/webhook_event_payload.rb
 - lib/onfido/models/webhook_event_payload_object.rb
+- lib/onfido/models/webhook_event_payload_resource.rb
+- lib/onfido/models/webhook_event_resource_type.rb
 - lib/onfido/models/webhook_event_type.rb
 - lib/onfido/models/webhook_resend.rb
 - lib/onfido/models/webhook_response.rb
@@ -415,14 +422,16 @@ files:
 - lib/onfido/models/webhooks_resend_item.rb
 - lib/onfido/models/workflow_run.rb
 - lib/onfido/models/workflow_run_builder.rb
+- lib/onfido/models/workflow_run_error.rb
+- lib/onfido/models/workflow_run_link.rb
 - lib/onfido/models/workflow_run_request.rb
 - lib/onfido/models/workflow_run_response.rb
-- lib/onfido/models/workflow_run_response_error.rb
 - lib/onfido/models/workflow_run_shared.rb
-- lib/onfido/models/workflow_run_shared_link.rb
+- lib/onfido/models/workflow_run_status.rb
 - lib/onfido/version.rb
 - lib/onfido/webhook_event_verifier.rb
 - onfido.gemspec
+- spec/classic_webhook_event_verifier_spec.rb
 - spec/integrations/address_picker_spec.rb
 - spec/integrations/applicant_spec.rb
 - spec/integrations/check_spec.rb
@@ -443,6 +452,8 @@ files:
 - spec/integrations/webhook_spec.rb
 - spec/integrations/workflow_run_output_spec.rb
 - spec/integrations/workflow_run_spec.rb
+- spec/media/studio_webhook_event_with_list_in_output.json
+- spec/media/studio_webhook_event_with_object_in_output.json
 - spec/shared_contexts/with_applicant.rb
 - spec/shared_contexts/with_check.rb
 - spec/shared_contexts/with_document.rb
@@ -450,12 +461,12 @@ files:
 - spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_workflow_run.rb
 - spec/spec_helper.rb
-- spec/webhook_event_verifier_spec.rb
+- spec/studio_webhook_event_verifier_spec.rb
 homepage: https://github.com/onfido/onfido-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -471,35 +482,38 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: The official Ruby library for integrating with the Onfido API.
 test_files:
+- spec/classic_webhook_event_verifier_spec.rb
+- spec/integrations/live_video_spec.rb
 - spec/integrations/document_spec.rb
+- spec/integrations/live_photo_spec.rb
+- spec/integrations/report_schema_spec.rb
 - spec/integrations/qualified_electronic_signature_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/check_spec.rb
-- spec/integrations/watchlist_monitor_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/media/sample_photo.png
-- spec/integrations/tasks_spec.rb
-- spec/integrations/live_video_spec.rb
 - spec/integrations/motion_capture_spec.rb
-- spec/integrations/sdk_token_spec.rb
+- spec/integrations/tasks_spec.rb
 - spec/integrations/workflow_run_spec.rb
-- spec/integrations/extraction_spec.rb
-- spec/integrations/address_picker_spec.rb
-- spec/integrations/id_photo_spec.rb
-- spec/integrations/report_schema_spec.rb
 - spec/integrations/webhook_spec.rb
-- spec/integrations/live_photo_spec.rb
 - spec/integrations/report_spec.rb
-- spec/shared_contexts/with_check.rb
+- spec/integrations/address_picker_spec.rb
+- spec/integrations/check_spec.rb
+- spec/integrations/sdk_token_spec.rb
+- spec/integrations/extraction_spec.rb
+- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/applicant_spec.rb
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/watchlist_monitor_spec.rb
+- spec/media/studio_webhook_event_with_list_in_output.json
+- spec/media/studio_webhook_event_with_object_in_output.json
+- spec/shared_contexts/with_workflow_run.rb
+- spec/shared_contexts/with_applicant.rb
 - spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_document.rb
+- spec/shared_contexts/with_check.rb
 - spec/shared_contexts/with_onfido.rb
-- spec/shared_contexts/with_workflow_run.rb
-- spec/shared_contexts/with_applicant.rb
 - spec/spec_helper.rb
-- spec/webhook_event_verifier_spec.rb
+- spec/studio_webhook_event_verifier_spec.rb