splitclient-rb 3.1.2 → 3.1.3.pre.rc1

data/lib/cache/stores/segment_store.rb

@@ -26,7 +26,7 @@ module SplitIoClient
 
         def blocked_store
           loop do
-            next unless @sdk_blocker.splits_ready
+            next unless @sdk_blocker.splits_repository.ready?
 
             store_segments
             @config.logger.debug("Segment names: #{@segments_repository.used_segment_names.to_a}") if @config.debug_enabled

data/lib/engine/api/client.rb

@@ -1,3 +1,7 @@
+require 'faraday/http_cache'
+require 'bundler/vendor/net/http/persistent' unless defined?(Net::HTTP)
+require 'faraday_middleware'
+
 module SplitIoClient
   module Api
     class Client
@@ -41,11 +45,20 @@ module SplitIoClient
       def common_headers(api_key, config)
         {
           'Authorization' => "Bearer #{api_key}",
-          'SplitSDKVersion' => SplitIoClient::SplitFactory.sdk_version,
+          'SplitSDKVersion' => SplitIoClient::SplitConfig.sdk_version,
           'SplitSDKMachineName' => config.machine_name,
-          'SplitSDKMachineIP' => config.machine_ip
+          'SplitSDKMachineIP' => config.machine_ip,
+          'Referer' => referer
         }
       end
+
+      def referer
+        result = SplitIoClient::SplitConfig.sdk_version
+
+        result = "#{result}::#{SplitIoClient::SplitConfig.get_hostname}" unless SplitIoClient::SplitConfig.get_hostname == 'localhost'
+
+        result
+      end
     end
   end
 end

data/lib/engine/api/metrics.rb

@@ -0,0 +1,57 @@
+module SplitIoClient
+  module Api
+    class Metrics < Client
+      def initialize(api_key, config, metrics_repository)
+        @config = config
+        @api_key = api_key
+        @metrics_repository = metrics_repository
+      end
+
+      def post
+        post_latencies
+        post_counts
+      end
+
+      private
+
+      def post_latencies
+        if @metrics_repository.latencies.empty?
+          @config.logger.debug('No latencies to report.') if @config.debug_enabled
+        else
+          @metrics_repository.latencies.each do |name, latencies|
+            metrics_time = { name: name, latencies: latencies }
+
+            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
+          end
+        end
+
+        @metrics_repository.clear_latencies
+      end
+
+      def post_counts
+        if @metrics_repository.counts.empty?
+          @config.logger.debug('No counts to report.') if @config.debug_enabled
+        else
+          @metrics_repository.counts.each do |name, count|
+            metrics_count = { name: name, delta: count }
+
+            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
+          end
+        end
+        @metrics_repository.clear_counts
+      end
+    end
+  end
+end

data/lib/engine/parser/split_adapter.rb

@@ -1,58 +1,37 @@
 require 'json'
 require 'thread'
-require 'faraday/http_cache'
-require 'bundler/vendor/net/http/persistent' unless defined?(Net::HTTP)
-require 'faraday_middleware'
-
 
 module SplitIoClient
-
   #
   # acts as an api adapater to connect to split endpoints
   # uses a configuration object that can be modified when creating the client instance
   # also, uses safe threads to execute fetches and post give the time execution values from the config
   #
   class SplitAdapter < NoMethodError
-    #
-    # handler for metrics
-    attr_reader :metrics
-
-    #
-    # handler for parsed splits
-    attr_reader :parsed_splits
-
-    #
-    # handeler for parsed segments
-    attr_reader :parsed_segments
-
-    attr_reader :impressions_producer
-
-    attr_reader :splits_repository, :segments_repository, :impressions_repository
+    attr_reader :splits_repository, :segments_repository, :impressions_repository, :metrics
 
     #
     # Creates a new split api adapter instance that consumes split api endpoints
     #
     # @param api_key [String] the API key for your split account
+    # @param config [SplitConfig] SplitConfig instance
+    # @param splits_repository [SplitsRepository] SplitsRepository instance to store splits in
+    # @param segments_repository [SegmentsRepository] SegmentsRepository instance to store segments in
+    # @param impressions_repository [ImpressionsRepository] ImpressionsRepository instance to store impressions in
+    # @param metrics_repository [MetricsRepository] SplitsRepository instance to store metrics in
+    # @param sdk_blocker [SDKBlocker] SDKBlocker instance which blocks splits_repository/segments_repository
     #
     # @return [SplitIoClient] split.io client instance
     def initialize(api_key, config, splits_repository, segments_repository, impressions_repository, metrics_repository, sdk_blocker)
       @api_key = api_key
       @config = config
-
       @splits_repository = splits_repository
       @segments_repository = segments_repository
       @impressions_repository = impressions_repository
       @metrics_repository = metrics_repository
-
       @metrics = Metrics.new(100, @config, @metrics_repository)
-
       @sdk_blocker = sdk_blocker
 
-      @api_client = Faraday.new do |builder|
-        builder.use FaradayMiddleware::Gzip
-        builder.adapter :net_http_persistent
-      end
-
       start_based_on_mode(@config.mode)
     end
 
@@ -90,119 +69,9 @@ module SplitIoClient
       SplitIoClient::Cache::Senders::ImpressionsSender.new(@impressions_repository, @config, @api_key).call
     end
 
-    #
-    # helper method to execute a post request to the provided endpoint
-    #
-    # @param path [string] api endpoint path
-    # @param params [object] hash of params that will be added to the request
-    #
-    # @return [object] response to the request
-    def post_api(path, param)
-      @api_client.post (@config.events_uri + path) do |req|
-        req.headers['Authorization'] = 'Bearer ' + @api_key
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['SplitSDKVersion'] = SplitIoClient::SplitFactory.sdk_version
-        req.headers['SplitSDKMachineName'] = @config.machine_name
-        req.headers['SplitSDKMachineIP'] = @config.machine_ip
-        req.body = param.to_json
-        req.options.timeout = @config.read_timeout
-        req.options.open_timeout = @config.connection_timeout
-
-        if @config.transport_debug_enabled
-          @config.logger.debug("POST #{@config.events_uri + path} #{req.body}")
-        elsif @config.debug_enabled
-          @config.logger.debug("POST #{@config.events_uri + path}")
-        end
-
-      end
-    end
-
-    #
-    # @return parsed_splits [object] parsed splits for this adapter
-    def parsed_splits
-      @parsed_splits
-    end
-
-    #
-    # @return parsed_segments [object] parsed segments for this adapter
-    def parsed_segments
-      @parsed_segments
-    end
-
-    #
-    # creates two safe threads that will be executing api calls
-    # for posting impressions and metrics given the execution time
-    # provided within the configuration
-    #
-
+    # Starts thread which loops constantly and sends metrics to the Split API
     def metrics_sender
-      # TODO: Send metrics in main thread for test ENV
-      return if ENV['SPLITCLIENT_ENV'] == 'test'
-
-      Thread.new do
-
-        @config.logger.info('Starting metrics service')
-
-        loop do
-          begin
-
-            post_metrics
-
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
-          end
-
-          # Sleep either on success of failure.
-          sleep(randomize_interval(@config.metrics_refresh_rate))
-        end
-      end
-
-    end
-
-    #
-    # creates the appropriate json data for the cached metrics values
-    # include latencies, counts and gauges
-    # and then sends them to the appropriate api endpoint with a valida body format
-    #
-    # @return [void]
-    def post_metrics
-      if @metrics_repository.latencies.empty?
-        @config.logger.debug('No latencies to report.') if @config.debug_enabled
-      else
-        @metrics_repository.latencies.each do |name, latencies|
-          metrics_time = { name: name, latencies: latencies }
-          res = post_api('/metrics/time', metrics_time)
-          if res.status / 100 != 2
-            @config.logger.error("Unexpected status code while posting time metrics: #{res.status}")
-          else
-            @config.logger.debug("Metric time reported: #{metrics_time.size}") if @config.debug_enabled
-          end
-        end
-      end
-      @metrics_repository.clear_latencies
-
-      if @metrics_repository.counts.empty?
-        @config.logger.debug('No counts to report.') if @config.debug_enabled
-      else
-        @metrics_repository.counts.each do |name, count|
-          metrics_count = { name: name, delta: count }
-          res = post_api('/metrics/counter', metrics_count)
-          if res.status / 100 != 2
-            @config.logger.error("Unexpected status code while posting count metrics: #{res.status}")
-          else
-            @config.logger.debug("Metric counts reported: #{metrics_count.size}") if @config.debug_enabled
-          end
-        end
-      end
-      @metrics_repository.clear_counts
-    end
-
-    private
-
-    def randomize_interval(interval)
-      @random_generator ||=  Random.new
-      random_factor = @random_generator.rand(50..100)/100.0
-      interval * random_factor
+      SplitIoClient::Cache::Senders::MetricsSender.new(@metrics_repository, @config, @api_key).call
     end
   end
 end

data/lib/engine/parser/split_treatment.rb

@@ -36,11 +36,13 @@ module SplitIoClient
         def matcher_type(condition)
           matchers = []
 
-          condition.matchers.each do |matcher|
-            matchers << condition.send(
-              "matcher_#{matcher[:matcherType].downcase}",
-              matcher: matcher, segments_repository: @segments_repository
-            )
+          @segments_repository.adapter.pipelined do
+            condition.matchers.each do |matcher|
+              matchers << condition.send(
+                "matcher_#{matcher[:matcherType].downcase}",
+                matcher: matcher, segments_repository: @segments_repository
+              )
+            end
           end
 
           final_matcher = condition.create_condition_matcher(matchers)

data/lib/engine/partitions/treatments.rb

@@ -1,10 +1,8 @@
 module SplitIoClient
-
   #
   # represents the possible return values for a treatment
   #
   class Treatments < NoMethodError
-
     # Constants to represent treatment values
     CONTROL = 'control'
     OFF = 'off'
@@ -34,7 +32,5 @@ module SplitIoClient
     def self.is_control?(treatment)
       get_type(treatment).equal?(CONTROL) ? true : false
     end
-
   end
-
-end
+end

data/lib/splitclient-rb.rb

@@ -1,8 +1,5 @@
 require 'splitclient-rb/version'
-require 'splitclient-rb/split_factory'
-require 'splitclient-rb/split_factory_builder'
-require 'splitclient-rb/localhost_split_factory'
-require 'splitclient-rb/split_config'
+
 require 'exceptions/sdk_blocker_timeout_expired_exception'
 require 'cache/adapters/memory_adapters/map_adapter'
 require 'cache/adapters/memory_adapters/queue_adapter'
@@ -20,11 +17,24 @@ require 'cache/repositories/metrics/memory_repository'
 require 'cache/repositories/metrics/redis_repository'
 require 'cache/senders/impressions_formatter'
 require 'cache/senders/impressions_sender'
+require 'cache/senders/metrics_sender'
 require 'cache/stores/sdk_blocker'
 require 'cache/stores/segment_store'
 require 'cache/stores/split_store'
+
+require 'splitclient-rb/localhost_utils'
+require 'splitclient-rb/clients/localhost_split_client'
+require 'splitclient-rb/clients/split_client'
+require 'splitclient-rb/managers/localhost_split_manager'
+require 'splitclient-rb/managers/split_manager'
+require 'splitclient-rb/split_factory'
+require 'splitclient-rb/split_factory_builder'
+require 'splitclient-rb/localhost_split_factory'
+require 'splitclient-rb/split_config'
+
 require 'engine/api/client'
 require 'engine/api/impressions'
+require 'engine/api/metrics'
 require 'engine/api/segments'
 require 'engine/api/splits'
 require 'engine/parser/condition'

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

@@ -0,0 +1,89 @@
+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, reload_rate = nil)
+      @localhost_mode = true
+      @localhost_mode_features = []
+      load_localhost_mode_features(splits_file, reload_rate)
+    end
+
+    #
+    # method that returns the sdk gem version
+    #
+    # @return [string] version value for this sdk
+    def self.sdk_version
+      'RubyClientSDK-'+SplitIoClient::VERSION
+    end
+
+    def get_treatments(key, split_names, attributes = nil)
+      split_names.each_with_object({}) do |name, memo|
+        puts "name #{name} memo #{memo}"
+        memo.merge!(name => get_treatment(key, name, attributes))
+      end
+    end
+
+    #
+    # obtains the treatment for a given feature
+    #
+    # @param id [string] user id
+    # @param feature [string] name of the feature that is being validated
+    #
+    # @return [Treatment]  treatment constant value
+    def get_treatment(id, feature, attributes = nil)
+      unless id
+        @config.logger.warn('id was null for feature: ' + feature)
+        return Treatments::CONTROL
+      end
+
+      unless feature
+        @config.logger.warn('feature was null for id: ' + id)
+        return Treatments::CONTROL
+      end
+
+      result = get_localhost_treatment(feature)
+    end
+
+    private
+
+    #
+    # auxiliary method to get the treatments avoding exceptions
+    #
+    # @param id [string] user id
+    # @param feature [string] name of the feature that is being validated
+    #
+    # @return [Treatment]  tretment constant value
+    def get_treatment_without_exception_handling(id, feature, attributes = nil)
+      get_treatment(id, feature, attributes)
+    end
+
+    #
+    # 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
+
+    #
+    # 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)
+      treatment = @localhost_mode_features.select { |h| h[:feature] == feature }.last || {}
+
+      treatment[:treatment] || Treatments::CONTROL
+    end
+  end
+end