splitclient-rb 4.3.2 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c780efac13986dc8c245f31efae4960eed28e3ad
-  data.tar.gz: 4d51cecaff7acda847f542f17f242ebccbce40b2
+  metadata.gz: e90a30df4c1f1e86befc5572851f37cee1e22eec
+  data.tar.gz: 8b7eeb1065058af7efe9ec9b104d4b0bd589d199
 SHA512:
-  metadata.gz: 75cf30499d4ccd57a3752fa5e125f767c20cb53a080f18a5521e481e9db447f18d582d47c5dbddb7aa0128940ad6b4edee4cc035ec88d91910d7dafffe115db6
-  data.tar.gz: fdfc055f1c25fc5c52708e46ea138ebed8dab1062ab0bdeaa3400dc0d7bd7d56172e7f09addc3b9432c7f42bac30581cfe21c5d2de461e68d134368b7c2e4bed
+  metadata.gz: da5a3fc027744717443eb00c87615444890b5cccc6c018baf89f93bd111fba8951ca1f64bdab839eead72e907befee279727402961dfb56dd1e02d8d410bc046
+  data.tar.gz: a86cd66443680a28c0b207f08cf8ff0c8e0e3130ecd9c77f542a419209c0786b3cbfe4fea4d3dc6d4afb07acb7344ac335d9478834f0a063ca3fc2e01141f910

data/CHANGES.txt

@@ -1,3 +1,9 @@
+4.4.0 (Feb 5th, 2018)
+- Add track API
+
+4.3.3 (Feb 22th, 2018)
+- Allow usage of Redis >= 3.2, not only ~> 3.2
+
 4.3.2 (Dec 19th, 2017)
 - Add DEFINITION_NOT_FOUND and rename NO_RULE_MATCHED labels
 

data/NEWS

@@ -1,3 +1,7 @@
+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

data/README.md

