onfido 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b50846731ee3d1258557cfbb22b8348d5328af3d2f8b0fba18548e37dc8963ea
-  data.tar.gz: efef5ee6be4f2f839764d11e1fb00f23d24e554b1e1c5bbb33ec127fbe603534
+  metadata.gz: 11bed99ce3f8728f3f344682bf2bd77fc5a24c02ee28fb0ba498e62b338ec0ba
+  data.tar.gz: 101c8c0b12326edc85a44f6ffdfa6803e25b88c01392d99715dae7d188cb8579
 SHA512:
-  metadata.gz: 7460854cfadcc65b683f1087130da5b23f46c3f1e9e4787b9aa5e82a5b8d394e3bea826fd085b70614d5d591e6ab78eff73365bd615ff8bc6e6e7f9f107d9680
-  data.tar.gz: 567a9d3e0e751d042022ea2a41691485a1deedddaf91131f3c599e5390638f0e5155c855f4d58a233a69d0e2f3acd072e0f040d0ff022d0fe326a36034c29192
+  metadata.gz: 0106e4ca114ac27bf511ac9b77544ec999b2eaf464811f6ecbda7e40a3e36dd9c458b5a498873c1051eff7bda2781b3f328681874c357c576f5ec727631f1b98
+  data.tar.gz: 65fcb7074155ef64bbbf581fa53f342607d17375e169703231d4353f7f59ea3c00693c64480aa1bc74cbc71d4b9ba9e891551b7be694e909c71cf4b98ee66516

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v5.1.0 14th May 2025
+
+- Release based on Onfido OpenAPI spec version [v5.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.1.0):
+  - CAT-1760: create get applicant consents endpoint
+  - Update Ruby library README template
+  - [CAT-1911] Fix document_with_driving_licence_information to be a list of objects
+  - [AF-1390] Fix: Device Intelligence Report Schema
+  - [CAT-1944] Add OAuth fields for Webhook authentication
+  - Fix storage of device_fingerprint_reuse breakdown and properties as float
+  - Add .markdownlint.json to templates
+
 ## v5.0.0 21st February 2025
 
 - Release based on Onfido OpenAPI spec version [v5.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.0.0):

data/README.md

@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem 'onfido', '~> 5.1.0'
+gem 'onfido', '~> 5.1.1'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):

data/lib/onfido/api_client.rb

@@ -35,7 +35,7 @@ module Onfido
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "onfido-ruby/5.1.0"
+      @user_agent = "onfido-ruby/5.1.1"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -175,7 +175,7 @@ module Onfido
 
       # reconstruct content
       content = stream.join
-      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
+      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'base64'  
       content = content.force_encoding(encoding)
 
       # return byte stream

data/lib/onfido/version.rb

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

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/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.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-14 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -463,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
@@ -518,5 +519,6 @@ test_files:
 - 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