show_json_exceptions 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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthew Savage
+
+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,54 @@
+# ShowJsonExceptions - For Rails, of course
+
+Rails catches exceptions within a ShowExceptions middleware and renders out a HTML error - in some cases you want an error be rendered as JSON for APIs consuming the app in question. This does just that.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'show_json_exceptions'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+There is nothing to do here, the railtie hooks in the middleware automatically. You can confirm the middleware has been loaded by running:
+
+	rake middleware
+
+When an error occurs in your application you will see a response similar to the following:
+
+    {
+    	"successful": false,
+    	"result": {},
+    	"error_messages": ["Exception: No route matches [GET] \"/poo/poo\"]
+    }
+
+If your application is running in development mode you will also see a backtrace in your error_messages array:
+
+	{
+    	"successful": false,
+    	"result": {},
+    	"error_messages": [
+    		"Exception: No route matches [GET] \"/poo/poo\",
+    		{
+    			"backtrace": [
+    			# ... Backtrace lines here as an array...
+    			]
+    		}
+    	]
+    }
+
+## No tests?
+
+Yes well, this is really a simple gem.. in fact you can just add the module and the config.middleware statements yourself, but I wanted to wrap this in a gem for reuse. If you really think it needs tests then bug me and I'll see what I can do...
+
+## 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/show_json_exceptions.rb

@@ -0,0 +1,34 @@
+require "show_json_exceptions/version"
+require 'show_json_exceptions/railtie' if defined?(Rails)
+
+require 'action_dispatch/http/request'
+
+module ShowJsonExceptions
+  class Middleware < ActionDispatch::ShowExceptions
+  def render_exception(env, exception)
+    log_error(exception)
+    exception = original_exception(exception)
+
+    request = ActionDispatch::Request.new(env)
+    exception_data = ["Exception: #{exception.message}"]
+
+    if @consider_all_requests_local || request.local?
+      exception_data << {backtrace: exception.backtrace}
+    end
+
+    render status_code(exception), {
+            successful: false,
+            result: {},
+            error_messages: exception_data
+    }.to_json
+  rescue Exception => failsafe_error
+    $stderr.puts "Error during failsafe response: #{failsafe_error}\n  #{failsafe_error.backtrace * "\n  "}"
+    FAILSAFE_RESPONSE
+  end
+
+  def render_json(status, body)
+    [status, {'Content-Type' => "application/json; charset=#{Response.default_charset}", 'Content-Length' => body.bytesize.to_s}, [body]]
+  end
+
+  end
+end

data/lib/show_json_exceptions/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails'
+
+module ShowJsonExceptions
+	class Railtie < Rails::Railtie
+		initializer "show_json_exceptions.config_middleware" do |app|
+			app.middleware.insert_after ActionDispatch::ShowExceptions, ShowJsonExceptions::Middleware
+			app.middleware.delete ActionDispatch::ShowExceptions
+		end
+	end
+end

data/lib/show_json_exceptions/version.rb

@@ -0,0 +1,3 @@
+module ShowJsonExceptions
+  VERSION = "0.0.1"
+end

data/show_json_exceptions.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/show_json_exceptions/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matthew Savage"]
+  gem.email         = ["matt@amasses.net"]
+  gem.description   = %q{Changes the default rails 'exception' behavior to render JSON instead of a HTML view (e.g. 404, 500 errors etc)}
+  gem.summary       = %q{Changes the default rails 'exception' behavior to render JSON instead of a HTML view (e.g. 404, 500 errors etc)}
+  gem.homepage      = "https://github.com/amasses/show_json_exceptions"
+
+  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          = "show_json_exceptions"
+  gem.require_paths = ["lib"]
+  gem.version       = ShowJsonExceptions::VERSION
+
+  gem.add_dependency "rails"
+  gem.add_dependency "multi_json"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: show_json_exceptions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Savage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70239099802860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70239099802860
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70239099802160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70239099802160
+description: Changes the default rails 'exception' behavior to render JSON instead
+  of a HTML view (e.g. 404, 500 errors etc)
+email:
+- matt@amasses.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/show_json_exceptions.rb
+- lib/show_json_exceptions/railtie.rb
+- lib/show_json_exceptions/version.rb
+- show_json_exceptions.gemspec
+homepage: https://github.com/amasses/show_json_exceptions
+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'
+      segments:
+      - 0
+      hash: 3302308707003729891
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3302308707003729891
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Changes the default rails 'exception' behavior to render JSON instead of
+  a HTML view (e.g. 404, 500 errors etc)
+test_files: []