breakers 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a99dbaa5b10dc377c242f0707ca01e138e5119b5
-  data.tar.gz: f65d7cc872f4d76c2902362baab53c0a4825b73a
+  metadata.gz: 6eab277573c135bff307496a5ff60036e8e2d7e6
+  data.tar.gz: c1dfd133b1a41f3d9d6f10aede8cdce0265c43e2
 SHA512:
-  metadata.gz: 7a6fcda690f8eb2757cc3a82e5240c7b5d3cd3bec48a1e4f9c9e3bb32f2b7ae5c08b8b12c2215750187aac5623860f7e6b2aa0548c0b64fd9736d17ed1643aa2
-  data.tar.gz: 78e50c255536dcc2dfe3cb460197b4e1ac836cb7caa684341ac66e002b8f01927921eea3fb1011cc17f1ef6cc555b8126a26e047c35e25dcf45571fef96ceee9
+  metadata.gz: 869a21c2cd1296d8e98ae7f13dd80352f31af945491e8afc6f2d694c8d057873879c05933551035b2f071902b2a08b7164d2107b7a671507ce1831ec9dc9e098
+  data.tar.gz: 093725a48e5e68c0172cd5cfcfe9e1eb8ddff596501a26a055d27f322a1cba6db77c42296a55e7e309cbcc348414645fec630ea0d975e076c850f20d07047942

data/README.md

@@ -154,6 +154,15 @@ service.end_forced_outage!
 Unlike with outages detected by the middleware, forced outages are not periodically tested to see if they have completed and must be
 manually ended with a call to `end_forced_outage!`.
 
+### Changing the Outage Response
+
+By default, if you make a request against a service that is experiencing an outage a Breakers::OutageException will be raised. If you would
+prefer to receive a response with a certain status code instead, you can change that with:
+
+```ruby
+Breakers.outage_response = { type: :status_code, status_code: 503 }
+```
+
 ### Redis Data Structure
 
 Data is stored in Redis with the following structure:

data/lib/breakers.rb

@@ -1,5 +1,6 @@
 require 'breakers/client'
 require 'breakers/outage'
+require 'breakers/outage_exception'
 require 'breakers/service'
 require 'breakers/uptime_middleware'
 require 'breakers/version'
@@ -40,4 +41,21 @@ module Breakers
   def self.redis_prefix
     @redis_prefix || ''
   end
+
+  # Configure the middleware's handling of outages. The default is to raise a Breakers::OutageException
+  # but you can also request that the response comes back with a configurable status code.
+  #
+  # @param [Hash] opts A hash of options
+  # @option opts [Symbol] :type Pass :exception to raise a Breakers::OutageException when an error occurs. Pass :status_code to respond.
+  # @option opts [Integer] :status_code If the type is :status_code, configure which code to return.
+  def self.outage_response=(opts)
+    @outage_response = { type: :exception }.merge(opts)
+  end
+
+  # Query for the outage response configuration
+  #
+  # @return [Hash] configuration for the outage response, as defined in outage_response=
+  def self.outage_response
+    @outage_response || { type: :exception }
+  end
 end

data/lib/breakers/outage_exception.rb

@@ -0,0 +1,17 @@
+module Breakers
+  # The error that is raised when a request is made against a service that is
+  # experiencing an outage
+  class OutageException < StandardError
+    attr_reader :outage
+    attr_reader :service
+
+    def initialize(outage, service)
+      @outage = outage
+      @service = service
+    end
+
+    def message
+      "Outage detected on #{@service.name} beginning at #{@outage.start_time.to_i}"
+    end
+  end
+end

data/lib/breakers/uptime_middleware.rb

@@ -31,12 +31,16 @@ module Breakers
     protected
 
     def outage_response(outage:, service:)
-      Faraday::Response.new.tap do |response|
-        response.finish(
-          status: 503,
-          body: "Outage detected on #{service.name} beginning at #{outage.start_time.to_i}",
-          response_headers: {}
-        )
+      if Breakers.outage_response[:type] == :status_code
+        Faraday::Response.new.tap do |response|
+          response.finish(
+            status: Breakers.outage_response[:status_code],
+            body: "Outage detected on #{service.name} beginning at #{outage.start_time.to_i}",
+            response_headers: {}
+          )
+        end
+      else
+        raise Breakers::OutageException.new(outage, service)
       end
     end
 
@@ -60,13 +64,15 @@ module Breakers
         end
       end
     rescue => e
-      handle_error(
-        service: service,
-        request_env: request_env,
-        response_env: nil,
-        error: "#{e.class.name} - #{e.message}",
-        current_outage: current_outage
-      )
+      unless e.is_a?(Breakers::OutageException)
+        handle_error(
+          service: service,
+          request_env: request_env,
+          response_env: nil,
+          error: "#{e.class.name} - #{e.message}",
+          current_outage: current_outage
+        )
+      end
       raise
     end
 

data/lib/breakers/version.rb

@@ -1,3 +1,3 @@
 module Breakers
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breakers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Aubrey Holland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,6 +192,7 @@ files:
 - lib/breakers.rb
 - lib/breakers/client.rb
 - lib/breakers/outage.rb
+- lib/breakers/outage_exception.rb
 - lib/breakers/service.rb
 - lib/breakers/uptime_middleware.rb
 - lib/breakers/version.rb