exceptionally 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 021bc161718c3f6759f35966d9d833adfcd9b700
-  data.tar.gz: c77c028c2e5aefaa9d424910b1898e141b350f63
+  metadata.gz: f5d52c4f55cb4c33ac54fd123000ad5ba8fe3f83
+  data.tar.gz: e97c1136715699b0e89a3dcc3308117f7e07c4e3
 SHA512:
-  metadata.gz: ab99856b766aecb5504bdbbb8fb033f868a40bfca10f751ea3f1d2f420206b68bf92b5bbe1b8a5538c41765f870cdc758d40d34748420e8cbeab42a83eddec31
-  data.tar.gz: d75cc2385e01a7280fa3602063c92101d174ea375d399df523f41f4394c72cfed30f6168257b0b0f3971ec439d9fee9b9195665c4ae5e7839b5745b9ce44dd5c
+  metadata.gz: 6652982d9c887a4c70599a3b61f08623f06b63badc1e5517f5f6d5463f9bb2a3b7e260a0f5cadc4fcc1e16e3df3248a71c9ea9ee1043c35c726a8221fae90f06
+  data.tar.gz: be9a538d861e564f7358b3c86d728e9e37ee18f4a4c0dc3af2b82e8bddf40f04aaed57d62c8e2c6ee218d7f566699cc7e463bf63c587b504d87a1dc609bf994c

data/README.md

@@ -2,6 +2,8 @@
 
 [https://www.github.com/neilgupta/exceptionally](https://www.github.com/neilgupta/exceptionally)
 
+[![Gem Version](https://badge.fury.io/rb/exceptionally.png)](http://badge.fury.io/rb/exceptionally)
+
 Exceptionally abstracts your exception logic to make raising and returning meaningful errors in Ruby on Rails easier. It is primarily designed for API-only applications that need to return descriptive JSON error messages, rather than static HTML error pages.
 
 Just raise the appropriate exception anywhere in your code and Exceptionally will handle the rest.
@@ -34,21 +36,27 @@ In addition to seamlessly abstracting your exception logic and returning clean J
 
 ### Logging
 
-If you raise a 500-level error, Exceptionally will log the error, stacktrace, and relevant parameters to Rails.logger. Additionally, Exceptionally supports [Airbrake](http://airbrake.io) and [New Relic](http://newrelic.com) by default, and will notify those services if you have their gems set up.
+If you raise a 500-level error, Exceptionally will log the error, backtrace, and relevant parameters to Rails.logger. Additionally, Exceptionally supports [Airbrake](http://airbrake.io) and [New Relic](http://newrelic.com) by default, and will notify those services if you have their gems set up.
 
 ### Customizable
 
 #### Add a custom error handler
 
-Need to run your own logging code or do something else with the errors before they're returned to the user? Just add the following to `config/initializers/exceptionally.rb`:
+Need to add more logging, use [BacktraceCleaner](http://api.rubyonrails.org/classes/ActiveSupport/BacktraceCleaner.html), or do something else with the errors before they're returned to the user? Just add the following to `config/initializers/exceptionally.rb`:
 
 ```ruby
 Exceptionally::Handler.before_render do |message, status, error, params|
   # Place your custom code here
   # message is a string description of what went wrong
   # status is an integer of the HTTP status code
-  # error is a Ruby Exception object
+  # error is the Exception object
   # params is a hash of the parameters passed to your controller
+
+  # For example, you could:
+  bc = BacktraceCleaner.new
+  bc.add_filter   { |line| line.gsub(Rails.root, '') }
+  bc.add_silencer { |line| line =~ /mongrel|rubygems/ }
+  bc.clean(error.backtrace) # will strip the Rails.root prefix and skip any lines from mongrel or rubygems from your backtrace
 end
 ```
 
@@ -114,6 +122,7 @@ You can raise the following HTTP errors. All of them accept an optional string t
 * Exceptionally::UnsupportedMedia
 * Exceptionally::RangeNotSatisfiable
 * Exceptionally::ExpectationFailed
+* Exceptionally::UnprocessableEntity
 * Exceptionally::Error
 * Exceptionally::NotImplemented
 * Exceptionally::BadGateway
@@ -121,11 +130,11 @@ You can raise the following HTTP errors. All of them accept an optional string t
 * Exceptionally::GatewayTimeout
 * Exceptionally::HttpVersionNotSupported
 
-You can also raise an error with just the HTTP status code by using `Exceptionally::Http404`. Status codes 400-417 and 500-505 are available.
+You can also raise an error with just the HTTP status code by using `Exceptionally::Http404`. Status codes 400-417, 422, and 500-505 are available.
 
 **[See descriptions of all status codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)**
 
-## Why use Exceptionally instead of the built-in Rails `render`?
+## Why use Exceptionally?
 
 By abstracting all of the exception handling logic, Exceptionally DRY's up your code and makes it easier to read. If you later decide to change the format of your error responses, you just need to edit `render_error` in one place. Exceptionally also transparently handles ActiveRecord, Apipie, and other generic exceptions for you, so that your app is less likely to crash. Additionally, you get a bunch of logging and error reporting functionality for free.
 
@@ -135,4 +144,4 @@ Neil Gupta [http://metamorphium.com](http://metamorphium.com)
 
 ## License
 
-The MIT License (MIT) Copyright (c) 2014 Neil Gupta. See [MIT-LICENSE](https://raw.github.com/neilgupta/exceptionally/master/MIT-LICENSE)
+The MIT License (MIT) Copyright (c) 2014 Neil Gupta. See [MIT-LICENSE](https://raw.github.com/neilgupta/exceptionally/master/MIT-LICENSE)

data/lib/exceptionally/controller.rb

@@ -12,7 +12,7 @@ module Exceptionally
       rescue_from ActiveRecord::RecordInvalid, :with => :record_invalid_handler
       if defined?(Apipie)
         rescue_from Apipie::ParamMissing, :with => :missing_param
-        rescue_from Apipie::ParamInvalid, :with => :missing_param
+        rescue_from Apipie::ParamInvalid, :with => :invalid_param
       end
     end
 
@@ -35,6 +35,11 @@ module Exceptionally
     def record_invalid_handler(error)
       pass_to_error_handler(error, 409)
     end
+    
+    # Raise 422 error
+    def invalid_param(error)
+      pass_to_error_handler(error, 422)
+    end
 
     def pass_to_error_handler(error, status = nil)
       status ||= error.try(:status) || 500
@@ -47,4 +52,4 @@ module Exceptionally
     end
 
   end
-end
+end

data/lib/exceptionally/exceptions.rb

@@ -125,6 +125,12 @@ module Exceptionally
     end
   end
 
+  class UnprocessableEntity < Error
+    def initialize(message = nil)
+      super(message, 422, "Unprocessable Entity")
+    end
+  end
+
   class NotImplemented < Error
     def initialize(message = nil)
       super(message, 501, "Not Implemented")
@@ -173,10 +179,11 @@ module Exceptionally
   class Http415 < UnsupportedMedia; end
   class Http416 < RangeNotSatisfiable; end
   class Http417 < ExpectationFailed; end
+  class Http422 < UnprocessableEntity; end
   class Http500 < Error; end
   class Http501 < NotImplemented; end
   class Http502 < BadGateway; end
   class Http503 < ServiceUnavailable; end
   class Http504 < GatewayTimeout; end
   class Http505 < HttpVersionNotSupported; end
-end
+end

data/lib/exceptionally/handler.rb

@@ -17,9 +17,11 @@ module Exceptionally
     def log
       # Log 5xx errors
       if @status >= 500 && @error
-        # Support Airbrake and New Relic out of box
-        Airbrake.notify(@error, :parameters => @params) if defined?(Airbrake) && Airbrake.respond_to?(:notify) && Rails.env.production?
-        NewRelic::Agent.notice_error(@error) if defined?(NewRelic) && defined?(NewRelic::Agent) && NewRelic::Agent.respond_to?(:notice_error) && Rails.env.production?
+        # Support Airbrake and New Relic out of box, but only in production
+        if Rails.env.production?
+          Airbrake.notify(@error, :parameters => @params) if defined?(Airbrake) && Airbrake.respond_to?(:notify)
+          NewRelic::Agent.notice_error(@error) if defined?(NewRelic) && defined?(NewRelic::Agent) && NewRelic::Agent.respond_to?(:notice_error)
+        end
 
         Rails.logger.error(@error.to_s)
         Rails.logger.error("Parameters: #{@params.to_s}") unless @params.blank?
@@ -27,4 +29,4 @@ module Exceptionally
       end
     end
   end  
-end
+end

data/lib/exceptionally/railtie.rb

@@ -6,4 +6,4 @@ module Exceptionally
       end
     end
   end
-end
+end

data/lib/exceptionally/version.rb

@@ -1,3 +1,3 @@
 module Exceptionally
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exceptionally
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Neil Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Exceptionally simple Rails Exception library
@@ -138,3 +138,4 @@ test_files:
 - test/dummy/README.rdoc
 - test/exceptionally_test.rb
 - test/test_helper.rb
+has_rdoc: