rollout-redis 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d7d811416500c11c77ca8c8490d301c0ce266db5dc6e7967e07c25e435be454
-  data.tar.gz: c8e76ea2823845c3c3ef2d1929e4e1e75d0f19688ac99b5e4a6e903dae3a57ec
+  metadata.gz: 3cbcf193e2048b5dfd5e694a7556844e7d7d9c4aa7426b6f0583a589f7fc8b70
+  data.tar.gz: 62d2b603c6a59495c6eca0816cdda4a2ba8b6944544e572a80f208af3c821615
 SHA512:
-  metadata.gz: e03a813c99336b16cdee142457f04e56a3cb12b8292f95034a583cd79ae12e97b9586db54cb3070d297bf762259acdb3a9026496124a1a6a40dbcf880fd4433d
-  data.tar.gz: 632ad6cf617ba379149383ad21e1033d5c6c3c12f9f8de58b1c1465d1440e957760f7ac4c15c011886dd9b188c73f2387b16d7cc144f4ece16446183f8dfcc21
+  metadata.gz: cae46805987da343fc78d1ec937a8a42c793eb09dce7dd98aeec2f33f0a615500324ba901e4585a34aa7f64a021766021bf8d942197443e0820005881f3151fd
+  data.tar.gz: c679e1a883c8ec708325f3a1a628dc125b9df9d0e014c2b67b7f479b700c10264db42abbf14561052dc19ee4b49564a11e9705744db4cbc146f8f17295b45032

data/CHANGELOG.md

@@ -5,6 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [0.3.0] - 2023-10-24
+
+### Added
+- Providing some rake tasks to the consumers of the gem for allowing them to easily manage their feature flags in their applications:
+    - `bundle exec rake rollout:on` rake task for activating feature flags
+    - `bundle exec rake rollout:off` rake task for deactivating feature flags
+    - `bundle exec rake rollout:list` rake task for listing stored feature flags
+
+## [0.2.0] - 2023-10-23
+
+### Added
+
+- `#features` method for listing all the feature flags stored in Redis
+
 ## [0.1.0] - 2023-10-23
 
 - Initial version

data/README.md

