activemerchant 1.42.6 → 1.90.0

data/lib/active_merchant/billing/gateways/linkpoint.rb

@@ -2,7 +2,6 @@ require 'rexml/document'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-
     # Initialization Options
     # :login                Your store number
     # :pem                  The text of your linkpoint PEM file. Note
@@ -144,6 +143,8 @@ module ActiveMerchant #:nodoc:
         }.update(options)
 
         raise ArgumentError, "You need to pass in your pem file using the :pem parameter or set it globally using ActiveMerchant::Billing::LinkpointGateway.pem_file = File.read( File.dirname(__FILE__) + '/../mycert.pem' ) or similar" if @options[:pem].blank?
+
+        @options[:pem].strip!
       end
 
       # Send a purchase request with periodic options
@@ -166,14 +167,16 @@ module ActiveMerchant #:nodoc:
       # :comments               Uh... comments
       #
       def recurring(money, creditcard, options={})
-        requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily], :installments, :order_id )
+        ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE
+
+        requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily], :installments, :order_id)
 
         options.update(
-          :ordertype => "SALE",
-          :action => options[:action] || "SUBMIT",
+          :ordertype => 'SALE',
+          :action => options[:action] || 'SUBMIT',
           :installments => options[:installments] || 12,
-          :startdate => options[:startdate] || "immediate",
-          :periodicity => options[:periodicity].to_s || "monthly",
+          :startdate => options[:startdate] || 'immediate',
+          :periodicity => options[:periodicity].to_s || 'monthly',
           :comments => options[:comments] || nil,
           :threshold => options[:threshold] || 3
         )
@@ -184,7 +187,7 @@ module ActiveMerchant #:nodoc:
       def purchase(money, creditcard, options={})
         requires!(options, :order_id)
         options.update(
-          :ordertype => "SALE"
+          :ordertype => 'SALE'
         )
         commit(money, creditcard, options)
       end
@@ -197,7 +200,7 @@ module ActiveMerchant #:nodoc:
       def authorize(money, creditcard, options = {})
         requires!(options, :order_id)
         options.update(
-          :ordertype => "PREAUTH"
+          :ordertype => 'PREAUTH'
         )
         commit(money, creditcard, options)
       end
@@ -211,7 +214,7 @@ module ActiveMerchant #:nodoc:
       def capture(money, authorization, options = {})
         options.update(
           :order_id => authorization,
-          :ordertype => "POSTAUTH"
+          :ordertype => 'POSTAUTH'
         )
         commit(money, nil, options)
       end
@@ -220,7 +223,7 @@ module ActiveMerchant #:nodoc:
       def void(identification, options = {})
         options.update(
           :order_id => identification,
-          :ordertype => "VOID"
+          :ordertype => 'VOID'
         )
         commit(nil, nil, options)
       end
@@ -232,18 +235,30 @@ module ActiveMerchant #:nodoc:
       #
       def refund(money, identification, options = {})
         options.update(
-          :ordertype => "CREDIT",
+          :ordertype => 'CREDIT',
           :order_id => identification
         )
         commit(money, nil, options)
       end
 
       def credit(money, identification, options = {})
-        deprecated CREDIT_DEPRECATION_MESSAGE
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, identification, options)
       end
 
+      def supports_scrubbing
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
+          gsub(%r((<cardnumber>)\d+(</cardnumber>))i, '\1[FILTERED]\2').
+          gsub(%r((<cvmvalue>)\d+(</cvmvalue>))i, '\1[FILTERED]\2')
+      end
+
       private
+
       # Commit the transaction by posting the XML file to the LinkPoint server
       def commit(money, creditcard, options = {})
         response = parse(ssl_post(test? ? self.test_url : self.live_url, post_data(money, creditcard, options)))
@@ -251,13 +266,13 @@ module ActiveMerchant #:nodoc:
         Response.new(successful?(response), response[:message], response,
           :test => test?,
           :authorization => response[:ordernum],
-          :avs_result => { :code => response[:avs].to_s[2,1] },
-          :cvv_result => response[:avs].to_s[3,1]
+          :avs_result => { :code => response[:avs].to_s[2, 1] },
+          :cvv_result => response[:avs].to_s[3, 1]
         )
       end
 
       def successful?(response)
