temescal 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d87fe04c5479ea7fc4081a5c20c1e00ecab56f7
-  data.tar.gz: 311bdc3696f87f883d63b77924f05a1d9c448518
+  metadata.gz: 703ee645d282ae0d060ee10a7c86f8e244abf307
+  data.tar.gz: 709b6344067afe53bd9bc0c0094c9931fb597d78
 SHA512:
-  metadata.gz: f478224b88e7cd8ca0bd5ecf9119c5593856c3c355a808953a0837ddd5f978c7a0e7529ec491306913e9365063095f2d3554f116c3cb3c099af31817606c7437
-  data.tar.gz: f713acaf1042b6864275125bfcdd01c2bb448a33119248b8ff9e548d978a5ce92f6e9e2a3bdc862b7b7e6f71c4ee81f0e3cb913dc4a97bac5e95c6820ca71475
+  metadata.gz: c7adcffdc5f34d2e77da605d45ad237cdd7ee61ac5d8d382247b204223306ba8b461b2ccd0995ad1b3b06f485a81b870a6135303100e60f9d005965a25578b0e
+  data.tar.gz: 5d7e7cbc05af0e2f2b2c81c12a6839e1c375dc59ff77742b8cf949a42963bef0cbbf8b0840f246c6634ec3bf168991e804601331e4254a74df336c19ecaab4b0

data/README.md

@@ -49,5 +49,7 @@ Temescal provides several configuration options for you. You can set these optio
 
 `default_message` to set an all-encompasing message to use in responses instead of the exception's message. Takes a string.
 
+`ignored_errors` to set which exception types you'd like to not be reported to a monitor or logged. Specified errors will still have error responses built, but they won't trigger any sort of logging. It takes the class names of the exceptions you'd like ignored.
+
 ## License
 Copyright 2013-2014 Todd Bealmear. See LICENSE for details.

data/lib/temescal.rb

@@ -1,5 +1,6 @@
 module Temescal
   require 'temescal/configuration'
+  require 'temescal/error'
   require 'temescal/middleware'
   require 'temescal/monitors'
   require 'temescal/response'

data/lib/temescal/configuration.rb

@@ -4,6 +4,9 @@ module Temescal
     # Public: Getter for monitors array.
     attr_reader :monitors
 
+    # Public: Getter for ignored errors array.
+    attr_reader :ignored_errors
+
     # Public: Setter for raise_errors option.
     attr_writer :raise_errors
 
@@ -15,6 +18,7 @@ module Temescal
     # Returns a new Configuration object.
     def initialize
       @monitors = []
+      @ignored_errors = []
     end
 
     # Public: Setter for monitors option.
@@ -42,6 +46,13 @@ module Temescal
       @raise_errors == true || ENV["RACK_ENV"] == "test"
     end
 
+    # Public: Setter for ignored_errors option.
+    #
+    # errors - Zero or more Exception classes.
+    def ignored_errors=(*errors)
+      @ignored_errors = errors.flatten
+    end
+
     private
 
     # Private: Converts a snake cased Symbol to a camel cased String.

data/lib/temescal/error.rb

@@ -0,0 +1,68 @@
+module Temescal
+  class Error
+    NOT_FOUND_ERRORS = ["ActiveRecord::RecordNotFound", "Sinatra::NotFound"]
+
+    # Public: Instantiates a new Error.
+    #
+    # exception - The raw exception being rescued.
+    #
+    # Returns a new Error.
+    def initialize(exception)
+      @exception = exception
+    end
+
+    # Public: Determines whether to use a default message (as specified in the
+    # configuration) or the exception's message for the API response.
+    #
+    # Returns a String that's either the default message or the exception's
+    # message.
+    def message
+      configuration.default_message || @exception.message
+    end
+
+    # Public: Determines the proper error code for the exception.
+    #
+    # Returns a Fixnum based on the exception's type and http_status
+    # attribute (if applicable), will return a generic 500 for all others.
+    def status
+      return 404 if NOT_FOUND_ERRORS.include? @exception.class.to_s
+      @exception.respond_to?(:http_status) ? @exception.http_status : 500
+    end
+
+    # Public: Formats the exception for logging.
+    #
+    # Returns a String containing the relevant exception information to log
+    # via STDERR.
+    def formatted
+      message = "\n#{@exception.class}: #{@exception.message}\n  "
+      message << @exception.backtrace.join("\n  ")
+      message << "\n\n"
+    end
+
+    # Public: Gets the exception's type.
+    #
+    # Returns a String representing the exception class name.
+    def type
+      @exception.class.to_s
+    end
+
+    # Public: Determines whether an exception should be silenced.
+    #
+    # Returns true if the error type is configured as an ignored error, false
+    # otherwise.
+    def ignore?
+      configuration.ignored_errors.each do |error|
+        return true if @exception.is_a? error
+      end
+
+      false
+    end
+
+    private
+
+    # Private: Getter for Temescal configuration.
+    def configuration
+      $_temescal_configuration
+    end
+  end
+end

