onfido 5.0.0 → 5.1.1

data/lib/onfido/models/webhook_updater.rb

@@ -27,6 +27,21 @@ module Onfido
     # Webhook version used to control the payload object when sending webhooks.
     attr_accessor :payload_version
 
+    # Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
+    attr_accessor :oauth_enabled
+
+    # The url to fetch the OAuth access token using client credentials grant.
+    attr_accessor :oauth_server_url
+
+    # The client id to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_id
+
+    # The client secret to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_secret
+
+    # The scopes to be sent when requesting the access token.
+    attr_accessor :oauth_server_scope
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
@@ -37,6 +52,11 @@ module Onfido
         :'events' => :'events',
         :'environments' => :'environments',
         :'payload_version' => :'payload_version',
+        :'oauth_enabled' => :'oauth_enabled',
+        :'oauth_server_url' => :'oauth_server_url',
+        :'oauth_server_client_id' => :'oauth_server_client_id',
+        :'oauth_server_client_secret' => :'oauth_server_client_secret',
+        :'oauth_server_scope' => :'oauth_server_scope',
         :'url' => :'url'
       }
     end
@@ -53,6 +73,11 @@ module Onfido
         :'events' => :'Array<WebhookEventType>',
         :'environments' => :'Array<String>',
         :'payload_version' => :'Integer',
+        :'oauth_enabled' => :'Boolean',
+        :'oauth_server_url' => :'String',
+        :'oauth_server_client_id' => :'String',
+        :'oauth_server_client_secret' => :'String',
+        :'oauth_server_scope' => :'String',
         :'url' => :'String'
       }
     end
@@ -106,6 +131,26 @@ module Onfido
         self.payload_version = attributes[:'payload_version']
       end
 
+      if attributes.key?(:'oauth_enabled')
+        self.oauth_enabled = attributes[:'oauth_enabled']
+      end
+
+      if attributes.key?(:'oauth_server_url')
+        self.oauth_server_url = attributes[:'oauth_server_url']
+      end
+
+      if attributes.key?(:'oauth_server_client_id')
+        self.oauth_server_client_id = attributes[:'oauth_server_client_id']
+      end
+
+      if attributes.key?(:'oauth_server_client_secret')
+        self.oauth_server_client_secret = attributes[:'oauth_server_client_secret']
+      end
+
+      if attributes.key?(:'oauth_server_scope')
+        self.oauth_server_scope = attributes[:'oauth_server_scope']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -135,6 +180,11 @@ module Onfido
           events == o.events &&
           environments == o.environments &&
           payload_version == o.payload_version &&
+          oauth_enabled == o.oauth_enabled &&
+          oauth_server_url == o.oauth_server_url &&
+          oauth_server_client_id == o.oauth_server_client_id &&
+          oauth_server_client_secret == o.oauth_server_client_secret &&
+          oauth_server_scope == o.oauth_server_scope &&
           url == o.url
     end
 
@@ -147,7 +197,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version, url].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope, url].hash
     end
 
     # Builds the object from hash

data/lib/onfido/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.11.0
 =end
 
 module Onfido
-  VERSION = '5.0.0'
+  VERSION = '5.1.1'
 end

data/lib/onfido.rb

@@ -23,6 +23,7 @@ require 'onfido/models/address_shared'
 require 'onfido/models/addresses_list'
 require 'onfido/models/applicant'
 require 'onfido/models/applicant_builder'
+require 'onfido/models/applicant_consent'
 require 'onfido/models/applicant_consent_builder'
 require 'onfido/models/applicant_consent_name'
 require 'onfido/models/applicant_create'
@@ -44,12 +45,13 @@ require 'onfido/models/complete_task_data_builder'
 require 'onfido/models/country_codes'
 require 'onfido/models/device_intelligence_breakdown'
 require 'onfido/models/device_intelligence_breakdown_breakdown'
-require 'onfido/models/device_intelligence_breakdown_breakdown_device'
-require 'onfido/models/device_intelligence_breakdown_breakdown_device_breakdown'
+require 'onfido/models/device_intelligence_breakdown_device'
+require 'onfido/models/device_intelligence_breakdown_device_breakdown'
 require 'onfido/models/device_intelligence_breakdown_properties'
 require 'onfido/models/device_intelligence_breakdown_properties_device'
 require 'onfido/models/device_intelligence_breakdown_properties_geolocation'
 require 'onfido/models/device_intelligence_breakdown_properties_ip'
+require 'onfido/models/device_intelligence_properties'
 require 'onfido/models/device_intelligence_report'
 require 'onfido/models/document'
 require 'onfido/models/document_breakdown'
@@ -95,7 +97,7 @@ require 'onfido/models/document_properties_address_lines'
 require 'onfido/models/document_properties_barcode_inner'
 require 'onfido/models/document_properties_document_classification'
 require 'onfido/models/document_properties_document_numbers_inner'
-require 'onfido/models/document_properties_driving_licence_information'
+require 'onfido/models/document_properties_driving_licence_information_item'
 require 'onfido/models/document_properties_extracted_data'
 require 'onfido/models/document_properties_nfc'
 require 'onfido/models/document_report'

data/spec/integrations/applicant_spec.rb

@@ -80,6 +80,34 @@ describe Onfido::Applicant do
       expect(updated_applicant.dob).to eq Date.parse('1968-04-08')
     end
 
+    it 'lists applicant consents' do
+      new_applicant_data = Onfido::ApplicantUpdater.new(
+        'consents' => [{
+                         'name' => Onfido::ApplicantConsentName::PRIVACY_NOTICES_READ,
+                         'granted' => true
+                       },
+                       {
+                         'name' => Onfido::ApplicantConsentName::SSN_VERIFICATION,
+                         'granted' => true
+                       },
+                       {
+                         'name' => Onfido::ApplicantConsentName::PHONE_NUMBER_VERIFICATION,
+                         'granted' => true
+                       }]
+      )
+      onfido_api.update_applicant(applicant_id, new_applicant_data)
+
+      expected_consents = [
+        have_attributes(name: "phone_number_verification", granted: true),
+        have_attributes(name: "privacy_notices_read", granted: true),
+        have_attributes(name: "ssn_verification", granted: true)
+      ]
+
+      consents = onfido_api.find_applicant_consents(applicant_id)
+      expect(consents).to contain_exactly(*expected_consents)
+
+    end
+
     it 'deletes an applicant' do
       onfido_api.delete_applicant(applicant_id)
 

data/spec/integrations/check_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_check'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::Check do
   describe 'Checks' do
@@ -74,10 +75,10 @@ describe Onfido::Check do
       onfido_api.resume_check(check_id)
     end
 
-    it 'downloads a check' do
-      file = onfido_api.download_check(check_id)
+    describe 'downloading a check' do
+      let(:file) { onfido_api.download_check(check_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PDF file"
     end
   end
 end

data/spec/integrations/document_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_document'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::Document do
   describe 'Documents' do
@@ -27,10 +28,10 @@ describe Onfido::Document do
       expect(get_document.id).to eq document_id
     end
 
-    it 'downloads a document' do
-      file = onfido_api.download_document(document_id)
+    describe 'downloading a document' do
+      let(:file) { onfido_api.download_document(document_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PNG file", 361771
     end
 
     it 'cannot download an inexistent document' do
@@ -41,10 +42,10 @@ describe Onfido::Document do
       }
     end
 
-    it 'downloads an NFC face' do
-      file = onfido_api.download_nfc_face(nfc_face_id)
+    describe 'downloading an NFC face' do
+      let(:file) { onfido_api.download_nfc_face(nfc_face_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PNG file", 471345
     end
 
     it 'cannot download an inexistent NFC face' do

data/spec/integrations/id_photo_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_applicant'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::IdPhoto do
   describe 'Id Photo' do
@@ -35,10 +36,10 @@ describe Onfido::IdPhoto do
       expect(get_id_photo.id).to eq id_photo_id
     end
 
-    it 'downloads id photo' do
-      file = onfido_api.download_id_photo(id_photo_id)
+    describe 'downloading id photo' do
+      let(:file) { onfido_api.download_id_photo(id_photo_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid PNG file", 395856
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent id photo' do

data/spec/integrations/live_photo_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_live_photo'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::LivePhoto do
   describe 'Live Photo' do
@@ -27,10 +28,10 @@ describe Onfido::LivePhoto do
       expect(live_photo).to be_an_instance_of Onfido::LivePhoto
     end
 
-    it 'downloads live photo' do
-      file = onfido_api.download_live_photo(live_photo_id)
+    describe 'downloading live photo' do
+      let(:file) { onfido_api.download_live_photo(live_photo_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid PNG file", 395856
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent live photo' do

data/spec/integrations/live_video_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_onfido'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::LiveVideo do
   describe 'Live Video' do
@@ -24,16 +25,16 @@ describe Onfido::LiveVideo do
       expect(get_live_video).to be_an_instance_of Onfido::LiveVideo
     end
 
-    it 'downloads live video' do
-      file = onfido_api.download_live_video(live_video_id)
+    describe 'downloading live video' do
+      let(:file) { onfido_api.download_live_video(live_video_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid MP4 file", 165093
     end
 
-    it 'downloads live video frame' do
-      file = onfido_api.download_live_video_frame(live_video_id)
+    describe 'downloading live video frame' do
+      let(:file) { onfido_api.download_live_video_frame(live_video_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid JPEG file", 1692
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent live video' do

data/spec/integrations/motion_capture_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_onfido'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::MotionCapture do
   describe 'Motion Capture' do
@@ -24,16 +25,16 @@ describe Onfido::MotionCapture do
       expect(get_motion_capture).to be_an_instance_of Onfido::MotionCapture
     end
 
-    it 'downloads motion capture' do
-      file = onfido_api.download_motion_capture(motion_id)
+    describe 'downloading live video' do
+      let(:file) { onfido_api.download_motion_capture(motion_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid MP4 file", 2720276
     end
 
-    it 'downloads motion capture frame' do
-      file = onfido_api.download_motion_capture_frame(motion_id)
+    describe 'downloading live video frame' do
+      let(:file) { onfido_api.download_motion_capture_frame(motion_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid JPEG file", 75627
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent motion capture' do

data/spec/integrations/report_schema_spec.rb

@@ -58,5 +58,38 @@ describe Onfido::Report do
       expect(report.properties.barcode[0]).to be_an_instance_of Onfido::DocumentPropertiesBarcodeInner
       expect(report.properties.barcode[0].document_type).to eq("driving_licence")
     end
+
+    it 'schema of Document With Driving Lincence Information report is valid' do
+      report_id = onfido_api.create_check(
+        Onfido::CheckBuilder.new(
+          applicant_id: applicant_id,
+          document_ids: [document_id],
+          report_names: [Onfido::ReportName::DOCUMENT_WITH_DRIVING_LICENCE_INFORMATION],
+      )).report_ids[0]
+
+      report = repeat_request_until_status_changes(
+        Onfido::ReportStatus::COMPLETE
+      ) { onfido_api.find_report(report_id) }
+
+      expect(report).to be_an_instance_of Onfido::DocumentWithDrivingLicenceInformationReport
+      expect(report.properties.driving_licence_information).not_to be_nil
+    end
+
+    it 'schema of Device Intelligence report is valid' do
+      report_id = onfido_api.create_check(
+        Onfido::CheckBuilder.new(
+          applicant_id: applicant_id,
+          document_ids: [document_id],
+          report_names: [Onfido::ReportName::DEVICE_INTELLIGENCE],
+      )).report_ids[0]
+
+      report = repeat_request_until_status_changes(
+        Onfido::ReportStatus::COMPLETE
+      ) { onfido_api.find_report(report_id) }
+
+      expect(report).to be_an_instance_of Onfido::DeviceIntelligenceReport
+      expect(report.breakdown).not_to be_nil
+      expect(report.properties).not_to be_nil
+    end
   end
 end

data/spec/integrations/workflow_run_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_workflow_run'
+require_relative '../shared_examples/file_examples'
+
 require 'zip'
 
 describe Onfido::WorkflowRun do
@@ -47,10 +49,10 @@ describe Onfido::WorkflowRun do
       expect(get_workflow_run.id).to eq workflow_run_id
     end
 
-    it 'downloads evidence file' do
-      file = onfido_api.download_signed_evidence_file(workflow_run_id)
+    describe 'downloading evidence file' do
+      let(:file) { onfido_api.download_signed_evidence_file(workflow_run_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PDF file", 497605
     end
 
     context 'with start -> approved workflow' do
@@ -78,7 +80,7 @@ describe Onfido::WorkflowRun do
           onfido_api.find_timeline_file(workflow_run_id, timeline_file_id)
         end
 
-        expect(file.size).to be > 0
+        expect(file.size).to be > 100000
       end
 
       it 'downloads an evidence folder' do
@@ -87,7 +89,7 @@ describe Onfido::WorkflowRun do
         end
 
         Zip::File.open(file.path) do |zip|
-          expect(zip.entries.size).to be > 0
+          expect(zip.entries.size).to be > 1
         end
       end
     end

data/spec/shared_examples/file_examples.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for "a valid file" do |expected_size|
+  it "is not nil and has a size greater than 0" do
+    expect(file).not_to be_nil
+    expect(file.size).to be > 0
+  end
+
+  it "has the expected file size" do
+    expect(file.size).to equal expected_size if expected_size
+  end
+end
+
+RSpec.shared_examples_for "a file with signature" do |signature, offset, length|
+  it "has a valid signature" do
+    signature_to_check = String.new(signature, encoding: 'BINARY')
+
+    File.open(file.path, 'rb') do |file_handler|
+      file_handler.rewind
+      content = file_handler.read(offset + length)
+      expect(content[offset, length]).to eq(signature_to_check)
+    end
+  end
+end
+
+RSpec.shared_examples_for "a valid PNG file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "\x89PNG\r\n\x1A\n", 0, 8
+end
+
+RSpec.shared_examples_for "a valid PDF file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "%PDF-", 0, 5
+end
+
+RSpec.shared_examples_for "a valid JPEG file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "\xFF\xD8\xFF\xE0\x00\x10JF", 0, 8
+end
+
+RSpec.shared_examples_for "a valid MP4 file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "ftyp", 4, 4
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.1
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,6 +144,7 @@ files:
 - lib/onfido/models/addresses_list.rb
 - lib/onfido/models/applicant.rb
 - lib/onfido/models/applicant_builder.rb
+- lib/onfido/models/applicant_consent.rb
 - lib/onfido/models/applicant_consent_builder.rb
 - lib/onfido/models/applicant_consent_name.rb
 - lib/onfido/models/applicant_create.rb
@@ -165,12 +166,13 @@ files:
 - lib/onfido/models/country_codes.rb
 - lib/onfido/models/device_intelligence_breakdown.rb
 - lib/onfido/models/device_intelligence_breakdown_breakdown.rb
-- lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb
-- lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb
+- lib/onfido/models/device_intelligence_breakdown_device.rb
+- lib/onfido/models/device_intelligence_breakdown_device_breakdown.rb
 - lib/onfido/models/device_intelligence_breakdown_properties.rb
 - lib/onfido/models/device_intelligence_breakdown_properties_device.rb
 - lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb
 - lib/onfido/models/device_intelligence_breakdown_properties_ip.rb
+- lib/onfido/models/device_intelligence_properties.rb
 - lib/onfido/models/device_intelligence_report.rb
 - lib/onfido/models/document.rb
 - lib/onfido/models/document_breakdown.rb
@@ -216,7 +218,7 @@ files:
 - lib/onfido/models/document_properties_barcode_inner.rb
 - lib/onfido/models/document_properties_document_classification.rb
 - lib/onfido/models/document_properties_document_numbers_inner.rb
-- lib/onfido/models/document_properties_driving_licence_information.rb
+- lib/onfido/models/document_properties_driving_licence_information_item.rb
 - lib/onfido/models/document_properties_extracted_data.rb
 - lib/onfido/models/document_properties_nfc.rb
 - lib/onfido/models/document_report.rb
@@ -461,6 +463,7 @@ files:
 - spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_workflow_run.rb
+- spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb
 homepage: https://github.com/onfido/onfido-ruby
@@ -488,33 +491,34 @@ 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/sdk_token_spec.rb
-- spec/integrations/address_picker_spec.rb
-- spec/integrations/tasks_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/motion_capture_spec.rb
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/check_spec.rb
+- spec/integrations/live_photo_spec.rb
 - spec/integrations/watchlist_monitor_spec.rb
-- spec/integrations/report_schema_spec.rb
+- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/live_video_spec.rb
+- spec/integrations/document_spec.rb
+- spec/integrations/webhook_spec.rb
 - spec/integrations/applicant_spec.rb
+- spec/integrations/address_picker_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/integrations/qualified_electronic_signature_spec.rb
-- spec/integrations/motion_capture_spec.rb
+- spec/integrations/report_schema_spec.rb
+- spec/integrations/sdk_token_spec.rb
+- spec/integrations/tasks_spec.rb
 - spec/integrations/report_spec.rb
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/media/sample_photo.png
 - spec/integrations/extraction_spec.rb
-- spec/integrations/webhook_spec.rb
-- spec/integrations/check_spec.rb
-- spec/integrations/live_video_spec.rb
-- spec/integrations/id_photo_spec.rb
-- spec/integrations/workflow_run_spec.rb
-- spec/integrations/document_spec.rb
-- spec/integrations/live_photo_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_live_photo.rb
-- spec/shared_contexts/with_onfido.rb
+- spec/media/studio_webhook_event_with_list_in_output.json
 - spec/shared_contexts/with_applicant.rb
-- spec/shared_contexts/with_document.rb
-- spec/shared_contexts/with_workflow_run.rb
 - spec/shared_contexts/with_check.rb
+- spec/shared_contexts/with_workflow_run.rb
+- spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_live_photo.rb
+- spec/shared_contexts/with_document.rb
+- spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb