devise_paypal 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in devise_paypal.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 David Wilkie
+
+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.markdown

@@ -0,0 +1,125 @@
+# devise_paypal
+
+devise_paypal is [Devise](http://github.com/plataformatec/devise) extension that allows you to authenticate users using the the [Paypal Permissions API](https://www.x.com/community/ppx/permissions) or the [Paypal Authentication API](https://www.x.com/community/ppx/authentication) through Devise.
+
+## Installation
+
+Add devise_paypal to your Gemfile and make sure your using Devise from the git repository or at least version: "1.2.rc"
+
+    gem "devise", :git => "git://github.com/plataformatec/devise.git" # "1.2.rc"
+    gem "devise_paypal" #, :git => "git://github.com/dwilkie/devise_paypal.git" # for the latest and greatest
+
+Ensure your bundle is installed and run the generator
+    bundle
+    rails g devise_paypal:install
+
+As the generator instructs, you need to also add paypal-ipn to your gemfile then run its generator
+
+    gem 'paypal-ipn', :require => 'paypal' #, :git => "git://github.com/dwilkie/paypal.git" # for the latest and greatest
+
+    bundle
+    rails g paypal:initializer
+
+This will create a configuration file where you can put your paypal api credentials.
+
+Note: to enable the Paypal Permissions API you must file a ticket [here](https://www.paypal.com/mts). See this [page](https://www.x.com/community/ppx/permissions) for further details.
+
+## Usage
+
+### Model Configuration
+
+Using the `devise` method, add `:paypal_authable` and/or `:paypal_permissions_authable` to your model.
+
+    class User < ActiveRecord::Base
+      devise paypal_authable, :paypal_permissions_authable
+    end
+
+### Views
+
+If you have chosen a model named User and `devise_for :users` is already added to your config/routes.rb, devise_paypal will create the following url methods:
+
+    new_user_paypal_authable
+    new_user_paypal_permissions_authable
+
+Then you only need to add them to your layouts in order to provide Paypal authentication:
+
+    <%= link_to "Sign in with Paypal Authable", new_user_paypal_authable_path %>
+    <%= link_to "Sign in with Paypal Permissions Authable", new_user_paypal_permissions_authable_path %>
+
+By clicking on these links, the user will be redirected to Paypal. Then after entering their credentials, they'll be redirected back to your application.
+
+### Model Callback Method
+
+Implement a class method in your model called `find_for_paypal_auth` which accepts a single params hash argument. The params hash contains the information returned from Paypal in the following format:
+
+    :email => "johnny@example.com",
+    :first_name => "Johnny",
+    :last_name => "Walker",
+    :permissions => {
+      :mass_pay => true
+    }
+
+The method should return a single record which will be used to sign in the user. A simple implementation may look like this:
+
+    class User < ActiveRecord::Base
+      def self.find_for_paypal_auth(params)
+        if params
+          user = self.find_or_initialize_by_email(params[:email])
+          if user.new_record?
+            stubbed_password = Devise.friendly_token[0..password_length.max-1]
+            user.password = stubbed_password
+            user.password_confirmation = stubbed_password
+            user.save
+          end
+        else
+          user = self.new
+        end
+        user
+      end
+    end
+
+See [user.rb](https://github.com/dwilkie/devise_paypal/blob/master/test/rails_app/app/models/user.rb) in the [sample rails app](https://github.com/dwilkie/devise_paypal/tree/master/test/rails_app) for more details.
+
+### Overriding Defaults
+
+Say you want to request permission to access a Paypal API on behalf of a user. You can do this by overriding the devise_for call in your routes.rb file.
+
+    # routes.rb
+    devise_for :users, :controllers => {
+      :paypal_permissions_authable => "paypal_registrations"
+    }
+
+Then creating your own controller inheriting from: `Devise::PaypalPermisssionsAuthableController`
+
+    # app/controllers/paypal_registrations_controller.rb
+    class PaypalRegistrationsController < Devise::PaypalPermissionsAuthableController
+      def new
+        @permissions = {:mass_pay => true}
+        super
+      end
+    end
+
+In this case be sure to remember to modify the keys for your locale file:
+    # config/locales/devise_paypal.en.yml
+    en:
+      devise:
+        paypal_registrations:
+          success: "Successfully authorized from paypal account."
+
+By default, if a non-persisted record is returned by your model callback method, the user will be rendered the new registrations page from `devise :registrations`
+
+To change this behavior simply override `render_for_paypal` in your controller
+
+    # app/controllers/paypal_registrations_controller.rb
+    class PaypalRegistrationsController < Devise::PaypalPermissionsAuthableController
+      private
+
+      def render_for_paypal
+        render "welcome#index"
+      end
+    end
+
+For more details check out the [source](https://github.com/dwilkie/devise_paypal/tree/master/lib/devise_paypal/)
+
+Copyright (c) 2010 David Wilkie, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/devise/paypal_authable_controller.rb

@@ -0,0 +1,24 @@
+class Devise::PaypalAuthableController < ApplicationController
+  prepend_before_filter :require_no_authentication, :only => :new
+  include Devise::Controllers::InternalHelpers
+  include DevisePaypal::Controllers::InternalHelpers
+  include Paypal::Authentication
+
+  # GET /resource/paypal_authorize_without_permissions
+  def new
+    callback_url = paypal_authable_callback_uri
+    redirect_to authenticate_with_paypal_url(callback_url)
+  end
+
+  # GET /resource/paypal_authable/callback
+  def callback_action
+    paypal_user_details = get_auth_details(params[:token]) if params[:token]
+    handle_callback_action(paypal_user_details)
+  end
+
+  private
+    def paypal_authable_callback_uri #:nodoc:
+      paypal_authable_callback_url(resource_name)
+    end
+end
+

data/app/controllers/devise/paypal_permissions_authable_controller.rb

@@ -0,0 +1,25 @@
+class Devise::PaypalPermissionsAuthableController < ApplicationController
+  prepend_before_filter :require_no_authentication, :only => :new
+  include Devise::Controllers::InternalHelpers
+  include DevisePaypal::Controllers::InternalHelpers
+  include Paypal::Permissions
+
+  # GET /resource/paypal_authorize_with_permissions
+  def new
+    @permissions ||= {}
+    callback_url = paypal_permissions_authable_callback_uri
+    redirect_to set_paypal_permissions_url(callback_url, @permissions)
+  end
+
+  # GET /resource/paypal_permissions_authable/callback
+  def callback_action
+    paypal_user_details = get_paypal_permissions(params[:token]) if params[:token]
+    handle_callback_action(paypal_user_details)
+  end
+
+  private
+    def paypal_permissions_authable_callback_uri #:nodoc:
+      paypal_permissions_authable_callback_url(resource_name)
+    end
+end
+

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  devise:
+    paypal_permissions_authable:
+      success: "Successfully authorized from Paypal account."
+    paypal_authable:
+      success: "Successfully authorized from Paypal account."
+

data/devise_paypal.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devise_paypal/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devise_paypal"
+  s.version     = DevisePaypal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Wilkie"]
+  s.email       = ["dwilkie@gmail.com"]
+  s.homepage    = "http://github.com/dwilkie/devise_paypal"
+  s.summary     = %q{Signup or login using Paypal}
+  s.description = %q{Signup or login using Paypal's Authorization or Permissions api's}
+
+  s.rubyforge_project = "devise_paypal"
+  s.add_runtime_dependency "paypal-ipn", ">0.0.1"
+
+  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"]
+end
+

data/features/paypal_authable.feature

@@ -0,0 +1,30 @@
+@paypal_authentication_request
+Feature: Authenticate using Paypal Authable
+  In order to signup or login using by logging into paypal
+  As a user
+  I want to be able to authenticate using the Paypal authable api
+
+  Scenario: I authenticate with Paypal authable
+    When I go to the authenticate with paypal authable page
+
+    Then I should be redirected to sign in with paypal
+    And I should be requested to grant access to my name and email address
+
+  Scenario: I sign into paypal
+    Given I have a paypal account with email: "mara@example.com"
+    And I sign into paypal through paypal authable
+
+    When I am redirected back to the application from paypal after an authentication request
+
+    Then a user should exist with email: "mara@example.com"
+    And I should be on the home page
+    And I should see "Successfully authorized from Paypal account."
+
+  Scenario: I do not sign into paypal
+    Given I have a paypal account with email: "mara@example.com"
+    But I do not sign into paypal
+
+    When I am redirected back to the application from paypal after an authentication request
+
+    Then a user should not exist with email: "mara@example.com"
+

data/features/paypal_permissions_authable.feature

@@ -0,0 +1,40 @@
+@paypal_authentication_request
+Feature: Authenticate using Paypal Permissions Authable
+  In order to signup or login using Paypal and grant requested permissions
+  As a user
+  I want to be able to authenticate using the Paypal permissions api
+
+  Scenario: I authenticate with Paypal permissions authable
+    When I go to the authenticate with paypal permissions page
+
+    Then I should be redirected to sign in with paypal
+    And I should be requested to grant the required permissions
+
+  Scenario: I grant the required permissions
+    Given I have a paypal account with email: "mara@example.com"
+    And I sign into paypal through paypal permissions authable
+    And I grant the required permissions
+
+    When I am redirected back to the application from paypal after a permissions request
+
+    Then a user should exist with email: "mara@example.com"
+    And I should be on the home page
+    And I should see "Successfully authorized from Paypal account."
+
+  Scenario: I do not grant the required permissions
+    Given I have a paypal account with email: "mara@example.com"
+    And I sign into paypal through paypal permissions authable
+    But I do not grant the required permissions
+
+    When I am redirected back to the application from paypal after a permissions request
+
+    Then a user should not exist with email: "mara@example.com"
+
+  Scenario: I do not sign into paypal
+    Given I have a paypal account with email: "mara@example.com"
+    But I do not sign into paypal
+
+    When I am redirected back to the application from paypal after a permissions request
+
+    Then a user should not exist with email: "mara@example.com"
+

data/features/step_definitions/extended_web_steps.rb

@@ -0,0 +1,12 @@
+Then /^(?:|I )should be at "([^"]*)"$/ do |url|
+  current_uri = URI.parse(current_url)
+  current_uri.query = nil
+  current_uri.path = "" if current_uri.path == "/"
+  current_uri = current_uri.to_s
+  if current_uri.respond_to? :should
+    current_uri.should == url
+  else
+    assert_equal url, current_uri
+  end
+end
+

data/features/step_definitions/paypal_authable_steps.rb

@@ -0,0 +1,11 @@
+Given /^I sign into paypal through paypal authable$/ do
+  register_get_user_details_response
+end
+
+Then /^I should be requested to grant access to my name and email address$/ do
+  Then %{I should have the following query string:}, table(%{
+    | cmd  | _account-authenticate-login  |
+    | token | HA-DJW3X5Y99KRR4            |
+  })
+end
+

data/features/step_definitions/paypal_authentication_steps.rb

@@ -0,0 +1,25 @@
+Given /^I have a paypal account(?: with #{capture_fields})?$/ do |fields|
+  @paypal_user_details = parse_fields(fields)
+  parsed_paypal_user_details = {}
+  @paypal_user_details.each do |key, value|
+    parsed_paypal_user_details[key.classify.upcase] = value
+  end
+  @paypal_user_details = parsed_paypal_user_details
+end
+
+Given /^I do not sign into paypal$/ do
+  # this step is intentionally blank
+end
+
+When /^I am redirected back to the application from paypal after a permissions request$/ do
+  When "I go to the paypal permissions callback page"
+end
+
+When /^I am redirected back to the application from paypal after an authentication request$/ do
+  When "I go to the paypal authable callback page"
+end
+
+Then /^I should be redirected to sign in with paypal$/ do
+  Then %{I should be at "#{Paypal.uri}"}
+end
+

data/features/step_definitions/paypal_permissions_authable_steps.rb

@@ -0,0 +1,22 @@
+Given /^I sign into paypal through paypal permissions authable$/ do
+  # this step is intentionally blank
+end
+
+Given /^I grant the required permissions$/ do
+  register_get_user_details_response
+end
+
+Given /^I do not grant the required permissions$/ do
+  body = "TIMESTAMP=2010%2d10%2d08T11%3a35%3a41Z&CORRELATIONID=d41ee44136721&ACK=Failure&VERSION=2%2e3&BUILD=1545724&L_ERRORCODE0=11622&L_SHORTMESSAGE0=User%20Does%20Not%20Exist%2e&L_LONGMESSAGE0=User%20may%20not%20have%20logged%20in%20using%20this%20token%2e&L_SEVERITYCODE0=Error"
+  FakeWeb.register_uri(
+    :post, Paypal.nvp_uri, :body => body
+  )
+end
+
+Then /^I should be requested to grant the required permissions$/ do
+  Then %{I should have the following query string:}, table(%{
+    | cmd  | _access-permission-login  |
+    | token | HA-DJW3X5Y99KRR4         |
+  })
+end
+

data/features/step_definitions/pickle_steps.rb

@@ -0,0 +1,100 @@
+# this file generated by script/generate pickle
+
+# create a model
+Given(/^#{capture_model} exists?(?: with #{capture_fields})?$/) do |name, fields|
+  create_model(name, fields)
+end
+
+# create n models
+Given(/^(\d+) #{capture_plural_factory} exist(?: with #{capture_fields})?$/) do |count, plural_factory, fields|
+  count.to_i.times { create_model(plural_factory.singularize, fields) }
+end
+
+# create models from a table
+Given(/^the following #{capture_plural_factory} exists?:?$/) do |plural_factory, table|
+  create_models_from_table(plural_factory, table)
+end
+
+# find a model
+Then(/^#{capture_model} should exist(?: with #{capture_fields})?$/) do |name, fields|
+  find_model!(name, fields)
+end
+
+# not find a model
+Then(/^#{capture_model} should not exist(?: with #{capture_fields})?$/) do |name, fields|
+  find_model(name, fields).should be_nil
+end
+
+# find models with a table
+Then(/^the following #{capture_plural_factory} should exists?:?$/) do |plural_factory, table|
+  find_models_from_table(plural_factory, table).should_not be_any(&:nil?)
+end
+
+# find exactly n models
+Then(/^(\d+) #{capture_plural_factory} should exist(?: with #{capture_fields})?$/) do |count, plural_factory, fields|
+  find_models(plural_factory.singularize, fields).size.should == count.to_i
+end
+
+# assert equality of models
+Then(/^#{capture_model} should be #{capture_model}$/) do |a, b|
+  model!(a).should == model!(b)
+end
+
+# assert model is in another model's has_many assoc
+Then(/^#{capture_model} should be (?:in|one of|amongst) #{capture_model}(?:'s)? (\w+)$/) do |target, owner, association|
+  model!(owner).send(association).should include(model!(target))
+end
+
+# assert model is not in another model's has_many assoc
+Then(/^#{capture_model} should not be (?:in|one of|amongst) #{capture_model}(?:'s)? (\w+)$/) do |target, owner, association|
+  model!(owner).send(association).should_not include(model!(target))
+end
+
+# assert model is another model's has_one/belongs_to assoc
+Then(/^#{capture_model} should be #{capture_model}(?:'s)? (\w+)$/) do |target, owner, association|
+  model!(owner).send(association).should == model!(target)
+end
+
+# assert model is not another model's has_one/belongs_to assoc
+Then(/^#{capture_model} should not be #{capture_model}(?:'s)? (\w+)$/) do |target, owner, association|
+  model!(owner).send(association).should_not == model!(target)
+end
+
+# assert model.predicate? 
+Then(/^#{capture_model} should (?:be|have) (?:an? )?#{capture_predicate}$/) do |name, predicate|
+  if model!(name).respond_to?("has_#{predicate.gsub(' ', '_')}")
+    model!(name).should send("have_#{predicate.gsub(' ', '_')}")
+  else
+    model!(name).should send("be_#{predicate.gsub(' ', '_')}")
+  end
+end
+
+# assert not model.predicate?
+Then(/^#{capture_model} should not (?:be|have) (?:an? )?#{capture_predicate}$/) do |name, predicate|
+  if model!(name).respond_to?("has_#{predicate.gsub(' ', '_')}")
+    model!(name).should_not send("have_#{predicate.gsub(' ', '_')}")
+  else
+    model!(name).should_not send("be_#{predicate.gsub(' ', '_')}")
+  end
+end
+
+# model.attribute.should eql(value)
+# model.attribute.should_not eql(value)
+Then(/^#{capture_model}'s (\w+) (should(?: not)?) be #{capture_value}$/) do |name, attribute, expectation, expected|
+  actual_value  = model(name).send(attribute)
+  expectation   = expectation.gsub(' ', '_')
+  
+  case expected
+  when 'nil', 'true', 'false'
+    actual_value.send(expectation, send("be_#{expected}"))
+  when /^[+-]?[0-9_]+(\.\d+)?$/
+    actual_value.send(expectation, eql(expected.to_f))
+  else
+    actual_value.to_s.send(expectation, eql(eval(expected)))
+  end
+end
+
+# assert size of association
+Then /^#{capture_model} should have (\d+) (\w+)$/ do |name, size, association|
+  model!(name).send(association).size.should == size.to_i
+end