Merge pull request #140 from CyberSource/feature/add-keep-alive-time

Feature/add keep alive time

Author: gaubansa

generator/cybersource-ruby-template/api_client.mustache

@@ -8,6 +8,7 @@ require 'logger'
 require 'tempfile'
 require 'typhoeus'
 require 'addressable/uri'
+require_relative 'ethon_extensions'
 
 module {{moduleName}}
   class ApiClient
@@ -144,7 +145,8 @@ module {{moduleName}}
         :sslcert => @config.cert_file,
         :sslkeypasswd => @merchantconfig.sslKeyPassword || "",
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :maxage_conn => @merchantconfig.keepAliveTime || 118 # Default to 118 seconds as same as default of libcurl
       }
 
       # set custom cert, if provided

lib/AuthenticationSDK/core/MerchantConfig.rb

@@ -44,6 +44,8 @@ def initialize(cybsPropertyObj)
     @log_config = LogConfiguration.new(cybsPropertyObj['logConfiguration'])
     # Custom Default Headers
     @defaultCustomHeaders = cybsPropertyObj['defaultCustomHeaders']
+    # Keep Alive Time for Connection Pooling
+    @keepAliveTime = cybsPropertyObj['keepAliveTime'] || 118 # Default to 118 seconds as same as default of libcurl
     # Path to client JWE pem file directory
     @pemFileDirectory = cybsPropertyObj['pemFileDirectory']
     @mleKeyAlias = cybsPropertyObj['mleKeyAlias']
@@ -56,6 +58,11 @@ def initialize(cybsPropertyObj)
 
     #fall back logic
     def validateMerchantDetails()
+      if !@keepAliveTime.is_a?(Integer)
+        err = StandardError.new(Constants::ERROR_PREFIX + "keepAliveTime must be an integer and in seconds")
+        raise err
+      end
+      
       logmessage = ''
       @log_config.validate(logmessage)
       @log_obj = Log.new @log_config, "MerchantConfig"
@@ -306,6 +313,7 @@ def logAllProperties(merchantPropertyObj)
     attr_accessor :keyFilename
     attr_accessor :useMetaKey
     attr_accessor :portfolioID
+    attr_accessor :keepAliveTime
     attr_accessor :enableClientCert
     attr_accessor :clientCertDirectory
     attr_accessor :sslClientCert

lib/cybersource_rest_client/api_client.rb

@@ -15,6 +15,7 @@
 require 'tempfile'
 require 'typhoeus'
 require 'addressable/uri'
+require_relative 'ethon_extensions'
 
 module CyberSource
   class ApiClient
@@ -148,7 +149,8 @@ def build_request(http_method, path, opts = {})
         :sslcert => @config.cert_file,
         :sslkeypasswd => @merchantconfig.sslKeyPassword || "",
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :maxage_conn => @merchantconfig.keepAliveTime || 118 # Default to 118 seconds as same as default of libcurl
       }
 
       # set custom cert, if provided

lib/cybersource_rest_client/ethon_extensions.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Extension to add CURLOPT_MAXAGE_CONN support to Ethon without modifying the gem
+# This file extends Ethon to add the maxage_conn option
+
+require 'ethon'
+
+# Now extend the Easy class to add the setter/getter methods
+# This follows the same pattern as other Ethon options
+module Ethon
+  class Easy
+    # Add the maxage_conn setter method - it will get call from set_attributes(options) from http actionable in ethon lib.
+    def maxage_conn=(value)
+      return if value.nil?
+      @maxage_conn = value.to_i
+      
+      # CURLOPT_MAXAGE_CONN = CURLOPTTYPE_LONG + 288
+      # CURLOPTTYPE_LONG = 0, so the option value is 0 + 288 = 288
+      curl_option = 288
+      # Call curl directly using Ethon::Curl.easy_setopt
+      Ethon::Curl.easy_setopt(@handle, curl_option, :long, @maxage_conn)
+    end
+    
+    # Add the maxage_conn getter method
+    def maxage_conn
+      @maxage_conn
+    end
+    
+    # Add alias methods
+    def max_connection_age=(value)
+      self.maxage_conn = value
+    end
+    
+    def max_connection_age
+      @maxage_conn
+    end
+  end
+end