unleash 3.2.5 → 4.2.0

data/bin/unleash-client

@@ -12,11 +12,13 @@ options = {
   url: 'http://localhost:4242',
   demo: false,
   disable_metrics: true,
+  custom_http_headers: {},
   sleep: 0.1
 }
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{__FILE__} [options] feature [key1=val1] [key2=val2]"
+  opts.banner = "Usage: #{__FILE__} [options] feature [contextKey1=val1] [contextKey2=val2] \n\n" \
+  "Where contextKey1 could be user_id, session_id, remote_address or any field in the Context class (or any property within it).\n"
 
   opts.on("-V", "--variant", "Fetch variant for feature") do |v|
     options[:variant] = v
@@ -46,6 +48,13 @@ OptionParser.new do |opts|
     options[:sleep] = s
   end
 
+  opts.on("-H", "--http-headers='Authorization: *:developement.secretstring'",
+          "Adds http headers to all requests on the unleash server. Use multiple times for multiple headers.") do |h|
+    http_header_as_hash = [h].to_h{ |l| l.split(": ") }.transform_keys(&:to_sym)
+
+    options[:custom_http_headers].merge!(http_header_as_hash)
+  end
+
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -70,10 +79,11 @@ log_level = \
   url: options[:url],
   app_name: 'unleash-client-ruby-cli',
   disable_metrics: options[:metrics],
+  custom_http_headers: options[:custom_http_headers],
   log_level: log_level
 )
 
-context_params = ARGV.map{ |e| e.split("=") }.map{ |k, v| [k.to_sym, v] }.to_h
+context_params = ARGV.to_h{ |l| l.split("=") }.transform_keys(&:to_sym)
 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?
@@ -97,12 +107,12 @@ if options[:demo]
   end
 elsif options[:variant]
   variant = @unleash.get_variant(feature_name, unleash_context)
-  puts " For feature \'#{feature_name}\' got variant \'#{variant}\'"
+  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"
+    puts " '#{feature_name}' is enabled according to unleash"
   else
-    puts " \'#{feature_name}\' is disabled according to unleash"
+    puts " '#{feature_name}' is disabled according to unleash"
   end
 end
 

data/examples/bootstrap.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'unleash'
+require 'unleash/context'
+require 'unleash/bootstrap/configuration'
+
+puts ">> START bootstrap.rb"
+
+@unleash = Unleash::Client.new(
+  url: 'http://unleash.herokuapp.com/api',
+  custom_http_headers: { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' },
+  app_name: 'bootstrap-test',
+  instance_id: 'local-test-cli',
+  refresh_interval: 2,
+  disable_client: true,
+  disable_metrics: true,
+  metrics_interval: 2,
+  retry_limit: 2,
+  bootstrap_config: Unleash::Bootstrap::Configuration.new(file_path: "examples/default-toggles.json")
+)
+
+feature_name = "featureX"
+unleash_context = Unleash::Context.new
+unleash_context.user_id = 123
+
+sleep 1
+3.times do
+  if @unleash.is_enabled?(feature_name, unleash_context)
+    puts "> #{feature_name} is enabled"
+  else
+    puts "> #{feature_name} is not enabled"
+  end
+  sleep 1
+  puts "---"
+  puts ""
+  puts ""
+end
+
+sleep 3
+feature_name = "foobar"
+if @unleash.is_enabled?(feature_name, unleash_context, true)
+  puts "> #{feature_name} is enabled"
+else
+  puts "> #{feature_name} is not enabled"
+end
+
+puts "> shutting down client..."
+
+@unleash.shutdown
+
+puts ">> END bootstrap.rb"

data/examples/default-toggles.json

@@ -0,0 +1,42 @@
+{
+  "version": 1,
+  "features": [
+    {
+      "name": "featureX",
+      "enabled": true,
+      "strategies": [
+        {
+          "name": "default"
+        }
+      ]
+    },
+    {
+      "name": "featureY",
+      "enabled": false,
+      "strategies": [
+        {
+          "name": "baz",
+          "parameters": {
+            "foo": "bar"
+          }
+        }
+      ]
+    },
+    {
+      "name": "featureZ",
+      "enabled": true,
+      "strategies": [
+        {
+          "name": "default"
+        },
+        {
+          "name": "hola",
+          "parameters": {
+            "name": "val"
+          }
+        }
+      ]
+    }
+  ]
+}
+    

data/examples/simple.rb

@@ -7,6 +7,7 @@ puts ">> START simple.rb"
 
 # Unleash.configure do |config|
 #   config.url = 'http://unleash.herokuapp.com/api'
+#   config.custom_http_headers = { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' }
 #   config.app_name = 'simple-test'
 #   config.refresh_interval = 2
 #   config.metrics_interval = 2
@@ -17,13 +18,13 @@ puts ">> START simple.rb"
 # or:
 
 @unleash = Unleash::Client.new(
-  url: 'https://app.unleash-hosted.com/demo/api',
+  url: 'http://unleash.herokuapp.com/api',
+  custom_http_headers: { 'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0' },
   app_name: 'simple-test',
   instance_id: 'local-test-cli',
   refresh_interval: 2,
   metrics_interval: 2,
-  retry_limit: 2,
-  custom_http_headers: {'Authorization': '943ca9171e2c884c545c5d82417a655fb77cec970cc3b78a8ff87f4406b495d0'},
+  retry_limit: 2
 )
 
 # feature_name = "AwesomeFeature"

data/lib/unleash/bootstrap/configuration.rb

@@ -0,0 +1,25 @@
+module Unleash
+  module Bootstrap
+    class Configuration
+      attr_accessor :data, :file_path, :url, :url_headers, :block
+
+      def initialize(opts = {})
+        self.file_path = resolve_value_indifferently(opts, 'file_path') || ENV['UNLEASH_BOOTSTRAP_FILE'] || nil
+        self.url = resolve_value_indifferently(opts, 'url') || ENV['UNLEASH_BOOTSTRAP_URL'] || nil
+        self.url_headers = resolve_value_indifferently(opts, 'url_headers')
+        self.data = resolve_value_indifferently(opts, 'data')
+        self.block = resolve_value_indifferently(opts, 'block')
+      end
+
+      def valid?
+        ![self.data, self.file_path, self.url, self.block].all?(&:nil?)
+      end
+
+      private
+
+      def resolve_value_indifferently(opts, key)
+        opts[key] || opts[key.to_sym]
+      end
+    end
+  end
+end

data/lib/unleash/bootstrap/handler.rb

@@ -0,0 +1,22 @@
+require 'unleash/bootstrap/provider/from_url'
+require 'unleash/bootstrap/provider/from_file'
+
+module Unleash
+  module Bootstrap
+    class Handler
+      attr_accessor :configuration
+
+      def initialize(configuration)
+        self.configuration = configuration
+      end
+
+      # @return [String] JSON string representing data returned from an Unleash server
+      def retrieve_toggles
+        return configuration.data unless self.configuration.data.nil?
+        return configuration.block.call if self.configuration.block.is_a?(Proc)
+        return Provider::FromFile.read(configuration.file_path) unless self.configuration.file_path.nil?
+        return Provider::FromUrl.read(configuration.url, configuration.url_headers) unless self.configuration.url.nil?
+      end
+    end
+  end
+end

data/lib/unleash/bootstrap/provider/base.rb

@@ -0,0 +1,14 @@
+module Unleash
+  module Bootstrap
+    module Provider
+      class NotImplemented < RuntimeError
+      end
+
+      class Base
+        def read
+          raise NotImplemented, "Bootstrap is not implemented"
+        end
+      end
+    end
+  end
+end

data/lib/unleash/bootstrap/provider/from_file.rb

@@ -0,0 +1,14 @@
+require 'unleash/bootstrap/provider/base'
+
+module Unleash
+  module Bootstrap
+    module Provider
+      class FromFile < Base
+        # @param file_path [String]
+        def self.read(file_path)
+          File.read(file_path)
+        end
+      end
+    end
+  end
+end

data/lib/unleash/bootstrap/provider/from_url.rb

@@ -0,0 +1,19 @@
+require 'unleash/bootstrap/provider/base'
+
+module Unleash
+  module Bootstrap
+    module Provider
+      class FromUrl < Base
+        # @param url [String]
+        # @param headers [Hash, nil] HTTP headers to use. If not set, the unleash client SDK ones will be used.
+        def self.read(url, headers = nil)
+          response = Unleash::Util::Http.get(URI.parse(url), nil, headers)
+
+          return nil if response.code != '200'
+
+          response.body
+        end
+      end
+    end
+  end
+end

data/lib/unleash/client.rb

@@ -18,8 +18,9 @@ module Unleash
       Unleash.logger = Unleash.configuration.logger.clone
       Unleash.logger.level = Unleash.configuration.log_level
 
+      Unleash.toggle_fetcher = Unleash::ToggleFetcher.new
       if Unleash.configuration.disable_client
-        Unleash.logger.warn "Unleash::Client is disabled! Will only return default results!"
+        Unleash.logger.warn "Unleash::Client is disabled! Will only return default (or bootstrapped if available) results!"
         return
       end
 
@@ -28,13 +29,14 @@ module Unleash
       start_metrics unless Unleash.configuration.disable_metrics
     end
 
-    def is_enabled?(feature, context = nil, default_value = false)
+    def is_enabled?(feature, context = nil, default_value_param = false, &fallback_blk)
       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
+      default_value = if block_given?
+                        default_value_param || !!fallback_blk.call(feature, context)
+                      else
+                        default_value_param
+                      end
 
       toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
 
@@ -56,19 +58,19 @@ module Unleash
       yield(blk) if is_enabled?(feature, context, default_value)
     end
 
-    def get_variant(feature, context = nil, fallback_variant = nil)
+    def get_variant(feature, context = Unleash::Context.new, fallback_variant = disabled_variant)
       Unleash.logger.debug "Unleash::Client.get_variant for feature: #{feature} with context #{context}"
 
       if Unleash.configuration.disable_client
         Unleash.logger.debug "unleash_client is disabled! Always returning #{fallback_variant} for feature #{feature}!"
-        return fallback_variant || Unleash::FeatureToggle.disabled_variant
+        return fallback_variant
       end
 
       toggle_as_hash = Unleash&.toggles&.select{ |toggle| toggle['name'] == feature }&.first
 
       if toggle_as_hash.nil?
         Unleash.logger.debug "Unleash::Client.get_variant feature: #{feature} not found"
-        return fallback_variant || Unleash::FeatureToggle.disabled_variant
+        return fallback_variant
       end
 
       toggle = Unleash::FeatureToggle.new(toggle_as_hash)
@@ -76,7 +78,7 @@ module Unleash
 
       if variant.nil?
         Unleash.logger.debug "Unleash::Client.get_variant variants for feature: #{feature} not found"
-        return fallback_variant || Unleash::FeatureToggle.disabled_variant
+        return fallback_variant
       end
 
       # TODO: Add to README: name, payload, enabled (bool)
@@ -88,7 +90,7 @@ module Unleash
     def shutdown
       unless Unleash.configuration.disable_client
         Unleash.toggle_fetcher.save!
-        Unleash.reporter.send unless Unleash.configuration.disable_metrics
+        Unleash.reporter.post unless Unleash.configuration.disable_metrics
         shutdown!
       end
     end
@@ -115,11 +117,11 @@ module Unleash
     end
 
     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
+        Unleash.configuration.retry_limit,
+        first_fetch_is_eager
       )
       self.fetcher_scheduled_executor.run do
         Unleash.toggle_fetcher.fetch
@@ -135,7 +137,7 @@ module Unleash
         Unleash.configuration.retry_limit
       )
       self.metrics_scheduled_executor.run do
-        Unleash.reporter.send
+        Unleash.reporter.post
       end
     end
 
@@ -144,12 +146,20 @@ module Unleash
 
       # Send the request, if possible
       begin
-        response = Unleash::Util::Http.post(Unleash.configuration.client_register_url, info.to_json)
+        response = Unleash::Util::Http.post(Unleash.configuration.client_register_uri, 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
+
+    def disabled_variant
+      @disabled_variant ||= Unleash::FeatureToggle.disabled_variant
+    end
+
+    def first_fetch_is_eager
+      Unleash.configuration.use_bootstrap?
+    end
   end
 end

data/lib/unleash/configuration.rb

@@ -1,5 +1,6 @@
 require 'securerandom'
 require 'tmpdir'
+require 'unleash/bootstrap/configuration'
 
 module Unleash
   class Configuration
@@ -8,6 +9,7 @@ module Unleash
       :app_name,
       :environment,
       :instance_id,
+      :project_name,
       :custom_http_headers,
       :disable_client,
       :disable_metrics,
@@ -17,7 +19,8 @@ module Unleash
       :metrics_interval,
       :backup_file,
       :logger,
-      :log_level
+      :log_level,
+      :bootstrap_config
 
     def initialize(opts = {})
       ensure_valid_opts(opts)
@@ -41,7 +44,7 @@ module Unleash
     end
 
     def refresh_backup_file!
-      self.backup_file = Dir.tmpdir + "/unleash-#{app_name}-repo.json" if self.backup_file.nil?
+      self.backup_file = File.join(Dir.tmpdir, "unleash-#{app_name}-repo.json")
     end
 
     def http_headers
@@ -51,16 +54,26 @@ module Unleash
       }.merge(custom_http_headers.dup)
     end
 
-    def fetch_toggles_url
-      self.url + '/client/features'
+    def fetch_toggles_uri
+      uri = URI("#{self.url_stripped_of_slash}/client/features")
+      uri.query = "project=#{self.project_name}" unless self.project_name.nil?
+      uri
     end
 
-    def client_metrics_url
-      self.url + '/client/metrics'
+    def client_metrics_uri
+      URI("#{self.url_stripped_of_slash}/client/metrics")
     end
 
-    def client_register_url
-      self.url + '/client/register'
+    def client_register_uri
+      URI("#{self.url_stripped_of_slash}/client/register")
+    end
+
+    def url_stripped_of_slash
+      self.url.delete_suffix '/'
+    end
+
+    def use_bootstrap?
+      self.bootstrap_config&.valid?
     end
 
     private
@@ -76,14 +89,16 @@ module Unleash
       self.environment      = 'default'
       self.url              = nil
       self.instance_id      = SecureRandom.uuid
+      self.project_name     = nil
       self.disable_client   = false
       self.disable_metrics  = false
       self.refresh_interval = 10
-      self.metrics_interval = 30
+      self.metrics_interval = 60
       self.timeout          = 30
-      self.retry_limit      = 1
+      self.retry_limit      = Float::INFINITY
       self.backup_file      = nil
       self.log_level        = Logger::WARN
+      self.bootstrap_config = nil
 
       self.custom_http_headers = {}
     end

data/lib/unleash/constraint.rb

@@ -1,26 +1,104 @@
+require 'date'
+
 module Unleash
   class Constraint
-    attr_accessor :context_name, :operator, :values
+    attr_accessor :context_name, :operator, :value, :inverted, :case_insensitive
+
+    OPERATORS = {
+      IN: ->(context_v, constraint_v){ constraint_v.include? context_v },
+      NOT_IN: ->(context_v, constraint_v){ !constraint_v.include? context_v },
+      STR_STARTS_WITH: ->(context_v, constraint_v){ constraint_v.any?{ |v| context_v.start_with? v } },
+      STR_ENDS_WITH: ->(context_v, constraint_v){ constraint_v.any?{ |v| context_v.end_with? v } },
+      STR_CONTAINS: ->(context_v, constraint_v){ constraint_v.any?{ |v| context_v.include? v } },
+      NUM_EQ: ->(context_v, constraint_v){ on_valid_float(constraint_v, context_v){ |x, y| (x - y).abs < Float::EPSILON } },
+      NUM_LT: ->(context_v, constraint_v){ on_valid_float(constraint_v, context_v){ |x, y| (x > y) } },
+      NUM_LTE: ->(context_v, constraint_v){ on_valid_float(constraint_v, context_v){ |x, y| (x >= y) } },
+      NUM_GT: ->(context_v, constraint_v){ on_valid_float(constraint_v, context_v){ |x, y| (x < y) } },
+      NUM_GTE: ->(context_v, constraint_v){ on_valid_float(constraint_v, context_v){ |x, y| (x <= y) } },
+      DATE_AFTER: ->(context_v, constraint_v){ on_valid_date(constraint_v, context_v){ |x, y| (x < y) } },
+      DATE_BEFORE: ->(context_v, constraint_v){ on_valid_date(constraint_v, context_v){ |x, y| (x > y) } },
+      SEMVER_EQ: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x == y) } },
+      SEMVER_GT: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x < y) } },
+      SEMVER_LT: ->(context_v, constraint_v){ on_valid_version(constraint_v, context_v){ |x, y| (x > y) } }
+    }.freeze
 
-    VALID_OPERATORS = ['IN', 'NOT_IN'].freeze
+    LIST_OPERATORS = [:IN, :NOT_IN, :STR_STARTS_WITH, :STR_ENDS_WITH, :STR_CONTAINS].freeze
 
-    def initialize(context_name, operator, values = [])
+    def initialize(context_name, operator, value = [], inverted: false, case_insensitive: false)
       raise ArgumentError, "context_name is not a String" unless context_name.is_a?(String)
