faulty 0.1.0

data/bin/check-version

@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+
+set -e
+
+tag="$(git describe --abbrev=0 2>/dev/null || echo)"
+tag="${tag#v}"
+[ "$tag" = '' ] && exit 0
+
+tag_gt_version=$(ruby -r ./lib/faulty/version -e "puts Faulty.version >= Gem::Version.new('${tag}')")
+test "$tag_gt_version" = true

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'faulty'
+require 'byebug'
+require 'irb'
+
+# For default cache support
+require 'active_support'
+
+IRB.start

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/yard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/faulty.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 'faulty/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'faulty'
+  spec.version = Faulty.version
+  spec.authors = ['Justin Howard']
+  spec.email = ['jmhoward0@gmail.com']
+  spec.licenses = ['MIT']
+
+  spec.summary = 'Fault-tolerance tools for ruby based on circuit-breakers'
+  spec.homepage = 'https://github.com/ParentSquare/faulty'
+
+  spec.files = `git ls-files -z`
+    .split("\x0")
+    .reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency 'activesupport', '>= 4.2'
+  spec.add_development_dependency 'bundler', '>= 1.17', '< 3'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'connection_pool', '~> 2.0'
+  spec.add_development_dependency 'irb', '~> 1.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  spec.add_development_dependency 'redis', '~> 3.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
+  # 0.81 is the last rubocop version with Ruby 2.3 support
+  spec.add_development_dependency 'rubocop', '0.81.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.38.1'
+  # For now, code climate doesn't support simplecov 0.18
+  # https://github.com/codeclimate/test-reporter/issues/413
+  spec.add_development_dependency 'simplecov', '>= 0.17.1', '< 0.18'
+  spec.add_development_dependency 'timecop', '>= 0.9'
+  spec.add_development_dependency 'yard', '~> 0.9.25'
+end

data/lib/faulty.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'concurrent-ruby'
+
+require 'faulty/immutable_options'
+require 'faulty/cache'
+require 'faulty/circuit'
+require 'faulty/error'
+require 'faulty/events'
+require 'faulty/result'
+require 'faulty/scope'
+require 'faulty/status'
+require 'faulty/storage'
+
+# The top-level namespace for Faulty
+#
+# Fault-tolerance tools for ruby based on circuit-breakers
+module Faulty
+  class << self
+    # Start the Faulty environment
+    #
+    # This creates a global shared Faulty state for configuration and for
+    # re-using State objects.
+    #
+    # Not thread safe, should be executed before any worker threads
+    # are spawned.
+    #
+    # If you prefer dependency-injection instead of global state, you can skip
+    # init and pass a {Scope} directly to your dependencies.
+    #
+    # @param scope_name [Symbol] The name of the default scope. Can be set to
+    #   `nil` to skip creating a default scope.
+    # @param config [Hash] Attributes for {Scope::Options}
+    # @yield [Scope::Options] For setting options in a block
+    # @return [self]
+    def init(scope_name = :default, **config, &block)
+      raise AlreadyInitializedError if @scopes
+
+      @default_scope = scope_name
+      @scopes = Concurrent::Map.new
+      register(scope_name, Scope.new(**config, &block)) unless scope_name.nil?
+      self
+    rescue StandardError
+      @scopes = nil
+      raise
+    end
+
+    # Get the default scope given during {.init}
+    #
+    # @return [Scope, nil] The default scope if it is registered
+    def default
+      raise UninitializedError unless @scopes
+      raise MissingDefaultScopeError unless @default_scope
+
+      self[@default_scope]
+    end
+
+    # Get a scope by name
+    #
+    # @return [Scope, nil] The named scope if it is registered
+    def [](scope_name)
+      raise UninitializedError unless @scopes
+
+      @scopes[scope_name]
+    end
+
+    # Register a scope to the global Faulty state
+    #
+    # Will not replace an existing scope with the same name. Check the
+    # return value if you need to know whether the scope already existed.
+    #
+    # @param name [Symbol] The name of the scope to register
+    # @param scope [Scope] The scope to register
+    # @return [Scope, nil] The previously-registered scope of that name if
+    #   it already existed, otherwise nil.
+    def register(name, scope)
+      raise UninitializedError unless @scopes
+
+      @scopes.put_if_absent(name, scope)
+    end
+
+    # Get the options for the default scope
+    #
+    # @raise MissingDefaultScopeError If the default scope has not been created
+    # @return [Scope::Options]
+    def options
+      default.options
+    end
+
+    # Get or create a circuit for the default scope
+    #
+    # @raise UninitializedError If the default scope has not been created
+    # @param (see Scope#circuit)
+    # @yield (see Scope#circuit)
+    # @return (see Scope#circuit)
+    def circuit(name, **config, &block)
+      default.circuit(name, **config, &block)
+    end
+
+    # Get a list of all circuit names for the default scope
+    #
+    # @return [Array<String>] The circuit names
+    def list_circuits
+      options.storage.list
+    end
+
+    # The current time
+    #
+    # Used by Faulty wherever the current time is needed. Can be overridden
+    # for testing
+    #
+    # @return [Time] The current time
+    def current_time
+      Time.now.to_i
+    end
+  end
+end

data/lib/faulty/cache.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Faulty
+  # The namespace for Faulty caching
+  module Cache
+  end
+end
+
+require 'faulty/cache/default'
+require 'faulty/cache/fault_tolerant_proxy'
+require 'faulty/cache/mock'
+require 'faulty/cache/null'
+require 'faulty/cache/rails'

data/lib/faulty/cache/default.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faulty
+  module Cache
+    # The default cache implementation
+    #
+    # It tries to make a logical decision of what cache implementation to use
+    # based on the current environment.
+    #
+    # - If Rails is loaded, it will use Rails.cache
+    # - If ActiveSupport is available, it will use an `ActiveSupport::Cache::MemoryStore`
+    # - Otherwise it will use a {Faulty::Cache::Null}
+    class Default
+      def initialize
+        @cache = if defined?(::Rails)
+          Cache::Rails.new(::Rails.cache)
+        elsif defined?(::ActiveSupport::Cache::MemoryStore)
+          Cache::Rails.new(ActiveSupport::Cache::MemoryStore.new, fault_tolerant: true)
+        else
+          Cache::Null.new
+        end
+      end
+
+      # Read from the internal cache by key
+      #
+      # @param (see Cache::Interface#read)
+      # @return (see Cache::Interface#read)
+      def read(key)
+        @cache.read(key)
+      end
+
+      # Write to the internal cache
+      #
+      # @param (see Cache::Interface#read)
+      # @return (see Cache::Interface#read)
+      def write(key, value, expires_in: nil)
+        @cache.write(key, value, expires_in: expires_in)
+      end
+
+      # This cache is fault tolerant if the internal one is
+      #
+      # @return [Boolean]
+      def fault_tolerant?
+        @cache.fault_tolerant?
+      end
+    end
+  end
+end

data/lib/faulty/cache/fault_tolerant_proxy.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Faulty
+  module Cache
+    # A wrapper for cache backends that may raise errors
+    #
+    # {Scope} automatically wraps all non-fault-tolerant cache backends with
+    # this class.
+    #
+    # If the cache backend raises a `StandardError`, it will be captured and
+    # sent to the notifier.
+    class FaultTolerantProxy
+      attr_reader :options
+
+      # Options for {FaultTolerantProxy}
+      #
+      # @!attribute [r] notifier
+      #   @return [Events::Notifier] A Faulty notifier
+      Options = Struct.new(
+        :notifier
+      ) do
+        include ImmutableOptions
+
+        private
+
+        def required
+          %i[notifier]
+        end
+      end
+
+      # @param cache [Cache::Interface] The cache backend to wrap
+      # @param options [Hash] Attributes for {Options}
+      # @yield [Options] For setting options in a block
+      def initialize(cache, **options, &block)
+        @cache = cache
+        @options = Options.new(options, &block)
+      end
+
+      # Read from the cache safely
+      #
+      # If the backend raises a `StandardError`, this will return `nil`.
+      #
+      # @param (see Cache::Interface#read)
+      # @return [Object, nil] The value if found, or nil if not found or if an
+      #   error was raised.
+      def read(key)
+        @cache.read(key)
+      rescue StandardError => e
+        options.notifier.notify(:cache_failure, key: key, action: :read, error: e)
+        nil
+      end
+
+      # Write to the cache safely
+      #
+      # If the backend raises a `StandardError`, the write will be ignored
+      #
+      # @param (see Cache::Interface#write)
+      # @return [void]
+      def write(key, value, expires_in: nil)
+        @cache.write(key, value, expires_in: expires_in)
+      rescue StandardError
+        options.notifier.notify(:cache_failure, key: key, action: :write, error: e)
+        nil
+      end
+
+      # This cache makes any cache fault tolerant, so this is always `true`
+      #
+      # @return [true]
+      def fault_tolerant?
+        true
+      end
+    end
+  end
+end