temescal 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f37264d3890ff553dbeeaa4da80089a858abc7b
-  data.tar.gz: 67e5f482b6fd8c757e881ca1aec281024462dcc1
+  metadata.gz: 99d0eb1cb114d96a76bdc45a6f31beb902d05028
+  data.tar.gz: 823a730b2904628aa8db967e31fed3d4630faad3
 SHA512:
-  metadata.gz: 1b5137c2c6bead9f87c8ef19b173f08658bf9ba0bd567c56bbd17d7f1255cadc241d5c4a02ae9bedf4be041267485564c498eed5326c3244ac888ce7b5c80b83
-  data.tar.gz: a24d94b23ae58d0765a0381105c8cd6036f12f800cee2aaf6a175d7c6bdf33cd619eb00599c7ca9d6964729aa984dc2a9c3d1ad4e153829f8dd2e091c22af18c
+  metadata.gz: 7b43e4795769e8de711b82ba6395d885eb01c8c653f4ad433b7dbbc42c118e55d2d00ae9dd0f96acf4638b05de2660ace17984a5fd90c03265058a75a7afc4df
+  data.tar.gz: 5afc871cd1ffa133dacae0eb0e32ae7b8d1b8b8b581a431e02019dee9330cb7a0d531f3aa8dda12efbc6ddb43552e9b8c16e6adfd3824b348beca0850d8984da

data/README.md

