johnreitano-activemerchant 1.5.2

data/lib/active_merchant/billing/integrations/paypal/notification.rb

@@ -0,0 +1,154 @@
+require 'net/http'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Paypal
+        # Parser and handler for incoming Instant payment notifications from paypal. 
+        # The Example shows a typical handler in a rails application. Note that this
+        # is an example, please read the Paypal API documentation for all the details
+        # on creating a safe payment controller.
+        #
+        # Example
+        #  
+        #   class BackendController < ApplicationController
+        #     include ActiveMerchant::Billing::Integrations
+        #
+        #     def paypal_ipn
+        #       notify = Paypal::Notification.new(request.raw_post)
+        #   
+        #       order = Order.find(notify.item_id)
+        #     
+        #       if notify.acknowledge 
+        #         begin
+        #           
+        #           if notify.complete? and order.total == notify.amount
+        #             order.status = 'success' 
+        #             
+        #             shop.ship(order)
+        #           else
+        #             logger.error("Failed to verify Paypal's notification, please investigate")
+        #           end
+        #   
+        #         rescue => e
+        #           order.status        = 'failed'      
+        #           raise
+        #         ensure
+        #           order.save
+        #         end
+        #       end
+        #   
+        #       render :nothing
+        #     end
+        #   end
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          include PostsData
+          
+          # Was the transaction complete?
+          def complete?
+            status == "Completed"
+          end
+
+          # When was this payment received by the client. 
+          # sometimes it can happen that we get the notification much later. 
+          # One possible scenario is that our web application was down. In this case paypal tries several 
+          # times an hour to inform us about the notification
+          def received_at
+            Time.parse params['payment_date']
+          end
+
+          # Status of transaction. List of possible values:
+          # <tt>Canceled-Reversal</tt>::
+          # <tt>Completed</tt>::
+          # <tt>Denied</tt>::
+          # <tt>Expired</tt>::
+          # <tt>Failed</tt>::
+          # <tt>In-Progress</tt>::
+          # <tt>Partially-Refunded</tt>::
+          # <tt>Pending</tt>::
+          # <tt>Processed</tt>::
+          # <tt>Refunded</tt>::
+          # <tt>Reversed</tt>::
+          # <tt>Voided</tt>::
+          def status
+            params['payment_status']
+          end
+
+          # Id of this transaction (paypal number)
+          def transaction_id
+            params['txn_id']
+          end
+
+          # What type of transaction are we dealing with? 
+          #  "cart" "send_money" "web_accept" are possible here. 
+          def type
+            params['txn_type']
+          end
+
+          # the money amount we received in X.2 decimal.
+          def gross
+            params['mc_gross']
+          end
+
+          # the markup paypal charges for the transaction
+          def fee
+            params['mc_fee']
+          end
+
+          # What currency have we been dealing with
+          def currency
+            params['mc_currency']
+          end
+
+          # This is the item number which we submitted to paypal 
+          # The custom field is also mapped to item_id because PayPal
+          # doesn't return item_number in dispute notifications
+          def item_id
+            params['item_number'] || params['custom']
+          end
+
+          # This is the invoice which you passed to paypal 
+          def invoice
+            params['invoice']
+          end   
+
+          # Was this a test transaction?
+          def test?
+            params['test_ipn'] == '1'
+          end
+          
+          def account
+            params['business'] || params['receiver_email']
+          end
+
+          # Acknowledge the transaction to paypal. This method has to be called after a new 
+          # ipn arrives. Paypal will verify that all the information we received are correct and will return a 
+          # ok or a fail. 
+          # 
+          # Example:
+          # 
+          #   def paypal_ipn
+          #     notify = PaypalNotification.new(request.raw_post)
+          #
+          #     if notify.acknowledge 
+          #       ... process order ... if notify.complete?
+          #     else
+          #       ... log possible hacking attempt ...
+          #     end
+          def acknowledge
+            payload =  raw
+
+            response = ssl_post(Paypal.service_url + '?cmd=_notify-validate', payload, 
+              'Content-Length' => "#{payload.size}",
+              'User-Agent'     => "Active Merchant -- http://activemerchant.org"
+            )
+            
+            raise StandardError.new("Faulty paypal result: #{response}") unless ["VERIFIED", "INVALID"].include?(response)
+
+            response == "VERIFIED"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/paypal/return.rb

@@ -0,0 +1,10 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Paypal
+        class Return < ActiveMerchant::Billing::Integrations::Return
+	      end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/paypal.rb

