pippin 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+gem 'combustion',
+  :git => 'git://github.com/freelancing-god/combustion.git',
+  :ref => 'd7a6836269a8fb528bc3721e9b8c06b5a62ef3cc'

data/HISTORY

@@ -0,0 +1,2 @@
+0.1.0 - January 4th 2012
+* First release

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Pat Allan
+
+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.

data/README.textile

@@ -0,0 +1,35 @@
+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.
+
+h2. Installation and Usage
+
+Just add it to your Gemfile:
+
+<pre><code>gem 'pippin', '~> 0.1'</code></pre>
+
+Then, in an initializer, add your listener:
+
+<pre><code># config/initializers/pippin.rb
+Pippin.listener = lambda { |ipn|
+  # use IPN data
+  ipn.params # => {'business' => 'email@domain.com', 'txn_type' => ...}
+}</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@.
+
+h2. Contributing
+
+Contributions are very much welcome - but keep in mind the following:
+
+* Keep patches in a separate branch.
+* Write tests for your patches.
+* Don't mess with the version or history file. I'll take care of that when the patch is merged in.
+
+h2. Credits
+
+Copyright (c) 2012, Pippin is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/pippin/ipns_controller.rb

@@ -0,0 +1,16 @@
+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/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :pippin do
+    resources :ipns, :only => [:create]
+  end
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller
+run Combustion::Application

data/lib/pippin/engine.rb

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

data/lib/pippin/ipn.rb

@@ -0,0 +1,43 @@
+require 'open-uri'
+
+class Pippin::IPN
+  attr_accessor :params, :body
+
+  def initialize(params = {}, body = '')
+    @params = parse_dates(params)
+    @body   = body
+  end
+
+  def valid?
+    open(paypal_uri).read == 'VERIFIED'
+  end
+
+  private
+
+  def parse_dates(params)
+    params.each do |key, value|
+      next if key.to_s[/_date$/].nil?
+
+      params[key] = parse_date value
+    end
+  end
+
+  def parse_date(string)
+    return nil if string.blank?
+
+    match = string.match(/(\d+):(\d+):(\d+) (\w{3}) (\d+), (\d{4}) (\w\w\w)/)
+    time = Time.zone.local match[6].to_i, match[4],      match[5].to_i,
+                           match[1].to_i, match[2].to_i, match[3].to_i
+
+    case match[7]
+    when /PDT/
+      time + 7.hours + Time.zone.utc_offset
+    when /PST/
+      time + 8.hours + Time.zone.utc_offset
+    end
+  end
+
+  def paypal_uri
+    "https://www.paypal.com/cgi-bin/webscr?cmd=_notify-validate&#{body}"
+  end
+end

data/lib/pippin/version.rb

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

data/lib/pippin.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module Pippin
+  def self.listener
+    @listener
+  end
+
+  def self.listener=(listener)
+    @listener = listener
+  end
+end
+
+require 'pippin/engine'
+require 'pippin/ipn'
+require 'pippin/version'

data/pippin.gemspec

@@ -0,0 +1,27 @@
+# -*- 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.authors     = ['Pat Allan']
+  s.email       = ['pat@freelancing-gods.com']
+  s.homepage    = ''
+  s.summary     = 'A PayPal Rails Engine that handles IPNs'
+  s.description = 'Accepts IPN requests, validates them and passes them on to a defined listener.'
+
+  s.rubyforge_project = 'pippin'
+
+  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.add_runtime_dependency 'rails', '3.1.3'
+
+  s.add_development_dependency 'fakeweb',         '1.3.0'
+  s.add_development_dependency 'fakeweb-matcher', '1.2.2'
+  s.add_development_dependency 'rspec-rails',     '2.7.0'
+  s.add_development_dependency 'sqlite3',         '1.3.5'
+end

data/spec/controllers/pippin/ipns_controller_spec.rb

@@ -0,0 +1,49 @@
+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

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/pippin/ipn_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Pippin::IPN do
+  describe '#params' do
+    it "should parse dates in params" do
+      ipn = Pippin::IPN.new :subscr_date => '20:36:25 Jan 02, 2012 PST'
+      ipn.params[:subscr_date].should == Time.zone.local(2012, 1, 3, 4, 36, 25)
+    end
+  end
+
+  describe '#valid?' do
+    let(:ipn)    { Pippin::IPN.new }
+
+    it "checks the validity with PayPal and the given request body" do
+      FakeWeb.register_uri :get, /^https:\/\/www\.paypal\.com\/cgi-bin\/webscr/,
+        :body => 'VERIFIED'
+
+      ipn = Pippin::IPN.new({}, 'foo=bar')
+      ipn.valid?
+
+      FakeWeb.should have_requested(:get,
+        'https://www.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'
+
+      ipn.should be_valid
+    end
+
+    it "returns false if PayPal revokes the validity of the data" do
+      FakeWeb.register_uri :get, /^https:\/\/www\.paypal\.com\/cgi-bin\/webscr/,
+        :body => 'INVALID'
+
+      ipn.should_not be_valid
+    end
+  end
+end

data/spec/requests/ipn_submission_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'IPN Submission' do
+  context 'valid IPN' do
+    before :each do
+      FakeWeb.register_uri :get, /^https:\/\/www\.paypal\.com\/cgi-bin\/webscr/,
+        :body => 'VERIFIED'
+    end
+
+    it "responds with a 200 status" do
+      post '/pippin/ipns'
+
+      response.status.should == 200
+    end
+
+    it "calls the provided listener" do
+      ipn_lodged = false
+      Pippin.listener = lambda { |ipn| ipn_lodged = true }
+
+      post '/pippin/ipns'
+
+      ipn_lodged.should be_true
+    end
+  end
+
+  context 'invalid IPN' do
+    before :each do
+      FakeWeb.register_uri :get, /^https:\/\/www\.paypal\.com\/cgi-bin\/webscr/,
+        :body => 'INVALID'
+    end
+
+    it "responds with a 400 status" do
+      post '/pippin/ipns'
+
+      response.status.should == 400
+    end
+
+    it "does not call the provided listener" do
+      ipn_lodged = false
+      Pippin.listener = lambda { |ipn| ipn_lodged = true }
+
+      post '/pippin/ipns'
+
+      ipn_lodged.should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller
+
+require 'rspec/rails'
+require 'fakeweb_matcher'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: pippin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+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: &70216495368700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70216495368700
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70216491700040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70216491700040
+- !ruby/object:Gem::Dependency
+  name: fakeweb-matcher
+  requirement: &70216491698460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70216491698460
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70216491697500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70216491697500
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70216491696780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70216491696780
+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:
+- .gitignore
+- Gemfile
+- HISTORY
+- LICENCE
+- README.textile
+- Rakefile
+- app/controllers/pippin/ipns_controller.rb
+- config.ru
+- config/routes.rb
+- lib/pippin.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: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: pippin
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A PayPal Rails Engine that handles IPNs
+test_files:
+- 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
+has_rdoc: