RubyGems - onfido - Versions diffs - 4.3.0 → 4.4.0 - Mend

onfido 4.3.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +5 -0
data/README.md +1 -1
data/lib/onfido/api_client.rb +1 -1
data/lib/onfido/models/task.rb +1 -1
data/lib/onfido/models/webhook_event_payload_resource.rb +1 -1
data/lib/onfido/models/webhook_event_resource_type.rb +3 -1
data/lib/onfido/models/webhook_event_type.rb +2 -1
data/lib/onfido/version.rb +1 -1
data/spec/media/studio_webhook_event_with_list_in_output.json +31 -0
data/spec/media/studio_webhook_event_with_object_in_output.json +264 -0
data/spec/studio_webhook_event_verifier_spec.rb +39 -0
metadata +22 -18

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a851838e4b60556d54bd1fbf71d53f2b8a1b163d96885d1c28d7c61f85bd0e51
-  data.tar.gz: 40eb5ef6d9be36de0342c24afaf7485879126471fe3505fedae8fe9aa31305de
+  metadata.gz: 3ad8d065a1432b0a9784b7e7abbc4232330b7473fc93295cee357f67472dc19d
+  data.tar.gz: '044988fa7351554b18584f22603922cf2b1f2f0fc35b48c7b398fa8f2e5bb26e'
 SHA512:
-  metadata.gz: d446fff108b5090493aa73017b958c76ad520cb734f43611eec05e947f7936ea4bcb02bf9f932598d26b3fd3bd0b85b50330a696560e19371a3fb69e531a7fb9
-  data.tar.gz: af4b4da542c2f8fa7da2af5f173d7cfde397f56d92708cf5405d6cabec77c54cbca38863549e1f62194ca8ecede384ff7ab44db0bdb7a06e430df56fac80ef54
+  metadata.gz: 035d43c3d89ef350ba28be90e9c395edcddc88cf06a063ee49eef0c2eb0d3e5e0c7e6d3da9eccfcc9db76cb580c9b1cd164f8e5e2418021797ebe22f217aabcb
+  data.tar.gz: 53cbebd670af14ba05ba595ce0af26fd7b973c6042dd072cd9a291163ba4d0e31ac3a9c32de82b902c8b950c4ea07cb5de0c3d734b628f7a48cc71b1702bea7b

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,10 @@
 # Changelog
+## v4.3.0 27th November 2024
+- Release based on Onfido OpenAPI spec version [v4.3.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.3.0):
+  - [CAT-1581] Revert "[CAT-1528] Fix barcode field in document properties object"
 ## v4.2.0 19th November 2024
 - Release based on Onfido OpenAPI spec version [v4.2.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.2.0):

data/README.md CHANGED Viewed

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

data/lib/onfido/api_client.rb CHANGED Viewed

@@ -34,7 +34,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/4.3.0"
+      @user_agent = "onfido-ruby/4.4.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/models/task.rb CHANGED Viewed

@@ -30,7 +30,7 @@ module Onfido
     # Input object with the fields used by the Task to execute.
     attr_accessor :input
-    # Output object with the fields produced by the Task execution.
+    # Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
     attr_accessor :output
     # The date and time when the Task was created.

data/lib/onfido/models/webhook_event_payload_resource.rb CHANGED Viewed

@@ -48,7 +48,7 @@ module Onfido
     # Input object with the fields used by the Task execution.
     attr_accessor :input
-    # Output object with the fields produced by the Task execution.
+    # Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
     attr_accessor :output
     # The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.

data/lib/onfido/models/webhook_event_resource_type.rb CHANGED Viewed

@@ -21,10 +21,12 @@ module Onfido
     WORKFLOW_RUN = "workflow_run".freeze
     WORKFLOW_TASK = "workflow_task".freeze
     WATCHLIST_MONITOR = "watchlist_monitor".freeze
+    WORKFLOW_TIMELINE_FILE = "workflow_timeline_file".freeze
+    WORKFLOW_RUN_EVIDENCE_FOLDER = "workflow_run_evidence_folder".freeze
     UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
     def self.all_vars
-      @all_vars ||= [CHECK, REPORT, AUDIT_LOG, WORKFLOW_RUN, WORKFLOW_TASK, WATCHLIST_MONITOR, UNKNOWN_DEFAULT_OPEN_API].freeze
+      @all_vars ||= [CHECK, REPORT, AUDIT_LOG, WORKFLOW_RUN, WORKFLOW_TASK, WATCHLIST_MONITOR, WORKFLOW_TIMELINE_FILE, WORKFLOW_RUN_EVIDENCE_FOLDER, UNKNOWN_DEFAULT_OPEN_API].freeze
     end
     # Builds the enum from string

data/lib/onfido/models/webhook_event_type.rb CHANGED Viewed

@@ -32,10 +32,11 @@ module Onfido
     REPORT_COMPLETED = "report.completed".freeze
     WORKFLOW_TIMELINE_FILE_CREATED = "workflow_timeline_file.created".freeze
     WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED = "workflow_signed_evidence_file.created".freeze
+    WORKFLOW_RUN_EVIDENCE_FOLDER_CREATED = "workflow_run_evidence_folder.created".freeze
     UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
     def self.all_vars
-      @all_vars ||= [AUDIT_LOG_CREATED, WATCHLIST_MONITOR_MATCHES_UPDATED, WORKFLOW_RUN_COMPLETED, WORKFLOW_TASK_STARTED, WORKFLOW_TASK_COMPLETED, CHECK_STARTED, CHECK_REOPENED, CHECK_WITHDRAWN, CHECK_COMPLETED, CHECK_FORM_COMPLETED, REPORT_WITHDRAWN, REPORT_RESUMED, REPORT_CANCELLED, REPORT_AWAITING_APPROVAL, REPORT_COMPLETED, WORKFLOW_TIMELINE_FILE_CREATED, WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED, UNKNOWN_DEFAULT_OPEN_API].freeze
+      @all_vars ||= [AUDIT_LOG_CREATED, WATCHLIST_MONITOR_MATCHES_UPDATED, WORKFLOW_RUN_COMPLETED, WORKFLOW_TASK_STARTED, WORKFLOW_TASK_COMPLETED, CHECK_STARTED, CHECK_REOPENED, CHECK_WITHDRAWN, CHECK_COMPLETED, CHECK_FORM_COMPLETED, REPORT_WITHDRAWN, REPORT_RESUMED, REPORT_CANCELLED, REPORT_AWAITING_APPROVAL, REPORT_COMPLETED, WORKFLOW_TIMELINE_FILE_CREATED, WORKFLOW_SIGNED_EVIDENCE_FILE_CREATED, WORKFLOW_RUN_EVIDENCE_FOLDER_CREATED, UNKNOWN_DEFAULT_OPEN_API].freeze
     end
     # Builds the enum from string

data/lib/onfido/version.rb CHANGED Viewed

@@ -11,5 +11,5 @@ Generator version: 7.9.0
 =end
 module Onfido
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

data/spec/media/studio_webhook_event_with_list_in_output.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "payload": {
+    "resource_type": "workflow_task",
+    "action": "workflow_task.completed",
+    "object": {
+      "id": "document_photo_5c229",
+      "task_spec_id": "document_photo_5c229",
+      "task_def_id": "upload_document_photo",
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "status": "completed",
+      "completed_at_iso8601": "2024-12-18T18:13:10Z",
+      "href": "https://api.eu.onfido.com/v3.6/workflow_runs/b48fdff9-66a1-405d-9912-54780799bd68/tasks/document_photo_5c229"
+    },
+    "resource": {
+      "updated_at": "2024-12-18T18:13:10Z",
+      "output": [
+        {
+          "type": "document_photo",
+          "id": "7af75a3a-ba34-4aa5-9e3e-096c9f56256b",
+          "checksum_sha256": "hiwV2PLmeQZzeySPGGwVL48sxVXcyfpXy9LDl1u3lWU="
+        }
+      ],
+      "created_at": "2024-12-18T18:12:44Z",
+      "task_def_id": "upload_document_photo",
+      "input": {},
+      "workflow_run_id": "b48fdff9-66a1-405d-9912-54780799bd68",
+      "task_def_version": null,
+      "id": "document_photo_5c229"
+    }
+  }
+}

data/spec/media/studio_webhook_event_with_object_in_output.json ADDED Viewed

@@ -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/studio_webhook_event_verifier_spec.rb CHANGED Viewed

@@ -35,5 +35,44 @@ describe Onfido::WebhookEventVerifier do
       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 CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - OpenAPI-Generator
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -452,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
@@ -464,7 +466,7 @@ homepage: https://github.com/onfido/onfido-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -480,36 +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/report_schema_spec.rb
 - spec/integrations/sdk_token_spec.rb
-- spec/integrations/tasks_spec.rb
-- spec/integrations/motion_capture_spec.rb
+- spec/integrations/applicant_spec.rb
 - spec/integrations/workflow_run_spec.rb
-- spec/integrations/check_spec.rb
-- spec/integrations/live_video_spec.rb
-- spec/integrations/webhook_spec.rb
 - spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/address_picker_spec.rb
+- spec/integrations/webhook_spec.rb
 - spec/integrations/watchlist_monitor_spec.rb
-- spec/integrations/id_photo_spec.rb
-- spec/integrations/qualified_electronic_signature_spec.rb
-- spec/integrations/report_schema_spec.rb
-- spec/integrations/live_photo_spec.rb
-- spec/integrations/report_spec.rb
+- spec/integrations/live_video_spec.rb
 - spec/integrations/document_spec.rb
+- spec/integrations/live_photo_spec.rb
+- spec/integrations/qualified_electronic_signature_spec.rb
+- spec/integrations/motion_capture_spec.rb
+- spec/integrations/address_picker_spec.rb
+- spec/integrations/tasks_spec.rb
 - spec/integrations/media/sample_photo.png
 - spec/integrations/media/sample_driving_licence.png
+- spec/integrations/check_spec.rb
+- spec/integrations/id_photo_spec.rb
 - spec/integrations/extraction_spec.rb
+- spec/integrations/report_spec.rb
+- spec/media/studio_webhook_event_with_object_in_output.json
+- spec/media/studio_webhook_event_with_list_in_output.json
 - spec/shared_contexts/with_document.rb
 - spec/shared_contexts/with_check.rb
-- spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_workflow_run.rb
 - spec/shared_contexts/with_applicant.rb
+- spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_onfido.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb