moneykit 0.0.2 → 0.0.5

data/lib/moneykit/api_client.rb

@@ -1,14 +1,12 @@
-=begin
-#MoneyKit 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
-OpenAPI Generator version: 6.5.0
-
-=end
+# #MoneyKit 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
+# OpenAPI Generator version: 7.1.0
+#
 
 require 'date'
 require 'json'
@@ -48,39 +46,39 @@ module MoneyKit
     # @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 = {})
+      stream = nil
       begin
         response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
           build_request(http_method, path, req, opts)
+          stream = download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
         end
 
-        if config.debugging
-          config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
-        end
+        config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" if config.debugging
 
         unless response.success?
           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)
+            raise ApiError.new(code: 0,
+                               message: response.return_message)
           else
-            fail ApiError.new(code: response.status,
-                              response_headers: response.headers,
-                              response_body: response.body),
-                 response.reason_phrase
+            raise 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')
+        raise ApiError, 'Connection timed out'
       rescue Faraday::ConnectionFailed
-        fail ApiError.new('Connection failed')
+        raise ApiError, 'Connection failed'
       end
 
-      if opts[:return_type]
-        data = deserialize(response, opts[:return_type])
-      else
-        data = nil
-      end
-      return data, response.status, response.headers
+      data = if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
+               deserialize_file(stream)
+             elsif opts[:return_type]
+               deserialize(response, opts[:return_type])
+             end
+      [data, response.status, response.headers]
     end
 
     # Builds the HTTP request
@@ -102,11 +100,9 @@ module MoneyKit
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
-      if [:post, :patch, :put, :delete].include?(http_method)
+      if %i[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"
-        end
+        config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" if config.debugging
       end
       request.headers = header_params
       request.body = req_body
@@ -117,7 +113,6 @@ module MoneyKit
 
       request.url url
       request.params = query_params
-      download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
       request
     end
 
@@ -134,16 +129,16 @@ module MoneyKit
       elsif header_params['Content-Type'] == 'multipart/form-data'
         data = {}
         form_params.each do |key, value|
-          case value
-          when ::File, ::Tempfile
-            # TODO hardcode to application/octet-stream, need better way to detect content type
-            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
-          else
-            data[key] = value.to_s
-          end
+          data[key] = case value
+                      when ::File, ::Tempfile
+                        # TODO: hardcode to application/octet-stream, need better way to detect content type
+                        Faraday::FilePart.new(value.path, 'application/octet-stream', value.path)
+                      when ::Array, nil
+                        # let Faraday handle Array and nil parameters
+                        value
+                      else
+                        value.to_s
+                      end
         end
       elsif body
         data = body.is_a?(String) ? body : body.to_json
@@ -154,11 +149,40 @@ module MoneyKit
     end
 
     def download_file(request)
-      @stream = []
+      stream = []
 
       # handle streaming Responses
-      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
-        @stream << chunk
+      request.options.on_data = proc 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)
+      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 += '-' 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
       end
     end
 
@@ -198,12 +222,12 @@ module MoneyKit
     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
+      return unless 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
 
