spree_pxpay_paymentmethod 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in spree_pxpay_paymentmethod.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Spree PxPay Gateway
+
+This is a gem for Spree > 1.1 which adds PXPay (paymentexpress.com - a NZ and
+Australian Payment Processor) as a Payment Method.
+
+This is does not use Active Merchant - this is not the version of the gateway
+with a POST API (see ActiveMerchant PXPost docs), PXPay is the service hosted
+on the Payment Express servers and credit card information is never touched by
+your Spree implementation (sort of like PayPal's Website Payments system).
+
+This extension will completely replace the payment page of the cart, and will
+return the customer to the completed order page when their payment has been
+processed.
+
+As such, you can not use multiple payment methods (on the front end) alongside
+this. You can manually create payments on the back-end as per usual.
+
+## Installation
+
+ 1. Add the gem to your Gemfile
+ 2. `bundle install`
+ 3. Add a new Payment Method in the admin section using the `Spree::Gateway::PxPay`
+ 4. Set the relevant configuration details
+
+## TODO
+
+The DPS documentation talks of being able to embed as an iframe. I'd like to
+see if it is possible within Spree's checkout process somewhere. Have to look
+into the states within the state machine, I imagine.
+
+Specs, obviously ;)
+
+## THANKS
+
+Inspired by the [spree-hosted-gateway gem](https://github.com/joshmcarthur/spree-hosted-gateway) and the work done by
+@bradleypriest who wrote the [PXPay gem](https://github.com/bradleypriest/pxpay).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/checkout_controller_decorator.rb

@@ -0,0 +1,51 @@
+Spree::CheckoutController.class_eval do
+  skip_before_filter :verify_authenticity_token, :only => [:dps_callback]
+  skip_before_filter :load_order, :only => :px_pay_callback
+
+  # Handles the response from PxPay (success or failure) and updates the
+  # relevant Payment record.
+  def px_pay_callback
+    response = Pxpay::Response.new(params).response.to_hash
+
+    payment = Spree::Payment.find(response[:merchant_reference])
+
+    if payment then
+      if response[:success] == '1'
+        payment.started_processing
+        payment.response_code = response[:auth_code]
+        payment.save
+        payment.complete
+        @order = payment.order
+        @order.next
+
+        state_callback(:after)
+        if @order.state == "complete" || @order.completed?
+          state_callback(:before)
+          flash.notice = t(:order_processed_successfully)
+          flash[:commerce_tracking] = "nothing special"
+          redirect_to completion_route
+        else
+          respond_with(@order, :location => checkout_state_path(@order.state))
+        end
+      else
+        payment.void
+        redirect_to cart_path, :notice => 'Your credit card details were declined. Please check your details and try again.'
+      end
+    else
+      # Bad Payment!
+      raise Spree::Core::GatewayError, "Unknown merchant_reference: #{response[:merchant_reference]}"
+    end
+  end
+
+private
+
+  alias :before_payment_without_px_pay_redirection :before_payment
+  def before_payment
+    before_payment_without_px_pay_redirection
+    redirect_to px_pay_gateway.url(@order, request)
+  end
+
+  def px_pay_gateway
+    @order.available_payment_methods.find { |x| x.is_a?(Spree::Gateway::PxPay) }
+  end
+end

data/app/models/spree/gateway/px_pay.rb

@@ -0,0 +1,64 @@
+require 'pxpay'
+
+module Spree
+  # The PxPay Gateway allows Spree to communicate with the PxPay system,
+  # including generating the correct URL to forward the customer to.
+  #
+  # It differs from most Spree::Gateway implementations in that it does not
+  # perform any actions directly via an API (as none exists), but just
+  # abstracts access to the pxpay gem.
+  class Gateway::PxPay < PaymentMethod
+
+    include Rails.application.routes.url_helpers
+
+    preference :user_id, :string
+    preference :key, :string
+    preference :currency_input, :string, :default => 'AUD', :description => "3 digit currency code from #{Pxpay::Base.currency_types.join(' ')}"
+
+    attr_accessible :preferred_user_id, :preferred_key, :preferred_currency_input
+
+    def source_required?
+      false
+    end
+
+    def actions
+      %w{}
+    end
+
+    # Indicates whether its possible to void the payment.
+    def can_void?(payment)
+      false
+    end
+
+    def url(order, request)
+      callback = callback_url(request.host, request.protocol)
+      px_pay_request(payment(order), callback).url
+    end
+
+private
+
+    # Finds the pending payment or creates a new one.
+    def payment(order)
+      payment = order.payments.pending.first
+      return payment if payment.present?
+
+      payment = order.payments.new
+      payment.amount = order.total
+      payment.payment_method = self
+      payment.save!
+      payment
+    end
+
+    # Creates a new Pxpay::Request with all the relevant data.
+    def px_pay_request(payment, callback_url)
+      Pxpay::Base.pxpay_user_id = self.preferred_user_id
+      Pxpay::Base.pxpay_key     = self.preferred_key
+      Pxpay::Request.new(payment.id, payment.amount, { :url_success => callback_url, :url_failure => callback_url, :currency_input => self.preferred_currency_input })
+    end
+
+    # Calculates the url to return to after the PxPay process completes
+    def callback_url(host, protocol)
+      url_for(:controller => 'spree/checkout', :action => 'px_pay_callback', :only_path => false, :host => host, :protocol => protocol)
+    end
+  end
+end

data/app/views/spree/admin/payments/source_views/_pxpay.html.erb

@@ -0,0 +1,10 @@
+<fieldset data-hook="creditcard">
+  <legend>PxPay</legend>
+
+  <table class="index">
+    <tr>
+      <td><%= label_tag nil, 'Authorisation' %></td>
+      <td><%= payment.response_code %></td>
+    </tr>
+  </table>
+</fieldset>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match '/checkout/pay/callback' => 'spree/checkout#px_pay_callback'
+end

data/lib/spree_pxpay_paymentmethod.rb

@@ -0,0 +1,27 @@
+require 'spree_core'
+require "spree_pxpay_paymentmethod/version"
+
+module SpreePxpayPaymentmethod
+  class Engine < Rails::Engine
+    railtie_name "spree_pxpay_paymentmethod"
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    initializer "spree_pxpay_paymentmethod.register.payment_methods" do |app|
+      app.config.spree.payment_methods += [
+        Spree::Gateway::PxPay
+      ]
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_pxpay_paymentmethod/version.rb

@@ -0,0 +1,3 @@
+module SpreePxpayPaymentmethod
+  VERSION = "1.0.0"
+end

data/spree_pxpay_paymentmethod.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "spree_pxpay_paymentmethod/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spree_pxpay_paymentmethod"
+  s.version     = SpreePxpayPaymentmethod::VERSION
+  s.authors     = ["tuttinator"]
+  s.email       = ["caleb.tutty@gmail.com"]
+  s.homepage    = ""
+  s.summary     = ""
+  s.description = "DPS PXPay payment method for Spree"
+
+  s.rubyforge_project = "spree_pxpay_paymentmethod"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('spree_core', '~> 1.1.1')
+  s.add_dependency('pxpay', '~> 0.2.6')
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: spree_pxpay_paymentmethod
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- tuttinator
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pxpay
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.6
+  type: :runtime
+  version_requirements: *id002
+description: DPS PXPay payment method for Spree
+email: 
+- caleb.tutty@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/checkout_controller_decorator.rb
+- app/models/spree/gateway/px_pay.rb
+- app/views/spree/admin/payments/source_views/_pxpay.html.erb
+- config/routes.rb
+- lib/spree_pxpay_paymentmethod.rb
+- lib/spree_pxpay_paymentmethod/version.rb
+- spree_pxpay_paymentmethod.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: spree_pxpay_paymentmethod
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: []
+