@@ -28,6 +28,7 @@ Split has built and maintains a SDKs for:
 * PHP [Github](https://github.com/splitio/php-client) [Docs](http://docs.split.io/docs/php-sdk-overview)
 * Python [Github](https://github.com/splitio/python-client) [Docs](http://docs.split.io/docs/python-sdk-overview)
 * GO [Github](https://github.com/splitio/go-client) [Docs](http://docs.split.io/docs/go-sdk-overview)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/v1/docs/android-sdk-overview)
 
 For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 

data/lib/splitclient-rb.rb

@@ -10,7 +10,10 @@ require 'splitclient-rb/cache/adapters/redis_adapter'
 require 'splitclient-rb/cache/repositories/repository'
 require 'splitclient-rb/cache/repositories/segments_repository'
 require 'splitclient-rb/cache/repositories/splits_repository'
+require 'splitclient-rb/cache/repositories/events_repository'
 require 'splitclient-rb/cache/repositories/impressions_repository'
+require 'splitclient-rb/cache/repositories/events/memory_repository'
+require 'splitclient-rb/cache/repositories/events/redis_repository'
 require 'splitclient-rb/cache/repositories/impressions/memory_repository'
 require 'splitclient-rb/cache/repositories/impressions/redis_repository'
 require 'splitclient-rb/cache/repositories/metrics_repository'
@@ -19,6 +22,7 @@ require 'splitclient-rb/cache/repositories/metrics/redis_repository'
 require 'splitclient-rb/cache/senders/impressions_formatter'
 require 'splitclient-rb/cache/senders/impressions_sender'
 require 'splitclient-rb/cache/senders/metrics_sender'
+require 'splitclient-rb/cache/senders/events_sender'
 require 'splitclient-rb/cache/stores/sdk_blocker'
 require 'splitclient-rb/cache/stores/segment_store'
 require 'splitclient-rb/cache/stores/split_store'
@@ -39,6 +43,7 @@ require 'splitclient-rb/engine/api/impressions'
 require 'splitclient-rb/engine/api/metrics'
 require 'splitclient-rb/engine/api/segments'
 require 'splitclient-rb/engine/api/splits'
+require 'splitclient-rb/engine/api/events'
 require 'splitclient-rb/engine/parser/condition'
 require 'splitclient-rb/engine/parser/partition'
 require 'splitclient-rb/engine/parser/split_adapter'

data/lib/splitclient-rb/cache/adapters/redis_adapter.rb

@@ -118,6 +118,21 @@ module SplitIoClient
           @redis.srandmember(key, count)
         end
 
+        # Queue
+        def add_to_queue(key, val)
+          @redis.rpush(key, val)
+        end
+
+        def get_from_queue(key, count)
+          items = @redis.lrange(key, 0, count - 1)
+          fetched_count = items.size
+          items_to_remove = (fetched_count == count) ? count : fetched_count
+
+          @redis.ltrim(key, items_to_remove, -1)
+
+          items
+        end
+
         # General
         def exists?(key)
           @redis.exists(key)

data/lib/splitclient-rb/cache/repositories/events/memory_repository.rb

@@ -0,0 +1,30 @@
+module SplitIoClient
+  module Cache
+    module Repositories
+      module Events
+        class MemoryRepository < EventsRepository
+          EVENTS_SLICE = 100
+
+          def initialize(adapter, config)
+            @adapter = adapter
+            @config = config
+          end
+
+          def add(key, traffic_type, event_type, time, value)
+            @adapter.add_to_queue(m: metadata, e: event(key, traffic_type, event_type, time, value))
+          rescue ThreadError # queue is full
+            if @config.debug_enabled
+              @config.logger.warn("Dropping events. Current size is #{@config.events_queue_size}. " \
+                                  "Consider increasing events_queue_size")
+            end
+            @adapter.clear
+          end
+
+          def clear
+            @adapter.clear
+          end
+        end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/cache/repositories/events/redis_repository.rb

@@ -0,0 +1,29 @@
+module SplitIoClient
+  module Cache
+    module Repositories
+      module Events
+        class RedisRepository < EventsRepository
+          EVENTS_SLICE = 100
+
+          def initialize(adapter, config)
+            @adapter = adapter
+            @config = config
+          end
+
+          def add(key, traffic_type, event_type, time, value)
+            @adapter.add_to_queue(
+              namespace_key('.events'),
+              { m: metadata, e: event(key, traffic_type, event_type, time, value) }.to_json,
+            )
+          end
+
+          def clear
+            @adapter.get_from_queue(namespace_key('.events'), EVENTS_SLICE).map do |e|
+              JSON.parse(e, symbolize_names: true)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/cache/repositories/events_repository.rb

@@ -0,0 +1,41 @@
+module SplitIoClient
+  module Cache
+    module Repositories
+      # Repository which forwards events interface to the selected adapter
+      class EventsRepository < Repository
+        extend Forwardable
+        def_delegators :@adapter, :add, :clear
+
+        def initialize(adapter, config)
+          @config = config
+          @adapter = case adapter.class.to_s
+          when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
+            Repositories::Events::MemoryRepository.new(adapter, config)
+          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+            Repositories::Events::RedisRepository.new(adapter, config)
+          end
+        end
+
+        protected
+
+        def metadata
+          {
+            s: "#{@config.language}-#{@config.version}",
+            i: @config.machine_ip,
+            n: @config.machine_name
+          }
+        end
+
+        def event(key, traffic_type, event_type, time, value)
+          {
+            key: key,
+            trafficTypeName: traffic_type,
+            eventTypeId: event_type,
+            value: value,
+            timestamp: time
+          }.reject { |_, v| v.nil? }
+        end
+      end
+    end
+  end
+end

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

@@ -49,7 +49,7 @@ module SplitIoClient
                 parsed_impression = JSON.parse(impression)
 
                 memo << {
-                  feature: split_name,
+                  feature: split_name.to_sym,
                   impressions: parsed_impression,
                   ip: ip
                 }

data/lib/splitclient-rb/cache/senders/events_sender.rb

@@ -0,0 +1,47 @@
+module SplitIoClient
+  module Cache
+    module Senders
+      class EventsSender
+        def initialize(events_repository, config, api_key)
+          @events_repository = events_repository
+          @config = config
+          @api_key = api_key
+        end
+
+        def call
+          if ENV['SPLITCLIENT_ENV'] == 'test'
+            post_events
+          else
+            events_thread
+
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                events_thread if forked
+              end
+            end
+          end
+        end
+
+        private
+
+        def events_thread
+          @config.threads[:events_sender] = Thread.new do
+            @config.logger.info('Starting events service')
+
+            loop do
+              post_events
+
+              sleep(SplitIoClient::Utilities.randomize_interval(@config.events_push_rate))
+            end
+          end
+        end
+
+        def post_events
+          SplitIoClient::Api::Events.new(@api_key, @config, @events_repository.clear).post
+        rescue StandardError => error
+          @config.log_found_exception(__method__.to_s, error)
+        end
+      end
+    end
+  end
+end

data/lib/splitclient-rb/cache/senders/impressions_formatter.rb

@@ -31,7 +31,7 @@ module SplitIoClient
                 end
 
             memo << {
-              testName: feature,
+              testName: feature.to_sym,
               keyImpressions: current_impressions,
               ip: ip
             }

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

@@ -55,6 +55,9 @@ module SplitIoClient
       result = get_localhost_treatment(feature)
     end
 
+    def track
+    end
+
     private
 
     #

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

@@ -6,13 +6,14 @@ module SplitIoClient
     # @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)
+    def initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository, events_repository)
       @config = config
 
       @splits_repository = splits_repository
       @segments_repository = segments_repository
       @impressions_repository = impressions_repository
       @metrics_repository = metrics_repository
+      @events_repository = events_repository
 
       @adapter = adapter
     end
@@ -136,6 +137,7 @@ module SplitIoClient
       @metrics_repository.clear
       @splits_repository.clear
       @segments_repository.clear
+      @events_repository.clear
 
       @config.logger.info('Split client shutdown complete') if @config.debug_enabled
     end
@@ -184,6 +186,10 @@ module SplitIoClient
       @impression_router ||= SplitIoClient::ImpressionRouter.new(@config)
     end
 
+    def track(key, traffic_type, event_type, value = nil)
+      @events_repository.add(key, traffic_type, event_type, (Time.now.to_f * 1000).to_i, value)
+    end
+
     def keys_from_key(key)
       case key.class.to_s
       when 'Hash'

data/lib/splitclient-rb/engine/api/client.rb

@@ -65,7 +65,7 @@ module SplitIoClient
       def referer(config)
         result = "#{config.language}-#{config.version}"
 
-        result = "#{result}::#{SplitIoClient::SplitConfig.get_hostname}" unless SplitIoClient::SplitConfig.get_hostname == 'localhost'
+        result = "#{result}::#{SplitIoClient::SplitConfig.machine_hostname}" unless SplitIoClient::SplitConfig.machine_hostname == 'localhost'
 
         result
       end

data/lib/splitclient-rb/engine/api/events.rb

@@ -0,0 +1,48 @@
+module SplitIoClient
+  module Api
+    class Events < Client
+      def initialize(api_key, config, events)
+        @config = config
+        @api_key = api_key
+        @events = events
+      end
+
+      def post
+        if @events.empty?
+          @config.logger.debug('No events to report') if @config.debug_enabled
+          return
+        end
+
+        @events.each_slice(@config.events_queue_size) do |event_slice|
+          result = post_api(
+            "#{@config.events_uri}/events/bulk",
+            @config,
+            @api_key,
+            event_slice.map { |event| formatted_event(event[:e]) },
+            'SplitSDKMachineIP' => event_slice[0][:m][:i],
+            'SplitSDKMachineName' => event_slice[0][:m][:n],
+            'SplitSDKVersion' => event_slice[0][:m][:s]
+          )
+
+          if (200..299).include? result.status
+            @config.logger.debug("Events reported: #{event_slice.size}") if @config.debug_enabled
+          else
+            @config.logger.error("Unexpected status code while posting events: #{result.status}")
+          end
+        end
+      end
+
+      private
+
+      def formatted_event(event)
+        {
+          key: event[:key],
+          trafficTypeName: event[:trafficTypeName],
+          eventTypeId: event[:eventTypeId],
+          value: event[:value].to_f,
+          timestamp: event[:timestamp].to_i
+        }
+      end
+    end
+  end
+end

data/lib/splitclient-rb/engine/parser/split_adapter.rb

@@ -25,13 +25,14 @@ module SplitIoClient
     # @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)
+    def initialize(api_key, config, splits_repository, segments_repository, impressions_repository, metrics_repository, events_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
+      @events_repository = events_repository
       @metrics = Metrics.new(100, @config, @metrics_repository)
       @sdk_blocker = sdk_blocker
 
@@ -45,6 +46,7 @@ module SplitIoClient
         segment_store
         metrics_sender
         impressions_sender
+        events_sender
       when :consumer
         # Do nothing in background
       when :producer
@@ -52,6 +54,7 @@ module SplitIoClient
         segment_store
         impressions_sender
         metrics_sender
+        events_sender
 
         sleep unless ENV['SPLITCLIENT_ENV'] == 'test'
       end
@@ -76,5 +79,10 @@ module SplitIoClient
     def metrics_sender
       MetricsSender.new(@metrics_repository, @config, @api_key).call
     end
+
+    # Starts thread which loops constantly and sends events to the Split API
+    def events_sender
+      EventsSender.new(@events_repository, @config, @api_key).call
+    end
   end
 end

data/lib/splitclient-rb/split_config.rb

@@ -53,8 +53,8 @@ module SplitIoClient
       @debug_enabled = opts[:debug_enabled] || SplitConfig.default_debug
       @transport_debug_enabled = opts[:transport_debug_enabled] || SplitConfig.default_debug
       @block_until_ready = opts[:ready] || opts[:block_until_ready] || 0
-      @machine_name = opts[:machine_name] || SplitConfig.get_hostname
-      @machine_ip = opts[:machine_ip] || SplitConfig.get_ip
+      @machine_name = opts[:machine_name] || SplitConfig.machine_hostname
+      @machine_ip = opts[:machine_ip] || SplitConfig.machine_ip
 
       @language = opts[:language] || 'ruby'
       @version = opts[:version] || SplitIoClient::VERSION
@@ -66,6 +66,12 @@ module SplitIoClient
 
       @threads = {}
 
+      @events_push_rate = opts[:events_push_rate] || SplitConfig.default_events_push_rate
+      @events_queue_size = opts[:events_queue_size] || SplitConfig.default_events_queue_size
+      @events_adapter = SplitConfig.init_cache_adapter(
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @redis_url, @events_queue_size
+      )
+
       startup_log
     end
 
@@ -110,6 +116,12 @@ module SplitIoClient
     # @return [Symbol] Metrics adapter
     attr_reader :metrics_adapter
 
+    #
+    # The cache adapter to store events in
+    #
+    # @return [Object] Metrics adapter
+    attr_reader :events_adapter
+
     #
     # The connection timeout for network connections in seconds.
     #
@@ -162,7 +174,7 @@ module SplitIoClient
     attr_reader :impression_listener_refresh_rate
 
     #
-    # Wow big the impressions queue is before dropping impressions. -1 to disable it.
+    # How big the impressions queue is before dropping impressions. -1 to disable it.
     #
     # @return [Integer]
     attr_reader :impressions_queue_size
@@ -172,6 +184,18 @@ module SplitIoClient
 
     attr_accessor :threads
 
+    #
+    # The schedule time for events flush after the first one
+    #
+    # @return [Integer]
+    attr_reader :events_push_rate
+
+    #
+    # The max size of the events queue
+    #
+    # @return [Integer]
+    attr_reader :events_queue_size
+
     #
     # The default split client configuration
     #
@@ -192,10 +216,10 @@ module SplitIoClient
       'https://events.split.io/api/'
     end
 
-    def self.init_cache_adapter(adapter, data_structure, redis_url = nil, impressions_queue_size = nil)
+    def self.init_cache_adapter(adapter, data_structure, redis_url = nil, queue_size = nil)
       case adapter
       when :memory
-        SplitIoClient::Cache::Adapters::MemoryAdapter.new(map_memory_adapter(data_structure, impressions_queue_size))
+        SplitIoClient::Cache::Adapters::MemoryAdapter.new(map_memory_adapter(data_structure, queue_size))
       when :redis
         begin
           require 'redis'
@@ -269,6 +293,14 @@ module SplitIoClient
       5000
     end
 
+    def self.default_events_push_rate
+      60
+    end
+
+    def self.default_events_queue_size
+      500
+    end
+
     #
     # The default logger object
     #
@@ -337,20 +369,17 @@ module SplitIoClient
     # gets the hostname where the sdk gem is running
     #
     # @return [string]
-    def self.get_hostname
-      begin
-        Socket.gethostname
-      rescue
-        #unable to get hostname
-        'localhost'
-      end
+    def self.machine_hostname
+      Socket.gethostname
+    rescue
+      'localhost'.freeze
     end
 
     #
     # gets the ip where the sdk gem is running
     #
     # @return [string]
-    def self.get_ip
+    def self.machine_ip
       loopback_ip = Socket.ip_address_list.find { |ip| ip.ipv4_loopback? }
       private_ip = Socket.ip_address_list.find { |ip| ip.ipv4_private? }
 

data/lib/splitclient-rb/split_factory.rb

@@ -15,18 +15,19 @@ module SplitIoClient
       @segments_repository = SegmentsRepository.new(@cache_adapter, @config)
       @impressions_repository = ImpressionsRepository.new(@config.impressions_adapter, @config)
       @metrics_repository = MetricsRepository.new(@config.metrics_adapter, @config)
+      @events_repository = EventsRepository.new(@config.events_adapter, @config)
 
       @sdk_blocker = SDKBlocker.new(@config, @splits_repository, @segments_repository)
       @adapter = start!
 
-      @client = SplitClient.new(@api_key, @config, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository)
+      @client = SplitClient.new(@api_key, @config, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository)
       @manager = SplitManager.new(@api_key, @config, @adapter, @splits_repository)
 
       @sdk_blocker.block if @config.block_until_ready > 0
     end
 
     def start!
-      SplitAdapter.new(@api_key, @config, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @sdk_blocker)
+      SplitAdapter.new(@api_key, @config, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository, @sdk_blocker)
     end
 
     alias resume! start!

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '4.3.2'
+  VERSION = '4.4.0'
 end

data/splitclient-rb.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
   spec.add_runtime_dependency "faraday", ">= 0.8"
   spec.add_runtime_dependency "net-http-persistent", "~> 2.9"
-  spec.add_runtime_dependency "redis", "~> 3.2"
+  spec.add_runtime_dependency "redis", ">= 3.2"
   spec.add_runtime_dependency "digest-murmurhash", ">= 1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 4.3.2
+  version: 4.4.0
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -210,14 +210,14 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -257,6 +257,9 @@ files:
 - lib/splitclient-rb/cache/adapters/memory_adapters/map_adapter.rb
 - lib/splitclient-rb/cache/adapters/memory_adapters/queue_adapter.rb
 - lib/splitclient-rb/cache/adapters/redis_adapter.rb
+- lib/splitclient-rb/cache/repositories/events/memory_repository.rb
+- lib/splitclient-rb/cache/repositories/events/redis_repository.rb
+- lib/splitclient-rb/cache/repositories/events_repository.rb
 - lib/splitclient-rb/cache/repositories/impressions/memory_repository.rb
 - lib/splitclient-rb/cache/repositories/impressions/redis_repository.rb
 - lib/splitclient-rb/cache/repositories/impressions_repository.rb
@@ -267,6 +270,7 @@ files:
 - lib/splitclient-rb/cache/repositories/segments_repository.rb
 - lib/splitclient-rb/cache/repositories/splits_repository.rb
 - lib/splitclient-rb/cache/routers/impression_router.rb
+- lib/splitclient-rb/cache/senders/events_sender.rb
 - lib/splitclient-rb/cache/senders/impressions_formatter.rb
 - lib/splitclient-rb/cache/senders/impressions_sender.rb
 - lib/splitclient-rb/cache/senders/metrics_sender.rb
@@ -276,6 +280,7 @@ files:
 - lib/splitclient-rb/clients/localhost_split_client.rb
 - lib/splitclient-rb/clients/split_client.rb
 - lib/splitclient-rb/engine/api/client.rb
+- lib/splitclient-rb/engine/api/events.rb
 - lib/splitclient-rb/engine/api/faraday_middleware/gzip.rb
 - lib/splitclient-rb/engine/api/impressions.rb
 - lib/splitclient-rb/engine/api/metrics.rb
@@ -350,7 +355,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for split SDK.