splitclient-rb 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5c4c6e0e239b150d86755ca6d3f5ae58aec3be6
-  data.tar.gz: 559ebfa78216411b6aecbe31bd885a17d2ae8d24
+  metadata.gz: 8c70d0111affdbf6d68572303ca335f9712fc8b3
+  data.tar.gz: 58b5eacffa5a95c9ff1b906b376660e0d6331788
 SHA512:
-  metadata.gz: 05fb963b7cec39bb32ab3fff03f5333fb3dde6a631af31c897c8552995f2d556d79ae977b1f0f03754021760a334bdd90d26b9886e065878b2cf955ff14ae2dd
-  data.tar.gz: 0cbde59397c915e4967358798cff31fabb750f440d605895ac83a8a1206e74de22d1036f10c28b145acc75d620e3ab51762a99462ae3630991113a4b242c7a96
+  metadata.gz: 99550497b640c1fdfc623ecf1800dea0e4d4ca6837132b81fd9c1ddd302bce2e251976fc46897670fe9ba87a1d62a1ba1a3fc4a385df43e90cbe3d1e86ada374
+  data.tar.gz: d1e7b4822aae284c209b2b866a61c4e8cfc95a71204c5b9ff96fa91c11884fa6bae83342571e81495b4b29a24610ee7d3f33fc4fe845f56a87277fd6a2c7a664

data/CHANGES.txt

@@ -1,3 +1,6 @@
+3.2.0
+- Add impression labeling
+
 3.1.3
 - Refactor SplitFactory - split it into separate mangers and client classes
 - Refactor Utilities to comply style guide

data/Detailed-README.md

@@ -152,9 +152,13 @@ split_client.get_treatment('user_id','feature_name', attr: 'val')
 
 *default value* = `Logger.new($stdout)`
 
-**block_until_ready** : The SDK will block your app for provided amount of seconds until it's ready. If timeout expires `SplitIoClient::SDKBlockerTimeoutExpiredException` will be thrown. If `false` provided, then SDK would run in non-blocking mode
+**ready** : The SDK will block your app for provided amount of seconds until it's ready. If timeout expires `SplitIoClient::SDKBlockerTimeoutExpiredException` will be thrown. If `0` provided, then SDK would run in non-blocking mode
 
-*default value* = `false`
+*default value* = `0`
+
+**labels_enabled** : Enables sending labels along with sensitive information
+
+*default value* = `true`
 
 **mode** : See [SDK modes section](#sdk-modes).
 
@@ -211,7 +215,7 @@ end
 
 #### IMPORTANT
 
-For now, SDK does not support both `producer` mode and `block_until_ready`. You must either run SDK in `standalone` mode, or do not use `block_until_ready` option.
+For now, SDK does not support both `producer` mode and `ready`. You must either run SDK in `standalone` mode, or do not use `ready` option.
 
 This begin-rescue-end block is optional, you might want to use it to catch timeout expired exception and apply some logic.
 
@@ -367,7 +371,7 @@ To run the suite of unit tests a rake task is provided.
 
 Make sure redis is running in localhost at redis://127.0.0.1:6379/0 and then just run:
 ```bash
-  SPLITCLIENT_ENV=test bundle exec rspecrake spec
+  SPLITCLIENT_ENV=test bundle exec rspec spec
 ```
 
 Also, simplecov is used for coverage reporting. After the execution of the rake task it will create the `/coverage` folder with coverage reports in pretty HTML format.

data/console

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec rake console

data/exe/splitio

@@ -54,8 +54,8 @@ opt_parser = OptionParser.new do |opts|
     options[:impressions_refresh_rate] = c
   end
 
-  opts.on("--block-until-ready=SECONDS", "Seconds to block the app until SDK is ready or false to run in non-blocking mode") do |c|
-    options[:block_until_ready] = c
+  opts.on("--ready=SECONDS", "Seconds to block the app until SDK is ready or false to run in non-blocking mode") do |c|
+    options[:ready] = c
   end
 
   opts.on("--redis-url=REDIS_URL", "Set base uri for Split SDK") do |c|

data/lib/cache/adapters/redis_adapter.rb

@@ -5,6 +5,8 @@ module SplitIoClient
     module Adapters
       # Redis adapter used to provide interface to Redis
       class RedisAdapter
+        SCAN_SLICE = 5000
+
         attr_reader :redis
 
         def initialize(redis_url)
@@ -52,7 +54,17 @@ module SplitIoClient
         end
 
         def find_strings_by_prefix(prefix)
-          @redis.keys("#{prefix}*")
+          memo = { items: [], cursor: 0 }
+
+          loop do
+            memo[:cursor], items = @redis.scan(memo[:cursor], match: "#{prefix}*", count: SCAN_SLICE)
+
+            memo[:items].push(*items)
+
+            break if memo[:cursor] == '0'
+          end
+
+          memo[:items]
         end
 
         def multiple_strings(keys)

data/lib/cache/repositories/impressions/memory_repository.rb

@@ -18,13 +18,15 @@ module SplitIoClient
             end
           end
 
-          def add_bulk(key, bucketing_key, treatments, time)
-            treatments.each do |split_name, treatment|
+          def add_bulk(key, bucketing_key, treatments_labels_change_numbers, time)
+            treatments_labels_change_numbers.each do |split_name, treatment_label_number|
               add(
                 split_name,
                 'key_name' => key,
                 'bucketing_key' => bucketing_key,
-                'treatment' => treatment,
+                'treatment' => treatment_label_number[:treatment],
+                'label' => @config.labels_enabled ? treatment_label_number[:label] : nil,
+                'change_number' => treatment_label_number[:change_number],
                 'time' => time
               )
             end
@@ -32,7 +34,7 @@ module SplitIoClient
 
           # Get everything from the queue and leave it empty
           def clear
-            @adapter.clear
+            @adapter.clear.map { |impression| impression.update(ip: @config.machine_ip) }
           end
 
           private

data/lib/cache/repositories/impressions/redis_repository.rb

@@ -13,15 +13,23 @@ module SplitIoClient
           # Store impression data in Redis
           def add(split_name, data)
             @adapter.add_to_set(
-              namespace_key("impressions.#{split_name}"), data.merge(split_name: split_name).to_json
+              namespace_key("impressions.#{split_name}"),
+              data.merge(split_name: split_name).to_json
             )
           end
 
-          def add_bulk(key, bucketing_key, treatments, time)
+          def add_bulk(key, bucketing_key, treatments_labels_change_numbers, time)
             @adapter.redis.pipelined do
-              treatments.each_slice(IMPRESSIONS_SLICE) do |treatments_slice|
-                treatments_slice.each do |split_name, treatment|
-                  add(split_name, 'key_name' => key, 'bucketing_key' => bucketing_key, 'treatment' => treatment, 'time' => time)
+              treatments_labels_change_numbers.each_slice(IMPRESSIONS_SLICE) do |treatments_labels_change_numbers_slice|
+                treatments_labels_change_numbers_slice.each do |split_name, treatment_label_change_number|
+                  add(split_name,
+                    'key_name' => key,
+                    'bucketing_key' => bucketing_key,
+                    'treatment' => treatment_label_change_number[:treatment],
+                    'label' => @config.labels_enabled ? treatment_label_change_number[:label] : nil,
+                    'change_number' => treatment_label_change_number[:change_number],
+                    'time' => time
+                  )
                 end
               end
             end
@@ -31,13 +39,15 @@ module SplitIoClient
           # delete fetched impressions afterwards
           def clear
             impressions = impression_keys.each_with_object([]) do |key, memo|
+              _, _, ip, = key.split('/')
               members = @adapter.random_set_elements(key, @config.impressions_queue_size)
               members.each do |impression|
                 parsed_impression = JSON.parse(impression)
 
                 memo << {
                   feature: parsed_impression['split_name'],
-                  impressions: parsed_impression.reject { |k, _| k == 'split_name' }
+                  impressions: parsed_impression.reject { |k| k == 'split_name' },
+                  ip: ip
                 }
               end
 
@@ -51,7 +61,7 @@ module SplitIoClient
 
           # Get all sets by prefix
           def impression_keys
-            @adapter.find_sets_by_prefix(namespace_key('impressions.'))
+            @adapter.find_sets_by_prefix("#{@config.redis_namespace}/*/impressions.*")
           end
         end
       end

data/lib/cache/repositories/repository.rb

@@ -12,7 +12,7 @@ module SplitIoClient
       protected
 
       def namespace_key(key)
-        "#{@config.redis_namespace}/#{key}"
+        "#{@config.redis_namespace}/#{@config.machine_ip}/#{key}"
       end
     end
   end

data/lib/cache/senders/impressions_formatter.rb

@@ -14,20 +14,26 @@ module SplitIoClient
           return [] if impressions.empty? || filtered_impressions.empty?
 
           formatted_impressions = unique_features(filtered_impressions).each_with_object([]) do |feature, memo|
+            ip = nil
             current_impressions =
               filtered_impressions
-                .select { |i| i[:feature] == feature }
-                .map do |i|
+                .select { |impression| impression[:feature] == feature }
+                .map do |impression|
+                  ip = impression[:ip]
                   {
-                    keyName: i[:impressions]['key_name'],
-                    treatment: i[:impressions]['treatment'],
-                    time: i[:impressions]['time']
+                    keyName: impression[:impressions]['key_name'],
+                    treatment: impression[:impressions]['treatment'],
+                    time: impression[:impressions]['time'],
+                    bucketingKey: impression[:impressions]['bucketing_key'],
+                    label: impression[:impressions]['label'],
+                    changeNumber: impression[:impressions]['change_number'],
                   }
                 end
 
             memo << {
               testName: feature,
-              keyImpressions: current_impressions
+              keyImpressions: current_impressions,
+              ip: ip
             }
           end
 
@@ -37,7 +43,7 @@ module SplitIoClient
         private
 
         def unique_features(impressions)
-          impressions.map { |i| i[:feature] }.uniq
+          impressions.map { |impression| impression[:feature] }.uniq
         end
 
         # Filter seen impressions by impression_hash
@@ -57,6 +63,8 @@ module SplitIoClient
         def impression_hash(impression)
           "#{impression[:feature]}:" \
           "#{impression[:impressions]['key_name']}:" \
+          "#{impression[:impressions]['bucketing_key']}:" \
+          "#{impression[:impressions]['change_number']}:" \
           "#{impression[:impressions]['treatment']}"
         end
       end

data/lib/cache/stores/split_store.rb

@@ -50,7 +50,7 @@ module SplitIoClient
 
           @config.logger.debug("segments seen(#{data[:segment_names].length}): #{data[:segment_names].to_a}") if @config.debug_enabled
 
-          if @config.block_until_ready && !@sdk_blocker.ready?
+          if @config.block_until_ready > 0 && !@sdk_blocker.ready?
             @sdk_blocker.splits_ready!
             @config.logger.info('splits are ready')
           end

data/lib/engine/api/client.rb

@@ -15,12 +15,16 @@ module SplitIoClient
           config.logger.debug("GET #{url}") if config.debug_enabled
         end
       rescue StandardError => e
-        config.logger.warn("#{e}\nURL:#{url}\ndata:#{data}\nparams:#{params}")
+        config.logger.warn("#{e}\nURL:#{url}\nparams:#{params}")
+
+        false
       end
 
-      def post_api(url, config, api_key, data, params = {})
+      def post_api(url, config, api_key, data, headers = {}, params = {})
         api_client.post(url) do |req|
-          req.headers = common_headers(api_key, config).merge('Content-Type' => 'application/json')
+          req.headers = common_headers(api_key, config)
+            .merge('Content-Type' => 'application/json')
+            .merge(headers)
 
           req.body = data.to_json
 
@@ -35,6 +39,8 @@ module SplitIoClient
         end
       rescue StandardError => e
         config.logger.warn("#{e}\nURL:#{url}\ndata:#{data}\nparams:#{params}")
+
+        false
       end
 
       private

data/lib/engine/api/impressions.rb

@@ -13,12 +13,14 @@ module SplitIoClient
           return
         end
 
-        result = post_api("#{@config.events_uri}/testImpressions/bulk", @config, @api_key, @impressions)
+        impressions_by_ip.each do |ip, impressions|
+          result = post_api("#{@config.events_uri}/testImpressions/bulk", @config, @api_key, impressions, 'SplitSDKMachineIP' => ip)
 
-        if result.status / 100 != 2
-          @config.logger.error("Unexpected status code while posting impressions: #{result.status}")
-        else
-          @config.logger.debug("Impressions reported: #{total_impressions(@impressions)}") if @config.debug_enabled
+          if (200..299).include? result.status
+            @config.logger.debug("Impressions reported: #{total_impressions(@impressions)}") if @config.debug_enabled
+          else
+            @config.logger.error("Unexpected status code while posting impressions: #{result.status}")
+          end
         end
       end
 
@@ -29,6 +31,12 @@ module SplitIoClient
           impressions_count += impression[:keyImpressions].length
         end
       end
+
+      private
+
+      def impressions_by_ip
+        @impressions.group_by { |impression| impression[:ip] }
+      end
     end
   end
 end

data/lib/engine/api/metrics.rb

@@ -23,11 +23,7 @@ module SplitIoClient
 
             result = post_api("#{@config.events_uri}/metrics/time", @config, @api_key, metrics_time)
 
-            if result.status / 100 != 2
-              @config.logger.error("Unexpected status code while posting time metrics: #{result.status}")
-            else
-              @config.logger.debug("Metric time reported: #{metrics_time.size}") if @config.debug_enabled
-            end
+            log_status(result, metrics_time.size)
           end
         end
 
@@ -43,15 +39,23 @@ module SplitIoClient
 
             result = post_api("#{@config.events_uri}/metrics/counter", @config, @api_key, metrics_count)
 
-            if result.status / 100 != 2
-              @config.logger.error("Unexpected status code while posting count metrics: #{result.status}")
-            else
-              @config.logger.debug("Metric counts reported: #{metrics_count.size}") if @config.debug_enabled
-            end
+            log_status(result, metrics_count.size)
           end
         end
         @metrics_repository.clear_counts
       end
+
+      private
+
+      def log_status(result, info_to_log)
+        if result == false
+          @config.logger.error("Failed to make a http request")
+        elsif (200..299).include? result.status
+          @config.logger.debug("Metric time reported: #{info_to_log}") if @config.debug_enabled
+        else
+          @config.logger.error("Unexpected status code while posting time metrics: #{result.status}")
+        end
+      end
     end
   end
 end

data/lib/engine/api/segments.rb

@@ -35,7 +35,9 @@ module SplitIoClient
         segments = []
         segment = get_api("#{@config.base_uri}/segmentChanges/#{name}", @config, @api_key, since: since)
 
-        if segment.status / 100 == 2
+        if segment == false
+          @config.logger.error("Failed to make a http request")
+        elsif segment.status / 100 == 2
           segment_content = JSON.parse(segment.body, symbolize_names: true)
           @segments_repository.set_change_number(name, segment_content[:till])
           @metrics.count(prefix + '.status.' + segment.status.to_s, 1)

data/lib/engine/api/splits.rb

@@ -12,7 +12,9 @@ module SplitIoClient
         prefix = 'splitChangeFetcher'
         splits = get_api("#{@config.base_uri}/splitChanges", @config, @api_key, since: since)
 
-        if splits.status / 100 == 2
+        if splits == false
+          @config.logger.error("Failed to make a http request")
+        elsif splits.status / 100 == 2
           result = splits_with_segment_names(splits.body)
 
           @metrics.count(prefix + '.status.' + splits.status.to_s, 1)

data/lib/engine/models/label.rb

@@ -0,0 +1,12 @@
+module SplitIoClient
+  module Engine
+    module Models
+      class Label
+        ARCHIVED = 'archived'
+        NO_RULE_MATCHED = 'no rule matched'
+        EXCEPTION = 'exception'
+        KILLED = 'killed'
+      end
+    end
+  end
+end

data/lib/engine/parser/split_adapter.rb

@@ -1,6 +1,9 @@
 require 'json'
 require 'thread'
 
+include SplitIoClient::Cache::Stores
+include SplitIoClient::Cache::Senders
+
 module SplitIoClient
   #
   # acts as an api adapater to connect to split endpoints
@@ -56,22 +59,22 @@ module SplitIoClient
 
     # Starts thread which loops constantly and stores splits in the splits_repository of choice
     def split_store
-      SplitIoClient::Cache::Stores::SplitStore.new(@splits_repository, @config, @api_key, @metrics, @sdk_blocker).call
+      SplitStore.new(@splits_repository, @config, @api_key, @metrics, @sdk_blocker).call
     end
 
     # Starts thread which loops constantly and stores segments in the segments_repository of choice
     def segment_store
-      SplitIoClient::Cache::Stores::SegmentStore.new(@segments_repository, @config, @api_key, @metrics, @sdk_blocker).call
+      SegmentStore.new(@segments_repository, @config, @api_key, @metrics, @sdk_blocker).call
     end
 
     # Starts thread which loops constantly and sends impressions to the Split API
     def impressions_sender
-      SplitIoClient::Cache::Senders::ImpressionsSender.new(@impressions_repository, @config, @api_key).call
+      ImpressionsSender.new(@impressions_repository, @config, @api_key).call
     end
 
     # Starts thread which loops constantly and sends metrics to the Split API
     def metrics_sender
-      SplitIoClient::Cache::Senders::MetricsSender.new(@metrics_repository, @config, @api_key).call
+      MetricsSender.new(@metrics_repository, @config, @api_key).call
     end
   end
 end

data/lib/engine/parser/split_treatment.rb

@@ -8,29 +8,38 @@ module SplitIoClient
 
         def call(keys, split, attributes = nil)
           split_model = Models::Split.new(split)
-          default_treatment = split[:defaultTreatment]
+          @default_treatment = split[:defaultTreatment]
 
-          return Treatments::CONTROL if split_model.archived?
+          return treatment(Models::Label::ARCHIVED, Treatments::CONTROL, split[:changeNumber]) if split_model.archived?
 
-          split_model.matchable? ? match(split, keys, attributes, default_treatment) : default_treatment
+          if split_model.matchable?
+            match(split, keys, attributes)
+          else
+            treatment(Models::Label::KILLED, @default_treatment, split[:changeNumber])
+          end
         end
 
         private
 
-        def match(split, keys, attributes, default_treatment)
+        def match(split, keys, attributes)
           split[:conditions].each do |c|
             condition = SplitIoClient::Condition.new(c)
 
             next if condition.empty?
 
             if matcher_type(condition).match?(keys[:matching_key], attributes)
-              treatment = Splitter.get_treatment(keys[:bucketing_key], split[:seed], condition.partitions)
+              key = keys[:bucketing_key] ? keys[:bucketing_key] : keys[:matching_key]
+              result = Splitter.get_treatment(key, split[:seed], condition.partitions)
 
-              return treatment.nil? ? default_treatment : treatment
+              if result.nil?
+                return treatment(Models::Label::NO_RULE_MATCHED, @default_treatment, split[:changeNumber])
+              else
+                return treatment(c[:label], result, split[:changeNumber])
+              end
             end
           end
 
-          default_treatment
+          treatment(Models::Label::NO_RULE_MATCHED, @default_treatment, split[:changeNumber])
         end
 
         def matcher_type(condition)
@@ -53,6 +62,10 @@ module SplitIoClient
             final_matcher
           end
         end
+
+        def treatment(label, treatment, change_number = nil)
+          { label: label, treatment: treatment, change_number: change_number }
+        end
       end
     end
   end

data/lib/splitclient-rb.rb

@@ -56,4 +56,5 @@ require 'engine/evaluator/splitter'
 require 'engine/metrics/metrics'
 require 'engine/metrics/binary_search_latency_tracker'
 require 'engine/models/split'
+require 'engine/models/label'
 require 'splitclient-rb_utilitites'

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

@@ -1,114 +1,136 @@
 module SplitIoClient
   class SplitClient
-  #
-  # Creates a new split client instance that connects to split.io API.
-  #
-  # @param api_key [String] the API key for your split account
-  #
-  # @return [SplitIoClient] split.io client instance
-  def initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository)
-    @config = config
-
-    @splits_repository = splits_repository
-    @segments_repository = segments_repository
-    @impressions_repository = impressions_repository
-    @metrics_repository = metrics_repository
-
-    @adapter = adapter
-  end
 
