onfido 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845613bbd6b1c405918b78dfb34fafc8830394f9bba7cb0814baedcdb8fdabf2
-  data.tar.gz: 0c08e45e9909662f8ac95d9c2e5f89edaae9d8857353f700c6cc72b52969def5
+  metadata.gz: d96d6906170b9be6731106168f61d6da039f67f8f65e7202274ef3259e645172
+  data.tar.gz: daf83bf07548dcba4da864e17c03b768aaf86b4d68bce658c4b2164d30ad6407
 SHA512:
-  metadata.gz: 7e591ea9e0f915f4e9b9b57edec45d6cfb7aeb245b56f2a639bf580978c832390f0b0c199ca43f7d52e8daa6ad753647086237c657b5cc2ea24b1489cabb8d67
-  data.tar.gz: cb8f330edba0390745729eb7dd9f9acb583669e7e896d9fe9bab7d650d5f0dc0888fae33d35a450e3bc995cc9d407a0594a82aa9b828b7248473a306e3a552f3
+  metadata.gz: 05a2d8051fbffeed8e82da41ab88a118477baf3e6214f62fc1c8a5327979dea2fa29a73e4cf0909acb833fa41cb0e5adf8a11cb46a44d297bf3a4b9d51f14276
+  data.tar.gz: fa62c445cae9183851eff0acaa5efff06a9a76abce6e216516ad872ed75cdd01ff125098b42b8697212b8e212d06de9fa8c4eecda7b6d90d145a14c02124010c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v4.5.0 8th January 2025
+
+- Release based on Onfido OpenAPI spec version [v4.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.5.0):
+  - [STUDIO-4305] Add download evidence folder path
+
 ## v4.4.0 20th December 2024
 
 - Release based on Onfido OpenAPI spec version [v4.4.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.4.0):

data/README.md

@@ -2,7 +2,7 @@
 
 The official Ruby library for integrating with the Onfido API.
 
-Documentation can be found at <https://documentation.onfido.com>.
+Refer to the documentation at <https://documentation.onfido.com>.
 
 This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
 
@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem onfido, '~> 4.5.0'
+gem onfido, '~> 4.6.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
@@ -42,7 +42,7 @@ applicant = onfido_api.create_applicant(
 )
 ```
 
-Documentation and code examples can be found at https://documentation.onfido.com
+Documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Error Handling
 
@@ -65,7 +65,7 @@ end
 
 ### Webhook event verification
 
-Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
+Webhook events payload needs to be verified before it can be accessed. Verifying webhook payloads is crucial for security reasons, as it ensures that the payloads are indeed from Onfido and have not been tampered with. The library allows you to easily decode the payload and verify its signature before returning it as an object for user convenience:
 
 ```ruby
   require 'onfido/webhook_event_verifier'
@@ -86,37 +86,39 @@ Webhook events payload needs to be verified before it can be accessed. Library a
 
 ## Contributing
 
-This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.9.0); therefore, all contributions (except test files) should target the [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository. Please follow the contribution guidelines provided in the OpenAPI specification repository.
 
 For contributions to the tests instead, please follow the steps below:
 
-1. [Fork](https://github.com/onfido/onfido-ruby/fork) repository
+1. Fork the [repository](https://github.com/onfido/onfido-ruby/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Make your changes
-4. Commit your changes (`git commit -am 'Add some feature'`)
+4. Commit your changes (`git commit -am 'Add detailed description of the feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create a new Pull Request
 
 ## Versioning policy
 
-[Semantic Versioning](https://semver.org) policy is used for library versioning, following guidelines and limitations below:
+Versioning helps manage changes and ensures compatibility across different versions of the library.
 
-- MAJOR versions (x.0.0) might:
+[Semantic Versioning](https://semver.org) policy is used for library versioning, following the guidelines and limitations outlined below:
+
+- MAJOR versions (x.0.0) may:
   - target a new API version
   - include non-backward compatible change
-- MINOR versions (0.x.0) might:
+- MINOR versions (0.x.0) may:
   - add a new functionality, non-mandatory parameter or property
   - deprecate an old functionality
   - include non-backward compatible change to a functionality which is:
     - labelled as alpha or beta
     - completely broken and not usable
-- PATCH version (0.0.x) might:
+- PATCH version (0.0.x) will:
   - fix a bug
   - include backward compatible changes only
 
 ## More documentation
 
-More documentation and code examples can be found at <https://documentation.onfido.com>.
+Additional documentation and code examples can be found at <https://documentation.onfido.com>.
 
 ## Support
 

data/lib/onfido/api_client.rb

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

data/lib/onfido/models/id_number.rb

@@ -115,7 +115,7 @@ module Onfido
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
+      type_validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_license", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -123,7 +123,7 @@ module Onfido
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
+      validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_license", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/onfido/models/webhook_event_payload_resource.rb

@@ -60,6 +60,9 @@ module Onfido
     # Error object that details why a Workflow Run is in Error status.
     attr_accessor :error
 
+    # Customer-provided user identifier.
+    attr_accessor :customer_user_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -77,7 +80,8 @@ module Onfido
         :'output' => :'output',
         :'reasons' => :'reasons',
         :'link' => :'link',
-        :'error' => :'error'
+        :'error' => :'error',
+        :'customer_user_id' => :'customer_user_id'
       }
     end
 
@@ -103,7 +107,8 @@ module Onfido
         :'output' => :'Object',
         :'reasons' => :'Array<String>',
         :'link' => :'WorkflowRunLink',
-        :'error' => :'WorkflowRunError'
+        :'error' => :'WorkflowRunError',
+        :'customer_user_id' => :'String'
       }
     end
 
@@ -191,6 +196,10 @@ module Onfido
       if attributes.key?(:'error')
         self.error = attributes[:'error']
       end
+
+      if attributes.key?(:'customer_user_id')
+        self.customer_user_id = attributes[:'customer_user_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -203,6 +212,10 @@ module Onfido
         invalid_properties.push("invalid value for \"task_def_id\", must conform to the pattern #{pattern}.")
       end
 
+      if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
+        invalid_properties.push('invalid value for "customer_user_id", the character length must be smaller than or equal to 256.')
+      end
+
       invalid_properties
     end
 
@@ -211,6 +224,7 @@ module Onfido
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@task_def_id.nil? && @task_def_id !~ Regexp.new(/^[0-9a-z_-]+$/)
+      return false if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
       true
     end
 
@@ -229,6 +243,20 @@ module Onfido
       @task_def_id = task_def_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] customer_user_id Value to be assigned
+    def customer_user_id=(customer_user_id)
+      if customer_user_id.nil?
+        fail ArgumentError, 'customer_user_id cannot be nil'
+      end
+
+      if customer_user_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "customer_user_id", the character length must be smaller than or equal to 256.'
+      end
+
+      @customer_user_id = customer_user_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -248,7 +276,8 @@ module Onfido
           output == o.output &&
           reasons == o.reasons &&
           link == o.link &&
-          error == o.error
+          error == o.error &&
+          customer_user_id == o.customer_user_id
     end
 
     # @see the `==` method
@@ -260,7 +289,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, applicant_id, created_at, updated_at, dashboard_url, workflow_id, workflow_run_id, workflow_version_id, task_def_id, task_def_version, input, output, reasons, link, error].hash
+      [id, applicant_id, created_at, updated_at, dashboard_url, workflow_id, workflow_run_id, workflow_version_id, task_def_id, task_def_version, input, output, reasons, link, error, customer_user_id].hash
     end
 
     # Builds the object from hash

data/lib/onfido/version.rb

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

data/spec/integrations/report_spec.rb

@@ -23,13 +23,15 @@ describe Onfido::Report do
     end
 
     it 'finds a report' do
-      get_document_report = onfido_api.find_report(document_report_id)
+      get_document_report = repeat_request_until_status_changes(Onfido::ReportStatus::COMPLETE) {
+        onfido_api.find_report(document_report_id)
+      }
       get_identity_report = onfido_api.find_report(identity_report_id)
 
       expect(get_document_report).to be_an_instance_of Onfido::DocumentReport
       expect(get_document_report.id).to eq document_report_id
       expect(get_document_report.name).to eq Onfido::ReportName::DOCUMENT
-      expect(get_document_report.status).to eq Onfido::ReportStatus::AWAITING_DATA
+      expect(get_document_report.status).to eq Onfido::ReportStatus::COMPLETE
 
       expect(get_identity_report).to be_an_instance_of Onfido::IdentityEnhancedReport
       expect(get_identity_report.id).to eq identity_report_id

data/spec/integrations/workflow_run_spec.rb

@@ -82,7 +82,9 @@ describe Onfido::WorkflowRun do
       end
 
       it 'downloads an evidence folder' do
-        file = onfido_api.download_evidence_folder(workflow_run_id)
+        file = repeat_request_unti_http_code_changes do
+          onfido_api.download_evidence_folder(workflow_run_id)
+        end
 
         Zip::File.open(file.path) do |zip|
           expect(zip.entries.size).to be > 0

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -487,33 +487,33 @@ 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/applicant_spec.rb
-- spec/integrations/workflow_run_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/webhook_spec.rb
-- spec/integrations/watchlist_monitor_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/motion_capture_spec.rb
-- spec/integrations/address_picker_spec.rb
 - spec/integrations/tasks_spec.rb
+- spec/integrations/workflow_run_spec.rb
+- spec/integrations/webhook_spec.rb
+- spec/integrations/report_spec.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/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/integrations/watchlist_monitor_spec.rb
 - spec/media/studio_webhook_event_with_list_in_output.json
-- spec/shared_contexts/with_document.rb
-- spec/shared_contexts/with_check.rb
+- 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/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb