protoboard 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3724f36f72e98c1dbb8fd27ee43700e8b878da75
+  data.tar.gz: 01aee471ca195a9b014cb3a2edd9888a381db783
+SHA512:
+  metadata.gz: 4e81f442a9d343e41cb861cd6bcb2500fead4ab51e24ba3c9375a1cfa8c99979421ab7b10b8bdd582469d648b085795cb2547caaca87a50fb3974d8e7f516a15
+  data.tar.gz: 6f74eda66ac8b853881201e614d59e3dd0fd4699e2382ceac90c6cbb50b0d33b3e914410d7d4675baacb094ee18b21e9177616c3b36e07cc4e355949f19c651f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Documentation:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - protoboard.gemspec
+
+Metrics/MethodLength:
+  Max: 15
+
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in protoboard.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    protoboard (0.1.0)
+      dry-configurable (~> 0.7.0)
+      stoplight (~> 2.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    rake (10.5.0)
+    redis (3.3.5)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    stoplight (2.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  protoboard!
+  rake (~> 10.0)
+  redis (~> 3.2)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# Protoboard
+
+[![Build Status](https://travis-ci.org/VAGAScom/protoboard.svg?branch=master)](https://travis-ci.org/VAGAScom/protoboard)
+
+Protoboard abstracts the way you use Circuit Breaker allowing you to easily use it with any Ruby Object, under the hood it uses the gem [stoplight](https://github.com/orgsync/stoplight) to create the circuits.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'protoboard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install protoboard
+
+## Usage
+
+The usage is really simple, just include `Protoboard::CircuitBreaker` and register your circuit.
+
+```ruby
+class MyFooService
+  include Protoboard::CircuitBreaker
+
+  register_circuits [:some_method],
+  options: {
+   service: 'my_cool_service',
+   open_after: 2,
+   cool_off_after: 3
+  }
+  def some_method
+    # Something that can break
+  end
+end
+```
+
+You can also define a fallback and callbacks for the circuit.
+
+```ruby
+class MyFooService
+  include Protoboard::CircuitBreaker
+
+  register_circuits [:some_method],
+  fallback: -> (error) { 'Do Something' }
+  on_before: [->(ce) { Something.notify("Circuit #{ce.circuit.name}") }, ->(_) {}],
+  on_after: [->(ce) { Something.notify("It fails with #{ce.error}") if ce.fail? }],
+  options: {
+   service: 'my_cool_service',
+   open_after: 2,
+   cool_off_after: 3
+  }
+  def some_method
+    # Something that can break
+  end
+end
+```
+
+Also if you want to add more than one method in the same class and customize the circuit name:
+
+```ruby
+class Foo4
+  include Protoboard::CircuitBreaker
+
+  register_circuits({ some_method: 'my_custom_name', other_method: 'my_other_custom_name' },
+    options: {
+      service: 'my_service_name',
+      open_after: 2,
+      cool_off_after: 3
+    })
+  def some_method
+    'OK'
+  end
+end
+```
+
+### Callbacks
+
+Any callback should receive one argument that it will be an instance of `CircuitExecution` class, that object will respond to the following methods:
+
+* `state` returns the current state of the circuit execution (`:not_started`, `:success` or `:fail`)
+* `value` returns the result value of the circuit execution, if the circuit fail the value will be `nil`.
+* `error` returns the error raised when the circuit fail, it will be `nil` if no error occurred
+* `circuit` returns a circuit instance which has the options configured in `register_circuits` (`name`, `service`, `open_after` and `cool_off_after`)
+* `fail?` returns `true` if the execution failed
+
+P.S: In before calbacks the state will always be `:not_started` and in after callbacks the state can be either `:fail` or `:success`
+
+### Check Services and Circuits Status
+
+If you want to check the services and circuits registered in Protoboard you can use `Protoboard::CircuitBreaker.services_healthcheck`, it will return a hash with the status of all circuits:
+
+```ruby
+{
+  'services' => {
+    'my_service_name' => {
+      'circuits' => {
+        'my_circuit1' => 'OK',
+        'my_circuit2' => 'NOT_OK'
+      }
+     }
+   }
+}
+
+```
+
+
+## Configuration
+
+In configuration you can customize the adapter options and set callbacks and configurations for all the Protoboard Circuits:
+
+```ruby
+
+Protoboard.configure do |config|
+  config.adapter = Protoboard::Adapters::StoplightAdapter
+
+  config.adapter.configure do |adapter|
+    adapter.data_store = :redis # Default is :memory 
+    adapter.redis_host = 'localhost'
+    adapter.redis_port = 1234
+  end
+  
+  #Global callbacks
+  config.callbacks.before = [->(_) {}]
+  config.callbacks.after = [MyCallableObject.new, ->(_) {}]
+end
+
+```
+
+The available options are:
+
+* `adapter =` Sets the adapter, `Protoboard::Adapters::StoplightAdapter` is the default
+* `callbacks.before =` Receives an array of callables, lambdas, procs or any object that responds to `call` and receives one argument. It will be called before each circuit execution.
+* `callbacks.after =` Receives an array of callables, lambdas, procs or any object that responds to `call` and receives one argument. It will be called after each circuit execution.
+
+### StoplightAdapter Options
+
+* `datastore =` Sets the datastore(:redis or :memory). The default option is :memory
+* `redis_host=` Sets the redis host
+* `redis_port=` Sets the redis port
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/VAGAScom/protoboard.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'protoboard'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  redis:
+    image: redis:alpine
+    volumes:
+      - redis-data:/data
+    ports:
+      - "6379:6379"
+
+volumes:
+  redis-data:

data/lib/protoboard.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+require 'protoboard/circuit_execution'
+require 'protoboard/adapters/base_adapter'
+require 'protoboard/adapters/stoplight_adapter'
+
+require 'protoboard/version'
+require 'protoboard/helpers/validate_callbacks'
+require 'protoboard/refinements/string_extensions'
+require 'protoboard/helpers/services_healthcheck_generator'
+require 'protoboard/configuration'
+require 'protoboard/circuit_breaker'
+require 'protoboard/circuit'
+require 'protoboard/circuit_proxy_factory'
+require 'protoboard/errors/invalid_callback'
+
+##
+# This module is the entry to get or set the configuration needed by the gem.
+module Protoboard
+  ##
+  # Returns the current configuration
+  def self.config
+    Protoboard::Configuration
+  end
+
+  ##
+  # Does the configuration needed by the gem
+  def self.configure(&block)
+    config.configure(&block)
+  end
+end

data/lib/protoboard/adapters/base_adapter.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Protoboard
+  module Adapters
+    ##
+    # This class is responsible to encapsulate every action that are commom between all adapters
+    class BaseAdapter
+      class << self
+        ##
+        # Manages the execution of the code intended to run before circuit execution
+        def execute_before_circuit_callbacks(circuit_execution)
+          before_global_callback(circuit_execution)
+          before_circuit_callback(circuit_execution)
+        end
+
+        ##
+        # Manages the execution of the code intended to run after circuit execution
+        def execute_after_circuit_callbacks(circuit_execution)
+          after_global_callback(circuit_execution)
+          after_circuit_callback(circuit_execution)
+        end
+
+        private
+        ##
+        # Calls the code intended to run before all circuit execution
+        def before_global_callback(circuit_execution)
+          Protoboard.config.callbacks.before.each do |callback|
+            callback.call(circuit_execution)
+          end
+        end
+
+        ##
+        # Calls the code intended to run before a circuit execution
+        def before_circuit_callback(circuit_execution)
+          circuit_execution.circuit.on_before.each do |callback|
+            callback.call(circuit_execution)
+          end
+        end
+
+        ##
+        # Calls the code intended to run after all circuit execution
+        def after_global_callback(circuit_execution)
+          Protoboard.config.callbacks.after.each do |callback|
+            callback.call(circuit_execution)
+          end
+        end
+
+        ##
+        # Calls the code intended to run after a circuit execution
+        def after_circuit_callback(circuit_execution)
+          circuit_execution.circuit.on_after.each do |callback|
+            callback.call(circuit_execution)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/protoboard/adapters/stoplight_adapter.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'stoplight'
+module Protoboard
+  module Adapters
+    ##
+    # This class manages every aspect for the execution of a circuit using the gem stoplight
+    class StoplightAdapter < BaseAdapter
+      ##
+      # This class represents the configuration needed to configure the gem stoplight.
+      class Configuration
+        extend Dry::Configurable
+
+        setting :data_store, :memory
+        setting :redis_host
+        setting :redis_port
+      end
+
+      def initialize
+        prepare_data_store
+      end
+
+      class << self
+        ##
+        # This methods is used to make it easier to access adapter configurations
+        def configure(&block)
+          Configuration.configure(&block)
+        end
+
+        ##
+        # This method is used to make it easier to access adapter data store configuration
+        def data_store
+          Configuration.config.data_store
+        end
+
+        ##
+        # This method is used to make it easier to access adapter redis host configuration
+        def redis_host
+          Configuration.config.redis_host
+        end
+
+        ##
+        # This method is used to make it easier to access adapter redis port configuration
+        def redis_port
+          Configuration.config.redis_port
+        end
+
+        ##
+        # Runs the circuit using stoplight
+        def run_circuit(circuit, &block)
+          prepare_data_store
+
+          circuit_execution = Protoboard::CircuitExecution.new(circuit)
+
+          execute_before_circuit_callbacks(circuit_execution)
+
+          stoplight = Stoplight(circuit.name, &block)
+                      .with_threshold(circuit.open_after)
+                      .with_cool_off_time(circuit.cool_off_after)
+
+          stoplight.with_fallback(&circuit.fallback) if circuit.fallback
+          value = stoplight.run
+
+          circuit_execution = ::Protoboard::CircuitExecution.new(circuit, state: :success, value: value)
+          execute_after_circuit_callbacks(circuit_execution)
+
+          value
+        rescue StandardError =>  exception
+          circuit_execution = Protoboard::CircuitExecution.new(circuit, state: :fail, error: exception)
+          execute_after_circuit_callbacks(circuit_execution)
+
+          raise circuit_execution.error if circuit_execution.fail?
+        end
+
+        # Returns the state of a circuit
+        #
+        # ==== States returned
+        #
+        # * +OK+ - when that stoplight circuit is green
+        # * +NOT_OK+ - when that stoplight circuit is yellow or red
+        def check_state(circuit_name)
+          mapper = { 'yellow' => 'NOT_OK', 'green' => 'OK', 'red' => 'NOT_OK' }
+          mapper[Stoplight(circuit_name).color]
+        end
+
+        private
+
+        def prepare_data_store
+          @prepare_data_store ||= case Configuration.config.data_store
+                                  when :redis
+                                    require 'redis'
+                                    redis_host = Configuration.config.redis_host
+                                    redis_port = Configuration.config.redis_port
+                                    redis = Redis.new(host: redis_host, port: redis_port)
+                                    data_store = Stoplight::DataStore::Redis.new(redis)
+                                    Stoplight::Light.default_data_store = data_store
+                                  else
+                                    Stoplight::Light.default_data_store = Stoplight::DataStore::Memory.new
+                                  end
+        end
+      end
+    end
+  end
+end

data/lib/protoboard/circuit.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Protoboard
+  ##
+  # This class represents a circuit.
+  class Circuit
+    attr_reader :name, :service,
+                :method_name, :timeout,
+                :open_after, :cool_off_after,
+                :on_before, :on_after,
+                :fallback
+
+    def initialize(**options)
+      @name = options.fetch(:name)
+      @service = options.fetch(:service)
+      @method_name = options.fetch(:method_name)
+      @timeout = options.fetch(:timeout)
+      @open_after = options.fetch(:open_after)
+      @cool_off_after = options.fetch(:cool_off_after)
+      @fallback = options[:fallback]
+      @on_before = options.fetch(:on_before, [])
+      @on_after = options.fetch(:on_after, [])
+    rescue KeyError => error
+      raise ArgumentError, "Missing required arguments: #{error.message}"
+    end
+  end
+end

data/lib/protoboard/circuit_breaker.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Protoboard
+  ##
+  # This module is responsible to manage the circuits.
+  module CircuitBreaker
+    module ClassMethods
+      ##
+      # Registers a list of circuits to be executed
+      #
+      # ==== Attributes
+      #
+      # * +circuit_methods+ - An array of symbols representing the names of the methods to be on a circuit 
+      #   or a hash containing a key with a symbol representing the name of the method and the value as the name of the circuit.
+      # * +on_before+ - An array of callable objects with code to be executed before each circuit runs
+      # * +on_after+ - An array of callable objects with code to be executed after each circuit runs
+      # * +options+ - A hash containing the options needed for the circuit to execute
+      # *   +:service+ - A string representing the name of the service for the circuit
+      # *   +:open_after+ - An integer representing the number of errors to occur for the circuit to be opened
+      # *   +:cool_off_after+ - An integer representing the number of successful requests to occur for the circuit to be closed
+      #
+      #   ==== Example
+      #   options: {
+      #     service: 'my_cool_service',
+      #     open_after: 2,
+      #     cool_off_after: 3
+      #   }
+      #   ====
+      #
+      # * +fallback+ - A callable object with code to be executed as an alternative plan if the code of the circuit fails
+      def register_circuits(circuit_methods, on_before: [], on_after: [], options:, fallback: nil)
+        Protoboard::Helpers::VALIDATE_CALLBACKS.call(on_before)
+        Protoboard::Helpers::VALIDATE_CALLBACKS.call(on_after)
+
+        circuits = Protoboard::CircuitBreaker.create_circuits(
+          circuit_methods,
+          options.merge(
+            fallback: fallback,
+            on_before: on_before,
+            on_after: on_after
+          )
+        )
+
+        circuits.each do |circuit|
+          Protoboard::CircuitBreaker.add_circuit circuit
+        end
+
+        proxy_module = Protoboard::CircuitBreaker.create_circuit_proxy(circuits, name)
+        prepend proxy_module
+      end
+    end
+
+    class << self
+      ##
+      # Returns a hash with the +circuits+ names and its states.
+      def services_healthcheck
+        Protoboard::Helpers::ServicesHealthcheckGenerator.new.call
+      end
+
+      ##
+      # Returns a list of registered +circuits+.
+      def registered_circuits
+        circuits
+      end
+
+      ##
+      # Adds a +circuit+ to the list of registered +circuits+.
+      def add_circuit(circuit)
+        circuits << circuit
+      end
+
+      ##
+      # Returns a list of +circuits+.
+      def circuits
+        @circuits ||= []
+      end
+
+      ##
+      # Calls the module responsible for creating the proxy module that will execute the circuit.
+      def create_circuit_proxy(circuits, class_name)
+        CircuitProxyFactory.create_module(circuits, class_name)
+      end
+
+      ##
+      # Creates a new +circuit+.
+      def create_circuits(circuit_methods, options)
+        circuit_hash = case circuit_methods
+                       when Array
+                         circuit_methods.reduce({}) do |memo, value|
+                           memo.merge(value.to_sym => "#{formatted_namespace}#{options[:service]}\##{value}")
+                         end
+                       when Hash
+                         circuit_methods
+                       else
+                         raise ArgumentError, 'Invalid input for circuit methods'
+                       end
+        circuit_hash.map do |circuit_method, circuit_name|
+          Circuit.new({ name: circuit_name, method_name: circuit_method }.merge(options))
+        end
+      end
+
+      def included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      private
+
+      ##
+      # Formats the namespace considering the configuration given when the gem starts
+      def formatted_namespace
+        !Protoboard.config.namespace.empty? ? "#{Protoboard.config.namespace}/" : ''
+      end
+    end
+  end
+end

data/lib/protoboard/circuit_execution.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Protoboard
+  ##
+  # This class represents a circuit execution.
+  class CircuitExecution
+    STATES = %i[not_started success fail].freeze
+
+    attr_reader :circuit, :state, :value, :error
+
+    def initialize(circuit, state: :pending, value: nil, error: nil)
+      @circuit = circuit
+      @state = state
+      @value = value
+      @error = error
+    end
+
+    def fail?
+      @state == :fail
+    end
+  end
+end

data/lib/protoboard/circuit_proxy_factory.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Protoboard
+  ##
+  # This module is responsible to manage a proxy module that executes the circuit.
+  module CircuitProxyFactory
+    class << self
+      using Protoboard::Refinements::StringExtensions
+      ##
+      # Creates the module that executes the circuit
+      def create_module(circuits, class_name)
+        module_name = infer_module_name(class_name, circuits.map(&:method_name))
+        proxy_module = Module.new
+
+        proxy_module.instance_exec do
+          circuits.each do |circuit|
+            define_method(circuit.method_name) do |*args|
+              Protoboard.config.adapter.run_circuit(circuit) { super(*args) }
+            end
+          end
+        end
+
+        Protoboard.const_set(module_name, proxy_module)
+      end
+
+      private
+
+      ##
+      # Formats the module name
+      def infer_module_name(class_name, methods)
+        "#{methods.map(&:to_s).map { |method| method.camelize }.join}#{class_name.split('::').join('')}CircuitProxy"
+      end
+    end
+  end
+end

data/lib/protoboard/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Protoboard
+  ##
+  # This class represents the configuration needed to run the gem.
+  class Configuration
+    extend Dry::Configurable
+
+    setting :adapter, Protoboard::Adapters::StoplightAdapter, reader: true
+
+    setting :namespace, '', reader: true
+
+    setting :callbacks, reader: true do
+      setting :before, [], reader: true, &Protoboard::Helpers::VALIDATE_CALLBACKS
+
+      setting :after, [], reader: true, &Protoboard::Helpers::VALIDATE_CALLBACKS
+    end
+  end
+end

data/lib/protoboard/errors/invalid_callback.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Protoboard
+  module Errors
+    class InvalidCallback < StandardError
+      DEFAULT_MESSAGE = 'All callbacks should respond to #call and receive one argument'
+      def initialize(msg = DEFAULT_MESSAGE); end
+    end
+  end
+end

data/lib/protoboard/helpers/services_healthcheck_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Protoboard
+  module Helpers
+    ##
+    # This class is responsible to generate information about the +circuits+ added
+    class ServicesHealthcheckGenerator
+
+      ##
+      # Verifies the list of +circuits+ added and returns a hash with the +circuits names+ and its states.
+      #
+      #   ==== Examples
+      #   'services' => {
+      #    'my_service_name' => {
+      #       'circuits' => {
+      #         'my_service_name#some_method' => 'OK',
+      #         'my_custom_name' => 'NOT_OK'
+      #       }
+      #     }
+      #   }
+      #  ====
+      #
+      def call
+        circuits_hash = Protoboard::CircuitBreaker.registered_circuits.map do |circuit|
+          state = Protoboard.config.adapter.check_state(circuit.name)
+
+          { name: circuit.name, status: state, service: circuit.service }
+        end
+        services_hash = circuits_hash
+                        .group_by { |circuit| circuit[:service] }
+                        .map do |service, circuits_hash|
+          circuits = circuits_hash.each_with_object({}) { |circuit, memo| memo[circuit[:name]] = circuit[:status] }
+          { service => { 'circuits' => circuits } }
+        end.reduce(:merge)
+
+        { 'services' => services_hash }
+      end
+    end
+  end
+end

data/lib/protoboard/helpers/validate_callbacks.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Protoboard
+  module Helpers
+    VALIDATE_CALLBACKS = lambda do |callbacks|
+      callbacks.each do |callback|
+        case callback
+        when Proc
+          raise Errors::InvalidCallback if callback.arity != 1
+        else
+          raise Errors::InvalidCallback if !callback.respond_to?(:call) || callback.method(:call).arity != 1
+        end
+      end
+
+      callbacks
+    end
+  end
+end

data/lib/protoboard/refinements/string_extensions.rb

@@ -0,0 +1,12 @@
+module Protoboard
+  module Refinements
+    module StringExtensions
+      refine String do
+        def camelize
+          string = sub(/^[a-z\d]*/) { $&.capitalize }
+          string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+        end
+      end
+    end
+  end
+end

data/lib/protoboard/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Protoboard
+  VERSION = '0.1.1'
+end

data/protoboard.gemspec

@@ -0,0 +1,43 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'protoboard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'protoboard'
+  spec.version       = Protoboard::VERSION
+  spec.authors       = ['Carlos Atkinson', 'Kelly Bhering']
+  spec.email         = ['carlos.atks@gmail.com', 'kellybhering@hotmail.com']
+
+  spec.summary       = 'Protoboard abstracts the way you use Circuit Breaker' \
+                       'allowing you to easily use it with any Ruby Object'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-configurable', '~> 0.7.0'
+  spec.add_dependency 'stoplight', '~> 2.1.3'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redis', '~> 3.2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: protoboard
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Carlos Atkinson
+- Kelly Bhering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: stoplight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- carlos.atks@gmail.com
+- kellybhering@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/protoboard.rb
+- lib/protoboard/adapters/base_adapter.rb
+- lib/protoboard/adapters/stoplight_adapter.rb
+- lib/protoboard/circuit.rb
+- lib/protoboard/circuit_breaker.rb
+- lib/protoboard/circuit_execution.rb
+- lib/protoboard/circuit_proxy_factory.rb
+- lib/protoboard/configuration.rb
+- lib/protoboard/errors/invalid_callback.rb
+- lib/protoboard/helpers/services_healthcheck_generator.rb
+- lib/protoboard/helpers/validate_callbacks.rb
+- lib/protoboard/refinements/string_extensions.rb
+- lib/protoboard/version.rb
+- protoboard.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Protoboard abstracts the way you use Circuit Breakerallowing you to easily
+  use it with any Ruby Object
+test_files: []