pippin 0.1.1 → 1.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: bundle exec rspec spec
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -3,5 +3,5 @@ source :rubygems
 gemspec
 
 gem 'combustion',
-  :git => 'git://github.com/freelancing-god/combustion.git',
+  :git => 'git://github.com/pat/combustion.git',
   :ref => 'd7a6836269a8fb528bc3721e9b8c06b5a62ef3cc'

data/HISTORY

@@ -1,3 +1,8 @@
+1.0.0 - September 25th 2012
+* Rails/ActiveSupport 3.1 or better.
+* No listener - use ActiveSupport::Notifications instead.
+* No controller - just as easy running things as a simple Rack app.
+
 0.1.1 - January 4th 2012
 * Don't require a specific version of Rails, just 3.0 or better.
 

data/README.textile

@@ -2,25 +2,37 @@ h1. Pippin
 
 Pippin is a Rails Engine for processing PayPal IPN requests. It automatically adds a route to your Rails application that validates and processes IPNs.
 
-If you want to do something with those IPN objects (and I recommend you do), then all you need to do is attach a listener, and that'll fire as each valid IPN is received.
+If you want to do something with those IPN objects (and I recommend you do), then all you need to do is attach a subscriber to the notification, and that'll fire as each valid IPN is received.
+
+*Using Rails 3.0?* Then you better jump back to the "0.1.1 release":https://github.com/pat/pippin/tree/v0.1.1 of this library, which does not use ActiveSupport::Notifications.
 
 h2. Installation and Usage
 
 Just add it to your Gemfile:
 
-<pre><code>gem 'pippin', '~> 0.1'</code></pre>
+<pre><code>gem 'pippin', '~> 1.0.0'</code></pre>
 
-Then, in an initializer, add your listener:
+Then somewhere (perhaps in an initializer), subscribe to the notifications:
 
-<pre><code># config/initializers/pippin.rb
-Pippin.listener = lambda { |ipn|
+<pre><code>ActiveSupport::Notifications.subscribe('received.ipn') do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  ipn   = event.payload[:ipn]
   # use IPN data
   ipn.params # => {'business' => 'email@domain.com', 'txn_type' => ...}
-}</code></pre>
+end</code></pre>
+
+There are also notifications fired using the txn_type parameter as the prefix, if you wish to subscribe to certain types:
+
+<pre><code>ActiveSupport::Notifications.subscribe('subscr_signup.ipn') do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  ipn   = event.payload[:ipn]
+
+  # A subscription sign up has happened. Do something!
+end</code></pre>
 
 Any parameters with the suffix '_date' in their name will automatically be translated from PayPal's ugly date string to an appropriate Time object.
 
-When constructing your form that redirects people to PayPal, you'll want to set the @notify_url@ parameter to use Pippin's URL that has automatically been added to your routes: @pippin_ipns_url@.
+When constructing your form that redirects people to PayPal, you'll want to set the @notify_url@ parameter to use Pippin's URL that has automatically been added to your routes: @'pippin/ipns'@.
 
 h2. Contributing
 

data/config/routes.rb

@@ -1,5 +1,3 @@
 Rails.application.routes.draw do
-  namespace :pippin do
-    resources :ipns, :only => [:create]
-  end
+  mount Pippin::App.new => '/pippin/ipns'
 end

data/lib/pippin.rb

@@ -1,15 +1,11 @@
-require 'rails'
+require 'active_support/notifications'
+require 'active_support/core_ext/module/delegation'
 
 module Pippin
-  def self.listener
-    @listener
-  end
-
-  def self.listener=(listener)
-    @listener = listener
-  end
+  #
 end
 
-require 'pippin/engine'
+require 'pippin/app'
 require 'pippin/ipn'
-require 'pippin/version'
+
+require 'pippin/engine' if defined?(Rails)

data/lib/pippin/app.rb

@@ -0,0 +1,17 @@
+class Pippin::App
+  delegate :instrument, :to => ActiveSupport::Notifications
+
+  def call(env)
+    request = Rack::Request.new(env)
+    ipn     = Pippin::IPN.new request.params, request.body.read
+
+    if ipn.valid?
+      instrument 'received.ipn',                  :ipn => ipn
+      instrument "#{ipn.params['txn_type']}.ipn", :ipn => ipn
+
+      [200, {}, [' ']]
+    else
+      [400, {}, [' ']]
+    end
+  end
+end

data/lib/pippin/engine.rb

@@ -1,4 +1,3 @@
 class Pippin::Engine < Rails::Engine
-  paths['app/controllers'] << 'app/controllers'
   paths['config'] << 'config'
 end

data/lib/pippin/ipn.rb

@@ -38,6 +38,9 @@ class Pippin::IPN
   end
 
   def paypal_uri
-    "https://www.paypal.com/cgi-bin/webscr?cmd=_notify-validate&#{body}"
+    domain = 'www.paypal.com'
+    domain = 'www.sandbox.paypal.com' if params['test_ipn'] == '1'
+
+    "https://#{domain}/cgi-bin/webscr?cmd=_notify-validate&#{body}"
   end
 end

data/pippin.gemspec

@@ -1,10 +1,9 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
-require 'pippin/version'
 
 Gem::Specification.new do |s|
   s.name        = 'pippin'
-  s.version     = Pippin::VERSION
+  s.version     = '1.0.0'
   s.authors     = ['Pat Allan']
   s.email       = ['pat@freelancing-gods.com']
   s.homepage    = ''
@@ -18,7 +17,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'rails', '>= 3.0'
+  s.add_runtime_dependency 'activesupport', '>= 3.1'
 
   s.add_development_dependency 'fakeweb',         '1.3.0'
   s.add_development_dependency 'fakeweb-matcher', '1.2.2'

