kount_complete 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e167c870a61adbe09bdba84a062a208dc6fbbc28
+  data.tar.gz: 5f56607da3704188e926bb60136542d0cdbad985
+SHA512:
+  metadata.gz: d4c52706b2d584bf7f5340077006b2ccab48021dd706a0a0e1ad139e851eda818c4a7199297694f3e6da94e1fe470f4fa5a2c765d5db4beceace8f12cec62654
+  data.tar.gz: 802ccd7df576560e41bc3dbb8919c3461591cbda111ead9e39fca84b2767927d5f5b4b7bedf1ed415a2399949adb096c2c2545b5b39f7c2bdda4ba83fe69de76

data/lib/kount.rb

@@ -0,0 +1,28 @@
+require 'kount/client'
+require 'kount/payment_types'
+
+##
+# This module is the main entry point to the service wrapper.
+# Its primary function is to collect the runtime options
+# and return a Client object, on which all of the runtime
+# integration takes place.
+module Kount
+  # Creates the client object
+  #
+  # Expected options include:
+  #   options = {
+  #     :merchant_id => "MERCHANT_ID" # required (6 digit number)
+  #     :ksalt => "KSALT" # required (provided by Kount)
+  #     :key => "RIS_KEY" # required (created in the AWC web app)
+  #     :endpoint => "RIS_ENDPOINT" # optional (default https://risk.kount.net)
+  #     :version => "RIS_VERSION" # optional (defaults "0630")
+  #     :is_test => "IS_TEST" # optional (defaults to false)
+  #    }
+  # @param options Hash
+  def new(options = {})
+    fail ArgumentError, 'Config options required' if options.empty?
+    Client.new(options)
+  end
+
+  module_function :new
+end

data/lib/kount/cart.rb

@@ -0,0 +1,36 @@
+module Kount
+  ##
+  # This class handles cart data until the get_request is ready
+  # to push the data into the form fields
+  class Cart
+    attr_accessor :items
+
+    # Initialize cart object
+    def initialize
+      @items = []
+    end
+
+    # Add cart items
+    #
+    # @param item [String] Cart item name
+    # @param type [String] Cart type name
+    # @param desc [String] Cart item long description
+    # @param quant [String] Cart item quantity
+    # @param price [String] Cart item price in cents
+    def add_item(item, type, desc, quant, price)
+      @items << { TYPE: type,
+                  DESC: desc,
+                  ITEM: item,
+                  QUANT: quant,
+                  PRICE: price }
+    end
+
+    # Initialize an Inquiry object
+    #
+    # @param param [String] Param type: :TYPE, :DESC, :ITEM, :PRICE, or :QUANT
+    # @return [Array] Ordered array of the cart contents for each param type
+    def get_item(param)
+      @items.collect { |item| item[param] }
+    end
+  end
+end

data/lib/kount/client.rb

@@ -0,0 +1,122 @@
+require 'kount/security_mash'
+require 'kount/cart'
+require 'kount/request'
+require 'kount/request/update'
+require 'kount/request/inquiry'
+require 'rest-client'
+require 'uri'
+
+# 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 = RestClient::Resource.new(
+        endpoint,
+        verify_ssl: verify_ssl_option).post params, x_kount_api_key: key
+      begin
+        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

data/lib/kount/payment_types.rb

@@ -0,0 +1,50 @@
+module Kount
+  ##
+  # Convenience class to provide a list of PTYP values
+  class PaymentTypes
+    # Credit card (VISA, MasterCard, Amercian Express, etc)
+    CREDIT_CARD   = 'CARD'
+    # 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

@@ -0,0 +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

data/lib/kount/request/inquiry.rb

@@ -0,0 +1,85 @@
+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'
+        ptok = Kount::SecurityMash.hash_credit_card(ptok, ksalt)
+        params.merge!(PTOK: ptok, PENC: 'KHASH')
+      when 'GIFT', 'OTHER'
+        ptok = Kount::SecurityMash.hash_gift_card(ptok, ksalt, merchant_id)
+        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

@@ -0,0 +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

data/lib/kount/security_mash.rb

@@ -0,0 +1,82 @@
+require 'digest/sha1'
+module Kount
+  ##
+  # This class implements the Kount KHASH for cards and gift cards.
+  # rubocop:disable Style/Documentation
+  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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: kount_complete
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Brandon Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper to facilitate making Kount RIS and API calls
+email: bst@keynetics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kount.rb
+- lib/kount/cart.rb
+- lib/kount/client.rb
+- lib/kount/payment_types.rb
+- lib/kount/request.rb
+- lib/kount/request/inquiry.rb
+- lib/kount/request/update.rb
+- lib/kount/security_mash.rb
+homepage: http://rubygems.org/gems/kount_complete
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Kount Complete Services Wrapper
+test_files: []
+has_rdoc: