mcmire-activemerchant 1.5.2

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

@@ -0,0 +1,68 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Nochex
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          # Required Parameters
+          # email
+          # amount
+          mapping :account, 'email'
+          mapping :amount, 'amount'
+        
+          # Set the field status = test for testing with accounts:
+          # Account             Password
+          # test1@nochex.com    123456
+          # test2@nochex.com    123456
+          # def initialize(order, account, options = {})
+          #  super
+          #  add_field('status', 'test')
+          # end 
+
+          # Need to format the amount to have 2 decimal places
+          def amount=(money)
+            cents = money.respond_to?(:cents) ? money.cents : money
+            if money.is_a?(String) or cents.to_i <= 0
+              raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.'
+            end
+            add_field mappings[:amount], sprintf("%.2f", cents.to_f/100)
+          end
+          
+          # Optional Parameters
+          # ordernumber
+          mapping :order, 'ordernumber'
+
+          # firstname
+          # lastname
+          # email_address_sender
+          mapping :customer, :first_name => 'firstname',
+                             :last_name  => 'lastname',
+                             :email      => 'email_address_sender'
+
+          # town
+          # firstline
+          # county
+          # postcode
+          mapping :billing_address, :city     => 'town',
+                                    :address1 => 'firstline',
+                                    :state    => 'county',
+                                    :zip      => 'postcode'
+
+          # responderurl 
+          mapping :notify_url, 'responderurl'
+
+          # returnurl
+          mapping :return_url, 'returnurl'
+          
+          # cancelurl
+          mapping :cancel_return_url, 'cancelurl'
+          
+          # description
+          mapping :description, 'description'
+
+          # Currently unmapped
+          # logo
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+require 'net/http'
+require 'date'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Nochex
+        # Parser and handler for incoming Automatic Payment Confirmations from Nochex.
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          include ActiveMerchant::PostsData
+
+          def complete?
+            status == 'Completed'
+          end 
+
+          # Id of the order we passed to Nochex
+          def item_id
+            params['order_id']
+          end
+
+          def transaction_id
+            params['transaction_id']
+          end
+
+          def currency
+            'GBP'
+          end
+  
+          # When was this payment received by the client. 
+          def received_at
+            # U.K. Format: 27/09/2006 22:30:54
+            return if params['transaction_date'].blank?
+            time = params['transaction_date'].scan(/\d+/)
+            Time.utc(time[2], time[1], time[0], time[3], time[4], time[5])
+          end
+
+          def payer_email
+            params['from_email']
+          end
+         
+          def receiver_email
+            params['to_email']
+          end 
+
+          def security_key
+            params['security_key']
+          end
+
+          # the money amount we received in X.2 decimal.
+          def gross
+            sprintf("%.2f", params['amount'].to_f)
+          end
+
+          # Was this a test transaction?
+          def test?
+            params['status'] == 'test'
+          end
+
+          def status
+            'Completed'
+          end
+
+          # Acknowledge the transaction to Nochex. This method has to be called after a new 
+          # apc arrives. Nochex will verify that all the information we received are correct and will return a 
+          # ok or a fail. This is very similar to the PayPal IPN scheme.
+          # 
+          # Example:
+          # 
+          #   def nochex_ipn
+          #     notify = NochexNotification.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(Nochex.notification_confirmation_url, payload, 
+               'Content-Length' => "#{payload.size}",
+               'User-Agent'     => "Active Merchant -- http://activemerchant.org",
+               'Content-Type'   => "application/x-www-form-urlencoded"
+             )
+
+             raise StandardError.new("Faulty Nochex result: #{response}") unless ["AUTHORISED", "DECLINED"].include?(response)
+
+             response == "AUTHORISED"
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,62 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      class Notification
+        attr_accessor :params
+        attr_accessor :raw
+        
+        # set this to an array in the subclass, to specify which IPs are allowed to send requests
+        class_inheritable_accessor :production_ips
+
+        def initialize(post, options = {})
+          @options = options
+          empty!
+          parse(post)
+        end
+
+        def status
+          raise NotImplementedError, "Must implement this method in the subclass"
+        end
+
+        # the money amount we received in X.2 decimal.
+        def gross
+          raise NotImplementedError, "Must implement this method in the subclass"
+        end
+
+        def gross_cents
+          (gross.to_f * 100.0).round
+        end
+
+        # This combines the gross and currency and returns a proper Money object. 
+        # this requires the money library located at http://dist.leetsoft.com/api/money
+        def amount
+          return Money.new(gross_cents, currency) rescue ArgumentError
+          return Money.new(gross_cents) # maybe you have an own money object which doesn't take a currency?
+        end
+
+        # reset the notification. 
+        def empty!
+          @params  = Hash.new
+          @raw     = ""      
+        end
+        
+        # Check if the request comes from an official IP
+        def valid_sender?(ip)
+          return true if ActiveMerchant::Billing::Base.integration_mode == :test || production_ips.blank?
+          production_ips.include?(ip)
+        end
+        
+        private
+
+        # Take the posted data and move the relevant data into a hash
+        def parse(post)
+          @raw = post.to_s
+          for line in @raw.split('&')    
+            key, value = *line.scan( %r{^([A-Za-z0-9_.]+)\=(.*)$} ).flatten
+            params[key] = CGI.unescape(value)
+          end
+        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/paypal/helper.rb

@@ -0,0 +1,119 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Paypal
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+         CANADIAN_PROVINCES = {  'AB' => 'Alberta',
+                                 'BC' => 'British Columbia',
+                                 'MB' => 'Manitoba',
+                                 'NB' => 'New Brunswick',
+                                 'NL' => 'Newfoundland',
+                                 'NS' => 'Nova Scotia',
+                                 'NU' => 'Nunavut',
+                                 'NT' => 'Northwest Territories',
+                                 'ON' => 'Ontario',
+                                 'PE' => 'Prince Edward Island',
+                                 'QC' => 'Quebec',
+                                 'SK' => 'Saskatchewan',
+                                 'YT' => 'Yukon'
+                               } 
+          # See https://www.paypal.com/IntegrationCenter/ic_std-variable-reference.html for details on the following options.
+          mapping :order, [ 'item_number', 'custom' ]
+
+          def initialize(order, account, options = {})
+            super
+            add_field('cmd', '_ext-enter')
+            add_field('redirect_cmd', '_xclick')
+            add_field('quantity', 1)
+            add_field('item_name', 'Store purchase')
+            add_field('no_shipping', '1')
+            add_field('no_note', '1')
+            add_field('charset', 'utf-8')
+            add_field('address_override', '0')
+            add_field('bn', application_id.to_s.slice(0,32)) unless application_id.blank?
+          end
+
+          mapping :amount, 'amount'
+          mapping :account, 'business'
+          mapping :currency, 'currency_code'
+          mapping :notify_url, 'notify_url'
+          mapping :return_url, 'return'
+          mapping :cancel_return_url, 'cancel_return'
+          mapping :invoice, 'invoice'
+          mapping :item_name, 'item_name'
+          mapping :quantity, 'quantity'
+          mapping :no_shipping, 'no_shipping'
+          mapping :no_note, 'no_note'
+          mapping :address_override, 'address_override'
+
+          mapping :application_id, 'bn'
+
+          mapping :customer, :first_name => 'first_name',
+                             :last_name  => 'last_name',
+                             :email      => 'email'
+
+          mapping :shipping_address,  :city    => 'city',
+                                      :address1 => 'address1',
+                                      :address2 => 'address2',
+                                      :state   => 'state',
+                                      :zip     => 'zip',
+                                      :country => 'country'
+          
+          def shipping_address(params = {})
+
+            # Get the country code in the correct format
+            # Use what we were given if we can't find anything
+            country_code = lookup_country_code(params.delete(:country))
+            add_field(mappings[:shipping_address][:country], country_code)
+            
+            if params.has_key?(:phone)
+              phone = params.delete(:phone).to_s
+          
+              # Whipe all non digits
+              phone.gsub!(/\D+/, '')
+              
+              if ['US', 'CA'].include?(country_code) && phone =~ /(\d{3})(\d{3})(\d{4})$/
+                add_field('night_phone_a', $1) 
+                add_field('night_phone_b', $2) 
+                add_field('night_phone_c', $3) 
+              else
+                add_field('night_phone_b', phone)                
+              end
+            end
+              
+            province_code = params.delete(:state)
+                       
+            case country_code
+            when 'CA'
+              add_field(mappings[:shipping_address][:state], CANADIAN_PROVINCES[province_code.upcase]) unless province_code.nil?
+            when 'US'
+              add_field(mappings[:shipping_address][:state], province_code)
+            else
+              add_field(mappings[:shipping_address][:state], province_code.blank? ? 'N/A' : province_code)
+            end
+              
+            # Everything else 
+            params.each do |k, v|
+              field = mappings[:shipping_address][k]
+              add_field(field, v) unless field.nil?
+            end
+          end
+          
+          mapping :tax, 'tax'
+          mapping :shipping, 'shipping'
+          mapping :cmd, 'cmd'
+          mapping :custom, 'custom'
+          mapping :src, 'src'
+          mapping :sra, 'sra'
+          %w(a p t).each do |l|
+            (1..3).each do |i|
+              mapping "#{l}#{i}".to_sym, "#{l}#{i}"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+

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