@@ -43,6 +43,7 @@ The services currently supported are:
 * [Airbrake](https://airbrake.io/)
 * [Bugsnag](https://bugsnag.com/)
 * [New Relic](http://newrelic.com/)
+* [Honeybadger](https://www.honeybadger.io/)
 
 If you use a different monitoring service that you'd like to see supported, feel free to submit an issue. Better yet, pull requests are more than welcome!
 
@@ -51,7 +52,7 @@ Note that you'll need the gem for your monitor installed and configured for your
 ## Configuration
 Temescal provides several configuration options for you. You can set these options when configuring the middleware for your application.
 
-`monitors` to set the monitors you'd like to use with Temescal. It takes symbols of monitor names (currently `:airbrake`, `:bugsnag`, and `:new_relic`).
+`monitors` to set the monitors you'd like to use with Temescal. It takes symbols of monitor names (currently `:airbrake`, `:bugsnag`, `:new_relic`, and `:honeybadger`).
 
 `raise_errors` to set whether you'd like to override Temescal and raise all errors without rendering a Temescal response. Set to `true` to enable.
 

data/lib/temescal/configuration.rb

@@ -10,6 +10,9 @@ module Temescal
     # Public: Setter for raise_errors option.
     attr_writer :raise_errors
 
+    # Public: Setter for meta_key option.
+    attr_writer :meta_key
+
     # Public: Getter/Setter for default JSON message.
     attr_accessor :default_message
 
@@ -53,6 +56,13 @@ module Temescal
       @ignored_errors = errors.flatten
     end
 
+    # Public: Getter for meta_key option.
+    #
+    # Returns the meta_key option or simply "meta" if null.
+    def meta_key
+      @meta_key || "meta"
+    end
+
     private
 
     # Private: Converts a snake cased Symbol to a camel cased String.

data/lib/temescal/error.rb

@@ -1,6 +1,6 @@
 module Temescal
   class Error
-    NOT_FOUND_ERRORS = ["ActiveRecord::RecordNotFound", "Sinatra::NotFound"]
+    NOT_FOUND_ERRORS = %w(ActiveRecord::RecordNotFound Sinatra::NotFound)
 
     # Public: Instantiates a new Error.
     #

data/lib/temescal/monitors.rb

@@ -41,5 +41,15 @@ module Temescal
         ::Bugsnag.notify exception
       end
     end
+
+    # Public: Reporting strategy for Honeybadger.
+    class Honeybadger < MonitorsStrategy
+      # Public: Reports an exception to Honeybadger.
+      #
+      # exception - The caught exception.
+      def self.report(exception)
+        ::Honeybadger.notify exception
+      end
+    end
   end
 end

data/lib/temescal/response.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Temescal
   module Response
@@ -11,7 +11,7 @@ module Temescal
     def self.build(error)
       [
         {
-          meta: {
+          $_temescal_configuration.meta_key => {
             status:  error.status,
             error:   error.type,
             message: error.message

data/lib/temescal/version.rb

@@ -1,3 +1,3 @@
 module Temescal
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/lib/temescal/configuration_spec.rb

@@ -7,8 +7,8 @@ class Temescal::Monitors::FooMonitor;  end
 describe Temescal::Configuration do
   let(:config) { Temescal::Configuration.new }
 
-  context "#monitors=" do
-    it "should add a list of valid monitor classes to the monitors array from snake-cased arguments" do
+  describe "#monitors=" do
+    it "adds a list of valid monitor classes to the monitors array from snake-cased arguments" do
       config.monitors = :monitor, :fake_monitor, :foo_monitor
 
       expect(config.monitors).to eq [
@@ -18,7 +18,7 @@ describe Temescal::Configuration do
                                     ]
     end
 
-    it "should raise an error if a monitor strategy is invalid" do
+    it "raises an error if a monitor strategy is invalid" do
       expect { config.monitors = :foo }.to raise_error(NameError, /Foo is not a valid monitoring strategy/)
     end
   end

data/spec/lib/temescal/error_spec.rb

@@ -10,70 +10,70 @@ describe Temescal::Error do
     $_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.")
+  describe "#message" do
+    it "returns the configured default message if it is set in the configuration" do
+      allow_any_instance_of(Temescal::Configuration).to receive(: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
+    it "returns 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
+  describe "#status" do
+    it "returns 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
+    it "returns 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)
+    it "returns the exception's status code if assigned" do
+      allow(exception).to receive(:http_status).and_return(403)
 
       expect(error.status).to eq 403
     end
 
-    it "should return 500 for all other exceptions" do
+    it "returns 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"])
+  describe "#formatted" do
+    it "returns a String formatted for log output" do
+      allow(exception).to receive(: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
+  describe "#type" do
+    it "returns the exception's class name" do
       expect(error.type).to eq "StandardError"
     end
   end
 
-  context "#ignore?" do
+  describe "#ignore?" do
     before do
-      Temescal::Configuration.any_instance.stub(:ignored_errors).and_return([TypeError])
+      allow_any_instance_of(Temescal::Configuration).to receive(:ignored_errors).and_return([TypeError])
     end
 
-    it "should return true if the exception type is configured as an ignored error" do
+    it "returns true if the exception type is configured as an ignored error" do
       error = Temescal::Error.new(TypeError.new)
-      expect(error.ignore?).to be_true
+      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
+    it "returns 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

@@ -12,7 +12,7 @@ describe Temescal::Middleware do
       Temescal::Middleware.new(app)
     end
 
-    it "should render the application's response" do
+    it "renders the application's response" do
       code, _, _ = middleware.call env_for('http://foobar.com')
 
       expect(code).to eq 200
@@ -21,8 +21,8 @@ describe Temescal::Middleware do
 
   context "Bad response" do
     before do
-      Temescal::Monitors::NewRelic.stub(:report)
-      $stderr.stub(:print)
+      allow(Temescal::Monitors::NewRelic).to receive(:report)
+      allow($stderr).to receive(:print)
 
       # Travis automatically sets RACK_ENV=test
       # Need to override for tests to run correctly.
@@ -38,27 +38,27 @@ describe Temescal::Middleware do
       end
     end
 
-    it "should respond with a 500 if the exception does not have a http_status attribute" do
+    it "responds with a 500 if the exception does not have a http_status attribute" do
       code, _, _ = middleware.call env_for("http://foobar.com")
 
       expect(code).to eq 500
     end
 
-    it "should respond with the appropriate status if the exception has a http_status attribute" do
-      StandardError.any_instance.stub(:http_status).and_return(403)
+    it "responds with the appropriate status if the exception has a http_status attribute" do
+      allow_any_instance_of(StandardError).to receive(:http_status).and_return(403)
 
       code, _, _ = middleware.call env_for("http://foobar.com")
 
       expect(code).to eq 403
     end
 
-    it "should set the correct content type header" do
+    it "sets the correct content type header" do
       _, headers, _ = middleware.call env_for("http://foobar.com")
 
       expect(headers["Content-Type"]).to eq "application/json"
     end
 
-    it "should render a JSON response for the error" do
+    it "renders a JSON response for the error" do
       _, _, response = middleware.call env_for("http://foobar.com")
 
       json = JSON.parse(response.first)["meta"]
@@ -67,20 +67,20 @@ describe Temescal::Middleware do
       expect(json["message"]).to eq "Foobar"
     end
 
-    it "should log the error" do
+    it "logs the error" do
       expect($stderr).to receive(:print).with(an_instance_of String)
 
       middleware.call env_for("http://foobar.com")
     end
 
-    it "should report the error to the specified monitors" do
+    it "reports the error to the specified monitors" do
       expect(Temescal::Monitors::NewRelic).to receive(:report).with(an_instance_of StandardError)
 
       middleware.call env_for("http://foobar.com")
     end
 
     context "with default_message set" do
-      it "should build a response with the specified message instead of the exception message" do
+      it "builds a response with the specified message instead of the exception message" do
         middleware = Temescal::Middleware.new(app) do |config|
           config.default_message = "An error has occured - we'll get on it right away!"
         end
@@ -93,7 +93,7 @@ describe Temescal::Middleware do
     end
 
     context "with a Sinatra::NotFound error" do
-      it "should build a response with a 404 status code" do
+      it "builds a response with a 404 status code" do
         app = ->(env) { raise Sinatra::NotFound.new }
         middleware = Temescal::Middleware.new(app)
 
@@ -104,7 +104,7 @@ describe Temescal::Middleware do
     end
 
     context "with an ActiveRecord::RecordNotFound error" do
-      it "should build a response with a 404 status code" do
+      it "builds a response with a 404 status code" do
         app = ->(env) { raise ActiveRecord::RecordNotFound.new }
         middleware = Temescal::Middleware.new(app)
 
@@ -122,23 +122,39 @@ describe Temescal::Middleware do
         end
       end
 
-      it "should not log an ignored error type" do
+      it "does 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
+      it "does 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
+
+    context "with custom meta key set" do
+      let(:middleware) do
+        Temescal::Middleware.new(app) do |config|
+          config.meta_key = "not_meta"
+        end
+      end
+
+      it "builds a response with the custom key" do
+        _, _, response = middleware.call env_for("http://foobar.com")
+
+        response = JSON.parse(response.first)
+
+        expect(response["not_meta"]).to_not be_nil
+      end
+    end
   end
 
   context "Override middleware to raise exception" do
     before do
-      $stderr.stub(:print)
+      allow($stderr).to receive(:print)
     end
 
     let(:app) { ->(env) { raise StandardError.new("Foobar") } }
@@ -149,7 +165,7 @@ describe Temescal::Middleware do
       end
     end
 
-    it "should raise the error" do
+    it "raises the error" do
       expect { middleware.call env_for("http://foobar.com") }.to raise_error StandardError
     end
   end

data/spec/lib/temescal/monitors_spec.rb

@@ -4,34 +4,52 @@ describe Temescal::Monitors do
   let(:exception) { StandardError.new }
 
   context "MonitorsStrategy" do
-    it "should raise an error when the report method is called" do
-      expect { Temescal::Monitors::MonitorsStrategy.report(exception) }.to raise_error(NotImplementedError)
+    describe '.report' do
+      it "raises an error" do
+        expect { Temescal::Monitors::MonitorsStrategy.report(exception) }.to raise_error(NotImplementedError)
+      end
     end
   end
 
   context "Airbrake" do
-    it "should send the exception to Airbrake when report is called" do
-      Airbrake.stub(:send_notice)
+    describe '.report' do
+      it "sends the exception to Airbrake" do
+        allow(Airbrake).to receive(:send_notice)
 
-      expect(Airbrake).to receive(:notify).with(exception)
+        expect(Airbrake).to receive(:notify).with(exception)
 
-      Temescal::Monitors::Airbrake.report exception
+        Temescal::Monitors::Airbrake.report exception
+      end
     end
   end
 
   context "NewRelic" do
-    it "should send the exception to New Relic when report is called" do
-      expect(NewRelic::Agent).to receive(:notice_error).with(exception)
+    describe '.report' do
+      it "sends the exception to New Relic" do
+        expect(NewRelic::Agent).to receive(:notice_error).with(exception)
 
-      Temescal::Monitors::NewRelic.report exception
+        Temescal::Monitors::NewRelic.report exception
+      end
     end
   end
 
   context 'Bugsnag' do
-    it "should send the exception to Bugsnag when report is called" do
-      expect(Bugsnag).to receive(:notify).with(exception)
+    describe '.report' do
+      it "sends the exception to Bugsnag" do
+        expect(Bugsnag).to receive(:notify).with(exception)
 
-      Temescal::Monitors::Bugsnag.report exception
+        Temescal::Monitors::Bugsnag.report exception
+      end
+    end
+  end
+
+    context 'Honeybadger' do
+    describe '.report' do
+      it "sends the exception to Honeybadger" do
+        expect(Honeybadger).to receive(:notify).with(exception)
+
+        Temescal::Monitors::Honeybadger.report exception
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ if ENV["CI"]
   Coveralls.wear!
 else
   require "awesome_print"
-  require "pry-debugger"
+  require "pry-byebug"
 
   require "simplecov"
   SimpleCov.start
@@ -14,6 +14,7 @@ require "rack"
 require "airbrake"
 require "newrelic_rpm"
 require "bugsnag"
+require "honeybadger"
 
 require "active_record"
 require "sinatra"
@@ -21,7 +22,6 @@ require "sinatra"
 require "temescal"
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: temescal
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Todd Bealmear
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rack Middleware for gracefully handling exceptions for JSON APIs.