kount_complete 2.0.0 → 2.0.5

data/lib/kount/request/inquiry.rb

@@ -1,90 +1,88 @@
-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
+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)
+      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)
+      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

data/lib/kount/request/update.rb

@@ -1,28 +1,28 @@
-module Kount
-  ##
-  # This class extends the Request class and is used in the
-  # process of sending updates to an existing transaction
-  # generated by a previous Inquiry request.
-  class Update < Request
-    # Initialize an Update object
-    #
-    # Example usage
-    #    {:MACK => "Y", :AUTH => "A"}
-    #
-    # @param initial_params [Hash] Initial params for request
-    def initialize(initial_params = {})
-      super(initial_params)
-      # Default to mode U unless mode X is explicitly set
-      add_params(MODE: 'U') unless initial_params[:MODE] == 'X'
-    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)
-      params
-    end
-  end
-end
+module Kount
+  ##
+  # This class extends the Request class and is used in the
+  # process of sending updates to an existing transaction
+  # generated by a previous Inquiry request.
+  class Update < Request
+    # Initialize an Update object
+    #
+    # Example usage
+    #    {:MACK => "Y", :AUTH => "A"}
+    #
+    # @param initial_params [Hash] Initial params for request
+    def initialize(initial_params = {})
+      super(initial_params)
+      # Default to mode U unless mode X is explicitly set
+      add_params(MODE: 'U') unless initial_params[:MODE] == 'X'
+    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)
+      params
+    end
+  end
+end

data/lib/kount/security_mash.rb

@@ -1,82 +1,82 @@
-require 'digest/sha1'
-module Kount
-  ##
-  # This class implements the Kount KHASH for cards and gift cards.
-  
-  class SecurityMash
-    # @param plain_text [String] String to be hashed
-    # @param ptyp [String] Payment type code: CARD, GIFT, or OTHER
-    # @return [String] KHASH version of string
-    def self.hash_token(plain_text, ptyp, ksalt, merchant_id = '')
-      if ptyp == 'CARD'
-        hash_credit_card(plain_text, ksalt)
-      else
-        hash_gift_card(plain_text, ksalt, merchant_id)
-      end
-    end
-
-    # Hash a credit card number.
-    # Preserves first six characters of the input so that hashed cards can be
-    # categorized by Bank Identification Number (BIN).
-    #
-    # Example usage:
-    #   hashed = Kount::SecurityMash.hash_credit_card("4111111111111111")
-    #     Expect: 411111WMS5YA6FUZA1KC
-    #   hashed = Kount::SecurityMash.hash_credit_card("5199185454061655")
-    #     Expect: 5199182NOQRXNKTTFL11
-    #   hashed = Kount::SecurityMash.hash_credit_card("4259344583883")
-    #     Expect: 425934FEXQI1QS6TH2O5
-    #
-    # @param plain_text [String] String to be hashed
-    # @return [String] KHASH version of string
-    def self.hash_credit_card(plain_text, ksalt)
-      return plain_text if khashed?(plain_text)
-      first_six = plain_text[0..5]
-      mashed = mash(plain_text, 14, ksalt)
-      "#{first_six}#{mashed}"
-    end
-
-    # Hash a gift card number.
-    # Use the six characters of the merchant id so that hashed cards can be
-    # unique across the entire domain.
-    #
-    # Example usage:
-    #   hashed = Kount::SecurityMash.hash_gift_card("123456", "3245876")
-    #     Expect: 1234569HXH32Y5NNJCGB
-
-    # @param plain_text [String] String to be hashed
-    # @return [String] KHASH version of string
-    def self.hash_gift_card(plain_text, ksalt, merchant_id)
-      mashed = mash(plain_text, 14, ksalt)
-      "#{merchant_id}#{mashed}"
-    end
-
-    # Compute a base64 hash of the provided data.
-    #
-    # @param data [String] Data to hash
-    # @param len [int] Length of hash to retain
-    # @return [String] Hashed data
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def self.mash(data, len, m)
-      a = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
-      r = Digest::SHA1.hexdigest("#{data}.#{m}")
-      c = ''
-      len = 17 if len > 17
-      limit = 2 * len
-      i = 0
-      while i < limit
-        c << a[r[i..i + 6].to_i(16) % 36]
-        i += 2
-      end
-      c
-    end
-
-    # end mash
-
-    # @param val [String] Token that may or may not be khashed
-    # @return [Boolean] True if token is already khashed
-    def self.khashed?(val)
-      true if val =~ /(\d{6}[A-Z0-9]{14})/
-    end
-  end # end KountSecurityMash
-end
+require 'digest/sha1'
+module Kount
+  ##
+  # This class implements the Kount KHASH for cards and gift cards.
+  
+  class SecurityMash
+    # @param plain_text [String] String to be hashed
+    # @param ptyp [String] Payment type code: CARD, GIFT, or OTHER
+    # @return [String] KHASH version of string
+    def self.hash_token(plain_text, ptyp, ksalt, merchant_id = '')
+      if ptyp == 'CARD'
+        hash_credit_card(plain_text, ksalt)
+      else
+        hash_gift_card(plain_text, ksalt, merchant_id)
+      end
+    end
+
+    # Hash a credit card number.
+    # Preserves first six characters of the input so that hashed cards can be
+    # categorized by Bank Identification Number (BIN).
+    #
+    # Example usage:
+    #   hashed = Kount::SecurityMash.hash_credit_card("4111111111111111")
+    #     Expect: 411111WMS5YA6FUZA1KC
+    #   hashed = Kount::SecurityMash.hash_credit_card("5199185454061655")
+    #     Expect: 5199182NOQRXNKTTFL11
+    #   hashed = Kount::SecurityMash.hash_credit_card("4259344583883")
+    #     Expect: 425934FEXQI1QS6TH2O5
+    #
+    # @param plain_text [String] String to be hashed
+    # @return [String] KHASH version of string
+    def self.hash_credit_card(plain_text, ksalt)
+      return plain_text if khashed?(plain_text)
+      first_six = plain_text[0..5]
+      mashed = mash(plain_text, 14, ksalt)
+      "#{first_six}#{mashed}"
+    end
+
+    # Hash a gift card number.
+    # Use the six characters of the merchant id so that hashed cards can be
+    # unique across the entire domain.
+    #
+    # Example usage:
+    #   hashed = Kount::SecurityMash.hash_gift_card("123456", "3245876")
+    #     Expect: 1234569HXH32Y5NNJCGB
+
+    # @param plain_text [String] String to be hashed
+    # @return [String] KHASH version of string
+    def self.hash_gift_card(plain_text, ksalt, merchant_id)
+      mashed = mash(plain_text, 14, ksalt)
+      "#{merchant_id}#{mashed}"
+    end
+
+    # Compute a base64 hash of the provided data.
+    #
+    # @param data [String] Data to hash
+    # @param len [int] Length of hash to retain
+    # @return [String] Hashed data
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def self.mash(data, len, m)
+      a = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+      r = Digest::SHA1.hexdigest("#{data}.#{m}")
+      c = ''
+      len = 17 if len > 17
+      limit = 2 * len
+      i = 0
+      while i < limit
+        c << a[r[i..i + 6].to_i(16) % 36]
+        i += 2
+      end
+      c
+    end
+
+    # end mash
+
+    # @param val [String] Token that may or may not be khashed
+    # @return [Boolean] True if token is already khashed
+    def self.khashed?(val)
+      true if val =~ /(\d{6}[A-Z0-9]{14})/
+    end
+  end # end KountSecurityMash
+end

data/lib/kount/utils/khash.rb

@@ -1,47 +1,59 @@
-module Kount 
-  class Khash
-    # @param plain_text [String] String to be hashed
-    # @param ptyp [String] Payment type code: CARD, GIFT, or OTHER
-    # @return [String] KHASH version of string
-    def self.hash_token(plain_text, ptyp, ksalt, merchant_id = '')
-      if ptyp == 'CARD'
-        HashPaymentToken(plain_text, ksalt)
-      elsif ptyp == 'CHEK'
-        HashCheckPayment(plain_text, ksalt)
-      else
-        HashGiftCard(plain_text, ksalt, merchant_id)
-      end
-    end
-
-    def self.getkhash(data, len, m)
-      a = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
-      r = Digest::SHA1.hexdigest("#{data}.#{m}")
-      c = ''
-      len = 17 if len > 17
-      limit = 2 * len
-      i = 0
-      while i < limit
-        c << a[r[i..i + 6].to_i(16) % 36]
-        i += 2
-      end
-      c
-    end
-
-    def self.hash_payment_token(plain_text, ksalt)
-      first_six = plain_text[0..5]
-      mashed = getkhash(plain_text, 14, ksalt)
-      "#{first_six}#{mashed}"
-    end
-
-    def self.hash_check_payment(plain_text, ksalt)
-      first_six = plain_text[0..5]
-      mashed = getkhash(plain_text, 14, ksalt)
-      "#{first_six}#{mashed}"
-    end
-
-    def self.hash_gift_card(plain_text, ksalt, merchant_id)
-      mashed = getkhash(plain_text, 14, ksalt)
-      "#{merchant_id}#{mashed}"
-    end
-  end
-end
+module Kount 
+  class Khash
+    # @param plain_text [String] String to be hashed
+    # @param ptyp [String] Payment type code: CARD, GIFT, or OTHER
+    # @return [String] KHASH version of string
+    def self.hash_token(plain_text, ptyp, ksalt, merchant_id = '')
+      # changed if-else to case-when to follow ruby coding standard
+
+      case ptyp
+      when 'CARD'
+        HashPaymentToken(plain_text, ksalt)
+      when 'CHEK'
+        HashCheckPayment(plain_text, ksalt)
+      else
+        HashGiftCard(plain_text, ksalt, merchant_id)
+      end
+    end
+
+    def self.getkhash(data, len, m)
+      a = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+      r = Digest::SHA1.hexdigest("#{data}.#{m}")
+      c = ''
+      len = 17 if len > 17
+      limit = 2 * len
+      i = 0
+      while i < limit
+        c << a[r[i..i + 6].to_i(16) % 36]
+        i += 2
+      end
+      c
+    end
+
+    def self.hash_payment_token(plain_text, ksalt)
+      return plain_text if khashed?(plain_text)
+      first_six = plain_text[0..5]
+      mashed = getkhash(plain_text, 14, ksalt)
+      "#{first_six}#{mashed}"
+    end
+
+    def self.hash_check_payment(plain_text, ksalt)
+      return plain_text if khashed?(plain_text)
+      first_six = plain_text[0..5]
+      mashed = getkhash(plain_text, 14, ksalt)
+      "#{first_six}#{mashed}"
+    end
+
+    def self.hash_gift_card(plain_text, ksalt, merchant_id)
+      mashed = getkhash(plain_text, 14, ksalt)
+      "#{merchant_id}#{mashed}"
+    end
+
+    # @param val [String] Token that may or may not be khashed
+    # @return [Boolean] True if token is already khashed
+    def self.khashed?(val)
+      true if val =~ /(\d{6}[A-Z0-9]{14})/
+    end
+
+  end
+end