pxpay 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end
+
+gem 'nokogiri'
+gem "rest-client"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  nokogiri
+  rcov
+  rest-client
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bradley Priest
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,44 @@
+= PxPay
+ A gem to integrate DPS-hosted payments through Payment Express' PxPay system. 
+ See http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html or http://www.paymentexpress.com/downloads/DPSECOM_PXPay.pdf for more details of PxPay
+ 
+ gem install pxpay
+ 
+ rails g pxpay:install to copy an initializer and a config yml file.
+ Make sure you add your own development credentials to the pxpay.yml file. Apply for a development account at https://www.paymentexpress.com/pxmi/apply
+ 
+ To send your customer to Payment Express for payment make a call to PaymentExpress::Request to request a redirection URL
+ 
+  def create
+    request = PaymentExpress::Request.new( id , price, options )
+    redirect_to request.url
+  end
+ 
+  Payment Express will redirect you back to the success URL that you provided. Use PaymentExpress:Response to get the details back from Payment Express
+ 
+  def success
+    response = PaymentExpress::Response.new(params).response
+    hash = response.hash
+  end
+ 
+ TODO 
+ Add code comments
+ Add tests
+ Add ability to set global configuration options
+ Add ability to use recurring billing
+
+== Contributing to PxPay
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Bradley Priest. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pxpay"
+  gem.homepage = "http://github.com/bradleypriest/pxpay"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for the Payment Express' PxPay API}
+  gem.description = %Q{A Ruby wrapper around the DPS-hosted PxPay service}
+  gem.email = "bradleypriest@gmail.com"
+  gem.authors = ["Bradley Priest"]
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'rest-client'
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pxpay #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pxpay.rb

@@ -0,0 +1,7 @@
+module Pxpay
+  require "pxpay/railtie" if defined?(Rails)
+  require "pxpay/base"
+  require "pxpay/request"
+  require "pxpay/response"
+  require "pxpay/notification"
+end

data/lib/pxpay/base.rb

@@ -0,0 +1,12 @@
+module Pxpay
+  class Base
+    # Acceptable payment currencies
+    def self.currency_types
+      %w( CAD CHF EUR FRF GBP HKD JPY NZD SGD USD ZAR AUD WST VUV TOP SBD PNG MYR KWD FJD )
+    end
+  
+    def self.return_details
+      [ :dps_billing_id, :txn_data1, :success, :card_number2, :email_address, :card_number, :amount_settlement, :txn_data2, :client_info, :date_expiry, :currency_settlement, :txn_data3, :txn_id, :txn_type, :date_settlement, :auth_code, :dps_txn_ref, :currency_input, :txn_mac, :card_name, :billing_id, :merchant_reference, :response_text, :card_holder_name ]
+    end      
+  end
+end

data/lib/pxpay/install_generator.rb

@@ -0,0 +1,13 @@
+module Pxpay
+  class InstallGenerator < Rails::Generators::Base
+    desc "Copies pxpay.yml to config and a config initializer to config/initializers/pxpay_config.rb"
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_files
+      template        'pxpay.rb'  ,'config/initializers/pxpay.rb'
+      template        'pxpay.yml' ,'config/pxpay.yml'
+    end
+    
+  end
+end

data/lib/pxpay/notification.rb

@@ -0,0 +1,21 @@
+module Pxpay
+  class Notification
+    mattr_accessor :order_details
+    attr_accessor :hash, :xml
+  
+    def initialize(response)
+      @hash = parse(response)
+      @xml = response
+    end
+  
+    def parse(response)
+      require 'nokogiri'
+      doc = Nokogiri::XML(response)
+      hash = {}
+      doc.at_css("Response").element_children.each do |attribute|
+        hash[attribute.name.underscore.to_sym] = attribute.inner_text# if ::Pxpay::Base.return_details.include?(attribute.name)
+      end
+      hash
+    end
+  end
+end

data/lib/pxpay/railtie.rb

