activemerchant 1.42.6 → 1.90.0

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

@@ -0,0 +1,218 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class TrexleGateway < Gateway
+      self.test_url = 'https://core.trexle.com/api/v1'
+      self.live_url = 'https://core.trexle.com/api/v1'
+
+      self.default_currency = 'USD'
+      self.money_format = :cents
+      self.supported_countries = %w(AD AE AT AU BD BE BG BN CA CH CY CZ DE DK EE EG ES FI FR GB
+                                    GI GR HK HU ID IE IL IM IN IS IT JO KW LB LI LK LT LU LV MC
+                                    MT MU MV MX MY NL NO NZ OM PH PL PT QA RO SA SE SG SI SK SM
+                                    TR TT UM US VA VN ZA)
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.homepage_url = 'https://trexle.com'
+      self.display_name = 'Trexle'
+
+      def initialize(options = {})
+        requires!(options, :api_key)
+        super
+      end
+
+      # Create a charge using a credit card, card token or customer token
+      #
+      # To charge a credit card: purchase([money], [creditcard hash], ...)
+      # To charge a customer: purchase([money], [token], ...)
+      def purchase(money, creditcard, options = {})
+        post = {}
+
+        add_amount(post, money, options)
+        add_customer_data(post, options)
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        commit(:post, 'charges', post, options)
+      end
+
+      # Create a customer and associated credit card. The token that is returned
+      # can be used instead of a credit card parameter in the purchase method
+      def store(creditcard, options = {})
+        post = {}
+
+        add_creditcard(post, creditcard)
+        add_customer_data(post, options)
+        add_address(post, creditcard, options)
+        commit(:post, 'customers', post, options)
+      end
+
+      # Refund a transaction
+      def refund(money, token, options = {})
+        commit(:post, "charges/#{CGI.escape(token)}/refunds", { amount: amount(money) }, options)
+      end
+
+      # Authorize an amount on a credit card. Once authorized, you can later
+      # capture this charge using the charge token that is returned.
+      def authorize(money, creditcard, options = {})
+        post = {}
+
+        add_amount(post, money, options)
+        add_customer_data(post, options)
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        post[:capture] = false
+        commit(:post, 'charges', post, options)
+      end
+
+      # Captures a previously authorized charge. Capturing only part of the original
+      # authorization is currently not supported.
+      def capture(money, token, options = {})
+        commit(:put, "charges/#{CGI.escape(token)}/capture", { amount: amount(money) }, options)
+      end
+
+      # Updates the credit card for the customer.
+      def update(token, creditcard, options = {})
+        post = {}
+
+        add_creditcard(post, creditcard)
+        add_customer_data(post, options)
+        add_address(post, creditcard, options)
+        commit(:put, "customers/#{CGI.escape(token)}", post, options)
+      end
+
+      def supports_scrubbing
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
+          gsub(/(number\\?":\\?")(\d*)/, '\1[FILTERED]').
+          gsub(/(cvc\\?":\\?")(\d*)/, '\1[FILTERED]')
+      end
+
+      private
+
+      def add_amount(post, money, options)
+        post[:amount] = amount(money)
+        post[:currency] = (options[:currency] || currency(money))
+        post[:currency] = post[:currency].upcase if post[:currency]
+      end
+
+      def add_customer_data(post, options)
+        post[:email] = options[:email] if options[:email]
+        post[:ip_address] = options[:ip] if options[:ip]
+      end
+
+      def add_address(post, creditcard, options)
+        return if creditcard.kind_of?(String)
+        address = (options[:billing_address] || options[:address])
+        return unless address
+
+        post[:card] ||= {}
+        post[:card].merge!(
+          address_line1: address[:address1],
+          address_line2: address[:address_line2],
+          address_city: address[:city],
+          address_postcode: address[:zip],
+          address_state: address[:state],
+          address_country: address[:country]
+        )
+      end
+
+      def add_invoice(post, options)
+        post[:description] = options[:description] || 'Active Merchant Purchase'
+      end
+
+      def add_creditcard(post, creditcard)
+        if creditcard.respond_to?(:number)
+          post[:card] ||= {}
+
+          post[:card].merge!(
+            number: creditcard.number,
+            expiry_month: creditcard.month,
+            expiry_year: creditcard.year,
+            cvc: creditcard.verification_value,
+            name: creditcard.name
+          )
+        elsif creditcard.kind_of?(String)
+          if creditcard =~ /^token_/
+            post[:card_token] = creditcard
+          else
+            post[:customer_token] = creditcard
+          end
+        end
+      end
+
+      def headers(params = {})
+        result = {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Basic #{Base64.strict_encode64(options[:api_key] + ':').strip}"
+        }
+
+        result['X-Partner-Key'] = params[:partner_key] if params[:partner_key]
+        result['X-Safe-Card'] = params[:safe_card] if params[:safe_card]
+        result
+      end
+
+      def commit(method, action, params, options)
+        url = "#{test? ? test_url : live_url}/#{action}"
+        raw_response = ssl_request(method, url, post_data(params), headers(options))
+        parsed_response = parse(raw_response)
+        success_response(parsed_response)
+      rescue ResponseError => e
+        error_response(parse(e.response.body))
+      rescue JSON::ParserError
+        unparsable_response(raw_response)
+      end
+
+      def success_response(body)
+        return invalid_response unless body['response']
+
+        response = body['response']
+        Response.new(
+          true,
+          response['status_message'],
+          body,
+          authorization: token(response),
+          test: test?
+        )
+      end
+
+      def error_response(body)
+        return invalid_response unless body['error']
+        Response.new(
+          false,
+          body['error'],
+          body,
+          authorization: nil,
+          test: test?
+        )
+      end
+
+      def unparsable_response(raw_response)
+        message = 'Invalid JSON response received from Trexle. Please contact support@trexle.com if you continue to receive this message.'
+        message += " (The raw response returned by the API was #{raw_response.inspect})"
+        return Response.new(false, message)
+      end
+
+      def invalid_response
+        message = 'Invalid response.'
+        return Response.new(false, message)
+      end
+
+      def token(response)
+        response['token']
+      end
+
+      def parse(body)
+        return {} if body.blank?
+        JSON.parse(body)
+      end
+
+      def post_data(parameters = {})
+        parameters.to_json
+      end
+    end
+  end
+end

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