@@ -1,4 +1,4 @@
-# rollout-redis 🚀
+# rollout-redis ⛳️
 
 [![Gem Version](https://badge.fury.io/rb/rollout-redis.svg)](https://badge.fury.io/rb/rollout-redis)
 
@@ -14,6 +14,7 @@ Topics covered in this README:
   - [Gradual activation based on percentages](#gradual-activation-based-on-percentages)
   - [Caching Feature Flags](#caching-feature-flags)
   - [Auto-deactivating flags](#auto-deactivating-flags)
+- [Rake tasks](#rake-tasks)
 - [Migrating from rollout gem](#migrating-from-rollout-gem-🚨)
 - [Changelog](#changelog)
 - [Contributing](#contributing)
@@ -67,6 +68,22 @@ If there is an issue, you have the option to disable a feature:
 @rollout.deactivate('FEATURE_FLAG_NAME')
 ```
 
+If you want to list all the stored feature flags, you can use the `features` method:
+
+```ruby
+@rollout.features
+```
+
+The response will be an array of hashes with all the information about the stored feature flags
+
+```ruby
+[
+  { name: 'a-feature-flag', percentage: 100, data: { requests: 50, errors: 1 } },
+  { name: 'another-feature-flag', percentage: 20, data: { requests: 1, errors: 0 } },
+  { name: 'super-feature-flag', percentage: 50, data: { requests: 828, errors: 34 } }
+]
+```
+
 ## Advanced features 🦾
 
 ### Gradual activation based on percentages
@@ -143,6 +160,39 @@ end
 
 When any unexpected error appears during the wrapped code execution, the Rollout gem will take it into account for automatically deactivating the feature flag if the threshold of errors is reached. All the managed or captured errors inside the wrapped code will not be taken into consideration.
 
+## Rake tasks
+
+In order to have access to the rollout rakes, you have to load manually the task definitions. For doing so load the rollout rake task:
+
+```ruby
+require 'rollout'
+
+load 'rollout/tasks/rollout.rake'
+```
+
+### Usage
+
+To activate/deactivate features, execute the following rake tasks:
+
+```shell
+bundle exec rake rollout:on[feature_name]
+bundle exec rake rollout:off[feature_name]
+```
+
+To a gradual activation based on percentages, pass the percentage as the second parameter when executing the `on` task.
+
+```shell
+bundle exec rake rollout:on[feature_name,50]
+```
+
+_NOTE_: In both cases, `feature_name` **must not** include quotes e.g. `bundle exec rake rollout:on['feature_name']`, as the gem will be unable to fetch its activation status if so.
+
+For listing all the stored feature flags, do:
+
+```shell
+bundle exec rake rollout:list
+```
+
 ## Migrating from rollout gem 🚨
 
 If you are currently using the unmaintained [rollout](https://github.com/fetlife/rollout) gem, you should consider checking this [migration guide](https://github.com/jcagarcia/rollout-redis/blob/main/MIGRATING_FROM_ROLLOUT_GEM.md) for start using the new `rollout-redis` gem.

data/lib/rollout/feature.rb

@@ -46,6 +46,17 @@ class Rollout
       def errors
         @data[:errors] || 0
       end
+
+      def to_h
+        {
+          name: @name,
+          percentage: @percentage,
+          data: {
+            requests: requests,
+            errors: errors
+          }
+        }
+      end
   
       private
   

data/lib/rollout/tasks/rollout.rake

@@ -0,0 +1,63 @@
+
+namespace :rollout do
+  desc "Activate a feature"
+  task :on, [:feature, :percentage] => :environment do |task, args|
+    if args.feature
+      puts "Activating feature #{args.feature}..."
+      if args.percentage
+        activated = rollout.activate(args.feature, args.percentage.to_i)
+      else
+        activated = rollout.activate(args.feature)
+      end
+
+      if activated
+        puts "Feature flag #{args.feature} has been activated! :)"
+      else
+        puts "Feature flag #{args.feature} has NOT been activated! :("
+      end
+    end
+  end
+
+  desc "Deactivate a feature"
+  task :off, [:feature] => :environment do |task, args|
+    if args.feature
+      puts "Deactivating feature #{args.feature}..."
+      deactivated = rollout.deactivate(args.feature)
+      if deactivated
+        puts "Feature flag #{args.feature} has been deactivated! :)"
+      else
+        puts "Feature flag #{args.feature} has NOT been deactivated! :("
+      end
+    end
+  end
+
+  desc "List features"
+  task list: :environment do
+    features = rollout.features
+    puts "This is the list of all the available features:"
+    puts ""
+    if !features.empty?
+      puts features
+    else
+      puts "- No feature flags stored"
+    end
+  end
+
+  private
+
+  def rollout
+    @rollout ||= Rollout.new(storage)
+  end
+
+  def storage
+    begin
+      @storage ||= Redis.new(
+        host: ENV.fetch('ROLLOUT_REDIS_HOST'),
+        port: ENV.fetch('ROLLOUT_REDIS_PORT')
+      )
+    rescue KeyError => e
+      puts "ROLLOUT_REDIS_HOST and ROLLOUT_REDIS_PORT are mandatory env variables to define in order to run rollout rake tasks"
+      raise e
+    end
+  end
+end

data/lib/rollout/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rollout
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/rollout.rb

@@ -78,6 +78,19 @@ class Rollout
     raise e
   end
 
+  def features
+    keys = @storage.keys("#{key_prefix}:*")
+    return [] if keys.empty?
+
+    keys.map do |key|
+      data = @storage.get(key)
+      next unless data
+
+      feature_name = key.gsub("#{key_prefix}:", '')
+      Feature.new(feature_name, JSON.parse(data, symbolize_names: true)).to_h
+    end
+  end
+
   def clean_cache
     return unless @cache_enabled
 
@@ -165,6 +178,10 @@ class Rollout
   end
 
   def key(name)
-    "feature-rollout-redis:#{name}"
+    "#{key_prefix}:#{name}"
+  end
+
+  def key_prefix
+    "feature-rollout-redis"
   end
 end

data/rollout-redis.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 2.4'
   spec.add_development_dependency 'rspec', '~> 3.12'
   spec.add_development_dependency 'mock_redis', '~> 0.37'
+  spec.add_development_dependency 'rake', '~> 13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rollout-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Juan Carlos García
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
 description: Fast and easy feature flags based on the latest Redis versions.
 email:
 - jugade92@gmail.com
@@ -84,6 +98,7 @@ files:
 - Rakefile
 - lib/rollout.rb
 - lib/rollout/feature.rb
+- lib/rollout/tasks/rollout.rake
 - lib/rollout/version.rb
 - rollout-redis.gemspec
 homepage: https://github.com/jcagarcia/rollout-redis