stoplight 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97f3aac00bec5d8f4a86a709adacab7e81246b2c
-  data.tar.gz: ed4f8f332e6111245ff0c6555b337bded9f417a7
+  metadata.gz: c744702c57c79bb96de6ba01eeb2c4adcc65eadd
+  data.tar.gz: face2e75b1ac458693f3d160a33d534dd1e0b226
 SHA512:
-  metadata.gz: 43be4295193fbd9977303ddb15baf0d1ef3a4f04eeea57302d58e89d97ed3af2066b4c37294d335213f2b5841b987bf3b0e2a74eda00bff619e1504092ada523
-  data.tar.gz: 5b8e1cfda7283a49082308f9f5d9f696ca2508066ddba7707240cc88e31e61f6f2d9611600c0468c68468eef0eb3851a16b1a1f1e85520c5618f043ddbe4fa62
+  metadata.gz: 258fd3aa57d2f49e4b049d98d83c899f80d47cdbd354436b854b56959aabd0e21f9d34e25fc607dc7d189dcdb8896e5b4cbdb6825f27435d3cd4e40654096179
+  data.tar.gz: 8369dc5c2f5355ed9936eea5d8999bdfa3965a891dbf62150dc1f748196aa46f87bec0e5201a473f5e72c6c0ef008e3f135cd8170bc5f72c1023784b862a62a7

data/README.md

@@ -33,6 +33,7 @@ Check out [stoplight-admin][] for controlling your stoplights.
     - [HipChat](#hipchat)
     - [Honeybadger](#honeybadger)
     - [Logger](#logger)
+    - [Sentry](#sentry)
     - [Slack](#slack)
   - [Rails](#rails-1)
 - [Advanced usage](#advanced-usage)
@@ -356,6 +357,22 @@ Stoplight::Light.default_notifiers += [notifier]
 # => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Logger:...>]
 ```
 
+#### Sentry
+
+Make sure you have [the Sentry gem][] (`~> 1.2`) installed before configuring
+Stoplight.
+
+``` rb
+require 'sentry-raven'
+# => true
+configuration = Raven::Configuration.new
+# => #<Raven::Configuration:...>
+notifier = Stoplight::Notifier::Raven.new(configuration)
+# => #<Stoplight::Notifier::Raven:...>
+Stoplight::Light.default_notifiers += [notifier]
+# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Raven:...>]
+```
+
 #### Slack
 
 Make sure you have [the Slack gem][] (`~> 1.3`) installed before configuring
@@ -476,6 +493,7 @@ Stoplight is licensed under [the MIT License][].
 [the HipChat gem]: https://rubygems.org/gems/hipchat
 [the Honeybadger gem]: https://rubygems.org/gems/honeybadger
 [the Logger class]: http://ruby-doc.org/stdlib-2.2.3/libdoc/logger/rdoc/Logger.html
+[the Sentry gem]: https://rubygems.org/gems/sentry-raven
 [the Slack gem]: https://rubygems.org/gems/slack-notifier
 [@camdez]: https://github.com/camdez
 [@tfausak]: https://github.com/tfausak

data/lib/stoplight.rb

@@ -24,6 +24,7 @@ require 'stoplight/notifier/hip_chat'
 require 'stoplight/notifier/honeybadger'
 require 'stoplight/notifier/io'
 require 'stoplight/notifier/logger'
+require 'stoplight/notifier/raven'
 require 'stoplight/notifier/slack'
 
 require 'stoplight/default'

data/lib/stoplight/failure.rb

@@ -15,7 +15,7 @@ module Stoplight
     # @param error [Exception]
     # @return (see #initialize)
     def self.from_error(error)
-      new(error.class.name, error.message, Time.new)
+      new(error.class.name, error.message, Time.now)
     end
 
     # @param json [String]

data/lib/stoplight/light/runnable.rb

@@ -8,11 +8,10 @@ module Stoplight
         failures, state = failures_and_state
         failure = failures.first
 
-        case
-        when state == State::LOCKED_GREEN then Color::GREEN
-        when state == State::LOCKED_RED then Color::RED
-        when failures.size < threshold then Color::GREEN
-        when failure && Time.new - failure.time >= cool_off_time
+        if state == State::LOCKED_GREEN then Color::GREEN
+        elsif state == State::LOCKED_RED then Color::RED
+        elsif failures.size < threshold then Color::GREEN
+        elsif failure && Time.now - failure.time >= cool_off_time
           Color::YELLOW
         else Color::RED
         end

data/lib/stoplight/notifier/honeybadger.rb

@@ -34,7 +34,8 @@ module Stoplight
         h = options.merge(
           api_key: api_key,
           error_message: message,
-          backtrace: (error.backtrace if error))
+          backtrace: (error.backtrace if error)
+        )
         ::Honeybadger.notify(h)
         message
       end

data/lib/stoplight/notifier/raven.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+module Stoplight
+  module Notifier
+    # @see Base
+    class Raven < Base
+      DEFAULT_OPTIONS = {
+        extra: {}
+      }.freeze
+
+      # @return [::Raven::Configuration]
+      attr_reader :configuration
+      # @return [Proc]
+      attr_reader :formatter
+      # @return [Hash{Symbol => Object}]
+      attr_reader :options
+
+      # @param api_key [String]
+      # @param formatter [Proc, nil]
+      # @param options [Hash{Symbol => Object}]
+      # @option options [Hash] :extra
+      def initialize(configuration, formatter = nil, options = {})
+        @configuration = configuration
+        @formatter = formatter || Default::FORMATTER
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def notify(light, from_color, to_color, error)
+        message = formatter.call(light, from_color, to_color, error)
+
+        h = options.merge(
+          configuration: configuration,
+          backtrace: (error.backtrace if error)
+        )
+        ::Raven.capture_message(message, h)
+        message
+      end
+    end
+  end
+end

data/lib/stoplight/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module Stoplight
-  VERSION = Gem::Version.new('2.0.0')
+  VERSION = Gem::Version.new('2.1.0')
 end

data/spec/stoplight/failure_spec.rb

@@ -10,7 +10,8 @@ RSpec.describe Stoplight::Failure do
   let(:json) do
     JSON.generate(
       error: { class: error_class, message: error_message },
-      time: time.strftime('%Y-%m-%dT%H:%M:%S.%N%:z'))
+      time: time.strftime('%Y-%m-%dT%H:%M:%S.%N%:z')
+    )
   end
 
   it 'is a class' do

data/spec/stoplight/light/runnable_spec.rb

@@ -51,14 +51,16 @@ RSpec.describe Stoplight::Light::Runnable do
         subject.data_store.record_failure(subject, failure)
       end
       other = Stoplight::Failure.new(
-        error.class.name, error.message, Time.new - subject.cool_off_time)
+        error.class.name, error.message, Time.new - subject.cool_off_time
+      )
       subject.data_store.record_failure(subject, other)
       expect(subject.color).to eql(Stoplight::Color::YELLOW)
     end
 
     it 'is red when the least recent failure is old' do
       other = Stoplight::Failure.new(
-        error.class.name, error.message, Time.new - subject.cool_off_time)
+        error.class.name, error.message, Time.new - subject.cool_off_time
+      )
       subject.data_store.record_failure(subject, other)
       (subject.threshold - 1).times do
         subject.data_store.record_failure(subject, failure)
@@ -200,7 +202,8 @@ RSpec.describe Stoplight::Light::Runnable do
         end
 
         other = Stoplight::Failure.new(
-          error.class.name, error.message, time - subject.cool_off_time)
+          error.class.name, error.message, time - subject.cool_off_time
+        )
         subject.data_store.record_failure(subject, other)
       end
 

data/spec/stoplight/notifier/honeybadger_spec.rb

@@ -18,7 +18,8 @@ RSpec.describe Stoplight::Notifier::Honeybadger do
   describe '#formatter' do
     it 'is initially the default' do
       expect(described_class.new(nil).formatter).to eql(
-        Stoplight::Default::FORMATTER)
+        Stoplight::Default::FORMATTER
+      )
     end
 
     it 'reads the formatter' do
@@ -30,13 +31,15 @@ RSpec.describe Stoplight::Notifier::Honeybadger do
   describe '#options' do
     it 'is initially the default' do
       expect(described_class.new(nil).options).to eql(
-        Stoplight::Notifier::Honeybadger::DEFAULT_OPTIONS)
+        Stoplight::Notifier::Honeybadger::DEFAULT_OPTIONS
+      )
     end
 
     it 'reads the options' do
       options = { key: :value }
       expect(described_class.new(nil, nil, options).options).to eql(
-        Stoplight::Notifier::Honeybadger::DEFAULT_OPTIONS.merge(options))
+        Stoplight::Notifier::Honeybadger::DEFAULT_OPTIONS.merge(options)
+      )
     end
   end
 
@@ -57,23 +60,29 @@ RSpec.describe Stoplight::Notifier::Honeybadger do
       error = nil
       message = notifier.formatter.call(light, from_color, to_color, error)
       expect(notifier.notify(light, from_color, to_color, error)).to eql(
-        message)
+        message
+      )
       expect(Honeybadger).to have_received(:notify).with(
         hash_including(
           api_key: api_key,
-          error_message: message))
+          error_message: message
+        )
+      )
     end
 
     it 'returns the message with an error' do
       error = ZeroDivisionError.new('divided by 0')
       message = notifier.formatter.call(light, from_color, to_color, error)
       expect(notifier.notify(light, from_color, to_color, error)).to eql(
-        message)
+        message
+      )
       expect(Honeybadger).to have_received(:notify).with(
         hash_including(
           api_key: api_key,
           error_message: message,
-          backtrace: error.backtrace))
+          backtrace: error.backtrace
+        )
+      )
     end
   end
 end

data/spec/stoplight/notifier/raven_spec.rb

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+# require 'sentry-raven'
+module Raven
+  class Configuration
+  end
+end
+
+RSpec.describe Stoplight::Notifier::Raven do
+  it 'is a class' do
+    expect(described_class).to be_a(Class)
+  end
+
+  it 'is a subclass of Base' do
+    expect(described_class).to be < Stoplight::Notifier::Base
+  end
+
+  describe '#formatter' do
+    it 'is initially the default' do
+      expect(described_class.new(nil).formatter).to eql(
+        Stoplight::Default::FORMATTER
+      )
+    end
+
+    it 'reads the formatter' do
+      formatter = proc {}
+      expect(described_class.new(nil, formatter).formatter).to eql(formatter)
+    end
+  end
+
+  describe '#options' do
+    it 'is initially the default' do
+      expect(described_class.new(nil).options).to eql(
+        Stoplight::Notifier::Raven::DEFAULT_OPTIONS
+      )
+    end
+
+    it 'reads the options' do
+      options = { key: :value }
+      expect(described_class.new(nil, nil, options).options).to eql(
+        Stoplight::Notifier::Raven::DEFAULT_OPTIONS.merge(options)
+      )
+    end
+  end
+
+  describe '#notify' do
+    let(:light) { Stoplight::Light.new(name, &code) }
+    let(:name) { ('a'..'z').to_a.shuffle.join }
+    let(:code) { -> {} }
+    let(:from_color) { Stoplight::Color::GREEN }
+    let(:to_color) { Stoplight::Color::RED }
+    let(:notifier) { described_class.new(configuration) }
+    let(:configuration) { instance_double(::Raven::Configuration) }
+
+    before do
+      allow(::Raven).to receive(:capture_message)
+    end
+
+    it 'returns the message' do
+      error = nil
+      message = notifier.formatter.call(light, from_color, to_color, error)
+      expect(notifier.notify(light, from_color, to_color, error)).to eql(
+        message
+      )
+      expect(::Raven).to have_received(:capture_message).with(
+        message,
+        hash_including(
+          configuration: configuration
+        )
+      )
+    end
+
+    it 'returns the message with an error' do
+      error = ZeroDivisionError.new('divided by 0')
+      message = notifier.formatter.call(light, from_color, to_color, error)
+      expect(notifier.notify(light, from_color, to_color, error)).to eql(
+        message
+      )
+      expect(::Raven).to have_received(:capture_message).with(
+        message,
+        hash_including(
+          configuration: configuration,
+          backtrace: error.backtrace
+        )
+      )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -110,6 +110,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -158,14 +172,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -225,6 +239,7 @@ files:
 - lib/stoplight/notifier/honeybadger.rb
 - lib/stoplight/notifier/io.rb
 - lib/stoplight/notifier/logger.rb
+- lib/stoplight/notifier/raven.rb
 - lib/stoplight/notifier/slack.rb
 - lib/stoplight/state.rb
 - lib/stoplight/version.rb
@@ -246,6 +261,7 @@ files:
 - spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
+- spec/stoplight/notifier/raven_spec.rb
 - spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb
@@ -271,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.0
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Traffic control for code.
@@ -294,6 +310,7 @@ test_files:
 - spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
+- spec/stoplight/notifier/raven_spec.rb
 - spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb