better_offsite_payments 2.3.0

data/lib/offsite_payments/integrations/universal.rb

@@ -0,0 +1,190 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Universal
+      def self.notification(post, options = {})
+        Notification.new(post, options)
+      end
+
+      def self.return(query_string, options = {})
+        Return.new(query_string, options)
+      end
+
+      def self.sign(fields, key)
+        OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, key, fields.sort.join)
+      end
+
+      class Helper < OffsitePayments::Helper
+        CURRENCY_SPECIAL_MINOR_UNITS = {
+          'BIF' => 0,
+          'BYR' => 0,
+          'CLF' => 0,
+          'CLP' => 0,
+          'CVE' => 0,
+          'DJF' => 0,
+          'GNF' => 0,
+          'HUF' => 0,
+          'ISK' => 0,
+          'JPY' => 0,
+          'KMF' => 0,
+          'KRW' => 0,
+          'PYG' => 0,
+          'RWF' => 0,
+          'UGX' => 0,
+          'UYI' => 0,
+          'VND' => 0,
+          'VUV' => 0,
+          'XAF' => 0,
+          'XOF' => 0,
+          'XPF' => 0,
+          'BHD' => 3,
+          'IQD' => 3,
+          'JOD' => 3,
+          'KWD' => 3,
+          'LYD' => 3,
+          'OMR' => 3,
+          'TND' => 3,
+          'COU' => 4
+        }
+
+        def initialize(order, account, options = {})
+          @forward_url = options[:forward_url]
+          @key = options[:credential2]
+          @currency = options[:currency]
+
+          # x_credential3 should not be included in the request when using the universal offsite dev kit.
+          options[:credential3] = nil if options[:credential3] == @forward_url
+
+          super
+          self.country = options[:country]
+          self.account_name = options[:account_name]
+          self.transaction_type = options[:transaction_type]
+          add_field 'x_test', @test.to_s
+        end
+
+        def credential_based_url
+          @forward_url
+        end
+
+        def form_fields
+          sign_fields
+        end
+
+        def amount=(amount)
+          add_field 'x_amount', format_amount(amount, @currency)
+        end
+
+        def sign_fields
+          @fields.merge!('x_signature' => generate_signature)
+        end
+
+        def generate_signature
+          Universal.sign(@fields, @key)
+        end
+
+        mapping :account,          'x_account_id'
+        mapping :currency,         'x_currency'
+        mapping :order,            'x_reference'
+        mapping :country,          'x_shop_country'
+        mapping :account_name,     'x_shop_name'
+        mapping :transaction_type, 'x_transaction_type'
+        mapping :description,      'x_description'
+        mapping :invoice,          'x_invoice'
+        mapping :credential3,      'x_credential3'
+        mapping :credential4,      'x_credential4'
+
+        mapping :customer, :first_name => 'x_customer_first_name',
+                           :last_name  => 'x_customer_last_name',
+                           :email      => 'x_customer_email',
+                           :phone      => 'x_customer_phone'
+
+        mapping :billing_address, :first_name => 'x_customer_billing_first_name',
+                                  :last_name =>  'x_customer_billing_last_name',
+                                  :city =>       'x_customer_billing_city',
+                                  :company =>    'x_customer_billing_company',
+                                  :address1 =>   'x_customer_billing_address1',
+                                  :address2 =>   'x_customer_billing_address2',
+                                  :state =>      'x_customer_billing_state',
+                                  :zip =>        'x_customer_billing_zip',
+                                  :country =>    'x_customer_billing_country',
+                                  :phone =>      'x_customer_billing_phone'
+
+        mapping :shipping_address, :first_name => 'x_customer_shipping_first_name',
+                                   :last_name =>  'x_customer_shipping_last_name',
+                                   :city =>       'x_customer_shipping_city',
+                                   :company =>    'x_customer_shipping_company',
+                                   :address1 =>   'x_customer_shipping_address1',
+                                   :address2 =>   'x_customer_shipping_address2',
+                                   :state =>      'x_customer_shipping_state',
+                                   :zip =>        'x_customer_shipping_zip',
+                                   :country =>    'x_customer_shipping_country',
+                                   :phone =>      'x_customer_shipping_phone'
+
+        mapping        :notify_url, 'x_url_callback'
+        mapping        :return_url, 'x_url_complete'
+        mapping :cancel_return_url, 'x_url_cancel'
+
+        private
+
+        def format_amount(amount, currency)
+          units = CURRENCY_SPECIAL_MINOR_UNITS[currency] || 2
+          sprintf("%.#{units}f", amount)
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        def initialize(post, options = {})
+          super
+          @key = options[:credential2]
+        end
+
+        def acknowledge(authcode = nil)
+          signature = @params['x_signature']
+          signature && signature.casecmp(generate_signature) == 0
+        end
+
+        def item_id
+          @params['x_reference']
+        end
+
+        def currency
+          @params['x_currency']
+        end
+
+        def gross
+          @params['x_amount']
+        end
+
+        def transaction_id
+          @params['x_gateway_reference']
+        end
+
+        def status
+          result = @params['x_result']
+          result && result.capitalize
+        end
+
+        def test?
+          @params['x_test'] == 'true'
+        end
+
+        private
+
+        def generate_signature
+          signature_params = @params.select { |k| k.start_with? 'x_' }.reject { |k| k == 'x_signature' }
+          Universal.sign(signature_params, @key)
+        end
+      end
+
+      class Return < OffsitePayments::Return
+        def initialize(query_string, options = {})
+          super
+          @notification = Notification.new(query_string, options)
+        end
+
+        def success?
+          @notification.acknowledge
+        end
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/valitor.rb

