rack-action 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/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@rack-action --create

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul Barry
+
+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,37 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-action'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-action
+
+## 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,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/rack/*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/config.ru

@@ -0,0 +1,9 @@
+require 'rack-action'
+
+app = Class.new(Rack::Action) do
+  def respond
+    pretty_json env.except("rack.input", "rack.errors")
+  end
+end
+
+run app

data/lib/rack-action.rb

@@ -0,0 +1 @@
+require 'rack/action'

data/lib/rack/action.rb

@@ -0,0 +1,291 @@
+require 'time'
+require 'json'
+require 'rack'
+require 'rack/filters'
+
+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
+    extend Filters
+
+    # @private
+    RACK_ROUTE_PARAMS = 'route.route_params'.freeze
+    # @private
+    CONTENT_TYPE = 'Content-Type'.freeze
+    # @private
+    APPLICATION_JSON = 'application/json'.freeze
+    # @private
+    LOCATION = 'Location'.freeze
+    # @private
+    DEFAULT_RESPONSE = "Default Rack::Action Response"
+
+    # This implements the Rack interface
+    #
+    # @param [Hash] env The Rack environment
+    # @return [Rack::Response] A Rack response
+    def self.call(env)
+      new(env).call
+    end
+
+    attr_accessor :env, :request, :response, :params
+
+    def initialize(env)
+      @env = env
+    end
+
+    def request
+      @request ||= Rack::Request.new(env)
+    end
+
+    def response
+      @response ||= Rack::Response.new
+    end
+
+    def params
+      @params ||= request.params.merge(env[RACK_ROUTE_PARAMS] || {})
+    end
+
+    # This is the main method responsible for generating a Rack response.
+    # You typically won't need to override this method of call it directly.
+    # First this will run the before filters for this action.
+    # If none of the before filters generate a response, this will call
+    # {#respond} to generate a response.
+    # All after filters for this action are called once the response
+    # is genenated.  Finally the response is returned.
+    #
+    # @return [Array<Numeric, Hash, #each>] A Rack response
+    def call
+      run_before_filters
+      run_respond
+      run_after_filters
+      finish_response
+    end
+
+    # This is the main method that you should override in your action.
+    # You can either write to the response during this method, or simply
+    # return a string, which will be written to the response if the
+    # response is still empty after this is called.
+    #
+    # @return [String] The Rack response or a String
+    def respond
+      DEFAULT_RESPONSE
+    end
+
+    # This is a convenience method that sets the Content-Type headers
+    # and writes the JSON String to the response.
+    #
+    # @param [Hash] data The data
+    # @return [String] The JSON
+    def json(data)
+      response[CONTENT_TYPE] = APPLICATION_JSON
+      response.write JSON.generate(data)
+    end
+
+    # This is a convenience method that sets the Content-Type headers
+    # and writes the pretty-formatted JSON String to the response.
+    #
+    # @param [Hash] data The data
+    # @return [String] The JSON
+    def pretty_json(data)
+      response[CONTENT_TYPE] = APPLICATION_JSON
+      response.write JSON.pretty_generate(data)
+    end
+
+    # This is a convenience method that forms an absolute URL based on the
+    # url parameter, which can be a relative or absolute URL, and then
+    # sets the headers and the body appropriately to do a 302 redirect.
+    #
+    # @see #absolute_url
+    # @return [String] The absolute url
+    def redirect_to(url, options={})
+      full_url = absolute_url(url, options)
+      response[LOCATION] = full_url
+      response.status = 302
+      response.write ''
+      full_url
+    end
+
+    # Generate an absolute url from the url.  If the url is already
+    # an absolute url, this will return it unchanged.
+    #
+    # @param [String] url The URL
+    # @param [Hash] options The options to use to generate the absolute URL
+    # @option options [true, false] :https If https should be used,
+    #   uses rack.url_scheme from the Rack env to determine the default
+    # @option options [String] :host The host to use,
+    #   uses SERVER_NAME form the Rack env for the default
+    # @option options [String, Numeric] :port The port to use,
+    #   users SERVER_PORT from the Rack env for the default
+    # @return [String] The absolute url
+    def absolute_url(url, options={})
+      URL.new(env, url, options).to_absolute
+    end
+
+    protected
+    def run_before_filters
+      self.class.before_filters.each do |filter|
+        send(filter)
+        return unless response.empty?
+      end
+    end
+
+    def run_respond
+      return if !response.empty?
+      body = respond
+      if response.empty?
+        response.write body
+      else
+        body
+      end
+    end
+
+    def run_after_filters
+      self.class.after_filters.each do |filter|
+        send(filter)
+      end
+    end
+
+    def finish_response
+      response.finish
+    end
+
+    # @private
+    class URL
+      HTTPS = 'https'.freeze
+      HTTP_PREFIX = 'http://'.freeze
+      HTTPS_PREFIX = 'https://'.freeze
+      ABSOLUTE_URL_REGEX = /\Ahttps?:\/\//
+      RACK_URL_SCHEME = 'rack.url_scheme'
+      SERVER_NAME = 'SERVER_NAME'.freeze
+      SERVER_PORT = 'SERVER_PORT'.freeze
+      DEFAULT_HTTP_PORT = 80
+      DEFAULT_HTTPS_PORT = 443
+
+      attr_accessor :env, :url, :https, :host, :port
+
+      def initialize(env, url, options={})
+        @env = env
+        @url = url.to_s
+        @options = options || {}
+        @https = options.fetch(:https, env[RACK_URL_SCHEME] == HTTPS)
+        @host = options.fetch(:host, env[SERVER_NAME])
+        @port = Integer(options.fetch(:port, env[SERVER_PORT]))
+      end
+
+      def to_absolute
+        if url =~ ABSOLUTE_URL_REGEX
+          url
+        else
+          absolute_url = [prefix]
+          absolute_url << (port == default_port ? host : "#{host}:#{port}")
+          absolute_url << url
+          ::File.join(*absolute_url)
+        end
+      end
+
+      def prefix
+        https ? HTTPS_PREFIX : HTTP_PREFIX
+      end
+
+      def default_port
+        https ? DEFAULT_HTTPS_PORT : DEFAULT_HTTP_PORT
+      end
+    end
+
+  end
+end

data/lib/rack/filters.rb

@@ -0,0 +1,40 @@
+module Rack
+  module Filters
+    def before_filters
+      @before_filters ||= if superclass.respond_to?(:before_filters)
+        superclass.before_filters.dup
+      else
+        []
+      end
+    end
+
+    def before_filter(method)
+      unless before_filters.include?(method)
+        before_filters << method
+      end
+    end
+
+    def skip_before_filter(method)
+      before_filters.delete(method)
+    end
+
+    def after_filters
+      @after_filters ||= if superclass.respond_to?(:after_filters)
+        superclass.after_filters.dup
+      else
+        []
+      end
+    end
+
+    def after_filter(method)
+      unless after_filters.include?(method)
+        after_filters << method
+      end
+    end
+
+    def skip_after_filter(method)
+      after_filters.delete(method)
+    end
+  end
+end
+

data/lib/rack_action.rb

@@ -0,0 +1 @@
+require 'rack/action'

data/rack-action.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Barry"]
+  gem.email         = ["mail@paulbarry.com"]
+  gem.description   = %q{a small, simple framework for generating Rack responses}
+  gem.summary       = %q{a small, simple framework for generating Rack responses}
+  gem.homepage      = "http://github.com/pjb3/rack-action"
+
+  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          = "rack-action"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_runtime_dependency "rack"
+end

data/test/rack/action_test.rb

@@ -0,0 +1,192 @@
+require 'rack_action'
+require 'rack_test'
+
+class Rack::ActionTest < RackTest
+
+  def test_default_respond
+    app = Class.new(Rack::Action)
+
+    response = get app, "/"
+
+    assert_equal 200, response.status
+    assert_equal Rack::Action::DEFAULT_RESPONSE.length, response.length
+    assert_equal 'text/html', response["Content-Type"]
+    assert_equal [Rack::Action::DEFAULT_RESPONSE], response.body
+  end
+
+  def test_custom_respond
+    app = Class.new(Rack::Action) do
+      def respond
+        "bananas"
+      end
+    end
+
+    response = get app, "/"
+
+    assert_equal 200, response.status
+    assert_equal 7, response.length
+    assert_equal 'text/html', response["Content-Type"]
+    assert_equal ['bananas'], response.body
+  end
+
+  def test_json_respond
+    app = Class.new(Rack::Action) do
+      def respond
+        json :hello => "world"
+      end
+    end
+    expected = %{{"hello":"world"}}
+
+    response = get app, "/"
+
+    assert_equal 200, response.status
+    assert_equal expected.length, response.length
+    assert_equal 'application/json', response["Content-Type"]
+    assert_equal [expected], response.body
+  end
+
+  def test_pretty_json_respond
+    app = Class.new(Rack::Action) do
+      def respond
+        pretty_json :hello => "world"
+      end
+    end
+    expected = %{{
+  "hello": "world"
+}}
+
+    response = get app, "/"
+
+    assert_equal 200, response.status
+    assert_equal expected.length.to_s, response["Content-Length"]
+    assert_equal 'application/json', response["Content-Type"]
+    assert_equal [expected], response.body
+  end
+
+  def test_before_filter_set_instance_variable
+    app = Class.new(Rack::Action) do
+      def respond
+        @message
+      end
+
+      def set_message
+        @message = "Hello, World!"
+      end
+    end
+    app.before_filter :set_message
+
+    response = get app, "/"
+
+    assert_equal 200, response.status
+    assert_equal ["Hello, World!"], response.body
+  end
+
+  def test_before_filter_set_response
+    app = Class.new(Rack::Action) do
+      def respond
+        fail "respond should not be called if a before filter sets the response"
+      end
+
+      def set_response
+        response.write "test"
+      end
+    end
+    app.before_filter :set_response
+
+    response = get app, "/"
+
+    assert_equal 200, response.status
+    assert_equal ["test"], response.body
+  end
+
+  def test_redirect
+    app = Class.new(Rack::Action) do
+      def respond
+        fail "respond should not be called if a before filter sets the response"
+      end
+
+      def login_required
+        redirect_to "/login"
+      end
+    end
+    app.before_filter :login_required
+
+    response = get app, "/"
+
+    assert_equal 302, response.status
+    assert_equal "http://example.com/login", response["Location"]
+  end
+
+  def test_redirect_non_default_port
+    app = Class.new(Rack::Action) do
+      def respond
+        fail "respond should not be called if a before filter sets the response"
+      end
+
+      def login_required
+        redirect_to "/login"
+      end
+    end
+    app.before_filter :login_required
+
+    response = get app, "/", "SERVER_PORT" => "3000"
+
+    assert_equal 302, response.status
+    assert_equal "http://example.com:3000/login", response["Location"]
+  end
+
+  def test_redirect_non_default_port_option
+    app = Class.new(Rack::Action) do
+      def respond
+        fail "respond should not be called if a before filter sets the response"
+      end
+
+      def login_required
+        redirect_to "/login", :port => 3000
+      end
+    end
+    app.before_filter :login_required
+
+    response = get app, "/"
+
+    assert_equal 302, response.status
+    assert_equal "http://example.com:3000/login", response["Location"]
+  end
+
+  def test_secure_redirect
+    app = Class.new(Rack::Action) do
+      def respond
+        fail "respond should not be called if a before filter sets the response"
+      end
+
+      def login_required
+        redirect_to "/login"
+      end
+    end
+    app.before_filter :login_required
+
+    response = get app, "/", "SERVER_PORT" => "443", "rack.url_scheme" => "https"
+
+    assert_equal 302, response.status
+    assert_equal "https://example.com/login", response["Location"]
+  end
+
+  def test_redirect_absolute_url
+    app = Class.new(Rack::Action) do
+      def respond
+        fail "respond should not be called if a before filter sets the response"
+      end
+
+      def login_required
+        redirect_to "http://test.com/login"
+      end
+    end
+    app.before_filter :login_required
+
+    response = get app, "/"
+
+    assert_equal 302, response.status
+    assert_equal "http://test.com/login", response["Location"]
+  end
+
+end

data/test/rack_test.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'stringio'
+
+class RackTest < Test::Unit::TestCase
+
+  DEFAULT_HOST = "example.com".freeze
+  DEFAULT_PORT = 80
+
+  DEFAULT_ENV = {
+    "SCRIPT_NAME" => "",
+    "QUERY_STRING" => "",
+    "SERVER_NAME" => DEFAULT_HOST,
+    "SERVER_PORT" => DEFAULT_PORT.to_s,
+    "HTTP_HOST" => DEFAULT_HOST,
+    "HTTP_ACCEPT" => "*/*",
+    "rack.input" => StringIO.new,
+    "rack.url_scheme" => "http"
+  }.freeze
+
+  def default_env
+    DEFAULT_ENV
+  end
+
+  def request(app, method, path, env={})
+    resp = app.call(DEFAULT_ENV.merge({
+      "REQUEST_METHOD" => method.to_s.upcase,
+      "PATH_INFO" => path
+    }.merge(env)))
+    resp.is_a?(Rack::Response) ? resp : Rack::Response.new(resp[2], resp[0], resp[1])
+  end
+
+  def get(app, path, env={})
+    request(app, :get, path, env)
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rack-action
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Barry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a small, simple framework for generating Rack responses
+email:
+- mail@paulbarry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib/rack-action.rb
+- lib/rack/action.rb
+- lib/rack/filters.rb
+- lib/rack_action.rb
+- rack-action.gemspec
+- test/rack/action_test.rb
+- test/rack_test.rb
+homepage: http://github.com/pjb3/rack-action
+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.23
+signing_key: 
+specification_version: 3
+summary: a small, simple framework for generating Rack responses
+test_files:
+- test/rack/action_test.rb
+- test/rack_test.rb
+has_rdoc: