offsite_payments 2.0.0

data/lib/offsite_payments/integrations/world_pay.rb

@@ -0,0 +1,273 @@
+module OffsitePayments #:nodoc:
+  module Integrations #:nodoc:
+    module WorldPay
+      mattr_accessor :production_url, :test_url
+      self.production_url = 'https://secure.worldpay.com/wcc/purchase'
+      self.test_url = 'https://secure-test.worldpay.com/wcc/purchase'
+
+      def self.service_url
+        case OffsitePayments.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
+        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'
+        mapping :return_url, 'MC_return'
+
+        # WorldPay supports two different test modes - :always_succeed and :always_fail
+        def initialize(order, account, options = {})
+          super
+
+          if OffsitePayments.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 OffsitePayments.mode == :always_succeed
+            add_field('testMode', '100')
+          elsif OffsitePayments.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 further 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
+
+      class Notification < OffsitePayments::Notification
+        def complete?
+          status == 'Completed'
+        end
+
+        def account
+          params['instId']
+        end
+
+        def item_id
+          params['cartId']
+        end
+
+        def transaction_id
+          params['transId']
+        end
+
+        # Time this payment was received by the client in UTC time.
+        def received_at
+          Time.at(params['transTime'].to_i / 1000).utc
+        end
+
+        # Callback password set in the WorldPay CMS
+        def security_key
+          params['callbackPW']
+        end
+
+        # the money amount we received in X.2 decimal.
+        def gross
+          params['authAmount']
+        end
+
+        def currency
+          params['authCurrency']
+        end
+
+        # Was this a test transaction?
+        def test?
+          params.key?('testMode') && params['testMode'] != '0'
+        end
+
+        def status
+          params['transStatus'] == 'Y' ? 'Completed' : 'Cancelled'
+        end
+
+        def name
+          params['name']
+        end
+
+        def address
+          params['address']
+        end
+
+        def postcode
+          params['postcode']
+        end
+
+        def country
+          params['country']
+        end
+
+        def phone_number
+          params['tel']
+        end
+
+        def fax_number
+          params['fax']
+        end
+
+        def email_address
+          params['email']
+        end
+
+        def card_type
+          params['cardType']
+        end
+
+        # WorldPay extended fraud checks returned as a 4 character string
+        #   1st char: Credit card CVV check
+        #   2nd char: Postcode AVS check
+        #   3rd char: Address AVS check
+        #   4th char: Country comparison check
+        # Possible values are:
+        #   :not_supported   -  0
+        #   :not_checked     -  1
+        #   :matched         -  2
+        #   :not_matched     -  4
+        #   :partial_match   -  8
+        def cvv_status
+          return avs_value_to_symbol(params['AVS'][0].chr)
+        end
+
+        def postcode_status
+          return avs_value_to_symbol(params['AVS'][1].chr)
+        end
+
+        def address_status
+          return avs_value_to_symbol(params['AVS'][2].chr)
+        end
+
+        def country_status
+          return avs_value_to_symbol(params['AVS'][3].chr)
+        end
+
+        def acknowledge(authcode = nil)
+          return true
+        end
+
+        # WorldPay supports the passing of custom parameters through to the callback script
+        def custom_params
+          return @custom_params ||= read_custom_params
+        end
+
+        private
+
+        # Take the posted data and move the relevant data into a hash
+        def parse(post)
+          @raw = post
+          for line in post.split('&')
+            key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+            params[key] = value
+          end
+        end
+
+        # Read the custom params into a hash
+        def read_custom_params
+          custom = {}
+          params.each do |key, value|
+            if /\A(M_|MC_|CM_)/ === key
+              custom[key.gsub(/\A(M_|MC_|CM_)/, '').to_sym] = value
+            end
+          end
+          custom
+        end
+
+        # Convert a AVS value to a symbol - see above for more about AVS
+        def avs_value_to_symbol(value)
+          case value.to_s
+          when '8'
+            :partial_match
+          when '4'
+            :no_match
+          when '2'
+            :matched
+          when '1'
+            :not_checked
+          else
+            :not_supported
+          end
+        end
+      end
+    end
+  end
+end

data/lib/offsite_payments/notification.rb

@@ -0,0 +1,71 @@
+module OffsitePayments #: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_attribute :production_ips
+
+    # * *Args*    :
+    #   - +doc+ ->     raw post string
+    #   - +options+ -> custom options which individual implementations can
+    #                  utilize
+    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://rubymoney.github.io/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 OffsitePayments.mode == :test || production_ips.blank?
+      production_ips.include?(ip)
+    end
+
+    def test?
+      false
+    end
+
+    def iso_currency
+      ActiveMerchant::CurrencyCode.standardize(currency)
+    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.to_s) if key.present?
+      end
+    end
+  end
+end

data/lib/offsite_payments/return.rb

@@ -0,0 +1,37 @@
+module OffsitePayments #:nodoc:
+  class Return
+    attr_accessor :params
+    attr_reader :notification
+
+    def initialize(query_string, options = {})
+      @params  = parse(query_string)
+      @options = options
+    end
+
+    # Successful by default. Overridden in the child class
+    def success?
+      true
+    end
+
+    # Not cancelled by default.  Overridden in the child class.
+    def cancelled?
+      false
+    end
+
+    def message
+    end
+
+    def parse(query_string)
+      return {} if query_string.blank?
+
+      query_string.split('&').inject({}) do |memo, chunk|
+        next if chunk.empty?
+        key, value = chunk.split('=', 2)
+        next if key.empty?
+        value = value.nil? ? nil : CGI.unescape(value)
+        memo[CGI.unescape(key)] = value
+        memo
+      end
+    end
+  end
+end

data/lib/offsite_payments/version.rb

@@ -0,0 +1,3 @@
+module OffsitePayments
+  VERSION = "2.0.0"
+end

metadata

@@ -0,0 +1,270 @@
+--- !ruby/object:Gem::Specification
+name: offsite_payments
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Tobias Luetke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: active_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Offsite Payments is a simple abstraction library used in and sponsored
+  by Shopify. It is written by Tobias Luetke, Cody Fauser, and contributors. The aim
+  of the project is to put as simple an abstraction as possible on top of offsite
+  (often called hosted) payment pages, and allow contributors to easily help services
+  such as Shopify extend the number of offsite payment services they support.
+email: tobi@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/offsite_payments.rb
+- lib/offsite_payments/action_view_helper.rb
+- lib/offsite_payments/helper.rb
+- lib/offsite_payments/integrations.rb
+- lib/offsite_payments/integrations/a1agregator.rb
+- lib/offsite_payments/integrations/authorize_net_sim.rb
+- lib/offsite_payments/integrations/bit_pay.rb
+- lib/offsite_payments/integrations/bogus.rb
+- lib/offsite_payments/integrations/chronopay.rb
+- lib/offsite_payments/integrations/citrus.rb
+- lib/offsite_payments/integrations/direc_pay.rb
+- lib/offsite_payments/integrations/directebanking.rb
+- lib/offsite_payments/integrations/doku.rb
+- lib/offsite_payments/integrations/dotpay.rb
+- lib/offsite_payments/integrations/dwolla.rb
+- lib/offsite_payments/integrations/e_payment_plans.rb
+- lib/offsite_payments/integrations/easy_pay.rb
+- lib/offsite_payments/integrations/epay.rb
+- lib/offsite_payments/integrations/first_data.rb
+- lib/offsite_payments/integrations/gestpay.rb
+- lib/offsite_payments/integrations/hi_trust.rb
+- lib/offsite_payments/integrations/ipay88.rb
+- lib/offsite_payments/integrations/klarna.rb
+- lib/offsite_payments/integrations/liqpay.rb
+- lib/offsite_payments/integrations/maksuturva.rb
+- lib/offsite_payments/integrations/mollie_ideal.rb
+- lib/offsite_payments/integrations/moneybookers.rb
+- lib/offsite_payments/integrations/nochex.rb
+- lib/offsite_payments/integrations/pag_seguro.rb
+- lib/offsite_payments/integrations/paxum.rb
+- lib/offsite_payments/integrations/pay_fast.rb
+- lib/offsite_payments/integrations/paydollar.rb
+- lib/offsite_payments/integrations/payflow_link.rb
+- lib/offsite_payments/integrations/paypal.rb
+- lib/offsite_payments/integrations/paypal_payments_advanced.rb
+- lib/offsite_payments/integrations/paysbuy.rb
+- lib/offsite_payments/integrations/payu_in.rb
+- lib/offsite_payments/integrations/payu_in_paisa.rb
+- lib/offsite_payments/integrations/platron.rb
+- lib/offsite_payments/integrations/pxpay.rb
+- lib/offsite_payments/integrations/quickpay.rb
+- lib/offsite_payments/integrations/rbkmoney.rb
+- lib/offsite_payments/integrations/robokassa.rb
+- lib/offsite_payments/integrations/sage_pay_form.rb
+- lib/offsite_payments/integrations/two_checkout.rb
+- lib/offsite_payments/integrations/universal.rb
+- lib/offsite_payments/integrations/valitor.rb
+- lib/offsite_payments/integrations/verkkomaksut.rb
+- lib/offsite_payments/integrations/web_pay.rb
+- lib/offsite_payments/integrations/webmoney.rb
+- lib/offsite_payments/integrations/wirecard_checkout_page.rb
+- lib/offsite_payments/integrations/world_pay.rb
+- lib/offsite_payments/notification.rb
+- lib/offsite_payments/return.rb
+- lib/offsite_payments/version.rb
+homepage: https://github.com/Shopify/offsite_payments
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Framework and tools for dealing with offsite (hosted) payment pages.
+test_files: []