wallee-ruby-sdk 5.2.0 → 6.0.0

data/Rakefile

@@ -1,14 +1,33 @@
+# Wallee AG Ruby SDK
+#
+# This library allows to interact with the Wallee AG payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://en.wallee.com
+# Developer email: ecosystem-team@wallee.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs = ["lib"]
-  t.warning = true
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
   t.verbose = true
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/**/*.rb']
   t.options = "-v --stop-on-failure"
 end
 
 
 task default: %w[test]
-
-

data/lib/wallee-ruby-sdk/api_client.rb

@@ -1,31 +1,35 @@
-=begin
-The wallee API allows an easy interaction with the wallee web service.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-=end
+# Wallee AG Ruby SDK
+#
+# This library allows to interact with the Wallee AG payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://en.wallee.com
+# Developer email: ecosystem-team@wallee.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
-require 'typhoeus'
-require 'addressable/uri'
 require 'base64'
+require 'jwt'
 require 'time'
-require 'openssl'
+require 'faraday'
+require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+require 'marcel'
 
-module Wallee
+module WalleeRubySdk
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
@@ -39,9 +43,9 @@ module Wallee
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Typhoeus"
+      @user_agent = "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36"
       @default_headers = {
-        'Content-Type' => "application/json",
+        'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
       }
       config.default_headers.each do |key, value|
@@ -55,37 +59,47 @@ module Wallee
 
     # Call an API with given options.
     #
-    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
+    # @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 = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+    def call_api(http_method, path, opts = {}, connection_timeout)
+      stream = nil
+      begin
+        Faraday::NestedParamsEncoder.sort_params = false
+        response = connection(opts).public_send(http_method) do |req|
+          request = build_request(http_method, path, req, opts, connection_timeout)
+          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
+        if config.debugging
+          config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        end
 
-      unless response.success?
-        if response.timed_out?
-          fail ApiError.new('Connection timed out')
-        elsif response.code == 0
-          # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
-        else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers.to_h,
-                            :response_body => response.body),
-               response.status_message
+        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)
+          else
+            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]
+      if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
+        data = deserialize_file(response, stream)
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
       end
-      return data, response.code, response.headers
+      return data, response.status, response.headers
     end
 
     # Builds the HTTP request
@@ -96,13 +110,13 @@ module Wallee
     # @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
-    def build_request(http_method, path, opts = {})
-      url = build_request_url(path)
+    # @return [Faraday::Request] A Faraday Request
+    def build_request(http_method, path, request, opts = {}, connection_timeout)
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       default_headers = {
-        'x-meta-sdk-version': "5.2.0",
+        'x-meta-sdk-version': "6.0.0",
         'x-meta-sdk-language': "ruby",
         'x-meta-sdk-provider': "wallee",
         'x-meta-sdk-language-version': RUBY_VERSION
@@ -110,75 +124,138 @@ module Wallee
 
       header_params = @default_headers.merge(opts[:header_params] || {})
       header_params = header_params.merge(default_headers)
-
+      
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
- 
-      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
-      _verify_ssl_host = true
+      bearer_token = get_authentication_headers(http_method, path, query_params)
+      header_params = header_params.merge({ "Authorization" => "Bearer #{bearer_token}" })
 
-      header_params  = header_params.merge(get_authentication_headers(http_method, path, query_params))
-      
-      timeout = opts[:timeout]
-
-      req_opts = {
-        :method => http_method,
-        :headers => header_params,
-        :params => query_params,
-        :params_encoding => @config.params_encoding,
-        :timeout => timeout,
-        :ssl_verifypeer => true,
-        :ssl_verifyhost => 2,
-        :sslcert => @config.cert_file,
-        :sslkey => @config.key_file,
-        :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"
+        end
+      end
+      request.headers = header_params
+      request.body = req_body
 
-      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+      # Overload default options only if provided
+      request.options.params_encoder = config.params_encoder if config.params_encoder
+      request.options.timeout        = connection_timeout    || config.timeout
 
-      # set custom cert, if provided
-      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+      request.url url
+      request.params = query_params
+      request
+    end
 
-      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
-        if @config.debugging
-          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
+        data = URI.encode_www_form(form_params)
+      elsif header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Tempfile
+            data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
+          when ::Array, nil
+            # let Faraday handle 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
+      else
+        data = nil
+      end
+      data
+    end
+
+    def download_file(request)
+      stream = []
+
+      # handle streaming Responses
+      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
+        stream << chunk
       end
 
-      Typhoeus::Request.new(url, req_opts)
+      stream
     end
-    
-
-    
-    # Returns the headers required for the HTTP authentication
-  	# @param [String] http_method HTTP method/verb (e.g. POST)
-    # @param [String] path URL path (e.g. /account/new) 
-    # @return [Hash] the authentication headers
-    def get_authentication_headers(http_method, path, query)
-      base_url = URI(@config.base_url)
-      completed_path = "#{base_url.path}#{path}"
-      completed_path += "?" + query.map{|k,v| "#{k}=#{v}"}.join('&') unless query.empty?
-      version = "1"
-      timestamp = Time.now.to_i
-      securedData = "#{version}|#{@config.user_id}|#{timestamp}|#{http_method.upcase}|#{completed_path}"
+
+    def deserialize_file(response, stream)
+      body     = response.body
+      encoding = body.encoding
+
+      # reconstruct content
+      content = stream.join
+      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
+      content = content.force_encoding(encoding)
+
+      # return byte stream
+      return content if @config.return_binary_data == true
+
+      # 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?('-')
+
+      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      tempfile.write(content)
+      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
+
+    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|
+        config.configure_middleware(conn)
+        yield(conn) if block_given?
+        conn.adapter(Faraday.default_adapter)
+        config.configure_connection(conn)
+      end
+    end
+
+    def ssl_options
       {
-        "x-mac-version":  version,
-        "x-mac-userid":  @config.user_id,
-        "x-mac-timestamp": timestamp,
-        "x-mac-value": calculate_hmac(securedData)
+        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 
-    
-    # Returns the calculated sha512 hmac for the given data
-    # @param [String] secured_data to hash
-    # @return [String] the calulated hmac
-    def calculate_hmac(secured_data)
-      decoded_secret = Base64.decode64(@config.authentication_key);
-      digest = OpenSSL::Digest.new('sha512')
-      Base64.strict_encode64(OpenSSL::HMAC.digest(digest, decoded_secret, secured_data)).strip;
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -190,22 +267,19 @@ module Wallee
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-       (mime == "*/*") || !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
+      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
     #
     # @param [Response] response HTTP response
-    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
-
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
@@ -215,7 +289,7 @@ module Wallee
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
+        if %w(String Date Time).include?(return_type)
           data = body
         else
           raise e
@@ -238,11 +312,11 @@ module Wallee
         data.to_i
       when 'Float'
         data.to_f
-      when 'BOOLEAN'
+      when 'Boolean'
         data == true
-      when 'DateTime'
+      when 'Time'
         # parse date time (expecting ISO 8601 format)
-        DateTime.parse data
+        Time.parse data
       when 'Date'
         # parse date time (expecting ISO 8601 format)
         Date.parse data
@@ -252,97 +326,64 @@ module Wallee
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map {|item| convert_to_type(item, sub_type) }
+        data.map { |item| convert_to_type(item, sub_type) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
         sub_type = $1
         {}.tap do |hash|
-          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models, e.g. Pet
-        Wallee.const_get(return_type).new.tap do |model|
-          model.build_from_hash data
-        end
+        # models (e.g. Pet) or oneOf
+        klass = WalleeRubySdk.const_get(return_type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end
 
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    #
-    # @see Configuration#temp_folder_path
-    # @return [Tempfile] the file downloaded
-    def download_file(response)
-      content_disposition = response.headers['Content-Disposition']
-      if content_disposition and content_disposition =~ /filename=/i
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        prefix = sanitize_filename(filename)
-      else
-        prefix = 'download-'
-      end
-      prefix = prefix + '-' unless prefix.end_with?('-')
-
-      tempfile = nil
-      encoding = response.body.encoding
-      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
-        file.write(response.body)
-        tempfile = file
-      end
-      @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
-
     # Sanitize filename by removing path.
     # e.g. ../../sun.gif becomes sun.gif
     #
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.split(/[\/\\]/).last
     end
 
-    def build_request_url(path)
+    def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-	  Addressable::URI.encode(@config.base_url + path)
-    end
-
-    # Builds the HTTP request body
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] form_params Query parameters
-    # @param [Object] body HTTP body (JSON/XML)
-    # @return [String] HTTP body data in the form of string
-    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'
-        data = {}
-        form_params.each do |key, value|
-          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
-      else
-        data = nil
-      end
-      data
+      @config.base_url(opts[:operation]) + path
     end
 
+    # Returns the bearer token required for the HTTP authentication
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @return [Hash{String => String}] A Bearer token as the value.
+    def get_authentication_headers(http_method, path, query_params)
+      base_url = URI(@config.base_url)
+      completed_path = "#{base_url.path}#{path}"
+      encoded_query_params = Faraday::NestedParamsEncoder.encode(query_params) unless query_params.empty?
+      uri = encoded_query_params ? "#{completed_path}?#{encoded_query_params}" : completed_path
+
+      payload = {
+        sub: @config.user_id.to_s,
+        iat: Time.now.to_i,
+        requestPath: uri,
+        requestMethod: http_method.upcase
+      }
 
+      decoded_secret = Base64.decode64(@config.authentication_key)
+      custom_headers = {
+        alg: 'HS256',
+        typ: 'JWT',
+        ver: 1,
+      }
+      JWT.encode(payload, decoded_secret, 'HS256', custom_headers)
+    end
 
     # Sets user agent in HTTP header
     #
-    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
+    # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
     def user_agent=(user_agent)
       @user_agent = user_agent
       @default_headers['User-Agent'] = @user_agent
@@ -350,23 +391,22 @@ module Wallee
 
     # Return Accept header based on an array of accepts provided.
     # @param [Array] accepts array for Accept
-    # @return [String] the Accept header (e.g. application/json)
+    # @return [String] the Accept header (e.g. application/json,text/plain)
     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) }
-      return json_accept || accepts.join(',')
+
+      accepts.join(',')
     end
 
     # Return Content-Type header based on an array of content types provided.
     # @param [Array] content_types array for Content-Type
     # @return [String] the Content-Type header  (e.g. application/json)
     def select_header_content_type(content_types)
-      # use application/json by default
-      return 'application/json' if content_types.nil? || content_types.empty?
+      # 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) }
-      return json_content_type || content_types.first
+      json_content_type || content_types.first
     end
 
     # Convert object (array, hash, object, etc) to JSON string.
@@ -376,7 +416,7 @@ module Wallee
       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) }
+        local_body = model.map { |m| object_to_hash(m) }
       else
         local_body = object_to_hash(model)
       end
@@ -407,17 +447,17 @@ module Wallee
       when :pipes
         param.join('|')
       when :multi
-        # return the array directly as typhoeus will handle it as expected
-        param
+        # return the array directly as Typhoeus will handle it as expected
+        # For Faraday we have to handle it
+        if param.is_a?(String)
+          return param
+        elsif param.is_a?(Array) && param.empty?
+          return nil
+        end
+        param.join(',')
       else
         fail "unknown collection format: #{collection_format.inspect}"
       end
     end
-    
-    # Return connection timeout.
-    # @return connection timeout
-    def get_connection_timeout()
-      return @config.timeout
-    end
   end
 end