unleash 0.1.6 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d6b4f0efb9cf53a2f86930e2e26594d2de8c72aee68ee20e1374f6ac1826cc
-  data.tar.gz: ac9905dee38bb80b0f94595907e74856be1842149bfbfc54ee0ff8390bd9dcda
+  metadata.gz: 70d64956aa703576336ee95064ef909655a664159b571be5417ebf073f0de224
+  data.tar.gz: 36cff93bb8203971721e3eeace2d24d9db4075926d2c2609e5c6acd01179c2fd
 SHA512:
-  metadata.gz: b0ce261b43d7325d3aac1ed62a60d7fdec14543d92e5da63f3e1e699ab6a79d5a529c9080f51dfaf641ce72e18518a61ac1f14395987b3e515503865ed1ef5bf
-  data.tar.gz: 3b4cf6548b3c19be261f3794370a80868f0c07cec0988423aa1388f5a75349f880ef1b824652a2bd582814149c985f82e7e1b01772470e41fd119406272f3b42
+  metadata.gz: 7b8c366cc799582a672646c796858381189e9286149929bb5e37afc2404cce9ac140b0c004ba8a3a7f774b0d83c705c2c714932656121054ab920f58afa55b34
+  data.tar.gz: 6a4f8aa92aa80e17eb2477cc77a534dcbe44b2b63b3ff7c05867392252e808ec76750094adaf476c739c2641db1ef0f8a7c3729001fd7efe8ab209a255ebe968

data/.gitignore

@@ -7,9 +7,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor
 
 # rspec failure tracking
 .rspec_status
 
 # Clone of the client-specification
-/client-specification/
+/client-specification/

data/.rubocop.yml

@@ -1,16 +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'
 
-Style/RedundantSelf:
-  Enabled: false
-Style/PreferredHashMethods:
+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:
+  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:
-  Enabled: false
+  EnforcedStyle: no_space
+  Exclude:
+    - 'unleash-client.gemspec'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -1,12 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - jruby
+- jruby
+- 3.0
+- 2.7
+- 2.6
+- 2.5
 before_install:
-  - gem install bundler -v 2.0.2
-  # install client spec from official repository:
-  - git clone --depth 5 https://github.com/Unleash/client-specification.git client-specification
+- 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

@@ -10,10 +10,10 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 
 ## Supported Ruby Interpreters
 
-  * MRI 2.3
-  * MRI 2.4
-  * MRI 2.5
+  * MRI 3.0
+  * MRI 2.7
   * MRI 2.6
+  * MRI 2.5
   * jruby
 
 ## Installation
@@ -21,7 +21,7 @@ Leverage the [Unleash Server](https://github.com/Unleash/unleash) for powerful f
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 0.1.6'
+gem 'unleash', '~> 3.2.3'
 ```
 
 And then execute:
@@ -66,7 +66,7 @@ Argument | Description | Required? |  Type |  Default Value|
 `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. | N | Integer | 1 |
+`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` |
@@ -242,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](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

@@ -12,7 +12,7 @@ options = {
   url: 'http://localhost:4242',
   demo: false,
   disable_metrics: true,
-  sleep: 0.1,
+  sleep: 0.1
 }
 
 OptionParser.new do |opts|
@@ -57,17 +57,26 @@ 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 = options[:quiet] ? Logger::ERROR : (options[:verbose] ? Logger::DEBUG : Logger::WARN),
+  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?
+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]
@@ -80,26 +89,21 @@ if options[:verbose]
   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 options[:variant]
-    variant = @unleash.get_variant(feature_name, unleash_context)
-    puts " For feature \'#{feature_name}\' got variant \'#{variant}\'"
+  if @unleash.is_enabled?(feature_name, unleash_context)
+    puts " \'#{feature_name}\' is enabled according to unleash"
   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
+    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: 'https://app.unleash-hosted.com/demo/api',
+  app_name: 'simple-test',
   instance_id: 'local-test-cli',
   refresh_interval: 2,
   metrics_interval: 2,
   retry_limit: 2,
-  log_level: Logger::DEBUG,
+  custom_http_headers: {'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0'},
 )
 
 # feature_name = "AwesomeFeature"
@@ -55,5 +57,3 @@ puts "> shutting down client..."
 @unleash.shutdown
 
 puts ">> END simple.rb"
-
-

data/lib/unleash/activation_strategy.rb

@@ -1,16 +1,29 @@
 module Unleash
   class ActivationStrategy
-    attr_accessor :name, :params
+    attr_accessor :name, :params, :constraints
 
-    def initialize(name, params)
+    def initialize(name, params, constraints = [])
       self.name = name
 
       if params.is_a?(Hash)
         self.params = params
+      elsif params.nil?
+        self.params = {}
       else
-        Unleash.logger.warn "Invalid params provided for ActivationStrategy #{params}"
+        Unleash.logger.warn "Invalid params provided for ActivationStrategy (params:#{params})"
         self.params = {}
       end
+
+      if constraints.is_a?(Array) && constraints.each{ |c| c.is_a?(Constraint) }
+        self.constraints = constraints
+      else
+        Unleash.logger.warn "Invalid constraints provided for ActivationStrategy (contraints: #{constraints})"
+        self.constraints = []
+      end
+    end
+
+    def matches_context?(context)
+      self.constraints.any?{ |c| c.matches_context? context }
     end
   end
 end

data/lib/unleash/client.rb

@@ -3,11 +3,11 @@ require 'unleash/toggle_fetcher'
 require 'unleash/metrics_reporter'
 require 'unleash/scheduled_executor'
 require 'unleash/feature_toggle'
+require 'unleash/util/http'
 require 'logger'
 require 'time'
 
 module Unleash
-
   class Client
     attr_accessor :fetcher_scheduled_executor, :metrics_scheduled_executor
 
@@ -18,71 +18,56 @@ module Unleash
       Unleash.logger = Unleash.configuration.logger.clone
       Unleash.logger.level = Unleash.configuration.log_level
 
-      unless Unleash.configuration.disable_client
-        Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
-
-        register
-
-        self.fetcher_scheduled_executor = Unleash::ScheduledExecutor.new('ToggleFetcher', Unleash.configuration.refresh_interval)
-        self.fetcher_scheduled_executor.run do
-          Unleash.toggle_fetcher.fetch
-        end
-
-        unless Unleash.configuration.disable_metrics
-          Unleash.toggle_metrics = Unleash::Metrics.new
-          Unleash.reporter = Unleash::MetricsReporter.new
-          self.metrics_scheduled_executor = Unleash::ScheduledExecutor.new('MetricsReporter', Unleash.configuration.metrics_interval)
-          self.metrics_scheduled_executor.run do
-            Unleash.reporter.send
-          end
-        end
-      else
+      if Unleash.configuration.disable_client
         Unleash.logger.warn "Unleash::Client is disabled! Will only return default results!"
+        return
       end
+
+      register
+      start_toggle_fetcher
+      start_metrics unless Unleash.configuration.disable_metrics
     end
 
     def is_enabled?(feature, context = nil, default_value = false)
-        Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} with context #{context}"
+      Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} with context #{context}"
 
-        if Unleash.configuration.disable_client
-          Unleash.logger.warn "unleash_client is disabled! Always returning #{default_value} for feature #{feature}!"
-          return default_value
-        end
+      if Unleash.configuration.disable_client
+        Unleash.logger.warn "unleash_client is disabled! Always returning #{default_value} for feature #{feature}!"
+        return default_value
+      end
 
-        toggle_as_hash = Unleash.toggles.select{ |toggle| toggle['name'] == feature }.first if Unleash.toggles
+      toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
 
-        if toggle_as_hash.nil?
-          Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} not found"
-          return default_value
-        end
+      if toggle_as_hash.nil?
+        Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} not found"
+        return default_value
+      end
 
-        toggle = Unleash::FeatureToggle.new(toggle_as_hash)
-        toggle_result = toggle.is_enabled?(context, default_value)
+      toggle = Unleash::FeatureToggle.new(toggle_as_hash)
 
-        return toggle_result
+      toggle.is_enabled?(context, default_value)
     end
 
     # enabled? is a more ruby idiomatic method name than is_enabled?
-    alias_method :enabled?, :is_enabled?
+    alias enabled? is_enabled?
 
     # execute a code block (passed as a parameter), if is_enabled? is true.
     def if_enabled(feature, context = nil, default_value = false, &blk)
-      yield if is_enabled?(feature, context, default_value)
+      yield(blk) if is_enabled?(feature, context, default_value)
     end
 
-
-    def get_variant(feature, context = nil, fallback_variant = false)
+    def get_variant(feature, context = nil, fallback_variant = nil)
       Unleash.logger.debug "Unleash::Client.get_variant for feature: #{feature} with context #{context}"
 
       if Unleash.configuration.disable_client
-        Unleash.logger.warn "unleash_client is disabled! Always returning #{default_variant} for feature #{feature}!"
+        Unleash.logger.debug "unleash_client is disabled! Always returning #{default_variant} for feature #{feature}!"
         return fallback_variant || Unleash::FeatureToggle.disabled_variant
       end
 
-      toggle_as_hash = Unleash.toggles.select{ |toggle| toggle['name'] == feature }.first if Unleash.toggles
+      toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
 
       if toggle_as_hash.nil?
-        Unleash.logger.debug "Unleash::Client.is_enabled? feature: #{feature} not found"
+        Unleash.logger.debug "Unleash::Client.get_variant feature: #{feature} not found"
         return fallback_variant || Unleash::FeatureToggle.disabled_variant
       end
 
@@ -96,7 +81,7 @@ module Unleash
 
       # TODO: Add to README: name, payload, enabled (bool)
 
-      return variant
+      variant
     end
 
     # safe shutdown: also flush metrics to server and toggles to disk
@@ -117,9 +102,10 @@ module Unleash
     end
 
     private
+
     def info
-      return {
-        'appName':  Unleash.configuration.app_name,
+      {
+        'appName': Unleash.configuration.app_name,
         'instanceId': Unleash.configuration.instance_id,
         'sdkVersion': "unleash-client-ruby:" + Unleash::VERSION,
         'strategies': Unleash::STRATEGIES.keys,
@@ -128,28 +114,42 @@ module Unleash
       }
     end
 
-    def register
-      Unleash.logger.debug "register()"
-
-      uri = URI(Unleash.configuration.client_register_url)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true if uri.scheme == 'https'
-      http.open_timeout = Unleash.configuration.timeout # in seconds
-      http.read_timeout = Unleash.configuration.timeout # in seconds
+    def start_toggle_fetcher
+      Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
+      self.fetcher_scheduled_executor = Unleash::ScheduledExecutor.new(
+        'ToggleFetcher',
+        Unleash.configuration.refresh_interval,
+        Unleash.configuration.retry_limit
+      )
+      self.fetcher_scheduled_executor.run do
+        Unleash.toggle_fetcher.fetch
+      end
+    end
 
-      headers = (Unleash.configuration.get_http_headers || {}).dup
-      headers['Content-Type'] = 'application/json'
+    def start_metrics
+      Unleash.toggle_metrics = Unleash::Metrics.new
+      Unleash.reporter = Unleash::MetricsReporter.new
+      self.metrics_scheduled_executor = Unleash::ScheduledExecutor.new(
+        'MetricsReporter',
+        Unleash.configuration.metrics_interval,
+        Unleash.configuration.retry_limit
+      )
+      self.metrics_scheduled_executor.run do
+        Unleash.reporter.send
+      end
+    end
 
-      request = Net::HTTP::Post.new(uri.request_uri, headers)
-      request.body = info.to_json
+    def register
+      Unleash.logger.debug "register()"
 
       # Send the request, if possible
       begin
-        response = http.request(request)
-      rescue Exception => e
+        response = Unleash::Util::Http.post(Unleash.configuration.client_register_url, info.to_json)
+      rescue StandardError => e
         Unleash.logger.error "unable to register client with unleash server due to exception #{e.class}:'#{e}'."
         Unleash.logger.error "stacktrace: #{e.backtrace}"
       end
+      Unleash.logger.debug "client registered: #{response}"
     end
   end
 end