straides 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,37 @@
+# Straides
+
+Better HTTP STatus coDES for RAIls!
+
+Straides provides a convenient and more consistent way for handling error conditions
+in controllers.
+
+Straides makes it possible, for example, to abort execution of a request in a before_filter.
+
+
+# Usage
+
+    # Stop controller execution and return the request with the given HTTP error.
+    error 404 unless [condition]
+
+    # Shorter version, integrated into loading for example a user object.
+    user = User.find_by_username(params[:id]) or error 401
+
+
+## Customizing the response
+
+Straides returns reasonable default responses dependent on the request format.
+
+* If the request returns HTML, it renders `public/[error code].html`, similar to what Rails does.
+* If the request returns JSON, it leaves the response body empty by default.
+
+These behaviors can be overridden by providing the call to `error` with the same parameters
+as you would give to [render](http://apidock.com/rails/ActionController/Base/render) in Rails.
+
+    # Provide a custom error message in the response body.
+    error 401, :text => 'Please log in first.'
+
+    # Render a different file in the response body.
+    error 404, :file => 'public/custom_404.html'
+
+    # Render a custom JSON response.
+    error 401, :json => { :code => 401, :message => 'Please log in first.' }

data/Rakefile

@@ -11,6 +11,7 @@ rescue LoadError
   require 'rake/rdoctask'
   RDoc::Task = Rake::RDocTask
 end
+
 require 'rspec/core/rake_task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
@@ -38,4 +39,3 @@ end
 
 desc "Run the unit tests"
 task :spec => ['spec:unit']
-

data/lib/straides/return_http_code_error.rb

@@ -0,0 +1,21 @@
+module Straides
+
+  # A custom exception for bubbling up HTTP errors and showing the corresponding error pages.
+  class ReturnHttpCodeError < RuntimeError
+    attr_accessor :render_options
+
+    # @constructor
+    #
+    # @param [ Hash ] render_options
+    def initialize(render_options = {})
+      @render_options = render_options
+    end
+
+    # Checks if error options contain any templates assigned to it.
+    #
+    # @return [ true, false ]
+    def has_template?
+      (render_options.keys & [:file, :text, :json, :nothing]).any?
+    end
+  end
+end

data/lib/straides/version.rb

@@ -1,3 +1,3 @@
 module Straides
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/straides.rb

@@ -1,37 +1,37 @@
-require 'return_http_code_error'
-require 'active_record'
+require 'straides/return_http_code_error'
+require 'straides/version'
+require 'active_support/concern'
 
-class ApplicationController < ActionController::Base
-  
-  rescue_from(ReturnHttpCodeError) { |error| show_error(error) }
+module Straides
+  extend ActiveSupport::Concern
 
-  
-  protected
+  included do
+    rescue_from ReturnHttpCodeError, :with => :show_error
 
-  # Makes the current action abort and return an HTTP error.
-  def error status, render_options = {}
-    render_options[:status] = status
-    raise ReturnHttpCodeError, render_options
-  end
+    protected
 
+    # Makes the current action abort and return an HTTP error.
+    #
+    # @param [ Integer ] status
+    # @param [ Hash ] render_options
+    def error(status, render_options = {})
+      render_options[:status] = status
+      raise ReturnHttpCodeError, render_options
+    end
 
-  private
-  
-  # Outputs the given error to the client.
-  def show_error error
-    respond_to do |format|
-      format.html do
-        if (error.render_options.keys & [:file, :text, :json, :nothing]).empty?
-          error.render_options[:file] = "public/#{error.render_options[:status]}.html"
-        end
-        render error.render_options
-      end
-      format.json do
-        if (error.render_options.keys & [:file, :text, :json, :nothing]).empty?
-          error.render_options[:text] = ''
+    # Outputs the given error to the client.
+    #
+    # @param [ Straides::ReturnHttpCodeError ] error
+    def show_error(error)
+      unless error.has_template?
+        if request.send(:format).html?
+          error.render_options[:file] = "public/#{error.render_options[:status] || 'error'}"
+          error.render_options[:formats] = [:html]
+        else
+          error.render_options[:nothing] = true
         end
-        render error.render_options
       end
+      render error.render_options
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: straides
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000Z
+date: 2012-02-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70245816341000 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70126776392840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70245816341000
+  version_requirements: *70126776392840
 - !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70245816340580 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70126776390900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245816340580
+  version_requirements: *70126776390900
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: &70245816340160 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70126776389120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70245816340160
+  version_requirements: *70126776389120
 description: A more convenient way to return different HTTP status codes from Rails.
 email:
 - kevin.goslar@gmail.com
@@ -51,13 +51,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/return_http_code_error.rb
+- lib/straides/return_http_code_error.rb
 - lib/straides/version.rb
 - lib/straides.rb
-- lib/tasks/straides_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 homepage: http://github.com/kevgo/straides
 licenses: []
 post_install_message: 
@@ -78,9 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: HTTP Status codes for Rails
+summary: HTTP STatus coDES for RAIls
 test_files: []
-has_rdoc: 

data/README.rdoc

@@ -1,3 +0,0 @@
-= Straides
-
-This project rocks and uses MIT-LICENSE.

data/lib/return_http_code_error.rb

@@ -1,8 +0,0 @@
-# A custom exception for bubbling up HTTP errors and showing the correspending error pages.
-class ReturnHttpCodeError < RuntimeError
-  attr_accessor :render_options
-
-  def initialize render_options
-    @render_options = render_options
-  end
-end

data/lib/tasks/straides_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :straides do
-#   # Task goes here
-# end