splitclient-rb 3.1.0.pre.rc12 → 3.1.0

data/lib/cache/senders/impressions_formatter.rb

@@ -0,0 +1,65 @@
+module SplitIoClient
+  module Cache
+    module Senders
+      class ImpressionsFormatter
+        def initialize(impressions_repository)
+          @impressions_repository = impressions_repository
+        end
+
+        def call(raw_impressions)
+          impressions = raw_impressions ? raw_impressions : @impressions_repository.clear
+          formatted_impressions = []
+          filtered_impressions = filter_impressions(impressions)
+
+          return [] if impressions.empty? || filtered_impressions.empty?
+
+          formatted_impressions = unique_features(filtered_impressions).each_with_object([]) do |feature, memo|
+            current_impressions =
+              filtered_impressions
+                .select { |i| i[:feature] == feature }
+                .map do |i|
+                  {
+                    keyName: i[:impressions]['key_name'],
+                    treatment: i[:impressions]['treatment'],
+                    time: i[:impressions]['time']
+                  }
+                end
+
+            memo << {
+              testName: feature,
+              keyImpressions: current_impressions
+            }
+          end
+
+          formatted_impressions
+        end
+
+        private
+
+        def unique_features(impressions)
+          impressions.map { |i| i[:feature] }.uniq
+        end
+
+        # Filter seen impressions by impression_hash
+        def filter_impressions(unfiltered_impressions)
+          impressions_seen = []
+
+          unfiltered_impressions.each_with_object([]) do |impression, impressions|
+            impression_hash = impression_hash(impression)
+
+            next if impressions_seen.include?(impression_hash)
+
+            impressions_seen << impression_hash
+            impressions << impression
+          end
+        end
+
+        def impression_hash(impression)
+          "#{impression[:feature]}:" \
+          "#{impression[:impressions]['key_name']}:" \
+          "#{impression[:impressions]['treatment']}"
+        end
+      end
+    end
+  end
+end

data/lib/cache/senders/impressions_sender.rb

@@ -0,0 +1,59 @@
+module SplitIoClient
+  module Cache
+    module Senders
+      class ImpressionsSender
+        def initialize(impressions_repository, config, api_key)
+          @impressions_repository = impressions_repository
+          @config = config
+          @api_key = api_key
+        end
+
+        def call
+          # Disable impressions if @config.impressions_queue_size == -1
+          if @config.impressions_queue_size < 0
+            @config.logger.info('Disabling impressions service by config')
+            return
+          end
+
+          if ENV['SPLITCLIENT_ENV'] == 'test'
+            post_impressions
+          else
+            Thread.new do
+              @config.logger.info('Starting impressions service') unless ENV['SPLITCLIENT_ENV'] == 'test'
+
+              loop do
+                post_impressions
+
+                sleep(randomize_interval(@config.impressions_refresh_rate))
+              end
+            end
+          end
+
+          @config.logger.info('Started impressions service') unless ENV['SPLITCLIENT_ENV'] == 'test'
+        end
+
+        private
+
+        def post_impressions
+          impressions_client.post
+        rescue StandardError => error
+          @config.log_found_exception(__method__.to_s, error)
+        end
+
+        def formatted_impressions(raw_impressions = nil)
+          ImpressionsFormatter.new(@impressions_repository).call(raw_impressions)
+        end
+
+        def impressions_client
+          SplitIoClient::Api::Impressions.new(@api_key, @config, formatted_impressions)
+        end
+
+        def randomize_interval(interval)
+          @random_generator ||=  Random.new
+          random_factor = @random_generator.rand(50..100)/100.0
+          interval * random_factor
+        end
+      end
+    end
+  end
+end

data/lib/engine/api/client.rb

@@ -1,18 +1,31 @@
 module SplitIoClient
   module Api
     class Client
-      def call_api(path, config, api_key, params = {})
-        api_client.get(config.base_uri + path, params) do |req|
-          req.headers['Authorization'] = 'Bearer ' + api_key
-          req.headers['SplitSDKVersion'] = SplitIoClient::SplitFactory.sdk_version
-          req.headers['SplitSDKMachineName'] = config.machine_name
-          req.headers['SplitSDKMachineIP'] = config.machine_ip
-          req.headers['Accept-Encoding'] = 'gzip'
+      def get_api(url, config, api_key, params = {})
+        api_client.get(url, params) do |req|
+          req.headers = common_headers(api_key, config).merge('Accept-Encoding' => 'gzip')
 
+          req.options.timeout = config.read_timeout
           req.options.open_timeout = config.connection_timeout
+
+          config.logger.debug("GET #{url}") if config.debug_enabled
+        end
+      end
+
+      def post_api(url, config, api_key, data, params = {})
+        api_client.post(url) do |req|
+          req.headers = common_headers(api_key, config).merge('Content-Type' => 'application/json')
+
+          req.body = data.to_json
+
           req.options.timeout = config.read_timeout
+          req.options.open_timeout = config.connection_timeout
 
-          config.logger.debug("GET #{config.base_uri + path}") if config.debug_enabled
+          if config.transport_debug_enabled
+            config.logger.debug("POST #{url} #{req.body}")
+          elsif config.debug_enabled
+            config.logger.debug("POST #{url}")
+          end
         end
       end
 
@@ -24,6 +37,15 @@ module SplitIoClient
           builder.adapter :net_http_persistent
         end
       end
+
+      def common_headers(api_key, config)
+        {
+          'Authorization' => "Bearer #{api_key}",
+          'SplitSDKVersion' => SplitIoClient::SplitFactory.sdk_version,
+          'SplitSDKMachineName' => config.machine_name,
+          'SplitSDKMachineIP' => config.machine_ip
+        }
+      end
     end
   end
 end

data/lib/engine/api/impressions.rb

@@ -0,0 +1,34 @@
+module SplitIoClient
+  module Api
+    class Impressions < Client
+      def initialize(api_key, config, impressions)
+        @config = config
+        @api_key = api_key
+        @impressions = impressions
+      end
+
+      def post
+        if @impressions.empty?
+          @config.logger.debug('No impressions to report') if @config.debug_enabled
+          return
+        end
+
+        result = post_api("#{config.events_uri}/testImpressions/bulk", @config, @api_key, @impressions)
+
+        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
+        end
+      end
+
+      def total_impressions(impressions)
+        return 0 if impressions.nil?
+
+        impressions.reduce(0) do |impressions_count, impression|
+          impressions_count += impression[:keyImpressions].length
+        end
+      end
+    end
+  end
+end

data/lib/engine/api/segments.rb

@@ -33,7 +33,7 @@ module SplitIoClient
 
       def fetch_segments(name, prefix, since)
         segments = []
-        segment = call_api('/segmentChanges/' + name, @config, @api_key, { since: since })
+        segment = get_api("#{@config.base_uri}/segmentChanges/#{name}", @config, @api_key, since: since)
 
         if segment.status / 100 == 2
           segment_content = JSON.parse(segment.body, symbolize_names: true)

data/lib/engine/api/splits.rb

@@ -10,7 +10,7 @@ module SplitIoClient
       def since(since)
         start = Time.now
         prefix = 'splitChangeFetcher'
-        splits = call_api('/splitChanges', @config, @api_key, {:since => since})
+        splits = get_api("#{@config.base_uri}/splitChanges", @config, @api_key, since: since)
 
         if splits.status / 100 == 2
           result = splits_with_segment_names(splits.body)

data/lib/engine/parser/split_adapter.rb

@@ -75,20 +75,21 @@ module SplitIoClient
       end
     end
 
-    #
-    # creates a safe thread that will be executing api calls
-    # for fetching splits and segments give the execution time
-    # provided within the configuration
-    #
-    # @return [void]
+    # 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
     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
     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
+    end
+
     #
     # helper method to execute a post request to the provided endpoint
     #
@@ -152,102 +153,6 @@ module SplitIoClient
       end
     end
 
-    def impressions_sender
-      # Disable impressions if @config.impressions_queue_size == -1
-      if @config.impressions_queue_size < 0
-        @config.logger.info("Disabling impressions service by config.")
-        return
-      end
-
-      @config.logger.info("Starting impressions service...")
-
-      # TODO: Send impressions in main thread for test ENV
-      return if ENV['SPLITCLIENT_ENV'] == 'test'
-
-      Thread.new do
-        loop do
-          begin
-            post_impressions
-
-            random_interval = randomize_interval @config.impressions_refresh_rate
-            sleep(random_interval)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
-          end
-        end
-      end
-
-      @config.logger.info("Started impressions service")
-    end
-
-    #
-    # creates the appropriate json data for the cached impressions values
-    # and then sends them to the appropriate api endpoint with a valid body format
-    #
-    # @return [void]
-    def post_impressions
-      impressions = impressions_array
-
-      if impressions.empty?
-        @config.logger.debug('No impressions to report') if @config.debug_enabled
-        return
-      end
-
-      res = post_api('/testImpressions/bulk', impressions)
-      if res.status / 100 != 2
-        @config.logger.error("Unexpected status code while posting impressions: #{res.status}")
-      else
-        @config.logger.debug("Impressions reported: #{calculate_tot_impressions(impressions)}") if @config.debug_enabled
-      end
-    end
-
-    def calculate_tot_impressions(impressions = nil)
-      tot = 0
-      return tot if impressions.nil?
-      impressions.each do |test_impression|
-        tot += test_impression[:keyImpressions].length
-      end
-      tot
-    end
-
-    # REFACTOR
-    def impressions_array(impressions = nil)
-      popped_impressions = impressions ? impressions : @impressions_repository.clear
-      test_impression_array, filtered_impressions, keys_treatments_seen = [], [], []
-
-      return [] if popped_impressions.empty?
-
-      popped_impressions.each do |item|
-        item_hash = "#{item[:feature]}:#{item[:impressions]['key_name']}:#{item[:impressions]['treatment']}"
-
-        next if keys_treatments_seen.include?(item_hash)
-
-        keys_treatments_seen << item_hash
-        filtered_impressions << item
-      end
-
-      return [] if filtered_impressions.empty?
-
-      features = filtered_impressions.map { |i| i[:feature] }.uniq
-      test_impression_array = features.each_with_object([]) do |feature, memo|
-        current_impressions = filtered_impressions.select { |i| i[:feature] == feature }
-        current_impressions.map! do |i|
-          {
-            keyName: i[:impressions]['key_name'],
-            treatment: i[:impressions]['treatment'],
-            time: i[:impressions]['time']
-          }
-        end
-
-        memo << {
-          testName: feature,
-          keyImpressions: current_impressions
-        }
-      end
-
-      test_impression_array
-    end
-
     #
     # creates the appropriate json data for the cached metrics values
     # include latencies, counts and gauges

data/lib/splitclient-rb.rb

@@ -1,7 +1,6 @@
 require 'splitclient-rb/version'
 require 'splitclient-rb/split_factory'
 require 'splitclient-rb/split_factory_builder'
-require 'splitclient-rb/localhost_split_factory_builder'
 require 'splitclient-rb/localhost_split_factory'
 require 'splitclient-rb/split_config'
 require 'exceptions/sdk_blocker_timeout_expired_exception'
@@ -19,10 +18,13 @@ require 'cache/repositories/impressions/redis_repository'
 require 'cache/repositories/metrics_repository'
 require 'cache/repositories/metrics/memory_repository'
 require 'cache/repositories/metrics/redis_repository'
+require 'cache/senders/impressions_formatter'
+require 'cache/senders/impressions_sender'
 require 'cache/stores/sdk_blocker'
 require 'cache/stores/segment_store'
 require 'cache/stores/split_store'
 require 'engine/api/client'
+require 'engine/api/impressions'
 require 'engine/api/segments'
 require 'engine/api/splits'
 require 'engine/parser/condition'

data/lib/splitclient-rb/localhost_split_factory.rb

@@ -42,6 +42,14 @@ module SplitIoClient
         @localhost_mode_features
       end
 
+      #
+      # method to get a split view
+      #
+      # @returns a split view
+      def split(split_name)
+        @localhost_mode_features.find {|x| x[:feature] == split_name}
+      end
+
       #
       # method to get the split list from the client
       #
@@ -49,6 +57,16 @@ module SplitIoClient
       def splits
         @localhost_mode_features
       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.each_with_object([]) do |split, memo|
+          memo << split[:feature]
+        end
+      end
     end
 
     class LocalhostSplitClient < NoMethodError
@@ -74,7 +92,7 @@ module SplitIoClient
       end
 
       def get_treatments(key, split_names, attributes = nil)
-        split_names.each_with_object({}) do | (name), memo|
+        split_names.each_with_object({}) do |name, memo|
           puts "name #{name} memo #{memo}"
           memo.merge!(name => get_treatment(key, name, attributes))
         end

data/lib/splitclient-rb/split_config.rb

@@ -272,6 +272,8 @@ module SplitIoClient
     #
     # @return [void]
     def startup_log
+      return if ENV['SPLITCLIENT_ENV'] == 'test'
+
       @logger.info("Loaded SDK in the #{@mode} mode")
       @logger.info("Loaded cache class: #{@cache_adapter.class}")
     end

data/lib/splitclient-rb/split_factory.rb

@@ -6,42 +6,17 @@ module SplitIoClient
   #
   class SplitFactory < NoMethodError
     class SplitManager < NoMethodError
-      #
-      # constant that defines the localhost mode
-      LOCALHOST_MODE = 'localhost'
-
       #
       # Creates a new split manager instance that connects to split.io API.
       #
       # @param api_key [String] the API key for your split account
       #
       # @return [SplitIoManager] split.io client instance
-      def initialize(api_key, config = {}, adapter = nil, splits_repository = nil, localhost_mode = false)
+      def initialize(api_key, config = {}, adapter = nil, splits_repository = nil)
         @localhost_mode_features = []
         @config = config
         @splits_repository = splits_repository
-        @localhost_mode = localhost_mode
-        if @localhost_mode
-          load_localhost_mode_features
-        else
-          @adapter = adapter
-        end
-      end
-
-      #
-      # method to set localhost mode features by reading .splits file located at home directory
-      #
-      # @returns [void]
-      def load_localhost_mode_features
-        splits_file = File.join(Dir.home, ".split")
-        if File.exists?(splits_file)
-          line_num=0
-          File.open(splits_file).each do |line|
-            line_data = line.strip.split(" ")
-            @localhost_mode_features << {feature: line_data[0], treatment: line_data[1]} unless line.start_with?('#') || line.strip.empty?
-          end
-        end
-        @localhost_mode_features
+        @adapter = adapter
       end
 
       #
@@ -49,7 +24,6 @@ module SplitIoClient
       #
       # @returns [object] array of splits
       def splits
-        return @localhost_mode_features if @localhost_mode
         return if @splits_repository.nil?
 
         @splits_repository.splits.each_with_object([]) do |(name, split), memo|
@@ -64,14 +38,6 @@ module SplitIoClient
       #
       # @returns [object] array of split names (String)
       def split_names
-        if @localhost_mode
-          local_feature_names = []
-          @localhost_mode_features.each do  |split|
-            local_feature_names << split[:feature]
-          end
-          return local_feature_names
-        end
-
         return if @splits_repository.nil?
 
         @splits_repository.split_names
@@ -82,11 +48,6 @@ module SplitIoClient
       #
       # @returns a split view
       def split(split_name)
-
-        if @localhost_mode
-          return @localhost_mode_features.find {|x| x[:feature] == split_name}
-        end
-
         if @splits_repository
           split = @splits_repository.get_split(split_name)
 
@@ -114,27 +75,14 @@ module SplitIoClient
       end
     end
 
-
     class SplitClient < NoMethodError
-      #
-      # constant that defines the localhost mode
-      LOCALHOST_MODE = 'localhost'
-
-      #
-      # 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 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, localhost_mode = false, splits_repository, segments_repository, impressions_repository, metrics_repository)
-        @localhost_mode = localhost_mode
-        @localhost_mode_features = []
-
+      def initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository)
         @config = config
 
         @splits_repository = splits_repository
@@ -142,22 +90,10 @@ module SplitIoClient
         @impressions_repository = impressions_repository
         @metrics_repository = metrics_repository
 
-        if api_key == LOCALHOST_MODE
-          @localhost_mode = true
-          load_localhost_mode_features
-        else
-          @adapter = adapter
-        end
+        @adapter = adapter
       end
 
       def get_treatments(key, split_names, attributes = nil)
-        # This localhost behavior must live in in localhost_spit_factory#client
-        if is_localhost_mode?
-          return split_names.each_with_object({}) do |name, memo|
-            memo.merge!(name => get_localhost_treatment(name))
-          end
-        end
-
         bucketing_key, matching_key = keys_from_key(key)
         bucketing_key = matching_key if bucketing_key.nil?
 
@@ -165,7 +101,9 @@ module SplitIoClient
           memo.merge!(name => get_treatment(matching_key, name, attributes, data, false))
         end
 
-        @impressions_repository.add_bulk(matching_key, treatments, (Time.now.to_f * 1000.0).to_i)
+        if @config.impressions_queue_size > 0
+          @impressions_repository.add_bulk(matching_key, treatments, (Time.now.to_f * 1000.0).to_i)
+        end
 
         treatments
       end
@@ -191,41 +129,36 @@ module SplitIoClient
           return Treatments::CONTROL
         end
 
-        if is_localhost_mode?
-          result = get_localhost_treatment(split_name)
-        else
-          start = Time.now
-          result = nil
-
-          begin
-            split = split_data ? split_data : @splits_repository.get_split(split_name)
-
-            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
-              )
-            end
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
-          end
+        start = Time.now
+        result = nil
+
+        begin
+          split = split_data ? split_data : @splits_repository.get_split(split_name)
 
-          result = result.nil? ? Treatments::CONTROL : result
+          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
+            )
+          end
+        rescue StandardError => error
+          @config.log_found_exception(__method__.to_s, error)
+        end
 
-          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, 'treatment' => result, 'time' => (Time.now.to_f * 1000.0).to_i)
-            end
+        result = result.nil? ? Treatments::CONTROL : result
 
-            # Measure
-            @adapter.metrics.time("sdk.get_treatment", latency)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
+        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, 'treatment' => result, 'time' => (Time.now.to_f * 1000.0).to_i)
           end
 
+          # Measure
+          @adapter.metrics.time("sdk.get_treatment", latency)
+        rescue StandardError => error
+          @config.log_found_exception(__method__.to_s, error)
         end
 
         result
@@ -247,42 +180,6 @@ module SplitIoClient
       def self.sdk_version
         'ruby-'+SplitIoClient::VERSION
       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?
-        @localhost_mode
-      end
-
-      #
-      # method to set localhost mode features by reading .splits file located at home directory
-      #
-      # @returns [void]
-      def load_localhost_mode_features
-        splits_file = File.join(Dir.home, ".split")
-        if File.exists?(splits_file)
-          line_num=0
-          File.open(splits_file).each do |line|
-            line_data = line.strip.split(" ")
-            @localhost_mode_features << {feature: line_data[0], treatment: line_data[1]} unless line.start_with?('#') || line.strip.empty?
-          end
-        end
-      end
-
-      #
-      # method to check the treatment for the given feature in localhost mode
-      #
-      # @return [boolean] true if the feature is available in localhost mode, false otherwise
-      def get_localhost_treatment(feature)
-        localhost_result = Treatments::CONTROL
-        treatment = @localhost_mode_features.select{|h| h[:feature] == feature}.last
-        localhost_result = treatment[:treatment] if !treatment.nil?
-        localhost_result
-      end
     end
 
     private_constant :SplitClient
@@ -297,10 +194,7 @@ module SplitIoClient
       @impressions_repository = SplitIoClient::Cache::Repositories::ImpressionsRepository.new(@config.impressions_adapter, @config)
       @metrics_repository = SplitIoClient::Cache::Repositories::MetricsRepository.new(@config.metrics_adapter, @config)
       @sdk_blocker = SplitIoClient::Cache::Stores::SDKBlocker.new(@config)
-      @adapter = api_key != 'localhost' \
-      ? SplitAdapter.new(api_key, @config, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @sdk_blocker)
-      : nil
-      @localhost_mode = api_key == 'localhost'
+      @adapter = SplitAdapter.new(api_key, @config, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @sdk_blocker)
 
       @sdk_blocker.block if @config.block_until_ready
     end
@@ -325,11 +219,11 @@ module SplitIoClient
       attr_reader :adapter
 
     def init_client
-      SplitClient.new(@api_key, @config, @adapter, @localhost_mode, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository)
+      SplitClient.new(@api_key, @config, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository)
     end
 
     def init_manager
-      SplitManager.new(@api_key, @config, @adapter, @splits_repository, @localhost_mode)
+      SplitManager.new(@api_key, @config, @adapter, @splits_repository)
     end
   end
 end