data/lib/temescal/middleware.rb

@@ -1,7 +1,5 @@
 module Temescal
   class Middleware
-    NOT_FOUND_ERRORS = ["ActiveRecord::RecordNotFound", "Sinatra::NotFound"]
-
     # Public: Initializes the middleware.
     #
     # app   - The Rack application.
@@ -23,40 +21,28 @@ module Temescal
     def call(env)
       begin
         @status, @headers, @response = @app.call(env)
-      rescue => error
+      rescue => exception
         raise if configuration.raise_errors?
 
-        @error  = error
-        message = configuration.default_message || @error.message
+        error = Error.new(exception)
 
-        $stderr.print formatted_error
-        configuration.monitors.each { |monitor| monitor.report(@error) }
+        unless error.ignore?
+          $stderr.print error.formatted
+          configuration.monitors.each { |monitor| monitor.report(exception) }
+        end
 
-        @status   = set_status
-        @response = Response.build(@status, @error, message)
-        @headers  = { "Content-Type"   => "application/json" }
+        @status   = error.status
+        @response = Response.build(error)
+        @headers  = { "Content-Type" => "application/json" }
       end
       [@status, @headers, @response]
     end
 
     private
 
-    # Private: Getter for middleware configuration.
+    # Private: Getter for Temescal configuration.
     def configuration
-      @_configuration ||= Configuration.new
-    end
-
-    # Private: Formats the exception for logging.
-    def formatted_error
-      message = "\n#{@error.class}: #{@error.message}\n  "
-      message << @error.backtrace.join("\n  ")
-      message << "\n\n"
-    end
-
-    # Private: Returns the proper error code for the exception.
-    def set_status
-      return 404 if NOT_FOUND_ERRORS.include? @error.class.to_s
-      @error.respond_to?(:http_status) ? @error.http_status : 500
+      $_temescal_configuration ||= Configuration.new
     end
   end
 end

data/lib/temescal/response.rb

@@ -5,18 +5,16 @@ module Temescal
 
     # Public: Builds a response body for the Rack response.
     #
-    # status    - The HTTP status code of the response.
-    # exception - The caught exception.
-    # message   - The error message.
+    # error - The Temescal::Error object representing the caught exception.
     #
     # Returns an Array containing a JSON string as the response body.
-    def self.build(status, exception, message)
+    def self.build(error)
       [
         {
           meta: {
-            status:  status,
-            error:   exception.class.to_s,
-            message: message
+            status:  error.status,
+            error:   error.type,
+            message: error.message
           }
         }.to_json
       ]

data/lib/temescal/version.rb

@@ -1,3 +1,3 @@
 module Temescal
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/lib/temescal/error_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Temescal::Error do
+  let(:exception) { StandardError.new("Foobar") }
+  let(:error)     { Temescal::Error.new(exception) }
+
+  before do
+    # This is admittedly a little hacky, but it's the best way to prevent
+    # previously memoized configurations from polluting these tests.
+    $_temescal_configuration = Temescal::Configuration.new
+  end
+
+  context "#message" do
+    it "should return the configured default message if it is set in the configuration" do
+      Temescal::Configuration.any_instance.stub(:default_message).and_return("Some other message.")
+
+      expect(error.message).to eq "Some other message."
+    end
+
+    it "should return the exception's message if the default message is not configured" do
+      expect(error.message).to eq "Foobar"
+    end
+  end
+
+  context "#status" do
+    it "should return 404 if the exception is an ActiveRecord::RecordNotFound" do
+      exception = ActiveRecord::RecordNotFound.new
+      error     = Temescal::Error.new(exception)
+
+      expect(error.status).to eq 404
+    end
+
+    it "should return 404 if the exception is a Sinatra::NotFound" do
+      exception = Sinatra::NotFound.new
+      error     = Temescal::Error.new(exception)
+
+      expect(error.status).to eq 404
+    end
+
+    it "should return the exception's status code if assigned" do
+      exception.stub(:http_status).and_return(403)
+
+      expect(error.status).to eq 403
+    end
+
+    it "should return 500 for all other exceptions" do
+      expect(error.status).to eq 500
+    end
+  end
+
+  context "#formatted" do
+    it "should return a String formatted for log output" do
+      exception.stub(:backtrace).and_return(["Line 1", "Line 2"])
+
+      expect(error.formatted).to eq "\nStandardError: Foobar\n  Line 1\n  Line 2\n\n"
+    end
+  end
+
+  context "#type" do
+    it "should return the exception's class name" do
+      expect(error.type).to eq "StandardError"
+    end
+  end
+
+  context "#ignore?" do
+    before do
+      Temescal::Configuration.any_instance.stub(:ignored_errors).and_return([TypeError])
+    end
+
+    it "should return true if the exception type is configured as an ignored error" do
+      error = Temescal::Error.new(TypeError.new)
+      expect(error.ignore?).to be_true
+    end
+
+    it "should return false if the exception type is not an ignored error" do
+      expect(error.ignore?).to be_false
+    end
+  end
+end

data/spec/lib/temescal/middleware_spec.rb

@@ -1,9 +1,10 @@
 require "spec_helper"
 
-require "active_record"
-require "sinatra"
-
 describe Temescal::Middleware do
+  before do
+    $_temescal_configuration = nil
+  end
+
   context "Ok response" do
     let(:app) { ->(env) { [200, env, "app" ] } }
 
@@ -33,6 +34,7 @@ describe Temescal::Middleware do
     let(:middleware) do
       Temescal::Middleware.new(app) do |config|
         config.monitors = :new_relic
+        config.ignored_errors = TypeError
       end
     end
 
@@ -111,6 +113,27 @@ describe Temescal::Middleware do
         expect(code).to eq 404
       end
     end
+
+    context "with ignore_errors set" do
+      let(:middleware) do
+        Temescal::Middleware.new(app) do |config|
+          config.ignored_errors = StandardError, TypeError
+          config.monitors = :new_relic
+        end
+      end
+
+      it "should not log an ignored error type" do
+        expect($stderr).to_not receive(:print).with(an_instance_of String)
+
+        middleware.call env_for("http://foobar.com")
+      end
+
+      it "should not report an ignored error type" do
+        expect(Temescal::Monitors::NewRelic).to_not receive(:report).with(an_instance_of StandardError)
+
+        middleware.call env_for("http://foobar.com")
+      end
+    end
   end
 
   context "Override middleware to raise exception" do

data/spec/spec_helper.rb

@@ -1,20 +1,23 @@
-if ENV['CI']
-  require 'coveralls'
+if ENV["CI"]
+  require "coveralls"
   Coveralls.wear!
 else
-  require 'awesome_print'
-  require 'pry-debugger'
+  require "awesome_print"
+  require "pry-debugger"
 
-  require 'simplecov'
+  require "simplecov"
   SimpleCov.start
 end
 
-require 'rack'
+require "rack"
 
-require 'airbrake'
-require 'newrelic_rpm'
+require "airbrake"
+require "newrelic_rpm"
 
-require 'temescal'
+require "active_record"
+require "sinatra"
+
+require "temescal"
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -25,5 +28,5 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
+  config.order = "random"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: temescal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Todd Bealmear
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Rack Middleware for gracefully handling exceptions for JSON APIs.
@@ -48,17 +48,19 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/temescal.rb
+- temescal.gemspec
 - lib/temescal/configuration.rb
+- lib/temescal/error.rb
 - lib/temescal/middleware.rb
 - lib/temescal/monitors.rb
 - lib/temescal/response.rb
 - lib/temescal/version.rb
+- lib/temescal.rb
 - spec/lib/temescal/configuration_spec.rb
+- spec/lib/temescal/error_spec.rb
 - spec/lib/temescal/middleware_spec.rb
 - spec/lib/temescal/monitors_spec.rb
 - spec/spec_helper.rb
-- temescal.gemspec
 homepage: https://github.com/todd/temescal
 licenses:
 - MIT
@@ -69,17 +71,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Rack Middleware for gracefully handling exceptions for JSON APIs.