deferrable_actions 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 bhserna
+
+MIT License
+
+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.md

@@ -0,0 +1,102 @@
+# DeferrableActions
+
+A very simple way to defer a controller action, and execute it in
+another request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deferrable_actions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deferrable_actions
+
+## Usage
+
+Include the module 'DefferrableActions' in the controller that you want
+to defer actions, if you want, you can include the module in the
+ApplicationController and all your controllers are going to have the
+ability to defer actions.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include DeferrableActions
+  
+  # other stuff ...
+end
+```
+
+## Example
+
+The principal way that we use deferrable actions, is to defer actions
+that need to authenticate the user in the middle of a POST request,
+because we can't can redirect to a POST.
+
+We use it like this:
+
+```ruby
+class TripsController < ApplicationController
+  def create
+    @trip = Trip.new(params[:trip])
+
+    if @trip.save
+      defer! :publish_trip!, trip_id: @trip.id
+      redirect_to auth_path
+    else
+      render :new
+    end
+  end
+end
+
+class SessionsController < ApplicationController
+  def create
+    # something ....
+
+    if defered_action?
+      execute_defered_action!
+    else
+      redirect_to root_url
+    end
+  end
+
+  def failure
+    if defered_action?
+      on_failure_execute_defered_action!
+    else
+      redirect_to root_url
+    end
+  end
+
+  private
+
+  def publish_trip!(args)
+    trip = Trip.find(args[:trip_id])
+    trip.publish_by! current_user
+
+    redirect_to trip
+  end
+
+  def on_failure_publish_trip!(args)
+    redirect_to trip_failed_path(args[:trip_id])
+  end
+end
+```
+
+## People
+
+* Benito Serna @bhserna
+* Jorge Gajón @gajon
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/deferrable_actions.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/deferrable_actions/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Benito Serna", "Jorge Gajon"]
+  gem.email         = ["bhserna@gmail.com"]
+  gem.description   = %q{A very simple way to defer a controller action, and execute it in another request.}
+  gem.summary       = %q{Defer a controller action, and execute it later}
+  gem.homepage      = "http://github.com/bhserna/deferrable_actions"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "deferrable_actions"
+  gem.require_paths = ["lib"]
+  gem.version       = DeferrableActions::VERSION
+
+  gem.add_development_dependency "rspec"
+end

data/lib/deferrable_actions/version.rb

@@ -0,0 +1,3 @@
+module DeferrableActions
+  VERSION = "0.0.1"
+end

data/lib/deferrable_actions.rb

@@ -0,0 +1,47 @@
+require "deferrable_actions/version"
+
+module DeferrableActions
+  def defer!(method, args)
+    Action.store(session, method, args)
+  end
+
+  def defered_action?
+    Action.exists?(session)
+  end
+
+  def execute_defered_action!
+    Action.new(self).execute! if defered_action?
+  end
+
+  def on_failure_execute_defered_action!
+    Action.new(self).on_failure_execute! if defered_action?
+  end
+
+  class Action
+    attr_reader :controller, :action
+
+    def self.store(session, method, args)
+      session[:defered_action] = {
+        method: method,
+        args: args
+      }
+    end
+
+    def self.exists?(session)
+      !!session[:defered_action]
+    end
+
+    def initialize(controller)
+      @controller = controller
+      @action = controller.session.delete :defered_action
+    end
+
+    def execute!
+      controller.send(action[:method], action[:args])
+    end
+
+    def on_failure_execute!
+      controller.send("on_failure_#{action[:method]}", action[:args])
+    end
+  end
+end

data/spec/deferrable_actions_spec.rb

@@ -0,0 +1,93 @@
+require_relative '../lib/deferrable_actions'
+
+
+module DeferrableActions
+  class Controller
+    include DeferrableActions
+
+    def session
+      @session ||= {}
+    end
+  end
+end
+
+describe DeferrableActions do
+  let(:controller) { DeferrableActions::Controller.new }
+
+  describe '#defer!' do
+    it 'stores the action' do
+      DeferrableActions::Action.should_receive(:store).
+        with(controller.session, :my_action, arg_one: 'arg_one')
+      controller.defer!(:my_action, arg_one: 'arg_one')
+    end
+  end
+
+  describe '#defered_action?' do
+    it 'returns true if a defered action exists' do
+      controller.defer!(:my_action, arg_one: 'arg_one')
+
+      DeferrableActions::Action.should_receive(:exists?).with(controller.session)
+      controller.defered_action?
+    end
+  end
+
+  describe '#execute_defered_action!' do
+    it 'execute a defered action if the action exists' do
+      controller.defer!(:my_action, arg_one: 'arg_one')
+
+      controller.should_receive(:my_action).with arg_one: 'arg_one'
+      controller.execute_defered_action!
+    end
+  end
+
+  describe '#on_failure_execute_defered_action!' do
+    it 'execute a defered action if the action exists' do
+      controller.defer!(:my_action, arg_one: 'arg_one')
+
+      controller.should_receive(:on_failure_my_action).with arg_one: 'arg_one'
+      controller.on_failure_execute_defered_action!
+    end
+  end
+end
+
+module DeferrableActions
+  describe Action do
+    let(:controller) { Controller.new }
+
+    describe '.store' do
+      it 'stores a controller action, with its arguments' do
+        Action.store(controller.session, :my_action, arg_one: 'arg_one')
+
+        controller.session[:defered_action].should be_true
+        controller.session[:defered_action][:method].should eq :my_action
+        controller.session[:defered_action][:args][:arg_one].should eq 'arg_one'
+      end
+    end
+
+    describe '.exists?' do
+      it 'returns true if a defered action exists' do
+        Action.store(controller.session, :my_action, arg_one: 'arg_one')
+
+        Action.exists?(controller.session).should be_true
+      end
+    end
+
+    describe '#execute' do
+      it 'executes the deferred action' do
+        Action.store(controller.session, :my_action, arg_one: 'arg_one')
+
+        controller.should_receive(:my_action).with arg_one: 'arg_one'
+        Action.new(controller).execute!
+      end
+    end
+
+    describe '#on_failure_execute' do
+      it 'executes an action that has an "on_failure_" prefix to the deferred action' do
+        Action.store(controller.session, :my_action, arg_one: 'arg_one')
+
+        controller.should_receive(:on_failure_my_action).with arg_one: 'arg_one'
+        Action.new(controller).on_failure_execute!
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: deferrable_actions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Benito Serna
+- Jorge Gajon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A very simple way to defer a controller action, and execute it in another
+  request.
+email:
+- bhserna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- deferrable_actions.gemspec
+- lib/deferrable_actions.rb
+- lib/deferrable_actions/version.rb
+- spec/deferrable_actions_spec.rb
+homepage: http://github.com/bhserna/deferrable_actions
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Defer a controller action, and execute it later
+test_files:
+- spec/deferrable_actions_spec.rb
+has_rdoc: