RubyGems - rackables - Versions diffs - 0.1.0 - Mend

rackables 0.1.0

Files changed (14) hide show

data/README +6 -0
data/Rakefile +22 -0
data/VERSION +1 -0
data/lib/rackables.rb +6 -0
data/lib/rackables/cache_control.rb +21 -0
data/lib/rackables/default_charset.rb +19 -0
data/lib/rackables/public_exception_page.rb +72 -0
data/lib/rackables/trailing_slash_redirect.rb +20 -0
data/test/fixtures/custom_500.html +1 -0
data/test/test_cache_control.rb +27 -0
data/test/test_default_charset.rb +27 -0
data/test/test_public_exception_page.rb +30 -0
data/test/test_trailing_slash_redirect.rb +39 -0
metadata +70 -0

data/README ADDED

@@ -0,0 +1,6 @@
+Bundles the following Rack middlewares:
+Rackables::CacheControl
+Rackables::DefaultCharset
+Rackables::PublicExceptionPage
+Rackables::TrailingSlashRedirect

data/Rakefile ADDED

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+task :default => :test
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "rackables"
+    gemspec.summary = "Bundle of useful Rack middleware"
+    gemspec.description = "Bundles Rack middleware: CacheControl, DefaultCharset, PublicExceptionPage, TrailingSlashRedirect"
+    gemspec.email = "gbuesing@gmail.com"
+    gemspec.homepage = "http://github.com/gbuesing/rackables"
+    gemspec.authors = ["Geoff Buesing"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 0.1.0

data/lib/rackables.rb ADDED

@@ -0,0 +1,6 @@
+module Rackables
+  autoload :CacheControl, 'rackables/cache_control'
+  autoload :DefaultCharset, 'rackables/default_charset'
+  autoload :PublicExceptionPage, 'rackables/public_exception_page'
+  autoload :TrailingSlashRedirect, 'rackables/trailing_slash_redirect'
+end

data/lib/rackables/cache_control.rb ADDED

@@ -0,0 +1,21 @@
+module Rackables
+  class CacheControl
+    # Works well with Varnish
+    # TODO: accomodate more options than just public, max-age=
+    def initialize(app, value, opts)
+      @app = app
+      @value = value
+      @opts = opts
+    end
+    def call(env)
+      status, headers, body = @app.call(env)
+      if headers['Cache-Control'].nil?
+        max_age = @opts[:max_age]
+        max_age = max_age.call if max_age.respond_to?(:call)
+        headers['Cache-Control'] = "#{@value}, max-age=#{max_age}"
+      end
+      [status, headers, body]
+    end
+  end
+end

data/lib/rackables/default_charset.rb ADDED

@@ -0,0 +1,19 @@
+module Rackables
+  class DefaultCharset
+    HAS_CHARSET = /charset=/
+    def initialize(app, value = 'utf-8')
+      @app = app
+      @value = value
+    end
+    def call(env)
+      status, headers, body = @app.call(env)
+      content_type = headers['Content-Type']
+      if content_type && content_type !~ HAS_CHARSET
+        headers['Content-Type'] = "#{content_type}; charset=#{@value}"
+      end
+      [status, headers, body]
+    end
+  end
+end

data/lib/rackables/public_exception_page.rb ADDED

@@ -0,0 +1,72 @@
+module Rackables
+  # Returns a user-friendly exception page
+  # Should be included at the very top of the middleware pipeline so that unhandled exceptions from anywhere down the pipeline are rescued
+  # In development, you'd want to use Rack::ShowExceptions instead of this (config.ru example):
+  #
+  #   if ENV['RACK_ENV'] == 'development'
+  #     use Rack::ShowExceptions
+  #   else
+  #     use Rackables::PublicExceptionPage
+  #   end
+  #
+  # The default HTML included here is a copy of the 500 page included with Rails
+  # You can optionally specify your own file, ex:
+  #
+  #   use Rackables::PublicExceptionPage, "public/500.html"
+  class PublicExceptionPage
+    def initialize(app, file_path = nil)
+      @app = app
+      @file_path = file_path
+    end
+    def call(env)
+      @app.call(env)
+    rescue ::Exception
+      [500, {'Content-Type' => 'text/html', 'Content-Length' => html.length.to_s}, [html]]
+    end
+    private
+      def html
+        @html ||= @file_path ? ::File.read(@file_path) : default_html
+      end
+      # Exception page from Rails (500.html)
+      def default_html
+        <<-EOV
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+               "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+          <title>We're sorry, but something went wrong (500)</title>
+        	<style type="text/css">
+        		body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+        		div.dialog {
+        			width: 25em;
+        			padding: 0 4em;
+        			margin: 4em auto 0 auto;
+        			border: 1px solid #ccc;
+        			border-right-color: #999;
+        			border-bottom-color: #999;
+        		}
+        		h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+        	</style>
+        </head>
+        <body>
+          <!-- This file lives in public/500.html -->
+          <div class="dialog">
+            <h1>We're sorry, but something went wrong.</h1>
+            <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+          </div>
+        </body>
+        </html>
+        EOV
+      end
+  end
+end

data/lib/rackables/trailing_slash_redirect.rb ADDED

@@ -0,0 +1,20 @@
+module Rackables
+  class TrailingSlashRedirect
+    HAS_TRAILING_SLASH = %r{^/(.*)/$}
+    def initialize(app)
+      @app = app
+    end
+    def call(env)
+      if env['PATH_INFO'] =~ HAS_TRAILING_SLASH
+        location = "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}/#{$1}"
+        location = "#{location}?#{env['QUERY_STRING']}" if env['QUERY_STRING'].to_s =~ /\S/
+        [301, {"Location" => location}, []]
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/test/fixtures/custom_500.html ADDED

	@@ -0,0 +1 @@
1	+ <h1>Custom 500 page</h1>

data/test/test_cache_control.rb ADDED

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'rackables'
+class TestCacheControl < Test::Unit::TestCase
+  def test_sets_cache_control
+    app = Proc.new { [200, {}, []]}
+    middleware = Rackables::CacheControl.new(app, :public, :max_age => 5)
+    status, headers, body = middleware.call({})
+    assert_equal 'public, max-age=5', headers['Cache-Control']
+  end
+  def test_sets_cache_control_with_value_specified_as_proc
+    app = Proc.new { [200, {}, []]}
+    middleware = Rackables::CacheControl.new(app, :public, :max_age => Proc.new {5})
+    status, headers, body = middleware.call({})
+    assert_equal 'public, max-age=5', headers['Cache-Control']
+  end
+  def test_respects_existing_cache_control_value
+    app = Proc.new { [200, {'Cache-Control' => 'private'}, []]}
+    middleware = Rackables::CacheControl.new(app, :public, :max_age => 5)
+    status, headers, body = middleware.call({})
+    assert_equal 'private', headers['Cache-Control']
+  end
+end

data/test/test_default_charset.rb ADDED

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'rackables'
+class TestDefaultCharset < Test::Unit::TestCase
+  def test_adds_utf8_charset_by_default
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, []]}
+    middleware = Rackables::DefaultCharset.new(app)
+    status, headers, body = middleware.call({})
+    assert_equal 'text/html; charset=utf-8', headers['Content-Type']
+  end
+  def test_adds_specified_charset
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, []]}
+    middleware = Rackables::DefaultCharset.new(app, 'us-ascii')
+    status, headers, body = middleware.call({})
+    assert_equal 'text/html; charset=us-ascii', headers['Content-Type']
+  end
+  def test_does_not_overwrite_existing_charset_value
+    app = Proc.new { [200, {'Content-Type' => 'text/html; charset=us-ascii'}, []]}
+    middleware = Rackables::DefaultCharset.new(app, 'iso-8859-2')
+    status, headers, body = middleware.call({})
+    assert_equal 'text/html; charset=us-ascii', headers['Content-Type']
+  end
+end

data/test/test_public_exception_page.rb ADDED

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'rackables'
+class TestPublicExceptionPage < Test::Unit::TestCase
+  def test_returns_downstream_app_response_when_no_exception_raised
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, ['Downstream app']]}
+    middleware = Rackables::PublicExceptionPage.new(app)
+    status, headers, body = middleware.call({})
+    assert_equal 200, status
+    assert_equal ['Downstream app'], body
+  end
+  def test_returns_500_with_default_exception_page_when_exception_raised_by_downstream_app
+    app = Proc.new { raise }
+    middleware = Rackables::PublicExceptionPage.new(app)
+    status, headers, body = middleware.call({})
+    assert_equal 500, status
+    assert_match /We\'re sorry, but something went wrong/, body[0]
+  end
+  def test_returns_500_with_custom_exception_page_when_file_path_specified
+    app = Proc.new { raise }
+    middleware = Rackables::PublicExceptionPage.new(app, 'test/fixtures/custom_500.html')
+    status, headers, body = middleware.call({})
+    assert_equal 500, status
+    assert_match /Custom 500 page/, body[0]
+  end
+end

data/test/test_trailing_slash_redirect.rb ADDED

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'rackables'
+class TestTrailingSlashRedirect < Test::Unit::TestCase
+  def test_passes_to_downstream_app_when_no_trailing_slash_on_path_info
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, ['Downstream app']]}
+    middleware = Rackables::TrailingSlashRedirect.new(app)
+    status, headers, body = middleware.call({'PATH_INFO' => '/foo'})
+    assert_equal 200, status
+    assert_equal ['Downstream app'], body
+    assert_nil headers['Location']
+  end
+  def test_returns_301_when_trailing_slash_on_path_info
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, ['Downstream app']]}
+    middleware = Rackables::TrailingSlashRedirect.new(app)
+    status, headers, body = middleware.call({'rack.url_scheme' => 'http', 'HTTP_HOST' => 'bar.com', 'PATH_INFO' => '/foo/'})
+    assert_equal 301, status
+    assert_equal 'http://bar.com/foo', headers['Location']
+  end
+  def test_301_respects_query_string
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, ['Downstream app']]}
+    middleware = Rackables::TrailingSlashRedirect.new(app)
+    status, headers, body = middleware.call({'rack.url_scheme' => 'http', 'HTTP_HOST' => 'bar.com', 'PATH_INFO' => '/foo/', 'QUERY_STRING' => 'baz=hi'})
+    assert_equal 301, status
+    assert_equal 'http://bar.com/foo?baz=hi', headers['Location']
+  end
+  def test_301_respects_https
+    app = Proc.new { [200, {'Content-Type' => 'text/html'}, ['Downstream app']]}
+    middleware = Rackables::TrailingSlashRedirect.new(app)
+    status, headers, body = middleware.call({'rack.url_scheme' => 'https', 'HTTP_HOST' => 'bar.com', 'PATH_INFO' => '/foo/', 'QUERY_STRING' => 'baz=hi'})
+    assert_equal 301, status
+    assert_equal 'https://bar.com/foo?baz=hi', headers['Location']
+  end
+end

metadata ADDED

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rackables
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Buesing
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-01-12 00:00:00 -06:00
+default_executable:
+dependencies: []
+description: "Bundles Rack middleware: CacheControl, DefaultCharset, PublicExceptionPage, TrailingSlashRedirect"
+email: gbuesing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- README
+- Rakefile
+- VERSION
+- lib/rackables.rb
+- lib/rackables/cache_control.rb
+- lib/rackables/default_charset.rb
+- lib/rackables/public_exception_page.rb
+- lib/rackables/trailing_slash_redirect.rb
+- test/fixtures/custom_500.html
+- test/test_cache_control.rb
+- test/test_default_charset.rb
+- test/test_public_exception_page.rb
+- test/test_trailing_slash_redirect.rb
+has_rdoc: true
+homepage: http://github.com/gbuesing/rackables
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: Bundle of useful Rack middleware
+test_files:
+- test/test_cache_control.rb
+- test/test_default_charset.rb
+- test/test_public_exception_page.rb
+- test/test_trailing_slash_redirect.rb