@@ -0,0 +1,200 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Valitor
+      mattr_accessor :test_url
+      self.test_url = 'https://testvefverslun.valitor.is/1_1/'
+
+      mattr_accessor :production_url
+      self.production_url = 'https://vefverslun.valitor.is/1_1/'
+
+      def self.test?
+        (OffsitePayments.mode == :test)
+      end
+
+      def self.service_url
+        (test? ? test_url : production_url)
+      end
+
+      def self.notification(params, options={})
+        Notification.new(params, options.merge(:test => test?))
+      end
+
+      def self.return(query_string, options={})
+        Return.new(query_string, options.merge(:test => test?))
+      end
+
+      class Helper < OffsitePayments::Helper
+        include ActiveUtils::RequiresParameters
+
+        DEFAULT_SUCCESS_TEXT = "The transaction has been completed."
+
+        def initialize(order, account, options={})
+          options[:currency] ||= 'ISK'
+          super
+          add_field 'Adeinsheimild', '0'
+          add_field 'KaupandaUpplysingar', '0'
+          add_field 'SlokkvaHaus', '0'
+          @security_number = options[:credential2]
+          @amount          = options[:amount]
+          @order           = order
+        end
+
+        mapping :account, 'VefverslunID'
+        mapping :currency, 'Gjaldmidill'
+
+        mapping :order, 'Tilvisunarnumer'
+
+        mapping :notify_url, 'SlodTokstAdGjaldfaeraServerSide'
+        mapping :return_url, 'SlodTokstAdGjaldfaera'
+        mapping :cancel_return_url, 'SlodNotandiHaettirVid'
+
+        mapping :success_text, 'SlodTokstAdGjaldfaeraTexti'
+
+        mapping :language, 'Lang'
+
+        def authorize_only
+          add_field 'Adeinsheimild', '1'
+        end
+
+        def collect_customer_info
+          add_field 'KaupandaUpplysingar', '1'
+        end
+
+        def hide_header
+          add_field 'SlokkvaHaus', '1'
+        end
+
+        def product(id, options={})
+          raise ArgumentError, "Product id #{id} is not an integer between 1 and 500" unless id.to_i > 0 && id.to_i <= 500
+          requires!(options, :amount, :description)
+          options.assert_valid_keys([:description, :quantity, :amount, :discount])
+
+          add_field("Vara_#{id}_Verd", format_amount(options[:amount], @fields[mappings[:currency]]))
+          add_field("Vara_#{id}_Fjoldi", options[:quantity] || "1")
+
+          add_field("Vara_#{id}_Lysing", options[:description]) if options[:description]
+          add_field("Vara_#{id}_Afslattur", options[:discount] || '0')
+
+          @products ||= []
+          @products << id.to_i
+        end
+
+        def signature
+          raise ArgumentError, "Security number not set" unless @security_number
+          parts = [@security_number, @fields['Adeinsheimild']]
+          @products.sort.uniq.each do |id|
+            parts.concat(["Vara_#{id}_Fjoldi", "Vara_#{id}_Verd", "Vara_#{id}_Afslattur"].collect{|e| @fields[e]})
+          end if @products
+          parts.concat(%w(VefverslunID Tilvisunarnumer SlodTokstAdGjaldfaera SlodTokstAdGjaldfaeraServerSide Gjaldmidill).collect{|e| @fields[e]})
+          Digest::MD5.hexdigest(parts.compact.join(''))
+        end
+
+        def form_fields
+          product(1, :amount => @amount, :description => @order) if Array(@products).empty?
+          @fields[mappings[:success_text]] ||= DEFAULT_SUCCESS_TEXT
+          @fields.merge('RafraenUndirskrift' => signature)
+        end
+
+        def format_amount(amount, currency)
+          OffsitePayments::CURRENCIES_WITHOUT_FRACTIONS.include?(currency) ? amount.to_f.round : sprintf("%.2f", amount)
+        end
+      end
+
+      module ResponseFields
+        def success?
+          status == 'Completed'
+        end
+        alias :complete? :success?
+
+        def test?
+          @options[:test]
+        end
+
+        def item_id
+          params['Tilvisunarnumer']
+        end
+        alias :order :item_id
+
+        def transaction_id
+          params['VefverslunSalaID']
+        end
+
+        def currency
+          nil
+        end
+
+        def status
+          "Completed" if acknowledge
+        end
+
+        def received_at
+          Time.parse(params['Dagsetning'].to_s)
+        end
+
+        def gross
+          "%0.2f" % params['Upphaed'].to_s.sub(',', '.')
+        end
+
+        def card_type
+          params['Kortategund']
+        end
+
+        def card_last_four
+          params['KortnumerSidustu']
+        end
+
+        def authorization_number
+          params['Heimildarnumer']
+        end
+
+        def transaction_number
+          params['Faerslunumer']
+        end
+
+        def customer_name
+          params['Nafn']
+        end
+
+        def customer_address
+          params['Heimilisfang']
+        end
+
+        def customer_zip
+          params['Postnumer']
+        end
+
+        def customer_city
+          params['Stadur']
+        end
+
+        def customer_country
+          params['Land']
+        end
+
+        def customer_email
+          params['Tolvupostfang']
+        end
+
+        def customer_comment
+          params['Athugasemdir']
+        end
+
+        def password
+          @options[:credential2]
+        end
+
+        def acknowledge(authcode = nil)
+          password ? Digest::MD5.hexdigest("#{password}#{order}") == params['RafraenUndirskriftSvar'] : true
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        include ResponseFields
+      end
+
+      class Return < OffsitePayments::Return
+        include ResponseFields
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/verkkomaksut.rb

@@ -0,0 +1,143 @@
+module OffsitePayments #: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
+
+      class Helper < OffsitePayments::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_title_#{i}".to_sym, "ITEM_TITLE[#{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
+
+      class Notification < OffsitePayments::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
+
+        # Acknowledges the payment. If the authcodes match, returns true.
+        def acknowledge(authcode = nil)
+          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