tlconnor-activemerchant 1.20.4 → 1.23.0

data/lib/active_merchant/billing/gateways/paypal/paypal_recurring_api.rb

@@ -0,0 +1,245 @@
+require File.dirname(__FILE__) + '/paypal_common_api'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # This module is included in both PaypalGateway and PaypalExpressGateway
+    module PaypalRecurringApi
+      PAYPAL_NAMESPACE = ActiveMerchant::Billing::PaypalCommonAPI::PAYPAL_NAMESPACE
+      API_VERSION = ActiveMerchant::Billing::PaypalCommonAPI::API_VERSION
+      EBAY_NAMESPACE = ActiveMerchant::Billing::PaypalCommonAPI::EBAY_NAMESPACE
+      # Create a recurring payment.
+      #
+      # This transaction creates a recurring payment profile
+      # ==== Parameters
+      #
+      # * <tt>money</tt> -- The amount to be charged to the customer at each interval as an Integer value in cents.
+      # * <tt>credit_card</tt> -- The CreditCard details for the transaction.
+      # * <tt>options</tt> -- A hash of parameters.
+      #
+      # ==== Options
+      #
+      # * <tt>:period</tt> -- [Day, Week, SemiMonth, Month, Year] default: Month
+      # * <tt>:frequency</tt> -- a number
+      # * <tt>:cycles</tt> -- Limit to certain # of cycles (OPTIONAL)
+      # * <tt>:start_date</tt> -- When does the charging starts (REQUIRED)
+      # * <tt>:description</tt> -- The description to appear in the profile (REQUIRED)
+      
+      def recurring(amount, credit_card, options = {})
+        options[:credit_card] = credit_card
+        options[:amount] = amount
+        requires!(options, :description, :start_date, :period, :frequency, :amount)
+        commit 'CreateRecurringPaymentsProfile', build_create_profile_request(options)
+      end
+
+      # Update a recurring payment's details.
+      #
+      # This transaction updates an existing Recurring Billing Profile
+      # and the subscription must have already been created previously 
+      # by calling +recurring()+. The ability to change certain
+      # details about a recurring payment is dependent on transaction history
+      # and the type of plan you're subscribed with paypal. Web Payment Pro
+      # seems to have the ability to update the most field.
+      #
+      # ==== Parameters
+      #
+      # * <tt>options</tt> -- A hash of parameters.
+      #
+      # ==== Options
+      #
+      # * <tt>:profile_id</tt> -- A string containing the <tt>:profile_id</tt>
+      # of the recurring payment already in place for a given credit card. (REQUIRED)
+      def update_recurring(options={})
+        requires!(options, :profile_id)
+        opts = options.dup
+        commit 'UpdateRecurringPaymentsProfile', build_change_profile_request(opts.delete(:profile_id), opts)
+      end
+
+      # Cancel a recurring payment.
+      #
+      # This transaction cancels an existing recurring billing profile. Your account must have recurring billing enabled
+      # and the subscription must have already been created previously by calling recurring()
+      #
+      # ==== Parameters
+      #
+      # * <tt>profile_id</tt> -- A string containing the +profile_id+ of the
+      # recurring payment already in place for a given credit card. (REQUIRED)
+      # * <tt>options</tt> -- A hash with extra info ('note' for ex.)
+      def cancel_recurring(profile_id, options = {})
+        raise_error_if_blank('profile_id', profile_id)
+        commit 'ManageRecurringPaymentsProfileStatus', build_manage_profile_request(profile_id, 'Cancel', options)
+      end
+
+      # Get Subscription Status of a recurring payment profile.
+      #
+      # ==== Parameters
+      #
+      # * <tt>profile_id</tt> -- A string containing the +profile_id+ of the
+      # recurring payment already in place for a given credit card. (REQUIRED)
+      def status_recurring(profile_id)
+        raise_error_if_blank('profile_id', profile_id)
+        commit 'GetRecurringPaymentsProfileDetails', build_get_profile_details_request(profile_id)
+      end
+
+      # Suspends a recurring payment profile.
+      #
+      # ==== Parameters
+      #
+      # * <tt>profile_id</tt> -- A string containing the +profile_id+ of the
+      # recurring payment already in place for a given credit card. (REQUIRED)
+      def suspend_recurring(profile_id, options = {})
+        raise_error_if_blank('profile_id', profile_id)
+        commit 'ManageRecurringPaymentsProfileStatus', build_manage_profile_request(profile_id, 'Suspend', options)
+      end
+
+      # Reactivates a suspended recurring payment profile.
+      #
+      # ==== Parameters
+      #
+      # * <tt>profile_id</tt> -- A string containing the +profile_id+ of the
+      # recurring payment already in place for a given credit card. (REQUIRED)
+      def reactivate_recurring(profile_id, options = {})
+        raise_error_if_blank('profile_id', profile_id)
+commit 'ManageRecurringPaymentsProfileStatus', build_manage_profile_request(profile_id, 'Reactivate', options)
+      end
+
+      # Bills outstanding amount to a recurring payment profile.
+      #
+      # ==== Parameters
+      #
+      # * <tt>profile_id</tt> -- A string containing the +profile_id+ of the
+      # recurring payment already in place for a given credit card. (REQUIRED)
+      def bill_outstanding_amount(profile_id, options = {})
+        raise_error_if_blank('profile_id', profile_id)
+        commit 'BillOutstandingAmount', build_bill_outstanding_amount(profile_id, options)
+      end
+
+      private
+      def raise_error_if_blank(field_name, field)
+        raise ArgumentError.new("Missing required parameter: #{field_name}") if field.blank?
+      end
+      def build_create_profile_request(options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'CreateRecurringPaymentsProfileReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'CreateRecurringPaymentsProfileRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:CreateRecurringPaymentsProfileRequestDetails' do
+              xml.tag! 'Token', options[:token] unless options[:token].blank?
+              if options[:credit_card]
+                add_credit_card(xml, options[:credit_card], (options[:billing_address] || options[:address]), options)
+              end
+              xml.tag! 'n2:RecurringPaymentsProfileDetails' do
+                xml.tag! 'n2:BillingStartDate', (options[:start_date].is_a?(Date) ? options[:start_date].to_time : options[:start_date]).utc.iso8601
+                xml.tag! 'n2:ProfileReference', options[:profile_reference] unless options[:profile_reference].blank?
+              end
+              xml.tag! 'n2:ScheduleDetails' do
+                xml.tag! 'n2:Description', options[:description]
+                xml.tag! 'n2:PaymentPeriod' do
+                  xml.tag! 'n2:BillingPeriod', options[:period] || 'Month'
+                  xml.tag! 'n2:BillingFrequency', options[:frequency]
+                  xml.tag! 'n2:TotalBillingCycles', options[:total_billing_cycles] unless options[:total_billing_cycles].blank?
+                  xml.tag! 'n2:Amount', amount(options[:amount]), 'currencyID' => options[:currency] || 'USD'
+                  xml.tag! 'n2:TaxAmount', amount(options[:tax_amount] || 0), 'currencyID' => options[:currency] || 'USD' unless options[:tax_amount].blank?
+                  xml.tag! 'n2:ShippingAmount', amount(options[:shipping_amount] || 0), 'currencyID' => options[:currency] || 'USD' unless options[:shipping_amount].blank?
+                end
+                if !options[:trial_amount].blank?
+                  xml.tag! 'n2:TrialPeriod' do
+                    xml.tag! 'n2:BillingPeriod', options[:trial_period] || 'Month'
+                    xml.tag! 'n2:BillingFrequency', options[:trial_frequency]
+                    xml.tag! 'n2:TotalBillingCycles', options[:trial_cycles] || 1
+                    xml.tag! 'n2:Amount', amount(options[:trial_amount]), 'currencyID' => options[:currency] || 'USD'
+                    xml.tag! 'n2:TaxAmount', amount(options[:trial_tax_amount] || 0), 'currencyID' => options[:currency] || 'USD' unless options[:trial_tax_amount].blank?
+                    xml.tag! 'n2:ShippingAmount', amount(options[:trial_shipping_amount] || 0), 'currencyID' => options[:currency] || 'USD' unless options[:trial_shipping_amount].blank?
+                  end
+                end
+                if !options[:initial_amount].blank?
+                  xml.tag! 'n2:ActivationDetails' do
+                    xml.tag! 'n2:InitialAmount', amount(options[:initial_amount]), 'currencyID' => options[:currency] || 'USD'
+                    xml.tag! 'n2:FailedInitialAmountAction', options[:continue_on_failure] ? 'ContinueOnFailure' : 'CancelOnFailure'
+                  end
+                end
+                xml.tag! 'n2:MaxFailedPayments', options[:max_failed_payments] unless options[:max_failed_payments].blank?
+                xml.tag! 'n2:AutoBillOutstandingAmount', options[:auto_bill_outstanding] ? 'AddToNextBilling' : 'NoAutoBill'
+              end
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_get_profile_details_request(profile_id)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'GetRecurringPaymentsProfileDetailsReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'GetRecurringPaymentsProfileDetailsRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'ProfileID', profile_id
+          end
+        end
+        xml.target!
+      end
+
+      def build_change_profile_request(profile_id, options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'UpdateRecurringPaymentsProfileReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'UpdateRecurringPaymentsProfileRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:UpdateRecurringPaymentsProfileRequestDetails' do
+              xml.tag! 'ProfileID', profile_id
+              if options[:credit_card]
+                add_credit_card(xml, options[:credit_card], options[:address], options)
+              end
+              xml.tag! 'n2:Note', options[:note] unless options[:note].blank?
+              xml.tag! 'n2:Description', options[:description] unless options[:description].blank?
+              xml.tag! 'n2:ProfileReference', options[:reference] unless options[:reference].blank?
+              xml.tag! 'n2:AdditionalBillingCycles', options[:additional_billing_cycles] unless options[:additional_billing_cycles].blank?
+              xml.tag! 'n2:MaxFailedPayments', options[:max_failed_payments] unless options[:max_failed_payments].blank?
+              xml.tag! 'n2:AutoBillOutstandingAmount', options[:auto_bill_outstanding] ? 'AddToNextBilling' : 'NoAutoBill'
+              if options.has_key?(:amount)
+                xml.tag! 'n2:Amount', amount(options[:amount]), 'currencyID' => options[:currency] || 'USD'
+              end
+              if options.has_key?(:tax_amount)
+                xml.tag! 'n2:TaxAmount', amount(options[:tax_amount] || 0), 'currencyID' => options[:currency] || 'USD'
+              end
+              if options.has_key?(:start_date)
+                xml.tag! 'n2:BillingStartDate', (options[:start_date].is_a?(Date) ? options[:start_date].to_time : options[:start_date]).utc.iso8601
+              end
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_manage_profile_request(profile_id, action, options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'ManageRecurringPaymentsProfileStatusReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'ManageRecurringPaymentsProfileStatusRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:ManageRecurringPaymentsProfileStatusRequestDetails' do
+              xml.tag! 'ProfileID', profile_id
+              xml.tag! 'n2:Action', action
+              xml.tag! 'n2:Note', options[:note] unless options[:note].blank?
+            end
+          end
+        end
+        xml.target!
+      end
+
+      def build_bill_outstanding_amount(profile_id, options)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'BillOutstandingAmountReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'BillOutstandingAmountRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:BillOutstandingAmountRequestDetails' do
+              xml.tag! 'ProfileID', profile_id
+              if options.has_key?(:amount)
+                xml.tag! 'n2:Amount', amount(options[:amount]), 'currencyID' => options[:currency] || 'USD'
+              end
+              xml.tag! 'n2:Note', options[:note] unless options[:note].blank?
+            end
+          end
+        end
+        xml.target!
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/paypal/paypal_common_api'
+require File.dirname(__FILE__) + '/paypal/paypal_express_response'
+require File.dirname(__FILE__) + '/paypal_express_common'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PaypalDigitalGoodsGateway < PaypalExpressGateway
+      self.test_redirect_url = 'https://www.sandbox.paypal.com/incontext'
+      self.live_redirect_url = 'https://www.paypal.com/incontext'
+
+      self.supported_countries = %w(AU CA CN FI GB ID IN IT MY NO NZ PH PL SE SG TH VN)
+      self.homepage_url = 'https://www.x.com/community/ppx/xspaces/digital_goods'
+      self.display_name = 'PayPal Express Checkout for Digital Goods'
+      
+      def redirect_url_for(token, options = {})
+        "#{redirect_url}?token=#{token}&useraction=commit"
+      end
+
+      # GATEWAY.setup_purchase(100,
+      #  :ip                => "127.0.0.1",
+      #  :description       => "Test Title",
+      #  :return_url        => "http://return.url",
+      #  :cancel_return_url => "http://cancel.url",
+      #  :items             => [ { :name => "Charge",
+      #                            :number => "1",
+      #                            :quantity => "1",
+      #                            :amount   => 100,
+      #                            :description => "Description",
+      #                            :category => "Digital" } ] )
+      def build_setup_request(action, money, options)
+        requires!(options, :items)
+        raise ArgumentError, "Must include at least 1 Item" unless options[:items].length > 0
+        options[:items].each do |item|
+          requires!(item, :name, :number, :quantity, :amount, :description, :category)
+          raise ArgumentError, "Each of the items must have the category 'Digital'" unless item[:category] == 'Digital'
+        end
+
+        super
+      end
+
+    end
+  end
+end

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

@@ -71,24 +71,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'n2:PaymentAction', action
               xml.tag! 'n2:Token', options[:token]
               xml.tag! 'n2:PayerID', options[:payer_id]
-              xml.tag! 'n2:PaymentDetails' do
-                xml.tag! 'n2:OrderTotal', localized_amount(money, currency_code), 'currencyID' => currency_code
-                
-                # All of the values must be included together and add up to the order total
-                if [:subtotal, :shipping, :handling, :tax].all?{ |o| options.has_key?(o) }
-                  xml.tag! 'n2:ItemTotal', localized_amount(options[:subtotal], currency_code), 'currencyID' => currency_code
-                  xml.tag! 'n2:ShippingTotal', localized_amount(options[:shipping], currency_code),'currencyID' => currency_code
-                  xml.tag! 'n2:HandlingTotal', localized_amount(options[:handling], currency_code),'currencyID' => currency_code
-                  xml.tag! 'n2:TaxTotal', localized_amount(options[:tax], currency_code), 'currencyID' => currency_code
-                end
-                
-                xml.tag! 'n2:NotifyURL', options[:notify_url]
-                xml.tag! 'n2:ButtonSource', application_id.to_s.slice(0,32) unless application_id.blank?
-                xml.tag! 'n2:InvoiceID', options[:order_id]
-                xml.tag! 'n2:OrderDescription', options[:description]
-
-                add_items_xml(xml, options, currency_code) if options[:items]
-              end
+              add_payment_details(xml, money, currency_code, options)
             end
           end
         end
@@ -98,7 +81,10 @@ module ActiveMerchant #:nodoc:
 
       def build_setup_request(action, money, options)
         currency_code = options[:currency] || currency(money)
-        
+        options[:payment_action] = action
+        options[:express_request] = true
+        options[:shipping_address] ||= options[:address]
+
         xml = Builder::XmlMarkup.new :indent => 2
         xml.tag! 'SetExpressCheckoutReq', 'xmlns' => PAYPAL_NAMESPACE do
           xml.tag! 'SetExpressCheckoutRequest', 'xmlns:n2' => EBAY_NAMESPACE do
@@ -121,7 +107,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'n2:cpp-payflow-color', options[:background_color] unless options[:background_color].blank?
               if options[:allow_guest_checkout]
                 xml.tag! 'n2:SolutionType', 'Sole'
-                xml.tag! 'n2:LandingPage', 'Billing'
+                xml.tag! 'n2:LandingPage', options[:landing_page] || 'Billing'
               end
               xml.tag! 'n2:BuyerEmail', options[:email] unless options[:email].blank?
 
@@ -137,28 +123,8 @@ module ActiveMerchant #:nodoc:
                 xml.tag! 'n2:AllowNote', options[:allow_note] ? '1' : '0'
               end
               xml.tag! 'n2:CallbackURL', options[:callback_url] unless options[:callback_url].blank?
-
-              xml.tag! 'n2:PaymentDetails' do
-                xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? localized_amount(100, currency_code) : localized_amount(money, currency_code), 'currencyID' => currency_code
-                # All of the values must be included together and add up to the order total
-                if [:subtotal, :shipping, :handling, :tax].all? { |o| options.has_key?(o) }
-                  xml.tag! 'n2:ItemTotal', localized_amount(options[:subtotal], currency_code), 'currencyID' => currency_code
-                  xml.tag! 'n2:ShippingTotal', localized_amount(options[:shipping], currency_code), 'currencyID' => currency_code
-                  xml.tag! 'n2:HandlingTotal', localized_amount(options[:handling], currency_code), 'currencyID' => currency_code
-                  xml.tag! 'n2:TaxTotal', localized_amount(options[:tax], currency_code), 'currencyID' => currency_code
-                end
-
-                xml.tag! 'n2:OrderDescription', options[:description]
-                xml.tag! 'n2:InvoiceID', options[:order_id]
-
-                add_address(xml, 'n2:ShipToAddress', options[:shipping_address] || options[:address])
-
-                add_items_xml(xml, options, currency_code) if options[:items]
-
-                xml.tag! 'n2:PaymentAction', action
-                xml.tag! 'n2:Custom', options[:custom] unless options[:custom].blank?
-              end
-
+              
+              add_payment_details(xml, with_money_default(money), currency_code, options)
               if options[:shipping_options]
                 options[:shipping_options].each do |shipping_option|
                   xml.tag! 'n2:FlatRateShippingOptions' do
@@ -180,7 +146,9 @@ module ActiveMerchant #:nodoc:
       
       def build_reference_transaction_request(action, money, options)
         currency_code = options[:currency] || currency(money)
-
+        
+        # I am not sure why it's set like this for express gateway
+        # but I don't want to break the existing behavior
         xml = Builder::XmlMarkup.new :indent => 2
         xml.tag! 'DoReferenceTransactionReq', 'xmlns' => PAYPAL_NAMESPACE do
           xml.tag! 'DoReferenceTransactionRequest', 'xmlns:n2' => EBAY_NAMESPACE do
@@ -189,13 +157,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'n2:ReferenceID', options[:reference_id]
               xml.tag! 'n2:PaymentAction', action
               xml.tag! 'n2:PaymentType', options[:payment_type] || 'Any'
-              xml.tag! 'n2:PaymentDetails' do
-                xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? localized_amount(100, currency_code) : localized_amount(money, currency_code), 'currencyID' => currency_code
-                xml.tag! 'n2:OrderDescription', options[:description]
-                xml.tag! 'n2:InvoiceID', options[:invoice_id]
-                xml.tag! 'n2:ButtonSource', 'ActiveMerchant'
-                xml.tag! 'n2:NotifyURL', ''
-              end
+              add_payment_details(xml, with_money_default(money), currency_code, options)
               xml.tag! 'n2:IPAddress', options[:ip]
             end
           end
@@ -208,21 +170,8 @@ module ActiveMerchant #:nodoc:
         PaypalExpressResponse.new(success, message, response, options)
       end
 
-      private
-
-      def add_items_xml(xml, options, currency_code)
-        options[:items].each do |item|
-          xml.tag! 'n2:PaymentDetailsItem' do
-            xml.tag! 'n2:Name', item[:name]
-            xml.tag! 'n2:Number', item[:number]
-            xml.tag! 'n2:Quantity', item[:quantity]
-            if item[:amount]
-              xml.tag! 'n2:Amount', localized_amount(item[:amount], currency_code), 'currencyID' => currency_code
-            end
-            xml.tag! 'n2:Description', item[:description]
-            xml.tag! 'n2:ItemURL', item[:url]
-          end
-        end
+      def with_money_default(money)
+        amount(money).to_f.zero? ? 100 : money
       end
     end
   end

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

@@ -2,8 +2,13 @@ module ActiveMerchant
   module Billing
     module PaypalExpressCommon
       def self.included(base)
-        base.cattr_accessor :test_redirect_url
-        base.cattr_accessor :live_redirect_url
+        if base.respond_to?(:class_attribute)
+          base.class_attribute :test_redirect_url
+          base.class_attribute :live_redirect_url
+        else
+          base.class_inheritable_accessor :test_redirect_url
+          base.class_inheritable_accessor :live_redirect_url
+        end
         base.live_redirect_url = 'https://www.paypal.com/cgibin/webscr'
       end
       
@@ -22,4 +27,4 @@ module ActiveMerchant
       end
     end
   end
-end
+end

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

@@ -1,4 +1,4 @@
-require 'rexml/document'
+require 'nokogiri'
 require 'digest/sha1'
 
 module ActiveMerchant
@@ -101,9 +101,8 @@ module ActiveMerchant
       def parse(xml)
         response = {}
 
-        xml = REXML::Document.new(xml)
-        xml.elements.each('//response/*') do |node|
-
+        doc = Nokogiri::XML(xml)
+        doc.xpath('//response/*').each do |node|
           if (node.elements.size == 0)
             response[node.name.downcase.to_sym] = normalize(node.text)
           else
@@ -112,8 +111,7 @@ module ActiveMerchant
               response[name.to_sym] = normalize(childnode.text)
             end
           end
-
-        end unless xml.root.nil?
+        end unless doc.root.nil?
 
         response
       end
@@ -312,4 +310,4 @@ module ActiveMerchant
       end
     end
   end
-end
+end