tlconnor-activemerchant 1.20.4

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

@@ -0,0 +1,88 @@
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      # To start with Nochex, follow the instructions for installing 
+      # ActiveMerchant as a plugin, as described on 
+      # http://www.activemerchant.org/.
+      # 
+      # The plugin will automatically add the ActionView helper for 
+      # ActiveMerchant, which will allow you to make the Nochex payments.  
+      # The idea behind the helper is that it generates an invisible 
+      # forwarding screen that will automatically redirect the user.  
+      # So you would collect all the information about the order and then 
+      # simply render the hidden form, which redirects the user to Nochex.
+      # 
+      # The syntax of the helper is as follows:
+      # 
+      #   <% payment_service_for 'order id', 'nochex_user_id',
+      #                                 :amount => 50.00,
+      #                                 :service => :nochex,
+      #                                 :html => { :id => 'nochex-form' } do |service| %>
+      #   
+      #      <% service.customer :first_name => 'Cody',
+      #                         :last_name => 'Fauser',
+      #                         :phone => '(555)555-5555',
+      #                         :email => 'cody@example.com' %>
+      #   
+      #      <% service.billing_address :city => 'Ottawa',
+      #                                :address1 => '21 Snowy Brook Lane',
+      #                                :address2 => 'Apt. 36',
+      #                                :state => 'ON',
+      #                                :country => 'CA',
+      #                                :zip => 'K1J1E5' %>
+      #   
+      #      <% service.invoice '#1000' %>
+      #      <% service.shipping '0.00' %>
+      #      <% service.tax '0.00' %>
+      #   
+      #      <% service.notify_url url_for(:action => 'notify', :only_path => false) %>
+      #      <% service.return_url url_for(:action => 'done', :only_path => false) %>
+      #      <% service.cancel_return_url 'http://mystore.com' %>
+      #    <% end %>
+      #   
+      # The notify_url is the URL that the Nochex IPN will be sent.  You can 
+      # handle the notification in your controller action as follows:
+      #   
+      #   class NotificationController < ApplicationController
+      #     include ActiveMerchant::Billing::Integrations
+      #   
+      #     def notify
+      #       notification =  Nochex::Notification.new(request.raw_post)
+      #       
+      #       begin
+      #         # Acknowledge notification with Nochex
+      #         raise StandardError, 'Illegal Notification' unless notification.acknowledge
+      #           # Process the payment  
+      #       rescue => e
+      #           logger.warn("Illegal notification received: #{e.message}")
+      #       ensure
+      #           head(:ok)
+      #       end
+      #     end
+      #   end
+      module Nochex
+        autoload :Return, File.dirname(__FILE__) + '/nochex/return.rb'
+        autoload :Helper, File.dirname(__FILE__) + '/nochex/helper.rb'
+        autoload :Notification, File.dirname(__FILE__) + '/nochex/notification.rb'
+        
+       
+        mattr_accessor :service_url
+        self.service_url = 'https://secure.nochex.com'
+
+        mattr_accessor :notification_confirmation_url
+        self.notification_confirmation_url = 'https://www.nochex.com/nochex.dll/apc/apc'
+
+        # Simply a convenience method that returns a new 
+        # ActiveMerchant::Billing::Integrations::Nochex::Notification
+        def self.notification(post, options = {})
+          Notification.new(post)
+        end  
+        
+        def self.return(query_string, options = {})
+          Return.new(query_string)
+        end
+      end
+    end
+  end
+end

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_attribute :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/payflow_link.rb

@@ -0,0 +1,21 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module PayflowLink
+        autoload :Helper, 'active_merchant/billing/integrations/payflow_link/helper.rb'
+        autoload :Notification, 'active_merchant/billing/integrations/payflow_link/notification.rb'
+
+        mattr_accessor :service_url
+        self.service_url = 'https://payflowlink.paypal.com'
+
+        def self.notification(post, options = {})
+          Notification.new(post)
+        end
+
+        def self.return(query_string, options = {})
+          ActiveMerchant::Billing::Integrations::Return.new(query_string)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module PayflowLink
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          include PostsData
+
+          def initialize(order, account, options = {})
+            super
+            add_field('login', account)
+            add_field('echodata', 'True')
+            add_field('user2', self.test?)
+            add_field('invoice', order)
+            add_field('vendor', account)
+            add_field('user', options[:credential4] || account)
+            add_field('trxtype', options[:transaction_type] || 'S')
+          end
+
+          mapping :account, 'login'
+          mapping :credential2, 'pwd'
+          mapping :credential3, 'partner'
+          mapping :order, 'user1'
+          mapping :description, 'description'
+
+          mapping :amount, 'amt'
+
+
+          mapping :billing_address,  :city    => 'city',
+                                     :address => 'address',
+                                     :state   => 'state',
+                                     :zip     => 'zip',
+                                     :country => 'country',
+                                     :phone   => 'phone',
+                                     :name    => 'name'
+
+          mapping :customer, :name => 'name'
+
+          def customer(params = {})
+            add_field(mappings[:customer][:name], [params.delete(:first_name), params.delete(:last_name)].compact.join(' '))
+          end
+
+          def billing_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[:billing_address][:country], country_code)
+
+            add_field(mappings[:billing_address][:address], [params.delete(:address1), params.delete(:address2)].compact.join(' '))
+
+            province_code = params.delete(:state)
+            add_field(mappings[:billing_address][:state], province_code.blank? ? 'N/A' : province_code.upcase)
+
+            # Everything else
+            params.each do |k, v|
+              field = mappings[:billing_address][k]
+              add_field(field, v) unless field.nil?
+            end
+          end
+
+          def form_fields
+            token, token_id = request_secure_token
+
+            {"securetoken" => token, "securetokenid" => token_id, "mode" => test? ? "test" : "live"}
+          end
+
+          private
+
+          def secure_token_id
+            @secure_token_id ||= Utils.generate_unique_id
+          end
+
+          def secure_token_url
+            test? ? "https://pilot-payflowpro.paypal.com" : "https://payflowpro.paypal.com"
+          end
+
+          def request_secure_token
+            @fields["securetokenid"] = secure_token_id
+            @fields["createsecuretoken"] = "Y"
+
+            fields = @fields.collect {|key, value| "#{key}[#{value.length}]=#{value}" }.join("&")
+
+            response = ssl_post(secure_token_url, fields)
+
+            parse_response(response)
+          end
+
+          def parse_response(response)
+            response = response.split("&").inject({}) do |hash, param|
+              key, value = param.split("=")
+              hash[key] = value
+              hash
+            end
+
+            [response['SECURETOKEN'], response['SECURETOKENID']] if response['RESPMSG'] && response['RESPMSG'].downcase == "approved"
+          end
+        end
+      end
+    end
+  end
+end