kount_complete 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e78ba40ade6af05b00f647e187aa66351ca6cd67472b5de0b84f39b2008326a9
-  data.tar.gz: 8a149dffc64cf06e1e00f96765ce004ab2df2c44465f51853e353882581bef7a
+  metadata.gz: 6d823582c3fa9dd5d79479b52f4e45365efd72f24a840a0f1aefd3384d41ac44
+  data.tar.gz: d5b0a0664392c3f0cf40b7c10389d2e2425c342e16fd64ebd9a75b947395af43
 SHA512:
-  metadata.gz: fb98d21ba72460bcc18c5b7581110566969755c1bc476e6b6e834c34928b626b16a92fca128a36ac99d2de82928877ee55275650b91d698607fb843ed84c1b56
-  data.tar.gz: f7e0937dda76d2919e20487a34d8c51a337b79745c7b72d5ec5527e1bfd1a76e5ffbeabdc8e590693c9e935266305015507c6f9b93c1481c17e54167ca711f50
+  metadata.gz: ba23c2a4b10d84e90debc567d6fabd7cfbf4befcadbefc09836d03dda914bb85cf13359bbd294b6ab5ed8ed430be0ee3ee87d437040b899b1fdd1e99f64f5263
+  data.tar.gz: 4be12537ebb05ff14d2cdcf5cb86d549bba92f6ffeae2b3d70926037eda688cec24504f1b1bf194f163be6ab3659080f5cc79e75f59501d8765b85ca88b92771

data/lib/kount/Response.rb

@@ -327,14 +327,15 @@ module Response
       @paramlist['ERROR_COUNT'].to_s
     end
 
-    def geterrors
+    def get_errors
       errors = []
-      error_count = get_error_count
-      (0..error_count.to_i - 1).each do |i|
-        errors = @paramlist["ERROR_#{i}"]
+      error_count = get_error_count.to_i
+      (0..error_count - 1).each do |i|
+        errors << @paramlist["ERROR_#{i}"]
       end
       errors.compact
     end
+    alias geterrors get_errors
 
     def get_numbercounters_triggered
       # changed due to rubocop styling rules for ruby

data/lib/kount/client.rb

@@ -1,4 +1,3 @@
-require 'kount/security_mash'
 require 'kount/cart'
 require 'kount/request'
 require 'kount/request/update'

data/lib/kount/config.rb

@@ -8,7 +8,7 @@ module Kount
         # SDK release version
         # Set the sdk release version which will be used for git tagging in github
         # This will be set by the build process
-        SDK_VERSION = '2.2.0'
+        SDK_VERSION = '2.3.0'
 
     end
 end

data/lib/kount/payment_types.rb

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

data/lib/kount/request/inquiry.rb

@@ -38,23 +38,19 @@ module Kount
 
     # 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)
+      when 'CARD'
+        return if params[:PENC] == 'MASK'
+        ptok = Kount::Khash.hash_payment_token(params[: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)
+      when 'CHEK', 'PYPL'
+        ptok = Kount::Khash.hash_payment_token(params[:PTOK], ksalt)
         params.merge!(PTOK: ptok, PENC: 'KHASH')
-      when 'CHEK', 'OTHER'
-        ptok = Kount::Khash.hash_check_payment(ptok, ksalt)
+      when 'GIFT' 
+        ptok = Kount::Khash.hash_gift_card(params[:PTOK], ksalt, merchant_id)
         params.merge!(PTOK: ptok, PENC: 'KHASH')
       when 'NONE'
-        params.merge!(PTOK: nil, PENC: nil)
-      else
-        params[:PENC] ||= 'NONE'
+        params.merge!(PTOK: nil)
       end
     end
 

data/lib/kount/request.rb

@@ -1,4 +1,3 @@
-require 'kount/security_mash'
 module Kount
   ##
   # This class acts as an abstract class for each type of request.
@@ -37,9 +36,11 @@ module Kount
     end
 
     # Add LBIN to request
+    # <b>DEPRECATED:</b> Please provide <tt>in the request constructor hash param</tt> instead.
     # Supports BIN lengths of 6 digits or greater
     # @param lbin [String] Long Bank Identification Number
     def add_lbin(lbin)
+      warn "[DEPRECATION] LBIN should be provided in the constructor hash instead"
       params.merge!(LBIN: lbin)
     end
   end

data/lib/kount/security_mash.rb

@@ -1,82 +1,27 @@
-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
+
+    # <b>DEPRECATED:</b> This function should not be used. It duplicates the concerns of Kount::Inquiry.fixup_payment_params.
+    def self.hash_token(_plain_text, _ptyp, _ksalt, _merchant_id = '')
+        raise "do not use this function, prefer to use Kount::Inquiry.fixup_payment_params"
     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
+    # <b>DEPRECATED:</b> Use Kount::Khash.hash_payment_token instead.
     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}"
+      warn "[DEPRECATION] use Kount::Khash.hash_payment_token instead"
+      Kount::Khash.hash_payment_token(plain_text, ksalt)
     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
+  
+    # <b>DEPRECATED:</b> Use Kount::Khash.hash_gift_card instead.
     def self.hash_gift_card(plain_text, ksalt, merchant_id)
-      mashed = mash(plain_text, 14, ksalt)
-      "#{merchant_id}#{mashed}"
+      warn "[DEPRECATION] use Kount::Khash.has_gift_card instead"
+      Kount::Khash.hash_gift_card(plain_text, ksalt, merchant_id)
     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
+    # <b>DEPRECATED:</b> Use Kount::Khash.hash_gift_card instead.
     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})/
+      warn "[DEPRECATION] use Kount::Khash.getkhash instead"
+      Kount::Khash.getkhash(data, len, m)
     end
-  end # end KountSecurityMash
+  end
 end

data/lib/kount/utils/khash.rb

@@ -1,21 +1,58 @@
 module Kount 
-  class Khash
+  module Khash
+    # Hash a PAN.
+    #
+    # Preserves first six characters of the input so that hashed cards can be
+    # categorized by Bank Identification Number (BIN).
+    #
+    # Example usage:
+    #   hashed = Kount::Khash.hash_payment_token("4111111111111111", ksalt)
+    #     Expect: 411111WMS5YA6FUZA1KC
+    #
     # @param plain_text [String] String to be hashed
-    # @param ptyp [String] Payment type code: CARD, GIFT, or OTHER
+    # @param ksalt      [String] The kount khash salt provided by Kount
+    #
     # @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
+    def self.hash_payment_token(plain_text, ksalt)
+      return plain_text if khashed?(plain_text)
+      mashed = getkhash(plain_text, 14, ksalt)
+      "#{plain_text[0..5]}#{mashed}"
+    end
 
-      case ptyp
-      when 'CARD'
-        HashPaymentToken(plain_text, ksalt)
-      when 'CHEK'
-        HashCheckPayment(plain_text, ksalt)
-      else
-        HashGiftCard(plain_text, ksalt, merchant_id)
-      end
+    # <b>DEPRECATED:</b> Use Kount::Khash.hash_payment_token instead.
+    def self.hash_check_payment(plain_text, ksalt)
+      warn "[DEPRECATION] use Kount::Khash.hash_payment_token instead"
+      hash_payment_token(plain_text, ksalt)
     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("3245876", salt, "123456")
+    #     Expect: 1234569HXH32Y5NNJCGB
+    #
+    # @param plain_text  [String] String to be hashed
+    # @param ksalt       [String] The kount khash salt provided by Kount
+    # @param merchant_id [String] The merchant id that will serve as the common domain of all gift
+    #        cards
+    #
+    # @return [String] KHASH version of string
+    def self.hash_gift_card(plain_text, ksalt, merchant_id)
+      return plain_text if khashed?(plain_text)
+      mashed = getkhash(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
+    # @param m    [String] The kount khash salt
+    #
+    # @return [String] Hashed data
     def self.getkhash(data, len, m)
       a = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'
       r = Digest::SHA1.hexdigest("#{data}.#{m}")
@@ -30,30 +67,10 @@ module Kount
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kount_complete
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Kount
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Kount Complete Services Wrapper