-  def get_treatments(key, split_names, attributes = nil)
-    bucketing_key, matching_key = keys_from_key(key)
-    bucketing_key = matching_key if bucketing_key.nil?
+    #
+    # Creates a new split client instance that connects to split.io API.
+    #
+    # @param api_key [String] the API key for your split account
+    #
+    # @return [SplitIoClient] split.io client instance
+    def initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository)
+      @config = config
+
+      @splits_repository = splits_repository
+      @segments_repository = segments_repository
+      @impressions_repository = impressions_repository
+      @metrics_repository = metrics_repository
+
+      @adapter = adapter
+    end
+
+    def get_treatments(key, split_names, attributes = nil)
+      bucketing_key, matching_key = keys_from_key(key)
 
-    treatments =
-      @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
-        memo.merge!(name => get_treatment(key, name, attributes, data, false))
+      treatments_labels_change_numbers =
+        @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
+          memo.merge!(name => get_treatment(key, name, attributes, data, false, true))
+        end
+
+      if @config.impressions_queue_size > 0
+        @impressions_repository.add_bulk(matching_key, bucketing_key, treatments_labels_change_numbers, (Time.now.to_f * 1000.0).to_i)
       end
 
-    if @config.impressions_queue_size > 0
-      @impressions_repository.add_bulk(matching_key, bucketing_key, treatments, (Time.now.to_f * 1000.0).to_i)
+      split_names = treatments_labels_change_numbers.keys
+      treatments = treatments_labels_change_numbers.values.map { |v| v[:treatment] }
+
+      Hash[split_names.zip(treatments)]
     end
 
