ljoseppi-paypal 3.0.0pre6

data/lib/paypal/helpers/rails.rb

@@ -0,0 +1,19 @@
+module Paypal
+  module Helpers
+    module Rails
+      # Convenience helper. Can replace <%= form_tag Paypal::Notification.ipn_url %>
+      # takes optional url parameter, default is Paypal::Notification.ipn_url
+      def paypal_form_tag(url = Paypal::Config.ipn_url, options = {})
+        form_tag(url, options)
+      end
+
+      def paypal_form_tag(url = Paypal::Config.ipn_url, options = {}, &block)
+        if block
+          concat(form_tag(url, options)+capture(&block)+"</form>", block.binding)
+        else
+          form_tag(url, options)
+        end
+      end
+    end
+  end
+end

data/lib/paypal/notification.rb

@@ -0,0 +1,188 @@
+require 'rack'
+require 'net/http'
+
+module Paypal
+  class NoDataError < StandardError; end
+
+  # Parser and handler for incoming Instant payment notifications from paypal.
+  # The Example shows a typical handler in a rails application. Note that this
+  # is an example, please read the Paypal API documentation for all the details
+  # on creating a safe payment controller.
+  #
+  # Example (Sinatra)
+  #   def raw_post
+  #     request.env["rack.input"].read
+  #   end
+  #
+  #   post "/paypal_ipn" do
+  #     notify = Paypal::Notification.new(raw_post)
+  #
+  #     order = Order.find(notify.item_id)
+  #
+  #     if notify.acknowledge
+  #       begin
+  #         if notify.complete? and order.total == notify.amount and notify.business == 'sales@myshop.com'
+  #             order.status = 'success'
+  #
+  #             shop.ship(order)
+  #           else
+  #             logger.error("Failed to verify Paypal's notification, please investigate")
+  #           end
+  #
+  #         rescue => e
+  #           order.status        = 'failed'
+  #           raise
+  #         ensure
+  #           order.save
+  #         end
+  #       end
+  #
+  #       nil
+  #     end
+  #   end
+  #
+  # Example (Rails)
+  #
+  #   class BackendController < ApplicationController
+  #
+  #     def paypal_ipn
+  #       notify = Paypal::Notification.new(request.raw_post)
+  #
+  #       order = Order.find(notify.item_id)
+  #
+  #       if notify.acknowledge
+  #         begin
+  #
+  #           if notify.complete? and order.total == notify.amount and notify.business == 'sales@myshop.com'
+  #             order.status = 'success'
+  #
+  #             shop.ship(order)
+  #           else
+  #             logger.error("Failed to verify Paypal's notification, please investigate")
+  #           end
+  #
+  #         rescue => e
+  #           order.status        = 'failed'
+  #           raise
+  #         ensure
+  #           order.save
+  #         end
+  #       end
+  #
+  #       render :nothing
+  #     end
+  #   end
+  class Notification
+    attr_accessor :params
+    attr_accessor :raw
+
+    # Creates a new paypal object. Pass the raw html you got from paypal in.
+    # In a rails application this looks something like this
+    #
+    #   def paypal_ipn
+    #     paypal = Paypal::Notification.new(request.raw_post)
+    #     ...
+    #   end
+    def initialize(post)
+      raise NoDataError if post.to_s.empty?
+
+      @params  = {}
+      @raw     = ""
+
+      parse(post)
+    end
+
+    # Transaction statuses
+    def canceled_reversal?
+      status == :Canceled_Reversal
+    end
+
+    def completed?
+      status == :Completed
+    end
+
+    def denied?
+      status == :Denied
+    end
+
+    def expired?
+      status == :Expired
+    end
+
+    def failed?
+      status == :Failed
+    end
+
+    def pending?
+      status == :Pending
+    end
+
+    def processed?
+      status == :Processed
+    end
+
+    def refunded?
+      status == :Refunded
+    end
+
+    def reversed?
+      status == :Reversed
+    end
+
+    def voided?
+      status == :Voided
+    end
+
+    # Acknowledge the transaction to paypal. This method has to be called after a new
+    # ipn arrives. Paypal will verify that all the information we received are correct and will return a
+    # ok or a fail.
+    #
+    # Example:
+    #
+    #   def paypal_ipn
+    #     notify = PaypalNotification.new(request.raw_post)
+    #
+    #     if notify.acknowledge
+    #       ... process order ... if notify.complete?
+    #     else
+    #       ... log possible hacking attempt ...
+    #     end
+    def acknowledge
+      payload = raw
+
+      uri = URI.parse(Paypal::Config.ipn_url)
+      request = Net::HTTP::Post.new(Paypal::Config.ipn_validation_path)
+      request['Content-Length'] = "#{payload.size}"
+      request['User-Agent']     = "paypal ruby -- http://github.com/JonathanTron/paypal"
+
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      http.verify_mode    = OpenSSL::SSL::VERIFY_NONE unless @ssl_strict
+      http.use_ssl        = true
+
+      request = http.request(request, payload)
+
+      raise StandardError.new("Faulty paypal result: #{request.body}") unless ["VERIFIED", "INVALID"].include?(request.body)
+
+      request.body == "VERIFIED"
+    end
+
+    def method_missing(method, *args)
+      params[method.to_s] || super
+    end
+
+    private
+
+    def status
+      @status ||= (params['payment_status'] ? params['payment_status'].to_sym : nil)
+    end
+
+    # Take the posted data and move the relevant data into a hash
+    def parse(post)
+      @raw = post
+      self.params = Rack::Utils.parse_query(post)
+      # Rack allows duplicate keys in queries, we need to use only the last value here
+      self.params.each{|k,v| self.params[k] = v.last if v.is_a?(Array)}
+    end
+  end
+end

data/lib/paypal/rails.rb

@@ -0,0 +1,6 @@
+require 'active_support'
+require File.join(File.dirname(__FILE__),'helpers', '/common')
+require File.join(File.dirname(__FILE__),'helpers', '/rails')
+
+ActionView::Base.send(:include, Paypal::Helpers::Common)
+ActionView::Base.send(:include, Paypal::Helpers::Rails)

data/lib/paypal/version.rb

@@ -0,0 +1,3 @@
+module Paypal
+  VERSION = "3.0.0pre6"
+end

data/lib/paypal.rb

@@ -0,0 +1,8 @@
+require 'cgi'
+require 'net/http'
+require 'net/https'
+
+require "paypal/version"
+require "paypal/config"
+require "paypal/notification"
+require "paypal/helpers/common"

data/misc/multiruby.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+for i in 1.9.2-head 1.9.1 ree 1.8.7; do
+  rvm use $i && echo `ruby -v` && bundle install > /dev/null && bundle exec rake spec && bundle show
+done

data/paypal.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "paypal/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ljoseppi-paypal"
+  s.version     = Paypal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lairton Borges","Jonathan TRON", "Joseph HALTER", "Tobias LUETKE"]
+  s.email       = "ljoseppi@gmail.com"
+  s.homepage    = "https://github.com/ljoseppi/paypal"
+  s.summary     = %q{Integrate Paypal Express}
+  s.description = %q{Paypal Express Integration}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+
+  s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
+
+  s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+  s.add_development_dependency(%q<rcov>, [">= 0.9.8"])
+  s.add_development_dependency(%q<nokogiri>, [">= 0"])
+  s.add_development_dependency(%q<bluecloth>, [">= 0"])
+  s.add_development_dependency(%q<yard>, [">= 0"])
+  s.add_development_dependency(%q<fakeweb>, [">= 0"])
+end

data/spec/config_spec.rb

