offsite_payments 2.0.0

data/lib/offsite_payments/integrations/moneybookers.rb

@@ -0,0 +1,199 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module Moneybookers
+      mattr_accessor :production_url
+      self.production_url = 'https://www.moneybookers.com/app/payment.pl'
+
+      def self.service_url
+        self.production_url
+      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
+        mapping :account, 'pay_to_email'
+        mapping :order, 'transaction_id'
+        mapping :amount, 'amount'
+        mapping :currency, 'currency'
+
+        mapping :customer,
+          :first_name => 'firstname',
+          :last_name  => 'lastname',
+          :email      => 'pay_from_email',
+          :phone      => 'phone_number'
+
+        mapping :billing_address,
+          :city     => 'city',
+          :address1 => 'address',
+          :address2 => 'address2',
+          :state    => 'state',
+          :zip      => 'postal_code',
+          :country  => 'country'
+
+        mapping :notify_url, 'status_url'
+        mapping :return_url, 'return_url'
+        mapping :cancel_return_url, 'cancel_url'
+        mapping :description, 'detail1_text'
+
+        MAPPED_COUNTRY_CODES = {
+          'SE' => 'SV',
+          'DK' => 'DA'
+        }
+
+        SUPPORTED_COUNTRY_CODES = [
+          'FI', 'DE', 'ES', 'FR',
+          'IT','PL', 'GR', 'RO',
+          'RU', 'TR', 'CN', 'CZ', 'NL'
+        ]
+
+        def initialize(order, account, options = {})
+          super
+          add_tracking_token
+          add_default_parameters
+          add_seller_details(options)
+        end
+
+        private
+
+        def add_tracking_token
+          return if application_id.blank? || application_id == 'ActiveMerchant'
+
+          add_field('merchant_fields', 'platform')
+          add_field('platform', application_id)
+        end
+
+        def add_default_parameters
+          add_field('hide_login', 1)
+        end
+
+        def add_seller_details(options)
+          add_field('recipient_description', options[:account_name]) if options[:account_name]
+          add_field('country', lookup_country_code(options[:country], :alpha3)) if options[:country]
+          add_field('language', locale_code(options[:country])) if options[:country]
+        end
+
+        def locale_code(country_code)
+          return country_code if SUPPORTED_COUNTRY_CODES.include?(country_code)
+          MAPPED_COUNTRY_CODES[country_code] || 'EN'
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        def complete?
+          status == 'Completed'
+        end
+
+        # ‘2’ Processed – This status is sent when the transaction is processed and the funds have been received on your Moneybookers account.
+        # ‘0’ Pending – This status is sent when the customers pays via the pending bank transfer option. Such transactions will auto-process IF the bank transfer is received by Moneybookers. We strongly recommend that you do NOT process the order/transaction in your system upon receipt of a pending status from Moneybookers.
+        # ‘-1’ Cancelled – Pending transactions can either be cancelled manually by the sender in their online account history or they will auto-cancel after 14 days if still pending.
+        # ‘-2’ Failed – This status is sent when the customer tries to pay via Credit Card or Direct Debit but our provider declines the transaction. If you do not accept Credit Card or Direct Debit payments via Moneybookers (see page 17) then you will never receive the failed status.
+        # ‘-3’ Chargeback – This status could be received only if your account is configured to receive chargebacks. If this is the case, whenever a chargeback is received by Moneybookers, a -3 status will be posted on the status_url for the reversed transaction.
+        def status
+          case status_code
+          when '2'
+            'Completed'
+          when '0'
+            'Pending'
+          when '-1'
+            'Cancelled'
+          when '-2'
+            'Failed'
+          when '-3'
+            'Reversed'
+          else
+            'Error'
+          end
+        end
+
+        def status_code
+          params['status']
+        end
+
+        def item_id
+          params['transaction_id']
+        end
+
+        def transaction_id
+          params['mb_transaction_id']
+        end
+
+        # When was this payment received by the client.
+        def received_at
+          nil
+        end
+
+        def payer_email
+          params['pay_from_email']
+        end
+
+        def receiver_email
+          params['pay_to_email']
+        end
+
+        def md5sig
+          params['md5sig']
+        end
+
+        #Unique ID from the merchant's Moneybookers.com account, needed for calculatinon of md5 sig
+        def merchant_id
+          params['merchant_id']
+        end
+
+        # currency of the payment as posted by the merchant on the entry form
+        def currency
+          params['currency']
+        end
+
+        # amount of the payment as posted by the merchant on the entry form (ex. 39.60/39.6/39)
+        def gross
+          params['amount']
+        end
+
+        # currency of mb_amount, will always be the same as the currency of the beneficiary's account at Moneybookers.com
+        def merchant_currency
+          params['mb_currency']
+        end
+
+        # total amount of the payment in Merchants currency (ex 25.46/25.4/25)
+        def merchant_amount
+          params['mb_amount']
+        end
+
+        # Was this a test transaction?
+        def test?
+          false
+        end
+
+        def secret
+          @options[:credential2]
+        end
+
+        # Acknowledge the transaction to MoneyBooker. This method has to be called after a new
+        # apc arrives. It will verify that all the information we received is correct and will return a
+        # ok or a fail. The secret (second credential) has to be provided in the parameter :credential2
+        # when instantiating the Notification object.
+        #
+        # Example:
+        #
+        #   def ipn
+        #     notify = Moneybookers.notification(request.raw_post, :credential2 => 'secret')
+        #
+        #     if notify.acknowledge
+        #       ... process order ... if notify.complete?
+        #     else
+        #       ... log possible hacking attempt ...
+        #     end
+        def acknowledge(authcode = nil)
+          fields = [merchant_id, item_id, Digest::MD5.hexdigest(secret.to_s).upcase, merchant_amount, merchant_currency, status_code].join
+          md5sig == Digest::MD5.hexdigest(fields).upcase
+        end
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/nochex.rb

