wvanbergen-http_status_exceptions 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Willem van Bergen
+ 
+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.rdoc

@@ -0,0 +1,40 @@
+= HTTP status exception
+
+This simple plugin will register exception classes for all HTTP status. These exceptions can then be raised from your controllers, after
+which a response will be send back to the client with the desired HTTP status, possible with some other content.
+
+You can use this plugin to access control mechanisms. You can simply raise a HTTPStatus::Forbidden if a user is not allowed to
+perform a certain action. A nice looking error page will be the result. See the example below 
+
+== Installation
+
+Installation is simple. Simply add the gem in your <tt>environment.rb</tt>:
+  
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'wvanbergen-http_status_exceptions', :lib => 'http_status_exceptions', :source => 'http://gems.github.com'
+  end
+
+Run <tt>rake gems:install</tt> to install the gem if needed.
+
+== Usage
+
+  class BlogController < ApplicationController
+    
+    def destroy
+      raise HTTPStatus::Forbidden, 'You cannot delete blogs!' unless current_user.can_delete_blogs?
+      @blog.destroy
+    end
+  end
+
+By default, this will return an empty response with the "forbidden" status code (403). If you want to add content
+to the response as well, create the following view: <tt>shared/http_status/forbidden.html.erb</tt>. You can use the
+<tt>@exception</tt>-object in your view:
+
+  <h1>Forbidden</h1>
+  <p> <%= h(@exception.message) %> </p>
+  <hr />
+  <p>HTTP status code <small> <%= @exception.status_code %>: <%= @exception.status.to_s.humanize %></small></p>
+
+The response will only be sent if the request format is HTML because of the name of the view file. In theory you 
+could make a response for XML requests as well by using <tt>shared/http_status/forbidden.xml.builder</tt> as filename

data/init.rb

@@ -0,0 +1 @@
+require 'http_status_exceptions.rb'

data/lib/http_status_exceptions.rb

@@ -0,0 +1,43 @@
+module HTTPStatus
+  
+  class Base < Exception
+    attr_accessor :status
+    
+    cattr_reader :template_path
+    @@template_path = 'shared/http_status'
+    
+    def initialize(message)
+      @status = self.class.to_s.split("::").last.underscore.to_sym
+      super(message)
+    end
+    
+    def status_code
+      ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE[@status]
+    end
+    
+    def template
+      "#{@@template_path}/#{@status_code}"
+    end
+  end
+  
+  def self.included(base)
+    # create all the classed
+    ActionController::StatusCodes::STATUS_CODES.each do |code, name|
+      const_set("#{name.to_s.gsub(/[^A-z]/, '').camelize}", Class.new(HTTPStatus::Base))
+    end
+    
+    base.send(:rescue_from, HTTPStatus::Base, :with => :http_status_exception)
+  end
+
+  # The default handler for raised HTTP status exceptions
+  def http_status_exception(exception)
+    @exception = exception
+    begin
+      render(:template => exception.template, :status => exception.status)
+    rescue ActionView::MissingTemplate
+      head(exception.status)
+    end
+  end
+end
+
+ActionController::Base.send(:include, HTTPStatus)

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: wvanbergen-http_status_exceptions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Clean up your controller code by raising exceptions that generate responses with different HTTP status codes.
+email: 
+- willem@vanbergen.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.rdoc
+- init.rb
+- lib
+- lib/http_status_exceptions.rb
+has_rdoc: false
+homepage: http://github.com/wvanbergen/http_status_exceptions/wikis
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails plugin to use exceptions for generating HTTP status responses
+test_files: []
+