bluepay 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4b8c60d7a7435833ded8a2dcb67bdc922ad753a
-  data.tar.gz: c50882b1f4839eb2940bebdcb438fff5d5e7bdda
+  metadata.gz: 040ef1ecd2c2ec89c955c6c038f503ba582097d9
+  data.tar.gz: bc51b336d7c58b48912d2573ab44b64a5fd2f3fd
 SHA512:
-  metadata.gz: 56176030b8a91a4941f475bcf854d6932cf7b0fd565037b22f31f8bcedbe8a37ba2285f44fefb224ac481cf8f9be27a6763ae535d7f5a0f8fa313a244df39fb4
-  data.tar.gz: 976a8df2dbe71fd7079f2dbab60991bbfc791a494d77427092e0d872d412ea0065e04fdf636da3ae19b30f609e11427403a69fbd77a908f4ec0f473e5e65b26d
+  metadata.gz: cf3ae0dfafa78afc6cf497199e96300d2ae115e1d61a5909f4405ed16446220b1f2ffb81eccda3a2bb96bbb27dd84e33583b99b95dbc6b4b07abd96b6ec6744a
+  data.tar.gz: e405a6db7afad4b1e8a15663ba0d1665b54804bb14b30b65e170b43b87513a11fd09cf710b14d7fc97f6d7547dc07e1e14b34eb9742ed3366e117549a26b64bc

data/README

@@ -57,5 +57,5 @@ end
 
 Author::    Justin Slingerland
 ReadmeDoc:: Justin Slingerland
-Copyright:: Copyright (c) 2016 BluePay, Inc.
+Copyright:: Copyright (c) 2018 BluePay, Inc.
 License::   GPL - GNU General Public License - http://www.gnu.org/licenses/gpl.html

data/bluepay.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'bluepay'
-  s.version     = '1.0.6'
-  s.date        = '2016-11-15'
+  s.version     = '1.0.7'
+  s.date        = '2018-02-16'
   s.summary     = "BluePay gateway rubygem"
   s.description = "This gem is intended to be used along with a BluePay gateway account to process credit card and ACH transactions"
-  s.authors     = ["Justin Slingerland, Susan Schmidt"]
+  s.authors     = ["Justin Slingerland, Susan Schmidt, Eric Margules"]
   s.email       = 'jslingerland@bluepay.com'
   s.has_rdoc    = true
   s.files       = Dir.glob("{lib,test,doc}/**/*") + %w(bluepay.gemspec Rakefile README)

data/lib/api_request.rb

@@ -8,10 +8,25 @@ class BluePay
     return uri_query_string
   end
 
+  # Generates TPS hash based on given hash type
+  def create_tps_hash(data, hash_type)
+    case hash_type   
+    when 'HMAC_SHA256'
+      OpenSSL::HMAC.hexdigest('sha256', @SECRET_KEY, data)
+    when 'SHA512'
+      Digest::SHA512.hexdigest(@SECRET_KEY + data)
+    when 'SHA256'
+      Digest::SHA256.hexdigest(@SECRET_KEY + data)
+    when 'MD5'
+      Digest::MD5.hexdigest(@SECRET_KEY + data)
+    else
+      OpenSSL::HMAC.hexdigest('sha512', @SECRET_KEY, data)
+    end
+  end
+
   # Sets TAMPER_PROOF_SEAL in @PARAM_HASH
   def calc_tps
-    @PARAM_HASH["TAMPER_PROOF_SEAL"] = Digest::SHA512.hexdigest(
-        @SECRET_KEY + 
+    @PARAM_HASH["TAMPER_PROOF_SEAL"] = create_tps_hash(
         @ACCOUNT_ID + 
         (@PARAM_HASH["TRANSACTION_TYPE"] || '') + 
         @PARAM_HASH["AMOUNT"] + 
@@ -21,55 +36,40 @@ class BluePay
         (@PARAM_HASH["REB_CYCLES"] || '') + 
         (@PARAM_HASH["REB_AMOUNT"] || '') + 
         (@PARAM_HASH["RRNO"] || '') + 
-        @PARAM_HASH["MODE"]
+        @PARAM_HASH["MODE"], 
+        @PARAM_HASH['TPS_HASH_TYPE']
       )
   end
 
   # Sets TAMPER_PROOF_SEAL in @PARAM_HASH for rebadmin API
   def calc_rebill_tps
-    @PARAM_HASH["TAMPER_PROOF_SEAL"] = Digest::MD5.hexdigest(
-      @SECRET_KEY + 
+    @PARAM_HASH["TAMPER_PROOF_SEAL"] = create_tps_hash(
       @ACCOUNT_ID +
       @PARAM_HASH["TRANS_TYPE"] + 
-      @PARAM_HASH["REBILL_ID"]
+      @PARAM_HASH["REBILL_ID"], 
+      @PARAM_HASH['TPS_HASH_TYPE']
     )
   end
 
   # Sets TAMPER_PROOF_SEAL in @PARAM_HASH for bpdailyreport2 API
   def calc_report_tps
-    @PARAM_HASH["TAMPER_PROOF_SEAL"] = Digest::MD5.hexdigest(
-      @SECRET_KEY + 
+    @PARAM_HASH["TAMPER_PROOF_SEAL"] = create_tps_hash(
       @ACCOUNT_ID + 
       @PARAM_HASH["REPORT_START_DATE"] + 
-      @PARAM_HASH["REPORT_END_DATE"]
+      @PARAM_HASH["REPORT_END_DATE"],
+      @PARAM_HASH['TPS_HASH_TYPE']
       )
   end
 
-  # Calculates TAMPER_PROOF_SEAL to be used with Trans Notify API 
-  def self.calc_trans_notify_tps(secret_key, trans_id, trans_status, trans_type, amount, batch_id, batch_status, total_count, total_amount, batch_upload_id, rebill_id, rebill_amount, rebill_status)
-    Digest::MD5.hexdigest(
-      @SECRET_KEY + 
-      trans_id + 
-      trans_status + 
-      transtype + 
-      amount + 
-      batch_id + 
-      batch_status + 
-      total_count + 
-      total_amount + 
-      batch_upload_id + 
-      rebill_id + 
-      rebill_amount + 
-      rebill_status
-    )
-  end
-
  # sends HTTPS POST to BluePay gateway for processing
   def process
     
     ua = Net::HTTP.new(SERVER, 443)
     ua.use_ssl = true
     
+    # Set default hash function to HMAC SHA-512
+    @PARAM_HASH['TPS_HASH_TYPE'] = 'HMAC_SHA512'
+
     # Checks presence of CA certificate
     if File.directory?(RootCA)
       ua.ca_path = RootCA
@@ -86,6 +86,9 @@ class BluePay
       rescue Exception
     end
 
+    # Response version to be returned
+    @PARAM_HASH["RESPONSEVERSION"] = '5'
+
     # Generate the query string and headers.  Chooses which API to make request to.
     case @api
     when "bpdailyreport2"
@@ -99,7 +102,7 @@ class BluePay
     when "bp10emu"
       calc_tps
       path = "/interfaces/bp10emu"
-      query = "MERCHANT=#{@ACCOUNT_ID}&" + uri_query(@PARAM_HASH) + "&TPS_HASH_TYPE=SHA512"
+      query = "MERCHANT=#{@ACCOUNT_ID}&" + uri_query(@PARAM_HASH)
       # puts "****"; puts uri_query(@PARAM_HASH).inspect
     when "bp20rebadmin"
       calc_rebill_tps
@@ -110,8 +113,6 @@ class BluePay
       'User-Agent' => 'Bluepay Ruby Client',
       'Content-Type' => 'application/x-www-form-urlencoded'
     }
-    # Response version to be returned
-    @PARAM_HASH["VERSION"] = '3'
     # Post parameters to BluePay gateway
     headers, body = ua.post(path, query, queryheaders)
     # Split the response into the response hash.
@@ -131,4 +132,4 @@ class BluePay
       end
     end
   end
-end
+end

data/lib/api_response.rb

@@ -2,7 +2,7 @@ class BluePay
   def get_response
     @RESPONSE_HASH
   end
-
+  
   # Returns true if response status is approved and not a duplicate, else returns false
   def successful_transaction?
     self.get_status == "APPROVED" && self.get_message != "DUPLICATE"
@@ -24,6 +24,21 @@ class BluePay
     end
   end
 
+  # Returns the BP_STAMP used to authenticate response
+  def get_bp_stamp
+    @RESPONSE_HASH['BP_STAMP']
+  end
+
+  # Returns the fields used to calculate the BP_STAMP
+  def get_bp_stamp_def
+    @RESPONSE_HASH['BP_STAMP_DEF']
+  end
+  
+  # Returns hash function used for transaction
+  def get_hash_type
+    @RESPONSE_HASH['TPS_HASH_TYPE']
+  end
+
   # Returns the single-character AVS response from the 
   # Card Issuing Bank
   def get_avs_code

data/lib/bluepay.rb

@@ -2,7 +2,6 @@ require "net/http"
 require "net/https"
 require "uri"
 require "digest/sha2"
-require "digest/md5"
 
 # Files
 require_relative "api_request"
@@ -74,6 +73,14 @@ class BluePay
     @api = "bp10emu"
   end
 
+  # Update
+  def update(params = {})
+    @PARAM_HASH['TRANSACTION_TYPE'] = 'UPDATE'
+    @PARAM_HASH['RRNO'] = params[:trans_id]
+    @PARAM_HASH['AMOUNT'] = params[:amount] || ''
+    @api = "bp10emu"
+  end
+
   # Void
   def void(trans_id)
     @PARAM_HASH['TRANSACTION_TYPE'] = 'VOID'
@@ -159,6 +166,71 @@ class BluePay
     @PARAM_HASH['AMOUNT_MISC'] = amount_misc
   end
 
+  # Adds information required for level 2 processing.
+  def add_level2_information(params)
+    @PARAM_HASH['LV2_ITEM_TAX_RATE'] = params[:tax_rate] || ''
+    @PARAM_HASH['LV2_ITEM_GOODS_TAX_RATE'] = params[:goods_tax_rate] || ''
+    @PARAM_HASH['LV2_ITEM_GOODS_TAX_AMOUNT'] = params[:goods_tax_amount] || ''
+    @PARAM_HASH['LV2_ITEM_SHIPPING_AMOUNT'] = params[:shipping_amount] || ''
+    @PARAM_HASH['LV2_ITEM_DISCOUNT_AMOUNT'] = params[:discount_amount] || ''
+    @PARAM_HASH['LV2_ITEM_CUST_PO'] = params[:cust_po] || ''
+    @PARAM_HASH['LV2_ITEM_GOODS_TAX_ID'] = params[:goods_tax_id] || ''
+    @PARAM_HASH['LV2_ITEM_TAX_ID'] = params[:tax_id] || ''
+    @PARAM_HASH['LV2_ITEM_CUSTOMER_TAX_ID'] = params[:customer_tax_id] || ''
+    @PARAM_HASH['LV2_ITEM_DUTY_AMOUNT'] = params[:duty_amount] || ''
+    @PARAM_HASH['LV2_ITEM_SUPPLEMENTAL_DATA'] = params[:supplemental_data] || ''
+    @PARAM_HASH['LV2_ITEM_CITY_TAX_RATE'] = params[:city_tax_rate] || ''
+    @PARAM_HASH['LV2_ITEM_CITY_TAX_AMOUNT'] = params[:city_tax_amount] || ''
+    @PARAM_HASH['LV2_ITEM_COUNTY_TAX_RATE'] = params[:county_tax_rate] || ''
+    @PARAM_HASH['LV2_ITEM_COUNTY_TAX_AMOUNT'] = params[:county_tax_amount] || ''
+    @PARAM_HASH['LV2_ITEM_STATE_TAX_RATE'] = params[:state_tax_rate] || ''
+    @PARAM_HASH['LV2_ITEM_STATE_TAX_AMOUNT'] = params[:state_tax_amount] || ''
+    @PARAM_HASH['LV2_ITEM_BUYER_NAME'] = params[:buyer_name] || ''
+    @PARAM_HASH['LV2_ITEM_CUSTOMER_REFERENCE'] = params[:customer_reference] || ''
+    @PARAM_HASH['LV2_ITEM_CUSTOMER_NUMBER'] = params[:customer_number] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_NAME'] = params[:ship_name] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_ADDR1'] = params[:ship_addr1] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_ADDR2'] = params[:ship_addr2] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_CITY'] = params[:ship_city] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_STATE'] = params[:ship_state] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_ZIP'] = params[:ship_zip] || ''
+    @PARAM_HASH['LV2_ITEM_SHIP_COUNTRY'] = params[:ship_country] || ''
+  end
+
+  # Adds a line item for level 3 processing. Repeat method for each item up to 99 items.
+  # For Canadian and AMEX processors, ensure required Level 2 information is present.
+  def add_line_item(params)
+    # Creates line items counter necessary for prefix.
+    @LINE_ITEMS = 0 if !@LINE_ITEMS                                                              
+    @LINE_ITEMS += 1                                                              #  VALUE REQUIRED IN:
+    prefix = "LV3_ITEM#{@LINE_ITEMS}_"                                            #  USA | CANADA
+    @PARAM_HASH[prefix + 'UNIT_COST'] = params[:unit_cost]                        #   *      *
+    @PARAM_HASH[prefix + 'QUANTITY'] = params[:quantity]                          #   *      *
+    @PARAM_HASH[prefix + 'ITEM_SKU'] = params[:item_sku] || ''                    #          *
+    @PARAM_HASH[prefix + 'ITEM_DESCRIPTOR'] = params[:descriptor] || ''           #   *      *
+    @PARAM_HASH[prefix + 'COMMODITY_CODE'] = params[:commodity_code] || ''        #   *      *
+    @PARAM_HASH[prefix + 'PRODUCT_CODE'] = params[:product_code] || ''            #   *    
+    @PARAM_HASH[prefix + 'MEASURE_UNITS'] = params[:measure_units] || ''          #   *      *
+    @PARAM_HASH[prefix + 'ITEM_DISCOUNT'] = params[:item_discount] || ''          #          *
+    @PARAM_HASH[prefix + 'TAX_RATE'] = params[:tax_rate] || ''                    #   *    
+    @PARAM_HASH[prefix + 'GOODS_TAX_RATE'] = params[:goods_tax_rate] || ''        #          *
+    @PARAM_HASH[prefix + 'TAX_AMOUNT'] = params[:tax_amount] || ''                #   *    
+    @PARAM_HASH[prefix + 'GOODS_TAX_AMOUNT'] = params[:goods_tax_amount] || ''    #          *
+    @PARAM_HASH[prefix + 'CITY_TAX_RATE'] = params[:city_tax_rate] || ''          #
+    @PARAM_HASH[prefix + 'CITY_TAX_AMOUNT'] = params[:city_tax_amount] || ''      #
+    @PARAM_HASH[prefix + 'COUNTY_TAX_RATE'] = params[:county_tax_rate] || ''      #
+    @PARAM_HASH[prefix + 'COUNTY_TAX_AMOUNT'] = params[:county_tax_amount] || ''  #
+    @PARAM_HASH[prefix + 'STATE_TAX_RATE'] = params[:state_tax_rate] || ''        #
+    @PARAM_HASH[prefix + 'STATE_TAX_AMOUNT'] = params[:state_tax_amount] || ''    #
+    @PARAM_HASH[prefix + 'CUST_SKU'] = params[:cust_sku] || ''                    #
+    @PARAM_HASH[prefix + 'CUST_PO'] = params[:cust_po] || ''                      #
+    @PARAM_HASH[prefix + 'SUPPLEMENTAL_DATA'] = params[:supplemental_data] || ''  #
+    @PARAM_HASH[prefix + 'GL_ACCOUNT_NUMBER'] = params[:gl_account_number] || ''  #
+    @PARAM_HASH[prefix + 'DIVISION_NUMBER'] = params[:division_number] || ''      #
+    @PARAM_HASH[prefix + 'PO_LINE_NUMBER'] = params[:po_line_number] || ''        #
+    @PARAM_HASH[prefix + 'LINE_ITEM_TOTAL'] = params[:line_item_total] || ''      #   *     
+  end
+
   # Set fields for a recurring payment
   def set_recurring_payment(params = {})
     @PARAM_HASH['REBILLING'] = '1'
@@ -321,21 +393,29 @@ class BluePay
     @PARAM_HASH['PROTECT_CUSTOM_ID2'] = params[:protect_custom_id2] || "No" 
     @PARAM_HASH['SHPF_FORM_ID'] = params[:payment_template] || "mobileform01"
     @PARAM_HASH['RECEIPT_FORM_ID'] = params[:receipt_template] || "mobileresult01"
-    @PARAM_HASH['REMOTE_URL'] = params[:receipt_temp_remote_url] || '' 
+    @PARAM_HASH['REMOTE_URL'] = params[:receipt_temp_remote_url] || ''
+    @PARAM_HASH['SHPF_TPS_HASH_TYPE'] = "HMAC_SHA512"
+    @PARAM_HASH['RECEIPT_TPS_HASH_TYPE'] = @PARAM_HASH['SHPF_TPS_HASH_TYPE']
+    @PARAM_HASH['TPS_HASH_TYPE'] = set_hash_type(params[:tps_hash_type] || '')
     @card_types = set_card_types
-    @receipt_tps_def = 'SHPF_ACCOUNT_ID SHPF_FORM_ID RETURN_URL DBA AMEX_IMAGE DISCOVER_IMAGE SHPF_TPS_DEF'
+    @receipt_tps_def = 'SHPF_ACCOUNT_ID SHPF_FORM_ID RETURN_URL DBA AMEX_IMAGE DISCOVER_IMAGE SHPF_TPS_DEF SHPF_TPS_HASH_TYPE'
     @receipt_tps_string = set_receipt_tps_string
-    @receipt_tamper_proof_seal = calc_url_tps(@receipt_tps_string)
+    @receipt_tamper_proof_seal = create_tps_hash(@receipt_tps_string, @PARAM_HASH['RECEIPT_TPS_HASH_TYPE'])
     @receipt_url = set_receipt_url
-    @bp10emu_tps_def = add_def_protected_status('MERCHANT APPROVED_URL DECLINED_URL MISSING_URL MODE TRANSACTION_TYPE TPS_DEF')
+    @bp10emu_tps_def = add_def_protected_status('MERCHANT APPROVED_URL DECLINED_URL MISSING_URL MODE TRANSACTION_TYPE TPS_DEF TPS_HASH_TYPE')
     @bp10emu_tps_string = set_bp10emu_tps_string
-    @bp10emu_tamper_proof_seal = calc_url_tps(@bp10emu_tps_string)
-    @shpf_tps_def = add_def_protected_status('SHPF_FORM_ID SHPF_ACCOUNT_ID DBA TAMPER_PROOF_SEAL AMEX_IMAGE DISCOVER_IMAGE TPS_DEF SHPF_TPS_DEF')
+    @bp10emu_tamper_proof_seal = create_tps_hash(@bp10emu_tps_string, @PARAM_HASH['TPS_HASH_TYPE'])
+    @shpf_tps_def = add_def_protected_status('SHPF_FORM_ID SHPF_ACCOUNT_ID DBA TAMPER_PROOF_SEAL AMEX_IMAGE DISCOVER_IMAGE TPS_DEF TPS_HASH_TYPE SHPF_TPS_DEF SHPF_TPS_HASH_TYPE')
     @shpf_tps_string = set_shpf_tps_string
-    @shpf_tamper_proof_seal = calc_url_tps(@shpf_tps_string)
+    @shpf_tamper_proof_seal = create_tps_hash(@shpf_tps_string, @PARAM_HASH['SHPF_TPS_HASH_TYPE'])
     return calc_url_response
   end
 
+  def set_hash_type(chosen_hash)
+    default_hash = "HMAC_SHA512"
+    ["MD5", "SHA256", "SHA512", "HMAC_SHA256"].include?(chosen_hash.upcase) ? chosen_hash.upcase : default_hash
+  end
+
   # Sets the types of credit card images to use on the Simple Hosted Payment Form. Must be used with generate_url.
   def set_card_types
     credit_cards = 'vi-mc'
@@ -346,41 +426,42 @@ class BluePay
 
   # Sets the receipt Tamperproof Seal string. Must be used with generate_url.
   def set_receipt_tps_string
-    [@SECRET_KEY, 
-    @ACCOUNT_ID, 
+    [@ACCOUNT_ID, 
     @PARAM_HASH['RECEIPT_FORM_ID'], 
     @PARAM_HASH['RETURN_URL'], 
     @PARAM_HASH['DBA'], 
     @PARAM_HASH['AMEX_IMAGE'], 
     @PARAM_HASH['DISCOVER_IMAGE'], 
-    @receipt_tps_def].join('')
+    @receipt_tps_def,
+    @PARAM_HASH['RECEIPT_TPS_HASH_TYPE']].join('')
   end
 
   # Sets the bp10emu string that will be used to create a Tamperproof Seal. Must be used with generate_url.
   def set_bp10emu_tps_string
     bp10emu = [
-    @SECRET_KEY,
     @ACCOUNT_ID,
     @receipt_url,
     @receipt_url,
     @receipt_url,
     @PARAM_HASH['MODE'],
     @PARAM_HASH['TRANSACTION_TYPE'],
-    @bp10emu_tps_def].join('')
+    @bp10emu_tps_def,
+    @PARAM_HASH['TPS_HASH_TYPE']].join('')
     return add_string_protected_status(bp10emu)
   end
 
   # Sets the Simple Hosted Payment Form string that will be used to create a Tamperproof Seal. Must be used with generate_url.
   def set_shpf_tps_string 
-    shpf = ([@SECRET_KEY,
-    @PARAM_HASH['SHPF_FORM_ID'], 
+    shpf = ([@PARAM_HASH['SHPF_FORM_ID'], 
     @ACCOUNT_ID, 
     @PARAM_HASH['DBA'], 
     @bp10emu_tamper_proof_seal, 
     @PARAM_HASH['AMEX_IMAGE'], 
     @PARAM_HASH['DISCOVER_IMAGE'], 
-    @bp10emu_tps_def, 
-    @shpf_tps_def].join(''))
+    @bp10emu_tps_def,
+    @PARAM_HASH['TPS_HASH_TYPE'], 
+    @shpf_tps_def,
+    @PARAM_HASH['SHPF_TPS_HASH_TYPE']].join(''))
     return add_string_protected_status(shpf)
   end
 
@@ -390,13 +471,14 @@ class BluePay
       return @PARAM_HASH['REMOTE_URL']
     else
       return 'https://secure.bluepay.com/interfaces/shpf?SHPF_FORM_ID=' + @PARAM_HASH['RECEIPT_FORM_ID'] + 
-      '&SHPF_ACCOUNT_ID=' + ACCOUNT_ID + 
-      '&SHPF_TPS_DEF='    + url_encode(@receipt_tps_def) + 
-      '&SHPF_TPS='        + url_encode(@receipt_tamper_proof_seal) + 
-      '&RETURN_URL='      + url_encode(@PARAM_HASH['RETURN_URL']) + 
-      '&DBA='             + url_encode(@PARAM_HASH['DBA']) + 
-      '&AMEX_IMAGE='      + url_encode(@PARAM_HASH['AMEX_IMAGE']) + 
-      '&DISCOVER_IMAGE='  + url_encode(@PARAM_HASH['DISCOVER_IMAGE'])
+      '&SHPF_ACCOUNT_ID='     + @ACCOUNT_ID + 
+      '&SHPF_TPS_DEF='        + url_encode(@receipt_tps_def) + 
+      '&SHPF_TPS_HASH_TYPE='  + url_encode(@PARAM_HASH['RECEIPT_TPS_HASH_TYPE']) +
+      '&SHPF_TPS='            + url_encode(@receipt_tamper_proof_seal) + 
+      '&RETURN_URL='          + url_encode(@PARAM_HASH['RETURN_URL']) + 
+      '&DBA='                 + url_encode(@PARAM_HASH['DBA']) + 
+      '&AMEX_IMAGE='          + url_encode(@PARAM_HASH['AMEX_IMAGE']) + 
+      '&DISCOVER_IMAGE='      + url_encode(@PARAM_HASH['DISCOVER_IMAGE'])
     end
   end
 
@@ -428,17 +510,13 @@ class BluePay
    return encoded_string
   end
 
-  # Generates a Tamperproof Seal for a url. Must be used with generate_url.
-  def calc_url_tps(tps_type)
-    Digest::MD5.hexdigest(tps_type)
-  end
-
   # Generates the final url for the Simple Hosted Payment Form. Must be used with generate_url.
   def calc_url_response
     'https://secure.bluepay.com/interfaces/shpf?'                                     +
     'SHPF_FORM_ID='       .concat(url_encode    (@PARAM_HASH['SHPF_FORM_ID'])       ) +
     '&SHPF_ACCOUNT_ID='   .concat(url_encode    (@ACCOUNT_ID)                       ) +
     '&SHPF_TPS_DEF='      .concat(url_encode    (@shpf_tps_def)                     ) +
+    '&SHPF_TPS_HASH_TYPE='.concat(url_encode    (@PARAM_HASH['SHPF_TPS_HASH_TYPE']) ) +
     '&SHPF_TPS='          .concat(url_encode    (@shpf_tamper_proof_seal)           ) +
     '&MODE='              .concat(url_encode    (@PARAM_HASH['MODE'])               ) +
     '&TRANSACTION_TYPE='  .concat(url_encode    (@PARAM_HASH['TRANSACTION_TYPE'])   ) +
@@ -456,6 +534,7 @@ class BluePay
     '&DISCOVER_IMAGE='    .concat(url_encode    (@PARAM_HASH['DISCOVER_IMAGE'])     ) +
     '&REDIRECT_URL='      .concat(url_encode    (@receipt_url)                      ) +
     '&TPS_DEF='           .concat(url_encode    (@bp10emu_tps_def)                  ) +
+    '&TPS_HASH_TYPE='     .concat(url_encode    (@PARAM_HASH['TPS_HASH_TYPE'])      ) +
     '&CARD_TYPES='        .concat(url_encode    (@card_types)                       )
   end
-end
+end

data/test/Get_Data/Retrieve_Settlement_Data.rb

@@ -28,4 +28,4 @@ report.get_settled_transaction_report(
 )
 
 # Makes the API request with BluePay and returns response
-puts report.process
+puts report.process

data/test/Get_Data/{retrieve_transaction_data.rb → Retrieve_Transaction_Data.rb}

@@ -27,4 +27,4 @@ report.get_transaction_report(
 )
 
 # Makes the API request with BluePay and returns response
-puts report.process
+puts report.process

data/test/Get_Data/Single_Transaction_Query.rb

@@ -27,7 +27,7 @@ query.get_single_transaction_query(
 )
 
 # Makes the API request with BluePay 
