jamm 1.2.2 → 1.4.0

data/lib/jamm/api/api_client.rb

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-# #Jamm API
-#
-# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-#
-# The version of the OpenAPI document: 1.0
-#
-# Generated by: https://openapi-generator.tech
-# Generator version: 7.9.0
-#
+=begin
+#Jamm API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
 
 require 'date'
 require 'json'
@@ -17,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module Api
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -51,29 +52,33 @@ module Api
       tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
-      @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" if @config.debugging
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
 
       unless response.success?
         if response.timed_out?
-          raise ApiError, 'Connection timed out'
-        elsif response.code.zero?
+          fail ApiError.new('Connection timed out')
+        elsif response.code == 0
           # Errors from libcurl will be made visible here
-          raise ApiError.new(:code => 0,
-                             :message => response.return_message)
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
         else
-          raise ApiError.new(:code => response.code,
-                             :response_headers => response.headers,
-                             :response_body => response.body),
-                response.status_message
+          fail ApiError.new(:code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.status_message
         end
       end
 
-      data = if opts[:return_type] == 'File'
-               tempfile
-             elsif opts[:return_type]
-               deserialize(response, opts[:return_type])
-             end
-      [data, response.code, response.headers]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
+        data = deserialize(response, opts[:return_type])
+      else
+        data = nil
+      end
+      return data, response.code, response.headers
     end
 
     # Builds the HTTP request
@@ -94,6 +99,7 @@ module Api
       form_params = opts[:form_params] || {}
       follow_location = opts[:follow_location] || true
 
+
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
 
@@ -114,10 +120,12 @@ module Api
       # set custom cert, if provided
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
-      if %i[post patch put delete].include?(http_method)
+      if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
-        @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" if @config.debugging
+        if @config.debugging
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        end
       end
 
       Typhoeus::Request.new(url, req_opts)
@@ -132,16 +140,16 @@ module Api
     def build_request_body(header_params, form_params, body)
       # http form
       if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-         header_params['Content-Type'] == 'multipart/form-data'
+          header_params['Content-Type'] == 'multipart/form-data'
         data = {}
         form_params.each do |key, value|
-          data[key] = case value
-                      when ::File, ::Array, nil
-                        # let typhoeus handle File, Array and nil parameters
-                        value
-                      else
-                        value.to_s
-                      end
+          case value
+          when ::File, ::Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
         end
       elsif body
         data = body.is_a?(String) ? body : body.to_json
@@ -171,7 +179,7 @@ module Api
         else
           prefix = 'download-'
         end
-        prefix += '-' unless prefix.end_with?('-')
+        prefix = prefix + '-' unless prefix.end_with?('-')
         encoding = response.body.encoding
         tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
       end
@@ -181,13 +189,15 @@ module Api
       end
       # run the request to ensure the tempfile is created successfully before returning it
       request.run
-      raise ApiError, "Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}" unless tempfile
-
-      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`'
+      if tempfile
+        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`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
+      end
 
       tempfile
     end
@@ -201,7 +211,7 @@ module Api
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ %r{^Application/.*json(?!p)(;.*)?}i).nil?
+      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -218,14 +228,16 @@ module Api
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
-      raise "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
 
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
-        raise e unless %w[String Date Time].include?(return_type)
-
-        data = body
+        if %w(String Date Time).include?(return_type)
+          data = body
+        else
+          raise e
+        end
       end
 
       convert_to_type data, return_type
@@ -237,7 +249,6 @@ module Api
     # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
-
       case return_type
       when 'String'
         data.to_s
@@ -258,11 +269,11 @@ module Api
         data
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
-        sub_type = ::Regexp.last_match(1)
+        sub_type = $1
         data.map { |item| convert_to_type(item, sub_type) }
-      when /\AHash<String, (.+)>\z/
+      when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
-        sub_type = ::Regexp.last_match(1)
+        sub_type = $1
         {}.tap do |hash|
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
@@ -279,12 +290,12 @@ module Api
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.split(%r{[/\\]}).last
+      filename.split(/[\/\\]/).last
     end
 
     def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(%r{/+}, '/')
+      path = "/#{path}".gsub(/\/+/, '/')
       @config.base_url(opts[:operation]) + path
     end
 
@@ -297,11 +308,10 @@ module Api
       Array(auth_names).each do |auth_name|
         auth_setting = @config.auth_settings[auth_name]
         next unless auth_setting
-
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
         when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else raise ArgumentError, 'Authentication token must be in `query` or `header`'
+        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end
@@ -319,7 +329,6 @@ module Api
     # @return [String] the Accept header (e.g. application/json)
     def select_header_accept(accepts)
       return nil if accepts.nil? || accepts.empty?
