slow_ride 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98df04ad0ae62d3f69aafc2908fbf5a83fdbe0365fa5236d335578a09daeb802
+  data.tar.gz: c62f23723655b807fe1d55862334eecf84ec327ab0a720d1597543f5669bdb78
+SHA512:
+  metadata.gz: 30f03d20f31902b63300c21bda56bd03fd4db4978051af08054ca8e7295bc982847a577cdbc69ca6583578aa619d48ccb8bfdd0ba4731adf5448aa683a36608f
+  data.tar.gz: b15981518c4e9522d44b1f51f5c4891329c159dbb9985c5e2307960ea5d063c4c11cae07d8e74b9687b4b95ec3d012a471c2677a96f8b35b47c35f5806803845

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jgaskins@hey.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slow_ride.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,96 @@
+# SlowRide
+
+When you've enabled a feature flag (for example, with [Flipper](https://github.com/jnunemaker/flipper) or [LaunchDarkly](https://launchdarkly.com)), what often follows is that a human being has to pay attention to error rates or, at the very least, respond to alerts about an increase in those error rates.
+
+With SlowRide, you can take it easy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slow_ride'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install slow_ride
+
+## Usage
+
+SlowRide was designed around the idea of pluggable backends. Right now, however, Redis is the only backend offered.
+
+### Redis
+
+SlowRide can use Redis to store the check and failure counts. To use it, load the SlowRide and Redis gems and define how you connect to Redis:
+
+```ruby
+require "redis"
+require "slow_ride"
+
+# The `redis` gem uses ENV["REDIS_URL"] by default, so if you use that env var
+# you can simply use `Redis.new` for your Redis block.
+SlowRide.enable_redis { Redis.new }
+```
+
+Define your feature by giving it a name, a failure threshold, a minimum number of checks (defaults to 1000), and a way to disable the feature flag.
+
+```ruby
+# If we reach 20% failures, shut off the feature.
+MY_FEATURE = SlowRide::Redis.new("my-feature", failure_threshold: 0.2) do
+  Flipper.disable "my-feature"
+end
+```
+
+You can also notify your team that the feature flag has been disabled:
+
+```ruby
+MY_FEATURE = SlowRide::Redis.new(:my_feature, failure_threshold: 0.2) do
+  Flipper.disable :my_feature
+  Slack.notify "#slow-ride", "Feature `my-feature` has exceeded 20% failures and has been disabled"
+end
+```
+
+Then, in your feature-flag code paths, you call `MY_FEATURE.check { ... }`:
+
+```ruby
+if Flipper.enabled? :my_feature
+  MY_FEATURE.check { new_hotness! }
+else
+  old_and_busted!
+end
+```
+
+_Please do not use this gem as a replacement for error reporting!_ I mean, you can do whatever you like and I can't stop you, but I'll be sad if you use it this way. The intent is that the block twiddles whatever bits it needs to in order to ensure the feature isn't checked anymore at all — such as by disabling a feature flag.
+
+You can also pass a couple other options:
+
+- `minimum_checks:` — the number of checks required to be run before SlowRide invokes the feature's block
+- `max_duration:` — the number of seconds to store the feature data in Redis
+
+#### Cleanup
+
+Redis-backed features will automatically clean up after themselves.
+
+- When a failure threshold is reached, the data is automatically deleted from Redis.
+- If a failure threshold is never reached before removing the feature flag from your code, the data will expire from Redis after a default duration of one week.
+
+You can override the max storage duration for any reason by passing `max_duration:` to the feature definition. The default is one week and assumes that feature checks will happen far more often than that. This way, you don't need to delete anything manually when you remove a feature flag from your codebase.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgaskins/slow_ride. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jgaskins/slow_ride/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the SlowRide project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jgaskins/slow_ride/blob/main/CODE_OF_CONDUCT.md).

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 "slow_ride"
+
+# 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/lib/slow_ride/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SlowRide
+  VERSION = "0.1.0"
+end

data/lib/slow_ride.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "connection_pool"
+
+require_relative "slow_ride/version"
+
+module SlowRide
+  Error = Class.new(StandardError)
+  RedisNotConfigured = Class.new(Error)
+
+  class << self
+    def enable_redis(max_connections: 25, &block)
+      @redis_pool = ConnectionPool.new(size: max_connections, &block)
+    end
+
+    def redis(&block)
+      if @redis_pool
+        @redis_pool.with(&block)
+      else
+        raise RedisNotConfigured, "Must configure Redis with `SlowRide.enable_redis { Redis.new(...) }`"
+      end
+    end
+  end
+
+  class Adapter
+    def initialize(failure_threshold:, minimum_checks: 1_000, &failure_handler)
+      @failure_threshold = failure_threshold
+      @minimum_checks = minimum_checks
+      @failure_handler = failure_handler
+    end
+
+    def check
+      checked_count = checked
+
+      begin
+        yield
+      rescue => ex
+        failed_count = failed
+
+        if checked_count >= @minimum_checks && failed_count.to_f / checked_count >= @failure_threshold
+          @failure_handler.call failed_count, checked_count
+          failure_threshold_exceeded failed: failed_count, checked: checked_count
+        end
+        raise ex
+      end
+    end
+
+    def failure_threshold_exceeded(failed:, checked:)
+    end
+  end
+
+  class Redis < Adapter
+    # The default expiration for a given key. We set it to a week and refresh
+    # the expiration each time a check is made.
+    #
+    # IT'S BEEN ...
+    ONE_WEEK = 60 * # seconds
+               60 * # minutes
+               24 * # hours
+               7    # days
+
+    def initialize(name, failure_threshold:, minimum_checks: 1_000, max_duration: ONE_WEEK, &failure_handler)
+      super failure_threshold: failure_threshold, minimum_checks: minimum_checks,  &failure_handler
+      @name = name
+      @max_duration = max_duration
+      @checked_key = "slow-ride:#{name}:checked"
+      @failed_key = "slow-ride:#{name}:failed"
+    end
+
+    def checked
+      SlowRide.redis do |redis|
+        redis.pipelined do |redis|
+          redis.incr @checked_key
+          redis.expire @checked_key, @max_duration
+          redis.expire @failed_key, @max_duration
+        end
+      end.first
+    end
+
+    def failed
+      SlowRide.redis { |redis| redis.incr @failed_key }
+    end
+
+    def failure_threshold_exceeded(failed:, checked:)
+      SlowRide.redis do |redis|
+        redis.pipelined do |redis|
+          redis.del @checked_key
+          redis.del @failed_key
+        end
+      end
+    end
+  end
+end

data/slow_ride.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/slow_ride/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "slow_ride"
+  spec.version = SlowRide::VERSION
+  spec.authors = ["Jamie Gaskins"]
+  spec.email = ["jgaskins@hey.com"]
+
+  spec.summary = "Check features"
+  spec.description = "check features"
+  spec.homepage = "https://github.com/jgaskins/slow_ride"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "connection_pool"
+  spec.add_development_dependency "redis"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: slow_ride
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: check features
+email:
+- jgaskins@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slow_ride.rb
+- lib/slow_ride/version.rb
+- slow_ride.gemspec
+homepage: https://github.com/jgaskins/slow_ride
+licenses: []
+metadata:
+  homepage_uri: https://github.com/jgaskins/slow_ride
+  source_code_uri: https://github.com/jgaskins/slow_ride
+  changelog_uri: https://github.com/jgaskins/slow_ride
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Check features
+test_files: []