kount_complete 1.0.7 → 2.0.3

data/lib/kount/client.rb

@@ -1,125 +1,133 @@
-require 'kount/security_mash'
-require 'kount/cart'
-require 'kount/request'
-require 'kount/request/update'
-require 'kount/request/inquiry'
-require 'rest-client'
-require 'uri'
-require 'kount/utils/khash'
-
-# rubocop:disable Style/ClassVars
-module Kount
-  ##
-  # This class is where the primary interaction with
-  # the merchant integration will take place.
-  class Client
-    # Tells the RIS server to respond in JSON instead of key/value pairs
-    # This cannot be overridden.
-    RESPONSE_FORMAT = 'JSON'
-
-    # RIS Version. Can be overridden my merchant if required.
-    DEFAULT_VERSION = '0630'
-
-    # Default endpoint for production. Used by the DEFAULT_OPTIONS
-    ENDPOINT_PROD = 'https://risk.kount.net'
-
-    # Default endpoint for test. Used by the TEST_DEFAULT_OPTIONS
-    ENDPOINT_TEST = 'https://risk.test.kount.net'
-
-    # Default params for production
-    PROD_DEFAULT_OPTIONS = {
-      endpoint: ENDPOINT_PROD,
-      version: DEFAULT_VERSION,
-      is_test: false
-    }
-
-    # Default params for test if is_test is TRUE
-    TEST_DEFAULT_OPTIONS = {
-      endpoint: ENDPOINT_TEST,
-      version: DEFAULT_VERSION
-    }
-
-    # Initialize a client object
-    #
-    # Example usage
-    #    {:merchant_id => "123456", :key => "trhvihsrihsta7ftadk6edkre7y8..."}
-    #
-    # @param params [Hash] Hash with merchant_id, ksalt and key, plus any
-    # other optional params
-    def initialize(params = {})
-      @options = {}
-      if params[:is_test]
-        @options.merge!(TEST_DEFAULT_OPTIONS)
-      else
-        @options.merge!(PROD_DEFAULT_OPTIONS)
-      end
-      @options.merge!(params)
-    end
-
-    # Makes the call to the Kount RIS server
-    #
-    # @param request [Kount::Request] Kount inquiry or update object
-    # @return [Hash] RIS response formatted into a native hash
-    def get_response(request)
-      params = prepare_request_params(request)
-      response = {}
-      begin
-        response = RestClient::Resource.new(
-          endpoint,
-          verify_ssl: verify_ssl_option, timeout: 1).post params, x_kount_api_key: key
-        
-        JSON.parse(response)
-      rescue
-        # RIS errors do not come back as JSON, so just pass them along raw.
-        response
-      end
-    end
-
-    # Give the request object what it needs to know to process the params
-    # to send to RIS.
-    def prepare_request_params(request)
-      request.prepare_params(version, merchant_id, RESPONSE_FORMAT, ksalt)
-    end
-
-    # Kount Merchant ID
-    def merchant_id
-      @options[:merchant_id]
-    end
-
-    # RIS Interface Version
-    def version
-      @options[:version]
-    end
-
-    # RIS Endpoint URL
-    def endpoint
-      @options[:endpoint]
-    end
-
-    # Merchant API for RIS acess
-    def key
-      @options[:key]
-    end
-
-    # Secret Kount salt for KHASH
-    def ksalt
-      @options[:ksalt]
-    end
-
-    # Is test or production setting
-    def test?
-      @options[:is_test]
-    end
-
-    private
-
-    # Helper method to turn on/off the SSL cert verify based on is_test config
-    def verify_ssl_option
-      if test?
-        OpenSSL::SSL::VERIFY_NONE
-      else
-        OpenSSL::SSL::VERIFY_PEER
-      end
-    end
-  end
-end
+require 'kount/security_mash'
+require 'kount/cart'
+require 'kount/request'
+require 'kount/request/update'
+require 'kount/request/inquiry'
+require 'rest-client'
+require 'uri'
+require 'kount/utils/khash'
+
+
+module Kount
+  ##
+  # This class is where the primary interaction with
+  # the merchant integration will take place.
+  class Client
+    # Tells the RIS server to respond in JSON instead of key/value pairs
+    # This cannot be overridden.
+    RESPONSE_FORMAT = 'JSON'
+
+    # RIS Version. Can be overridden my merchant if required.
+    DEFAULT_VERSION = '0700'
+
+    # Default endpoint for production. Used by the DEFAULT_OPTIONS
+    ENDPOINT_PROD = 'https://risk.kount.net'
+
+    # Default endpoint for test. Used by the TEST_DEFAULT_OPTIONS
+    ENDPOINT_TEST = 'https://risk.test.kount.net'
+
+    # Default params for production
+    PROD_DEFAULT_OPTIONS = {
+      endpoint: ENDPOINT_PROD,
+      version: DEFAULT_VERSION,
+      is_test: false,
+      timeout: 10
+    }
+
+    # Default params for test if is_test is TRUE
+    TEST_DEFAULT_OPTIONS = {
+      endpoint: ENDPOINT_TEST,
+      version: DEFAULT_VERSION,
+      timeout: 10
+    }
+
+    # Initialize a client object
+    #
+    # Example usage
+    #    {:merchant_id => "123456", :key => "trhvihsrihsta7ftadk6edkre7y8..."}
+    #
+    # @param params [Hash] Hash with merchant_id, ksalt and key, plus any
+    # other optional params
+    def initialize(params = {})
+      @options = {}
+      if params[:is_test]
+        @options.merge!(TEST_DEFAULT_OPTIONS)
+      else
+        @options.merge!(PROD_DEFAULT_OPTIONS)
+      end
+      @options.merge!(params)
+    end
+
+    # Makes the call to the Kount RIS server
+    #
+    # @param request [Kount::Request] Kount inquiry or update object
+    # @return [Hash] RIS response formatted into a native hash
+    def get_response(request)
+      params = prepare_request_params(request)
+      response = {}
+      begin
+        response = RestClient::Resource.new(
+          endpoint,
+          verify_ssl: verify_ssl_option, timeout: timeout
+        ).post params, x_kount_api_key: key
+
+        JSON.parse(response)
+      rescue StandardError
+        # RIS errors do not come back as JSON, so just pass them along raw.
+        response
+      end
+    end
+
+    # Give the request object what it needs to know to process the params
+    # to send to RIS.
+    def prepare_request_params(request)
+      request.prepare_params(version, merchant_id, RESPONSE_FORMAT, ksalt)
+    end
+
+    # Kount Merchant ID
+    def merchant_id
+      @options[:merchant_id]
+    end
+
+    # RIS Interface Version
+    def version
+      @options[:version]
+    end
+
+    # RIS Endpoint URL
+    def endpoint
+      @options[:endpoint]
+    end
+
+    # Timeout settings
+    def timeout
+      @options[:timeout]
+    end
+
+    # Merchant API for RIS acess
+    def key
+      @options[:key]
+    end
+
+    # Secret Kount salt for KHASH
+    def ksalt
+      @options[:ksalt]
+    end
+
+    # Is test or production setting
+    def test?
+      @options[:is_test]
+    end
+
+    private
+
+    # Helper method to turn on/off the SSL cert verify based on is_test config
+    def verify_ssl_option
+      if test?
+        OpenSSL::SSL::VERIFY_NONE
+      else
+        OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+  end
+end

data/lib/kount/payment_types.rb

@@ -1,52 +1,52 @@
-module Kount
-  ##
-  # Convenience class to provide a list of PTYP values
-  class PaymentTypes
-    # Credit card (VISA, MasterCard, Amercian Express, etc)
-    CREDIT_CARD   = 'CARD'
-    #Generic Token
-    TOKEN   = 'TOKEN'
-    # PayPal
-    PAYPAL        = 'PYPL'
-    # Check
-    CHECK         = 'CHEK'
-    # Merchant issued gift card (not the ones with VISA/MC on them)
-    GIFT_CARD     = 'GIFT'
-    # Carte Bleue
-    CARTE_BLEUE   = 'CARTE_BLEUE'
-    # Sofort
-    SOFORT        = 'SOFORT'
-    # Elv
-    ELV           = 'ELV'
-    # Poli
-    POLI          = 'POLI'
-    # Neteller
-    NETELLER      = 'NETELLER'
-    # Giropay
-    GIROPAY       = 'GIROPAY'
-    # BPay
-    BPAY          = 'BPAY'
-    # Interac
-    INTERAC       = 'INTERAC'
-    # Apple Pay
-    APPLE_PAY     = 'APAY'
-    # Skrill
-    SKRILL        = 'SKRILL'
-    # Moneybooker (basically another name for Skrill)
-    MONEYBOOKERS  = 'SKRILL'
-    # Mercado Pago
-    MERCADO_PAGO  = 'MERCADE_PAGO'
-    # Bill Me Later
-    BILL_ME_LATER = 'BLML'
-    # Google Checkout
-    GOOGLE_CHECKOUT = 'GOOG'
-    # Green Dot Money Pack
-    GREEN_DOT_MONEY_PACK  =	'GDMP'
-    # Single Euro Payments Area
-    SINGLE_EURO_PAYMENTS_AREA	=	'SEPA'
-    # None
-    NONE          = 'NONE'
-    # Other
-    OTHER         = 'OTHER'
-  end
-end
+module Kount
+  ##
+  # Convenience class to provide a list of PTYP values
+  class PaymentTypes
+    # Credit card (VISA, MasterCard, Amercian Express, etc)
+    CREDIT_CARD   = 'CARD'
+    #Generic Token
+    TOKEN   = 'TOKEN'
+    # PayPal
+    PAYPAL        = 'PYPL'
+    # Check
+    CHECK         = 'CHEK'
+    # Merchant issued gift card (not the ones with VISA/MC on them)
+    GIFT_CARD     = 'GIFT'
+    # Carte Bleue
+    CARTE_BLEUE   = 'CARTE_BLEUE'
+    # Sofort
+    SOFORT        = 'SOFORT'
+    # Elv
+    ELV           = 'ELV'
+    # Poli
+    POLI          = 'POLI'
+    # Neteller
+    NETELLER      = 'NETELLER'
+    # Giropay
+    GIROPAY       = 'GIROPAY'
+    # BPay
+    BPAY          = 'BPAY'
+    # Interac
+    INTERAC       = 'INTERAC'
+    # Apple Pay
+    APPLE_PAY     = 'APAY'
+    # Skrill
+    SKRILL        = 'SKRILL'
+    # Moneybooker (basically another name for Skrill)
+    MONEYBOOKERS  = 'SKRILL'
+    # Mercado Pago
+    MERCADO_PAGO  = 'MERCADE_PAGO'
+    # Bill Me Later
+    BILL_ME_LATER = 'BLML'
+    # Google Checkout
+    GOOGLE_CHECKOUT = 'GOOG'
+    # Green Dot Money Pack
+    GREEN_DOT_MONEY_PACK  =	'GDMP'
+    # Single Euro Payments Area
+    SINGLE_EURO_PAYMENTS_AREA	=	'SEPA'
+    # None
+    NONE          = 'NONE'
+    # Other
+    OTHER         = 'OTHER'
+  end
+end

data/lib/kount/request.rb

@@ -1,41 +1,41 @@
-require 'kount/security_mash'
-module Kount
-  ##
-  # This class acts as an abstract class for each type of request.
-  class Request
-    attr_accessor :params
-
-    # Initialize a Request object
-    #
-    # Example usage
-    #    Not used directly. Use Inquiry or Update instead.
-    #
-    # @param initial_params [Hash] Initial params for request
-    def initialize(initial_params = {})
-      fail "Cannot directly instantiate a #{self.class}." if
-        self.class == Request
-      @params = initial_params
-    end
-
-    # Add params to the current request object
-    # @param hash [Hash] Hash of values to be added
-    def add_params(hash)
-      @params.merge!(hash)
-    end
-
-    # This method creates the final state of the params collection such that
-    # it can be sent to RIS. Items that are specific to either the Inquiry
-    # or Update calls are delegated to the prepare_params method in each
-    # respective class.
-    #
-    # @param version [String] RIS version
-    # @param merchant_id [String] Merchant ID
-    # @param response_format [String] Response format (JSON)
-    # @param _ksalt [String] Kount supplied secret salt for KHASH
-    def prepare_params(version, merchant_id, response_format, _ksalt = '')
-      # The KSALT is not used here, however, it is used in the corresponding
-      # subclass prepare_params methods.
-      params.merge!(VERS: version, MERC: merchant_id, FRMT: response_format)
-    end
-  end
-end
+require 'kount/security_mash'
+module Kount
+  ##
+  # This class acts as an abstract class for each type of request.
+  class Request
+    attr_accessor :params
+
+    # Initialize a Request object
+    #
+    # Example usage
+    #    Not used directly. Use Inquiry or Update instead.
+    #
+    # @param initial_params [Hash] Initial params for request
+    def initialize(initial_params = {})
+      raise "Cannot directly instantiate a #{self.class}." if
+        self.class == Request
+      @params = initial_params
+    end
+
+    # Add params to the current request object
+    # @param hash [Hash] Hash of values to be added
+    def add_params(hash)
+      @params.merge!(hash)
+    end
+
+    # This method creates the final state of the params collection such that
+    # it can be sent to RIS. Items that are specific to either the Inquiry
+    # or Update calls are delegated to the prepare_params method in each
+    # respective class.
+    #
+    # @param version [String] RIS version
+    # @param merchant_id [String] Merchant ID
+    # @param response_format [String] Response format (JSON)
+    # @param _ksalt [String] Kount supplied secret salt for KHASH
+    def prepare_params(version, merchant_id, response_format, _ksalt = '')
+      # The KSALT is not used here, however, it is used in the corresponding
+      # subclass prepare_params methods.
+      params.merge!(VERS: version, MERC: merchant_id, FRMT: response_format)
+    end
+  end
+end