data/spec/pippin/ipn_spec.rb

@@ -22,6 +22,18 @@ describe Pippin::IPN do
         'https://www.paypal.com/cgi-bin/webscr?cmd=_notify-validate&foo=bar')
     end
 
+    it "checks the validity in the sandbox if it is a test IPN" do
+      FakeWeb.register_uri :get,
+        /^https:\/\/www\.sandbox\.paypal\.com\/cgi-bin\/webscr/,
+        :body => 'VERIFIED'
+
+      ipn = Pippin::IPN.new({'test_ipn' => '1'}, 'foo=bar')
+      ipn.valid?
+
+      FakeWeb.should have_requested(:get,
+        'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_notify-validate&foo=bar')
+    end
+
     it "returns true if PayPal confirms the validity of the data" do
       FakeWeb.register_uri :get, /^https:\/\/www\.paypal\.com\/cgi-bin\/webscr/,
         :body => 'VERIFIED'

data/spec/requests/ipn_submission_spec.rb

@@ -13,12 +13,16 @@ describe 'IPN Submission' do
       response.status.should == 200
     end
 
-    it "calls the provided listener" do
+    it "calls the provided subscriber" do
       ipn_lodged = false
-      Pippin.listener = lambda { |ipn| ipn_lodged = true }
+      sub = ActiveSupport::Notifications.subscribe('received.ipn') { |payload|
+        ipn_lodged = true
+      }
 
       post '/pippin/ipns'
 
+      ActiveSupport::Notifications.unsubscribe sub
+
       ipn_lodged.should be_true
     end
   end
@@ -37,10 +41,14 @@ describe 'IPN Submission' do
 
     it "does not call the provided listener" do
       ipn_lodged = false
-      Pippin.listener = lambda { |ipn| ipn_lodged = true }
+      sub = ActiveSupport::Notifications.subscribe('received.ipn') { |payload|
+        ipn_lodged = true
+      }
 
       post '/pippin/ipns'
 
+      ActiveSupport::Notifications.unsubscribe sub
+
       ipn_lodged.should be_false
     end
   end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler'
+require 'rails'
 
 Bundler.require :default, :development
 

metadata

@@ -1,125 +1,164 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: pippin
-version: !ruby/object:Gem::Version
-  version: 0.1.1
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
-authors:
+authors: 
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70102267855040 !ruby/object:Gem::Requirement
+
+date: 2012-09-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
   type: :runtime
-  prerelease: false
-  version_requirements: *70102267855040
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: fakeweb
-  requirement: &70102277736820 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
   type: :development
-  prerelease: false
-  version_requirements: *70102277736820
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: fakeweb-matcher
-  requirement: &70102277735200 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 2
+        - 2
         version: 1.2.2
   type: :development
-  prerelease: false
-  version_requirements: *70102277735200
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rspec-rails
-  requirement: &70102277734220 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
         version: 2.7.0
   type: :development
-  prerelease: false
-  version_requirements: *70102277734220
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: sqlite3
-  requirement: &70102277733580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 3
+        - 5
         version: 1.3.5
   type: :development
-  prerelease: false
-  version_requirements: *70102277733580
-description: Accepts IPN requests, validates them and passes them on to a defined
-  listener.
-email:
+  version_requirements: *id005
+description: Accepts IPN requests, validates them and passes them on to a defined listener.
+email: 
 - pat@freelancing-gods.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - HISTORY
 - LICENCE
 - README.textile
 - Rakefile
-- app/controllers/pippin/ipns_controller.rb
 - config.ru
 - config/routes.rb
 - lib/pippin.rb
+- lib/pippin/app.rb
 - lib/pippin/engine.rb
 - lib/pippin/ipn.rb
-- lib/pippin/version.rb
 - pippin.gemspec
-- spec/controllers/pippin/ipns_controller_spec.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
 - spec/pippin/ipn_spec.rb
 - spec/requests/ipn_submission_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: pippin
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: A PayPal Rails Engine that handles IPNs
-test_files:
-- spec/controllers/pippin/ipns_controller_spec.rb
+test_files: 
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
 - spec/pippin/ipn_spec.rb

data/app/controllers/pippin/ipns_controller.rb

@@ -1,16 +0,0 @@
-class Pippin::IpnsController < ActionController::Base
-  def create
-    if ipn.valid?
-      Pippin.listener.call ipn if Pippin.listener
-      head :ok
-    else
-      head :bad_request
-    end
-  end
-
-  private
-
-  def ipn
-    @ipn ||= Pippin::IPN.new params, request.body.read
-  end
-end

data/lib/pippin/version.rb

@@ -1,3 +0,0 @@
-module Pippin
-  VERSION = '0.1.1'
-end

data/spec/controllers/pippin/ipns_controller_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-describe Pippin::IpnsController do
-  describe '#create' do
-    let(:ipn)   { double('IPN') }
-    let(:block) { double('block', :call => true) }
-
-    before :each do
-      Pippin::IPN.stub :new => ipn
-      Pippin.stub :listener => block
-    end
-
-    context 'valid IPN' do
-      before :each do
-        ipn.stub :valid? => true
-      end
-
-      it "responds with 200" do
-        post :create
-
-        response.status.should == 200
-      end
-
-      it "calls the listener with the IPN object" do
-        block.should_receive(:call).with(ipn)
-
-        post :create
-      end
-    end
-
-    context 'invalid IPN' do
-      before :each do
-        ipn.stub :valid? => false
-      end
-
-      it "responds with a 400" do
-        post :create
-
-        response.status.should == 400
-      end
-
-      it "does not call the listener" do
-        block.should_not_receive(:call)
-
-        post :create
-      end
-    end
-  end
-end