Merge pull request #52 from onfido/release-upgrade

Refresh onfido-ruby after onfido-openapi-spec update (8e437b8)

.github/workflows/ruby.yml

@@ -1,35 +1,62 @@
-name: Ruby
+name: Ruby CI
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+  workflow_dispatch:
+  release:
+    types:
+      - published
 
 jobs:
-  test:
-
+  integration-tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run tests
-      if: ${{ matrix.ruby-version == '3.2' &&
-        github.repository_owner == 'onfido' &&
-        github.actor != 'dependabot[bot]' }}
-      run: bundle exec rspec spec
-      env:
-        ONFIDO_API_TOKEN: ${{ secrets.ONFIDO_API_TOKEN }}
-        ONFIDO_SAMPLE_APPLICANT_ID: ${{ secrets.ONFIDO_SAMPLE_APPLICANT_ID }}
-        ONFIDO_SAMPLE_VIDEO_ID_1: ${{ secrets.ONFIDO_SAMPLE_VIDEO_ID_1 }}
-        ONFIDO_SAMPLE_VIDEO_ID_2: ${{ secrets.ONFIDO_SAMPLE_VIDEO_ID_2 }}
-        ONFIDO_SAMPLE_MOTION_ID_1: ${{ secrets.ONFIDO_SAMPLE_MOTION_ID_1 }}
-        ONFIDO_SAMPLE_MOTION_ID_2: ${{ secrets.ONFIDO_SAMPLE_MOTION_ID_2 }}
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run integration tests
+        if: ${{ matrix.ruby-version == '3.2' &&
+          github.repository_owner == 'onfido' &&
+          github.actor != 'dependabot[bot]' }}
+        run: bundle exec rspec spec
+        env:
+          ONFIDO_API_TOKEN: ${{ secrets.ONFIDO_API_TOKEN }}
+          ONFIDO_SAMPLE_APPLICANT_ID: ${{ secrets.ONFIDO_SAMPLE_APPLICANT_ID }}
+          ONFIDO_SAMPLE_VIDEO_ID_1: ${{ secrets.ONFIDO_SAMPLE_VIDEO_ID_1 }}
+          ONFIDO_SAMPLE_VIDEO_ID_2: ${{ secrets.ONFIDO_SAMPLE_VIDEO_ID_2 }}
+          ONFIDO_SAMPLE_MOTION_ID_1: ${{ secrets.ONFIDO_SAMPLE_MOTION_ID_1 }}
+          ONFIDO_SAMPLE_MOTION_ID_2: ${{ secrets.ONFIDO_SAMPLE_MOTION_ID_2 }}
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: integration-tests
+    if: github.event_name == 'release'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

CHANGELOG.md

@@ -1,8 +1,9 @@
 # Changelog
 
-## v3.0.0 31th May 2024
+## v3.0.0 14th Jun 2024
 
 - Make library auto-generated and based on [Onfido OpenAPI spec](https://github.com/onfido/onfido-openapi-spec)
+- Refresh library up to commit: [8e437b8](https://github.com/onfido/onfido-openapi-spec/commit/8e437b8465e872cf8e4deb166499484a957da3f2)
 
 ## v2.9.0 24 November 2023
 

Gemfile

@@ -7,3 +7,5 @@ group :development, :test do
   gem 'pry-byebug'
   gem 'rubocop', '~> 0.66.0'
 end
+
+gem "faraday-follow_redirects", "~> 0.3.0"

lib/onfido.rb

@@ -232,6 +232,7 @@
 require 'onfido/models/sdk_token_response'
 require 'onfido/models/task'
 require 'onfido/models/task_item'
+require 'onfido/models/timeline_file_reference'
 require 'onfido/models/us_driving_licence_breakdown'
 require 'onfido/models/us_driving_licence_breakdown_address'
 require 'onfido/models/us_driving_licence_breakdown_address_breakdown'

lib/onfido/api/default_api.rb

@@ -298,6 +298,69 @@ def create_check_with_http_info(check_builder, opts = {})
       return data, status_code, headers
     end
 
+    # Create Timeline File for Workflow Run
+    # Triggers the generation of the Timeline File for the designated Workflow Run. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run.
+    # @param [Hash] opts the optional parameters
+    # @return [TimelineFileReference]
+    def create_timeline_file(workflow_run_id, opts = {})
+      data, _status_code, _headers = create_timeline_file_with_http_info(workflow_run_id, opts)
+      data
+    end
+
+    # Create Timeline File for Workflow Run
+    # Triggers the generation of the Timeline File for the designated Workflow Run. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TimelineFileReference, Integer, Hash)>] TimelineFileReference data, response status code and response headers
+    def create_timeline_file_with_http_info(workflow_run_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.create_timeline_file ...'
+      end
+      # verify the required parameter 'workflow_run_id' is set
+      if @api_client.config.client_side_validation && workflow_run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.create_timeline_file"
+      end
+      # resource path
+      local_var_path = '/workflow_runs/{workflow_run_id}/timeline_file'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TimelineFileReference'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.create_timeline_file",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#create_timeline_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create monitor
     # Creates a new monitor for the applicant 
     # @param watchlist_monitor_builder [WatchlistMonitorBuilder] 
@@ -1290,7 +1353,7 @@ def download_signed_evidence_file_with_http_info(workflow_run_id, opts = {})
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['binary/octet-stream', 'application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -2026,6 +2089,75 @@ def find_task_with_http_info(workflow_run_id, task_id, opts = {})
       return data, status_code, headers
     end
 
+    # Retrieve Timeline File for Workflow Run
+    # Retrieves the Timeline File for the designated Workflow Run. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run.
+    # @param timeline_file_id [String] The unique identifier for the Timefile File.
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def find_timeline_file(workflow_run_id, timeline_file_id, opts = {})
+      data, _status_code, _headers = find_timeline_file_with_http_info(workflow_run_id, timeline_file_id, opts)
+      data
+    end
+
+    # Retrieve Timeline File for Workflow Run
+    # Retrieves the Timeline File for the designated Workflow Run. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run.
+    # @param timeline_file_id [String] The unique identifier for the Timefile File.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def find_timeline_file_with_http_info(workflow_run_id, timeline_file_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.find_timeline_file ...'
+      end
+      # verify the required parameter 'workflow_run_id' is set
+      if @api_client.config.client_side_validation && workflow_run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.find_timeline_file"
+      end
+      # verify the required parameter 'timeline_file_id' is set
+      if @api_client.config.client_side_validation && timeline_file_id.nil?
+        fail ArgumentError, "Missing the required parameter 'timeline_file_id' when calling DefaultApi.find_timeline_file"
+      end
+      # resource path
+      local_var_path = '/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s)).sub('{' + 'timeline_file_id' + '}', CGI.escape(timeline_file_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.find_timeline_file",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#find_timeline_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve monitor
     # Retrieves a single monitor 
     # @param monitor_id [String] The watchlist monitor&#39;s unique identifier.

lib/onfido/configuration.rb

@@ -10,6 +10,8 @@
 
 =end
 
+require 'faraday/follow_redirects'
+
 module Onfido
   class Configuration
     REGIONS = {
@@ -180,6 +182,8 @@ def initialize
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
 
+      use( Faraday::FollowRedirects::Middleware ) 
+
       yield(self) if block_given?
     end