johnreitano-activemerchant 1.5.2

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

@@ -0,0 +1,67 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module HiTrust
+        class Return < ActiveMerchant::Billing::Integrations::Return
+          SUCCESS = "00"
+          CODES = { "00"   => "Operation completed successfully",
+                    "-1"  => "Unable to initialize winsock dll.",
+                    "-2"  => "Can't create stream socket.",
+                    "-3"  => "No Request Message.", 
+                    "-4"  => "Can't connect to server.",
+                    "-5"  => "Send socket error.",
+                    "-6"  => "Couldn't receive data.", 
+                    "-7"  => "Receive Broken message.",
+                    "-8"  => "Unable to initialize Envirnment.",
+                    "-9"  => "Can't Read Server RSA File.",
+                    "-10" => "Can't Read Client RSA File.",
+                    "-11" => "Web Server error.",
+                    "-12" => "Receive Message type error.",
+                    "-13" => "No Request Message.",
+                    "-14" => "No Response Content.",
+                    "-18" => "Merchant Update URL not found.",
+                    "-19" => "Server URL not find Domain or IP.",
+                    "-20" => "Server URL only can fill http or https.",
+                    "-21" => "Server Config File open error.",
+                    "-22" => "Server RSA Key File open error.",
+                    "-23" => "Server RSA Key File read error.",
+                    "-24" => "Server Config File have some errors, Please to check it.",
+                    "-25" => "Merchant Config File open error.",
+                    "-26" => "Merchant RSA Key File open error.",
+                    "-27" => "Merchant RSA Key File read error.",
+                    "-28" => "Merchant Config File has some errors, Please to check it.",
+                    "-29" => "Server Type is unknown.",
+                    "-30" => "Comm Type is unknown.",
+                    "-31" => "Input Parameter [ORDERNO] is null or empty.",
+                    "-32" => "Input Parameter [STOREID] is null or empty.",
+                    "-33" => "Input Parameter [ORDERDESC] is null or empty.",
+                    "-34" => "Input Parameter [CURRENCY] is null or empty.",
+                    "-35" => "Input Parameter [AMOUNT] is null or empty.",
+                    "-36" => "Input Parameter [ORDERURL] is null or empty.",
+                    "-37" => "Input Parameter [RETURNURL] is null or empty.",
+                    "-38" => "Input Parameter [DEPOSIT] is null or empty.",
+                    "-39" => "Input Parameter [QUERYFLAG] is null or empty.",
+                    "-40" => "Input Parameter [UPDATEURL] is null or empty.",
+                    "-41" => "Input Parameter [MERUPDATEURL] is null or empty.",
+                    "-42" => "Input Parameter [KEY] is null or empty.",
+                    "-43" => "Input Parameter [MAC] is null or empty.",
+                    "-44" => "Input Parameter [CIPHER] is null or empty.",
+                    "-45" => "Input Parameter [TrxType] is wrong.",
+                    "-100" => "TrustLink Server is closed. Or Merchant Server IP is not consistent with TrustLink Server setting.",
+                    "-101" => "TrustLink Server receives NULL.",
+                    "-308" => "Order Number already exists.",
+                    "positive" => "Response from Bank. Please contact with Acquirer Bank Service or HiTRUST Call Center."
+                  }
+          
+          def success?
+            params['retcode'] == SUCCESS
+          end
+          
+          def message
+            CODES[ params['retcode'] ]
+          end
+	      end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module HiTrust 
+        autoload :Helper, File.dirname(__FILE__) + '/hi_trust/helper.rb'
+        autoload :Return, File.dirname(__FILE__) + '/hi_trust/return.rb'
+        autoload :Notification, File.dirname(__FILE__) + '/hi_trust/notification.rb'
+
+        TEST_URL = 'https://testtrustlink.hitrust.com.tw/TrustLink/TrxReq'
+        LIVE_URL = 'https://trustlink.hitrust.com.tw/TrustLink/TrxReq'
+        
+        def self.service_url
+          ActiveMerchant::Billing::Base.integration_mode == :test ? TEST_URL : LIVE_URL
+        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/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/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://www.nochex.com/nochex.dll/checkout'
+
+        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)
+          Notification.new(post)
+        end  
+        
+        def self.return(query_string)
+          Return.new(query_string)
+        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/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
+
+