paypal 1.8.0 → 1.9.0

data/README

@@ -17,18 +17,10 @@ business account and tell paypal where to send the IPN ( Instant payment notific
 
 == Installation 
 
-1) Either install the rubygem for this library (rake install from source) or use gems directly:
-   gem install paypal --source http://dist.leetsoft.com/
-   
-2) Create a new controller which handels the paypal related tasks.  
-    script/generate controller payment   
-    
-3) Add the Paypal::Helpers to the newly created controller.
-    module PaymentHelper
-      include Paypal::Helpers
-    end
+1) Install the plugin using ./script/plugin install svn://vault.jadedpixel.com/paypal/trunk/paypal
+
 
-4) Create a paypal_ipn ( or similar ) action like the one in the "Example rails controller" appendix. 
+2) Create a paypal_ipn ( or similar ) action like the one in the "Example rails controller" appendix. 
 
 Within the new payment controller you can now create pages from which users can be sent to paypal. You always 
 have to sent users to paypal using a HTTP Post so a standard link won't work (well OK but you need some javascript for that). The +Paypal::Helper+ namespace has some examples of how such a forward page may look. 
@@ -103,6 +95,9 @@ uninitalized constant Paypal - Make sure your ruby has openssl support
 
 == Changelog
 
+2006-04-20 -- 1.7.0 
+* Now a rails plugin
+
 2006-02-10 -- 1.5.1
 * added complete list of valid paypal options (Paul Hart)
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "1.8.0"
+PKG_VERSION = "1.9.0"
 PKG_NAME = "paypal"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
@@ -49,7 +49,6 @@ end
 Rake::RDocTask.new { |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = "Paypal library"
-  rdoc.options << '--line-numbers --inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 }
@@ -89,8 +88,8 @@ spec = Gem::Specification.new do |s|
   s.description = s.summary = "Paypal IPN integration library for rails and other web applications"
   s.has_rdoc = true
 
-  s.files = %w(README Rakefile MIT-LICENSE) + Dir['lib/**/*'] + Dir['misc/*'] + Dir['tests/*']
-
+  s.files = %w(init.rb README Rakefile MIT-LICENSE) + Dir['lib/**/*'] + Dir['misc/**/*'] + Dir['test/**/*']
+  s.files.reject! { |f| /\/\.\_/ }
   s.require_path = 'lib'
   s.autorequire  = 'paypal'
   s.author = "Tobias Luetke"
@@ -114,12 +113,14 @@ RUBY_FORGE_USER = 'xal'
 RELEASE_NAME  = "REL #{PKG_VERSION}"
 
 desc "Publish the release files to RubyForge."
-task :release => [:gem] do
+task :release => [:publish] do
   `rubyforge login`
+  release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.gem"
+  puts release_command
+  system(release_command)
+
+  release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.zip"
+  puts release_command
+  system(release_command)
 
-  for ext in %w( gem tgz zip )
-    release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}"
-    puts release_command
-    system(release_command)
-  end
 end

data/init.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2005 Tobias Luetke
+#
+# 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.
+#++
+
+
+# Please note: Paypal is by default in *production* mode. 
+# During development you will want to add 
+#
+
+ActionView::Base.send(:include, Paypal::Helpers)

data/lib/notification.rb

@@ -1,3 +1,5 @@
+require 'net/http'
+
 module Paypal
   # Parser and handler for incoming Instant payment notifications from paypal. 
   # The Example shows a typical handler in a rails application. Note that this

data/test/helper_test.rb

