pxpay 0.1.1 → 0.1.2

data/Gemfile

@@ -10,7 +10,7 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
-end
-
-gem 'nokogiri'
-gem "rest-client"
+  gem "builder"
+  gem "nokogiri"
+  gem "rest-client"
+end

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    builder (2.1.2)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
@@ -18,6 +19,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  builder
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
   nokogiri

data/README.md

@@ -1,16 +1,18 @@
 PxPay
 =======
 A Rubygem to integrate DPS-hosted payments through the Payment Express PxPay system.
-For self-hosted systems check out the amazing [ActiveMerchant](https://www.github.com/Shopify/active_merchant) gem
-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
+
+For self-hosted systems check out the amazing [ActiveMerchant](https://www.github.com/Shopify/active_merchant) gem.
+
+See <http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html> or <http://www.paymentexpress.com/downloads/DPSECOM_PXPay.pdf> for more details about PxPay.
 
 Installation
 ------------
 Install from Rubygems
     gem install pxpay
-Then run `rails g pxpay:install` to copy an initializer and a config yml file to your rails app.
+Then run `rails generate pxpay:install` to copy an initializer and a config yml file to your rails app.
 Make sure you add your own development credentials to the `config/pxpay.yml` file and create success and failure URLs for Payment Express to redirect you back to
-You can apply for a development account at https://www.paymentexpress.com/pxmi/apply
+You can apply for a development account at <https://www.paymentexpress.com/pxmi/apply>
 
 
 Usage
@@ -30,7 +32,9 @@ To send your customer to Payment Express for payment make a call to Pxpay::Reque
       redirect_to request.url
     end
  
-Once your customer has entered their details Payment Express will redirect the back to the success URL that you provided. Use Pxpay:Response to get the details back from Payment Express.
+Once your customer has entered their details Payment Express will redirect them back to the success URL that you provided. 
+
+Use Pxpay:Response to get the transaction details back from Payment Express.
 
     def success
       response = Pxpay::Response.new(params).response
@@ -38,22 +42,23 @@ Once your customer has entered their details Payment Express will redirect the b
       ## Do something with the results hash
     end
  
-N.B. There is a minor caveat here: Payment Express has a system called fail-proof result notification where as soon as the customer has finished the transaction they will send a background request. This means your success/failure URL will be hit at least twice for 
-each transaction, so you must allow for this in your code. See <http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html#ResultNotification> for details.
+N.B. There is a minor caveat here: Payment Express includes a system called fail-proof result notification where as soon as the customer has finished the transaction they will send a background request. 
 
+This means your success/failure URL will be hit at least twice for each transaction, so you must allow for this in your code. See <http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html#ResultNotification> for details.
 
-TODO 
-Add tests
-Add ability to set global configuration options
-Token Billing
-Remove rails dependencies
-
-This gem is as of yet untested.
+N.B.
+----
 
 This gem is in no way endorsed or affiliated with Payment Express
 
-== Contributing to PxPay
- 
+TODO
+----
+* Add ability to set global configuration options
+* Add more tests
+* Token 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
@@ -62,7 +67,8 @@ This gem is in no way endorsed or affiliated with Payment Express
 * 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
+=========
 
 Copyright (c) 2011 Bradley Priest. See LICENSE.txt for
 further details.

data/Rakefile

@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ["Bradley Priest"]
   gem.add_dependency 'nokogiri'
   gem.add_dependency 'rest-client'
+  gem.add_dependency 'builder'
   # 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'

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/pxpay.rb

@@ -1,3 +1,4 @@
+# A Ruby wrapper around the DPS-hosted PxPay service
 module Pxpay
   require "pxpay/railtie" if defined?(Rails)
   require "pxpay/base"

data/lib/pxpay/base.rb

@@ -1,4 +1,5 @@
 module Pxpay
+  # The base Pxpay class, contains the acceptable currency types and the details that are returned from Payment Express
   class Base
     # A list of the acceptable payment currencies
     # See http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html#Properties

data/lib/pxpay/init.rb

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

data/lib/pxpay/install_generator.rb

@@ -1,4 +1,5 @@
 module Pxpay
+  # The install generator for Pxpay
   class InstallGenerator < Rails::Generators::Base
     desc "Copies pxpay.yml to config"
 

data/lib/pxpay/notification.rb

@@ -1,9 +1,8 @@
 module Pxpay
   # The return notification from Payment Express 
   class Notification
-    mattr_accessor :order_details
     attr_accessor :response
-  
+    # Create a new Notification from Payment Express' response
     def initialize(response)
       @response = response
     end
@@ -16,7 +15,7 @@ module Pxpay
     # Return the response as a hash
     def to_hash
       require 'nokogiri'
-      doc = Nokogiri::XML(self.response)
+      doc = ::Nokogiri::XML( self.response )
       hash = {}
       doc.at_css("Response").element_children.each do |attribute|
         hash[attribute.name.underscore.to_sym] = attribute.inner_text
@@ -25,4 +24,15 @@ module Pxpay
       hash
     end
   end
+end
+
+class String
+  # A copy of Rails' ActiveSupport underscore method
+   def underscore
+       self.gsub(/::/, '/').
+       gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+       gsub(/([a-z\d])([A-Z])/,'\1_\2').
+       tr("-", "_").
+       downcase
+   end
 end

data/lib/pxpay/request.rb

@@ -1,4 +1,5 @@
 module Pxpay
+  # The request object to send to Payment Express
   class Request
     
     attr_accessor :post
@@ -17,26 +18,27 @@ module Pxpay
     # Get the redirect URL from Payment Express
     def url
       require 'rest_client'
+      require 'nokogiri'
       response = ::RestClient.post("https://sec2.paymentexpress.com/pxpay/pxaccess.aspx", post )
-      url =  Hash.from_xml(response)['Request']['URI']
+      url = ::Nokogiri::XML(response).at_css("URI").inner_html
       return URI::extract(url).first.gsub("&", "&")
     end
     
     private
     # Internal method to build the xml to send to Payment Express
     def build_xml( id, price, options )
-      xml = Builder::XmlMarkup.new
+      xml = ::Builder::XmlMarkup.new
       xml.GenerateRequest do
-        xml.PxPayUserId PXPAY_CONFIG[:pxpay][:pxpay_user_id]
-        xml.PxPayKey PXPAY_CONFIG[:pxpay][:pxpay_key]
+        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]
+        xml.UrlSuccess ::PXPAY_CONFIG[:pxpay][:success_url]
+        xml.UrlFail ::PXPAY_CONFIG[:pxpay][:failure_url]
       end
     end
   end

data/lib/pxpay/response.rb

@@ -1,22 +1,27 @@
 module Pxpay
+  # The response object received from Payment Express
   class Response
-    attr_accessor :result
+    attr_accessor :post
+    
+    # Create a new Payment Express response object by passing in the return parameters provided to the success/failure URL
+    
     def initialize(params)
       @result = params[:result]
       @user_id = params[:userid]
+      @post = build_xml( params[:result] )
     end
     
     # Retrieving the transaction details from Payment Express as an instance of Pxpay::Notification
     def response
       require 'rest_client'
-      response = ::RestClient.post( 'https://www.paymentexpress.com/pxpay/pxaccess.aspx', build_xml( result ) )
+      response = ::RestClient.post( 'https://www.paymentexpress.com/pxpay/pxaccess.aspx',  self.post )
       return ::Pxpay::Notification.new( response )
     end
   
     private
     # Internal method to build the xml to send to Payment Express
     def build_xml( result )
-      xml = Builder::XmlMarkup.new
+      xml = ::Builder::XmlMarkup.new
     
       xml.ProcessResponse do 
         xml.PxPayUserId PXPAY_CONFIG[:pxpay][:pxpay_user_id]

data/pxpay.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pxpay}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bradley Priest"]
@@ -32,10 +32,11 @@ Gem::Specification.new do |s|
     "lib/pxpay/railtie.rb",
     "lib/pxpay/request.rb",
     "lib/pxpay/response.rb",
