stoplight 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e500fe8c6d34e694cfbc2c46540a445eb997f89a
-  data.tar.gz: ec03f4f69321194449e3e0918183c6cbea4f9e2b
+  metadata.gz: e5bb148c31a3c94f65125fba1628f7399755c74d
+  data.tar.gz: ed907f0fcfee16fbb9a760d863f47f0d89341d69
 SHA512:
-  metadata.gz: 8b6f647cb561a37f14e44054b2549defcf1f72df27c0d8ba93c39d98b13d1b3f44c34b5c10070aa4d9c5d5d7c4b438983a532531bbad253605769b6a53925bdf
-  data.tar.gz: 75a107deca63c8fca90ec6466f66b98524af37263750d77ae06526a280331f65de4a83e1647ad41ef568c6afa7e103241d070ebe5fedd23d6b41dcbf312514e2
+  metadata.gz: 73b02ee787610aef6491804b789c449fc91ed49ba6c511d800e7119178b120dcc9f87341838eb0b28ce4acb880ee2d67d956cedce1883c1cd49b76feccb5c699
+  data.tar.gz: 567b87080e6cd46487e09ea136319317aeebd6f0042f1b2e60aa5438d13f92cf99f2f42af76097609c35201903beac2c8d96f9ec912f5e7b220a25763ce8f2c1

data/CHANGELOG.md

@@ -1,10 +1,25 @@
 # Changelog
 
+## v0.3.1 (2014-09-12)
+
+- Replaced `Stoplight::Failure#error` with `#error_class` and `#error_message`.
+  Also changed the constructor to take the class and the message instead of the
+  error.
+
 ## v0.3.0 (2014-09-11)
 
 - Allowed formatting notifications.
 - Added automatic recovery from red lights.
 - Added `Stoplight::DataStore#clear_stale` for clearing stale lights.
+- Removed forwarded methods on `Stoplight` module.
+- Moved some methods from `Stoplight::DataStore::Base` to
+  `Stoplight::DataStore`.
+- Renamed `Stoplight::DataStore::Base#purge` to `#clear_stale`.
+- Renamed `Stoplight::DataStore::Base#delete` to `#clear`.
+- Prefixed data store getters with `get_`.
+- Added `Stoplight::DataStore::Base#sync`.
+- Changed `Stoplight::DataStore::Base#get_failures` to return actual failures
+  (`Stoplight::Failure`) instead of strings.
 
 ## v0.2.1 (2014-08-20)
 

data/README.md

@@ -30,7 +30,7 @@ Check out [stoplight-admin][12] for controlling your stoplights.
 Add it to your Gemfile:
 
 ``` rb
-gem 'stoplight', '~> 0.3.0'
+gem 'stoplight', '~> 0.3.1'
 ```
 
 Or install it manually:
@@ -225,7 +225,8 @@ Stoplight::Error::RedLight: example-6
 ### Custom timeout
 
 Stoplights will automatically attempt to recover after a certain amount of time.
