unleash 0.1.4 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abfb2ccb4ad16fa7842a94c42c715bc28e2b61e9e9ce4b7875a8ad92f47a696
-  data.tar.gz: 59708b33a865480b75f7ffac3e153f32e7a2c19a0ad8338b0ef3872feaf57e8a
+  metadata.gz: da9995687fc28b71318711bd1575d9f5493fb9514cc3f276966323e4a73e15f8
+  data.tar.gz: e4a29a197e0faeaeaf093bb5a67103ed36aba352facf9633a6845739b17ff58c
 SHA512:
-  metadata.gz: 47562d77f0847992c11e3b9f6a504bddc3eb057c62c9bd41f229bd9ddd73d9437f5736f9125790e5b6e9d10d2e6be7f383dee57a6bd33c13c42e58d8837931f7
-  data.tar.gz: 3e081ffa547d95dca4e08030d21b7948ac5bf6d6af81fda91d37c2b328cd84a56f091ad3a83329bb5f86d5caf30e4befdb9d07eb3622e7439d2d5141df79718a
+  metadata.gz: a7831894183515cbe05fb10520542b93d8a8cd521eab6ff33e9c7a4f88540519b479a76fb360a085b4f1ee059be1d03d0b531eb0daa4ff3db0147380b6f5db52
+  data.tar.gz: 93ce839564b8ef8af502ca148bd3e369f5463d32cd42af1d947be5d751dda88c52d8da71ee5a456658de899afe7fff159655f7f8579cf8030c81ff62655f1804

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Clone of the client-specification
+/client-specification/

data/.rubocop.yml

@@ -1,11 +1,70 @@
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
 Naming/PredicateName:
-  NameWhitelist:
+  AllowedMethods:
     - is_enabled?
 
-Metrics/LineLength:
+Metrics/ClassLength:
   Max: 120
+Layout/LineLength:
+  Max: 140
+Metrics/MethodLength:
+  Max: 20
+Metrics/BlockLength:
+  Max: 100
+  Exclude:
+    - 'spec/unleash/client_spec.rb'
+    - 'spec/unleash/feature_toggle_spec.rb'
 
+Metrics/AbcSize:
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Max: 9
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
 Style/RedundantSelf:
   Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/WordArray:
+  EnforcedStyle: brackets
 Style/PreferredHashMethods:
-  Enabled: false
+  EnforcedStyle: verbose
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+Style/GuardClause:
+  MinBodyLength: 8
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IfInsideElse:
+  Exclude:
+    - 'bin/unleash-client'
+
+Style/Next:
+  Exclude:
+    - 'lib/unleash/scheduled_executor.rb'
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+  Exclude:
+    - 'unleash-client.gemspec'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -1,9 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - jruby
-before_install: gem install bundler -v 1.14.6
+- jruby
+- 3.0
+- 2.7
+- 2.6
+- 2.5
+before_install:
+- gem install bundler -v 2.1.4
+- git clone --depth 5 --branch v3.3.0 https://github.com/Unleash/client-specification.git client-specification
+
+notifications:
+  slack:
+    secure: x593zOjdl2yVB8uP54v8CmuCOat8GFHnK99NPvPHKvif5U7PGe0YOgYh4DC1+Jc9vfjn1ke+0++m+Gif4quowpeOaA/t45xpB494lyziXsBulYml245jRp9yzoUmIIt7KxHhv4rlo3Q1ztMJgh6a5yDCornKHW2bKTkLsvqVTwxBRatLOrt6K9O8FivO/NaqgcoXl7Rw0fOx/bsZtx2IAFueTCH19NoqW1mk9KFEZ96YqJSvuqmfDC0AO7siq03WKlB++nPlKe1QcrlPalCrcsSzrYNhYJ3akBTt/ZbE1v6YJv2L+zUqRnAPTY2H+qp8WejFQtdhIjfeJ/SWox0iWv/Wy/mTFfj+EhFO9Aq+xhMjJ1OOLtNAPoYJyatEVgJkILb6M26igTFcuI60xBbGNmh5ZYeyRdn5/xFb7G2zyJ2Swc3PvN1uLzMHfTF0R7WzGq4CRNGIOjrHTGncyB3IGAONOdJdM3iT9XKY6cdlRK0VkQjEsEMe0eNv2fxxLVSGna4sdJoTND6LhJ6qCfuS9DEDXwoRdLxAXxefycCh9VNp7gloMJx8IbHYxOW0BFZqc3hxNU9X2SwOj6j72DZMrdYDg2aPAW69HG0iMontQ37Di87JEW2F2Cpgb49+4twByrQNIx+st+DGNce1vpc0DN+KuJVdIcmha654lT7Ffe8=

data/README.md

@@ -2,17 +2,26 @@
 
 [![Build Status](https://travis-ci.org/Unleash/unleash-client-ruby.svg?branch=master)](https://travis-ci.org/Unleash/unleash-client-ruby)
 [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-client-ruby/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash-client-ruby?branch=master)
+[![Gem Version](https://badge.fury.io/rb/unleash.svg)](https://badge.fury.io/rb/unleash)
 
 Unleash client so you can roll out your features with confidence.
 
 Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful feature toggling in your ruby/rails applications.
 
+## Supported Ruby Interpreters
+
+  * MRI 3.0
+  * MRI 2.7
+  * MRI 2.6
+  * MRI 2.5
+  * jruby
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 0.1.4'
+gem 'unleash', '~> 3.2.2'
 ```
 
 And then execute:
@@ -25,16 +34,15 @@ Or install it yourself as:
 
 ## Configure
 
-It is **required** to configure the `url` of the unleash server. Please substitute the sample `'http://unleash.herokuapp.com/api'` for the url of your own instance.
+It is **required** to configure the `url` of the unleash server and `app_name` with the name of the runninng application. Please substitute the sample `'http://unleash.herokuapp.com/api'` for the url of your own instance.
 
-It is **highly recommended** to configure `app_name` and the `instance_id`.
+It is **highly recommended** to configure the `instance_id` parameter as well.
 
-For other options please see `lib/unleash/configuration.rb`.
 
 ```ruby
 Unleash.configure do |config|
-  config.url      = 'http://unleash.herokuapp.com/api'
-  config.app_name = 'my_ruby_app'
+  config.url         = 'http://unleash.herokuapp.com/api'
+  config.app_name    = 'my_ruby_app'
 end
 ```
 
@@ -44,6 +52,28 @@ or instantiate the client with the valid configuration:
 UNLEASH = Unleash::Client.new(url: 'http://unleash.herokuapp.com/api', app_name: 'my_ruby_app')
 ```
 
+#### List of Arguments
+
+Argument | Description | Required? |  Type |  Default Value|
+---------|-------------|-----------|-------|---------------|
+`url`      | Unleash server URL. | Y | String | N/A |
+`app_name` | Name of your program. | Y | String | N/A |
+`instance_id` | Identifier for the running instance of program. Important so you can trace back to where metrics are being collected from. **Highly recommended be be set.** | N | String | random UUID |
+`environment` | Environment the program is running on. Could be for example `prod` or `dev`. Not yet in use. | N | String | `default` |
+`refresh_interval` | How often the unleash client should check with the server for configuration changes. | N | Integer |  15 |
+`metrics_interval` | How often the unleash client should send metrics to server. | N | Integer | 10 |
+`disable_client` | Disables all communication with the Unleash server, effectively taking it *offline*. If set, `is_enabled?` will always answer with the `default_value` and configuration validation is skipped. Defeats the entire purpose of using unleash, but can be useful in when running tests. | N | Boolean | `false` |
+`disable_metrics` | Disables sending metrics to Unleash server. | N | Boolean | `false` |
+`custom_http_headers` | Custom headers to send to Unleash. | N | Hash | {} |
+`timeout` | How long to wait for the connection to be established or wait in reading state (open_timeout/read_timeout) | N | Integer | 30 |
+`retry_limit` | How many consecutive failures in connecting to the Unleash server are allowed before giving up. Use `Float::INFINITY` if you would like it to never give up. | N | Numeric | 5 |
+`backup_file` | Filename to store the last known state from the Unleash server. Best to not change this from the default. | N | String | `Dir.tmpdir + "/unleash-#{app_name}-repo.json` |
+`logger` | Specify a custom `Logger` class to handle logs for the Unleash client. | N | Class | `Logger.new(STDOUT)` |
+`log_level` | Change the log level for the `Logger` class. Constant from `Logger::Severity`. | N | Constant | `Logger::ERROR` |
+
+For in a more in depth look, please see `lib/unleash/configuration.rb`.
+
+
 ## Usage in a plain Ruby Application
 
 ```ruby
@@ -74,6 +104,8 @@ Unleash.configure do |config|
   config.url      = 'http://unleash.herokuapp.com/api'
   config.app_name = Rails.application.class.parent.to_s
   # config.instance_id = "#{Socket.gethostname}"
+  config.logger   = Rails.logger
+  config.environment = Rails.env
 end
 
 UNLEASH = Unleash::Client.new
@@ -92,6 +124,7 @@ on_worker_boot do
   Unleash.configure do |config|
     config.url      = 'http://unleash.herokuapp.com/api'
     config.app_name = Rails.application.class.parent.to_s
+    config.environment = Rails.env
   end
   Rails.configuration.unleash = Unleash::Client.new
 end
@@ -139,9 +172,53 @@ if Rails.configuration.unleash.is_enabled? "AwesomeFeature", @unleash_context
 end
 ```
 
+If the feature is not found in the server, it will by default return false. However you can override that by setting the default return value to `true`:
+
+```ruby
+if UNLEASH.is_enabled? "AwesomeFeature", @unleash_context, true
+  puts "AwesomeFeature is enabled by default"
+end
+```
+
+Alternatively by using `if_enabled` you can send a code block to be executed as a parameter:
+
+```ruby
+UNLEASH.if_enabled "AwesomeFeature", @unleash_context, true do
+  puts "AwesomeFeature is enabled by default"
+end
+```
+
+##### Variations
+
+If no variant is found in the server, use the fallback variant.
+
+```ruby
+fallback_variant = Unleash::Variant.new(name: 'default', enabled: true, payload: {"color" => "blue"})
+variant = UNLEASH.get_variant "ColorVariants", @unleash_context, fallback_variant
+
+puts "variant color is: #{variant.payload.fetch('color')}"
+```
+
+
+#### Client methods
+
+Method Name | Description | Return Type |
+---------|-------------|-------------|
+`is_enabled?` | Check if feature toggle is to be enabled or not. | Boolean |
+`enabled?` | Alias to the `is_enabled?` method. But more ruby idiomatic. | Boolean |
+`if_enabled` | Run a code block, if a feature is enabled. | `yield` |
+`get_variant` | Get variant for a given feature | `Unleash::Variant` |
+`shutdown` | Save metrics to disk, flush metrics to server, and then kill ToggleFetcher and MetricsReporter threads. A safe shutdown. Not really useful in long running applications, like web applications. | nil |
+`shutdown!` | Kill ToggleFetcher and MetricsReporter threads immediately. | nil |
+
+
 ## Local test client
 
 ```
+# cli unleash client:
+bundle exec bin/unleash-client --help
+
+# or a simple sample implementation (with values hardcoded):
 bundle exec examples/simple.rb
 ```
 
@@ -155,7 +232,7 @@ This client comes with the all the required strategies out of the box:
  * GradualRolloutSessionIdStrategy
  * GradualRolloutUserIdStrategy
  * RemoteAddressStrategy
- * UnknowndStrategy
+ * UnknownStrategy
  * UserWithIdStrategy
 
 
@@ -165,8 +242,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-See (TODO.md) for known limitations, and feature roadmap.
-
 
 ## Contributing
 

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/unleash-client

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'unleash'
+require 'unleash/client'
+require 'unleash/context'
+
+options = {
+  variant: false,
+  verbose: false,
+  quiet: false,
+  url: 'http://localhost:4242',
+  demo: false,
+  disable_metrics: true,
+  sleep: 0.1
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [options] feature [key1=val1] [key2=val2]"
+
+  opts.on("-V", "--variant", "Fetch variant for feature") do |v|
+    options[:variant] = v
+  end
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on("-q", "--quiet", "Quiet mode, minimum output only") do |v|
+    options[:quiet] = v
+  end
+
+  opts.on("-uURL", "--url=URL", "URL base for the Unleash feature toggle service") do |u|
+    options[:url] = u
+  end
+
+  opts.on("-d", "--demo", "Demo load by looping, instead of a simple lookup") do |d|
+    options[:demo] = d
+  end
+
+  opts.on("-m", "--[no-]metrics", "Enable metrics reporting") do |m|
+    options[:disable_metrics] = !m
+  end
+
+  opts.on("-sSLEEP", "--sleep=SLEEP", Float, "Sleep interval between checks (seconds) in demo") do |s|
+    options[:sleep] = s
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+feature_name = ARGV.shift
+raise 'feature_name is required. see --help for usage.' unless feature_name
+
+options[:verbose] = false if options[:quiet]
+
+log_level = \
+  if options[:quiet]
+    Logger::ERROR
+  elsif options[:verbose]
+    Logger::DEBUG
+  else
+    Logger::WARN
+  end
+
+@unleash = Unleash::Client.new(
+  url: options[:url],
+  app_name: 'unleash-client-ruby-cli',
+  disable_metrics: options[:metrics],
+  log_level: log_level
+)
+
+context_params = ARGV.map{ |e| e.split("=") }.map{ |k, v| [k.to_sym, v] }.to_h
+context_properties = context_params.reject{ |k, _v| [:user_id, :session_id, :remote_address].include? k }
+context_params.select!{ |k, _v| [:user_id, :session_id, :remote_address].include? k }
+context_params.merge!(properties: context_properties) unless context_properties.nil?
+unleash_context = Unleash::Context.new(context_params)
+
+if options[:verbose]
+  puts "Running configuration:"
+  p options
+  puts "feature: #{feature_name}"
+  puts "context_args: #{ARGV}"
+  puts "context_params: #{context_params}"
+  puts "context: #{unleash_context}"
+  puts ""
+end
+
+if options[:demo]
+  loop do
+    enabled = @unleash.is_enabled?(feature_name, unleash_context)
+    print enabled ? '.' : '|'
+    sleep options[:sleep]
+  end
+elsif options[:variant]
+  variant = @unleash.get_variant(feature_name, unleash_context)
+  puts " For feature \'#{feature_name}\' got variant \'#{variant}\'"
+else
+  if @unleash.is_enabled?(feature_name, unleash_context)
+    puts " \'#{feature_name}\' is enabled according to unleash"
+  else
+    puts " \'#{feature_name}\' is disabled according to unleash"
+  end
+end
+
+@unleash.shutdown

data/examples/simple.rb

@@ -16,12 +16,14 @@ puts ">> START simple.rb"
 
 # or:
 
-@unleash = Unleash::Client.new( url: 'http://unleash.herokuapp.com/api', app_name: 'simple-test',
+@unleash = Unleash::Client.new(
+  url: 'http://unleash.herokuapp.com/api',
+  app_name: 'simple-test',
   instance_id: 'local-test-cli',
   refresh_interval: 2,
   metrics_interval: 2,
   retry_limit: 2,
-  log_level: Logger::DEBUG,
+  log_level: Logger::DEBUG
 )
 
 # feature_name = "AwesomeFeature"
@@ -50,4 +52,8 @@ else
   puts "> #{feature_name} is not enabled"
 end
 
+puts "> shutting down client..."
+
+@unleash.shutdown
+
 puts ">> END simple.rb"

data/lib/unleash.rb

@@ -5,19 +5,19 @@ require 'unleash/context'
 require 'unleash/client'
 require 'logger'
 
-Gem.find_files('unleash/strategy/**/*.rb').each { |path| require path }
+Gem.find_files('unleash/strategy/**/*.rb').each{ |path| require path unless path.end_with? '_spec.rb' }
 
 module Unleash
   TIME_RESOLUTION = 3
 
   STRATEGIES = Unleash::Strategy.constants
-    .select { |c| Unleash::Strategy.const_get(c).is_a? Class }
-    .select { |c| !['NotImplemented', 'Base'].include?(c.to_s) }
-    .map { |c|
+    .select{ |c| Unleash::Strategy.const_get(c).is_a? Class }
+    .reject{ |c| ['NotImplemented', 'Base'].include?(c.to_s) }
+    .map do |c|
       lowered_c = c.to_s
       lowered_c[0] = lowered_c[0].downcase
-      [lowered_c.to_sym, Object::const_get("Unleash::Strategy::#{c}").new]
-    }
+      [lowered_c.to_sym, Object.const_get("Unleash::Strategy::#{c}").new]
+    end
     .to_h
 
   class << self
@@ -30,12 +30,11 @@ module Unleash
   end
 
   # Support for configuration via yield:
-  def self.configure()
+  def self.configure
     self.configuration ||= Unleash::Configuration.new
     yield(configuration)
 
     self.configuration.validate!
     self.configuration.refresh_backup_file!
   end
-
 end