fractious-http_status_exceptions 0.1.4.2

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,60 @@
+= 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 
+
+See the project wiki (http://github.com/wvanbergen/http_status_exceptions/wikis) for additional documentation.
+
+== 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.
+
+== Configuration
+
+You can modify where HTTP status exception looks for its template files like so:
+  
+  class ApplicationController < ActionController::Base
+    ...
+    HTTPStatus::Base.template_path = 'path_to/http_status_templates'
+  end
+  
+You can also modify which layout is used when rendering a template by setting the <tt>template_layout</tt>:
+
+  class ApplicationController < ActionController::Base
+    ...
+    HTTPStatus::Base.template_layout = 'exception'
+  end
+
+If you don't set a template_layout the current layout for the requested action will be used.
+
+== 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/Rakefile

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + "/tasks/*.rake"].each { |file| load(file) }
+ 
+#task :default => :spec

data/init.rb

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

data/lib/http_status_exceptions.rb

@@ -0,0 +1,55 @@
+module HTTPStatus
+  
+  class Base < StandardError
+
+    # The path from which the error documents are loaded.
+    cattr_accessor :template_path
+    @@template_path = 'shared/http_status'
+
+    # The layout in which the error documents are rendered
+    cattr_accessor :template_layout
+
+    attr_reader :status, :details
+    
+    # Creates the exception with a message and some optional other info.
+    def initialize(message = nil, details = nil)
+      @status = self.class.to_s.split("::").last.underscore.to_sym rescue :internal_server_error
+      @details = details
+      super(message)
+    end
+    
+    # The numeric status code corresponding to this exception
+    def status_code
+      ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE[@status]
+    end
+    
+    # The name of the template that should be used as error page for this exception
+    def template
+      "#{@@template_path}/#{@status}"
+    end
+  end
+
+  # Creates all the exception classes based on Rails's list of available status code and
+  # registers the exception handler using the rescue_from method.
+  def self.included(base)
+    ActionController::StatusCodes::STATUS_CODES.each do |code, name|
+      const_set(name.to_s.gsub(/[^A-Za-z]/, '').camelize, Class.new(HTTPStatus::Base)) if code >= 400
+    end
+    
+    base.send(:rescue_from, HTTPStatus::Base, :with => :http_status_exception)
+  end
+
+  # The default handler for raised HTTP status exceptions. 
+  # It will render a template if available, or respond with an empty response
+  # with the HTTP status correspodning to the exception.
+  def http_status_exception(exception)
+    @exception = exception
+    render_options = {:template => exception.template, :status => exception.status}
+    render_options[:layout] = exception.template_layout if exception.template_layout
+    render(render_options)
+  rescue ActionView::MissingTemplate
+    head(exception.status)
+  end
+end
+
+ActionController::Base.send(:include, HTTPStatus)

data/tasks/github-gem.rake

@@ -0,0 +1,250 @@
+require 'rubygems'
+require 'rubyforge'
+require 'rake'
+require 'rake/tasklib'
+require 'date'
+
+module Rake 
+  
+  class GithubGem < TaskLib
+    
+    attr_accessor :name
+    attr_accessor :specification
+   
+    def self.define_tasks!
+      gem_task_builder = Rake::GithubGem.new      
+      gem_task_builder.register_all_tasks!
+    end
+    
+
+    def initialize
+      reload_gemspec!
+    end
+
+    def register_all_tasks!
+      namespace(:gem) do
+        desc "Updates the file lists for this gem"
+        task(:manifest) { manifest_task }
+
+        desc "Releases a new version of #{@name}"
+        task(:build => [:manifest]) { build_task } 
+        
+        
+        release_dependencies = [:check_clean_master_branch, :version, :build, :create_tag]
+        release_dependencies.push 'doc:publish' if has_rdoc?
+        release_dependencies.unshift 'test' if has_tests?
+        release_dependencies.unshift 'spec' if has_specs?
+                
+        desc "Releases a new version of #{@name}"
+        task(:release => release_dependencies) { release_task } 
+        
+        # helper task for releasing
+        task(:check_clean_master_branch) { verify_clean_status('master') }
+        task(:check_version) { verify_version(ENV['VERSION'] || @specification.version) }
+        task(:version => [:check_version]) { set_gem_version! }
+        task(:create_tag) { create_version_tag! }
+      end
+      
+      # Register RDoc tasks
+      if has_rdoc?
+        require 'rake/rdoctask'
+        
+        namespace(:doc) do 
+          desc 'Generate documentation for request-log-analyzer'
+          Rake::RDocTask.new(:compile) do |rdoc|
+            rdoc.rdoc_dir = 'doc'
+            rdoc.title    = @name
+            rdoc.options += @specification.rdoc_options
+            rdoc.rdoc_files.include(@specification.extra_rdoc_files)
+            rdoc.rdoc_files.include('lib/**/*.rb')
+          end
+          
+          desc "Publish RDoc files for #{@name} to Github"
+          task(:publish => :compile) do
+            sh 'git checkout gh-pages'
+            sh 'git pull origin gh-pages'
+            sh 'cp -rf doc/* .'
+            sh "git commit -am \"Publishing newest RDoc documentation for #{@name}\""
+            sh "git push origin gh-pages"
+            sh "git checkout master"
+          end
+        end
+      end
+    
+      # Setup :spec task if RSpec files exist
+      if has_specs?
+        require 'spec/rake/spectask'
+
+        desc "Run all specs for #{@name}"
+        Spec::Rake::SpecTask.new(:spec) do |t|
+          t.spec_files = FileList['spec/**/*_spec.rb']
+        end
+      end
+      
+      # Setup :test task if unit test files exist
+      if has_tests?
+        require 'rake/testtask'
+
+        desc "Run all unit tests for #{@name}"
+        Rake::TestTask.new(:test) do |t|
+          t.pattern = 'test/**/*_test.rb'
+          t.verbose = true
+          t.libs << 'test'
+        end
+      end      
+    end
+    
+    protected 
+
+    def has_rdoc?
+      @specification.has_rdoc
+    end
+
+    def has_specs?
+      Dir['spec/**/*_spec.rb'].any?
+    end
+    
+    def has_tests?
+      Dir['test/**/*_test.rb'].any?
+    end
+
+    def reload_gemspec!
+      raise "No gemspec file found!" if gemspec_file.nil?      
+      spec = File.read(gemspec_file)
+      @specification = eval(spec)
+      @name = specification.name  
+    end
+
+    def run_command(command)
+      lines = []
+      IO.popen(command) { |f| lines = f.readlines }
+      return lines
+    end
+    
+    def git_modified?(file)
+      return !run_command('git status').detect { |line| Regexp.new(Regexp.quote(file)) =~ line }.nil?
+    end
+    
+    def git_commit_file(file, message, branch = nil)
+      verify_current_branch(branch) unless branch.nil?
+      if git_modified?(file)
+        sh "git add #{file}"
+        sh "git commit -m \"#{message}\""
+      else
+        raise "#{file} is not modified and cannot be committed!"
+      end
+    end
+    
+    def git_create_tag(tag_name, message)
+      sh "git tag -a \"#{tag_name}\" -m \"#{message}\""
+    end
+    
+    def git_push(remote = 'origin', branch = 'master', options = [])
+      verify_clean_status(branch)
+      options_str = options.map { |o| "--#{o}"}.join(' ')
+      sh "git push #{options_str} #{remote} #{branch}"
+    end
+    
+    def gemspec_version=(new_version)
+      spec = File.read(gemspec_file)
+      spec.gsub!(/^(\s*s\.version\s*=\s*)('|")(.+)('|")(\s*)$/) { "#{$1}'#{new_version}'#{$5}" }
+      spec.gsub!(/^(\s*s\.date\s*=\s*)('|")(.+)('|")(\s*)$/) { "#{$1}'#{Date.today.strftime('%Y-%m-%d')}'#{$5}" }    
+      File.open(gemspec_file, 'w') { |f| f << spec }
+      reload_gemspec!      
+    end
+    
+    def gemspec_date=(new_date)
+      spec = File.read(gemspec_file)
+      spec.gsub!(/^(\s*s\.date\s*=\s*)('|")(.+)('|")(\s*)$/) { "#{$1}'#{new_date.strftime('%Y-%m-%d')}'#{$5}" }    
+      File.open(gemspec_file, 'w') { |f| f << spec }
+      reload_gemspec!       
+    end
+    
+    def gemspec_file 
+      @gemspec_file ||= Dir['*.gemspec'].first
+    end
+    
+    def verify_current_branch(branch)
+      run_command('git branch').detect { |line| /^\* (.+)/ =~ line }
+      raise "You are currently not working in the master branch!" unless branch == $1
+    end
+    
+    def verify_clean_status(on_branch = nil)
+      sh "git fetch"
+      lines = run_command('git status')
+      raise "You don't have the most recent version available. Run git pull first." if /^\# Your branch is behind/ =~ lines[1]
+      raise "You are currently not working in the #{on_branch} branch!" unless on_branch.nil? || (/^\# On branch (.+)/ =~ lines.first && $1 == on_branch)
+      raise "Your master branch contains modifications!" unless /^nothing to commit \(working directory clean\)/ =~ lines.last
+    end
+    
+    def verify_version(new_version)
+      newest_version = run_command('git tag').map { |tag| tag.split(name + '-').last }.compact.map { |v| Gem::Version.new(v) }.max
+      raise "This version number (#{new_version}) is not higher than the highest tagged version (#{newest_version})" if !newest_version.nil? && newest_version >= Gem::Version.new(new_version.to_s)
+    end
+    
+    def set_gem_version!
+      # update gemspec file
+      self.gemspec_version = ENV['VERSION'] if Gem::Version.correct?(ENV['VERSION'])
+      self.gemspec_date    = Date.today
+    end
+
+    def manifest_task
+      verify_current_branch('master')
+      
+      list = Dir['**/*'].sort
+      list -= [gemspec_file]
+
+      if File.exist?('.gitignore')
+        File.read('.gitignore').each_line do |glob|
+          glob = glob.chomp.sub(/^\//, '')
+          list -= Dir[glob]
+          list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
+        end
+      end
+      
+      # update the spec file
+      spec = File.read(gemspec_file)
+      spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+        assignment = $1
+        bunch = $2 ? list.grep(/^(test.*_test\.rb|spec.*_spec.rb)$/) : list
+        '%s%%w(%s)' % [assignment, bunch.join(' ')]
+      end
+
+      File.open(gemspec_file, 'w') { |f| f << spec }
+      reload_gemspec!
+    end
+    
+    def build_task
+      sh "gem build #{gemspec_file}"
+      Dir.mkdir('pkg') unless File.exist?('pkg')
+      sh "mv #{name}-#{specification.version}.gem pkg/#{name}-#{specification.version}.gem" 
+    end
+    
+    def install_task
+      raise "#{name} .gem file not found" unless File.exist?("pkg/#{name}-#{specification.version}.gem")
+      sh "gem install pkg/#{name}-#{specification.version}.gem"
+    end
+    
+    def uninstall_task
+      raise "#{name} .gem file not found" unless File.exist?("pkg/#{name}-#{specification.version}.gem")
+      sh "gem uninstall #{name}"
+    end    
+    
+    def create_version_tag!
+      # commit the gemspec file
+      git_commit_file(gemspec_file, "Updated #{gemspec_file} for release of version #{@specification.version}") if git_modified?(gemspec_file)
+
+      # create tag and push changes
+      git_create_tag("#{@name}-#{@specification.version}", "Tagged version #{@specification.version}")
+      git_push('origin', 'master', [:tags])     
+    end
+    
+    def release_task
+      puts
+      puts '------------------------------------------------------------'
+      puts "Released #{@name} - version #{@specification.version}"
+    end
+  end
+end
+
+Rake::GithubGem.define_tasks!

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: fractious-http_status_exceptions
+version: !ruby/object:Gem::Version 
+  version: 0.1.4.2
+platform: ruby
+authors: 
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-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
+- Rakefile
+- init.rb
+- lib
+- lib/http_status_exceptions.rb
+- tasks
+- tasks/github-gem.rake
+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: []
+