-
       # use JSON when present, otherwise use all of the provided
       json_accept = accepts.find { |s| json_mime?(s) }
       json_accept || accepts.join(',')
@@ -331,7 +340,6 @@ module Api
     def select_header_content_type(content_types)
       # return nil by default
       return if content_types.nil? || content_types.empty?
-
       # use JSON when present, otherwise use the first one
       json_content_type = content_types.find { |s| json_mime?(s) }
       json_content_type || content_types.first
@@ -342,12 +350,12 @@ module Api
     # @return [String] JSON string representation of the object
     def object_to_http_body(model)
       return model if model.nil? || model.is_a?(String)
-
-      local_body = if model.is_a?(Array)
-                     model.map { |m| object_to_hash(m) }
-                   else
-                     object_to_hash(model)
-                   end
+      local_body = nil
+      if model.is_a?(Array)
+        local_body = model.map { |m| object_to_hash(m) }
+      else
+        local_body = object_to_hash(model)
+      end
       local_body.to_json
     end
 
@@ -378,7 +386,7 @@ module Api
         # return the array directly as typhoeus will handle it as expected
         param
       else
-        raise "unknown collection format: #{collection_format.inspect}"
+        fail "unknown collection format: #{collection_format.inspect}"
       end
     end
   end

data/lib/jamm/api/api_error.rb

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-# #Jamm API
-#
-# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-#
-# The version of the OpenAPI document: 1.0
-#
-# Generated by: https://openapi-generator.tech
-# Generator version: 7.9.0
-#
+=begin
+#Jamm API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
 
 module Api
   class ApiError < StandardError
@@ -42,11 +42,11 @@ module Api
     end
 
     def message
-      msg = if @message.nil?
-              'Error message: the server returns an error'
-            else
-              @message
-            end
+      if @message.nil?
+        msg = "Error message: the server returns an error"
+      else
+        msg = @message
+      end
 
       msg += "\nHTTP status code: #{code}" if code
       msg += "\nResponse headers: #{response_headers}" if response_headers

data/lib/jamm/api/configuration.rb

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-# #Jamm API
-#
-# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-#
-# The version of the OpenAPI document: 1.0
-#
-# Generated by: https://openapi-generator.tech
-# Generator version: 7.9.0
-#
+=begin
+#Jamm API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
 
 module Api
   class Configuration
@@ -151,7 +151,10 @@ module Api
     # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
-    attr_accessor :inject_format, :force_ending_format
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
 
     def initialize
       @scheme = 'http'
@@ -174,7 +177,7 @@ module Api
       @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
-      @logger = defined?(Rails) ? Rails.logger : Logger.new($stdout)
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
 
       yield(self) if block_given?
     end
@@ -190,29 +193,28 @@ module Api
 
     def scheme=(scheme)
       # remove :// from scheme
-      @scheme = scheme.sub(%r{://}, '')
+      @scheme = scheme.sub(/:\/\//, '')
     end
 
     def host=(host)
       # remove http(s):// and anything after a slash
-      @host = host.sub(%r{https?://}, '').split('/').first
+      @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(%r{/+}, '/')
+      @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(%r{/+}, '/')}".sub(%r{/+\z}, '') if ignore_operation_servers
-
-      if operation_server_settings.key?(operation)
+      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(%r{/+}, '/')}".sub(%r{/+\z}, '') : server_url(server_index, server_variables, nil)
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
       end
     end
 
@@ -231,32 +233,33 @@ module Api
     # 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")}"
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
     end
 
     # Returns Auth Settings hash for api client.
     def auth_settings
-      {}
+      {
+      }
     end
 
     # Returns an array of Server setting
     def server_settings
       [
         {
-          url: '',
-          description: 'No description provided'
+          url: "",
+          description: "No description provided",
         }
       ]
     end
 
     def operation_server_settings
-      {}
+      {
+      }
     end
 
     # Returns URL based on server settings
@@ -264,10 +267,12 @@ module Api
     # @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?
+      servers = server_settings if servers == nil
 
       # check array index out of bound
-      raise ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}" if index.nil? || index.negative? || index >= servers.size
+      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]
@@ -275,19 +280,22 @@ module Api
       return url unless server.key? :variables
 
       # go through variable and assign a value
-      server[:variables].each_key do |name|
+      server[:variables].each do |name, variable|
         if variables.key?(name)
-          raise ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}." unless !server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name])
-
-          url.gsub! "{#{name}}", variables[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}}", server[:variables][name][:default_value]
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
         end
       end
 
       url
     end
+
+
   end
 end