@@ -19,10 +19,10 @@ module ActiveMerchant #:nodoc:
     # Next, create a credit card object using a TC approved test card.
     #
     #   creditcard = ActiveMerchant::Billing::CreditCard.new(
-    #	    :number => '4111111111111111',
-    #	    :month => 8,
-    #	    :year => 2006,
-    #	    :first_name => 'Longbob',
+    #     :number => '4111111111111111',
+    #     :month => 8,
+    #     :year => 2006,
+    #     :first_name => 'Longbob',
     #     :last_name => 'Longsen'
     #   )
     #
@@ -67,38 +67,38 @@ module ActiveMerchant #:nodoc:
     class TrustCommerceGateway < Gateway
       self.live_url = self.test_url = 'https://vault.trustcommerce.com/trans/'
 
-      SUCCESS_TYPES = ["approved", "accepted"]
+      SUCCESS_TYPES = ['approved', 'accepted']
 
       DECLINE_CODES = {
-        "decline"       => "The credit card was declined",
-        "avs"           => "AVS failed; the address entered does not match the billing address on file at the bank",
-        "cvv"           => "CVV failed; the number provided is not the correct verification number for the card",
-        "call"          => "The card must be authorized manually over the phone",
-        "expiredcard"   => "Issuer was not certified for card verification",
-        "carderror"     => "Card number is invalid",
-        "authexpired"   => "Attempt to postauth an expired (more than 14 days old) preauth",
-        "fraud"         => "CrediGuard fraud score was below requested threshold",
-        "blacklist"     => "CrediGuard blacklist value was triggered",
-        "velocity"      => "CrediGuard velocity control value was triggered",
-        "dailylimit"    => "Daily limit in transaction count or amount as been reached",
-        "weeklylimit"   => "Weekly limit in transaction count or amount as been reached",
-        "monthlylimit"  => "Monthly limit in transaction count or amount as been reached"
+        'decline'       => 'The credit card was declined',
+        'avs'           => 'AVS failed; the address entered does not match the billing address on file at the bank',
+        'cvv'           => 'CVV failed; the number provided is not the correct verification number for the card',
+        'call'          => 'The card must be authorized manually over the phone',
+        'expiredcard'   => 'Issuer was not certified for card verification',
+        'carderror'     => 'Card number is invalid',
+        'authexpired'   => 'Attempt to postauth an expired (more than 14 days old) preauth',
+        'fraud'         => 'CrediGuard fraud score was below requested threshold',
+        'blacklist'     => 'CrediGuard blacklist value was triggered',
+        'velocity'      => 'CrediGuard velocity control value was triggered',
+        'dailylimit'    => 'Daily limit in transaction count or amount as been reached',
+        'weeklylimit'   => 'Weekly limit in transaction count or amount as been reached',
+        'monthlylimit'  => 'Monthly limit in transaction count or amount as been reached'
       }
 
       BADDATA_CODES = {
-        "missingfields"       => "One or more parameters required for this transaction type were not sent",
-        "extrafields"         => "Parameters not allowed for this transaction type were sent",
-        "badformat"           => "A field was improperly formatted, such as non-digit characters in a number field",
-        "badlength"           => "A field was longer or shorter than the server allows",
-        "merchantcantaccept"  => "The merchant can't accept data passed in this field",
-        "mismatch"            => "Data in one of the offending fields did not cross-check with the other offending field"
+        'missingfields'       => 'One or more parameters required for this transaction type were not sent',
+        'extrafields'         => 'Parameters not allowed for this transaction type were sent',
+        'badformat'           => 'A field was improperly formatted, such as non-digit characters in a number field',
+        'badlength'           => 'A field was longer or shorter than the server allows',
+        'merchantcantaccept'  => "The merchant can't accept data passed in this field",
+        'mismatch'            => 'Data in one of the offending fields did not cross-check with the other offending field'
       }
 
       ERROR_CODES = {
-        "cantconnect"   => "Couldn't connect to the TrustCommerce gateway",
-        "dnsfailure"    => "The TCLink software was unable to resolve DNS hostnames",
-        "linkfailure"   => "The connection was established, but was severed before the transaction could complete",
-        "failtoprocess" => "The bank servers are offline and unable to authorize transactions"
+        'cantconnect'   => "Couldn't connect to the TrustCommerce gateway",
+        'dnsfailure'    => 'The TCLink software was unable to resolve DNS hostnames',
+        'linkfailure'   => 'The connection was established, but was severed before the transaction could complete',
+        'failtoprocess' => 'The bank servers are offline and unable to authorize transactions'
       }
 
       TEST_LOGIN = 'TestMerchant'
