stoplight 2.1.3 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e73b740e1d020caa3c2231d358358f7f1405d339
-  data.tar.gz: f228a34259327f769ee5a43630815ee31ec754ee
+SHA256:
+  metadata.gz: e26d25f913bb759dccd62f2b12576cbe51550753c3c6428fb16cdb6052559928
+  data.tar.gz: 6cbfd0ccd62da40cb335e671c8ba2d84348652e206520355fa651eb2276e16ea
 SHA512:
-  metadata.gz: ef7a7ec7291ffc27d4b12c2900e52927abe9b9faf93e26f5086959742e57c69c4b8d05a880e66eba7439193686983bd516f429d1c4e6eb61067b86d5870c9f9d
-  data.tar.gz: 68ef1c8e9583434ae5da043aa0c7ef3f5e0a23a9b9bef40ac58bdffac57fa83de4d9d148e3bfbf68bda3caaf8f831cd10a5d28882952a533655a47fb3b7f21f2
+  metadata.gz: a186fc199cd54411996a65c369c687dc1165ecb2115699c72e6aa005f1b3d5b0da3b5f90402d2c49b12d73ca708628b09f5b9ba02e57c127ce89a33f8dc16cd2
+  data.tar.gz: 7ee5b81cad78ed7aaa7200aedf74cba3af8aff5b1e95940c572ca93bbefa28676ceb507ef04ce63bef28d9b6e7dcb2590653dd06704cf14b561653662c9fa30b

data/README.md

@@ -32,6 +32,8 @@ Check out [stoplight-admin][] for controlling your stoplights.
     - [HipChat](#hipchat)
     - [Honeybadger](#honeybadger)
     - [Logger](#logger)
+    - [Pagerduty](#pagerduty)
+    - [Rollbar](#rollbar)
     - [Sentry](#sentry)
     - [Slack](#slack)
   - [Rails](#rails-1)
@@ -204,7 +206,7 @@ The default threshold is `3`.
 ### Custom cool off time
 
 Stoplights will automatically attempt to recover after a certain amount of
-time. A light in the red state for longer than the cool of period will
+time. A light in the red state for longer than the cool off period will
 transition to the yellow state. This cool off time is customizable.
 
 ``` rb
@@ -356,6 +358,36 @@ Stoplight::Light.default_notifiers += [notifier]
 # => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Logger:...>]
 ```
 
+#### Pagerduty
+
+Make sure you have [the Pagerduty gem][] (`~> 2.1`) installed before configuring
+Stoplight.
+
+``` rb
+require 'pagerduty'
+# => true
+pagerduty = Pagerduty.new('http://www.example.com/webhook-url')
+# => #<Pagerduty:...>
+notifier = Stoplight::Notifier::Pagerduty.new(pagerduty)
+# => #<Stoplight::Notifier::Pagerduty:...>
+Stoplight::Light.default_notifiers += [notifier]
+# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Pagerduty:...>]
+```
+
+#### Rollbar
+
+Make sure you have [the Rollbar gem][] (`~> 2.0`) installed before configuring
+Stoplight.
+
+``` rb
+require 'rollbar'
+# => true
+notifier = Stoplight::Notifier::Rollbar.new(Rollbar)
+# => #<Stoplight::Notifier::Rollbar:...>
+Stoplight::Light.default_notifiers += [notifier]
+# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Rollbar:...>]
+```
+
 #### Sentry
 
 Make sure you have [the Sentry gem][] (`~> 1.2`) installed before configuring
@@ -490,8 +522,10 @@ 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 Rollbar gem]: https://rubygems.org/gems/rollbar
 [the Sentry gem]: https://rubygems.org/gems/sentry-raven
 [the Slack gem]: https://rubygems.org/gems/slack-notifier
+[the Pagerduty gem]: https://rubygems.org/gems/pagerduty
 [@camdez]: https://github.com/camdez
 [@tfausak]: https://github.com/tfausak
 [@orgsync]: https://github.com/OrgSync

data/lib/stoplight.rb

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

data/lib/stoplight/failure.rb

@@ -52,14 +52,18 @@ module Stoplight
         time == other.time
     end
 
+    # @param options [Object, nil]
     # @return [String]
-    def to_json
+    def to_json(options = nil)
       JSON.generate(
-        error: {
-          class: error_class,
-          message: error_message
+        {
+          error: {
+            class: error_class,
+            message: error_message
+          },
+          time: time.strftime(TIME_FORMAT)
         },
-        time: time.strftime(TIME_FORMAT)
+        options
       )
     end
   end

data/lib/stoplight/notifier/pagerduty.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+module Stoplight
+  module Notifier
+    # @see Base
+    class Pagerduty < Base
+      include Generic
+
+      # @return [::Pagerduty]
+      def pagerduty
+        @object
+      end
+
+      private
+
+      def put(message)
+        pagerduty.trigger(message)
+      end
+    end
+  end
+end

data/lib/stoplight/notifier/rollbar.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+module Stoplight
+  module Notifier
+    # @see Base
+    class Rollbar < Base
+      DEFAULT_OPTIONS = {
+        severity: 'info'
+      }.freeze
+
+      StoplightStatusChange = Class.new(Error::Base)
+
+      # @return [Proc]
+      attr_reader :formatter
+      # @return [::Rollbar]
+      attr_reader :rollbar
+      # @return [Hash{Symbol => Object}]
+      attr_reader :options
+
+      # @param rollbar [::Rollbar]
+      # @param formatter [Proc, nil]
+      # @param options [Hash{Symbol => Object}]
+      # @option options [String] :severity
+      def initialize(rollbar, formatter = nil, options = {})
+        @rollbar = rollbar
+        @formatter = formatter || Default::FORMATTER
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def notify(light, from_color, to_color, error)
+        formatter.call(light, from_color, to_color, error).tap do |message|
+          severity = options.fetch(:severity)
+          exception = StoplightStatusChange.new(message)
+          rollbar.__send__(severity, exception)
+        end
+      end
+    end
+  end
+end

data/lib/stoplight/version.rb

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

data/spec/stoplight/default_spec.rb

@@ -74,7 +74,7 @@ RSpec.describe Stoplight::Default do
 
   describe '::THRESHOLD' do
     it 'is an integer' do
-      expect(Stoplight::Default::THRESHOLD).to be_a(Fixnum)
+      expect(Stoplight::Default::THRESHOLD).to be_a(Integer)
     end
   end
 end

data/spec/stoplight/failure_spec.rb

@@ -89,6 +89,11 @@ RSpec.describe Stoplight::Failure do
       expect(described_class.new(error_class, error_message, time).to_json)
         .to eql(json)
     end
+
+    it 'generates JSON with options' do
+      expect(described_class.new(error_class, error_message, time).to_json({}))
+        .to eql(json)
+    end
   end
 
   describe '::TIME_FORMAT' do

data/spec/stoplight/notifier/bugsnag_spec.rb

@@ -7,8 +7,6 @@ module Bugsnag
 end
 
 RSpec.describe Stoplight::Notifier::Bugsnag do
-  StoplightStatusChange = Stoplight::Notifier::Bugsnag::StoplightStatusChange
-
   it 'is a class' do
     expect(described_class).to be_a(Class)
   end
@@ -65,7 +63,7 @@ RSpec.describe Stoplight::Notifier::Bugsnag do
     end
 
     before do
-      status_change = StoplightStatusChange.new(message)
+      status_change = described_class::StoplightStatusChange.new(message)
       expect(bugsnag).to receive(:notify).with(status_change, severity: 'info')
     end
 

data/spec/stoplight/notifier/pagerduty_spec.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'pagerduty'
+
+RSpec.describe Stoplight::Notifier::Pagerduty do
+  it_behaves_like 'a generic notifier'
+
+  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 '#pagerduty' do
+    it 'reads Pagerduty client' do
+      pagerduty = Pagerduty.new('WEBHOOK_URL')
+      expect(described_class.new(pagerduty).pagerduty).to eql(pagerduty)
+    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(pagerduty) }
+    let(:pagerduty) { double(Pagerduty).as_null_object }
+
+    it 'pings Pagerduty' do
+      error = nil
+      message = notifier.formatter.call(light, from_color, to_color, error)
+      expect(pagerduty).to receive(:trigger).with(message)
+      notifier.notify(light, from_color, to_color, error)
+    end
+  end
+end

data/spec/stoplight/notifier/rollbar_spec.rb

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+# require 'rollbar'
+module Rollbar
+end
+
+RSpec.describe Stoplight::Notifier::Rollbar 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, 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, nil).options)
+        .to eql(Stoplight::Notifier::Rollbar::DEFAULT_OPTIONS)
+    end
+
+    it 'reads the options' do
+      options = { key: :value }
+      expect(described_class.new(nil, nil, options).options)
+        .to eql(Stoplight::Notifier::Rollbar::DEFAULT_OPTIONS.merge(options))
+    end
+  end
+
+  describe '#rollbar' do
+    it 'reads the Rollbar client' do
+      client = Rollbar
+      expect(described_class.new(client, nil).rollbar)
+        .to eql(client)
+    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(rollbar) }
+    let(:rollbar) { Rollbar }
+
+    subject(:result) do
+      notifier.notify(light, from_color, to_color, error)
+    end
+
+    before do
+      status_change = described_class::StoplightStatusChange.new(message)
+      expect(rollbar).to receive(:info).with(status_change)
+    end
+
+    context 'when no error given' do
+      let(:error) { nil }
+
+      it 'logs message' do
+        expect(result).to eq(message)
+      end
+    end
+
+    context 'when message with an error given' do
+      let(:error) { ZeroDivisionError.new('divided by 0') }
+
+      it 'logs message' do
+        expect(result).to eq(message)
+      end
+    end
+
+    def message
+      notifier.formatter.call(light, from_color, to_color, error)
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.1
 platform: ruby
 authors:
 - Cameron Desautels
 - Taylor Fausak
 - Justin Steffy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -97,19 +97,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: sentry-raven
+  name: pagerduty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.40.0
+- !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: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +239,9 @@ files:
 - lib/stoplight/notifier/honeybadger.rb
 - lib/stoplight/notifier/io.rb
 - lib/stoplight/notifier/logger.rb
+- lib/stoplight/notifier/pagerduty.rb
 - lib/stoplight/notifier/raven.rb
+- lib/stoplight/notifier/rollbar.rb
 - lib/stoplight/notifier/slack.rb
 - lib/stoplight/state.rb
 - lib/stoplight/version.rb
@@ -247,7 +263,9 @@ files:
 - spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
+- spec/stoplight/notifier/pagerduty_spec.rb
 - spec/stoplight/notifier/raven_spec.rb
+- spec/stoplight/notifier/rollbar_spec.rb
 - spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb
@@ -257,7 +275,7 @@ homepage: https://github.com/orgsync/stoplight
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -272,9 +290,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Traffic control for code.
 test_files:
@@ -282,12 +299,14 @@ test_files:
 - spec/stoplight_spec.rb
 - spec/stoplight/error_spec.rb
 - spec/stoplight/failure_spec.rb
+- spec/stoplight/notifier/pagerduty_spec.rb
 - spec/stoplight/notifier/raven_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
 - spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/generic_spec.rb
 - spec/stoplight/notifier/slack_spec.rb
+- spec/stoplight/notifier/rollbar_spec.rb
 - spec/stoplight/notifier/base_spec.rb
 - spec/stoplight/notifier/bugsnag_spec.rb
 - spec/stoplight/notifier/hip_chat_spec.rb