rack-action 0.2.0 → 0.2.1

data/README.md

@@ -1,18 +1,6 @@
 # Rack::Action
 
-Rack action is a small, simple framework for generating Rack responses.  A basic rack action looks like this:
-
-    require 'rack/action'
-
-    class MyAction < Rack::Action
-      def respond
-        "Hello, World!"
-      end
-    end
-
-    run MyAction
-
-See the docs for Rack::Action for more details
+Rack::Action is a small, simple framework for generating [Rack][rack] responses.
 
 ## Installation
 
@@ -28,6 +16,113 @@ Or install it yourself as:
 
     $ gem install rack-action
 
+## Usage
+
+Rack::Action provides functionality to generate a Rack response. To use Rack::Action, you should subclass Rack::Action and provide your own implementation of `respond`.  The simplest Rack action is
+one that just returns a string from respond:
+
+``` ruby
+require 'rack/action'
+
+class MyAction < Rack::Action
+  def respond
+    "Hello, World!"
+  end
+end
+
+run MyAction
+```
+
+The class itself is a rack app, so the previous code example is a valid
+rackup file. Rack::Action is meant to be used with one action per
+page/endpoint in your application, so it is typically used in conjuction
+with something like [Rack::Router][rack-router], which would look something like this:
+
+``` ruby
+require 'rack/action'
+require 'rack/router'
+
+class FooAction < Rack::Action
+  def respond
+    "foo"
+  end
+end
+
+class BarAction < Rack::Action
+  def respond
+    "bar"
+  end
+end
+
+router = Rack::Router.new do
+  get "/foo" => FooAction
+  get "/bar" => BarAction
+end
+
+run router
+```
+
+Rack::Action makes an instance of [Rack::Request][rack-req] and [Rack::Response][rack-res] available
+which can be used to set headers, cookies, etc.
+
+``` ruby
+class ArticleAction < Rack::Action
+  def respond
+    article = Article.find(params["id"])
+    response['Content-Type'] = "text/xml"
+    article.to_xml
+  end
+end
+```
+
+You can use before filters to do things before respond is called:
+
+``` ruby
+class AccountAction < Rack::Action
+  before_filter :load_current_user
+
+  def load_current_user
+    @current_user = User.find(params["id"])
+  end
+
+  def respond
+    "Welcome Back, #{@current_user.name}"
+  end
+end
+```
+
+and you can of course share functionality across actions with inheritance:
+
+``` ruby
+class ApplicationAction < Rack::Action
+  before_filter :login_required
+
+  def login_required
+    redirect_to "/login" unless logged_in?
+  end
+end
+
+class PublicAction < ApplicationAction
+  skip_before_filter :login_required
+
+  def respond
+    "Hello"
+  end
+end
+
+class PrivateAction < ApplicationAction
+  def respond
+    "It's A Secret To Everybody."
+  end
+end
+```
+
+Before filters will execute in the order they are defined.  If a before
+filter writes to the response, subsequent filters will not be executed
+and the respond method will not be executed.  As long as no before filters
+write to the response, subsequent filters and the respond
+method will be called.
+
 ## Contributing
 
 1. Fork it
@@ -35,3 +130,8 @@ Or install it yourself as:
 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
+
+[rack]: http://rack.github.com/
+[rack-req]: http://rubydoc.info/gems/rack/Rack/Request
+[rack-res]: http://rubydoc.info/gems/rack/Rack/Response
+[rack-router]: https://github.com/pjb3/rack-router

data/lib/rack/action.rb

@@ -2,106 +2,11 @@ require 'time'
 require 'json'
 require 'rack'
 require 'rack/filters'
-require 'rack/version'
 
 module Rack
-  # Rack::Action provides functionality to generate a Rack response.
-  # To use Rack::Action, you should subclass Rack::Action and provide
-  # your own implementation of {#respond}.  The simplest Rack action is
-  # one that just returns a string from respond:
-  #
-  #     require 'rack/action'
-  #
-  #     class MyAction < Rack::Action
-  #       def respond
-  #         "Hello, World!"
-  #       end
-  #     end
-  #
-  #     run MyAction
-  #
-  # The class itself is a rack app, so the previous code example is a valid
-  # rackup file. Rack::Action is meant to be used with one action per
-  # page/endpoint in your application, so it is typically used in conjuction
-  # with something like Rack::Router, which would look something like this:
-  #
-  #     require 'rack/action'
-  #     require 'rack/router'
-  #
-  #     class FooAction < Rack::Action
-  #       def respond
-  #         "foo"
-  #       end
-  #     end
-  #
-  #     class BarAction < Rack::Action
-  #       def respond
-  #         "bar"
-  #       end
-  #     end
-  #
-  #     router = Rack::Router.new do
-  #       get "/foo" => FooAction
-  #       get "/bar" => BarAction
-  #     end
-  #
-  #     run router
-  #
-  # Rack::Action makes an instance of Rack::Request and Rack::Response available
-  # which can be used to set headers, cookies, etc.
-  #
-  #     class ArticleAction < Rack::Action
-  #       def respond
-  #         article = Article.find(params["id"])
-  #         response['Content-Type'] = "text/xml"
-  #         article.to_xml
-  #       end
-  #     end
-  #
-  # You can use before filters to do things before respond is called:
-  #
-  #     class AccountAction < Rack::Action
-  #       before_filter :load_current_user
-  #
-  #       def load_current_user
-  #         @current_user = User.find(params["id"])
-  #       end
-  #
-  #       def respond
-  #         "Welcome Back, #{@current_user.name}"
-  #       end
-  #     end
-  #
-  # and you can of course share functionality across actions with inheritance:
-  #
-  #     class ApplicationAction < Rack::Action
-  #       before_filter :login_required
-  #
-  #       def login_required
-  #         redirect_to "/login" unless logged_in?
-  #       end
-  #     end
-  #
-  #     class PublicAction < ApplicationAction
-  #       skip_before_filter :login_required
-  #
-  #       def respond
-  #         "Hello"
-  #       end
-  #     end
-  #
-  #     class PrivateAction < ApplicationAction
-  #       def respond
-  #         "It's A Secret To Everybody."
-  #       end
-  #     end
-  #
-  # Before filters will execute in the order they are defined.  If a before
-  # filter writes to the response, subsequent filters will not be executed
-  # and the respond method will not be executed.  As long as no before filters
-  # write to the response, execution of subsequent filters and the respond
-  # method will be called.
   class Action
+    VERSION = '0.2.1'
+
     extend Filters
 
     # @private

data/rack-action.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "rack-action"
   gem.require_paths = ["lib"]
-  gem.version       = "0.2.0"
+  gem.version       = "0.2.1"
 
   gem.add_runtime_dependency "rack"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-action
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -45,7 +45,6 @@ files:
 - lib/rack-action.rb
 - lib/rack/action.rb
 - lib/rack/filters.rb
-- lib/rack/version.rb
 - lib/rack_action.rb
 - rack-action.gemspec
 - test/rack/action_test.rb
@@ -77,3 +76,4 @@ summary: a small, simple framework for generating Rack responses
 test_files:
 - test/rack/action_test.rb
 - test/rack_test.rb
+has_rdoc: 

data/lib/rack/version.rb

@@ -1,5 +0,0 @@
-module Rack
-  class Action
-    VERSION = '0.2.0'
-  end
-end