@@ -0,0 +1,39 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Paypal
+        autoload :Return, 'active_merchant/billing/integrations/paypal/return.rb'
+        autoload :Helper, 'active_merchant/billing/integrations/paypal/helper.rb'
+        autoload :Notification, 'active_merchant/billing/integrations/paypal/notification.rb'
+        
+        # Overwrite this if you want to change the Paypal test url
+        mattr_accessor :test_url
+        self.test_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+        
+        # Overwrite this if you want to change the Paypal production url
+        mattr_accessor :production_url 
+        self.production_url = 'https://www.paypal.com/cgi-bin/webscr' 
+        
+        def self.service_url
+          mode = ActiveMerchant::Billing::Base.integration_mode
+          case mode
+          when :production
+            self.production_url    
+          when :test
+            self.test_url
+          else
+            raise StandardError, "Integration mode set to an invalid value: #{mode}"
+          end
+        end
+            
+        def self.notification(post)
+          Notification.new(post)
+        end
+        
+        def self.return(query_string)
+          Return.new(query_string)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/quickpay/helper.rb

@@ -0,0 +1,72 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Quickpay
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+
+          def initialize(order, account, options = {})
+            super
+            add_field('protocol', '3')
+            add_field('msgtype', 'authorize')
+            add_field('language', 'da')
+            add_field('autocapture', 0)
+            add_field('testmode', 0)
+            add_field('ordernumber', format_order_number(order))
+          end
+              
+          def md5secret(value)
+            @md5secret = value
+          end
+          
+          def form_fields
+            @fields.merge('md5check' => generate_md5check)
+          end
+            
+          def generate_md5string
+            MD5_CHECK_FIELDS.map {|key| @fields[key.to_s]} * "" + @md5secret
+          end
+          
+          def generate_md5check
+            Digest::MD5.hexdigest(generate_md5string)
+          end
+
+          # Limited to 20 digits max
+          def format_order_number(number)
+            number.to_s.gsub(/[^\w_]/, '').rjust(4, "0")[0...20]
+          end
+          
+          MD5_CHECK_FIELDS = [
+            :protocol, :msgtype, :merchant, :language, :ordernumber, 
+            :amount, :currency, :continueurl, :cancelurl, :callbackurl,
+            :autocapture, :cardtypelock, :description, :ipaddress, :testmode
+          ]
+
+          mapping :protocol, 'protocol'
+          mapping :msgtype, 'msgtype'
+          mapping :account, 'merchant'
+          mapping :language, 'language'
+          mapping :amount, 'amount'
+          mapping :currency, 'currency'
+          
+          mapping :return_url, 'continueurl'
+          mapping :cancel_return_url, 'cancelurl'
+          mapping :notify_url, 'callbackurl'
+
+          mapping :autocapture, 'autocapture'
+          mapping :cardtypelock, 'cardtypelock'
+
+          mapping :description, 'description'
+          mapping :ipaddress, 'ipaddress'
+          mapping :testmode, 'testmode'
+
+          mapping :md5secret, 'md5secret'
+
+          mapping :customer, ''
+          mapping :billing_address, {}
+          mapping :tax, ''
+          mapping :shipping, ''
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/quickpay/notification.rb

@@ -0,0 +1,74 @@
+require 'net/http'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Quickpay
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          def complete?
+            status == '000'
+          end 
+
+          def item_id
+            params['ordernumber']
+          end
+
+          def transaction_id
+            params['transaction']
+          end
+
+          def received_at
+            Time.local(*params['time'].scan(/../))
+          end
+
+          def gross
+            "%.2f" % (gross_cents / 100.0)
+          end
+
+          def gross_cents
+            params['amount'].to_i
+          end
+
+          def test?
+            params['testmode'] == 'Yes'
+          end
+
+          def status
+            params['qpstat']
+          end
+
+          def currency
+            params['currency']
+          end
+          
+          # Provide access to raw fields from quickpay
+          %w(msgtype ordernumber state chstat chstatmsg qpstat qpstatmsg merchant merchantemail cardtype cardnumber).each do |attr|
+            define_method(attr) do
+              params[attr]
+            end
+          end
+
+          MD5_CHECK_FIELDS = [
+            :msgtype, :ordernumber, :amount, :currency, :time, :state,
+            :chstat, :chstatmsg, :qpstat, :qpstatmsg, :merchant, :merchantemail,
+            :transaction, :cardtype, :cardnumber, :testmode
+          ]
+
+          def generate_md5string
+            MD5_CHECK_FIELDS.map { |key| params[key.to_s] } * "" + @options[:md5secret]
+          end
+          
+          def generate_md5check
+            Digest::MD5.hexdigest(generate_md5string)
+          end
+          
+          # Quickpay doesn't do acknowledgements of callback notifications
+          # Instead it uses and MD5 hash of all parameters
+          def acknowledge      
+            generate_md5check == params['md5check']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/quickpay.rb

@@ -0,0 +1,17 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Quickpay 
+        autoload :Helper, File.dirname(__FILE__) + '/quickpay/helper.rb'
+        autoload :Notification, File.dirname(__FILE__) + '/quickpay/notification.rb'
+       
+        mattr_accessor :service_url
+        self.service_url = 'https://secure.quickpay.dk/form/'
+
+        def self.notification(post)
+          Notification.new(post)
+        end  
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/return.rb

@@ -0,0 +1,35 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      class Return
+        attr_accessor :params
+      
+        def initialize(query_string)
+          @params = parse(query_string)
+        end
+      
+        # Successful by default. Overridden in the child class
+        def success?
+          true
+        end
+      
+        def message
+          
+        end
+        
+        def parse(query_string)
+          return {} if query_string.blank?
+          
+          query_string.split('&').inject({}) do |memo, chunk|
+            next if chunk.empty?
+            key, value = chunk.split('=', 2)
+            next if key.empty?
+            value = value.nil? ? nil : CGI.unescape(value)
+            memo[CGI.unescape(key)] = value
+            memo
+          end
+        end 
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/two_checkout/helper.rb

@@ -0,0 +1,59 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module TwoCheckout
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          def initialize(order, account, options = {})
+            super
+            add_field('fixed', 'Y')
+            
+            if ActiveMerchant::Billing::Base.integration_mode == :test || options[:test]
+              add_field('demo', 'Y')
+            end 
+          end
+          
+          # The 2checkout vendor account number
+          mapping :account, 'sid'
+          
+          # he total amount to be billed, in decimal form, without a currency symbol. (8 characters, decimal, 2 characters: Example: 99999999.99)
+          mapping :amount, 'total'
+        
+          # a unique order id from your program. (128 characters max)
+          mapping :order, 'cart_order_id'
+
+
+          mapping :customer, :email      => 'email',
+                             :phone      => 'phone'
+
+          mapping :billing_address, :city     => 'city',
+                                    :address1 => 'street_address',
+                                    :address2 => 'street_address2',
+                                    :state    => 'state',
+                                    :zip      => 'zip',
+                                    :country  => 'country'
+          
+          mapping :shipping_address, :city     => 'ship_city',
+                                     :address1 => 'ship_street_address',
+                                     :state    => 'ship_state',
+                                     :zip      => 'ship_zip',
+                                     :country  => 'ship_country'
+          
+          mapping :invoice, 'merchant_order_id'
+          
+          # Does nothing, since we've disabled the Continue Shopping button by using the fixed = Y field
+          mapping :return_url, 'return_url'
+          
+          #mapping :description, ''
+          #mapping :tax, ''
+          #mapping :shipping, ''
+          
+          def customer(params = {})
+            add_field(mappings[:customer][:email], params[:email])
+            add_field(mappings[:customer][:phone], params[:phone])
+            add_field('card_holder_name', "#{params[:first_name]} #{params[:last_name]}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/two_checkout/notification.rb

@@ -0,0 +1,114 @@
+require 'net/http'
+require 'base64'
+require 'digest/md5'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module TwoCheckout
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+        #  order_number	2Checkout.com order number
+        #   	card_holder_name	Card holder's name
+        #   	street_address	Card holder's address
+        #   	city	Card holder's city
+        #   	state	Card holder's state
+        #   	zip	Card holder's zip
+        #   	country	Card holder's country
+        #   	email	Card holder's email
+        #   	phone	Card holder's phone
+        #   	credit_card_processed	Y if successful, K if waiting for approval
+        #   	total	 Total purchase amount
+        #   	ship_name	Shipping information
+        #   	ship_street_address	Shipping information
+        #   	ship_city	Shipping information
+        #   	ship_state	Shipping information
+        #   	ship_zip	 Shipping information
+        #   	ship_country	Shipping information
+        #   	product_id	2Checkout product ID for purchased items will append a number if more than one item. 
+        #  ex. product_id,product_id1,product_id2
+        #   	quantity	quantity of corresponding product will append a number if more than one item.
+        #  ex. quantity,quantity1,quantity2
+        #   	merchant_product_id	 your product ID for purchased items will append a number if more than one item.
+        #  ex. merchant_product_id,merchant_product_id1,merchant_product_id2
+        #   	product_description	your description for purchased items will append a number if more than one item.
+        #  ex. product_description,product_description1,product_description2
+          
+          def currency
+            'USD'
+          end
+          
+          def complete?
+            status == 'Completed'
+          end 
+
+          def item_id
+            params['cart_order_id']
+          end
+
+          def transaction_id
+            params['order_number']
+          end
+
+          def received_at
+            params['']
+          end
+
+          def payer_email
+            params['email']
+          end
+         
+          def receiver_email
+            params['']
+          end 
+
+          # The MD5 Hash
+          def security_key
+            params['key']
+          end
+
+          # the money amount we received in X.2 decimal.
+          def gross
+            params['total']
+          end
+
+          # Was this a test transaction? # Use the hash
+          def test?
+            params['demo'] == 'Y'
+          end
+
+          def status
+            case params['credit_card_processed']
+            when 'Y'
+              'Completed'
+            when 'K'
+              'Pending'
+            else
+              'Failed'
+            end
+          end
+          
+          def verify(secret)
+            return false if security_key.blank?
+            
+            Digest::MD5.hexdigest("#{secret}#{params['sid']}#{transaction_id}#{gross}").upcase == security_key.upcase
+          end
+          
+          def acknowledge
+            true
+          end
+          
+          private
+          
+          def parse(post)
+            @raw = post.to_s
+            for line in @raw.split('&')    
+              key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+              params[key] = CGI.unescape(value || '')
+            end
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/two_checkout/return.rb

@@ -0,0 +1,17 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module TwoCheckout
+        class Return < ActiveMerchant::Billing::Integrations::Return
+          def success?
+            params['credit_card_processed'] == 'Y'
+          end
+          
+          def message
+            
+          end
+	      end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/two_checkout.rb

@@ -0,0 +1,23 @@
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module TwoCheckout 
+        autoload 'Helper', File.dirname(__FILE__) + '/two_checkout/helper'
+        autoload 'Return', File.dirname(__FILE__) + '/two_checkout/return'
+        autoload 'Notification', File.dirname(__FILE__) + '/two_checkout/notification'
+       
+        mattr_accessor :service_url
+        self.service_url = 'https://www.2checkout.com/2co/buyer/purchase'
+
+        def self.notification(post)
+          Notification.new(post)
+        end  
+        
+        def self.return(query_string)
+          Return.new(query_string)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations.rb

@@ -0,0 +1,29 @@
+
+# make the bogus gateway be classified correctly by the inflector
+if defined?(ActiveSupport::Inflector)
+  ActiveSupport::Inflector.inflections do |inflect|
+    inflect.uncountable 'bogus'
+  end
+else
+  Inflector.inflections do |inflect|
+    inflect.uncountable 'bogus'
+  end
+end
+
+module ActiveMerchant
+  module Billing
+    module Integrations        
+    
+      Dir[File.dirname(__FILE__) + '/integrations/*.rb'].each do |f|      
+      
+        # Get camelized class name 
+        filename = File.basename(f, '.rb')
+        # Camelize the string to get the class name
+        gateway_class = filename.camelize.to_sym
+              
+        # Register for autoloading
+        autoload gateway_class, f      
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/response.rb

@@ -0,0 +1,32 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+  
+    class Error < ActiveMerchantError #:nodoc:
+    end
+  
+    class Response
+      attr_reader :params, :message, :test, :authorization, :avs_result, :cvv_result
+      
+      def success?
+        @success
+      end
+
+      def test?
+        @test
+      end
+      
+      def fraud_review?
+        @fraud_review
+      end
+      
+      def initialize(success, message, params = {}, options = {})
+        @success, @message, @params = success, message, params.stringify_keys
+        @test = options[:test] || false        
+        @authorization = options[:authorization]
+        @fraud_review = options[:fraud_review]
+        @avs_result = AVSResult.new(options[:avs_result]).to_hash
+        @cvv_result = CVVResult.new(options[:cvv_result]).to_hash
+      end
+    end
+  end
+end