pxpay 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,69 @@
+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
+
+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.
+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
+
+
+Usage
+-----
+    >> require 'nokogiri'
+    >> require 'pxpay'
+    >> request = Pxpay::Request.new( 1, 12.00 )
+    => #<Pxpay::Request:0x00000101c9a840 >
+    >> request.url
+    => "https://sec2.paymentexpress.com/pxpay/pxpay.aspx?userid=Fake_Dev&request=xxxxxxxxxx" 
+
+
+To send your customer to Payment Express for payment make a call to Pxpay::Request to request a redirection URL
+ 
+    def create
+      request = Pxpay::Request.new( id , price, options )
+      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.
+
+    def success
+      response = Pxpay::Response.new(params).response
+      hash = response.to_hash
+      ## 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.
+
+
+TODO 
+Add tests
+Add ability to set global configuration options
+Token Billing
+Remove rails dependencies
+
+This gem is as of yet untested.
+
+This gem is in no way endorsed or affiliated with Payment Express
+
+== 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/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/pxpay/base.rb

@@ -1,10 +1,12 @@
 module Pxpay
   class Base
-    # Acceptable payment currencies
+    # A list of the acceptable payment currencies
+    # See http://www.paymentexpress.com/technical_resources/ecommerce_hosted/pxpay.html#Properties
     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
-  
+    
+    # The currently returned details from Payment Express. Access with Pxpay::Base.return_details
     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      

data/lib/pxpay/init.rb

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

data/lib/pxpay/install_generator.rb

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

data/lib/pxpay/notification.rb

@@ -1,20 +1,27 @@
 module Pxpay
+  # The return notification from Payment Express 
   class Notification
     mattr_accessor :order_details
-    attr_accessor :hash, :xml
+    attr_accessor :response
   
     def initialize(response)
-      @hash = parse(response)
-      @xml = response
+      @response = response
     end
-  
-    def parse(response)
+    
+    # Return the xml response
+    def to_xml
+      response
+    end 
+    
+    # Return the response as a hash
+    def to_hash
       require 'nokogiri'
-      doc = Nokogiri::XML(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# if ::Pxpay::Base.return_details.include?(attribute.name)
+        hash[attribute.name.underscore.to_sym] = attribute.inner_text
       end
+      hash[:valid] = doc.at_css("Response")['valid']
       hash
     end
   end

data/lib/pxpay/railtie.rb

@@ -5,5 +5,8 @@ module Pxpay
     generators do
       require 'pxpay/install_generator'
     end
+    initializer "railtie.configure_rails_initialization" do
+      require 'pxpay/init'
+    end
   end
 end

data/lib/pxpay/request.rb

@@ -3,10 +3,18 @@ module Pxpay
     
     attr_accessor :post
     
+    # Create a new instance of Pxpay::Request
+    # Pxpay::Request.new( id, amount, options = {} )
+    # Current available options are:
+    # :currency, currency for transaction, default is NZD, can be any of Pxpay::Base.currency_types
+    # :reference, a reference field, default is the id
+    # :email, email address of user, default is nil
+    
     def initialize( id , price, options = {} )
       @post = build_xml( id, price, options )
     end
     
+    # Get the redirect URL from Payment Express
     def url
       require 'rest_client'
       response = ::RestClient.post("https://sec2.paymentexpress.com/pxpay/pxaccess.aspx", post )
@@ -15,7 +23,7 @@ module Pxpay
     end
     
     private
-    
+    # Internal method to build the xml to send to Payment Express
     def build_xml( id, price, options )
       xml = Builder::XmlMarkup.new
       xml.GenerateRequest do

data/lib/pxpay/response.rb

@@ -5,7 +5,8 @@ module Pxpay
       @result = params[:result]
       @user_id = params[:userid]
     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 ) )
@@ -13,6 +14,7 @@ module Pxpay
     end
   
     private
+    # Internal method to build the xml to send to Payment Express
     def build_xml( result )
       xml = Builder::XmlMarkup.new
     

data/lib/pxpay/templates/pxpay.rb

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

data/pxpay.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pxpay}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bradley Priest"]
+  s.date = %q{2011-03-13}
+  s.description = %q{A Ruby wrapper around the DPS-hosted PxPay service}
+  s.email = %q{bradleypriest@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/pxpay.rb",
+    "lib/pxpay/base.rb",
+    "lib/pxpay/init.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",
+    "pxpay.gemspec",
+    "test/helper.rb",
+    "test/test_pxpay.rb"
+  ]
+  s.homepage = %q{http://github.com/bradleypriest/pxpay}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby wrapper for the Payment Express' PxPay API}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_pxpay.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 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<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 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<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Bradley Priest
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-12 00:00:00 +13:00
+date: 2011-03-13 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -133,17 +133,18 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/pxpay.rb
 - lib/pxpay/base.rb
+- lib/pxpay/init.rb
 - lib/pxpay/install_generator.rb
 - lib/pxpay/notification.rb
 - lib/pxpay/railtie.rb
@@ -151,6 +152,7 @@ files:
 - lib/pxpay/response.rb
 - lib/pxpay/templates/pxpay.rb
 - lib/pxpay/templates/pxpay.yml
+- pxpay.gemspec
 - test/helper.rb
 - test/test_pxpay.rb
 has_rdoc: true
@@ -167,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2524755229026388599
+      hash: 3313518574838189803
       segments: 
       - 0
       version: "0"

data/README.rdoc

@@ -1,44 +0,0 @@
-= 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.
-