-response = query.process
+query.process
 
 if query.get_id
   # Reads the response from BluePay

data/test/Get_Data/Transaction_Notification.rb

@@ -10,9 +10,13 @@
 require_relative "../../lib/bluepay.rb"
 require "cgi"
 
-vars = CGI.new
+ACCOUNT_ID = "Merchant's Account ID Here"
+SECRET_KEY = "Merchant's Secret Key Here"
+MODE = "TEST" 
+
+tps = BluePay.new(account_id: ACCOUNT_ID, secret_key: SECRET_KEY, mode: MODE)
 
-secret_key = ""
+vars = CGI.new
 
 # Assign values
 trans_id = vars["trans_id"]
@@ -20,33 +24,22 @@ trans_status = vars["trans_status"]
 trans_type = vars["trans_type"]
 amount = vars["amount"]
 batch_id = vars["batch_id"]
-batch_status = vars["batch_status"]
-total_count = vars["total_count"]
-total_amount = vars["total_amount"]
-batch_upload_id = vars["batch_upload_id"]
 rebill_id = vars["rebill_id"]
 rebill_amount = vars["reb_amount"]
 rebill_status = vars["status"]
+tps_hash_type = vars["TPS_HASH_TYPE"]
+bp_stamp = vars["BP_STAMP"]
+bp_stamp_def = vars["BP_STAMP_DEF"]
 
 # Calculate expected bp_stamp
-bp_stamp = BluePay.calc_trans_notify_tps(
-  secret_key,
-  trans_id,
-  trans_status,
-  trans_type,
-  amount,
-  batch_id,
-  batch_status,
-  total_count,
-  total_amount,
-  batch_upload_id,
-  rebill_id,
-  rebill_amount,
-  rebill_status
-)
+bp_stamp_string = ''
+bp_stamp_def.split(' ').each do |field| 
+  bp_stamp_string += vars[field]
+end
+expected_stamp = tps.create_tps_hash(bp_stamp_string, tps_hash_type).upcase
 
 # check if expected bp_stamp = actual bp_stamp
-if bp_stamp == vars["bp_stamp"]
+if expected_stamp == vars["BP_STAMP"]
 
   # Reads the response from BluePay
   puts 'Transaction ID: ' + trans_id

data/test/Get_Data/Validate_BP_Stamp.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+
+##
+# BluePay Ruby Sample code.
+#
+# This code sample reads the values from a BP10emu redirect
+# and authenticates the message using the the BP_STAMP
+# provided in the response. Point the REDIRECT_URL of your 
+# BP10emu request to the location of this script on your server.
+##
+
+print "Content-type:text/html\r\n\r\n"
+print "<html><head></head><body>"
+
+require_relative "bluepay.rb"
+require "cgi"
+
+ACCOUNT_ID = "Merchant's Account ID Here"
+SECRET_KEY = "Merchant's Secret Key Here"
+MODE = "TEST" 
+
+response = CGI.new
+
+if response["BP_STAMP"] # Check whether BP_STAMP is provided
+
+  bp = BluePay.new(account_id: ACCOUNT_ID, secret_key: SECRET_KEY, mode: MODE)
+
+  bp_stamp_string = ''
+  response["BP_STAMP_DEF"].split(' ').each do |field| # Split BP_STAMP_DEF on whitespace
+    bp_stamp_string += response[field] # Concatenate values used to calculate expected BP_STAMP
+  end
+  expected_stamp = bp.create_tps_hash(bp_stamp_string, response["TPS_HASH_TYPE"]).upcase # Calculate expected BP_STAMP using hash function specified in response
+
+  if expected_stamp == response["BP_STAMP"] # Compare expected BP_STAMP with received BP_STAMP
+    # Validate BP_STAMP and reads the response results
+    print "VALID BP_STAMP: TRUE<br/>"
+    response.params.each{|k,v| print "#{k}: #{v[0]}<br/>"}
+  else
+    print "ERROR: BP_STAMP VALUES DO NOT MATCH<br/>"
+  end
+
+else
+  print "ERROR: BP_STAMP NOT FOUND. CHECK MESSAGE & RESPONSEVERSION<br/>"
+end
+
+print "</body></html>"

data/test/Rebill/Cancel_Recurring_Payment.rb

@@ -35,7 +35,7 @@ rebill.set_customer_information(
 
 rebill.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -78,4 +78,4 @@ if rebill.successful_transaction?
   puts "REBILL NEXT AMOUNT: " + rebill_cancel.get_next_amount
 else
   puts rebill.get_message
-end
+end

data/test/Rebill/Create_Recurring_Payment_ACH.rb

@@ -58,4 +58,4 @@ if rebill.successful_transaction?
   puts "CUSTOMER BANK NAME: " + rebill.get_bank_name
 else
   puts rebill.get_message
-end
+end

data/test/Rebill/Create_Recurring_Payment_CC.rb

@@ -31,7 +31,7 @@ rebill.set_customer_information(
 
 rebill.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -61,4 +61,4 @@ if rebill.successful_transaction?
   puts "AUTH CODE: " + rebill.get_auth_code
 else
   puts rebill.get_message
-end
+end

data/test/Rebill/Get_Recurring_Payment_Status.rb

@@ -36,7 +36,7 @@ rebill.set_customer_information(
 
 rebill.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 

data/test/Rebill/Update_Recurring_Payment.rb

@@ -36,7 +36,7 @@ rebill.set_customer_information(
 
 rebill.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -64,7 +64,7 @@ if rebill.successful_transaction?
 
   # Sets an updated credit card expiration date
   payment_information_update.set_cc_information(
-    cc_expiration: "0121" # Card Expiration
+    cc_expiration: "1229" # Card Expiration
   )
 
   # Stores new card expiration date

data/test/Transactions/Cancel_Transaction.rb

@@ -35,7 +35,7 @@ payment.set_customer_information(
 
 payment.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -71,4 +71,4 @@ if payment.successful_transaction?
   puts "AUTH CODE: " + payment_void.get_auth_code
 else
   puts payment.get_message
-end
+end

data/test/Transactions/Charge_Customer_ACH.rb

@@ -51,4 +51,4 @@ if payment.successful_transaction?
   puts "BANK NAME: " + payment.get_bank_name
 else
   puts payment.get_message
-end
+end

data/test/Transactions/{CHarge_Customer_CC.rb → Charge_Customer_CC.rb}

@@ -9,8 +9,8 @@
 
 require_relative "../../lib/bluepay.rb"
 
-ACCOUNT_ID = "Merchant's Account ID Here"
-SECRET_KEY = "Merchant's Secret Key Here"
+ACCOUNT_ID = "Merchant's Account ID here"
+SECRET_KEY = "Merchant's Secret Key here"
 MODE = "TEST"  
 
 payment = BluePay.new(
@@ -34,7 +34,7 @@ payment.set_customer_information(
 
 payment.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 

data/test/Transactions/Charge_Customer_CC_Lvl2_Lvl3.rb

@@ -0,0 +1,91 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a Credit Card sales transaction, 
+# including sample Level 2 and 3 processing information,
+# against a customer using test payment information.
+# If using TEST mode, odd dollar amounts will return
+# an approval and even dollar amounts will return a decline.
+##
+
+require_relative "../../lib/bluepay.rb"
+
+ACCOUNT_ID = "Merchant's Account ID here"
+SECRET_KEY = "Merchant's Secret Key here"
+MODE = "TEST"  
+
+payment = BluePay.new(
+  account_id: ACCOUNT_ID,  
+  secret_key: SECRET_KEY,  
+  mode: MODE
+)
+
+payment.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "123 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"  
+)
+
+payment.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1225", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+# Set Level 2 Information
+payment.invoice_id = "123456789"
+payment.amount_tax = "0.91"
+
+# Set Level 3 line item information. Repeat for each item up to 99.
+payment.add_line_item(
+  quantity: "1", # The number of units of item. Max: 5 digits
+  unit_cost: "3.00", # The cost per unit of item. Max: 9 digits decimal
+  descriptor: "test1", # Description of the item purchased. Max: 26 character
+  commodity_code: "123412341234", # Commodity Codes can be found at http://www.census.gov/svsd/www/cfsdat/2002data/cfs021200.pdf. Max: 12 characters
+  product_code: "432143214321", # Merchant-defined code for the product or service being purchased. Max: 12 characters 
+  measure_units: "EA", # The unit of measure of the item purchase. Normally EA. Max: 3 characters
+  tax_rate: "7%", # Tax rate for the item. Max: 4 digits
+  tax_amount: "0.21", # Tax amount for the item. unit_cost * quantity * tax_rate = tax_amount. Max: 9 digits.
+  item_discount: "0.00", # The amount of any discounts on the item. Max: 12 digits.
+  line_item_total: "3.21" # The total amount for the item including taxes and discounts.
+)
+
+payment.add_line_item(
+  quantity: "2", 
+  unit_cost: "5.00", 
+  descriptor: "test2", 
+  commodity_code: "123412341234", 
+  product_code: "098709870987", 
+  measure_units: "EA", 
+  tax_rate: "7%",
+  tax_amount: "0.70", 
+  item_discount: "0.00", 
+  line_item_total: "10.70"
+)
+
+payment.sale(amount: "13.91") # Sale Amount: $13.91
+
+# Makes the API Request with BluePay
+payment.process
+
+# If transaction was successful reads the responses from BluePay
+if payment.successful_transaction?  
+  puts "TRANSACTION STATUS: " + payment.get_status
+  puts "TRANSACTION MESSAGE: " + payment.get_message
+  puts "TRANSACTION ID: " + payment.get_trans_id
+  puts "AVS RESPONSE: " + payment.get_avs_code
+  puts "CVV2 RESPONSE: " + payment.get_cvv2_code
+  puts "MASKED PAYMENT ACCOUNT: " + payment.get_masked_account
+  puts "CARD TYPE: " + payment.get_card_type
+  puts "AUTH CODE: " + payment.get_auth_code
+else
+  puts payment.get_message
+end
+

data/test/Transactions/Check_Customer_Credit.rb

@@ -33,7 +33,7 @@ payment.set_customer_information(
 
 payment.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -54,4 +54,4 @@ if payment.successful_transaction?
   puts "AUTH CODE: " + payment.get_auth_code
 else
   puts payment.get_message
-end
+end

data/test/Transactions/Customer_Defined_Data.rb

@@ -35,7 +35,7 @@ payment.set_customer_information(
 
 payment.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -67,4 +67,4 @@ if payment.successful_transaction?
   puts "AUTH CODE: " + payment.get_auth_code
 else
   puts payment.get_message
-end
+end

data/test/Transactions/How_To_Use_Token.rb

@@ -39,4 +39,4 @@ if payment.successful_transaction?
   puts "AUTH CODE: " + payment.get_auth_code
 else
   puts payment.get_message
-end
+end

data/test/Transactions/Return_Funds.rb

@@ -36,7 +36,7 @@ payment.set_customer_information(
 
 payment.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -74,4 +74,4 @@ if payment.successful_transaction?
   puts "AUTH CODE: " + payment_return.get_auth_code
 else
   puts payment_return.get_message
-end
+end

data/test/Transactions/Store_Payment_Information.rb

@@ -33,7 +33,7 @@ payment.set_customer_information(
 
 payment.set_cc_information(
   cc_number: "4111111111111111", # Customer Credit Card Number
-  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cc_expiration: "1225", # Card Expiration Date: MMYY
   cvv2: "123" # Card CVV2
 )
 
@@ -54,4 +54,4 @@ if payment.successful_transaction?
   puts "AUTH CODE: " + payment.get_auth_code
 else
   puts payment.get_message
-end
+end

data/test/Transactions/Swipe.rb

@@ -30,7 +30,7 @@ payment.set_customer_information(
 )
 
 # Set payment information for a swiped credit card transaction
-payment.swipe("%B4111111111111111^TEST/BLUEPAY^1911101100001100000000667000000?;4111111111111111=191110110000667?")
+payment.swipe("%B4111111111111111^TEST/BLUEPAY^2511101100001100000000667000000?;4111111111111111=251110110000667?")
 
 payment.sale(amount: "3.00") # Sale Amount: $3.00
 

data/test/Transactions/Update_Transaction.rb

@@ -0,0 +1,77 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 Credit Card Sale transaction
+# against a customer using test payment information. If
+# approved, a 2nd transaction is run to update the first transaction 
+# to $5.75, $2.75 more than the original $3.00.
+# If using TEST mode, odd dollar amounts will return
+# an approval and even dollar amounts will return a decline.
+##
+
+require_relative "../../lib/bluepay.rb"
+
+ACCOUNT_ID = "Merchant's Account ID"
+SECRET_KEY = "Merchant's Secret Key"
+MODE = "TEST"  
+
+payment = BluePay.new(
+  account_id: ACCOUNT_ID,  
+  secret_key: SECRET_KEY,  
+  mode: MODE
+)
+
+payment.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "123 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"  
+)
+
+payment.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1225", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+payment.sale(amount: "3.00") # Sale Amount: $3.00
+
+# Makes the API Request for processing the sale
+payment.process
+
+# If transaction was approved..
+if payment.successful_transaction?  
+
+  payment_update = BluePay.new(
+    account_id: ACCOUNT_ID,  
+    secret_key: SECRET_KEY,  
+    mode: MODE
+  )
+
+  # Creates an update transaction against previous sale
+  payment_update.update(
+    trans_id: payment.get_trans_id, # id of previous transaction to update
+    amount: "5.75" # add $2.75 to previous amount
+  )
+
+  # Makes the API Request to process update
+  payment_update.process
+
+  # Reads the response from BluePay
+  puts "TRANSACTION STATUS: " + payment_update.get_status
+  puts "TRANSACTION MESSAGE: " + payment_update.get_message
+  puts "TRANSACTION ID: " + payment_update.get_trans_id
+  puts "AVS RESPONSE: " + payment_update.get_avs_code
+  puts "CVV2 RESPONSE: " + payment_update.get_cvv2_code
+  puts "MASKED PAYMENT ACCOUNT: " + payment_update.get_masked_account
+  puts "CARD TYPE: " + payment_update.get_card_type
+  puts "AUTH CODE: " + payment_update.get_auth_code
+else
+  puts payment_update.get_message
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bluepay
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
-- Justin Slingerland, Susan Schmidt
+- Justin Slingerland, Susan Schmidt, Eric Margules
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies: []
 description: This gem is intended to be used along with a BluePay gateway account
   to process credit card and ACH transactions
@@ -17,14 +17,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README
+- Rakefile
+- bluepay.gemspec
 - lib/api_request.rb
 - lib/api_response.rb
 - lib/bluepay.rb
 - lib/cacert.pem
 - test/Get_Data/Retrieve_Settlement_Data.rb
-- test/Get_Data/retrieve_transaction_data.rb
+- test/Get_Data/Retrieve_Transaction_Data.rb
 - test/Get_Data/Single_Transaction_Query.rb
 - test/Get_Data/Transaction_Notification.rb
+- test/Get_Data/Validate_BP_Stamp.rb
 - test/Rebill/Cancel_Recurring_Payment.rb
 - test/Rebill/Create_Recurring_Payment_ACH.rb
 - test/Rebill/Create_Recurring_Payment_CC.rb
@@ -32,16 +36,15 @@ files:
 - test/Rebill/Update_Recurring_Payment.rb
 - test/Transactions/Cancel_Transaction.rb
 - test/Transactions/Charge_Customer_ACH.rb
-- test/Transactions/CHarge_Customer_CC.rb
+- test/Transactions/Charge_Customer_CC.rb
+- test/Transactions/Charge_Customer_CC_Lvl2_Lvl3.rb
 - test/Transactions/Check_Customer_Credit.rb
 - test/Transactions/Customer_Defined_Data.rb
 - test/Transactions/How_To_Use_Token.rb
 - test/Transactions/Return_Funds.rb
 - test/Transactions/Store_Payment_Information.rb
 - test/Transactions/Swipe.rb
-- bluepay.gemspec
-- Rakefile
-- README
+- test/Transactions/Update_Transaction.rb
 homepage: http://www.bluepay.com
 licenses:
 - GPL
@@ -52,17 +55,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: BluePay gateway rubygem