@@ -153,6 +153,7 @@ module ActiveMerchant #:nodoc:
         }
 
         add_order_id(parameters, options)
+        add_aggregator(parameters, options)
         add_customer_data(parameters, options)
         add_payment_source(parameters, creditcard_or_billing_id)
         add_addresses(parameters, options)
@@ -167,6 +168,7 @@ module ActiveMerchant #:nodoc:
         }
 
         add_order_id(parameters, options)
+        add_aggregator(parameters, options)
         add_customer_data(parameters, options)
         add_payment_source(parameters, creditcard_or_billing_id)
         add_addresses(parameters, options)
@@ -181,6 +183,7 @@ module ActiveMerchant #:nodoc:
           :amount => amount(money),
           :transid => authorization,
         }
+        add_aggregator(parameters, options)
 
         commit('postauth', parameters)
       end
@@ -192,12 +195,13 @@ module ActiveMerchant #:nodoc:
           :amount => amount(money),
           :transid => identification
         }
+        add_aggregator(parameters, options)
 
         commit('credit', parameters)
       end
 
       def credit(money, identification, options = {})
-        deprecated CREDIT_DEPRECATION_MESSAGE
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, identification, options)
       end
 
@@ -219,11 +223,12 @@ module ActiveMerchant #:nodoc:
         parameters = {
           :transid => authorization,
         }
+        add_aggregator(parameters, options)
 
         commit('reversal', parameters)
       end
 
-      # recurring() a TrustCommerce account that is activated for Citatdel, TrustCommerce's
+      # recurring() a TrustCommerce account that is activated for Citadel, TrustCommerce's
       # hosted customer billing info database.
       #
       # Recurring billing uses the same TC action as a plain-vanilla 'store', but we have a separate method for clarity. It can be called
@@ -235,7 +240,9 @@ module ActiveMerchant #:nodoc:
       #
       # You can optionally specify how long you want payments to continue using 'payments'
       def recurring(money, creditcard, options = {})
-        requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily] )
+        ActiveMerchant.deprecated RECURRING_DEPRECATION_MESSAGE
+
+        requires!(options, [:periodicity, :bimonthly, :monthly, :biweekly, :weekly, :yearly, :daily])
 
         cycle = case options[:periodicity]
         when :monthly
@@ -265,7 +272,7 @@ module ActiveMerchant #:nodoc:
         commit('store', parameters)
       end
 
-      # store() requires a TrustCommerce account that is activated for Citatdel. You can call it with a credit card and a billing ID
+      # store() requires a TrustCommerce account that is activated for Citadel. You can call it with a credit card and a billing ID
       # you would like to use to reference the stored credit card info for future captures. Use 'verify' to specify whether you want
       # to simply store the card in the DB, or you want TC to verify the data first.
 
@@ -290,24 +297,46 @@ module ActiveMerchant #:nodoc:
         commit('unstore', parameters)
       end
 
+      def supports_scrubbing
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
+          gsub(%r((&?cc=)\d*(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?password=)[^&]+(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?cvv=)\d*(&?)), '\1[FILTERED]\2')
+      end
+
       private
+
+      def add_aggregator(params, options)
+        if @options[:aggregator_id] || application_id != Gateway.application_id
+          params[:aggregators] = 1
+          params[:aggregator1] = @options[:aggregator_id] || application_id
+        end
+      end
+
       def add_payment_source(params, source)
         if source.is_a?(String)
           add_billing_id(params, source)
