Generated version 0.22.1

This commit was automatically created by a GitHub Action to generate version 0.22.1 of this library.

Author: devexperience

.gitlab-ci.yml

@@ -0,0 +1,26 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v
+    - bundle config set --local deployment true
+    - bundle install -j $(nproc)
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby-$RUBY_VERSION'
+
+gem:
+  extends: .ruby
+  script:
+    - bundle exec rspec
+    - bundle exec rake build
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+

.openapi-generator/FILES

@@ -1,4 +1,5 @@
 .gitignore
+.gitlab-ci.yml
 .rspec
 Gemfile
 README.md

.openapi-generator/VERSION

@@ -1 +1 @@
-5.4.0
+7.0.1

lib/mx-platform-ruby.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+OpenAPI Generator version: 7.0.1
 
 =end
 

lib/mx-platform-ruby/api/mx_platform_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+OpenAPI Generator version: 7.0.1
 
 =end
 

lib/mx-platform-ruby/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+OpenAPI Generator version: 7.0.1
 
 =end
 
@@ -16,6 +16,7 @@
 require 'tempfile'
 require 'time'
 require 'faraday'
+require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
 
 module MxPlatformRuby
   class ApiClient
@@ -47,47 +48,31 @@ def self.default
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      ssl_options = {
-        :ca_file => @config.ssl_ca_file,
-        :verify => @config.ssl_verify,
-        :verify_mode => @config.ssl_verify_mode,
-        :client_cert => @config.ssl_client_cert,
-        :client_key => @config.ssl_client_key
-      }
-
-      connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
-        conn.request(:basic_auth, config.username, config.password)
-        @config.configure_middleware(conn)
-        if opts[:header_params]["Content-Type"] == "multipart/form-data"
-          conn.request :multipart
-          conn.request :url_encoded
-        end
-        conn.adapter(Faraday.default_adapter)
-      end
-
       begin
-        response = connection.public_send(http_method.to_sym.downcase) do |req|
+        response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
           build_request(http_method, path, req, opts)
         end
 
-        if @config.debugging
-          @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        if config.debugging
+          config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         end
 
         unless response.success?
-          if response.status == 0
+          if response.status == 0 && response.respond_to?(:return_message)
             # Errors from libcurl will be made visible here
-            fail ApiError.new(:code => 0,
-                              :message => response.return_message)
+            fail ApiError.new(code: 0,
+                              message: response.return_message)
           else
-            fail ApiError.new(:code => response.status,
-                              :response_headers => response.headers,
-                              :response_body => response.body),
+            fail ApiError.new(code: response.status,
+                              response_headers: response.headers,
+                              response_body: response.body),
                  response.reason_phrase
           end
         end
       rescue Faraday::TimeoutError
         fail ApiError.new('Connection timed out')
+      rescue Faraday::ConnectionFailed
+        fail ApiError.new('Connection failed')
       end
 
       if opts[:return_type]
@@ -106,7 +91,7 @@ def call_api(http_method, path, opts = {})
     # @option opts [Hash] :query_params Query parameters
     # @option opts [Hash] :form_params Query parameters
     # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
+    # @return [Faraday::Request] A Faraday Request
     def build_request(http_method, path, request, opts = {})
       url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
@@ -117,24 +102,22 @@ def build_request(http_method, path, request, opts = {})
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
-      req_opts = {
-        :params_encoding => @config.params_encoding,
-        :timeout => @config.timeout,
-        :verbose => @config.debugging
-      }
-
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
-        if @config.debugging
-          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        if config.debugging
+          config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
       request.headers = header_params
       request.body = req_body
-      request.options = OpenStruct.new(req_opts)
+
+      # Overload default options only if provided
+      request.options.params_encoder = config.params_encoder if config.params_encoder
+      request.options.timeout        = config.timeout        if config.timeout
+
       request.url url
       request.params = query_params
-      download_file(request) if opts[:return_type] == 'File'
+      download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
       request
     end
 
@@ -154,7 +137,7 @@ def build_request_body(header_params, form_params, body)
           case value
           when ::File, ::Tempfile
             # TODO hardcode to application/octet-stream, need better way to detect content type
-            data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+            data[key] = Faraday::FilePart.new(value.path, 'application/octet-stream', value.path)
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value
@@ -179,6 +162,51 @@ def download_file(request)
       end
     end
 
+    def connection(opts)
+      opts[:header_params]['Content-Type'] == 'multipart/form-data' ? connection_multipart : connection_regular
+    end
+
+    def connection_multipart
+      @connection_multipart ||= build_connection do |conn|
+        conn.request :multipart
+        conn.request :url_encoded
+      end
+    end
+
+    def connection_regular
+      @connection_regular ||= build_connection
+    end
+
+    def build_connection
+      Faraday.new(url: config.base_url, ssl: ssl_options, proxy: config.proxy) do |conn|
+        basic_auth(conn)
+        config.configure_middleware(conn)
+        yield(conn) if block_given?
+        conn.adapter(Faraday.default_adapter)
+        config.configure_connection(conn)
+      end
+    end
+
+    def ssl_options
+      {
+        ca_file: config.ssl_ca_file,
+        verify: config.ssl_verify,
+        verify_mode: config.ssl_verify_mode,
+        client_cert: config.ssl_client_cert,
+        client_key: config.ssl_client_key
+      }
+    end
+
+    def basic_auth(conn)
+      if config.username && config.password
+        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+          conn.request(:authorization, :basic, config.username, config.password)
+        else
+          conn.request(:basic_auth, config.username, config.password)
+        end
+      end
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -201,23 +229,30 @@ def deserialize(response, return_type)
       # handle file downloading - return the File instance processed in request callbacks
       # note that response body is empty when the file is written in chunks in request on_body callback
       if return_type == 'File'
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
+        if @config.return_binary_data == true
+          # return byte stream
+          encoding = body.encoding
+          return @stream.join.force_encoding(encoding)
         else
-          prefix = 'download-'
+          # 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`"
+          return @tempfile
         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`"
-        return @tempfile
       end
 
       return nil if body.nil? || body.empty?

lib/mx-platform-ruby/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+OpenAPI Generator version: 7.0.1
 
 =end
 
@@ -32,6 +32,7 @@ def initialize(arg = nil)
         end
       else
         super arg
+        @message = arg
       end
     end