-This timeout is customizable.
+A light in the red state for longer than the timeout will transition to the
+yellow state. This timeout is customizable.
 
 ``` irb
 >> light = Stoplight::Light.new('example-7') { fail }.

data/lib/stoplight.rb

@@ -15,7 +15,7 @@ require 'stoplight/notifier/standard_error'
 
 module Stoplight
   # @return [Gem::Version]
-  VERSION = Gem::Version.new('0.3.0')
+  VERSION = Gem::Version.new('0.3.1')
 
   @data_store = DataStore::Memory.new
   @notifiers = [Notifier::StandardError.new]

data/lib/stoplight/failure.rb

@@ -1,36 +1,51 @@
 # coding: utf-8
 
 require 'json'
+require 'time'
 
 module Stoplight
   class Failure
-    # @return [Exception]
-    attr_reader :error
+    # @return [String]
+    attr_reader :error_class
+
+    # @return [String]
+    attr_reader :error_message
 
     # @return [Time]
     attr_reader :time
 
+    # @param error [Exception]
+    def self.create(error)
+      new(error.class.name, error.message)
+    end
+
+    # @param json [String]
     def self.from_json(json)
       h = JSON.parse(json)
-
-      match = /#<(.+): (.+)>/.match(h['error'])
-      error = Object.const_get(match[1]).new(match[2]) if match
-
-      time = Time.parse(h['time'])
-
-      new(error, time)
+      new(
+        h['error']['class'],
+        h['error']['message'],
+        Time.parse(h['time']))
+    rescue => error
+      new(Error::InvalidFailure.name, error.message)
     end
 
-    # @param error [Exception]
-    def initialize(error, time = nil)
-      @error = error
+    # @param error_class [String]
+    # @param error_message [String]
+    # @param time [Time, nil]
+    def initialize(error_class, error_message, time = nil)
+      @error_class = error_class
+      @error_message = error_message
       @time = time || Time.now
     end
 
     def to_json(*args)
       {
-        error: @error.inspect,
-        time: time.inspect
+        error: {
+          class: error_class,
+          message: error_message
+        },
+        time: time.iso8601
       }.to_json(*args)
     end
   end

data/lib/stoplight/light.rb

@@ -131,7 +131,7 @@ module Stoplight
       if error_allowed?(error)
         Stoplight.data_store.clear_failures(name)
       else
-        Stoplight.data_store.record_failure(name, Failure.new(error))
+        Stoplight.data_store.record_failure(name, Failure.create(error))
       end
     end
 

data/spec/stoplight/failure_spec.rb

@@ -3,25 +3,56 @@
 require 'spec_helper'
 
 describe Stoplight::Failure do
-  subject(:failure) { described_class.new(error, time) }
-  let(:error) { error_class.new(error_message) }
-  let(:error_class) { StandardError }
+  subject(:failure) { described_class.new(error_class, error_message, time) }
+  let(:error_class) { SecureRandom.hex }
   let(:error_message) { SecureRandom.hex }
   let(:time) { Time.now }
 
+  describe '.create' do
+    subject(:result) { described_class.create(error) }
+    let(:error) { error_class.new(error_message) }
+    let(:error_class) { Class.new(StandardError) }
+
+    it 'creates a failure' do
+      expect(result).to be_a(Stoplight::Failure)
+      expect(result.error_class).to eql(error.class.name)
+      expect(result.error_message).to eql(error.message)
+      expect(result.time).to be_within(1).of(Time.now)
+    end
+  end
+
   describe '.from_json' do
     subject(:result) { described_class.from_json(json) }
     let(:json) { failure.to_json }
 
-    it do
-      expect(result.error).to eq(failure.error)
+    it 'can be round-tripped' do
+      expect(result.error_class).to eq(failure.error_class)
+      expect(result.error_message).to eq(failure.error_message)
       expect(result.time).to be_within(1).of(failure.time)
     end
+
+    context 'with invalid JSON' do
+      let(:json) { nil }
+
+      it 'does not raise an error' do
+        expect { result }.to_not raise_error
+      end
+
+      it 'returns a self-describing invalid failure' do
+        expect(result.error_class).to eq('Stoplight::Error::InvalidFailure')
+        expect(result.error_message).to end_with('nil into String')
+        expect(result.time).to be_within(1).of(Time.now)
+      end
+    end
   end
 
   describe '#initialize' do
-    it 'sets the error' do
-      expect(failure.error).to eql(error)
+    it 'sets the error class' do
+      expect(failure.error_class).to eql(error_class)
+    end
+
+    it 'sets the error message' do
+      expect(failure.error_message).to eql(error_message)
     end
 
     it 'sets the time' do
@@ -40,10 +71,12 @@ describe Stoplight::Failure do
   describe '#to_json' do
     subject(:json) { failure.to_json }
     let(:data) { JSON.load(json) }
+    let(:time) { Time.utc(2001, 2, 3, 4, 5, 6) }
 
     it 'converts to JSON' do
-      expect(data['error']).to eql(error.inspect)
-      expect(data['time']).to eql(time.inspect)
+      expect(data['error']['class']).to eql(error_class)
+      expect(data['error']['message']).to eql(error_message)
+      expect(data['time']).to eql('2001-02-03T04:05:06Z')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Cameron Desautels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips