activemerchant 1.29.1 → 1.33.0

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

@@ -0,0 +1,155 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class CardStreamModernGateway < Gateway
+      self.test_url = self.live_url = 'https://gateway.cardstream.com/direct/'
+      self.money_format = :cents
+      self.default_currency = 'GBP'
+      self.supported_countries = ['GB']
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club, :discover, :jcb, :maestro, :solo, :switch]
+      self.homepage_url = 'http://www.cardstream.com/'
+      self.display_name = 'CardStream'
+
+      def initialize(options = {})
+        requires!(options, :login)
+        if(options[:threeDSRequired])
+          @threeDSRequired = options[:threeDSRequired]
+        else
+          @threeDSRequired = 'N'
+        end
+        super
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = {}
+        add_amount(post, money, options)
+        add_invoice(post, creditcard, money, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+        commit('PREAUTH', post)
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = {}
+        add_amount(post, money, options)
+        add_invoice(post, creditcard, money, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+        commit('SALE', post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+        add_pair(post, :xref, authorization)
+        add_amount(post, money, options)
+        commit('SALE', post)
+      end
+
+      def refund(money, authorization, options = {})
+        post = {}
+        add_pair(post, :xref, authorization)
+        add_amount(post, money, options)
+        commit('REFUND', post)
+      end
+
+      def void(authorization, options = {})
+        post = {}
+        add_pair(post, :xref, authorization)
+        commit('REFUND', post)
+      end
+
+      private
+
+      def add_amount(post, money, options)
+        add_pair(post, :amount, amount(money), :required => true)
+        add_pair(post, :currencyCode, options[:currency] || self.default_currency)
+      end
+
+      def add_customer_data(post, options)
+        address = options[:billing_address] || options[:address]
+        add_pair(post, :customerPostCode, address[:zip])
+        add_pair(post, :customerEmail, options[:email])
+        add_pair(post, :customerPhone, options[:phone])
+      end
+
+      def add_address(post, creditcard, options)
+        address = options[:billing_address] || options[:address]
+
+        return if address.nil?
+
+        add_pair(post, :customerAddress, address[:address1] + " " + (address[:address2].nil? ? "" : address[:address2]) )
+        add_pair(post, :customerPostCode, address[:zip])
+      end
+
+      def add_invoice(post, credit_card, money, options)
+        add_pair(post, :transactionUnique, options[:order_id], :required => true)
+        add_pair(post, :orderRef, options[:description] || options[:order_id], :required => true)
+        if [ 'american_express', 'diners_club' ].include?(card_brand(credit_card).to_s)
+          add_pair(post, :item1Quantity,  1)
+          add_pair(post, :item1Description,  (options[:description] || options[:order_id]).slice(0, 15))
+          add_pair(post, :item1GrossValue, amount(money))
+        end
+      end
+
+      def add_creditcard(post, credit_card)
+        add_pair(post, :customerName, credit_card.name, :required => true)
+        add_pair(post, :cardNumber, credit_card.number, :required => true)
+
+        add_pair(post, :cardExpiryMonth, format(credit_card.month, :two_digits), :required => true)
+        add_pair(post, :cardExpiryYear, format(credit_card.year, :two_digits), :required => true)
+
+        if requires_start_date_or_issue_number?(credit_card)
+          add_pair(post, :cardStartMonth, format(credit_card.start_month, :two_digits))
+          add_pair(post, :cardStartYear, format(credit_card.start_year, :two_digits))
+
+          add_pair(post, :cardIssueNumber, credit_card.issue_number)
+        end
+
+        add_pair(post, :cardCVV, credit_card.verification_value)
+      end
+
+      def parse(body)
+        result = {}
+        pairs = body.split("&")
+        pairs.each do |pair|
+          a = pair.split("=")
+          result[a[0].to_sym] = CGI.unescape(a[1])
+        end
+        result
+      end
+
+      def commit(action, parameters)
+        response = parse( ssl_post(self.live_url, post_data(action, parameters)) )
+
+        Response.new(response[:responseCode] == "0",
+          response[:responseCode] == "0" ? "APPROVED" : response[:responseMessage],
+          response,
+          :test => test?,
+          :authorization => response[:xref],
+          :avs_result => {
+            :street_match => response[:addressCheck],
+            :postal_match => response[:postcodeCheck],
+          },
+          :cvv_result => response[:cv2Check]
+        )
+      end
+
+      def post_data(action, parameters = {})
+        parameters.update(
+          :merchantID => @options[:login],
+          :action => action,
+          :type => '1', #Ecommerce
+          :countryCode => self.supported_countries[0],
+          :threeDSRequired => @threeDSRequired #Disable 3d secure by default
+        )
+        parameters.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      def add_pair(post, key, value, options = {})
+        post[key] = value if !value.blank? || options[:required]
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,156 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # CC5 API is used by many banks in Turkey. Extend this base class to provide
+    # concrete implementations.
+    class CC5Gateway < Gateway
+      self.default_currency = 'TRY'
+
+      CURRENCY_CODES = {
+        'TRY' => 949,
+        'YTL' => 949,
+        'TRL' => 949,
+        'TL'  => 949,
+        'USD' => 840,
+        'EUR' => 978,
+        'GBP' => 826,
+        'JPY' => 392
+      }
+
+      def initialize(options = {})
+        requires!(options, :login, :password, :client_id)
+        super
+      end
+
+      def purchase(money, creditcard, options = {})
+        commit(build_sale_request('Auth', money, creditcard, options))
+      end
+
+      def authorize(money, creditcard, options = {})
+        commit(build_sale_request('PreAuth', money, creditcard, options))
+      end
+
+      def capture(money, authorization, options = {})
+        commit(build_capture_request(money, authorization, options))
+      end
+
+      protected
+
+      def build_sale_request(type, money, creditcard, options = {})
+        requires!(options,  :order_id)
+
+        xml = Builder::XmlMarkup.new :indent => 2
+
+        xml.tag! 'CC5Request' do
+          add_login_tags(xml)
+          xml.tag! 'OrderId', options[:order_id]
+          xml.tag! 'Type', type
+          xml.tag! 'Number', creditcard.number
+          xml.tag! 'Expires', [format(creditcard.month, :two_digits), format(creditcard.year, :two_digits)].join('/')
+          xml.tag! 'Cvv2Val', creditcard.verification_value
+          add_amount_tags(money, options, xml)
+          xml.tag! 'Email', options[:email] if options[:email]
+
+          if(address = (options[:billing_address] || options[:address]))
+            xml.tag! 'BillTo' do
+              add_address(xml, address)
+            end
+            xml.tag! 'ShipTo' do
+              add_address(xml, address)
+            end
+          end
+
+        end
+
+        xml.target!
+      end
+
+      def build_capture_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', 'PostAuth'
+          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])
+        xml.tag! 'Street2', normalize(address[:address2]) if address[:address2]
+        xml.tag! 'City', normalize(address[:city])
+        xml.tag! 'PostalCode', address[:zip]
+        xml.tag! 'Country', normalize(address[:country])
+        xml.tag! 'Company', normalize(address[:company])
+        xml.tag! 'TelVoice', address[:phone].to_s.gsub(/[^0-9]/, '') if address[:phone]
+      end
+
+      def add_login_tags(xml)
+        xml.tag! 'Name', @options[:login]
+        xml.tag! 'Password', @options[:password]
+        xml.tag! 'ClientId', @options[:client_id]
+        xml.tag! 'Mode', (test? ? 'T' : 'P')
+      end
+
+      def add_amount_tags(money, options, xml)
+        xml.tag! 'Total', amount(money)
+        xml.tag! 'Currency', currency_code(options[:currency] || currency(money))
+      end
+
+      def currency_code(currency)
+        (CURRENCY_CODES[currency] || CURRENCY_CODES[default_currency])
+      end
+
+      def commit(request)
+        raw_response = ssl_post((test? ? self.test_url : self.live_url), "DATA=" + request)
+
+        response = parse(raw_response)
+
+        success = success?(response)
+
+        Response.new(
+          success,
+          (success ? 'Approved' : "Declined (Reason: #{response[:proc_return_code]} - #{response[:err_msg]})"),
+          response,
+          :test => test?,
+          :authorization => response[:order_id]
+        )
+      end
+
+      def parse(body)
+        xml = REXML::Document.new(body)
+
+        response = {}
+        xml.root.elements.to_a.each do |node|
+          parse_element(response, node)
+        end
+        response
+      end
+
+      def parse_element(response, node)
+        if node.has_elements?
+          node.elements.each{|element| parse_element(response, element) }
+        else
+          response[node.name.underscore.to_sym] = node.text
+        end
+      end
+
+      def success?(response)
+        (response[:response] == "Approved")
+      end
+
+      def normalize(text)
+        return unless text
+
+        if ActiveSupport::Inflector.method(:transliterate).arity == -2
+          ActiveSupport::Inflector.transliterate(text,'')
+        elsif RUBY_VERSION >= '1.9'
+          text.gsub(/[^\x00-\x7F]+/, '')
+        else
+          ActiveSupport::Inflector.transliterate(text).to_s
+        end
+      end
+    end
+  end
+end

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

@@ -13,6 +13,7 @@ module ActiveMerchant #:nodoc:
     # names.
     #
     # Important Notes
+    # * For checks you can purchase and store.
     # * AVS and CVV only work against the production server.  You will always
     #   get back X for AVS and no response for CVV against the test server.
     # * Nexus is the list of states or provinces where you have a physical
@@ -131,10 +132,10 @@ module ActiveMerchant #:nodoc:
 
       # Purchase is an auth followed by a capture
       # You must supply an order_id in the options hash
-      def purchase(money, creditcard_or_reference, options = {})
+      def purchase(money, payment_method_or_reference, options = {})
         requires!(options, :order_id)
         setup_address_hash(options)
-        commit(build_purchase_request(money, creditcard_or_reference, options), options)
+        commit(build_purchase_request(money, payment_method_or_reference, options), options)
       end
 
       def void(identification, options = {})
@@ -154,10 +155,10 @@ module ActiveMerchant #:nodoc:
       # Stores a customer subscription/profile with type "on-demand".
       # To charge the card while creating a profile, pass
       # options[:setup_fee] => money
-      def store(creditcard, options = {})
+      def store(payment_method, options = {})
         requires!(options, :order_id)
         setup_address_hash(options)
-        commit(build_create_subscription_request(creditcard, options), options)
+        commit(build_create_subscription_request(payment_method, options), options)
       end
 
       # Updates a customer subscription/profile
@@ -222,7 +223,7 @@ module ActiveMerchant #:nodoc:
 
       def build_auth_request(money, creditcard_or_reference, options)
         xml = Builder::XmlMarkup.new :indent => 2
-        add_creditcard_or_subscription(xml, money, creditcard_or_reference, options)
+        add_payment_method_or_subscription(xml, money, creditcard_or_reference, options)
         add_auth_service(xml)
         add_business_rules_data(xml)
         xml.target!
@@ -250,11 +251,15 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
-      def build_purchase_request(money, creditcard_or_reference, options)
+      def build_purchase_request(money, payment_method_or_reference, options)
         xml = Builder::XmlMarkup.new :indent => 2
-        add_creditcard_or_subscription(xml, money, creditcard_or_reference, options)
-        add_purchase_service(xml, options)
-        add_business_rules_data(xml)
+        add_payment_method_or_subscription(xml, money, payment_method_or_reference, options)
+        if !payment_method_or_reference.is_a?(String) && card_brand(payment_method_or_reference) == 'check'
+          add_check_service(xml)
+        else
+          add_purchase_service(xml, options)
+          add_business_rules_data(xml)
+        end
         xml.target!
       end
 
@@ -297,16 +302,22 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
-      def build_create_subscription_request(creditcard, options)
+      def build_create_subscription_request(payment_method, options)
         options[:subscription] = (options[:subscription] || {}).merge(:frequency => "on-demand", :amount => 0, :automatic_renew => false)
 
         xml = Builder::XmlMarkup.new :indent => 2
-        add_address(xml, creditcard, options[:billing_address], options)
+        add_address(xml, payment_method, options[:billing_address], options)
         add_purchase_data(xml, options[:setup_fee] || 0, true, options)
-        add_creditcard(xml, creditcard)
-        add_creditcard_payment_method(xml)
+        if card_brand(payment_method) == 'check'
+          add_check(xml, payment_method)
+          add_check_payment_method(xml)
+          add_check_service(xml, options) if options[:setup_fee]
+        else
+          add_creditcard(xml, payment_method)
+          add_creditcard_payment_method(xml)
+          add_purchase_service(xml, options) if options[:setup_fee]
+        end
         add_subscription(xml, options)
-        add_purchase_service(xml, options) if options[:setup_fee]
         add_subscription_create_service(xml, options)
         add_business_rules_data(xml)
         xml.target!
@@ -372,12 +383,12 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def add_address(xml, creditcard, address, options, shipTo = false)
+      def add_address(xml, payment_method, address, options, shipTo = false)
         requires!(options, :email)
 
         xml.tag! shipTo ? 'shipTo' : 'billTo' do
-          xml.tag! 'firstName',             creditcard.first_name             if creditcard
-          xml.tag! 'lastName',              creditcard.last_name              if creditcard
+          xml.tag! 'firstName',             payment_method.first_name             if payment_method
+          xml.tag! 'lastName',              payment_method.last_name              if payment_method
           xml.tag! 'street1',               address[:address1]
           xml.tag! 'street2',               address[:address2]                unless address[:address2].blank?
           xml.tag! 'city',                  address[:city]
@@ -403,6 +414,14 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_check(xml, check)
+        xml.tag! 'check' do
+          xml.tag! 'accountNumber', check.account_number
+          xml.tag! 'accountType', check.account_type[0]
+          xml.tag! 'bankTransitNumber', check.routing_number
+        end
+      end
+
       def add_tax_service(xml)
         xml.tag! 'taxService', {'run' => 'true'} do
           xml.tag!('nexus', @options[:nexus]) unless @options[:nexus].blank?
@@ -447,6 +466,10 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_check_service(xml)
+        xml.tag! 'ecDebitService', {'run' => 'true'}
+      end
+
       def add_subscription_create_service(xml, options)
         xml.tag! 'paySubscriptionCreateService', {'run' => 'true'}
       end
@@ -491,14 +514,24 @@ module ActiveMerchant #:nodoc:
         end
       end
 
-      def add_creditcard_or_subscription(xml, money, creditcard_or_reference, options)
-        if creditcard_or_reference.is_a?(String)
+      def add_check_payment_method(xml)
+        xml.tag! 'subscription' do
+          xml.tag! 'paymentMethod', "check"
+        end
+      end
+
+      def add_payment_method_or_subscription(xml, money, payment_method_or_reference, options)
+        if payment_method_or_reference.is_a?(String)
+          add_purchase_data(xml, money, true, options)
+          add_subscription(xml, options, payment_method_or_reference)
+        elsif card_brand(payment_method_or_reference) == 'check'
+          add_address(xml, payment_method_or_reference, options[:billing_address], options)
           add_purchase_data(xml, money, true, options)
-          add_subscription(xml, options, creditcard_or_reference)
+          add_check(xml, payment_method_or_reference)
         else
-          add_address(xml, creditcard_or_reference, options[:billing_address], options)
+          add_address(xml, payment_method_or_reference, options[:billing_address], options)
           add_purchase_data(xml, money, true, options)
-          add_creditcard(xml, creditcard_or_reference)
+          add_creditcard(xml, payment_method_or_reference)
         end
       end
 

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

@@ -65,7 +65,7 @@ module ActiveMerchant
       #      See http://www.datacash.com/services/recurring/historic.php for more details of historic transactions.
       #   * <tt>:address</tt>:: billing address for card
       #
-      # The continuous authority reference will be available in response#params['ca_referece'] if you have requested one
+      # The continuous authority reference will be available in response#params['ca_reference'] if you have requested one
       def purchase(money, authorization_or_credit_card, options = {})
         requires!(options, :order_id)
 
@@ -93,7 +93,7 @@ module ActiveMerchant
       #      See http://www.datacash.com/services/recurring/historic.php for more details of historic transactions.
       #   * <tt>:address</tt>:: billing address for card
       #
-      # The continuous authority reference will be available in response#params['ca_referece'] if you have requested one
+      # The continuous authority reference will be available in response#params['ca_reference'] if you have requested one
       def authorize(money, authorization_or_credit_card, options = {})
         requires!(options, :order_id)
 
@@ -448,7 +448,7 @@ module ActiveMerchant
         end
       end
 
-      # Add credit_card detals to the passed XML Builder doc
+      # Add credit_card details to the passed XML Builder doc
       #
       # Parameters:
       #   -xml: Builder document that is being built up