stoplight 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5bb148c31a3c94f65125fba1628f7399755c74d
-  data.tar.gz: ed907f0fcfee16fbb9a760d863f47f0d89341d69
+  metadata.gz: 817cede2460b3309d9d6b2eed1e2eb5fd7c089e0
+  data.tar.gz: 7c5b0b24c68c0d4b63bdcf285dc97d0a67b2eedb
 SHA512:
-  metadata.gz: 73b02ee787610aef6491804b789c449fc91ed49ba6c511d800e7119178b120dcc9f87341838eb0b28ce4acb880ee2d67d956cedce1883c1cd49b76feccb5c699
-  data.tar.gz: 567b87080e6cd46487e09ea136319317aeebd6f0042f1b2e60aa5438d13f92cf99f2f42af76097609c35201903beac2c8d96f9ec912f5e7b220a25763ce8f2c1
+  metadata.gz: 128a58ba2d5667ca408a05696defb2cb8152a20c3f4f28e641d18e4ca91730b5209fb8f376fcff019989984fb49fdb75bdc9fbb24a8485e390e41b79799cbb37
+  data.tar.gz: b6766506606eda2a21886582ea626517a2f9d01d0b0967a63b323d67e58103167780ec91ff0ce018d9d341adaf07bca5261e8cc223a78dc06688391e58c1cf4c

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.4.0 (2014-09-17)
+
+- Made stoplights handle failing notifiers by logging the failure to standard
+  error.
+- Made stoplights automatically fall back to a fresh in-memory data store if the
+  primary store is unavailable.
+- Generalized `Stoplight::Notifier::StandardError` into
+  `Stoplight::Notifier::IO`.
+- Changed notification format from a string to a lambda. It accepts the same
+  parameters that the format string accepted.
+- Updated `Stoplight::Notifier::Base#notify` to accept three parameters (the
+  light, the before color, and the after color) instead of just one parameter
+  (the message).
+- Prevented setting non-positive thresholds.
+- Removed `Stoplight::Mixin`.
+
 ## v0.3.1 (2014-09-12)
 
 - Replaced `Stoplight::Failure#error` with `#error_class` and `#error_message`.

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. **Fork** the repository.
+2. Create a **branch** for your feature (`git checkout -b feature`).
+3. **Commit** your changes (`git commit -a -m 'Feature'`).
+4. **Push** to your branch (`git push origin feature`).
+5. Create a **pull request**.

data/README.md

@@ -6,6 +6,8 @@
 [![Quality status][8]][9]
 [![Dependency status][10]][11]
 
+<img align="right" alt="Stoplight icon" src="https://i.imgur.com/tiuOfY9.png">
+
 Traffic control for code. An implementation of the circuit breaker pattern in
 Ruby.
 
@@ -16,13 +18,14 @@ Check out [stoplight-admin][12] for controlling your stoplights.
   - [Data store](#data-store)
   - [Notifiers](#notifiers)
   - [Rails](#rails)
-- [Usage](#usage)
-  - [Mixin](#mixin)
+- [Basic usage](#basic-usage)
   - [Custom errors](#custom-errors)
   - [Custom fallback](#custom-fallback)
   - [Custom threshold](#custom-threshold)
   - [Custom timeout](#custom-timeout)
   - [Rails](#rails-1)
+- [Advanced usage](#advanced-usage)
+  - [Locking](#locking)
 - [Credits](#credits)
 
 ## Installation
@@ -30,7 +33,7 @@ Check out [stoplight-admin][12] for controlling your stoplights.
 Add it to your Gemfile:
 
 ``` rb
-gem 'stoplight', '~> 0.3.1'
+gem 'stoplight', '~> 0.4.0'
 ```
 
 Or install it manually:
@@ -75,7 +78,7 @@ Stoplight sends notifications to standard error by default.
 
 ``` irb
 >> Stoplight.notifiers
-=> [#<Stoplight::Notifier::StandardError:...>]
+=> [#<Stoplight::Notifier::IO:...>]
 ```
 
 If you want to send notifications elsewhere, you'll have to set them up.
@@ -90,7 +93,7 @@ HipChat gem][15] installed before configuring Stoplight.
 >> notifier = Stoplight::Notifier::HipChat.new(hipchat, 'room')
 => #<Stoplight::Notifier::HipChat:...>
 >> Stoplight.notifiers << notifier
-=> [#<Stoplight::Notifier::StandardError:...>, #<Stoplight::Notifier::HipChat:...>]
+=> [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::HipChat:...>]
 ```
 
 ### Rails
@@ -107,7 +110,7 @@ Stoplight.data_store = Stoplight::DataStore::Redis.new(...)
 Stoplight.notifiers << Stoplight::Notifier::HipChat.new(...)
 ```
 
-## Usage
+## Basic usage
 
 To get started, create a stoplight:
 
@@ -155,18 +158,6 @@ Stoplight::Error::RedLight: example-2
 When the stoplight changes from green to red, it will notify every configured
 notifier.
 
-### Mixin
-
-Since creating and running a stoplight is so common, we provide a mixin that
-makes it easy.
-
-``` irb
->> include Stoplight::Mixin
-=> Object
->> stoplight('example-3') { 1.0 / 3 }
-=> 0.3333333333333333
-```
-
 ### Custom errors
 
 Some errors shouldn't cause your stoplight to move into the red state. Usually
@@ -269,6 +260,32 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Advanced usage
+
+### Locking
+
+Although stoplights can operate on their own, occasionally you may want to
+override the default behavior. You can lock a light in either the green or red
+state using `set_state`.
+
+``` irb
+>> light = Stoplight::Light.new('example-8') { true }
+=> #<Stoplight::Light:...>
+>> light.run
+=> true
+>> Stoplight.data_store.set_state(
+..   light.name, Stoplight::DataStore::STATE_LOCKED_RED)
+=> "locked_red"
+>> light.run
+Switching example-8 from green to red
+Stoplight::Error::RedLight: example-8
+```
+
+**Code in locked red lights may still run under certain conditions!** If you
+have configured a custom data store and that data store fails, Stoplight will
+switch over to using a blank in-memory data store. That means you will lose the
+locked state of any stoplights.
+
 ## Credits
 
 Stoplight is brought to you by [@camdez][16] and [@tfausak][17] from

data/lib/stoplight.rb

@@ -7,18 +7,17 @@ require 'stoplight/data_store/redis'
 require 'stoplight/error'
 require 'stoplight/failure'
 require 'stoplight/light'
-require 'stoplight/mixin'
 require 'stoplight/notifier'
 require 'stoplight/notifier/base'
 require 'stoplight/notifier/hip_chat'
-require 'stoplight/notifier/standard_error'
+require 'stoplight/notifier/io'
 
 module Stoplight
   # @return [Gem::Version]
-  VERSION = Gem::Version.new('0.3.1')
+  VERSION = Gem::Version.new('0.4.0')
 
   @data_store = DataStore::Memory.new
-  @notifiers = [Notifier::StandardError.new]
+  @notifiers = [Notifier::IO.new($stderr)]
 
   class << self
     # @return [DataStore::Base]

data/lib/stoplight/data_store.rb

@@ -41,7 +41,6 @@ module Stoplight
       case
       when state == STATE_LOCKED_GREEN then COLOR_GREEN
       when state == STATE_LOCKED_RED then COLOR_RED
-      when threshold < 1 then COLOR_RED
       when failures.size < threshold then COLOR_GREEN
       when Time.now - failures.last.time > timeout then COLOR_YELLOW
       else COLOR_RED
@@ -99,7 +98,7 @@ module Stoplight
     # @param threshold [Integer]
     # @return [Boolean]
     def valid_threshold?(threshold)
-      threshold.is_a?(Integer)
+      threshold.is_a?(Integer) && threshold > 0
     end
 
     # @param timeout [Integer]

data/lib/stoplight/data_store/redis.rb

@@ -38,6 +38,8 @@ module Stoplight
         threshold = normalize_threshold(threshold)
         @redis.hset(DataStore.thresholds_key, name, threshold)
         nil
+      rescue ::Redis::BaseError => error
+        raise Error::BadDataStore, error
       end
 
       def get_color(name)

data/lib/stoplight/error.rb

@@ -22,5 +22,29 @@ module Stoplight
 
     # @return [Class]
     InvalidTimeout = Class.new(Base)
+
+    # @return [Class]
+    class BadDataStore < Base
+      # @return [Exception]
+      attr_reader :cause
+
+      # @param cause [Exception]
+      def initialize(cause)
+        super(cause.message)
+        @cause = cause
+      end
+    end
+
+    # @return [Class]
+    class BadNotifier < Base
+      # @return [Exception]
+      attr_reader :cause
+
+      # @param cause [Exception]
+      def initialize(cause)
+        super(cause.message)
+        @cause = cause
+      end
+    end
   end
 end

data/lib/stoplight/light.rb

@@ -24,7 +24,7 @@ module Stoplight
     # @see #fallback
     # @see #green?
     def run
-      Stoplight.data_store.sync(name)
+      sync
 
       case color
       when DataStore::COLOR_GREEN
@@ -117,12 +117,12 @@ module Stoplight
     end
 
     def run_yellow
-      run_green.tap { notify("Switching #{name} from red to green.") }
+      run_green.tap { notify(DataStore::COLOR_RED, DataStore::COLOR_GREEN) }
     end
 
     def run_red
       if Stoplight.data_store.record_attempt(name) == 1
-        notify("Switching #{name} from green to red.")
+        notify(DataStore::COLOR_GREEN, DataStore::COLOR_RED)
       end
       fallback.call
     end
@@ -139,8 +139,22 @@ module Stoplight
       allowed_errors.any? { |klass| error.is_a?(klass) }
     end
 
-    def notify(message)
-      Stoplight.notifiers.each { |notifier| notifier.notify(message) }
+    def notify(from_color, to_color)
+      Stoplight.notifiers.each do |notifier|
+        begin
+          notifier.notify(self, from_color, to_color)
+        rescue Error::BadNotifier => error
+          warn(error.cause)
+        end
+      end
+    end
+
+    def sync
+      Stoplight.data_store.sync(name)
+    rescue Error::BadDataStore => error
+      warn(error.cause)
+      Stoplight.data_store = Stoplight::DataStore::Memory.new
+      retry
     end
   end
 end

data/lib/stoplight/notifier/base.rb

@@ -3,7 +3,10 @@
 module Stoplight
   module Notifier
     class Base
-      def notify(_message)
+      # @param _light [Light]
+      # @param _from_color [String]
+      # @param _to_color [String]
+      def notify(_light, _from_color, _to_color)
         fail NotImplementedError
       end
     end

data/lib/stoplight/notifier/hip_chat.rb

@@ -4,21 +4,42 @@ module Stoplight
   module Notifier
     # @note hipchat ~> 1.3.0
     class HipChat < Base
-      DEFAULT_FORMAT = '@all %s'
+      DEFAULT_FORMATTER = lambda do |light, from_color, to_color|
+        "@all Switching #{light.name} from #{from_color} to #{to_color}"
+      end
       DEFAULT_OPTIONS = { color: 'red', message_format: 'text', notify: true }
 
       # @param client [HipChat::Client]
       # @param room [String]
+      # @param formatter [Proc, nil]
       # @param options [Hash]
-      def initialize(client, room, format = nil, options = {})
+      def initialize(client, room, formatter = nil, options = {})
         @client = client
         @room = room
-        @format = format || DEFAULT_FORMAT
+        @formatter = formatter || DEFAULT_FORMATTER
         @options = DEFAULT_OPTIONS.merge(options)
       end
 
-      def notify(message)
-        @client[@room].send('Stoplight', @format % message, @options)
+      def notify(light, from_color, to_color)
+        message = @formatter.call(light, from_color, to_color)
+        @client[@room].send('Stoplight', message, @options)
+      rescue *errors => error
+        raise Error::BadNotifier, error
+      end
+
+      private
+
+      def errors
+        [
+          ::HipChat::InvalidApiVersion,
+          ::HipChat::RoomMissingOwnerUserId,
+          ::HipChat::RoomNameTooLong,
+          ::HipChat::Unauthorized,
+          ::HipChat::UnknownResponseCode,
+          ::HipChat::UnknownRoom,
+          ::HipChat::UnknownUser,
+          ::HipChat::UsernameTooLong
+        ]
       end
     end
   end

data/lib/stoplight/notifier/io.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+module Stoplight
+  module Notifier
+    class IO < Base
+      DEFAULT_FORMATTER = lambda do |light, from_color, to_color|
+        "Switching #{light.name} from #{from_color} to #{to_color}"
+      end
+
+      # @param io [IO]
+      # @param formatter [Proc, nil]
+      def initialize(io, formatter = nil)
+        @io = io
+        @formatter = formatter || DEFAULT_FORMATTER
+      end
+
+      def notify(light, from_color, to_color)
+        message = @formatter.call(light, from_color, to_color)
+        @io.puts(message)
+      end
+    end
+  end
+end

data/spec/stoplight/data_store/redis_spec.rb

@@ -1,11 +1,41 @@
 # coding: utf-8
 
 require 'spec_helper'
-require 'fakeredis'
 
 describe Stoplight::DataStore::Redis do
   subject(:data_store) { described_class.new(redis) }
   let(:redis) { Redis.new }
 
   it_behaves_like 'a data store'
+
+  context 'with a failing connection' do
+    let(:name) { SecureRandom.hex }
+    let(:error) { Redis::BaseConnectionError.new(message) }
+    let(:message) { SecureRandom.hex }
+
+    before { allow(redis).to receive(:hget).and_raise(error) }
+
+    it 'reraises the error' do
+      expect { data_store.sync(name) }
+        .to raise_error(Stoplight::Error::BadDataStore)
+    end
+
+    it 'sets the message' do
+      begin
+        data_store.sync(name)
+        expect(false).to be(true)
+      rescue Stoplight::Error::BadDataStore => e
+        expect(e.message).to eql(message)
+      end
+    end
+
+    it 'sets the cause' do
+      begin
+        data_store.sync(name)
+        expect(false).to be(true)
+      rescue Stoplight::Error::BadDataStore => e
+        expect(e.cause).to eql(error)
+      end
+    end
+  end
 end

data/spec/stoplight/data_store_spec.rb

@@ -45,6 +45,22 @@ describe Stoplight::DataStore do
         expect { result }.to raise_error(Stoplight::Error::InvalidThreshold)
       end
     end
+
+    context 'with a negative threshold' do
+      let(:threshold) { -1 }
+
+      it 'raises an error' do
+        expect { result }.to raise_error(Stoplight::Error::InvalidThreshold)
+      end
+    end
+
+    context 'with a zero threshold' do
+      let(:threshold) { 0 }
+
+      it 'raises an error' do
+        expect { result }.to raise_error(Stoplight::Error::InvalidThreshold)
+      end
+    end
   end
 
   describe '.validate_timeout!' do

data/spec/stoplight/light_spec.rb

@@ -6,7 +6,7 @@ require 'spec_helper'
 describe Stoplight::Light do
   before do
     @notifiers = Stoplight.notifiers
-    Stoplight.notifiers = []
+    Stoplight.notifiers = [Stoplight::Notifier::IO.new(StringIO.new)]
   end
   after { Stoplight.notifiers = @notifiers }
 
@@ -20,7 +20,7 @@ describe Stoplight::Light do
   let(:fallback) { -> { fallback_result } }
   let(:message) { SecureRandom.hex }
   let(:name) { SecureRandom.hex }
-  let(:threshold) { rand(100) }
+  let(:threshold) { 1 + rand(100) }
   let(:timeout) { rand(100) }
 
   it { expect(light.run).to eql(code_result) }
@@ -97,15 +97,6 @@ describe Stoplight::Light do
       end
     end
 
-    context 'with threshold' do
-      before { light.with_threshold(0) }
-
-      it 'stays red' do
-        expect(light.red?).to eql(true)
-        expect { light.run }.to raise_error(Stoplight::Error::RedLight)
-      end
-    end
-
     context 'with timeout' do
       before { light.with_timeout(-1) }
 
@@ -119,4 +110,97 @@ describe Stoplight::Light do
       end
     end
   end
+
+  context 'with Redis' do
+    let(:data_store) { Stoplight::DataStore::Redis.new(redis) }
+    let(:redis) { Redis.new }
+
+    before do
+      @data_store = Stoplight.data_store
+      Stoplight.data_store = data_store
+    end
+    after { Stoplight.data_store = @data_store }
+
+    context 'with a failing connection' do
+      let(:error) { Stoplight::Error::BadDataStore.new(cause) }
+      let(:cause) { Redis::BaseConnectionError.new(message) }
+      let(:message) { SecureRandom.hex }
+
+      before { allow(data_store).to receive(:sync).and_raise(error) }
+
+      before { @stderr, $stderr = $stderr, StringIO.new }
+      after { $stderr = @stderr }
+
+      it 'does not raise an error' do
+        expect { light.run }.to_not raise_error
+      end
+
+      it 'switches to an in-memory data store' do
+        light.run
+        expect(Stoplight.data_store).to_not eql(data_store)
+        expect(Stoplight.data_store).to be_a(Stoplight::DataStore::Memory)
+      end
+
+      it 'syncs the light in the new data store' do
+        expect_any_instance_of(Stoplight::DataStore::Memory)
+          .to receive(:sync).with(light.name)
+        light.run
+      end
+
+      it 'warns to STDERR' do
+        light.run
+        expect($stderr.string).to eql("#{cause}\n")
+      end
+    end
+  end
+
+  context 'with HipChat' do
+    let(:notifier) { Stoplight::Notifier::HipChat.new(client, room_name) }
+    let(:client) { double(HipChat::Client) }
+    let(:room_name) { SecureRandom.hex }
+    let(:room) { double(HipChat::Room) }
+
+    before do
+      @notifiers = Stoplight.notifiers
+      Stoplight.notifiers = [notifier]
+      allow(client).to receive(:[]).with(room_name).and_return(room)
+    end
+
+    after { Stoplight.notifiers = @notifiers }
+
+    context 'with a failing client' do
+      subject(:result) do
+        begin
+          light.run
+        rescue Stoplight::Error::RedLight
+          nil
+        end
+      end
+
+      let(:error_class) { HipChat::Unauthorized }
+
+      before do
+        Stoplight.data_store.set_state(
+          light.name, Stoplight::DataStore::STATE_LOCKED_RED)
+        allow(room).to receive(:send).with(
+          'Stoplight',
+          /\A@all /,
+          hash_including(color: 'red')
+        ).and_raise(error)
+        @stderr = $stderr
+        $stderr = StringIO.new
+      end
+
+      after { $stderr = @stderr }
+
+      it 'does not raise an error' do
+        expect { result }.to_not raise_error
+      end
+
+      it 'warns to STDERR' do
+        result
+        expect($stderr.string).to eql("#{error}\n")
+      end
+    end
+  end
 end

data/spec/stoplight/notifier/hip_chat_spec.rb

@@ -3,32 +3,72 @@
 require 'spec_helper'
 
 describe Stoplight::Notifier::HipChat do
-  subject(:notifier) { described_class.new(client, room, format, options) }
+  subject(:notifier) { described_class.new(client, room, formatter, options) }
   let(:client) { double }
   let(:room) { SecureRandom.hex }
-  let(:format) { nil }
+  let(:formatter) { nil }
   let(:options) { {} }
 
   describe '#notify' do
-    subject(:result) { notifier.notify(message) }
-    let(:message) { SecureRandom.hex }
+    subject(:result) { notifier.notify(light, from_color, to_color) }
+    let(:light) { Stoplight::Light.new(light_name, &light_code) }
+    let(:light_name) { SecureRandom.hex }
+    let(:light_code) { -> {} }
+    let(:from_color) { Stoplight::DataStore::COLOR_GREEN }
+    let(:to_color) { Stoplight::DataStore::COLOR_RED }
 
     it 'sends the message to HipChat' do
       expect(client).to receive(:[]).with(room).and_return(client)
-      expect(client).to receive(:send)
-        .with('Stoplight', "@all #{message}", anything)
+      expect(client).to receive(:send).with(
+        'Stoplight',
+        "@all Switching #{light.name} from #{from_color} to #{to_color}",
+        anything)
       result
     end
 
-    context 'with a format' do
-      let(:format) { '> %s <' }
+    context 'with a formatter' do
+      let(:formatter) { ->(l, f, t) { "#{l.name} #{f} #{t}" } }
 
       it 'formats the message' do
         expect(client).to receive(:[]).with(room).and_return(client)
-        expect(client).to receive(:send)
-          .with('Stoplight', "> #{message} <", anything)
+        expect(client).to receive(:send).with(
+          'Stoplight',
+          "#{light.name} #{from_color} #{to_color}",
+          anything)
         result
       end
     end
+
+    context 'failing' do
+      let(:error) { HipChat::UnknownResponseCode.new(message) }
+      let(:message) { SecureRandom.hex }
+
+      before do
+        allow(client).to receive(:[]).with(room).and_return(client)
+        allow(client).to receive(:send).and_raise(error)
+      end
+
+      it 'reraises the error' do
+        expect { result }.to raise_error(Stoplight::Error::BadNotifier)
+      end
+
+      it 'sets the message' do
+        begin
+          result
+          expect(false).to be(true)
+        rescue Stoplight::Error::BadNotifier => e
+          expect(e.message).to eql(message)
+        end
+      end
+
+      it 'sets the cause' do
+        begin
+          result
+          expect(false).to be(true)
+        rescue Stoplight::Error::BadNotifier => e
+          expect(e.cause).to eql(error)
+        end
+      end
+    end
   end
 end

data/spec/stoplight/notifier/io_spec.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Stoplight::Notifier::IO do
+  subject(:notifier) { described_class.new(io, formatter) }
+  let(:io) { StringIO.new }
+  let(:formatter) { nil }
+
+  describe '#notify' do
+    subject(:result) { notifier.notify(light, from_color, to_color) }
+    let(:light) { Stoplight::Light.new(light_name, &light_code) }
+    let(:light_name) { SecureRandom.hex }
+    let(:light_code) { -> {} }
+    let(:from_color) { Stoplight::DataStore::COLOR_GREEN }
+    let(:to_color) { Stoplight::DataStore::COLOR_RED }
+
+    it 'emits the message as a warning' do
+      result
+      expect(io.string)
+        .to eql("Switching #{light.name} from #{from_color} to #{to_color}\n")
+    end
+
+    context 'with a formatter' do
+      let(:formatter) { ->(l, f, t) { "#{l.name} #{f} #{t}" } }
+
+      it 'formats the message' do
+        result
+        expect(io.string)
+          .to eql("#{light.name} #{from_color} #{to_color}\n")
+      end
+    end
+  end
+end

data/spec/stoplight_spec.rb

@@ -46,7 +46,7 @@ describe Stoplight do
     it 'uses the default notifier' do
       expect(result).to be_an(Array)
       expect(result.size).to eql(1)
-      expect(result.first).to be_a(Stoplight::Notifier::StandardError)
+      expect(result.first).to be_a(Stoplight::Notifier::IO)
     end
 
     it 'memoizes the result' do

data/spec/support/data_store.rb

@@ -8,7 +8,7 @@ shared_examples_for 'a data store' do
   let(:error_class) { Class.new(StandardError) }
   let(:time) { Time.now }
   let(:state) { Stoplight::DataStore::STATES.to_a.sample }
-  let(:threshold) { rand(100) }
+  let(:threshold) { 1 + rand(100) }
   let(:timeout) { rand(100) }
 
   it { expect(data_store.names).to eql([]) }

data/spec/support/fakeredis.rb

@@ -0,0 +1,3 @@
+# coding: utf-8
+
+require 'fakeredis/rspec'

data/spec/support/hipchat.rb

@@ -0,0 +1,3 @@
+# coding: utf-8
+
+require 'hipchat'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -17,99 +17,115 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: '0.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: '0.26'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
-description: Traffic control for code.
+        version: '0.8'
+description: |
+  Traffic control for code. An implementation of the circuit breaker pattern
+  in Ruby.
 email:
 - camdez@gmail.com
 - taylor@fausak.me
@@ -118,6 +134,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE.md
 - README.md
 - lib/stoplight.rb
@@ -128,11 +145,10 @@ files:
 - lib/stoplight/error.rb
 - lib/stoplight/failure.rb
 - lib/stoplight/light.rb
-- lib/stoplight/mixin.rb
 - lib/stoplight/notifier.rb
 - lib/stoplight/notifier/base.rb
 - lib/stoplight/notifier/hip_chat.rb
-- lib/stoplight/notifier/standard_error.rb
+- lib/stoplight/notifier/io.rb
 - spec/spec_helper.rb
 - spec/stoplight/data_store/base_spec.rb
 - spec/stoplight/data_store/memory_spec.rb
@@ -140,14 +156,15 @@ files:
 - spec/stoplight/data_store_spec.rb
 - spec/stoplight/failure_spec.rb
 - spec/stoplight/light_spec.rb
-- spec/stoplight/mixin_spec.rb
 - spec/stoplight/notifier/base_spec.rb
 - spec/stoplight/notifier/hip_chat_spec.rb
-- spec/stoplight/notifier/standard_error_spec.rb
+- spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight_spec.rb
 - spec/support/data_store.rb
-homepage: https://github.com/orgsync/stoplight
+- spec/support/fakeredis.rb
+- spec/support/hipchat.rb
+homepage: http://orgsync.github.io/stoplight
 licenses:
 - MIT
 metadata: {}
@@ -179,11 +196,12 @@ test_files:
 - spec/stoplight/data_store_spec.rb
 - spec/stoplight/failure_spec.rb
 - spec/stoplight/light_spec.rb
-- spec/stoplight/mixin_spec.rb
 - spec/stoplight/notifier/base_spec.rb
 - spec/stoplight/notifier/hip_chat_spec.rb
-- spec/stoplight/notifier/standard_error_spec.rb
+- spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight_spec.rb
 - spec/support/data_store.rb
+- spec/support/fakeredis.rb
+- spec/support/hipchat.rb
 has_rdoc: 

data/lib/stoplight/mixin.rb

@@ -1,9 +0,0 @@
-# coding: utf-8
-
-module Stoplight
-  module Mixin
-    def stoplight(name, &block)
-      Stoplight::Light.new(name, &block).run
-    end
-  end
-end

data/lib/stoplight/notifier/standard_error.rb

@@ -1,17 +0,0 @@
-# coding: utf-8
-
-module Stoplight
-  module Notifier
-    class StandardError < Base
-      DEFAULT_FORMAT = '%s'
-
-      def initialize(format = nil)
-        @format = format || DEFAULT_FORMAT
-      end
-
-      def notify(message)
-        warn(@format % message)
-      end
-    end
-  end
-end

data/spec/stoplight/mixin_spec.rb

@@ -1,35 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-describe Stoplight::Mixin do
-  subject(:klass) { Class.new.extend(described_class) }
-
-  describe '#stoplight' do
-    subject(:result) { klass.stoplight(name, &code) }
-    let(:name) { SecureRandom.hex }
-    let(:code) { proc { code_result } }
-    let(:code_result) { double }
-
-    let(:light) { double }
-
-    before do
-      allow(Stoplight::Light).to receive(:new).and_return(light)
-      allow(light).to receive(:run).and_return(code.call)
-    end
-
-    it 'calls .new' do
-      expect(Stoplight::Light).to receive(:new)
-      result
-    end
-
-    it 'calls #run' do
-      expect(light).to receive(:run)
-      result
-    end
-
-    it 'returns the result of #run' do
-      expect(result).to eql(code_result)
-    end
-  end
-end

data/spec/stoplight/notifier/standard_error_spec.rb

@@ -1,30 +0,0 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-describe Stoplight::Notifier::StandardError do
-  subject(:notifier) { described_class.new(format) }
-  let(:format) { nil }
-
-  before { @stderr, $stderr = $stderr, StringIO.new }
-  after { $stderr = @stderr }
-
-  describe '#notify' do
-    subject(:result) { notifier.notify(message) }
-    let(:message) { SecureRandom.hex }
-
-    it 'emits the message as a warning' do
-      result
-      expect($stderr.string).to eql("#{message}\n")
-    end
-
-    context 'with a format' do
-      let(:format) { '> %s <' }
-
-      it 'formats the message' do
-        result
-        expect($stderr.string).to eql("> #{message} <\n")
-      end
-    end
-  end
-end