-        response[:approved] == "APPROVED"
+        response[:approved] == 'APPROVED'
       end
 
       # Build the XML file
@@ -265,11 +280,11 @@ module ActiveMerchant #:nodoc:
         params = parameters(money, creditcard, options)
 
         xml = REXML::Document.new
-        order = xml.add_element("order")
+        order = xml.add_element('order')
 
         # Merchant Info
-        merchantinfo = order.add_element("merchantinfo")
-        merchantinfo.add_element("configfile").text = @options[:login]
+        merchantinfo = order.add_element('merchantinfo')
+        merchantinfo.add_element('configfile').text = @options[:login]
 
         # Loop over the params hash to construct the XML string
         for key, value in params
@@ -277,7 +292,7 @@ module ActiveMerchant #:nodoc:
           if key == :items
             build_items(elem, value)
           else
-            for k, v in params[key]
+            for k, _ in params[key]
               elem.add_element(k.to_s).text = params[key][k].to_s if params[key][k]
             end
           end
@@ -290,14 +305,14 @@ module ActiveMerchant #:nodoc:
       # adds LinkPoint's Items entity to the XML.  Called from post_data
       def build_items(element, items)
         for item in items
-          item_element = element.add_element("item")
+          item_element = element.add_element('item')
           for key, value in item
             if key == :options
-              options_element = item_element.add_element("options")
+              options_element = item_element.add_element('options')
               for option in value
-                opt_element = options_element.add_element("option")
-                opt_element.add_element("name").text =  option[:name]   unless option[:name].blank?
-                opt_element.add_element("value").text =  option[:value]   unless option[:value].blank?
+                opt_element = options_element.add_element('option')
+                opt_element.add_element('name').text =  option[:name]   unless option[:name].blank?
+                opt_element.add_element('value').text =  option[:value]   unless option[:value].blank?
               end
             else
               item_element.add_element(key.to_s).text =  item[key].to_s unless item[key].blank?
@@ -309,7 +324,6 @@ module ActiveMerchant #:nodoc:
       # Set up the parameters hash just once so we don't have to do it
       # for every action.
       def parameters(money, creditcard, options = {})
-
         params = {
           :payment => {
             :subtotal => amount(options[:subtotal]),
@@ -319,14 +333,14 @@ module ActiveMerchant #:nodoc:
             :chargetotal => amount(money)
           },
           :transactiondetails => {
-            :transactionorigin => options[:transactionorigin] || "ECI",
+            :transactionorigin => options[:transactionorigin] || 'ECI',
             :oid => options[:order_id],
             :ponumber => options[:ponumber],
             :taxexempt => options[:taxexempt],
             :terminaltype => options[:terminaltype],
             :ip => options[:ip],
             :reference_number => options[:reference_number],
-            :recurring => options[:recurring] || "NO",  #DO NOT USE if you are using the periodic billing option.
+            :recurring => options[:recurring] || 'NO',  # DO NOT USE if you are using the periodic billing option.
             :tdate => options[:tdate]
           },
           :orderoptions => {
@@ -403,7 +417,6 @@ module ActiveMerchant #:nodoc:
       end
 
       def parse(xml)
-
         # For reference, a typical response...
         # <r_csp></r_csp>
         # <r_time></r_time>
@@ -418,29 +431,18 @@ module ActiveMerchant #:nodoc:
         # <r_approved>APPROVED</r_approved>
         # <r_avs></r_avs>
 
-        response = {:message => "Global Error Receipt", :complete => false}
+        response = {:message => 'Global Error Receipt', :complete => false}
 
         xml = REXML::Document.new("<response>#{xml}</response>")
-        xml.root.elements.each do |node|
+        xml.root&.elements&.each do |node|
           response[node.name.downcase.sub(/^r_/, '').to_sym] = normalize(node.text)
-        end unless xml.root.nil?
+        end
 
         response
       end
 
-      # Make a ruby type out of the response string
-      def normalize(field)
-        case field
-        when "true"   then true
-        when "false"  then false
-        when ""       then nil
-        when "null"   then nil
-        else field
-        end
-      end
-
       def format_creditcard_expiry_year(year)
-        sprintf("%.4i", year)[-2..-1]
+        sprintf('%.4i', year)[-2..-1]
       end
     end
   end