faulty 0.1.0 → 0.2.0

data/lib/faulty/events/listener_interface.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Events
     # The interface required to implement a event listener
     #

data/lib/faulty/events/log_listener.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Events
     # A default listener that logs Faulty events
     class LogListener

data/lib/faulty/events/notifier.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Events
     # The default event dispatcher for Faulty
     class Notifier
@@ -11,6 +11,9 @@ module Faulty
 
       # Notify all listeners of an event
       #
+      # If a listener raises an error while handling an event, that error will
+      # be captured and written to STDERR.
+      #
       # @param event [Symbol] The event name
       # @param payload [Hash] A hash of event payload data. The payload keys
       #   differ between events, but should be consistent across calls for a
@@ -18,7 +21,13 @@ module Faulty
       def notify(event, payload)
         raise ArgumentError, "Unknown event #{event}" unless EVENTS.include?(event)
 
-        @listeners.each { |l| l.handle(event, payload) }
+        @listeners.each do |listener|
+          begin
+            listener.handle(event, payload)
+          rescue StandardError => e
+            warn "Faulty listener #{listener.class.name} crashed: #{e.message}"
+          end
+        end
       end
     end
   end

data/lib/faulty/immutable_options.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   # A struct that cannot be modified after initialization
   module ImmutableOptions
     # @param hash [Hash] A hash of attributes to initialize with

data/lib/faulty/result.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   # An approximation of the `Result` type from some strongly-typed languages.
   #
   # F#: https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/results
@@ -53,7 +53,7 @@ module Faulty
     #
     # @param ok An ok value
     # @param error [Error] An error instance
-    def initialize(ok: NOTHING, error: NOTHING) # rubocop:disable Naming/MethodParameterName
+    def initialize(ok: NOTHING, error: NOTHING)
       if ok.equal?(NOTHING) && error.equal?(NOTHING)
         raise ArgumentError, 'Result must have an ok or error value'
       end

data/lib/faulty/status.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   # The status of a circuit
   #
   # Includes information like the state and locks. Also calculates

data/lib/faulty/storage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   # The namespace for Faulty storage
   module Storage
   end

data/lib/faulty/storage/fault_tolerant_proxy.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Storage
     # A wrapper for storage backends that may raise errors
     #
-    # {Scope} automatically wraps all non-fault-tolerant storage backends with
+    # {Faulty#initialize} automatically wraps all non-fault-tolerant storage backends with
     # this class.
     #
     # If the storage backend raises a `StandardError`, it will be captured and
@@ -53,8 +53,8 @@ module Faulty
       # @see Interface#open
       # @param (see Interface#open)
       # @return (see Interface#open)
-      def open(circuit)
-        @storage.open(circuit)
+      def open(circuit, opened_at)
+        @storage.open(circuit, opened_at)
       rescue StandardError => e
         options.notifier.notify(:storage_failure, circuit: circuit, action: :open, error: e)
         false
@@ -65,8 +65,8 @@ module Faulty
       # @see Interface#reopen
       # @param (see Interface#reopen)
       # @return (see Interface#reopen)
-      def reopen(circuit)
-        @storage.reopen(circuit)
+      def reopen(circuit, opened_at, previous_opened_at)
+        @storage.reopen(circuit, opened_at, previous_opened_at)
       rescue StandardError => e
         options.notifier.notify(:storage_failure, circuit: circuit, action: :reopen, error: e)
         false
@@ -167,10 +167,8 @@ module Faulty
       # @return [Status] The stub status
       def stub_status(circuit)
         Faulty::Status.new(
-          cool_down: circuit.options.cool_down,
-          stub: true,
-          sample_threshold: circuit.options.sample_threshold,
-          rate_threshold: circuit.options.rate_threshold
+          options: circuit.options,
+          stub: true
         )
       end
     end

data/lib/faulty/storage/interface.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Storage
     # The interface required for a storage backend implementation
     #

data/lib/faulty/storage/memory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Storage
     # The default in-memory storage for circuits
     #
@@ -83,7 +83,7 @@ module Faulty
         memory = fetch(circuit)
         memory.runs.borrow do |runs|
           runs.push([time, success])
-          runs.pop if runs.size > options.max_sample_size
+          runs.shift if runs.size > options.max_sample_size
         end
         memory.status(circuit.options)
       end

data/lib/faulty/storage/redis.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   module Storage
     class Redis # rubocop:disable Metrics/ClassLength
       # Separates the time/status for history entry strings
@@ -97,7 +97,7 @@ module Faulty
       # @return (see Interface#open)
       def open(circuit, opened_at)
         redis do |r|
-          opened = compare_and_set(r, state_key(circuit), ['closed', nil], 'open')
+          opened = compare_and_set(r, state_key(circuit), ['closed', nil], 'open', ex: options.circuit_ttl)
           r.set(opened_at_key(circuit), opened_at, ex: options.circuit_ttl) if opened
           opened
         end
@@ -110,7 +110,7 @@ module Faulty
       # @return (see Interface#reopen)
       def reopen(circuit, opened_at, previous_opened_at)
         redis do |r|
-          compare_and_set(r, opened_at_key(circuit), [previous_opened_at.to_s], opened_at)
+          compare_and_set(r, opened_at_key(circuit), [previous_opened_at.to_s], opened_at, ex: options.circuit_ttl)
         end
       end
 
@@ -121,7 +121,7 @@ module Faulty
       # @return (see Interface#close)
       def close(circuit)
         redis do |r|
-          closed = compare_and_set(r, state_key(circuit), ['open'], 'closed')
+          closed = compare_and_set(r, state_key(circuit), ['open'], 'closed', ex: options.circuit_ttl)
           r.del(entries_key(circuit)) if closed
           closed
         end
@@ -287,16 +287,16 @@ module Faulty
       # @param new [String] The new value to set if the compare passes
       # @return [Boolean] True if the value was set to `new`, false if the CAS
       #   failed
-      def compare_and_set(redis, key, old, new)
-        result = redis.watch(key) do
+      def compare_and_set(redis, key, old, new, ex:)
+        redis.watch(key) do
           if old.include?(redis.get(key))
-            redis.multi { |m| m.set(key, new) }
+            result = redis.multi { |m| m.set(key, new, ex: ex) }
+            result && result[0] == 'OK'
           else
             redis.unwatch
+            false
           end
         end
-
-        result[0] == 'OK'
       end
 
       # Yield a Redis connection

data/lib/faulty/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Faulty
+class Faulty
   # The current Faulty version
   def self.version
-    Gem::Version.new('0.1.0')
+    Gem::Version.new('0.2.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faulty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Howard
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,54 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.17'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.17'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -87,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: irb
+  name: honeybadger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -142,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -184,26 +108,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.38.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -218,21 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.25
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.25
-description:
+description: 
 email:
 - jmhoward0@gmail.com
 executables: []
@@ -244,6 +134,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -267,12 +158,12 @@ files:
 - lib/faulty/error.rb
 - lib/faulty/events.rb
 - lib/faulty/events/callback_listener.rb
+- lib/faulty/events/honeybadger_listener.rb
 - lib/faulty/events/listener_interface.rb
 - lib/faulty/events/log_listener.rb
 - lib/faulty/events/notifier.rb
 - lib/faulty/immutable_options.rb
 - lib/faulty/result.rb
-- lib/faulty/scope.rb
 - lib/faulty/status.rb
 - lib/faulty/storage.rb
 - lib/faulty/storage/fault_tolerant_proxy.rb
@@ -284,7 +175,7 @@ homepage: https://github.com/ParentSquare/faulty
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -299,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: Fault-tolerance tools for ruby based on circuit-breakers
 test_files: []