activemerchant 1.100.0 → 1.133.0

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

@@ -11,14 +11,14 @@ module ActiveMerchant #:nodoc:
       self.supported_countries = ['US']
       self.default_currency = 'USD'
       self.money_format = :dollars
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
+      self.supported_cardtypes = %i[visa master american_express discover diners_club jcb]
 
-      def initialize(options={})
+      def initialize(options = {})
         requires!(options, :account_id, :merchant_pin)
         super
       end
 
-      def purchase(amount, payment_method, options={})
+      def purchase(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_payment_method(post, payment_method)
@@ -27,7 +27,7 @@ module ActiveMerchant #:nodoc:
         commit(payment_method.is_a?(String) ? :stored_purchase : :purchase, post)
       end
 
-      def authorize(amount, payment_method, options={})
+      def authorize(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_payment_method(post, payment_method)
@@ -36,7 +36,7 @@ module ActiveMerchant #:nodoc:
         commit(:authorize, post)
       end
 
-      def capture(amount, authorization, options={})
+      def capture(amount, authorization, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -45,14 +45,14 @@ module ActiveMerchant #:nodoc:
         commit(:capture, post)
       end
 
-      def void(authorization, options={})
+      def void(authorization, options = {})
         post = {}
         add_reference(post, authorization)
 
         commit(:void, post)
       end
 
-      def refund(amount, authorization, options={})
+      def refund(amount, authorization, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_reference(post, authorization)
@@ -61,7 +61,7 @@ module ActiveMerchant #:nodoc:
         commit(:refund, post)
       end
 
-      def credit(amount, payment_method, options={})
+      def credit(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
         add_payment_method(post, payment_method)
@@ -69,7 +69,7 @@ module ActiveMerchant #:nodoc:
         commit(payment_method.is_a?(String) ? :stored_credit : :credit, post)
       end
 
-      def verify(credit_card, options={})
+      def verify(credit_card, options = {})
         MultiResponse.run(:use_first_response) do |r|
           r.process { authorize(100, credit_card, options) }
           r.process(:ignore_result) { void(r.authorization, options) }
@@ -110,10 +110,10 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_payment_method(post, payment_method)
-        if(payment_method.is_a?(String))
-          user_profile_id, last_4 = split_authorization(payment_method)
+        if payment_method.is_a?(String)
+          user_profile_id, last4 = split_authorization(payment_method)
           post[:userprofileid] = user_profile_id
-          post[:last4digits] = last_4
+          post[:last4digits] = last4
         else
           post[:ccname] = payment_method.name
           post[:ccnum] = payment_method.number
@@ -127,13 +127,13 @@ module ActiveMerchant #:nodoc:
       def add_customer_data(post, options)
         post[:email] = options[:email] if options[:email]
         post[:ipaddress] = options[:ip] if options[:ip]
-        if(billing_address = options[:billing_address])
+        if (billing_address = options[:billing_address])
           post[:billaddr1] = billing_address[:address1]
           post[:billaddr2] = billing_address[:address2]
           post[:billcity] = billing_address[:city]
           post[:billstate] = billing_address[:state]
           post[:billcountry] = billing_address[:country]
-          post[:bilzip]    = billing_address[:zip]
+          post[:bilzip] = billing_address[:zip]
           post[:phone] = billing_address[:phone]
         end
       end
@@ -172,20 +172,20 @@ module ActiveMerchant #:nodoc:
           message_from(succeeded, response_data),
           response_data,
           authorization: authorization_from(post, response_data),
-          :avs_result => AVSResult.new(code: response_data['avs_response']),
-          :cvv_result => CVVResult.new(response_data['cvv2_response']),
+          avs_result: AVSResult.new(code: response_data['avs_response']),
+          cvv_result: CVVResult.new(response_data['cvv2_response']),
           test: test?
         )
       end
 
       def headers
         {
-          'Content-Type'  => 'application/xml'
+          'Content-Type' => 'application/xml'
         }
       end
 
       def build_request(post)
-        Nokogiri::XML::Builder.new(:encoding => 'utf-8') do |xml|
+        Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
           xml.interface_driver {
             xml.trans_catalog {
               xml.transaction(name: 'creditcard') {
@@ -235,7 +235,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def error_message_from(response)
-        if(response[:status] == 'Declined')
+        if response[:status] == 'Declined'
           match = response[:result].match(/DECLINED:\d{10}:(.+):/)
           match[1] if match
         end

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

@@ -7,27 +7,27 @@ module ActiveMerchant #:nodoc:
       self.v4_live_url = 'https://ps1.merchantware.net/Merchantware/ws/RetailTransaction/v4/Credit.asmx'
 
       self.supported_countries = ['US']
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.supported_cardtypes = %i[visa master american_express discover]
       self.homepage_url = 'http://merchantwarehouse.com/merchantware'
       self.display_name = 'MerchantWARE'
 
       ENV_NAMESPACES = { 'xmlns:xsi'  => 'http://www.w3.org/2001/XMLSchema-instance',
                          'xmlns:xsd'  => 'http://www.w3.org/2001/XMLSchema',
-                         'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/'}
+                         'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/' }
       ENV_NAMESPACES_V4 = { 'xmlns:xsi'  => 'http://www.w3.org/2001/XMLSchema-instance',
                             'xmlns:xsd'  => 'http://www.w3.org/2001/XMLSchema',
-                            'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/'}
+                            'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/' }
 
       TX_NAMESPACE = 'http://merchantwarehouse.com/MerchantWARE/Client/TransactionRetail'
       TX_NAMESPACE_V4 = 'http://schemas.merchantwarehouse.com/merchantware/40/Credit/'
 
       ACTIONS = {
-        :purchase  => 'IssueKeyedSale',
-        :authorize => 'IssueKeyedPreAuth',
-        :capture   => 'IssuePostAuth',
-        :void      => 'VoidPreAuthorization',
-        :credit    => 'IssueKeyedRefund',
-        :reference_credit => 'IssueRefundByReference'
+        purchase: 'IssueKeyedSale',
+        authorize: 'IssueKeyedPreAuth',
+        capture: 'IssuePostAuth',
+        void: 'VoidPreAuthorization',
+        credit: 'IssueKeyedRefund',
+        reference_credit: 'IssueRefundByReference'
       }
 
       # Creates a new MerchantWareGateway
@@ -117,7 +117,7 @@ module ActiveMerchant #:nodoc:
       private
 
       def soap_request(action)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
         xml.tag! 'env:Envelope', ENV_NAMESPACES do
           xml.tag! 'env:Body' do
@@ -131,7 +131,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def v4_soap_request(action)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
         xml.tag! 'soap:Envelope', ENV_NAMESPACES_V4 do
           xml.tag! 'soap:Body' do
@@ -272,7 +272,7 @@ module ActiveMerchant #:nodoc:
           response[element.name] = element.text
         end
 
-        response[:message] = response['faultstring'].to_s.gsub("\n", ' ')
+        response[:message] = response['faultstring'].to_s.tr("\n", ' ')
         response
       rescue REXML::ParseException
         response[:http_body]        = http_response.body
@@ -292,25 +292,21 @@ module ActiveMerchant #:nodoc:
         begin
           data = ssl_post(url(v4), request,
             'Content-Type' => 'text/xml; charset=utf-8',
-            'SOAPAction'   => soap_action(action, v4)
-          )
+            'SOAPAction'   => soap_action(action, v4))
           response = parse(action, data)
         rescue ActiveMerchant::ResponseError => e
           response = parse_error(e.response)
         end
 
         Response.new(response[:success], response[:message], response,
-          :test => test?,
-          :authorization => authorization_from(response),
-          :avs_result => { :code => response['AVSResponse'] },
-          :cvv_result => response['CVResponse']
-        )
+          test: test?,
+          authorization: authorization_from(response),
+          avs_result: { code: response['AVSResponse'] },
+          cvv_result: response['CVResponse'])
       end
 
       def authorization_from(response)
-        if response[:success]
-          [ response['ReferenceID'], response['OrderNumber'] ].join(';')
-        end
+        [response['ReferenceID'], response['OrderNumber']].join(';') if response[:success]
       end
     end
   end

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

@@ -5,7 +5,7 @@ module ActiveMerchant #:nodoc:
       self.test_url = 'https://ps1.merchantware.net/Merchantware/ws/RetailTransaction/v4/Credit.asmx'
 
       self.supported_countries = ['US']
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.supported_cardtypes = %i[visa master american_express discover]
       self.homepage_url = 'http://merchantwarehouse.com/merchantware'
       self.display_name = 'MerchantWARE'
 
@@ -16,12 +16,12 @@ module ActiveMerchant #:nodoc:
       TX_NAMESPACE = 'http://schemas.merchantwarehouse.com/merchantware/40/Credit/'
 
       ACTIONS = {
-        :purchase  => 'SaleKeyed',
-        :reference_purchase => 'RepeatSale',
-        :authorize => 'PreAuthorizationKeyed',
-        :capture   => 'PostAuthorization',
-        :void      => 'Void',
-        :refund    => 'Refund'
+        purchase: 'SaleKeyed',
+        reference_purchase: 'RepeatSale',
+        authorize: 'PreAuthorizationKeyed',
+        capture: 'PostAuthorization',
+        void: 'Void',
+        refund: 'Refund'
       }
 
       # Creates a new MerchantWareVersionFourGateway
@@ -108,7 +108,7 @@ module ActiveMerchant #:nodoc:
         commit(:refund, request)
       end
 
-      def verify(credit_card, options={})
+      def verify(credit_card, options = {})
         MultiResponse.run(:use_first_response) do |r|
           r.process { authorize(100, credit_card, options) }
           r.process(:ignore_result) { void(r.authorization, options) }
@@ -129,7 +129,7 @@ module ActiveMerchant #:nodoc:
       private
 
       def soap_request(action)
-        xml = Builder::XmlMarkup.new :indent => 2
+        xml = Builder::XmlMarkup.new indent: 2
         xml.instruct!
         xml.tag! 'soap:Envelope', ENV_NAMESPACES do
           xml.tag! 'soap:Body' do
@@ -243,7 +243,7 @@ module ActiveMerchant #:nodoc:
           response[element.name] = element.text
         end
 
-        response[:message] = response['ErrorMessage'].to_s.gsub("\n", ' ')
+        response[:message] = response['ErrorMessage'].to_s.tr("\n", ' ')
         response
       rescue REXML::ParseException
         response[:http_body]        = http_response.body
@@ -263,19 +263,17 @@ module ActiveMerchant #:nodoc:
         begin
           data = ssl_post(url, request,
             'Content-Type' => 'text/xml; charset=utf-8',
-            'SOAPAction'   => soap_action(action)
-          )
+            'SOAPAction'   => soap_action(action))
           response = parse(action, data)
         rescue ActiveMerchant::ResponseError => e
           response = parse_error(e.response, action)
         end
 
         Response.new(response[:success], response[:message], response,
-          :test => test?,
-          :authorization => authorization_from(response),
-          :avs_result => { :code => response['AvsResponse'] },
-          :cvv_result => response['CvResponse']
-        )
+          test: test?,
+          authorization: authorization_from(response),
+          avs_result: { code: response['AvsResponse'] },
+          cvv_result: response['CvResponse'])
       end
 
       def authorization_from(response)

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

@@ -11,8 +11,8 @@ module ActiveMerchant #:nodoc:
       POST_LIVE_URL = 'https://api.merchantwarrior.com/post/'
 
       self.supported_countries = ['AU']
-      self.supported_cardtypes = [:visa, :master, :american_express,
-                                  :diners_club, :discover, :jcb]
+      self.supported_cardtypes = %i[visa master american_express
+                                    diners_club discover jcb]
       self.homepage_url = 'https://www.merchantwarrior.com/'
       self.display_name = 'Merchant Warrior'
 
@@ -30,6 +30,8 @@ module ActiveMerchant #:nodoc:
         add_order_id(post, options)
         add_address(post, options)
         add_payment_method(post, payment_method)
+        add_recurring_flag(post, options)
+        add_soft_descriptors(post, options)
         commit('processAuth', post)
       end
 
@@ -39,6 +41,8 @@ module ActiveMerchant #:nodoc:
         add_order_id(post, options)
         add_address(post, options)
         add_payment_method(post, payment_method)
+        add_recurring_flag(post, options)
+        add_soft_descriptors(post, options)
         commit('processCard', post)
       end
 
@@ -46,6 +50,7 @@ module ActiveMerchant #:nodoc:
         post = {}
         add_amount(post, money, options)
         add_transaction(post, identification)
+        add_soft_descriptors(post, options)
         post['captureAmount'] = amount(money)
         commit('processCapture', post)
       end
@@ -54,10 +59,21 @@ module ActiveMerchant #:nodoc:
         post = {}
         add_amount(post, money, options)
         add_transaction(post, identification)
+        add_soft_descriptors(post, options)
         post['refundAmount'] = amount(money)
         commit('refundCard', post)
       end
 
+      def void(identification, options = {})
+        post = {}
+        # The amount parameter is required for void transactions
+        # on the Merchant Warrior gateway.
+        post['transactionAmount'] = options[:amount]
+        post['hash'] = void_verification_hash(identification)
+        add_transaction(post, identification)
+        commit('processVoid', post)
+      end
+
       def store(creditcard, options = {})
         post = {
           'cardName' => scrub_name(creditcard.name),
@@ -87,7 +103,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_address(post, options)
-        return unless(address = (options[:billing_address] || options[:address]))
+        return unless (address = (options[:billing_address] || options[:address]))
 
         post['customerName'] = scrub_name(address[:name])
         post['customerCountry'] = address[:country]
@@ -135,6 +151,18 @@ module ActiveMerchant #:nodoc:
         post['hash'] = verification_hash(amount(money), currency)
       end
 
+      def add_recurring_flag(post, options)
+        return if options[:recurring_flag].nil?
+
+        post['recurringFlag'] = options[:recurring_flag]
+      end
+
+      def add_soft_descriptors(post, options)
+        post['descriptorName'] = options[:descriptor_name] if options[:descriptor_name]
+        post['descriptorCity'] = options[:descriptor_city] if options[:descriptor_city]
+        post['descriptorState'] = options[:descriptor_state] if options[:descriptor_state]
+      end
+
       def verification_hash(money, currency)
         Digest::MD5.hexdigest(
           (
@@ -146,9 +174,21 @@ module ActiveMerchant #:nodoc:
         )
       end
 
+      def void_verification_hash(transaction_id)
+        Digest::MD5.hexdigest(
+          (
+            @options[:api_passphrase].to_s +
+            @options[:merchant_uuid].to_s +
+            transaction_id
+          ).downcase
+        )
+      end
+
       def parse(body)
         xml = REXML::Document.new(body)
 
+        return { response_message: 'Invalid gateway response' } unless xml.root.present?
+
         response = {}
         xml.root.elements.to_a.each do |node|
           parse_element(response, node)
@@ -173,17 +213,15 @@ module ActiveMerchant #:nodoc:
           success?(response),
           response[:response_message],
           response,
-          :test => test?,
-          :authorization => (response[:card_id] || response[:transaction_id])
+          test: test?,
+          authorization: (response[:card_id] || response[:transaction_id])
         )
       end
 
       def add_auth(action, post)
         post['merchantUUID'] = @options[:merchant_uuid]
         post['apiKey'] = @options[:api_key]
-        unless token?(post)
-          post['method'] = action
-        end
+        post['method'] = action unless token?(post)
       end
 
       def url_for(action, post)

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

@@ -12,14 +12,14 @@ module ActiveMerchant #:nodoc:
     # and +refund+ will become mandatory.
     class MercuryGateway < Gateway
       URLS = {
-        :test => 'https://w1.mercurycert.net/ws/ws.asmx',
-        :live => 'https://w1.mercurypay.com/ws/ws.asmx'
+        test: 'https://w1.mercurycert.net/ws/ws.asmx',
+        live: 'https://w1.mercurypay.com/ws/ws.asmx'
       }
 
       self.homepage_url = 'http://www.mercurypay.com'
       self.display_name = 'Mercury'
-      self.supported_countries = ['US', 'CA']
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
+      self.supported_countries = %w[US CA]
+      self.supported_cardtypes = %i[visa master american_express discover diners_club jcb]
       self.default_currency = 'USD'
 
       STANDARD_ERROR_CODE_MAPPING = {
@@ -51,14 +51,14 @@ module ActiveMerchant #:nodoc:
       def authorize(money, credit_card, options = {})
         requires!(options, :order_id)
 
-        request = build_non_authorized_request('PreAuth', money, credit_card, options.merge(:authorized => money))
+        request = build_non_authorized_request('PreAuth', money, credit_card, options.merge(authorized: money))
         commit('PreAuth', request)
       end
 
       def capture(money, authorization, options = {})
         requires!(options, :credit_card) unless @use_tokenization
 
-        request = build_authorized_request('PreAuthCapture', money, authorization, options[:credit_card], options.merge(:authorized => money))
+        request = build_authorized_request('PreAuthCapture', money, authorization, options[:credit_card], options.merge(authorized: money))
         commit('PreAuthCapture', request)
       end
 
@@ -69,14 +69,14 @@ module ActiveMerchant #:nodoc:
         commit('Return', request)
       end
 
-      def void(authorization, options={})
+      def void(authorization, options = {})
         requires!(options, :credit_card) unless @use_tokenization
 
         request = build_authorized_request('VoidSale', nil, authorization, options[:credit_card], options)
         commit('VoidSale', request)
       end
 
-      def store(credit_card, options={})
+      def store(credit_card, options = {})
         request = build_card_lookup_request(credit_card, options)
         commit('CardLookup', request)
       end
@@ -103,9 +103,7 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'Transaction' do
             xml.tag! 'TranType', 'Credit'
             xml.tag! 'TranCode', action
-            if options[:allow_partial_auth] && ['PreAuth', 'Sale'].include?(action)
-              xml.tag! 'PartialAuth', 'Allow'
-            end
+            xml.tag! 'PartialAuth', 'Allow' if options[:allow_partial_auth] && %w[PreAuth Sale].include?(action)
             add_invoice(xml, options[:order_id], nil, options)
             add_reference(xml, 'RecordNumberRequested')
             add_customer_data(xml, options)
@@ -126,9 +124,7 @@ module ActiveMerchant #:nodoc:
         xml.tag! 'TStream' do
           xml.tag! 'Transaction' do
             xml.tag! 'TranType', 'Credit'
-            if options[:allow_partial_auth] && (action == 'PreAuthCapture')
-              xml.tag! 'PartialAuth', 'Allow'
-            end
+            xml.tag! 'PartialAuth', 'Allow' if options[:allow_partial_auth] && (action == 'PreAuthCapture')
             xml.tag! 'TranCode', (@use_tokenization ? (action + 'ByRecordNo') : action)
             add_invoice(xml, invoice_no, ref_no, options)
             add_reference(xml, record_no)
@@ -215,11 +211,11 @@ module ActiveMerchant #:nodoc:
             # handle with the validation error as it sees fit.
             # Track 2 requires having the STX and ETX stripped. Track 1 does not.
             # Max-length track 1s require having the STX and ETX stripped. Max is 79 bytes including LRC.
-            is_track_2 = credit_card.track_data[0] == ';'
+            is_track2 = credit_card.track_data[0] == ';'
             etx_index = credit_card.track_data.rindex('?') || credit_card.track_data.length
             is_max_track1 = etx_index >= 77
 
-            if is_track_2
+            if is_track2
               xml.tag! 'Track2', credit_card.track_data[1...etx_index]
             elsif is_max_track1
               xml.tag! 'Track1', credit_card.track_data[1...etx_index]
@@ -234,7 +230,7 @@ module ActiveMerchant #:nodoc:
         xml.tag! 'CardType', CARD_CODES[credit_card.brand] if credit_card.brand
 
         include_cvv = !%w(Return PreAuthCapture).include?(action) && !credit_card.track_data.present?
-        xml.tag! 'CVVData', credit_card.verification_value if(include_cvv && credit_card.verification_value)
+        xml.tag! 'CVVData', credit_card.verification_value if include_cvv && credit_card.verification_value
       end
 
       def add_address(xml, options)
@@ -298,7 +294,7 @@ module ActiveMerchant #:nodoc:
         }
       end
 
-      SUCCESS_CODES = [ 'Approved', 'Success' ]
+      SUCCESS_CODES = %w[Approved Success]
 
       def commit(action, request)
         response = parse(action, ssl_post(endpoint_url, build_soap_request(request), build_header))
@@ -307,11 +303,11 @@ module ActiveMerchant #:nodoc:
         message = success ? 'Success' : message_from(response)
 
         Response.new(success, message, response,
-          :test => test?,
-          :authorization => authorization_from(response),
-          :avs_result => { :code => response[:avs_result] },
-          :cvv_result => response[:cvv_result],
-          :error_code => success ? nil : STANDARD_ERROR_CODE_MAPPING[response[:dsix_return_code]])
+          test: test?,
+          authorization: authorization_from(response),
+          avs_result: { code: response[:avs_result] },
+          cvv_result: response[:cvv_result],
+          error_code: success ? nil : STANDARD_ERROR_CODE_MAPPING[response[:dsix_return_code]])
       end
 
       def message_from(response)