splitclient-rb 7.0.0.pre.rc3-java → 7.0.1-java

data/NEWS

@@ -1,144 +0,0 @@
-6.4.0 (Jul 05, 2019)
- - Added properties to track method.
-
-6.3.0 (Apr 30, 2019)
-
-- Added Dynamic Configurations support through two new methods that mimick the regular ones, changing the type of what is returned.
-  - get_treatment_with_config: Same as get_treatment but returning the treatment with it's config.
-  - get_treatments_with_config: Same as get_treatments, but instead of a map of string it returns a map of treatments with config.
-- Added configs to SplitViews returned by the manager module.
-- Updated localhost mode. Now besides supporting the old text files with `.split` extension (to be deprecated soon), we support YAML (.yaml/.yml) files where you can
-  define configurations for your treatments and also whitelisted keys. Read more in our docs!
-  
-6.2.0
-Ensure SDK flushes information to Split servers on client destroy
-Fix for compatibility issue between Faraday < 0.13 and net-http-persistent 3
-Change default features refresh rate interval to 5 seconds
-
-6.1.0
-
-Review input validation for client API methods: get_treatment, get_treatments, track, manager. Add input validation to block_until_ready, client startup, and destroy
-Add additional logging to the SDK Client in order to help debug matcher related issues
-Fix for issue causing redis_url parameter to be ignored
-
-6.0.1
-
-Fix an issue in events and impressions API calls log messages introduced in 6.0.0
-
-6.0.0
-
-BREAKING CHANGE: Remove producer mode, make memory adapter mandatory in standalone mode, and Redis adapter mandatory in consumer mode.
-BREAKING CHANGE: Reduce the total number of Redis operations of the SDK by changing the impressions storage format and adding a memory cache for splits and segments. It requires to have Split Synchronizer > v2.0.0 running if you are using Redis.
-SDK is now compatible with net-http-persistent 3.0.
-
-5.1.2
-
-Add input validation for client API methods: get_treatment, get_treatments, track, manager
-
-5.1.1
-
-Reduces the number of calls to Redis when calling #client.get_treatments using such cache adapter.
-
-5.1.0
-
-Prevent unhandled exceptions from raising when API get calls fail on Segments and Treatments.
-
-5.0.3
-
-Creates a new configuration parameter (impressions_bulk_size) to manage the max number of impressions sent to the Split backend on each post.
-Changes impressions_queue_size so that it manages only the queue size in the memory adapter.
-A backwards compatibility fail safe is included for users of previous SDK versions.
-
-5.0.2
-
-Turn Impression Listener into an optional SDK feature.
-Prevents the impression thread from being started if a listener is not in place
-
-5.0.1
-
-Adding stop! method to the factory.
-With this method the user will be able to stop the threads that queries the Split Service. This will be used in the before_fork configuration in Puma and Unicorn to stop the threads in the master process.
-
-5.0.0
-
-This is a breaking change in how users buckets are allocated.
-Ruby SDK was wrongly picking up the right buckets and defauled to
-use a "legacy hashing" instead of our moder murmur3 algo which is
-what other SDKs use. Please reach out to support@split.io for help
-on how to upgrade to this release.
-
-4.5.0
-
-Add JRuby support
-
-4.4.0
-
-Add the ability to send event data to split service (.track() api)
-
-4.3.0
-
-Add support for impression listener, there is an ability to use user-defined class to capture all impressions
-Now you can apply attribute matcher to the traffic type
-
-4.2.0
-
-Introduce new matchers: boolean and regexp (string).
-Remove unneeded dependencies
-Introduce dependency matcher, which allows treatment of one split to depend on the evaluation of another.
-
-4.1.0
-
-Introduce set matchers: part of set, contains all and contains any, starts with, ends with and contains.
-
-4.0.0
-
-Add support for murmur3 hashing algorithm
-Optimize gem memory usage
-
-3.3.0
-
-Add support for traffic allocation
-
-3.1.0
-
-Now supporting Redis as a cache adapter
-Factory is build now as SplitIoClient::SplitFactoryBuilder.build('<API_KEY>')
-
-3.0.2
-
-now support also client.get_treatment( { :matching_key = 'bb' , "bucketing_key = ''}, ....)
-
-2.0.1
-
-No news for this release
-
-2.0.0
-
-Instantiation of the split client is now through a factory:
-
-  factory = SplitIoClient::SplitFactory.new("rbk5je8be5qflpa047m17fe4ra", options)
-  client = factory.client
-  manager = factory.manager
-
-1.0.4
-
-Added AND combiner for conditions support. Added events_uri config param which is the url where the metrics post are send to.
-
-1.0.3
-
-This version of the gem fixes two minor bugs related to the config option for the refresh rates, as well as an inconsistency for the split definitions that are not created from the web app, but directly from the api instead.
-
-1.0.2
-
-Support for all the new matchers including: number comparison with >=, <=, =, between; date comparison with is on or before, is on or after, is on, between; attribute value in a defined set of values.
-No other major updates for this release.
-
-1.0.1
-
-isTreatment was removed from the API
-local environment file was removed to match the rest of the SDKs. "split".
-No other major updates for this release.
-
-1.0.0
-
-No news for this release.

data/lib/splitclient-rb/clients/localhost_split_client.rb

@@ -1,184 +0,0 @@
-module SplitIoClient
-  class LocalhostSplitClient
-    include SplitIoClient::LocalhostUtils
-
-    #
-    # variables to if the sdk is being used in localhost mode and store the list of features
-    attr_reader :localhost_mode
-    attr_reader :localhost_mode_features
-
-    #
-    # Creates a new split client instance that reads from the given splits file
-    #
-    # @param splits_file [File] file that contains some splits
-    #
-    # @return [LocalhostSplitIoClient] split.io localhost client instance
-    def initialize(splits_file, config, reload_rate = nil)
-      @localhost_mode = true
-      @localhost_mode_features = []
-      load_localhost_mode_features(splits_file, reload_rate)
-      @config = config
-    end
-
-    #
-    # method that returns the sdk gem version
-    #
-    # @return [string] version value for this sdk
-    def self.sdk_version
-      'ruby-'+SplitIoClient::VERSION
-    end
-
-    #
-    # obtains the treatments and configs for a given set of features
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_names [array] name of the features being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [hash] map of treatments (split_name, treatment)
-    def get_treatments_with_config(key, split_names, attributes = nil)
-      get_localhost_treatments(key, split_names, attributes, 'get_treatments_with_config')
-    end
-
-    #
-    # obtains the treatments for a given set of features
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_names [array] name of the features being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [hash] map of treatments (split_name, treatment_name)
-    def get_treatments(key, split_names, attributes = nil)
-      treatments = get_localhost_treatments(key, split_names, attributes)
-      return treatments if treatments.nil?
-      keys = treatments.keys
-      treats = treatments.map { |_,t| t[:treatment]  }
-      Hash[keys.zip(treats)]
-    end
-
-    #
-    # obtains the treatment for a given feature
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_name [string] name of the feature that is being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [string] corresponding treatment
-    def get_treatment(key, split_name, attributes = nil)
-      get_localhost_treatment(key, split_name, attributes)[:treatment]
-    end
-
-    #
-    # obtains the treatment and config for a given feature
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_name [string] name of the feature that is being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [hash]  corresponding treatment and config
-    def get_treatment_with_config(key, split_name, attributes = nil)
-      get_localhost_treatment(key, split_name, attributes, 'get_treatment_with_config')
-    end
-
-    def track
-    end
-
-    private
-
-    #
-    # method to check if the sdk is running in localhost mode based on api key
-    #
-    # @return [boolean] True if is in localhost mode, false otherwise
-    def is_localhost_mode?
-      true
-    end
-
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_name [string] name of the feature that is being validated
-    #
-    # @return [Hash] corresponding treatment and config, control otherwise
-    def get_localhost_treatment(key, split_name, attributes, calling_method = 'get_treatment')
-      control_treatment = { label: Engine::Models::Label::EXCEPTION, treatment: SplitIoClient::Engine::Models::Treatment::CONTROL, config: nil }
-      parsed_control_treatment = parsed_treatment(control_treatment)
-
-      bucketing_key, matching_key = keys_from_key(key)
-      return parsed_control_treatment unless @config.split_validator.valid_get_treatment_parameters(calling_method, key, split_name, matching_key, bucketing_key, attributes)
-
-      sanitized_split_name = split_name.to_s.strip
-
-      if split_name.to_s != sanitized_split_name
-        @config.logger.warn("get_treatment: split_name #{split_name} has extra whitespace, trimming")
-        split_name = sanitized_split_name
-      end
-
-      treatment = @localhost_mode_features.select { |h| h[:feature] == split_name && has_key(h[:keys], key) }.last
-
-      if treatment.nil?
-        treatment = @localhost_mode_features.select { |h| h[:feature] == split_name && h[:keys] == nil }.last
-      end
-
-      if treatment && treatment[:treatment]
-        {
-          treatment: treatment[:treatment],
-          config: treatment[:config]
-        }
-      else
-        parsed_control_treatment
-      end
-    end
-
-    def get_localhost_treatments(key, split_names, attributes = nil, calling_method = 'get_treatments')
-      return nil unless @config.split_validator.valid_get_treatments_parameters(calling_method, split_names)
-
-      sanitized_split_names = sanitize_split_names(calling_method, split_names)
-
-      if sanitized_split_names.empty?
-        @config.logger.error("#{calling_method}: split_names must be a non-empty Array")
-        return {}
-      end
-
-      split_names.each_with_object({}) do |split_name, memo|
-        memo.merge!(split_name => get_treatment_with_config(key, split_name, attributes))
-      end
-    end
-
-    def sanitize_split_names(calling_method, split_names)
-      split_names.compact.uniq.select do |split_name|
-        if (split_name.is_a?(String) || split_name.is_a?(Symbol)) && !split_name.empty?
-          true
-        elsif split_name.is_a?(String) && split_name.empty?
-          @config.logger.warn("#{calling_method}: you passed an empty split_name, split_name must be a non-empty String or a Symbol")
-          false
-        else
-          @config.logger.warn("#{calling_method}: you passed an invalid split_name, split_name must be a non-empty String or a Symbol")
-          false
-        end
-      end
-    end
-
-    def parsed_treatment(treatment_data)
-      {
-        treatment: treatment_data[:treatment],
-        config: treatment_data[:config]
-      }
-    end
-
-    def has_key(keys, key)
-      case keys
-        when Array then keys.include? key
-        when String then keys == key
-      else
-        false
-      end
-    end
-
-    def keys_from_key(key)
-      case key
-      when Hash
-        key.values_at(:bucketing_key, :matching_key).map { |k| k.nil? ? nil : k }
-      else
-        [nil, key].map { |k| k.nil? ? nil : k }
-      end
-    end
-  end
-end

data/lib/splitclient-rb/localhost_split_factory.rb

@@ -1,14 +0,0 @@
-module SplitIoClient
-  class LocalhostSplitFactory
-    attr_reader :client, :manager
-
-    def initialize(splits_file, config, reload_rate = nil, logger = nil)
-      @splits_file = splits_file
-      @reload_rate = reload_rate
-      @config = config
-
-      @client = LocalhostSplitClient.new(@splits_file, @config, @reload_rate)
-      @manager = LocalhostSplitManager.new(@splits_file, @reload_rate)
-    end
-  end
-end

data/lib/splitclient-rb/localhost_utils.rb

@@ -1,59 +0,0 @@
-module SplitIoClient
-  module LocalhostUtils
-
-    require 'yaml'
-    #
-    # method to set localhost mode features by reading the given .splits
-    #
-    # @param splits_file [File] the .split file that contains the splits
-    # @param reload_rate [Integer] the number of seconds to reload splits_file
-    # @return nil
-    def load_localhost_mode_features(splits_file, reload_rate = nil)
-      return @localhost_mode_features unless File.exists?(splits_file)
-
-      store_features(splits_file)
-
-      return unless reload_rate
-
-      Thread.new do
-        loop do
-          @localhost_mode_features = []
-          store_features(splits_file)
-
-          sleep(SplitIoClient::Utilities.randomize_interval(reload_rate))
-        end
-      end
-    end
-
-    def store_features(splits_file)
-      yaml_extensions = [".yml", ".yaml"]
-      if yaml_extensions.include? File.extname(splits_file)
-        store_yaml_features(splits_file)
-      else
-        store_plain_text_features(splits_file)
-      end
-    end
-
-    private
-
-    def store_plain_text_features(splits_file)
-      File.open(splits_file).each do |line|
-        feature, treatment = line.strip.split(' ')
-
-        next if line.start_with?('#') || line.strip.empty?
-
-        @localhost_mode_features << { feature: feature, treatment: treatment, key: nil, config: nil }
-      end
-    end
-
-    def store_yaml_features(splits_file)
-      YAML.load(File.read(splits_file)).each do |feature|
-        feat_symbolized_keys = feature[feature.keys.first].inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
-        feat_symbolized_keys[:config] = feat_symbolized_keys[:config].to_json
-
-        @localhost_mode_features << { feature: feature.keys.first }.merge(feat_symbolized_keys)
-      end
-    end
-  end
-end

data/lib/splitclient-rb/managers/localhost_split_manager.rb

@@ -1,60 +0,0 @@
-module SplitIoClient
-  class LocalhostSplitManager
-    include SplitIoClient::LocalhostUtils
-
-    #
-    # Creates a new split manager instance that holds the splits from a given file
-    #
-    # @param splits_file [File] the .split file that contains the splits
-    # @param reload_rate [Integer] the number of seconds to reload splits_file
-    #
-    # @return [LocalhostSplitIoManager] split.io localhost manager instance
-    def initialize(splits_file, reload_rate = nil)
-      @localhost_mode = true
-      @localhost_mode_features = []
-
-      load_localhost_mode_features(splits_file, reload_rate)
-    end
-
-    #
-    # method to get a split view
-    #
-    # @returns a split view
-    def split(split_name)
-      features = @localhost_mode_features.find_all { |feat| feat[:feature] == split_name }
-
-      return nil if features.nil?
-
-      treatments = features.map { |feat| feat[:treatment] }
-
-      configs = Hash[ features.map { |feat| [ feat[:treatment].to_sym, feat[:config] ] } ]
-
-      {
-        change_number: nil,
-        killed:       false,
-        name:         split_name,
-        traffic_type:  nil,
-        treatments:   treatments,
-        configs: configs
-      }
-    end
-
-    #
-    # method to get the split list from the client
-    #
-    # @returns Array of split view
-    def splits
-      split_names.map do |split_name|
-        split(split_name)
-      end
-    end
-
-    #
-    # method to get the list of just split names. Ideal for ietrating and calling client.get_treatment
-    #
-    # @returns [object] array of split names (String)
-    def split_names
-      @localhost_mode_features.map{ |feat| feat[:feature]}.uniq
-    end
-  end
-end