@@ -0,0 +1,228 @@
+module OffsitePayments #: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 OffsitePayments::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
+      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
+      # OffsitePayments::Integrations::Nochex::Notification
+      def self.notification(post, options = {})
+        Notification.new(post)
+      end
+
+      def self.return(query_string, options = {})
+        Return.new(query_string)
+      end
+
+      class Helper < OffsitePayments::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
+          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
+
+        # 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
+
+      # Parser and handler for incoming Automatic Payment Confirmations from Nochex.
+      class Notification < OffsitePayments::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(authcode = nil)
+           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
+
+      class Return < OffsitePayments::Return
+      end
+    end
+  end
+end

data/lib/offsite_payments/integrations/pag_seguro.rb

@@ -0,0 +1,255 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module PagSeguro
+      mattr_accessor :service_production_url
+      self.service_production_url = 'https://pagseguro.uol.com.br/v2/checkout/payment.html'
+
+      mattr_accessor :service_test_url
+      self.service_test_url = 'https://sandbox.pagseguro.uol.com.br/v2/checkout/payment.html'
+
+      mattr_accessor :invoicing_production_url
+      self.invoicing_production_url = 'https://ws.pagseguro.uol.com.br/v2/checkout/'
+
+      mattr_accessor :invoicing_test_url
+      self.invoicing_test_url = 'https://ws.sandbox.pagseguro.uol.com.br/v2/checkout/'
+
+      mattr_accessor :notification_production_url
+      self.notification_production_url = 'https://ws.pagseguro.uol.com.br/v2/transactions/notifications/'
+
+      mattr_accessor :notification_test_url
+      self.notification_test_url = 'https://ws.sandbox.pagseguro.uol.com.br/v2/transactions/notifications/'
+
+      def self.service_url
+        test? ? service_test_url : service_production_url
+      end
+
+      def self.invoicing_url
+        test? ? invoicing_test_url : invoicing_production_url
+      end
+
+      def self.notification_url
+        test? ? notification_test_url : notification_production_url
+      end
+
+      def self.notification(query_string, options = {})
+        Notification.new(query_string, options)
+      end
+
+      def self.return(query_string, options = {})
+        Return.new(query_string, options)
+      end
+
+      def self.test?
+        OffsitePayments.mode == :test
+      end
+
+      class Helper < OffsitePayments::Helper
+        def initialize(order_id, account, options)
+          super
+          @account = account
+
+          add_field('itemAmount1', sprintf("%0.02f", options[:amount]))
+          add_field('itemId1', '1')
+          add_field('itemQuantity1', '1')
+          add_field('shippingType', '3')
+          add_field('currency', 'BRL')
+        end
+
+        mapping :account, 'email'
+        mapping :credential2, 'token'
+
+        mapping :order, 'reference'
+
+        mapping :billing_address, :city     => 'shippingAddressCity',
+                                  :address1 => 'shippingAddressStreet',
+                                  :address2 => 'shippingAddressNumber',
+                                  :state    => 'shippingAddressState',
+                                  :zip      => 'shippingAddressPostalCode',
+                                  :country  => 'shippingAddressCountry'
+
+        mapping :notify_url, 'notificationURL'
+        mapping :return_url, 'redirectURL'
+        mapping :description, 'itemDescription1'
+
+        def form_fields
+          invoice_id = fetch_token
+
+          {"code" => invoice_id}
+        end
+
+        def shipping(value)
+          add_field("shippingCost", sprintf("%0.02f", value))
+        end
+
+        def customer(params = {})
+          phone = area_code_and_number(params[:phone])
+          full_name = remove_excessive_whitespace("#{params[:first_name]} #{params[:last_name]}")
+
+          add_field("senderAreaCode", phone[0])
+          add_field("senderPhone", phone[1])
+          add_field("senderEmail", params[:email])
+          add_field('senderName', full_name)
+        end
+
+        def fetch_token
+          uri = URI.parse(PagSeguro.invoicing_url)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request.content_type = "application/x-www-form-urlencoded"
+          request.set_form_data @fields
+
+          response = http.request(request)
+          xml = Nokogiri::XML.parse(response.body)
+
+          check_for_errors(response, xml)
+
+          extract_token(xml)
+        rescue Timeout::Error, Errno::ECONNRESET => e
+          raise ActionViewHelperError, "Erro ao conectar-se ao PagSeguro. Por favor, tente novamente."
+        end
+
+        def area_code_and_number(phone)
+          phone.gsub!(/[^\d]/, '')
+
+          ddd    = phone.slice(0..1)
+          number = phone.slice(2..12)
+
+          [ddd, number]
+        end
+
+        def check_for_errors(response, xml)
+          return if response.code == "200"
+
+          case response.code
+          when "400"
+            raise ActionViewHelperError, humanize_errors(xml)
+          when "401"
+            raise ActionViewHelperError, "Token do PagSeguro inválido."
+          else
+            raise ActiveMerchant::ResponseError, response
+          end
+        end
+
+        def extract_token(xml)
+          xml.css("code").text
+        end
+
+        def humanize_errors(xml)
+          # reference: https://pagseguro.uol.com.br/v2/guia-de-integracao/codigos-de-erro.html
+
+          xml.css("errors").children.map do |error|
+            case error.css('code').text
+            when "11013"
+              "Código de área inválido"
+            when "11014"
+              "Número de telefone inválido. Formato esperado: (DD) XXXX-XXXX"
+            when "11017"
+              "Código postal (CEP) inválido."
+            else
+              error.css('message').text
+            end
+          end.join(", ")
+        end
+
+        def remove_excessive_whitespace(text)
+          text.gsub(/\s{2,}/, ' ').strip
+        end
+      end
+
+      class Notification < OffsitePayments::Notification
+        def initialize(post, options = {})
+          notify_code = parse_http_query(post)["notificationCode"]
+          email = options[:credential1]
+          token = options[:credential2]
+
+          uri = URI.join(PagSeguro.notification_url, notify_code)
+          parse_xml(web_get(uri, email: email, token: token))
+        end
+
+        def complete?
+          status == "Completed"
+        end
+
+        def item_id
+          params["transaction"]["reference"]
+        end
+
+        def transaction_id
+          params["transaction"]["code"]
+        end
+
+        def received_at
+          params["transaction"]["date"]
+        end
+
+        def payer_email
+          params["sender"]["email"]
+        end
+
+        def gross
+          params["transaction"]["grossAmount"]
+        end
+
+        def currency
+          "BRL"
+        end
+
+        def payment_method_type
+          params["transaction"]["paymentMethod"]["type"]
+        end
+
+        def payment_method_code
+          params["transaction"]["paymentMethod"]["code"]
+        end
+
+        def status
+          case params["transaction"]["status"]
+          when "1", "2"
+            "Pending"
+          when "3"
+            "Completed"
+          when "4"
+            "Available"
+          when "5"
+            "Dispute"
+          when "6"
+            "Reversed"
+          when "7"
+            "Failed"
+          end
+        end
+
+        # There's no acknowledge for PagSeguro
+        def acknowledge
+          true
+        end
+
+        private
+
+        def web_get(uri, params)
+          uri.query = URI.encode_www_form(params)
+
+          response = Net::HTTP.get_response(uri)
+          response.body
+        end
+
+        # Take the posted data and move the relevant data into a hash
+        def parse_xml(post)
+          @params = Hash.from_xml(post)
+        end
+
+        def parse_http_query(post)
+          @raw = post
+          params = {}
+          for line in post.split('&')
+            key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+            params[key] = value
+          end
+          params
+        end
+      end
+    end
+  end
+end