@@ -216,7 +240,7 @@ module MoneyKit
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == '*/*') || !(mime =~ %r{Application/.*json(?!p)(;.*)?}i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -225,54 +249,22 @@ module MoneyKit
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # 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'
-        if @config.return_binary_data == true
-          # return byte stream
-          encoding = body.encoding
-          return @stream.join.force_encoding(encoding)
-        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`"
-          return @tempfile
-        end
-      end
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
-      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+      raise "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
 
       begin
-        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+        data = JSON.parse("[#{body}]", symbolize_names: true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date Time).include?(return_type)
-          data = body
-        else
-          raise e
-        end
+        raise e unless %w[String Date Time].include?(return_type)
+
+        data = body
       end
 
       convert_to_type data, return_type
@@ -284,6 +276,7 @@ module MoneyKit
     # @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
@@ -304,11 +297,11 @@ module MoneyKit
         data
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
-        sub_type = $1
+        sub_type = ::Regexp.last_match(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 = $1
+        sub_type = ::Regexp.last_match(1)
         {}.tap do |hash|
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
@@ -325,12 +318,12 @@ module MoneyKit
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.gsub(%r{.*[/\\]}, '')
     end
 
     def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
+      path = "/#{path}".gsub(%r{/+}, '/')
       @config.base_url(opts[:operation]) + path
     end
 
@@ -343,10 +336,11 @@ module MoneyKit
       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 fail ArgumentError, 'Authentication token must be in `query` or `header`'
+        else raise ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end
@@ -364,6 +358,7 @@ module MoneyKit
     # @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(',')
@@ -375,6 +370,7 @@ module MoneyKit
     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
@@ -385,12 +381,13 @@ module MoneyKit
     # @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 = 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 = if model.is_a?(Array)
+                     model.map { |m| object_to_hash(m) }
+                   else
+                     object_to_hash(model)
+                   end
       local_body.to_json
     end
 
@@ -421,7 +418,7 @@ module MoneyKit
         # return the array directly as typhoeus will handle it as expected
         param
       else
-        fail "unknown collection format: #{collection_format.inspect}"
+        raise "unknown collection format: #{collection_format.inspect}"
       end
     end
   end

data/lib/moneykit/api_error.rb

@@ -1,14 +1,12 @@
-=begin
-#MoneyKit 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
-OpenAPI Generator version: 6.5.0
-
-=end
+# #MoneyKit 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
+# OpenAPI Generator version: 7.1.0
+#
 
 module MoneyKit
   class ApiError < StandardError
@@ -42,11 +40,11 @@ module MoneyKit
     end
 
     def message
-      if @message.nil?
-        msg = "Error message: the server returns an error"
-      else
-        msg = @message
-      end
+      msg = if @message.nil?
+              'Error message: the server returns an error'
+            else
+              @message
+            end
 
       msg += "\nHTTP status code: #{code}" if code
       msg += "\nResponse headers: #{response_headers}" if response_headers

data/lib/moneykit/configuration.rb

@@ -1,14 +1,12 @@
-=begin
-#MoneyKit 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
-OpenAPI Generator version: 6.5.0
-
-=end
+# #MoneyKit 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
+# OpenAPI Generator version: 7.1.0
+#
 
 module MoneyKit
   class Configuration
@@ -142,16 +140,13 @@ module MoneyKit
     # https://github.com/lostisland/faraday/tree/main/lib/faraday/encoders
     attr_accessor :params_encoder
 
-
-    attr_accessor :inject_format
-
-    attr_accessor :force_ending_format
+    attr_accessor :inject_format, :force_ending_format
 
     def initialize
       @scheme = 'https'
-      @host = 'production.moneykit.com'
+      @host = 'api.moneykit.com'
       @base_path = ''
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -188,26 +183,34 @@ module MoneyKit
 
     def scheme=(scheme)
       # remove :// from scheme
-      @scheme = scheme.sub(/:\/\//, '')
+      @scheme = scheme.sub(%r{://}, '')
     end
 
     def host=(host)
       # remove http(s):// and anything after a slash
-      @host = host.sub(/https?:\/\//, '').split('/').first
+      @host = host.sub(%r{https?://}, '').split('/').first
     end
 
     def base_path=(base_path)
       # Add leading and trailing slashes to base_path
-      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = "/#{base_path}".gsub(%r{/+}, '/')
       @base_path = '' if @base_path == '/'
     end
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      if operation_server_settings.key?(operation)
+        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])
+      elsif server_index.nil?
+        "#{scheme}://#{[host, base_path].join('/').gsub(%r{/+}, '/')}".sub(%r{/+\z},
+                                                                           '')
+      else
+        server_url(
+          server_index, server_variables, nil
+        )
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -224,8 +227,9 @@ module MoneyKit
 
     # 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
+      return access_token if access_token_getter.nil?
+
+      access_token_getter.call
     end
 
     # Gets Basic Auth token string
@@ -243,27 +247,13 @@ module MoneyKit
             key: 'Authorization',
             value: "Bearer #{access_token_with_refresh}"
           },
-        'clientId' =>
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'Client-Id',
-            value: api_key_with_prefix('clientId')
-          },
-        'clientSecret' =>
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'Client-Secret',
-            value: api_key_with_prefix('clientSecret')
-          },
         'HTTPBasic' =>
           {
             type: 'basic',
             in: 'header',
             key: 'Authorization',
             value: basic_auth_token
-          },
+          }
       }
     end
 
@@ -271,19 +261,14 @@ module MoneyKit
     def server_settings
       [
         {
-          url: "https://production.moneykit.com",
-          description: "MoneyKit production environment (Live institution data)",
-        },
-        {
-          url: "https://sandbox.moneykit.com",
-          description: "MoneyKit sandbox environment (Unrestricted environment with fake institution data)",
+          url: 'https://api.moneykit.com',
+          description: 'No description provided'
         }
       ]
     end
 
     def operation_server_settings
-      {
-      }
+      {}
     end
 
     # Returns URL based on server settings
@@ -291,11 +276,12 @@ module MoneyKit
     # @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
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if index.nil? || index < 0 || index >= servers.size
+        raise ArgumentError,
+              "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]
@@ -304,16 +290,17 @@ module MoneyKit
       return url unless server.key? :variables
 
       # go through variable and assign a value
-      server[:variables].each do |name, variable|
+      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]
+          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]}."
+            raise 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]
+          url.gsub! '{' + name.to_s + '}', server[:variables][name][:default_value]
         end
       end
 
@@ -373,9 +360,9 @@ module MoneyKit
     #
     # @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."
+      unless %i[request response use insert insert_before insert_after swap delete].include?(operation)
+        raise 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]
@@ -386,7 +373,7 @@ module MoneyKit
     def configure_middleware(connection)
       return if @middlewares.empty?
 
-      [:request, :response, :use, :insert, :insert_before, :insert_after, :swap].each do |operation|
+      %i[request response use insert insert_before insert_after swap].each do |operation|
         next unless @middlewares.key?(operation)
 
         @middlewares[operation].each do |key, args, block|
@@ -394,10 +381,10 @@ module MoneyKit
         end
       end
 
-      if @middlewares.key?(:delete)
-        @middlewares[:delete].each do |key, _args, _block|
-          connection.builder.delete(key)
-        end
+      return unless @middlewares.key?(:delete)
+
+      @middlewares[:delete].each do |key, _args, _block|
+        connection.builder.delete(key)
       end
     end
   end