offsite_payments 2.0.0

data/lib/offsite_payments/integrations/directebanking.rb

@@ -0,0 +1,237 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Directebanking
+      # Supported countries:
+      # Germany - DE
+      # Austria - AT
+      # Belgium - BE
+      # Netherlands - NL
+      # Switzerland - CH
+      # Great Britain - GB
+
+      # Overwrite this if you want to change the directebanking test url
+      mattr_accessor :test_url
+      self.test_url = 'https://www.directebanking.com/payment/start'
+
+      # Overwrite this if you want to change the directebanking production url
+      mattr_accessor :production_url
+      self.production_url = 'https://www.directebanking.com/payment/start'
+
+      def self.service_url
+        mode = OffsitePayments.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, options = {})
+        Notification.new(post, options)
+      end
+
+      def self.return(post, options = {})
+        Return.new(post, options)
+      end
+
+      class Helper < OffsitePayments::Helper
+        # All credentials are mandatory and need to be set
+        #
+        # credential1: User ID
+        # credential2: Project ID
+        # credential3: Project Password (Algorithm: SH1)
+        # credential4: Notification Password (Algorithm: SH1)
+        def initialize(order, account, options = {})
+          super
+          add_field('user_variable_0', order)
+          add_field('project_id', options[:credential2])
+          @project_password = options[:credential3]
+        end
+
+        SIGNATURE_FIELDS = [
+          :user_id,
+          :project_id,
+          :sender_holder,
+          :sender_account_number,
+          :sender_bank_code,
+          :sender_country_id,
+          :amount,
+          :currency_id,
+          :reason_1,
+          :reason_2,
+          :user_variable_0,
+          :user_variable_1,
+          :user_variable_2,
+          :user_variable_3,
+          :user_variable_4,
+          :user_variable_5
+        ]
+
+        SIGNATURE_IGNORE_AT_METHOD_CREATION_FIELDS = [
+          :user_id,
+          :amount,
+          :project_id,
+          :currency_id,
+          :user_variable_0,
+          :user_variable_1,
+          :user_variable_2,
+          :user_variable_3
+        ]
+
+        SIGNATURE_FIELDS.each do |key|
+          if !SIGNATURE_IGNORE_AT_METHOD_CREATION_FIELDS.include?(key)
+            mapping "#{key}".to_sym, "#{key.to_s}"
+          end
+        end
+
+        # Need to format the amount to have 2 decimal places
+        def amount=(money)
+          cents = money.respond_to?(:cents) ? money.cents : money
+          raise ArgumentError, "amount must be a Money object or an integer" if money.is_a?(String)
+          raise ActionViewHelperError, "amount must be greater than $0.00" if cents.to_i <= 0
+
+          add_field mappings[:amount], sprintf("%.2f", cents.to_f/100)
+        end
+
+        def generate_signature_string
+          # format of signature: user_id|project_id|sender_holder|sender_account_number|sender_bank_code| sender_country_id|amount|currency_id|reason_1|reason_2|user_variable_0|user_variable_1|user_variable_2|user_variable_3|user_variable_4|user_variable_5|project_password
+          SIGNATURE_FIELDS.map {|key| @fields[key.to_s]} * "|" + "|#{@project_password}"
+        end
+
+        def generate_signature
+          Digest::SHA1.hexdigest(generate_signature_string)
+        end
+
+        def form_fields
+          @fields.merge('hash' => generate_signature)
+        end
+
+        mapping :account, 'user_id'
+        mapping :amount, 'amount'
+        mapping :currency, 'currency_id'
+        mapping :description, 'reason_1'
+
+        mapping :return_url, 'user_variable_1'
+        mapping :cancel_return_url, 'user_variable_2'
+        mapping :notify_url, 'user_variable_3'
+      end
+
+      class Notification < OffsitePayments::Notification
+        def initialize(data, options)
+          if options[:credential4].nil?
+            raise ArgumentError, "You need to provide the notification password (SH1) as the option :credential4 to verify that the notification originated from Directebanking (Payment Networks AG)"
+          end
+          super
+        end
+
+        def complete?
+          status == 'Completed'
+        end
+
+        def item_id
+          params['user_variable_0']
+        end
+
+        def transaction_id
+          params['transaction']
+        end
+
+        # When was this payment received by the client.
+        def received_at
+          Time.parse(params['created']) if params['created']
+        end
+
+        # the money amount we received in X.2 decimal.
+        def gross
+          "%.2f" % params['amount'].to_f
+        end
+
+        def status
+          'Completed'
+        end
+
+        def currency
+          params['currency_id']
+        end
+
+        def test?
+          params['sender_bank_name'] == 'Testbank'
+        end
+
+        # for verifying the signature of the URL parameters
+        PAYMENT_HOOK_SIGNATURE_FIELDS = [
+          :transaction,
+          :user_id,
+          :project_id,
+          :sender_holder,
+          :sender_account_number,
+          :sender_bank_code,
+          :sender_bank_name,
+          :sender_bank_bic,
+          :sender_iban,
+          :sender_country_id,
+          :recipient_holder,
+          :recipient_account_number,
+          :recipient_bank_code,
+          :recipient_bank_name,
+          :recipient_bank_bic,
+          :recipient_iban,
+          :recipient_country_id,
+          :international_transaction,
+          :amount,
+          :currency_id,
+          :reason_1,
+          :reason_2,
+          :security_criteria,
+          :user_variable_0,
+          :user_variable_1,
+          :user_variable_2,
+          :user_variable_3,
+          :user_variable_4,
+          :user_variable_5,
+          :created
+        ]
+
+        PAYMENT_HOOK_IGNORE_AT_METHOD_CREATION_FIELDS = [
+          :transaction,
+          :amount,
+          :currency_id,
+          :user_variable_0,
+          :user_variable_1,
+          :user_variable_2,
+          :user_variable_3,
+          :created
+        ]
+
+        # Provide access to raw fields
+        PAYMENT_HOOK_SIGNATURE_FIELDS.each do |key|
+          if !PAYMENT_HOOK_IGNORE_AT_METHOD_CREATION_FIELDS.include?(key)
+            define_method(key.to_s) do
+               params[key.to_s]
+            end
+          end
+        end
+
+        def generate_signature_string
+          #format is: transaction|user_id|project_id|sender_holder|sender_account_number|sender_bank_code|sender_bank_name|sender_bank_bic|sender_iban|sender_country_id|recipient_holder|recipient_account_number|recipient_bank_code|recipient_bank_name|recipient_bank_bic|recipient_iban|recipient_country_id|international_transaction|amount|currency_id|reason_1|reason_2|security_criteria|user_variable_0|user_variable_1|user_variable_2|user_variable_3|user_variable_4|user_variable_5|created|notification_password
+          PAYMENT_HOOK_SIGNATURE_FIELDS.map {|key| params[key.to_s]} * "|" + "|#{@options[:credential4]}"
+        end
+
+        def generate_signature
+          Digest::SHA1.hexdigest(generate_signature_string)
+        end
+
+        def acknowledge(authcode = nil)
+          # signature_is_valid?
+          generate_signature.to_s == params['hash'].to_s
+        end
+      end
+
+      class Return < OffsitePayments::Return
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/doku.rb

@@ -0,0 +1,171 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Doku
+      def self.service_url
+        'https://apps.myshortcart.com/payment/request-payment/'
+      end
+
+      def self.notification(post, options = {})
+        Notification.new(post, options)
+      end
+
+      def self.return(post, options = {})
+        Return.new(post, options)
+      end
+
+      # # Example.
+      #
+      #  payment_service_for('ORDER_ID', 'DOKU_STORE_ID', :service => :doku,  :amount => 155_000, :shared_key => 'DOKU_SHARED_KEY') do |service|
+      #
+      #    service.customer :name              => 'Ismail Danuarta',
+      #                     :email             => 'ismail.danuarta@gmail.com',
+      #                     :mobile_phone      => '085779280093',
+      #                     :working_phone     => '0215150555',
+      #                     :home_phone        => '0215150555',
+      #                     :birth_date        => '1991-09-11'
+      #
+      #    service.billing_address :city     => 'Jakarta Selatan',
+      #                            :address  => 'Jl. Jendral Sudirman kav 59, Plaza Asia Office Park Unit 3',
+      #                            :state    => 'DKI Jakarta',
+      #                            :zip      => '12190',
+      #                            :country  => 'ID'
+
+      #    service.shipping_address :city     => 'Jakarta',
+      #                             :address  => 'Jl. Jendral Sudirman kav 59, Plaza Asia Office Park Unit 3',
+      #                             :state    => 'DKI Jakarta',
+      #                             :zip      => '12190',
+      #                             :country  => 'ID'
+      #
+      #    service.url 'http://yourstore.com'
+      #
+      # end
+      #
+      class Helper < OffsitePayments::Helper
+        def initialize(order, account, options = {})
+          @shared_key      = options.delete(:credential2)
+          @transidmerchant = order
+          super
+        end
+
+        def form_fields
+          add_field 'WORDS', words
+          add_field 'BASKET', basket
+          add_field 'TRANSIDMERCHANT', @transidmerchant
+          @fields
+        end
+
+        def customer(params = {})
+          add_field mappings[:customer][:name], "#{params[:first_name]} #{params[:last_name]}"
+          add_field mappings[:customer][:email], params[:email]
+          add_field mappings[:customer][:phone], params[:phone]
+          add_field mappings[:customer][:mobile_phone], params[:mobile_phone]
+          add_field mappings[:customer][:working_phone], params[:working_phone]
+          add_field mappings[:customer][:birth_date], params[:birth_date]
+        end
+
+        mapping :account,           'STOREID'
+        mapping :amount,            'AMOUNT'
+        mapping :cancel_return_url, 'URL'
+
+
+        mapping :customer, :name          => 'CNAME',
+                           :email         => 'CEMAIL',
+                           :phone         => 'CHPHONE',
+                           :mobile_phone  => 'CMPHONE',
+                           :working_phone => 'CWPHONE',
+                           :birth_date    => 'BIRTHDATE'
+
+        mapping :billing_address, :city     => 'CCITY',
+                                  :address1 => 'CADDRESS',
+                                  :state    => 'CSTATE',
+                                  :zip      => 'CZIPCODE',
+                                  :country  => 'CCOUNTRY'
+
+        mapping :shipping_address,  :city     => 'SCITY',
+                                    :address1 => 'SADDRESS',
+                                    :state    => 'SSTATE',
+                                    :zip      => 'SZIPCODE',
+                                    :country  => 'SCOUNTRY'
+
+        private
+
+        def basket
+          "Checkout #{@transidmerchant},#{@fields['AMOUNT']},1,#{@fields['AMOUNT']}"
+        end
+
+        def words
+          @words ||= Digest::SHA1.hexdigest("#{ @fields['AMOUNT'] }#{ @shared_key }#{ @transidmerchant }")
+        end
+
+        def add_address(key, params)
+          return if mappings[key].nil?
+
+          code = lookup_country_code(params.delete(:country), :numeric)
+          add_field(mappings[key][:country], code)
+          add_fields(key, params)
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        self.production_ips = ['103.10.128.11', '103.10.128.14']
+
+        def complete?
+          status.present?
+        end
+
+        def item_id
+          params['TRANSIDMERCHANT']
+        end
+
+        def gross
+          params['AMOUNT']
+        end
+
+        def status
+          case params['RESULT']
+          when 'Success'
+            'Completed'
+          when 'Fail'
+            'Failed'
+          end
+        end
+
+        def currency
+          'IDR'
+        end
+
+        def words
+          params['WORDS']
+        end
+
+        def type
+          if words && params['STOREID']
+            'verify'
+          elsif status
+            'notify'
+          end
+        end
+
+        # no unique ID is generated by Doku at any point in the process,
+        # so use the same as the original order number.
+        def transaction_id
+          params['TRANSIDMERCHANT']
+        end
+
+        def acknowledge(authcode = nil)
+          case type
+          when 'verify'
+            words == Digest::SHA1.hexdigest("#{gross}#{@options[:credential2]}#{item_id}")
+          when 'notify'
+            true
+          else
+            false
+          end
+        end
+      end
+
+      class Return < OffsitePayments::Return
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/dotpay.rb

@@ -0,0 +1,166 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Dotpay
+      mattr_accessor :service_url
+      self.service_url = 'https://ssl.dotpay.pl'
+
+      def self.notification(post, options = {})
+        Notification.new(post, options)
+      end
+
+      def self.return(post, options = {})
+        Return.new(post, options)
+      end
+
+      class Helper < OffsitePayments::Helper
+        def initialize(order, account, options = {})
+          options = {:currency => 'PLN'}.merge options
+
+          super
+
+          add_field('channel', '0')
+          add_field('ch_lock', '0')
+          add_field('lang', 'PL')
+          add_field('onlinetransfer', '0')
+          add_field('tax', '0')
+          add_field('type', '2')
+        end
+
+        mapping :account,         'id'
+        mapping :amount,          'amount'
+
+        mapping :billing_address, :street => 'street',
+                                  :street_n1 => 'street_n1',
+                                  :street_n2 => 'street_n2',
+                                  :addr2 => 'addr2',
+                                  :addr3 => 'addr3',
+                                  :city => 'city',
+                                  :postcode => 'postcode',
+                                  :phone => 'phone',
+                                  :country => 'country'
+
+        mapping :buttontext,      'buttontext'
+        mapping :channel,         'channel'
+        mapping :ch_lock,         'ch_lock'
+        mapping :code,            'code'
+        mapping :control,         'control'
+        mapping :currency,        'currency'
+
+        mapping :customer,        :firstname => 'firstname',
+                                  :lastname => 'lastname',
+                                  :email => 'email'
+
+        mapping :description,     'description'
+        mapping :lang,            'lang'
+        mapping :onlinetransfer,  'onlinetransfer'
+        mapping :order,           'description'
+        mapping :p_email,         'p_email'
+        mapping :p_info,          'p_info'
+        mapping :tax,             'tax'
+        mapping :type,            'type'
+        mapping :url,             'url'
+        mapping :urlc,            'urlc'
+
+        def billing_address(params = {})
+          country = lookup_country_code(params.delete(:country) { 'POL' }, :alpha3)
+          add_field(mappings[:billing_address][:country], country)
+
+          # Everything else
+          params.each do |k, v|
+            field = mappings[:billing_address][k]
+            add_field(field, v) unless field.nil?
+          end
+        end
+
+        private
+
+        def lookup_country_code(name_or_code, format = country_format)
+          country = ActiveMerchant::Country.find(name_or_code)
+          country.code(format).to_s
+        rescue ActiveMerchant::InvalidCountryCodeError
+          name_or_code
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        def complete?
+          status == 'OK' && %w(2 4 5).include?(t_status)
+        end
+
+        def currency
+          orginal_amount.split(' ')[1]
+        end
+
+        # the money amount we received in X.2 decimal.
+        def gross
+          params['amount']
+        end
+
+        def pin=(value)
+          @options[:pin] = value
+        end
+
+        def status
+          params['status']
+        end
+
+        def test?
+          params['t_id'].match('.*-TST\d+') ? true : false
+        end
+
+        PAYMENT_HOOK_FIELDS = [
+          :id,
+          :control,
+          :t_id,
+          :orginal_amount,
+          :email,
+          :service,
+          :code,
+          :username,
+          :password,
+          :t_status,
+          :description,
+          :md5,
+          :p_info,
+          :p_email,
+          :t_date
+        ]
+
+        PAYMENT_HOOK_SIGNATURE_FIELDS = [
+          :id,
+          :control,
+          :t_id,
+          :amount,
+          :email,
+          :service,
+          :code,
+          :username,
+          :password,
+          :t_status
+        ]
+
+        # Provide access to raw fields
+        PAYMENT_HOOK_FIELDS.each do |key|
+          define_method(key.to_s) do
+             params[key.to_s]
+          end
+        end
+
+        def generate_signature_string
+          "#{@options[:pin]}:" + PAYMENT_HOOK_SIGNATURE_FIELDS.map {|key| params[key.to_s]} * ":"
+        end
+
+        def generate_signature
+          Digest::MD5.hexdigest(generate_signature_string)
+        end
+
+        def acknowledge(authcode = nil)
+          generate_signature.to_s == md5.to_s
+        end
+      end
+
+      class Return < OffsitePayments::Return
+      end
+    end
+  end
+end