-      raise ArgumentError, "operator does not hold a valid value:" + VALID_OPERATORS unless VALID_OPERATORS.include? operator
-      raise ArgumentError, "values does not hold an Array" unless values.is_a?(Array)
+      raise ArgumentError, "operator does not hold a valid value:" + OPERATORS.keys unless OPERATORS.include? operator.to_sym
+
+      self.validate_constraint_value_type(operator.to_sym, value)
 
       self.context_name = context_name
-      self.operator = operator
-      self.values = values
+      self.operator = operator.to_sym
+      self.value = value
+      self.inverted = !!inverted
+      self.case_insensitive = !!case_insensitive
     end
 
     def matches_context?(context)
-      Unleash.logger.debug "Unleash::Constraint matches_context? values: #{self.values} context.get_by_name(#{self.context_name})" \
+      Unleash.logger.debug "Unleash::Constraint matches_context? value: #{self.value} context.get_by_name(#{self.context_name})" \
         " #{context.get_by_name(self.context_name)} "
+      match = matches_constraint?(context)
+      self.inverted ? !match : match
+    rescue KeyError
+      Unleash.logger.warn "Attemped to resolve a context key during constraint resolution: #{self.context_name} but it wasn't \
+      found on the context"
+      false
+    end
+
+    def self.on_valid_date(val1, val2)
+      val1 = DateTime.parse(val1)
+      val2 = DateTime.parse(val2)
+      yield(val1, val2)
+    rescue ArgumentError
+      Unleash.logger.warn "Unleash::ConstraintMatcher unable to parse either context_value (#{val1}) \
+      or constraint_value (#{val2}) into a date. Returning false!"
+      false
+    end
+
+    def self.on_valid_float(val1, val2)
+      val1 = Float(val1)
+      val2 = Float(val2)
+      yield(val1, val2)
+    rescue ArgumentError
+      Unleash.logger.warn "Unleash::ConstraintMatcher unable to parse either context_value (#{val1}) \
+      or constraint_value (#{val2}) into a number. Returning false!"
+      false
+    end
+
+    def self.on_valid_version(val1, val2)
+      val1 = Gem::Version.new(val1)
+      val2 = Gem::Version.new(val2)
+      yield(val1, val2)
+    rescue ArgumentError
+      Unleash.logger.warn "Unleash::ConstraintMatcher unable to parse either context_value (#{val1}) \
+      or constraint_value (#{val2}) into a version. Return false!"
+      false
+    end
+
+    # This should be a private method but for some reason this fails on Ruby 2.5
+    def validate_constraint_value_type(operator, value)
+      raise ArgumentError, "context_name is not an Array" if LIST_OPERATORS.include?(operator) && value.is_a?(String)
+      raise ArgumentError, "context_name is not a String" if !LIST_OPERATORS.include?(operator) && value.is_a?(Array)
+    end
+
+    private
+
+    def matches_constraint?(context)
+      unless OPERATORS.include?(self.operator)
+        Unleash.logger.warn "Invalid constraint operator: #{self.operator}, this should be unreachable. Always returning false."
+        false
+      end
+
+      v = self.value.dup
+      context_value = context.get_by_name(self.context_name)
 
-      is_included = self.values.include? context.get_by_name(self.context_name)
+      v.map!(&:upcase) if self.case_insensitive
+      context_value.upcase! if self.case_insensitive
 
-      operator == 'IN' ? is_included : !is_included
+      OPERATORS[self.operator].call(context_value, v)
     end
   end
 end

data/lib/unleash/context.rb

@@ -1,6 +1,6 @@
 module Unleash
   class Context
-    ATTRS = [:app_name, :environment, :user_id, :session_id, :remote_address].freeze
+    ATTRS = [:app_name, :environment, :user_id, :session_id, :remote_address, :current_time].freeze
 
     attr_accessor(*[ATTRS, :properties].flatten)
 
@@ -12,6 +12,7 @@ module Unleash
       self.user_id     = value_for('userId', params)
       self.session_id  = value_for('sessionId', params)
       self.remote_address = value_for('remoteAddress', params)
+      self.current_time = value_for('currentTime', params, Time.now.utc.iso8601.to_s)
 
       properties = value_for('properties', params)
       self.properties = properties.is_a?(Hash) ? properties.transform_keys(&:to_sym) : {}
@@ -28,7 +29,7 @@ module Unleash
       if ATTRS.include? normalized_name
         self.send(normalized_name)
       else
-        self.properties.fetch(normalized_name)
+        self.properties.fetch(normalized_name, nil) || self.properties.fetch(name.to_sym)
       end
     end