activemerchant 1.38.0 → 1.78.0

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

@@ -0,0 +1,219 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class CashnetGateway < Gateway
+      include Empty
+
+      self.live_url = "https://commerce.cashnet.com/"
+      self.test_url = "https://train.cashnet.com/"
+
+      self.supported_countries = ["US"]
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :diners_club, :jcb]
+      self.homepage_url        = "http://www.higherone.com/"
+      self.display_name        = "Cashnet"
+      self.money_format        = :dollars
+      self.max_retries         = 0
+
+      # Creates a new CashnetGateway
+      #
+      # ==== Options
+      #
+      # * <tt>:merchant</tt> -- Gateway Merchant (REQUIRED)
+      # * <tt>:operator</tt> -- Operator (REQUIRED)
+      # * <tt>:password</tt> -- Password (REQUIRED)
+      # * <tt>:merchant_gateway_name</tt> -- Site name (REQUIRED)
+      # * <tt>:station</tt> -- Station (defaults to "WEB")
+      # * <tt>:custcode</tt> -- Customer code (defaults to
+      #   "ActiveMerchant/#{ActiveMerchant::VERSION}")
+      # * <tt>:default_item_code</tt> -- Default item code (defaults to "FEE",
+      #   can be overridden on a per-transaction basis with options[:item_code])
+      def initialize(options = {})
+        requires!(
+          options,
+          :merchant,
+          :operator,
+          :password,
+          :merchant_gateway_name
+        )
+        options[:default_item_code] ||= "FEE"
+        super
+      end
+
+      def purchase(money, payment_object, options = {})
+        post = {}
+        add_creditcard(post, payment_object)
+        add_invoice(post, options)
+        add_address(post, options)
+        add_customer_data(post, options)
+        commit('SALE', money, post)
+      end
+
+      def refund(money, identification, options = {})
+        post = {}
+        post[:origtx]  = identification
+        add_invoice(post, options)
+        add_customer_data(post, options)
+        commit('REFUND', money, post)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript
+          .gsub(%r{(password=)[^&]+}, '\1[FILTERED]')
+          .gsub(%r{(cardno=)[^&]+}, '\1[FILTERED]')
+          .gsub(%r{(cid=)[^&]+}, '\1[FILTERED]')
+      end
+
+      private
+
+      def commit(action, money, fields)
+        fields[:amount] = amount(money)
+        url = (test? ? test_url : live_url) + CGI.escape(@options[:merchant_gateway_name])
+        raw_response = ssl_post(url, post_data(action, fields))
+        parsed_response = parse(raw_response)
+
+        return unparsable_response(raw_response) unless parsed_response
+
+        success = (parsed_response[:result] == '0')
+        Response.new(
+          success,
+          CASHNET_CODES[parsed_response[:result]],
+          parsed_response,
+          test:          test?,
+          authorization: (success ? parsed_response[:tx] : '')
+        )
+      end
+
+      def post_data(action, parameters = {})
+        post = {}
+        post[:command]        = action
+        post[:merchant]       = @options[:merchant]
+        post[:operator]       = @options[:operator]
+        post[:password]       = @options[:password]
+        post[:station]        = (@options[:station] || "WEB")
+        post[:custcode]       = (@options[:custcode] || "ActiveMerchant/#{ActiveMerchant::VERSION}")
+        post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:cardno]          = creditcard.number
+        post[:cid]             = creditcard.verification_value
+        post[:expdate]         = expdate(creditcard)
+        post[:card_name_g]     = creditcard.name
+        post[:fname]           = creditcard.first_name
+        post[:lname]           = creditcard.last_name
+      end
+
+      def add_invoice(post, options)
+        post[:order_number]    = options[:order_id] if options[:order_id].present?
+        post[:itemcode]       = (options[:item_code] || @options[:default_item_code])
+      end
+
+      def add_address(post, options)
+        if address = (options[:shipping_address] || options[:billing_address] || options[:address])
+          post[:addr_g]       = String(address[:address1]) + ',' + String(address[:address2])
+          post[:city_g]       = address[:city]
+          post[:state_g]      = address[:state]
+          post[:zip_g]        = address[:zip]
+        end
+      end
+
+      def add_customer_data(post, options)
+        post[:email_g]  = options[:email]
+        post[:custcode]  = options[:custcode] unless empty?(options[:custcode])
+      end
+
+      def expdate(creditcard)
+        year  = format(creditcard.year, :two_digits)
+        month = format(creditcard.month, :two_digits)
+
+        "#{month}#{year}"
+      end
+
+      def parse(body)
+        match = body.match(/<cngateway>(.*)<\/cngateway>/)
+        return nil unless match
+
+        Hash[CGI::parse(match[1]).map{|k,v| [k.to_sym,v.first]}]
+      end
+
+      def handle_response(response)
+        if (200...300).include?(response.code.to_i)
+          return response.body
+        elsif 302 == response.code.to_i
+          return ssl_get(URI.parse(response['location']))
+        end
+        raise ResponseError.new(response)
+      end
+
+      def unparsable_response(raw_response)
+        message = "Unparsable response received from Cashnet. Please contact Cashnet 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
+
+      CASHNET_CODES = {
+        '0' => 'Success',
+        '1' => 'Invalid customer code, no customer code specified',
+        '2' => 'Invalid operator code, no operator specified',
+        '3' => 'Invalid workstation code, no station specified',
+        '4' => 'Invalid item code, no code specified',
+        '5' => 'Negative amount is not allowed',
+        '6' => 'Invalid credit card number, no credit card number provided',
+        '7' => 'Invalid expiration date, no expiration date provided',
+        '8' => 'Please only provide either ACH or credit card information',
+        '9' => 'Invalid ACH account number, no account number provided',
+        '10' => 'Invalid routing/transit number, no routing/transit number provided',
+        '11' => 'Invalid account type, no account type provided',
+        '12' => 'Invalid check digit for routing/transit number',
+        '13' => 'No ACH merchant account set up for the location of the station being used',
+        '21' => 'Invalid merchant code, no merchant code provided',
+        '22' => 'Invalid client code, no client code provided',
+        '23' => 'Invalid password, no password provided',
+        '24' => 'Invalid transaction type, no transaction type provided',
+        '25' => 'Invalid amount, amount not provided',
+        '26' => 'Invalid payment code provided',
+        '27' => 'Invalid version number, version not found',
+        '31' => 'Application amount exceeds account balance',
+        '150' => 'Invalid payment information, no payment information provided',
+        '200' => 'Invalid command',
+        '201' => 'Customer not on file',
+        '205' => 'Invalid operator or password',
+        '206' => 'Operator is not authorized for this function',
+        '208' => 'Customer/PIN authentication unsuccessful',
+        '209' => 'Credit card error',
+        '211' => 'Credit card error',
+        '212' => 'Customer/PIN not on file',
+        '213' => 'Customer information not on file',
+        '215' => 'Old PIN does not validate ',
+        '221' => 'Invalid credit card processor type specified in location or payment code',
+        '222' => 'Credit card processor error',
+        '280' => 'SmartPay transaction not posted',
+        '301' => 'Original transaction not found for this customer',
+        '302' => 'Amount to refund exceeds original payment amount or is missing',
+        '304' => 'Original credit card payment not found or corrupted',
+        '305' => 'Refund amounts should be expressed as positive amounts',
+        '306' => 'Original ACH payment not found',
+        '307' => 'Original electronic payment not found',
+        '308' => 'Invalid original transaction number, original transaction number not found',
+        '310' => 'Refund amount exceeds amount still available for a refund',
+        '321' => 'Store has not been implemented',
+        '501' => 'Unable to roll over batch',
+        '502' => 'Batch not found',
+        '503' => 'Batch information not available',
+        '650' => 'Invalid quick code',
+        '651' => 'Transaction amount does not match amount specified in quick code',
+        '652' => 'Invalid item code in the detail of the quick code',
+        '701' => 'This website has been disabled. Please contact the system administrator.',
+        '702' => 'Improper merchant code. Please contact the system administrator.',
+        '703' => 'This site is temporarily down for maintenance. We regret the inconvenience. Please try again later.',
+        '704' => 'Duplicate item violation. Please contact the system administrator.',
+        '705' => 'An invalid reference type has been passed into the system. Please contact the system administrator',
+        '706' => 'Items violating unique selection have been passed in. Please contact the system administrator.',
+        '999' => 'An unexpected error has occurred. Please consult the event log.'
+      }
+    end
+  end
+end

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

@@ -33,6 +33,18 @@ module ActiveMerchant #:nodoc:
         commit(build_capture_request(money, authorization, options))
       end
 
+      def void(authorization, options = {})
+        commit(build_void_request(authorization, options))
+      end
+
+      def refund(money, authorization, options = {})
+        commit(build_authorization_credit_request(money, authorization, options))
+      end
+
+      def credit(money, creditcard, options = {})
+        commit(build_creditcard_credit_request(money, creditcard, options))
+      end
+
       protected
 
       def build_sale_request(type, money, creditcard, options = {})
@@ -75,6 +87,39 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def build_void_request(authorization, options = {})
+        xml = Builder::XmlMarkup.new :indent => 2
+
+        xml.tag! 'CC5Request' do
+          add_login_tags(xml)
+          xml.tag! 'OrderId', authorization
+          xml.tag! 'Type', 'Void'
+        end
+      end
+
+      def build_authorization_credit_request(money, authorization, options = {})
+        xml = Builder::XmlMarkup.new :indent => 2
+
+        xml.tag! 'CC5Request' do
+          add_login_tags(xml)
+          xml.tag! 'OrderId', authorization
+          xml.tag! 'Type', 'Credit'
+          add_amount_tags(money, options, xml)
+        end
+      end
+
+      def build_creditcard_credit_request(money, creditcard, options = {})
+        xml = Builder::XmlMarkup.new :indent => 2
+
+        xml.tag! 'CC5Request' do
+          add_login_tags(xml)
+          xml.tag! 'Type', 'Credit'
+          xml.tag! 'Number', creditcard.number
+
+          add_amount_tags(money, options, xml)
+        end
+      end
+
       def add_address(xml, address)
         xml.tag! 'Name', normalize(address[:name])
         xml.tag! 'Street1', normalize(address[:address1])

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

@@ -0,0 +1,239 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class CecabankGateway < Gateway
+      self.test_url = 'http://tpv.ceca.es:8000'
+      self.live_url = 'https://pgw.ceca.es'
+
+      self.supported_countries = ['ES']
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.homepage_url = 'http://www.ceca.es/es/'
+      self.display_name = 'Cecabank'
+      self.default_currency = 'EUR'
+      self.money_format = :cents
+
+      #### CECA's MAGIC NUMBERS
+      CECA_NOTIFICATIONS_URL = 'NONE'
+      CECA_ENCRIPTION = 'SHA1'
+      CECA_DECIMALS = '2'
+      CECA_MODE = 'SSL'
+      CECA_UI_LESS_LANGUAGE = 'XML'
+      CECA_UI_LESS_LANGUAGE_REFUND = '1'
+      CECA_UI_LESS_REFUND_PAGE = 'anulacion_xml'
+      CECA_ACTION_REFUND   = 'tpvanularparcialmente' #use partial refund's URL to avoid time frame limitations and decision logic on client side
+      CECA_ACTION_PURCHASE = 'tpv'
+      CECA_CURRENCIES_DICTIONARY = {'EUR' => 978, 'USD' => 840, 'GBP' => 826}
+
+      # Creates a new CecabankGateway
+      #
+      # The gateway requires four values for connection to be passed
+      # in the +options+ hash.
+      #
+      # ==== Options
+      #
+      # * <tt>:merchant_id</tt>  -- Cecabank's merchant_id (REQUIRED)
+      # * <tt>:acquirer_bin</tt> -- Cecabank's acquirer_bin (REQUIRED)
+      # * <tt>:terminal_id</tt>  -- Cecabank's terminal_id (REQUIRED)
+      # * <tt>:key</tt>          -- Cecabank's cypher key (REQUIRED)
+      # * <tt>:test</tt> -- +true+ or +false+. If true, perform transactions against the test server.
+      #   Otherwise, perform transactions against the production server.
+      def initialize(options = {})
+        requires!(options, :merchant_id, :acquirer_bin, :terminal_id, :key)
+        super
+      end
+
+      # Perform a purchase, which is essentially an authorization and capture in a single operation.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be purchased as an Integer value in cents.
+      # * <tt>creditcard</tt> -- The CreditCard details for the transaction.
+      # * <tt>options</tt> -- A hash of optional parameters.
+      #
+      # ==== Options
+      #
+      # * <tt>:order_id</tt>    -- order_id passed used purchase. (REQUIRED)
+      # * <tt>:currency</tt>    -- currency. Supported: EUR, USD, GBP.
+      # * <tt>:description</tt> -- description to be pased to the gateway.
+      def purchase(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        post = {'Descripcion' => options[:description],
+                'Num_operacion' => options[:order_id],
+                'Idioma' => CECA_UI_LESS_LANGUAGE,
+                'Pago_soportado' => CECA_MODE,
+                'URL_OK' => CECA_NOTIFICATIONS_URL,
+                'URL_NOK' => CECA_NOTIFICATIONS_URL,
+                'Importe' => amount(money),
+                'TipoMoneda' => CECA_CURRENCIES_DICTIONARY[options[:currency] || currency(money)]}
+
+        add_creditcard(post, creditcard)
+
+        commit(CECA_ACTION_PURCHASE, post)
+      end
+
+      # Refund a transaction.
+      #
+      # This transaction indicates to the gateway that
+      # money should flow from the merchant to the customer.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be credited to the customer as an Integer value in cents.
+      # * <tt>identification</tt> -- The reference given from the gateway on purchase (reference, not operation).
+      # * <tt>options</tt> -- A hash of parameters.
+      def refund(money, identification, options = {})
+        reference, order_id = split_authorization(identification)
+
+        post = {'Referencia' => reference,
+                'Num_operacion' => order_id,
+                'Idioma' => CECA_UI_LESS_LANGUAGE_REFUND,
+                'Pagina' => CECA_UI_LESS_REFUND_PAGE,
+                'Importe' => amount(money),
+                'TipoMoneda' => CECA_CURRENCIES_DICTIONARY[options[:currency] || currency(money)]}
+
+        commit(CECA_ACTION_REFUND, post)
+      end
+
+      def supports_scrubbing
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
+          gsub(%r((&?pan=)[^&]*)i, '\1[FILTERED]').
+          gsub(%r((&?cvv2=)[^&]*)i, '\1[FILTERED]')
+      end
+
+      private
+
+      def add_creditcard(post, creditcard)
+        post['PAN'] = creditcard.number
+        post['Caducidad'] = expdate(creditcard)
+        post['CVV2'] = creditcard.verification_value
+        post['Pago_elegido'] = CECA_MODE
+      end
+
+      def expdate(creditcard)
+        "#{format(creditcard.year, :four_digits)}#{format(creditcard.month, :two_digits)}"
+      end
+
+      def parse(body)
+        response = {}
+
+        root = REXML::Document.new(body).root
+
+        response[:success] = (root.attributes['valor'] == "OK")
+        response[:date] = root.attributes['fecha']
+        response[:operation_number] = root.attributes['numeroOperacion']
+        response[:message] = root.attributes['valor']
+
+        if root.elements['OPERACION']
+          response[:operation_type] = root.elements['OPERACION'].attributes['tipo']
+          response[:amount] =  root.elements['OPERACION/importe'].text.strip
+        end
+
+        response[:description] = root.elements['OPERACION/descripcion'].text if root.elements['OPERACION/descripcion']
+        response[:authorization_number] = root.elements['OPERACION/numeroAutorizacion'].text if root.elements['OPERACION/numeroAutorizacion']
+        response[:reference] = root.elements['OPERACION/referencia'].text if root.elements['OPERACION/referencia']
+        response[:pan] = root.elements['OPERACION/pan'].text if root.elements['OPERACION/pan']
+
+        if root.elements['ERROR']
+          response[:error_code] = root.elements['ERROR/codigo'].text
+          response[:error_message] = root.elements['ERROR/descripcion'].text
+        else
+          if("000" == root.elements['OPERACION'].attributes['numeroOperacion'])
+            if(root.elements['OPERACION/numeroAutorizacion'])
+              response[:authorization] = root.elements['OPERACION/numeroAutorizacion'].text
+            end
+          else
+            response[:authorization] = root.attributes['numeroOperacion']
+          end
+        end
+
+        return response
+
+      rescue REXML::ParseException => e
+        response[:success] = false
+        response[:message] = "Unable to parse the response."
+        response[:error_message] = e.message
+        response
+      end
+
+      def commit(action, parameters)
+        parameters.merge!(
+          'Cifrado' => CECA_ENCRIPTION,
+          'Firma' => generate_signature(action, parameters),
+          'Exponente' => CECA_DECIMALS,
+          'MerchantID' => options[:merchant_id],
+          'AcquirerBIN' => options[:acquirer_bin],
+          'TerminalID' => options[:terminal_id]
+        )
+        url = (test? ? self.test_url : self.live_url) + "/cgi-bin/#{action}"
+        xml = ssl_post(url, post_data(parameters))
+        response = parse(xml)
+        Response.new(
+          response[:success],
+          response[:message],
+          response,
+          :test => test?,
+          :authorization => build_authorization(response)
+        )
+      end
+
+      def post_data(params)
+        return nil unless params
+
+        params.map do |key, value|
+          next if value.blank?
+          if value.is_a?(Hash)
+            h = {}
+            value.each do |k, v|
+              h["#{key}.#{k}"] = v unless v.blank?
+            end
+            post_data(h)
+          else
+            "#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end.compact.join("&")
+      end
+
+      def build_authorization(response)
+        [response[:reference], response[:authorization]].join("|")
+      end
+
+      def split_authorization(authorization)
+        authorization.split("|")
+      end
+
+      def generate_signature(action, parameters)
+        signature_fields = case action
+        when CECA_ACTION_REFUND
+          options[:key].to_s +
+          options[:merchant_id].to_s +
+          options[:acquirer_bin].to_s +
+          options[:terminal_id].to_s +
+          parameters['Num_operacion'].to_s +
+          parameters['Importe'].to_s +
+          parameters['TipoMoneda'].to_s +
+          CECA_DECIMALS +
+          parameters['Referencia'].to_s +
+          CECA_ENCRIPTION
+        else
+          options[:key].to_s +
+          options[:merchant_id].to_s +
+          options[:acquirer_bin].to_s +
+          options[:terminal_id].to_s +
+          parameters['Num_operacion'].to_s +
+          parameters['Importe'].to_s +
+          parameters['TipoMoneda'].to_s +
+          CECA_DECIMALS +
+          CECA_ENCRIPTION +
+          CECA_NOTIFICATIONS_URL +
+          CECA_NOTIFICATIONS_URL
+        end
+        Digest::SHA1.hexdigest(signature_fields)
+      end
+    end
+  end
+end