Merge pull request #67 from onfido/release-upgrade

Refresh onfido-ruby after onfido-openapi-spec update (2998dd3)
onfido · Oct 23, 2024 · 6b5c12c · 6b5c12c
2 parents 9238f39 + 0529f50
commit 6b5c12c
Show file tree

Hide file tree

Showing 299 changed files with 438 additions and 392 deletions.
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-7.6.0
+7.9.0
diff --git a/.release.json b/.release.json
@@ -1,9 +1,9 @@
 {
   "source": {
     "repo_url": "https://github.com/onfido/onfido-openapi-spec",
-    "short_sha": "10f8380",
-    "long_sha": "10f83806efa080edbf022ac48d5eeac90fbceb0c",
-    "version": ""
+    "short_sha": "2998dd3",
+    "long_sha": "2998dd3ad2db49a33e0ecf9b41c7cf873909ef0b",
+    "version": "v4.0.0"
   },
-  "release": "v3.4.0"
+  "release": "v4.0.0"
 }
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -0,0 +1,30 @@
+# Migration Guide
+
+## Upgrading from 3.x to 4.x
+
+### Core Resources
+
+- Applicants
+  - Replace broken `ConsentsBuilder` object with a list of `ApplicantConsentBuilder` ones
+- Workflow Runs
+  - Rename `WorkflowRunSharedLink` object into `WorkflowRunLink`
+  - Define `WorkflowRunStatus` enum for storing status information
+  - Rename `WorkflowRunResponseError` object into `WorkflowRunError`
+- Documents
+  - Reuse already existent `DocumentTypes` enum when uploading documents
+
+### Other Endpoints
+
+- Webhooks
+  - Define `WebhookEventObjectStatus` enum to collect webhook event object's status
+  - Define `WebhookEventResourceType` enum to collect webhhok event resource's type
+  - Define `WebhookEventPayloadResource` object to store webhook payload's contents
+- Checks
+  - Define `CheckStatus` enum for accessing checks status
+- Reports
+  - Remove properties from `DeviceIntelligenceBreakdownPropertiesDevice` object: `true_os`, `os_anomaly`, `rooted` and `remote_software`
+  - Remove properties from `DeviceIntelligenceBreakdownPropertiesIp` object: `vpn_detection`, `proxy_detection` and `type`
+
+### OpenAPI generator
+
+- Version upgraded from 7.6.0 to 7.9.0
diff --git a/README.md b/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, '~> 3.4.0'
+gem onfido, '~> 4.0.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
@@ -86,7 +86,7 @@ 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.6.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 the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
 
 For contributions to the tests instead, please follow the steps below:
 

diff --git a/lib/onfido.rb b/lib/onfido.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/api/default_api.rb b/lib/onfido/api/default_api.rb
diff --git a/lib/onfido/api_client.rb b/lib/onfido/api_client.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -34,7 +34,7 @@ class ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "onfido-ruby/3.4.0"
+      @user_agent = "onfido-ruby/4.0.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -164,35 +164,41 @@ def download_file(request)
       request.options.on_data = Proc.new do |chunk, overall_received_bytes|
         stream << chunk
       end
+
       stream
     end
 
     def deserialize_file(response, stream)
-      body = response.body
-      if @config.return_binary_data == true
-        # return byte stream
-        encoding = body.encoding
-        stream.join.force_encoding(encoding)
+      body     = response.body
+      encoding = body.encoding
+
+      # reconstruct content
+      content = stream.join
+      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
+      content = content.force_encoding(encoding)
+
+      # return byte stream
+      return content if @config.return_binary_data == true
+
+      # return file instead of binary data
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition && content_disposition =~ /filename=/i
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        prefix = sanitize_filename(filename)
       else
-        # return file instead of binary data
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        tempfile.write(stream.join.force_encoding(encoding))
-        tempfile.close
-        config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
-        tempfile
+        prefix = 'download-'
       end
+      prefix = prefix + '-' unless prefix.end_with?('-')
+
+      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      tempfile.write(content)
+      tempfile.close
+
+      config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                          "explicitly with `tempfile.delete`"
+      tempfile
     end
 
     def connection(opts)

diff --git a/lib/onfido/api_error.rb b/lib/onfido/api_error.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/configuration.rb b/lib/onfido/configuration.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -87,6 +87,14 @@ class Configuration
     # @return [true, false]
     attr_accessor :debugging
 
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
     # Defines the logger used for debugging.
     # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
     #
@@ -178,6 +186,7 @@ def initialize
       @return_binary_data = false
       @params_encoder = nil
       @debugging = false
+      @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -214,6 +223,7 @@ def base_path=(base_path)
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
       if operation_server_settings.key?(operation) then
         index = server_operation_index.fetch(operation, server_index)
         server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])

diff --git a/lib/onfido/models/address.rb b/lib/onfido/models/address.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/address_builder.rb b/lib/onfido/models/address_builder.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/address_shared.rb b/lib/onfido/models/address_shared.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/addresses_list.rb b/lib/onfido/models/addresses_list.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant.rb b/lib/onfido/models/applicant.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_builder.rb b/lib/onfido/models/applicant_builder.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_consent_builder.rb b/lib/onfido/models/applicant_consent_builder.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_consent_name.rb b/lib/onfido/models/applicant_consent_name.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_create.rb b/lib/onfido/models/applicant_create.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_request.rb b/lib/onfido/models/applicant_request.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_response.rb b/lib/onfido/models/applicant_response.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_shared.rb b/lib/onfido/models/applicant_shared.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_update.rb b/lib/onfido/models/applicant_update.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicant_updater.rb b/lib/onfido/models/applicant_updater.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/applicants_list.rb b/lib/onfido/models/applicants_list.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/check.rb b/lib/onfido/models/check.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/check_builder.rb b/lib/onfido/models/check_builder.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/check_request.rb b/lib/onfido/models/check_request.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/check_response.rb b/lib/onfido/models/check_response.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/check_shared.rb b/lib/onfido/models/check_shared.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

diff --git a/lib/onfido/models/check_status.rb b/lib/onfido/models/check_status.rb
@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end