-    "lib/pxpay/templates/pxpay.rb",
     "lib/pxpay/templates/pxpay.yml",
     "pxpay.gemspec",
     "test/helper.rb",
+    "test/pxpay.yml",
+    "test/response.xml",
     "test/test_pxpay.rb"
   ]
   s.homepage = %q{http://github.com/bradleypriest/pxpay}
@@ -53,33 +54,39 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<builder>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
     else
-      s.add_dependency(%q<nokogiri>, [">= 0"])
-      s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
     end
   else
-    s.add_dependency(%q<nokogiri>, [">= 0"])
-    s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -9,10 +9,13 @@ rescue Bundler::BundlerError => e
 end
 require 'test/unit'
 require 'shoulda'
+require 'builder'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'pxpay'
+PXPAY_CONFIG = YAML.load_file("test/pxpay.yml")['test']
+
 
 class Test::Unit::TestCase
 end

data/test/pxpay.yml

@@ -0,0 +1,6 @@
+test:
+  :pxpay:
+    :pxpay_user_id: TODO
+    :pxpay_key: TODO
+    :success_url: http://localhost:3000/success
+    :failure_url: http://localhost:3000/failure

data/test/response.xml

@@ -0,0 +1 @@
+<Response valid="1"><Success>1</Success><TxnType>Purchase</TxnType><CurrencyInput>NZD</CurrencyInput><MerchantReference>1</MerchantReference><TxnData1></TxnData1><TxnData2></TxnData2><TxnData3></TxnData3><AuthCode>222330</AuthCode><CardName>Visa</CardName><CardHolderName>123</CardHolderName><CardNumber>411111........11</CardNumber><DateExpiry>1212</DateExpiry><ClientInfo>202.180.88.16</ClientInfo><TxnId>1</TxnId><EmailAddress></EmailAddress><DpsTxnRef>00000006070485ce</DpsTxnRef><BillingId></BillingId><DpsBillingId></DpsBillingId><AmountSettlement>12.00</AmountSettlement><CurrencySettlement>NZD</CurrencySettlement><DateSettlement>20110309</DateSettlement><TxnMac>BD43E619</TxnMac><ResponseText>APPROVED</ResponseText><CardNumber2></CardNumber2></Response>

data/test/test_pxpay.rb

@@ -1,7 +1,60 @@
 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"
+  context "create a request object" do
+    setup do
+      @request = Pxpay::Request.new( 1, 12.34 )
+    end
+  
+    should "generate an xml request" do
+      assert_match(/GenerateRequest/, @request.post )
+    end
+
+    should "generate an xml request with username and id" do
+      assert_match(/<PxPayUserId>Test_Dev<\/PxPayUserId><PxPayKey>\w{64}<\/PxPayKey>/, @request.post )
+    end
+    
+    should "generate an xml request with correct amount" do
+      assert_match(/<AmountInput>12.34<\/AmountInput>/, @request.post)
+    end
+    
+    should "return a URL" do
+      assert_match(/https:\/\/sec2.paymentexpress.com\/pxpay\/pxpay.aspx\?userid=\w{64}&request=\S{270}/, @request.url)
+    end
+  end
+  
+  context "create a response object" do
+    setup do
+      @response_text = "v5l4alYudyoKcCD1vSADyfiuWv4QqCKyJVdaXCuJR0_7jUyj9reTWi7Jdhe5-xtbDRlwLpPG56qO7AOKR-h65Awaa886kw9vjf5YglO1fz2wyyshMsaJT5XrEhGFBsNLycaqou0rxwRxF4Y0chcA_laRn8Ev1sOqpNNXafUwP2fDMQVQ7gla11Ibdv7K5v0TIvV28rPVLZgnbty5rtnK_AdR0W9XOXpo6w4NlNzh81KcFJeVc_5n_4QITRZ1zVYrrCGzg3T3S902ej1kgqBGGJf904IWEgNfbjc8teg3ereUWLYhDK-E3FrP-v3L06VxRwR96wZkkO2rucYUrxc2drOQfZipqijabZTRjyoLK37jFQkg5JfrQPOvXZaQeY6eby2Voh_XLAYtoUawPPvkupiEI3b5_TlANhnOLl0_fUS95ObLG1VIHenw=="
+      @response = Pxpay::Response.new(:userid => 'Test_Dev', :result => @response_text )
+    end
+    
+    should "generate an xml request" do
+      assert_match(/ProcessResponse/, @response.post )
+    end
+
+    should "generate an xml request with username and id" do
+      assert_match(/<PxPayUserId>#{PXPAY_CONFIG[:pxpay_user_id]}<\/PxPayUserId><PxPayKey>#{PXPAY_CONFIG[:pxpay_key]}<\/PxPayKey>/, @response.post )
+    end
+    
+    should "generate an xml request with the correct response text" do
+      assert_match( %r(<Response>#{@response_text}</Response), @response.post)
+    end    
+  end
+  
+  context "create a notification" do
+    setup do
+      @notification = Pxpay::Notification.new( File.read('test/response.xml') )
+    end
+  
+    should "parse xml to hash" do
+      assert_instance_of(Hash, @notification.to_hash )
+    end
+    
+    should "return info in hash" do
+      assert_match(@notification.to_hash[:success], "1")
+      assert_match(@notification.to_hash[:valid], "1")
+      assert_match(@notification.to_hash[:amount_settlement], "12.00")
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bradley Priest
@@ -18,7 +18,7 @@ date: 2011-03-13 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: shoulda
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -27,67 +27,67 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: bundler
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        version: "0"
-  type: :runtime
+        - 0
+        version: 1.0.0
+  type: :development
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: jeweler
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: rcov
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: "0"
   type: :development
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: builder
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
+        - 0
+        version: "0"
   type: :development
   prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: nokogiri
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -100,7 +100,7 @@ dependencies:
   prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: rest-client
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -109,11 +109,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: nokogiri
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -125,6 +125,32 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: builder
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id010
 description: A Ruby wrapper around the DPS-hosted PxPay service
 email: bradleypriest@gmail.com
 executables: []
@@ -150,10 +176,11 @@ files:
 - lib/pxpay/railtie.rb
 - lib/pxpay/request.rb
 - lib/pxpay/response.rb
-- lib/pxpay/templates/pxpay.rb
 - lib/pxpay/templates/pxpay.yml
 - pxpay.gemspec
 - test/helper.rb
+- test/pxpay.yml
+- test/response.xml
 - test/test_pxpay.rb
 has_rdoc: true
 homepage: http://github.com/bradleypriest/pxpay
@@ -169,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3313518574838189803
+      hash: 1867572891445724982
       segments: 
       - 0
       version: "0"