data/lib/kount/request/inquiry.rb

@@ -1,90 +1,90 @@
-module Kount
-  ##
-  # This class extends the Request class.
-  class Inquiry < Request
-    attr_accessor :cart
-
-    # Initialize an Inquiry object
-    #
-    # Example usage
-    #    {:MACK => "Y", :AUTH => "A"}
-    #
-    # @param initial_params [Hash] Initial params for request
-    def initialize(initial_params = {})
-      super(initial_params)
-      @cart = Cart.new
-      # We want Request to default to MODE Q unless a different mode has
-      # been passed.
-      add_params(MODE: 'Q') unless initial_params.key?(:MODE)
-    end
-
-    # @param version [String] RIS version
-    # @param merchant_id [String] Merchant ID
-    # @param response_format [String] Response format (JSON)
-    # @param ksalt [String] Kount supplied secret salt for KHASH
-    def prepare_params(version, merchant_id, response_format, ksalt)
-      super(version, merchant_id, response_format, ksalt)
-      begin
-        params.merge! collect_cart_items
-        # The Kount::Request has no knowledge of the KSALT or merchant_id, both
-        # of which are needed for KHASH. Request form params have everything we
-        # need at this point to do the KHASH if needed.
-        fixup_payment_params(ksalt, merchant_id)
-      end
-      params
-    end
-
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def fixup_payment_params(ksalt, merchant_id)
-      ptok = params[:PTOK]
-      case params[:PTYP]
-      when 'CARD', 'TOKEN'
-        #ptok = Kount::SecurityMash.hash_credit_card(ptok, ksalt)
-        ptok = Kount::Khash.HashPaymentToken(ptok, ksalt)
-        params.merge!(PTOK: ptok, PENC: 'KHASH')
-      when 'GIFT', 'OTHER'
-        #ptok = Kount::SecurityMash.hash_gift_card(ptok, ksalt, merchant_id)
-        ptok = Kount::Khash.HashGiftCard(ptok, ksalt, merchant_id)
-        params.merge!(PTOK: ptok, PENC: 'KHASH')
-      when 'CHEK', 'OTHER'
-        ptok = Kount::Khash.HashCheckPayment(ptok, ksalt)
-        params.merge!(PTOK: ptok, PENC: 'KHASH')
-      when 'NONE'
-        params.merge!(PTOK: nil, PENC: nil)
-      else
-        params[:PENC] ||= 'NONE'
-      end
-    end
-
-    # Pulls the cart data into the request params hash
-    def collect_cart_items
-      {
-        PROD_TYPE: cart.get_item(:TYPE),
-        PROD_DESC: cart.get_item(:DESC),
-        PROD_ITEM: cart.get_item(:ITEM),
-        PROD_PRICE: cart.get_item(:PRICE),
-        PROD_QUANT: cart.get_item(:QUANT)
-      }
-    end
-
-    # Puts the cart object into the request for processing
-    # @param cart [Kount::Cart] Cart object
-    def add_cart(cart)
-      @cart = cart
-    end
-
-    # Add UDF to request
-    # @param name [String] UDF label name
-    # @param value [String] UDF value
-    def add_udf(name, value)
-      @params.merge!("UDF[#{name}]" => value)
-    end
-
-    # Convenience method to create the payment params
-    # @param type [String] Payment type
-    # @param token [String] Payment token
-    def add_payment(type, token = '')
-      add_params(PTYP: type, PTOK: token)
-    end
-  end
-end
+module Kount
+  ##
+  # This class extends the Request class.
+  class Inquiry < Request
+    attr_accessor :cart
+
+    # Initialize an Inquiry object
+    #
+    # Example usage
+    #    {:MACK => "Y", :AUTH => "A"}
+    #
+    # @param initial_params [Hash] Initial params for request
+    def initialize(initial_params = {})
+      super(initial_params)
+      @cart = Cart.new
+      # We want Request to default to MODE Q unless a different mode has
+      # been passed.
+      add_params(MODE: 'Q') unless initial_params.key?(:MODE)
+    end
+
+    # @param version [String] RIS version
+    # @param merchant_id [String] Merchant ID
+    # @param response_format [String] Response format (JSON)
+    # @param ksalt [String] Kount supplied secret salt for KHASH
+    def prepare_params(version, merchant_id, response_format, ksalt)
+      super(version, merchant_id, response_format, ksalt)
+      begin
+        params.merge! collect_cart_items
+        # The Kount::Request has no knowledge of the KSALT or merchant_id, both
+        # of which are needed for KHASH. Request form params have everything we
+        # need at this point to do the KHASH if needed.
+        fixup_payment_params(ksalt, merchant_id)
+      end
+      params
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def fixup_payment_params(ksalt, merchant_id)
+      ptok = params[:PTOK]
+      case params[:PTYP]
+      when 'CARD', 'TOKEN'
+        #ptok = Kount::SecurityMash.hash_credit_card(ptok, ksalt)
+        ptok = Kount::Khash.hash_payment_token(ptok, ksalt)
+        params.merge!(PTOK: ptok, PENC: 'KHASH')
+      when 'GIFT', 'OTHER'
+        #ptok = Kount::SecurityMash.hash_gift_card(ptok, ksalt, merchant_id)
+        ptok = Kount::Khash.hash_gift_card(ptok, ksalt, merchant_id)
+        params.merge!(PTOK: ptok, PENC: 'KHASH')
+      when 'CHEK', 'OTHER'
+        ptok = Kount::Khash.hash_check_payment(ptok, ksalt)
+        params.merge!(PTOK: ptok, PENC: 'KHASH')
+      when 'NONE'
+        params.merge!(PTOK: nil, PENC: nil)
+      else
+        params[:PENC] ||= 'NONE'
+      end
+    end
+
+    # Pulls the cart data into the request params hash
+    def collect_cart_items
+      {
+        PROD_TYPE: cart.get_item(:TYPE),
+        PROD_DESC: cart.get_item(:DESC),
+        PROD_ITEM: cart.get_item(:ITEM),
+        PROD_PRICE: cart.get_item(:PRICE),
+        PROD_QUANT: cart.get_item(:QUANT)
+      }
+    end
+
+    # Puts the cart object into the request for processing
+    # @param cart [Kount::Cart] Cart object
+    def add_cart(cart)
+      @cart = cart
+    end
+
+    # Add UDF to request
+    # @param name [String] UDF label name
+    # @param value [String] UDF value
+    def add_udf(name, value)
+      @params.merge!("UDF[#{name}]" => value)
+    end
+
+    # Convenience method to create the payment params
+    # @param type [String] Payment type
+    # @param token [String] Payment token
+    def add_payment(type, token = '')
+      add_params(PTYP: type, PTOK: token)
+    end
+  end
+end