reacon-sdk 0.1.0.beta.4

data/lib/reacon-sdk/configuration.rb

@@ -0,0 +1,399 @@
+=begin
+#Reacon API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+module Reacon
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @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.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # Total JSON/CSV network deadline in seconds, including response body reads.
+    # Default to 30; must be finite and positive. Per-call: request_timeout.
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :ssl_verify
+
+    ### TLS/SSL setting
+    # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    attr_accessor :ssl_verify_mode
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    attr_accessor :ssl_ca_file
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :ssl_client_cert
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :ssl_client_key
+
+    ### Proxy setting
+    # HTTP Proxy settings
+    attr_accessor :proxy
+
+    # Set this to customize parameters encoder of array parameter.
+    # Default to nil. Faraday uses NestedParamsEncoder when nil.
+    #
+    # @see The params_encoder option of Faraday. Related source code:
+    # https://github.com/lostisland/faraday/tree/main/lib/faraday/encoders
+    attr_accessor :params_encoder
+
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.reacon.io'
+      @base_path = ''
+      @server_index = nil
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
+      @api_key = {}
+      @api_key_prefix = {}
+      @client_side_validation = true
+      @ssl_verify = true
+      @ssl_verify_mode = nil
+      @ssl_ca_file = nil
+      @ssl_client_cert = nil
+      @ssl_client_key = nil
+      @middlewares = Hash.new { |h, k| h[k] = [] }
+      @configure_connection_blocks = []
+      @timeout = 30
+      # return data as binary instead of file
+      @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)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    # 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])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{key}"
+      else
+        key
+      end
+    end
+
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'ApiKey' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-API-Key',
+            value: api_key_with_prefix('X-API-Key')
+          },
+        'McpIdentityToken' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+      }
+    end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "https://api.reacon.io",
+          description: "No description provided",
+        }
+      ]
+    end
+
+    def operation_server_settings
+      {
+      }
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
+
+      # check array index out of bound
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      return url unless server.key? :variables
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
+
+    # Configure Faraday connection directly.
+    #
+    # ```
+    # c.configure_faraday_connection do |conn|
+    #   conn.use Faraday::HttpCache, shared_cache: false, logger: logger
+    #   conn.response :logger, nil, headers: true, bodies: true, log_level: :debug do |logger|
+    #     logger.filter(/(Authorization: )(.*)/, '\1[REDACTED]')
+    #   end
+    # end
+    #
+    # c.configure_faraday_connection do |conn|
+    #   conn.adapter :typhoeus
+    # end
+    # ```
+    #
+    # @param block [Proc] `#call`able object that takes one arg, the connection
+    def configure_faraday_connection(&block)
+      @configure_connection_blocks << block
+    end
+
+    def configure_connection(conn)
+      @configure_connection_blocks.each do |block|
+        block.call(conn)
+      end
+    end
+
+    # Adds middleware to the stack
+    def use(*middleware)
+      set_faraday_middleware(:use, *middleware)
+    end
+
+    # Adds request middleware to the stack
+    def request(*middleware)
+      set_faraday_middleware(:request, *middleware)
+    end
+
+    # Adds response middleware to the stack
+    def response(*middleware)
+      set_faraday_middleware(:response, *middleware)
+    end
+
+    # Adds Faraday middleware setting information to the stack
+    #
+    # @example Use the `set_faraday_middleware` method to set middleware information
+    #   config.set_faraday_middleware(:request, :retry, max: 3, methods: [:get, :post], retry_statuses: [503])
+    #   config.set_faraday_middleware(:response, :logger, nil, { bodies: true, log_level: :debug })
+    #   config.set_faraday_middleware(:use, Faraday::HttpCache, store: Rails.cache, shared_cache: false)
+    #   config.set_faraday_middleware(:insert, 0, FaradayMiddleware::FollowRedirects, { standards_compliant: true, limit: 1 })
+    #   config.set_faraday_middleware(:swap, 0, Faraday::Response::Logger)
+    #   config.set_faraday_middleware(:delete, Faraday::Multipart::Middleware)
+    #
+    # @see https://github.com/lostisland/faraday/blob/v2.3.0/lib/faraday/rack_builder.rb#L92-L143
+    def set_faraday_middleware(operation, key, *args, &block)
+      unless [:request, :response, :use, :insert, :insert_before, :insert_after, :swap, :delete].include?(operation)
+        fail ArgumentError, "Invalid faraday middleware operation #{operation}. Must be" \
+                            " :request, :response, :use, :insert, :insert_before, :insert_after, :swap or :delete."
+      end
+
+      @middlewares[operation] << [key, args, block]
+    end
+    ruby2_keywords(:set_faraday_middleware) if respond_to?(:ruby2_keywords, true)
+
+    # Set up middleware on the connection
+    def configure_middleware(connection)
+      return if @middlewares.empty?
+
+      [:request, :response, :use, :insert, :insert_before, :insert_after, :swap].each do |operation|
+        next unless @middlewares.key?(operation)
+
+        @middlewares[operation].each do |key, args, block|
+          connection.builder.send(operation, key, *args, &block)
+        end
+      end
+
+      if @middlewares.key?(:delete)
+        @middlewares[:delete].each do |key, _args, _block|
+          connection.builder.delete(key)
+        end
+      end
+    end
+
+  end
+end