-    treatments
-  end
+    #
+    # obtains the treatment for a given feature
+    #
+    # @param key [String/Hash] user id or hash with matching_key/bucketing_key
+    # @param split_name [String/Array] name of the feature that is being validated or array of them
+    # @param attributes [Hash] attributes to pass to the treatment class
+    # @param split_data [Hash] split data, when provided this method doesn't fetch splits_repository for the data
+    # @param store_impressions [Boolean] impressions aren't stored if this flag is false
+    # @param multiple [Hash] internal flag to signal if method is called by get_treatments
+    #
+    # @return [String/Hash] Treatment as String or Hash of treatments in case of array of features
+    def get_treatment(key, split_name, attributes = nil, split_data = nil, store_impressions = true, multiple = false)
+      bucketing_key, matching_key = keys_from_key(key)
+
+      if matching_key.nil?
+        @config.logger.warn('matching_key was null for split_name: ' + split_name.to_s)
+        return parsed_treatment(multiple, { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL })
+      end
 
-  #
-  # obtains the treatment for a given feature
-  #
-  # @param key [String/Hash] user id or hash with matching_key/bucketing_key
-  # @param split_name [String/Array] name of the feature that is being validated or array of them
-  #
-  # @return [String/Hash] Treatment as String or Hash of treatments in case of array of features
-  def get_treatment(key, split_name, attributes = nil, split_data = nil, store_impressions = true)
-    bucketing_key, matching_key = keys_from_key(key)
-    bucketing_key = matching_key if bucketing_key.nil?
-
-    if matching_key.nil?
-      @config.logger.warn('matching_key was null for split_name: ' + split_name.to_s)
-      return Treatments::CONTROL
-    end
+      if split_name.nil?
+        @config.logger.warn('split_name was null for key: ' + key)
+        return parsed_treatment(multiple, { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL })
+      end
 
-    if split_name.nil?
-      @config.logger.warn('split_name was null for key: ' + key)
-      return Treatments::CONTROL
-    end
+      start = Time.now
+      treatment_label_change_number = { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL }
 
-    start = Time.now
-    result = nil
+      begin
+        split = multiple ? split_data : @splits_repository.get_split(split_name)
 
-    begin
-      split = split_data ? split_data : @splits_repository.get_split(split_name)
+        if split.nil?
+          return parsed_treatment(multiple, treatment_label_change_number)
+        else
+          treatment_label_change_number = SplitIoClient::Engine::Parser::SplitTreatment.new(@segments_repository).call(
+            { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
+          )
+        end
+      rescue StandardError => error
+        @config.log_found_exception(__method__.to_s, error)
 
-      result = if split.nil?
-        Treatments::CONTROL
-      else
-        SplitIoClient::Engine::Parser::SplitTreatment.new(@segments_repository).call(
-          { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
-        )
+        return parsed_treatment(multiple, treatment_label_change_number)
       end
-    rescue StandardError => error
-      @config.log_found_exception(__method__.to_s, error)
-    end
 
-    result = result.nil? ? Treatments::CONTROL : result
-
-    begin
-      latency = (Time.now - start) * 1000.0
-      if @config.impressions_queue_size > 0 && store_impressions
-        # Disable impressions if @config.impressions_queue_size == -1
-        @impressions_repository.add(split_name,
-          'key_name' => matching_key,
-          'bucketing_key' => bucketing_key,
-          'treatment' => result,
-          'time' => (Time.now.to_f * 1000.0).to_i
-        )
+      begin
+        latency = (Time.now - start) * 1000.0
+        if @config.impressions_queue_size > 0 && store_impressions && split
+          # Disable impressions if @config.impressions_queue_size == -1
+          @impressions_repository.add(split_name,
+            'key_name' => matching_key,
+            'bucketing_key' => bucketing_key,
+            'treatment' => treatment_label_change_number[:treatment],
+            'label' => @config.labels_enabled ? treatment_label_change_number[:label] : nil,
+            'time' => (Time.now.to_f * 1000.0).to_i,
+            'change_number' => treatment_label_change_number[:change_number]
+          )
+        end
+
+        # Measure
+        @adapter.metrics.time('sdk.get_treatment', latency)
+      rescue StandardError => error
+        @config.log_found_exception(__method__.to_s, error)
+
+        return parsed_treatment(multiple, treatment_label_change_number)
       end
 
-      # Measure
-      @adapter.metrics.time("sdk.get_treatment", latency)
-    rescue StandardError => error
-      @config.log_found_exception(__method__.to_s, error)
+      parsed_treatment(multiple, treatment_label_change_number)
     end
 
-    result
-  end
+    def keys_from_key(key)
+      case key.class.to_s
+      when 'Hash'
+        key.values_at(:bucketing_key, :matching_key)
+      when 'String'
+        [nil, key]
+      end
+    end
 
-  def keys_from_key(key)
-    case key.class.to_s
-    when 'Hash'
-      key.values_at(:bucketing_key, :matching_key)
-    when 'String'
-      [key, key]
+    def parsed_treatment(multiple, treatment_label_change_number)
+      if multiple
+        {
+          treatment: treatment_label_change_number[:treatment],
+          label: treatment_label_change_number[:label],
+          change_number: treatment_label_change_number[:change_number]
+        }
+      else
+        treatment_label_change_number[:treatment]
+      end
     end
-  end
 
-  #
-  # method that returns the sdk gem version
-  #
-  # @return [string] version value for this sdk
-  def self.sdk_version
-    'ruby-'+SplitIoClient::VERSION
+    #
+    # method that returns the sdk gem version
+    #
+    # @return [string] version value for this sdk
+    def self.sdk_version
+      'ruby-'+SplitIoClient::VERSION
+    end
   end
 end
-end

data/lib/splitclient-rb/split_config.rb

@@ -52,10 +52,12 @@ module SplitIoClient
       @logger = opts[:logger] || SplitConfig.default_logger
       @debug_enabled = opts[:debug_enabled] || SplitConfig.default_debug
       @transport_debug_enabled = opts[:transport_debug_enabled] || SplitConfig.default_debug
-      @block_until_ready = opts[:block_until_ready] || false
+      @block_until_ready = opts[:ready] || opts[:block_until_ready] || 0
       @machine_name = SplitConfig.get_hostname
       @machine_ip = SplitConfig.get_ip
 
+      @labels_enabled = opts[:labels_enabled].nil? ? SplitConfig.default_labels_logging : opts[:labels_enabled]
+
       startup_log
     end
 
@@ -125,6 +127,12 @@ module SplitIoClient
     # @return [Boolean] The value for the debug flag
     attr_reader :transport_debug_enabled
 
+    #
+    # Enable logging labels and sending potentially sensitive information
+    #
+    # @return [Boolean] The value for the labels enabled flag
+    attr_reader :labels_enabled
+
     #
     # The number of seconds to wait for SDK readiness
     # or false to disable waiting
@@ -161,7 +169,7 @@ module SplitIoClient
     #
     # @return [string] version value for this sdk
     def self.sdk_version
-      'RubyClientSDK-'+SplitIoClient::VERSION
+      'ruby-'+SplitIoClient::VERSION
     end
 
     #
@@ -261,6 +269,14 @@ module SplitIoClient
       false
     end
 
+    #
+    # The default labels logging value
+    #
+    # @return [boolean]
+    def self.default_labels_logging
+      true
+    end
+
     def self.default_redis_url
       'redis://127.0.0.1:6379/0'
     end
@@ -316,12 +332,9 @@ module SplitIoClient
     #
     # @return [string]
     def self.get_ip
-      begin
-        Socket::getaddrinfo(Socket.gethostname, 'echo', Socket::AF_INET)[0][3]
-      rescue
-        #unable to get local ip
-        '127.0.0.0'
-      end
+      Socket.ip_address_list.detect { |intf| intf.ipv4_private? }.ip_address
+    rescue StandardError
+      'unknown'
     end
   end
 end

data/lib/splitclient-rb/split_factory.rb

@@ -22,7 +22,7 @@ module SplitIoClient
       @client = SplitClient.new(@api_key, @config, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository)
       @manager = SplitManager.new(@api_key, @config, @adapter, @splits_repository)
 
-      @sdk_blocker.block if @config.block_until_ready
+      @sdk_blocker.block if @config.block_until_ready > 0
     end
   end
 end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '3.1.3'
+  VERSION = '3.2.0'
 end

data/runTests

@@ -0,0 +1,2 @@
+#!/bin/bash
+SPLITCLIENT_ENV=test bundle exec rspec spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -250,6 +250,7 @@ files:
 - NEWS
 - README.md
 - Rakefile
+- console
 - exe/splitio
 - lib/cache/adapters/memory_adapter.rb
 - lib/cache/adapters/memory_adapters/map_adapter.rb
@@ -289,6 +290,7 @@ files:
 - lib/engine/matchers/whitelist_matcher.rb
 - lib/engine/metrics/binary_search_latency_tracker.rb
 - lib/engine/metrics/metrics.rb
+- lib/engine/models/label.rb
 - lib/engine/models/split.rb
 - lib/engine/parser/condition.rb
 - lib/engine/parser/partition.rb
@@ -308,6 +310,7 @@ files:
 - lib/splitclient-rb/split_factory_builder.rb
 - lib/splitclient-rb/version.rb
 - lib/splitclient-rb_utilitites.rb
+- runTests
 - splitclient-rb.gemspec
 - splitio.yml.example
 - tasks/benchmark_get_treatment.rake