stateless-systems-alertpay 0.2.1

data/README.txt

@@ -0,0 +1,17 @@
+= alertpay
+
+This library simply converts a HTTP/S request into an object.
+
+== Resources
+
+Install
+
+* gem install alertpay
+
+Rubyforge project
+
+* http://rubyforge.org/projects/alertpay
+
+RDocs
+
+* http://alertpay.rubyforge.org

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "alertpay"
+    gem.summary = %Q{Common interface to alertpay request params.}
+    gem.email = "enquiries@statelesssystems.com"
+    gem.homepage = "http://github.com/stateless-systems/alertpay"
+    gem.authors = ["Stateless Systems"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "alertpay #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 1

data/lib/alertpay.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/notification'
+require File.dirname(__FILE__) + '/helpers'

data/lib/helpers.rb

@@ -0,0 +1,51 @@
+module Alertpay
+  module Helpers
+    def alertpay_form_tag(url = 'https://www.alertpay.com/PayProcess.aspx', options = {}, &block)
+      if block_given?
+        form_tag(url, options, &block)
+      else
+        form_tag(url, options)
+      end
+    end
+
+    def alertpay_setup(amount, currency, item_id, merchant, options = {})
+      params = {
+        :ap_amount       => amount,
+        :ap_currency     => (currency || :usd).to_s.upcase,
+        :ap_merchant     => merchant,
+        :ap_itemcode     => item_id,
+        :ap_quantity     => 1
+      }
+
+      if options.include?(:subscription)
+        params[:ap_purchasetype] = :subscription
+        params[:ap_periodlength] = options[:subscription][:length]
+        params[:ap_timeunit] = case options[:subscription][:period]
+          when :monthly; 'Month'
+          when :yearly;  'Year'
+          when :weekly;  'Week'
+          when :daily;   'Day'
+        end
+      else
+        params[:ap_purchasetype] = :item
+      end
+
+      if options.include?(:custom)
+        options[:custom].each_index {|i| params["apc_#{i.to_i + 1}"] = options[:custom][i] }
+      end
+
+      params[:ap_quantity]   = options[:quanity]       if options.include?(:quanity)
+      params[:ap_itemname]   = options[:item_name]     if options.include?(:item_name)
+      params[:purchase_type] = options[:purchase_type] if options.include?(:purchase_type)
+      params[:ap_notifyurl]  = options[:notify_url]    if options.include?(:notify_url)
+      params[:ap_returnurl]  = options[:return_url]    if options.include?(:return_url)
+      params[:ap_cancelurl]  = options[:cancel_url]    if options.include?(:cancel_url)
+
+      returning button = [] do
+        params.each do |k, v|
+          button << tag(:input, :type => :hidden, :name => k.to_s, :value => v.to_s) unless v.nil?
+        end
+      end.join("\n")
+    end
+  end
+end

data/lib/notification.rb

@@ -0,0 +1,89 @@
+require 'cgi'
+
+module Alertpay
+  class Notification
+    attr_accessor :params
+    attr_accessor :raw
+
+    def initialize(post)
+      @params = {}
+      parse(post)
+    end
+
+    # The type of purchase. E.g. 'item' or 'subscription'.
+    def purchase_type
+      params['ap_purchasetype']
+    end
+
+    # Security code sent through from alertpay. You are to compare this with a
+    # hard coded value that you get from your alertpay profile, which only you
+    # should know.
+    def security_code
+      params['ap_securitycode']
+    end
+
+    # Name of the item that was purchased.
+    def item_name
+      params['ap_itemname']
+    end
+
+    # Was the payment successful?
+    def successful?
+      status == 'Success'
+    end
+
+    # Was this a subscription payment?
+    def is_subscription_payment?
+      status == 'Subscription-Payment-Success'
+    end
+
+    # The shipping charges for this transaction.
+    def shipping
+      params['ap_shippingcharges'].to_f
+    end
+
+    # Amount of item purchased.
+    def amount
+      params['ap_amount'].to_f
+    end
+
+    # Currency that the payment was made in.
+    def currency
+      params['ap_currency']
+    end
+
+    # Status of the payment. E.g. 'Succes'
+    def status
+      params['ap_status']
+    end
+
+    # The reference number or transaction ID you can use to refer to this
+    # transaction.
+    def reference_number
+      params['ap_referencenumber']
+    end
+
+    # The email address associated with the merchant that recieved the monies.
+    def merchant
+      params['ap_merchant']
+    end
+
+    # The item code on the alertpay side
+    def item_code
+      params['ap_itemcode']
+    end
+
+    # An array containing the 6 custom elements
+    def custom
+      params.values_at('apc_1', 'apc_2', 'apc_3', 'apc_4', 'apc_5', 'apc_6')
+    end
+
+    private
+      def parse(post)
+        @raw = post
+        CGI.parse(post).each_pair do |k,v|
+          params[k] = v.to_s
+        end
+      end
+  end
+end

data/test/notification_test.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'alertpay'
+
+class NotificationTest < Test::Unit::TestCase
+  def test_parse
+    alertpay = Alertpay::Notification.new raw_post
+  end
+
+  def test_successful
+    alertpay = Alertpay::Notification.new raw_post
+    assert alertpay.successful?
+  end
+
+  def test_custom
+    alertpay = Alertpay::Notification.new raw_post
+    assert_equal 'Danial Pearce', alertpay.custom[2]
+  end
+
+  private
+    def raw_post
+      'ap_merchant=alertpay@tigris.id.au&ap_securitycode=NOT_SECURE&ap_custfirstname=Danial&ap_custlastname=Pearce&ap_custaddress=1 There St&ap_custcity=Melbourne&ap_custstate=VIC&ap_custcountry=AUS&ap_custzip=3000&ap_custemailaddress=alertpay@tigris.id.au&ap_purchasetype=subscription&ap_referencenumber=TEST TRANSACTION&ap_itemname=Jigglets&ap_description=&ap_itemcode=&ap_quantity=1&ap_amount=28&ap_shippingcharges=0&ap_additionalcharges=0&ap_taxamount=0&ap_discountamount=0&ap_totalamount=28&ap_currency=USD&ap_subscriptionreferencenumber=REFERENCE&ap_timeunit=Month&ap_periodlength=1&ap_periodcount=-1&ap_nextrundate=&apc_1=1&apc_2=alertpay@tigris.id.au&apc_3=Danial Pearce&apc_4=&apc_5=&apc_6=&ap_test=1&ap_status=Success'
+    end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: stateless-systems-alertpay
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Stateless Systems
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: enquiries@statelesssystems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- README.txt
+- Rakefile
+- VERSION.yml
+- lib/alertpay.rb
+- lib/helpers.rb
+- lib/notification.rb
+- test/notification_test.rb
+has_rdoc: false
+homepage: http://github.com/stateless-systems/alertpay
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Common interface to alertpay request params.
+test_files: 
+- test/notification_test.rb