@@ -0,0 +1,154 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'paypal'
+
+require_gem 'money'
+require_gem 'actionpack' rescue LoadError raise(StandardErrror.new("This test needs ActionPack installed as gem to run"))
+
+
+# Little hack class which pretends to be a active controller
+class TestController
+  include Paypal::Helpers
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::FormTagHelper
+
+  def url_for(options, *parameters_for_method_reference)
+    "http://www.sandbox.paypal.com/cgi-bin/webscr"
+  end
+end
+
+class HelperTest < Test::Unit::TestCase
+ 
+  
+  def assert_inputs(options, text)
+    all = text.scan(/name\=\"(\w+)\"/).flatten
+    
+    xor = (options.keys | all) - (options.keys & all)
+    
+    # xor
+    assert_equal [], xor, "options do not match expectations does not have keys #{xor.inspect} only appear in one of both sides in \n\n#{text}"
+
+    text.scan(/name\=\"([^"]+).*?value\=\"([^"]+)/) do |key, value|
+      if options.has_key?(key)
+        assert_equal options[key], value, "key #{key} was '#{options[key]}' and not '#{value}' in \n\n#{text}" 
+      end
+    end
+  end
+   
+  def setup 
+    @helpers = TestController.new
+  end
+
+  def test_paypal_form_start
+    assert_equal %{<form action="http://www.sandbox.paypal.com/cgi-bin/webscr" method="post">}, @helpers.paypal_form_tag
+  end
+
+  def test_paypal_setup_with_money
+    actual = @helpers.paypal_setup("100", Money.us_dollar(50000), "bob@bigbusiness.com")    
+    assert_inputs({ "amount" => "500.00",
+                    "business" => "bob@bigbusiness.com",
+                    "charset" => "utf-8",
+                    "cmd" => "_xclick",
+                    "currency_code" => "USD",
+                    "item_name" => "Store purchase",
+                    "item_number" => "100",
+                    "no_note" => "1",
+                    "no_shipping" => "1",
+                    "quantity" => "1"}, actual)
+  end
+
+  def test_paypal_setup_with_money_and_tax
+    actual = @helpers.paypal_setup("100", Money.us_dollar(50000), "bob@bigbusiness.com", :tax => Money.us_dollar(500))    
+    assert_inputs({ "amount" => "500.00",
+    "business" => "bob@bigbusiness.com",
+    "charset" => "utf-8",
+    "cmd" => "_xclick",
+    "currency_code" => "USD",
+    "item_name" => "Store purchase",
+    "item_number" => "100",
+    "no_note" => "1",
+    "no_shipping" => "1",
+    "quantity" => "1",
+    "tax" => "5.00"}, actual)
+  end
+  
+  def test_paypal_setup_with_money_and_invoice
+    actual = @helpers.paypal_setup("100", Money.us_dollar(50000), "bob@bigbusiness.com", :invoice => "Cool invoice!")    
+    assert_inputs({ "amount" => "500.00",
+    "business" => "bob@bigbusiness.com",
+    "charset" => "utf-8",
+    "cmd" => "_xclick",
+    "currency_code" => "USD",
+    "invoice" => "Cool invoice!",
+    "item_name" => "Store purchase",
+    "item_number" => "100",
+    "no_note" => "1",
+    "no_shipping" => "1",
+    "quantity" => "1"}, actual)
+  end  
+
+  def test_paypal_setup_with_money_and_custom
+    actual = @helpers.paypal_setup("100", Money.us_dollar(50000), "bob@bigbusiness.com", :custom => "Custom")    
+    assert_inputs({ "amount" => "500.00",
+    "business" => "bob@bigbusiness.com",
+    "charset" => "utf-8",
+    "cmd" => "_xclick",
+    "currency_code" => "USD",
+    "custom" => "Custom",
+    "item_name" => "Store purchase",
+    "item_number" => "100",
+    "no_note" => "1",
+    "no_shipping" => "1",
+    "quantity" => "1"}, actual)
+  end  
+  
+    def test_paypal_setup_with_float
+      actual = @helpers.paypal_setup("100", 50.00, "bob@bigbusiness.com", :currency => 'CAD')
+      assert_inputs({ "amount" => "50.00",
+      "business" => "bob@bigbusiness.com",
+      "charset" => "utf-8",
+      "cmd" => "_xclick",
+      "currency_code" => "CAD",
+      "item_name" => "Store purchase",
+      "item_number" => "100",
+      "no_note" => "1",
+      "no_shipping" => "1",
+      "quantity" => "1"}, actual)
+    end
+
+    def test_paypal_setup_with_string
+      actual = @helpers.paypal_setup("100", "50.00", "bob@bigbusiness.com", :currency => 'CAD')
+      assert_inputs({ "amount" => "50.00",
+      "business" => "bob@bigbusiness.com",
+      "charset" => "utf-8",
+      "cmd" => "_xclick",
+      "currency_code" => "CAD",
+      "item_name" => "Store purchase",
+      "item_number" => "100",
+      "no_note" => "1",
+      "no_shipping" => "1",
+      "quantity" => "1"}, actual)
+    end
+    
+  def test_paypal_setup_options
+    actual = @helpers.paypal_setup("100", Money.us_dollar(100), "bob@bigbusiness.com", :item_name => "MegaBob's shop purchase", :return => 'http://www.bigbusiness.com', :cancel_return => 'http://www.bigbusiness.com', :notify_url => 'http://www.bigbusiness.com', :no_shipping => 0, :no_note => 0  )    
+    assert_inputs({ "amount" => "1.00",
+    "business" => "bob@bigbusiness.com",
+    "cancel_return" => "http://www.bigbusiness.com",
+    "charset" => "utf-8",
+    "cmd" => "_xclick",
+    "currency_code" => "USD",
+    "item_name" => "MegaBob's shop purchase",
+    "item_number" => "100",
+    "no_note" => "0",
+    "no_shipping" => "0",
+    "notify_url" => "http://www.bigbusiness.com",
+    "quantity" => "1",
+    "return" => "http://www.bigbusiness.com"}, actual )
+  end    
+
+
+end

data/test/mocks/method_mock.rb

@@ -0,0 +1,33 @@
+class Module
+  def mock_methods(mock_methods)
+    raise "mock methods needs a block" unless block_given?
+    
+    original    = self
+    namespace   = original.name.split("::")
+    class_name  = namespace.last
+    
+    mod = namespace[0..-2].inject(Object) { |mod, part| mod.const_get(part) }
+    
+    klass = (original.is_a?(Class) ? Class : Module).new(self) do
+
+      instance_eval do       
+        mock_methods.each do |method, proc| 
+          define_method("mocked_#{method}", &proc)
+          alias_method method, "mocked_#{method}"
+        end            
+      end
+      
+    end
+    
+    begin
+      mod.send(:remove_const, class_name)
+      mod.const_set(class_name, klass)
+      
+      yield      
+    ensure
+      mod.send(:remove_const, class_name)
+      mod.const_set(class_name, original)
+    end
+    
+  end
+end

data/test/notification_test.rb

@@ -0,0 +1,83 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'openssl'
+require 'net/http'
+require File.dirname(__FILE__) + '/mocks/method_mock'
+require 'test/unit'
+require 'paypal'
+
+$paypal_success = Class.new do
+  def body; "VERIFIED"; end
+end
+
+$paypal_failure = Class.new do
+  def body; "INVALID"; end
+end
+
+
+class NotificationTest < Test::Unit::TestCase
+
+  def setup
+    Paypal::Notification.ipn_url = "http://www.paypal.com/some/address"
+
+    @paypal = Paypal::Notification.new(http_raw_data)
+  end
+
+  def test_raw
+    assert_equal http_raw_data, @paypal.raw
+  end
+
+  def test_parse
+    @paypal = Paypal::Notification.new(http_raw_data)
+    assert_equal "500.00", @paypal.params['mc_gross']
+    assert_equal "confirmed", @paypal.params['address_status']
+    assert_equal "EVMXCLDZJV77Q", @paypal.params['payer_id']
+    assert_equal "Completed", @paypal.params['payment_status']    
+    assert_equal CGI.unescape("15%3A23%3A54+Apr+15%2C+2005+PDT"), @paypal.params['payment_date']
+    # ...
+  end
+
+  def test_accessors
+    assert @paypal.complete?
+    assert_equal "Completed", @paypal.status
+    assert_equal "6G996328CK404320L", @paypal.transaction_id
+    assert_equal "web_accept", @paypal.type
+    assert_equal "500.00", @paypal.gross
+    assert_equal "15.05", @paypal.fee
+    assert_equal "CAD", @paypal.currency
+  end
+
+  def test_compositions
+    assert_equal Money.ca_dollar(50000), @paypal.amount
+  end
+
+  def test_acknowledgement    
+        
+    
+    Net::HTTP.mock_methods( :request => Proc.new { |r, b| $paypal_success.new } ) do     
+      assert @paypal.acknowledge        
+    end
+
+    Net::HTTP.mock_methods( :request => Proc.new { |r, b| $paypal_failure.new } ) do 
+      assert !@paypal.acknowledge
+    end
+
+  end
+
+  def test_send_acknowledgement
+    request, body = nil
+    
+    Net::HTTP.mock_methods( :request => Proc.new { |r, b| request = r; body = b; $paypal_success.new } ) do     
+      assert @paypal.acknowledge        
+    end
+
+    assert_equal '/some/address?cmd=_notify-validate', request.path
+    assert_equal http_raw_data, body
+  end
+
+  private
+
+  def http_raw_data
+    "mc_gross=500.00&address_status=confirmed&payer_id=EVMXCLDZJV77Q&tax=0.00&address_street=164+Waverley+Street&payment_date=15%3A23%3A54+Apr+15%2C+2005+PDT&payment_status=Completed&address_zip=K2P0V6&first_name=Tobias&mc_fee=15.05&address_country_code=CA&address_name=Tobias+Luetke&notify_version=1.7&custom=&payer_status=unverified&business=tobi%40leetsoft.com&address_country=Canada&address_city=Ottawa&quantity=1&payer_email=tobi%40snowdevil.ca&verify_sign=AEt48rmhLYtkZ9VzOGAtwL7rTGxUAoLNsuf7UewmX7UGvcyC3wfUmzJP&txn_id=6G996328CK404320L&payment_type=instant&last_name=Luetke&address_state=Ontario&receiver_email=tobi%40leetsoft.com&payment_fee=&receiver_id=UQ8PDYXJZQD9Y&txn_type=web_accept&item_name=Store+Purchase&mc_currency=CAD&item_number=&test_ipn=1&payment_gross=&shipping=0.00"
+  end  
+end

data/test/remote/remote_test.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'test/unit'
+require 'paypal'
+
+class RemoteTest < Test::Unit::TestCase
+
+  def test_raw
+    Paypal::Notification.ipn_url = "https://www.sandbox.paypal.com/cgi-bin/webscr"
+    @paypal = Paypal::Notification.new('')
+    
+    assert_nothing_raised do
+      assert_equal false, @paypal.acknowledge    
+    end
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: paypal
 version: !ruby/object:Gem::Version 
-  version: 1.8.0
-date: 2006-04-09 00:00:00 -04:00
+  version: 1.9.0
+date: 2006-04-29 00:00:00 -04:00
 summary: Paypal IPN integration library for rails and other web applications
 require_paths: 
 - lib
@@ -28,6 +28,7 @@ cert_chain:
 authors: 
 - Tobias Luetke
 files: 
+- init.rb
 - README
 - Rakefile
 - MIT-LICENSE
@@ -36,6 +37,12 @@ files:
 - lib/paypal.rb
 - misc/PayPal - Instant Payment Notification - Technical Overview.pdf
 - misc/paypal.psd
+- test/helper_test.rb
+- test/mocks
+- test/notification_test.rb
+- test/remote
+- test/mocks/method_mock.rb
+- test/remote/remote_test.rb
 test_files: []
 
 rdoc_options: []