@@ -0,0 +1,168 @@
+require "spec_helper"
+
+describe Paypal::Config do
+  after do
+    Paypal.class_eval do
+      remove_const :Config if const_defined?(:Config)
+    end
+    load "paypal/config.rb"
+  end
+  
+  describe "ipn_urls" do
+    it "should define url for :production" do
+      Paypal::Config.ipn_urls[:production].should eql("https://www.paypal.com/cgi-bin/webscr")
+    end
+    it "should define url for :sandbox" do
+      Paypal::Config.ipn_urls[:sandbox].should eql("https://www.sandbox.paypal.com/cgi-bin/webscr")
+    end
+    it "should allow changing urls" do
+      url = "https://myownsandbox.com"
+      Paypal::Config.ipn_urls[:sandbox] = url
+      Paypal::Config.ipn_urls[:sandbox].should eql(url)
+    end
+  end
+
+  describe "mode" do
+    it "should be :sandbox by default" do
+      Paypal::Config.mode.should eql(:sandbox)
+    end
+    
+    it "should accept :sandbox" do
+      lambda {
+        Paypal::Config.mode = :sandbox
+      }.should_not raise_error
+    end
+
+    it "should accept :production" do
+      lambda {
+        Paypal::Config.mode = :production
+      }.should_not raise_error
+    end
+
+    it "should not accept something different than :production or :sandbox" do
+      lambda {
+        Paypal::Config.mode = :demo
+      }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe "when setting mode to sandbox" do
+    before do
+      Paypal::Config.mode = :sandbox
+    end
+    
+    it "should be in :sandbox mode" do
+      Paypal::Config.mode.should eql(:sandbox)
+    end
+
+    it "should have ipn url for sandbox" do
+      Paypal::Config.ipn_url.should eql("https://www.sandbox.paypal.com/cgi-bin/webscr")
+    end
+    
+    it "should have the ipn validation path for sandbox" do
+      Paypal::Config.ipn_validation_path.should eql("/cgi-bin/webscr?cmd=_notify-validate")
+    end
+
+    it "should have the ipn validation url for sandbox" do
+      Paypal::Config.ipn_validation_url.should eql("https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_notify-validate")
+    end
+    
+    it "should have paypal cert for sandbox" do
+      Paypal::Config.paypal_cert.should eql(
+"-----BEGIN CERTIFICATE-----
+MIIDoTCCAwqgAwIBAgIBADANBgkqhkiG9w0BAQUFADCBmDELMAkGA1UEBhMCVVMx
+EzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNhbiBKb3NlMRUwEwYDVQQK
+EwxQYXlQYWwsIEluYy4xFjAUBgNVBAsUDXNhbmRib3hfY2VydHMxFDASBgNVBAMU
+C3NhbmRib3hfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tMB4XDTA0
+MDQxOTA3MDI1NFoXDTM1MDQxOTA3MDI1NFowgZgxCzAJBgNVBAYTAlVTMRMwEQYD
+VQQIEwpDYWxpZm9ybmlhMREwDwYDVQQHEwhTYW4gSm9zZTEVMBMGA1UEChMMUGF5
+UGFsLCBJbmMuMRYwFAYDVQQLFA1zYW5kYm94X2NlcnRzMRQwEgYDVQQDFAtzYW5k
+Ym94X2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbTCBnzANBgkqhkiG
+9w0BAQEFAAOBjQAwgYkCgYEAt5bjv/0N0qN3TiBL+1+L/EjpO1jeqPaJC1fDi+cC
+6t6tTbQ55Od4poT8xjSzNH5S48iHdZh0C7EqfE1MPCc2coJqCSpDqxmOrO+9QXsj
+HWAnx6sb6foHHpsPm7WgQyUmDsNwTWT3OGR398ERmBzzcoL5owf3zBSpRP0NlTWo
+nPMCAwEAAaOB+DCB9TAdBgNVHQ4EFgQUgy4i2asqiC1rp5Ms81Dx8nfVqdIwgcUG
+A1UdIwSBvTCBuoAUgy4i2asqiC1rp5Ms81Dx8nfVqdKhgZ6kgZswgZgxCzAJBgNV
+BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMREwDwYDVQQHEwhTYW4gSm9zZTEV
+MBMGA1UEChMMUGF5UGFsLCBJbmMuMRYwFAYDVQQLFA1zYW5kYm94X2NlcnRzMRQw
+EgYDVQQDFAtzYW5kYm94X2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNv
+bYIBADAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GBAFc288DYGX+GX2+W
+P/dwdXwficf+rlG+0V9GBPJZYKZJQ069W/ZRkUuWFQ+Opd2yhPpneGezmw3aU222
+CGrdKhOrBJRRcpoO3FjHHmXWkqgbQqDWdG7S+/l8n1QfDPp+jpULOrcnGEUY41Im
+jZJTylbJQ1b5PBBjGiP0PpK48cdF
+-----END CERTIFICATE-----")
+    end
+    
+    it "should allow setting a new sandbox cert" do
+      lambda {
+        Paypal::Config.paypal_sandbox_cert = "TEST"
+      }.should_not raise_error
+      Paypal::Config.paypal_cert.should eql("TEST")
+    end
+  end
+  
+  describe "when setting mode to :production" do
+    before do
+      Paypal::Config.mode = :production
+    end
+    
+    it "should be in :production mode" do
+      Paypal::Config.mode.should eql(:production)
+    end
+
+    it "should have ipn url for production" do
+      Paypal::Config.ipn_url.should eql("https://www.paypal.com/cgi-bin/webscr")
+    end
+    
+    it "should have the ipn validation path for production" do
+      Paypal::Config.ipn_validation_path.should eql("/cgi-bin/webscr?cmd=_notify-validate")
+    end
+
+    it "should have the ipn validation url for production" do
+      Paypal::Config.ipn_validation_url.should eql("https://www.paypal.com/cgi-bin/webscr?cmd=_notify-validate")
+    end
+
+    describe "when paypal_production_cert was not set" do
+      before do
+        @old_cert, Paypal::Config.paypal_production_cert = Paypal::Config.paypal_production_cert, nil
+      end
+      
+      after do
+        Paypal::Config.paypal_production_cert = @old_cert
+      end
+      
+      it "should raise an error" do
+        lambda {
+          Paypal::Config.paypal_cert
+        }.should raise_error(StandardError)
+      end
+    end
+
+    describe "when paypal_production_cert was set" do
+      before do
+        @old_cert, Paypal::Config.paypal_production_cert = Paypal::Config.paypal_production_cert, "TEST"
+      end
+      
+      after do
+        Paypal::Config.paypal_production_cert = @old_cert
+      end
+      
+      it "should not raise an error" do
+        lambda {
+          Paypal::Config.paypal_cert
+        }.should_not raise_error(StandardError)
+      end
+
+      it "should use the paypal production certificate" do
+        Paypal::Config.paypal_cert.should eql("TEST")
+      end
+    end
+
+    it "should allow setting a new production cert" do
+      lambda {
+        Paypal::Config.paypal_production_cert = "TEST"
+      }.should_not raise_error
+      Paypal::Config.paypal_cert.should eql("TEST")
+    end
+  end
+end

data/spec/fixtures/business_cert.pem

@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIC/jCCAmegAwIBAgIJAPlQUrHaPFrXMA0GCSqGSIb3DQEBBQUAMF4xCzAJBgNV
+BAYTAkZSMRMwEQYDVQQIEwpTb21lLVN0YXRlMR4wHAYDVQQKExVPcGVuaG9vZCAt
+IFBheXBhbCBnZW0xGjAYBgNVBAMTEU9wZW5ob29kUGF5cGFsR2VtMB4XDTEwMDMy
+ODE1MjgwM1oXDTIwMDMyNTE1MjgwM1owXjELMAkGA1UEBhMCRlIxEzARBgNVBAgT
+ClNvbWUtU3RhdGUxHjAcBgNVBAoTFU9wZW5ob29kIC0gUGF5cGFsIGdlbTEaMBgG
+A1UEAxMRT3Blbmhvb2RQYXlwYWxHZW0wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJ
+AoGBAMaHlHZGjccN7p2xV6ro+TWc34EnRWhXRe1g9z/YwxhKA3Iu9etrU8m8Bbdh
+EpBQTv/IOp7EG7kiUWcdyZp5gEQn6vX/+VIyvIJEDIiyWbxk2TBr6ofb0N8dwebh
+M1T4Z7RvpqSAQWjbqFnN32IWR8SzmnZ5Hl/omfOsII14rWmDAgMBAAGjgcMwgcAw
+HQYDVR0OBBYEFDDSdBbUWCfW8kVhoIkjEQm0a5P1MIGQBgNVHSMEgYgwgYWAFDDS
+dBbUWCfW8kVhoIkjEQm0a5P1oWKkYDBeMQswCQYDVQQGEwJGUjETMBEGA1UECBMK
+U29tZS1TdGF0ZTEeMBwGA1UEChMVT3Blbmhvb2QgLSBQYXlwYWwgZ2VtMRowGAYD
+VQQDExFPcGVuaG9vZFBheXBhbEdlbYIJAPlQUrHaPFrXMAwGA1UdEwQFMAMBAf8w
+DQYJKoZIhvcNAQEFBQADgYEAtnLucD1VU50JDcS/uuerhsBCHYwYUyrksYd43Stz
+LaFLEhNXlciWvAanfMp182F1b5SLQdE9WqGZ4bDHWlgVeFa6zqcbmu7O9Z7xi0pS
+f6lx3qllyjbn1zPbuiPOImM81dvXODYXD8fRvBc4+uTy4Xqin5rlwTvsM5TxJgHw
+sSc=
+-----END CERTIFICATE-----

data/spec/fixtures/business_key.pem

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXgIBAAKBgQDGh5R2Ro3HDe6dsVeq6Pk1nN+BJ0VoV0XtYPc/2MMYSgNyLvXr
+a1PJvAW3YRKQUE7/yDqexBu5IlFnHcmaeYBEJ+r1//lSMryCRAyIslm8ZNkwa+qH
+29DfHcHm4TNU+Ge0b6akgEFo26hZzd9iFkfEs5p2eR5f6JnzrCCNeK1pgwIDAQAB
+AoGBAKI289K0kXHc62TEG/rVQ5NP67vPB8Ja1RNB0KTFi5uUFj69KklCuAK09ALD
+eXSbegE7bNJ/MJvT86mKyEjFEEyvpupEy7uzqZtWJUWHkDZTN2nyiz+kyRvhzldi
+DlMOA0S3sNF6il94Chjb+F6/b+8d6cd8zi86tN5NJ0RLBiJ5AkEA6RrJxclKjPIb
+GEtQ7W/hvhne2fx+F/mXdUg4TXBzupk9G5fgFpB05NDrLVs8gIJisBf7h/9OQ69B
+Qvps9V4GxwJBANoHbtGQDBZDka1RSOsRubSqRMDWOYiE0KJcGmEdwoOz/zH0YcWI
+iYQRv0k/sGITDAUQW+cqMEd82zME/XR0W2UCQQCgc98FdNwLDq+V1mn7NfMGPpqG
+I+XLrPMTOMYAj/IpNEe60ZzfC0pbIm9vRgjsUFOL8MYjw5nkvyLF7sjHUJSLAkEA
+k0IB7zjDcSYh9lW4UkyeiQ+XcEdAhJxv7bkXeBCJmDqyWiMdBjW566Gw+OAzWYpT
+y/fImtE72ozR4Bu2tDkCoQJAHWVaDrzDANnUP8/xGoPxbWI8lYE+kKpyZtyTOgWm
+mXbXCGjqKRA5HcDMoNmd0+pY/3pXx5VjHOiL2UsKrSnTaQ==
+-----END RSA PRIVATE KEY-----

data/spec/helpers/common_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+describe Paypal::Helpers::Common do
+  include Paypal::Helpers::Common
+
+  describe ".paypal_setup(item_number, amount, business, options = {})" do
+    describe "with default options" do
+      before do
+        @result = paypal_setup(1, "10.00", "trash@openhood.com")
+      end
+
+      {
+        "item_number" => "1",
+        "amount" => "10.00",
+        "currency_code" => "USD",
+        "business" => "trash@openhood.com",
+        "cmd" => "_xclick",
+        "quantity" => "1",
+        "item_number" => "1",
+        "item_name" => "Store purchase",
+        "no_shipping" => "1",
+        "no_note" => "1",
+        "charset" => "utf-8"
+      }.each do |key, value|
+        it "should include #{key} with #{value}" do
+          @result.should have_css("input[type=hidden][name=\"#{key}\"][value=\"#{value}\"]")
+        end
+      end
+    end
+
+    describe "with :enable_encryption set to true" do
+      context "with Paypal::Config.business_cert business_key and business_cert_id not set" do
+        it "should raise an error" do
+          lambda {
+            paypal_setup(1, "10.00", "trash@openhood.com", {:enable_encryption => true})
+          }.should raise_error ArgumentError, "Paypal::Config.business_key, Paypal::Config.business_cert and Paypal::Config.business_cert_id should be set if you use :enable_encryption"
+        end
+      end
+
+      context "with Paypal::Config.business_cert business_key and business_cert_id set" do
+        before do
+          Paypal::Config.business_cert = File.read(File.expand_path("../../fixtures/business_cert.pem", __FILE__))
+          Paypal::Config.business_key = File.read(File.expand_path("../../fixtures/business_key.pem", __FILE__))
+          Paypal::Config.business_cert_id = "CERTID"
+          @result = paypal_setup(1, "10.00", "trash@openhood.com", {
+            :enable_encryption => true
+          })
+        end
+
+        it "should include cmd with _s-xclick" do
+          @result.should have_css("input[type=hidden][name=cmd][value=_s-xclick]")
+        end
+        it "should include cmd with encrypted datas" do
+          @result.should have_css("input[type=hidden][name=encrypted][value*=PKCS7]")
+          @result.should_not have_css("input[type=hidden][name=encrypted][value*='\n']")
+        end
+      end
+    end
+
+    describe "with unknown options" do
+      it "should raise an error" do
+        lambda do
+          paypal_setup(1, "10.00", "trash@openhood.com", :unknown_option => "unknown")
+        end.should raise_error(ArgumentError, "Unknown option #{[:unknown_option].inspect}")
+      end
+    end
+  end
+end