@@ -0,0 +1,9 @@
+require 'pxpay'
+require 'rails'
+module Pxpay
+  class Railtie < ::Rails::Railtie
+    generators do
+      require 'pxpay/install_generator'
+    end
+  end
+end

data/lib/pxpay/request.rb

@@ -0,0 +1,35 @@
+module Pxpay
+  class Request
+    
+    attr_accessor :post
+    
+    def initialize( id , price, options = {} )
+      @post = build_xml( id, price, options )
+    end
+    
+    def url
+      require 'rest_client'
+      response = ::RestClient.post("https://sec2.paymentexpress.com/pxpay/pxaccess.aspx", post )
+      url =  Hash.from_xml(response)['Request']['URI']
+      return URI::extract(url).first.gsub("&", "&")
+    end
+    
+    private
+    
+    def build_xml( id, price, options )
+      xml = Builder::XmlMarkup.new
+      xml.GenerateRequest do
+        xml.PxPayUserId PXPAY_CONFIG[:pxpay][:pxpay_user_id]
+        xml.PxPayKey PXPAY_CONFIG[:pxpay][:pxpay_key]
+        xml.AmountInput sprintf("%.2f", price)
+        xml.CurrencyInput options[:currency] || "NZD"
+        xml.MerchantReference options[:reference] || id.to_s
+        xml.EmailAddress options[:email]
+        xml.TxnType "Purchase"
+        xml.TxnId id
+        xml.UrlSuccess PXPAY_CONFIG[:pxpay][:success_url]
+        xml.UrlFail PXPAY_CONFIG[:pxpay][:failure_url]
+      end
+    end
+  end
+end

data/lib/pxpay/response.rb

@@ -0,0 +1,26 @@
+module Pxpay
+  class Response
+    attr_accessor :result
+    def initialize(params)
+      @result = params[:result]
+      @user_id = params[:userid]
+    end
+  
+    def response
+      require 'rest_client'
+      response = ::RestClient.post( 'https://www.paymentexpress.com/pxpay/pxaccess.aspx', build_xml( result ) )
+      return ::Pxpay::Notification.new( response )
+    end
+  
+    private
+    def build_xml( result )
+      xml = Builder::XmlMarkup.new
+    
+      xml.ProcessResponse do 
+        xml.PxPayUserId PXPAY_CONFIG[:pxpay][:pxpay_user_id]
+        xml.PxPayKey PXPAY_CONFIG[:pxpay][:pxpay_key]
+        xml.Response result
+      end
+    end
+  end
+end

data/lib/pxpay/templates/pxpay.rb

@@ -0,0 +1 @@
+PXPAY_CONFIG = YAML.load_file("#{Rails.root}/config/pxpay.yml")[Rails.env]

data/lib/pxpay/templates/pxpay.yml

@@ -0,0 +1,6 @@
+development:
+  :pxpay:
+    :pxpay_user_id: Demo
+    :pxpay_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+    :success_url: http://localhost:3000/success
+    :failure_url: http://localhost:3000/failure

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pxpay'
+
+class Test::Unit::TestCase
+end

data/test/test_pxpay.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPxpay < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification 
+name: pxpay
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bradley Priest
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-12 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id008
+description: A Ruby wrapper around the DPS-hosted PxPay service
+email: bradleypriest@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pxpay.rb
+- lib/pxpay/base.rb
+- lib/pxpay/install_generator.rb
+- lib/pxpay/notification.rb
+- lib/pxpay/railtie.rb
+- lib/pxpay/request.rb
+- lib/pxpay/response.rb
+- lib/pxpay/templates/pxpay.rb
+- lib/pxpay/templates/pxpay.yml
+- test/helper.rb
+- test/test_pxpay.rb
+has_rdoc: true
+homepage: http://github.com/bradleypriest/pxpay
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2524755229026388599
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Payment Express' PxPay API
+test_files: 
+- test/helper.rb
+- test/test_pxpay.rb