+        elsif card_brand(source) == 'check'
+          add_check(params, source)
         else
           add_creditcard(params, source)
         end
       end
 
-      def expdate(creditcard)
-        year  = sprintf("%.4i", creditcard.year)
-        month = sprintf("%.2i", creditcard.month)
-
-        "#{month}#{year[-2..-1]}"
+      def add_check(params, check)
+        params[:media] = 'ach'
+        params[:routing] = check.routing_number
+        params[:account] = check.account_number
+        params[:savings] = 'y' if check.account_type == 'savings'
       end
 
       def add_creditcard(params, creditcard)
-        params[:media]     = "cc"
+        params[:media]     = 'cc'
         params[:name]      = creditcard.name
         params[:cc]        = creditcard.number
         params[:exp]       = expdate(creditcard)
@@ -346,7 +375,7 @@ module ActiveMerchant #:nodoc:
           params[:shipto_address2] = shipping_address[:address2] unless shipping_address[:address2].blank?
           params[:shipto_city]     = shipping_address[:city]     unless shipping_address[:city].blank?
           params[:shipto_state]    = shipping_address[:state]    unless shipping_address[:state].blank?
-          params[:shipto_zip]	     = shipping_address[:zip]      unless shipping_address[:zip].blank?
+          params[:shipto_zip]      = shipping_address[:zip]      unless shipping_address[:zip].blank?
           params[:shipto_country]  = shipping_address[:country]  unless shipping_address[:country].blank?
         end
       end
@@ -355,7 +384,7 @@ module ActiveMerchant #:nodoc:
         # TCLink wants us to send a hash with string keys, and activemerchant pushes everything around with
         # symbol keys. Before sending our input to TCLink, we convert all our keys to strings and dump the symbol keys.
         # We also remove any pairs with nil values, as these confuse TCLink.
-        parameters.keys.reverse.each do |key|
+        parameters.keys.reverse_each do |key|
           if parameters[key]
             parameters[key.to_s] = parameters[key]
           end
@@ -364,7 +393,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def post_data(parameters)
-        parameters.collect { |key, value| "#{key}=#{ CGI.escape(value.to_s)}" }.join("&")
+        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
       end
 
       def commit(action, parameters)
@@ -376,19 +405,19 @@ module ActiveMerchant #:nodoc:
         clean_and_stringify_params(parameters)
 
         data = if tclink?
-          TCLink.send(parameters)
-        else
-          parse( ssl_post(self.live_url, post_data(parameters)) )
+                 TCLink.send(parameters)
+               else
+                 parse(ssl_post(self.live_url, post_data(parameters)))
         end
 
         # to be considered successful, transaction status must be either "approved" or "accepted"
-        success = SUCCESS_TYPES.include?(data["status"])
+        success = SUCCESS_TYPES.include?(data['status'])
         message = message_from(data)
         Response.new(success, message, data,
           :test => test?,
-          :authorization => data["transid"],
-          :cvv_result => data["cvv"],
-          :avs_result => { :code => data["avs"] }
+          :authorization => data['transid'],
+          :cvv_result => data['cvv'],
+          :avs_result => { :code => data['avs'] }
         )
       end
 
@@ -396,7 +425,7 @@ module ActiveMerchant #:nodoc:
         results = {}
 
         body.split(/\n/).each do |pair|
-          key,val = pair.split(/=/)
+          key, val = pair.split(/=/)
           results[key] = val
         end
 
@@ -404,15 +433,15 @@ module ActiveMerchant #:nodoc:
       end
 
       def message_from(data)
-        status = case data["status"]
-        when "decline"
-          return DECLINE_CODES[data["declinetype"]]
-        when "baddata"
-          return BADDATA_CODES[data["error"]]
-        when "error"
-          return ERROR_CODES[data["errortype"]]
+        case data['status']
+        when 'decline'
+          return DECLINE_CODES[data['declinetype']]
+        when 'baddata'
+          return BADDATA_CODES[data['error']]
+        when 'error'
+          return ERROR_CODES[data['errortype']]
         else
-          return "The transaction was successful"
+          return 'The transaction was successful'
         end
       end
 

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

@@ -9,15 +9,15 @@ module ActiveMerchant #:nodoc:
       self.abstract_class = true
 
       ##
-      # Creates an instance of UsaEpayTransactionGateway by default, but if 
+      # Creates an instance of UsaEpayTransactionGateway by default, but if
       # :software id or :live_url are passed in the options hash it will
       # create an instance of UsaEpayAdvancedGateway.
       #
       def self.new(options={})
-        unless options.has_key?(:software_id) || options.has_key?(:live_url)
-          UsaEpayTransactionGateway.new(options)
-        else
+        if options.has_key?(:software_id) || options.has_key?(:live_url)
           UsaEpayAdvancedGateway.new(options)
+        else
+          UsaEpayTransactionGateway.new(options)
         end
       end
     end