activemerchant-nsp 1.27.0

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

@@ -0,0 +1,13 @@
+require 'active_merchant/billing/integrations/valitor/response_fields'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Valitor
+        class Return < ActiveMerchant::Billing::Integrations::Return
+          include ResponseFields
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/verkkomaksut/helper.rb'
+require File.dirname(__FILE__) + '/verkkomaksut/notification.rb'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      
+      # Usage, see the blog post here: http://blog.kiskolabs.com/post/22374612968/understanding-active-merchant-integrations and E1 API documentation here: http://docs.verkkomaksut.fi/
+      module Verkkomaksut 
+       
+        mattr_accessor :service_url
+        self.service_url = 'https://payment.verkkomaksut.fi/'
+
+        def self.notification(post)
+          Notification.new(post)
+        end  
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Verkkomaksut
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          
+          # Fetches the md5secret and adds MERCHANT_ID and API TYPE to the form
+          def initialize(order, account, options = {})
+            md5secret options.delete(:credential2)
+            super
+            add_field("MERCHANT_ID", account)
+            add_field("TYPE", "E1")
+          end          
+          
+          def md5secret(value)
+            @md5secret = value
+          end
+          
+          # Adds the AUTHCODE to the form
+          def form_fields
+            @fields.merge("AUTHCODE" => generate_md5string)
+          end
+          
+          # Calculates the AUTHCODE
+          def generate_md5string
+            fields = [@md5secret, @fields["MERCHANT_ID"], @fields["ORDER_NUMBER"], @fields["REFERENCE_NUMBER"], @fields["ORDER_DESCRIPTION"], @fields["CURRENCY"], @fields["RETURN_ADDRESS"], @fields["CANCEL_ADDRESS"], @fields["PENDING_ADDRESS"],
+                      @fields["NOTIFY_ADDRESS"], @fields["TYPE"], @fields["CULTURE"], @fields["PRESELECTED_METHOD"], @fields["MODE"], @fields["VISIBLE_METHODS"], @fields["GROUP"], @fields["CONTACT_TELNO"], @fields["CONTACT_CELLNO"],
+                      @fields["CONTACT_EMAIL"], @fields["CONTACT_FIRSTNAME"], @fields["CONTACT_LASTNAME"], @fields["CONTACT_COMPANY"], @fields["CONTACT_ADDR_STREET"], @fields["CONTACT_ADDR_ZIP"], @fields["CONTACT_ADDR_CITY"], @fields["CONTACT_ADDR_COUNTRY"], @fields["INCLUDE_VAT"],
+                      @fields["ITEMS"]]
+                      
+            (0..@fields["ITEMS"].to_i-1).each do |i|
+              fields += [@fields["ITEM_TITLE[#{i}]"], @fields["ITEM_NO[#{i}]"], @fields["ITEM_AMOUNT[#{i}]"], @fields["ITEM_PRICE[#{i}]"], @fields["ITEM_TAX[#{i}]"], @fields["ITEM_DISCOUNT[#{i}]"], @fields["ITEM_TYPE[#{i}]"]]
+            end
+                      
+            fields = fields.join("|")
+            
+            return Digest::MD5.hexdigest(fields).upcase
+          end
+          
+          # Mappings
+          mapping :merchant_id, "MERCHANT_ID"
+          mapping :order, "ORDER_NUMBER"
+          mapping :reference_number, "REFERENCE_NUMBER"
+          mapping :customer, :first_name => "CONTACT_FIRSTNAME",
+                             :last_name  => "CONTACT_LASTNAME",
+                             :email      => "CONTACT_EMAIL",
+                             :phone      => "CONTACT_CELLNO",
+                             :tellno     => "CONTACT_TELLNO",
+                             :company    => "CONTACT_COMPANY"
+              
+          
+          mapping :billing_address, :city     => "CONTACT_ADDR_CITY",
+                                    :address1 => "CONTACT_ADDR_STREET",
+                                    :address2 => "",
+                                    :state    => "",
+                                    :zip      => "CONTACT_ADDR_ZIP",
+                                    :country  => "CONTACT_ADDR_COUNTRY"
+
+          mapping :notify_url, "NOTIFY_ADDRESS"
+          mapping :currency, "CURRENCY"
+          mapping :return_url, "RETURN_ADDRESS"
+          mapping :cancel_return_url, "CANCEL_ADDRESS"
+          mapping :description, "ORDER_DESCRIPTION"
+          mapping :tax, ""
+          mapping :shipping, ""
+          mapping :include_vat, "INCLUDE_VAT"
+          mapping :pending_address, "PENDING_ADDRESS"
+          mapping :culture, "CULTURE"
+          mapping :items, "ITEMS"
+          mapping :preselected_method, "PRESELECTED_METHOD"
+          mapping :mode, "MODE"
+          mapping :visible_methods, "VISIBLE_METHODS"
+          mapping :group, "GROUP"
+          
+          (0..499.to_i).each do |i|
+            mapping "item_no_#{i}".to_sym, "ITEM_NO[#{i}]"
+            mapping "item_amount_#{i}".to_sym, "ITEM_AMOUNT[#{i}]"
+            mapping "item_price_#{i}".to_sym, "ITEM_PRICE[#{i}]"
+            mapping "item_tax_#{i}".to_sym, "ITEM_TAX[#{i}]"
+            mapping "item_discount_#{i}".to_sym, "ITEM_DISCOUNT[#{i}]"
+            mapping "item_type_#{i}".to_sym, "ITEM_TYPE[#{i}]"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require 'net/http'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Verkkomaksut
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+
+          # Is the payment complete or not. Verkkomaksut only has two statuses: random string or 0000000000 which means pending
+          def complete?
+            params['PAID'] != "0000000000"
+          end 
+          
+          # Order id
+          def order_id
+            params['ORDER_NUMBER']
+          end
+          
+          # Payment method used
+          def method
+            params['METHOD']
+          end
+          
+          # When was this payment received by the client. 
+          def received_at
+            params['TIMESTAMP']
+          end
+          
+          # Security key got from Verkkomaksut
+          def security_key
+            params['RETURN_AUTHCODE']
+          end
+          
+          # Another way of asking the payment status
+          def status
+            if complete?
+              "PAID"
+            else
+              "PENDING"
+            end
+          end
+          
+          # Acknowldges the payment. If the authcodes match, returns true.
+          def acknowledge(authcode)
+            return_authcode = [params["ORDER_NUMBER"], params["TIMESTAMP"], params["PAID"], params["METHOD"], authcode].join("|")
+            Digest::MD5.hexdigest(return_authcode).upcase == params["RETURN_AUTHCODE"]
+          end
+ private
+ 
+          def parse(post)
+            post.each do |key, value|
+              params[key] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+
+      # Documentation: You will get it after registration steps here:
+      # http://reg.webpay.by/registration-form.php
+      module WebPay
+        autoload :Helper, File.dirname(__FILE__) + '/web_pay/helper.rb'
+        autoload :Notification, File.dirname(__FILE__) + '/web_pay/notification.rb'
+        autoload :Common, File.dirname(__FILE__) + '/web_pay/common.rb'
+
+        # Overwrite this if you want to change the WebPay sandbox url
+        mattr_accessor :test_url
+        self.test_url = 'https://secure.sandbox.webpay.by:8843'
+
+        # Overwrite this if you want to change the WebPay production url
+        mattr_accessor :production_url
+        self.production_url = 'https://secure.webpay.by'
+
+        mattr_accessor :signature_parameter_name
+        self.signature_parameter_name = 'wsb_signature'
+
+        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.helper(order, account, options = {})
+          Helper.new(order, account, options)
+        end
+
+        def self.notification(query_string, options = {})
+          Notification.new(query_string, options)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/web_pay/common.rb

@@ -0,0 +1,50 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module WebPay
+        module Common
+          def generate_signature(type)
+            string = case type
+            when :request
+              request_signature_string
+            when :notify
+              notify_signature_string
+            end
+            if type != :notify && @fields[mappings[:version]] == '2'
+              Digest::SHA1.hexdigest(string)
+            else
+              Digest::MD5.hexdigest(string)
+            end
+          end
+
+          def request_signature_string
+            [
+              @fields[mappings[:seed]],
+              @fields[mappings[:account]],
+              @fields[mappings[:order]],
+              @fields[mappings[:test]],
+              @fields[mappings[:currency]],
+              @fields[mappings[:amount]],
+              secret
+            ].join
+          end
+
+          def notify_signature_string
+            [
+              params['batch_timestamp'],
+              params['currency_id'],
+              params['amount'],
+              params['payment_method'],
+              params['order_id'],
+              params['site_order_id'],
+              params['transaction_id'],
+              params['payment_type'],
+              params['rrn'],
+              secret
+            ].join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module WebPay
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          include Common
+
+          def initialize(order, account, options = {})
+            @md5secret = options.delete(:secret)
+            @line_item_count = 0
+            super
+          end
+
+          def form_fields
+            @fields.merge(ActiveMerchant::Billing::Integrations::WebPay.signature_parameter_name => generate_signature(:request))
+          end
+
+          def params
+            @fields
+          end
+
+          def secret
+            @md5secret
+          end
+
+          def add_line_item(options)
+            options.each do |key, value|
+              add_field("wsb_invoice_item_#{key}[#{@line_item_count}]", value)
+            end
+
+            @line_item_count += 1
+          end
+
+          def calculate_total
+            sum = 0
+
+            @line_item_count.times do |i|
+              sum += @fields["wsb_invoice_item_quantity[#{i}]"].to_i * @fields["wsb_invoice_item_price[#{i}]"].to_i
+            end
+
+            sum + @fields[mappings[:tax]].to_i + @fields[mappings[:shipping_price]].to_i - @fields[mappings[:discount_price]].to_i
+          end
+
+          mapping :scart, '*scart'
+          mapping :account, 'wsb_storeid'
+          mapping :store, 'wsb_store'
+          mapping :order, 'wsb_order_num'
+          mapping :currency, 'wsb_currency_id'
+          mapping :version, 'wsb_version'
+          mapping :language, 'wsb_language_id'
+          mapping :seed, 'wsb_seed'
+          mapping :success_url, 'wsb_return_url'
+          mapping :cancel_url, 'wsb_cancel_return_url'
+          mapping :notify_url, 'wsb_notify_url'
+          mapping :test, 'wsb_test'
+          mapping :tax, 'wsb_tax'
+          mapping :shipping_name, 'wsb_shipping_name'
+          mapping :shipping_price, 'wsb_shipping_price'
+          mapping :discount_name, 'wsb_discount_name'
+          mapping :discount_price, 'wsb_discount_price'
+          mapping :amount, 'wsb_total'
+          mapping :email, 'wsb_email'
+          mapping :phone, 'wsb_phone'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module WebPay
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          include Common
+
+          def self.recognizes?(params)
+            params.has_key?('site_order_id') && params.has_key?('amount')
+          end
+
+          def complete?
+            true
+          end
+
+          def amount
+            BigDecimal.new(gross)
+          end
+
+          def item_id
+            params['site_order_id']
+          end
+
+          def security_key
+            params[ActiveMerchant::Billing::Integrations::WebPay.signature_parameter_name]
+          end
+
+          def gross
+            params['amount']
+          end
+
+          def status
+            'success'
+          end
+
+          def secret
+            @options[:secret]
+          end
+
+          def acknowledge
+            (security_key == generate_signature(:notify))
+          end
+
+          def success_response(*args)
+            {:nothing => true}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/world_pay/helper.rb'
+require File.dirname(__FILE__) + '/world_pay/notification.rb'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module WorldPay 
+       
+        # production and test have the same endpoint
+        mattr_accessor :production_url
+        self.production_url = 'https://secure.wp3.rbsworldpay.com/wcc/purchase'
+        
+        def self.service_url
+          production_url
+        end
+
+        def self.notification(post, options = {})
+          Notification.new(post, options)
+        end
+        
+        def self.return(post, options = {})
+          Return.new(post, options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module WorldPay
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          mapping :account, 'instId'
+          mapping :amount, 'amount'
+          mapping :order, 'cartId'
+          mapping :currency, 'currency'
+
+          mapping :customer, :email => 'email',
+                             :phone => 'tel'
+
+          mapping :billing_address, :zip => 'postcode',
+                                    :country  => 'country'
+
+          mapping :description, 'desc'
+          mapping :notify_url, 'MC_callback'
+          
+          
+          # WorldPay supports two different test modes - :always_succeed and :always_fail
+          def initialize(order, account, options = {})
+            super
+            
+            if ActiveMerchant::Billing::Base.integration_mode == :test || options[:test]
+              test_mode = case options[:test]
+              when :always_fail
+                101
+              when false
+                0
+              else
+                100
+              end
+              add_field('testMode', test_mode.to_s)
+            elsif ActiveMerchant::Billing::Base.integration_mode == :always_succeed
+              add_field('testMode', '100')
+            elsif ActiveMerchant::Billing::Base.integration_mode == :always_fail
+              add_field('testMode', '101')
+            end
+          end
+          
+          # WorldPay only supports a single address field so we 
+          # have to concat together - lines are separated using &#10;
+          def billing_address(params={})
+            add_field(mappings[:billing_address][:zip], params[:zip])
+            add_field(mappings[:billing_address][:country], lookup_country_code(params[:country]))
+            
+            address = [params[:address1], params[:address2], params[:city], params[:state]].compact
+            add_field('address', address.join('&#10;'))
+          end
+          
+          # WorldPay only supports a single name field so we have to concat
+          def customer(params={})
+            add_field(mappings[:customer][:email], params[:email])
+            add_field(mappings[:customer][:phone], params[:phone])
+            add_field('name', "#{params[:first_name]} #{params[:last_name]}")
+          end
+          
+          # Support for a MD5 hash of selected fields to prevent tampering
+          # For futher information read the tech note at the address below: 
+          # http://support.worldpay.com/kb/integration_guides/junior/integration/help/tech_notes/sjig_tn_009.html
+          def encrypt(secret, fields = [:amount, :currency, :account, :order])
+            signature_fields = fields.collect{ |field| mappings[field] }
+            add_field('signatureFields', signature_fields.join(':'))
+
+            field_values = fields.collect{ |field| form_fields[mappings[field]] }
+            signature    = "#{secret}:#{field_values.join(':')}"            
+            add_field('signature', Digest::MD5.hexdigest(signature))
+          end
+          
+          # Add a time window for which the payment can be completed. Read the link below for how they work
+          # http://support.worldpay.com/kb/integration_guides/junior/integration/help/appendicies/sjig_10100.html
+          def valid_from(from_time)
+            add_field('authValidFrom', from_time.to_i.to_s + '000')
+          end
+          
+          def valid_to(to_time)
+            add_field('authValidTo', to_time.to_i.to_s + '000')
+          end
+          
+          # WorldPay supports the passing of custom parameters prefixed with the following:
+          # C_          : These parameters can be used in the response pages hosted on WorldPay's site
+          # M_          : These parameters are passed through to the callback script (if enabled)
+          # MC_ or CM_  : These parameters are availble both in the response and callback contexts
+          def response_params(params={})
+            params.each{|k,v| add_field("C_#{k}",v)}
+          end
+          
+          def callback_params(params={})
+            params.each{|k,v| add_field("M_#{k}",v)}
+          end
+          
+          def combined_params(params={})
+            params.each{|k,v| add_field("MC_#{k}",v)}
+          end
+        end
+      end
+    end
+  end
+end