data/lib/reacon-sdk/http_policy.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+# Copyright Reacon contributors. Licensed under Apache-2.0.
+require 'timeout'
+
+module Reacon
+  class RequestTimeoutError < StandardError
+    attr_reader :timeout
+    def initialize(timeout)
+      @timeout = timeout
+      super("Reacon request exceeded its #{timeout} second network deadline")
+    end
+  end
+  class TransportError < StandardError; end
+  class ResponseDecodeError < StandardError
+    attr_reader :response
+    def initialize(response)
+      @response = response
+      super('Reacon response does not match its declared format')
+    end
+    def status = response.status
+    def headers = response.headers
+    def body = response.body
+    def request_id = headers['x-request-id']
+  end
+
+  module HttpPolicy
+    # A separate exception prevents Faraday from mistaking the total deadline
+    # for one of its own phase timeouts. It is translated at the SDK boundary.
+    class DeadlineExceeded < Exception; end
+    private_constant :DeadlineExceeded
+
+    def self.seconds(value)
+      unless value.is_a?(Numeric) && value.real? && value.finite? && value.positive?
+        raise ArgumentError, 'request_timeout must be a finite positive number of seconds'
+      end
+      value.to_f
+    end
+
+    def self.request(seconds)
+      Timeout.timeout(seconds, DeadlineExceeded) { yield }
+    rescue DeadlineExceeded, Faraday::TimeoutError => cause
+      raise RequestTimeoutError.new(seconds), cause: cause
+    rescue Faraday::Error => cause
+      raise TransportError.new('Reacon network request failed'), cause: cause
+    end
+
+    def self.parse_error(body)
+      JSON.parse(body)
+    rescue JSON::ParserError, TypeError
+      body
+    end
+
+    # Generated scalar conversion otherwise turns malformed numbers into 0,
+    # or arbitrary JSON strings into booleans. Validate before coercion.
+    def self.check_value(type, value)
+      return if value.nil?
+      valid = case type.to_s
+              when 'Integer' then value.is_a?(Integer)
+              when 'Float' then value.is_a?(Numeric)
+              when 'Boolean' then value == true || value == false
+              when 'Object' then true
+              when 'String', 'Date', 'Time' then value.is_a?(String) || value.is_a?(Symbol)
+              when /\AArray</ then value.is_a?(Array)
+              when /\AHash</ then value.is_a?(Hash)
+              else
+                model = Reacon.const_get(type.to_s, false)
+                !model.respond_to?(:attribute_map) || value.is_a?(Hash)
+              end
+      raise TypeError, "Expected #{type} in JSON response" unless valid
+      case type.to_s
+      when /\AArray<(.+)>\z/
+        inner = Regexp.last_match(1)
+        value.each { |item| check_value(inner, item) }
+      when /\AHash<String, (.+)>\z/
+        inner = Regexp.last_match(1)
+        value.each_value { |item| check_value(inner, item) }
+      else
+        if defined?(model) && model&.respond_to?(:attribute_map)
+          model.attribute_map.each do |field, wire|
+            key = value.key?(wire) ? wire : wire.to_s
+            check_value(model.openapi_types.fetch(field), value[key]) if value.key?(key)
+          end
+        end
+      end
+    end
+  end
+
+  module HttpApiError
+    attr_reader :response
+    def initialize(arg = nil)
+      super
+      @response = arg[:response] if arg.is_a?(Hash)
+    end
+    def status = code # Preserve the generated ApiError#code HTTP-status API.
+    def headers = response_headers
+    def body = response_body
+    def request_id = response_headers&.[]('x-request-id')
+    def parsed_body = HttpPolicy.parse_error(response_body)
+    def error_code
+      parsed = parsed_body
+      return unless parsed.is_a?(Hash)
+      value = parsed['code'] || (parsed['error'].is_a?(Hash) && parsed['error']['code'])
+      value if value.is_a?(String)
+    end
+  end
+
+  module HttpModelValues
+    def _deserialize(type, value)
+      HttpPolicy.check_value(type, value)
+      super
+    end
+  end
+
+  module HttpClientPolicy
+    def call_api(http_method, path, opts = {})
+      seconds = HttpPolicy.seconds(opts.fetch(:request_timeout, config.timeout))
+      stream = nil
+      response = HttpPolicy.request(seconds) do
+        connection(opts).public_send(http_method.to_sym.downcase) do |req|
+          request = build_request(http_method, path, req, opts)
+          request.options.timeout = seconds
+          stream = download_file(request) if %w[File Binary].include?(opts[:return_type])
+        end
+      end
+      unless response.success?
+        raise ApiError.new(code: response.status, message: "Reacon returned HTTP #{response.status}",
+                           response: response, response_headers: response.headers, response_body: response.body)
+      end
+      data = if %w[File Binary].include?(opts[:return_type])
+               deserialize_file(response, stream)
+             elsif opts[:return_type]
+               deserialize(response, opts[:return_type])
+             end
+      [data, response.status, response.headers]
+    end
+
+    def deserialize(response, return_type)
+      # No-content methods never call deserialize. An empty 200 for a declared
+      # JSON model is a protocol error, not an empty model or a successful nil.
+      if return_type != 'String' && (response.body.nil? || response.body.empty? || response.body.strip == 'null')
+        raise TypeError, 'Expected a JSON response body'
+      end
+      super
+    rescue StandardError => cause
+      raise ResponseDecodeError.new(response), cause: cause
+    end
+
+    def convert_to_type(data, type)
+      HttpPolicy.check_value(type, data)
+      super
+    end
+  end
+
+  ApiClient.prepend(HttpClientPolicy)
+  ApiError.prepend(HttpApiError)
+  ApiModelBase.singleton_class.prepend(HttpModelValues)
+end