ldclient-rb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e44a1aa86a1b8486920b0798f25160481a8fd06
-  data.tar.gz: 0ecdeb68b3479534fc148dc277181fd4d98d94c3
+  metadata.gz: abbd939adce22e127e3b1dc732d5d24487457a79
+  data.tar.gz: a903a1c807ce38b74c207ef53196198d5d16f489
 SHA512:
-  metadata.gz: 47fa2c0003a580ce85eb90a235a1405723fd891bef78bfff21cfa9cc84933b1f0d24dc228ccda1dd1a97d973426754bc246e2b0d80f26f0272b2e0c2d589f127
-  data.tar.gz: e4dbca380db1a33754d595b98a17969981876c0d04ea36d275c8aec95f0de9d2abe519a3ac1d443964f4c399ad7e7bc3e6eb63f167123f9de347603820d5d3c4
+  metadata.gz: 85400dc792fbe9f4ddb982cc195b0342ac74fb2e97203a910242b4b72376d1fa28522a5468c6ee9861167a4fe6e06ab4aeeac131e3f043973d6fbe2130aa7754
+  data.tar.gz: 8c1a5de8549b1b26aa4aae92b716a06740e9bdd615c4a9bdc06d763800076e1a579068fc899fd1662ee600d1635f789eb73e5930214d8af1e8a57dfd5f78cbca

data/.gitignore

@@ -11,4 +11,5 @@
 *.o
 *.a
 mkmf.log
-*.gem
+*.gem
+Gemfile.lock

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ldclient-rb.gemspec
 gemspec

data/README.md

@@ -32,4 +32,9 @@ Your first feature flag
 Learn more
 -----------
 
-Check out our [documentation](http://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](http://docs.launchdarkly.com/v1.0/docs/ruby-sdk-reference).
+Check out our [documentation](http://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](http://docs.launchdarkly.com/v1.0/docs/ruby-sdk-reference).
+
+Contributing
+------------
+
+We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/v1.0/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.

data/ldclient-rb.gemspec

@@ -6,11 +6,11 @@ require 'ldclient-rb/version'
 Gem::Specification.new do |spec|
   spec.name          = "ldclient-rb"
   spec.version       = LaunchDarkly::VERSION
-  spec.authors       = ["Catamorphic Co"]
-  spec.email         = ["team@catamorphic.com"]
+  spec.authors       = ["LaunchDarkly"]
+  spec.email         = ["team@launchdarkly.com"]
   spec.summary       = %q{LaunchDarkly SDK for Ruby}
   spec.description   = %q{Official LaunchDarkly SDK for Ruby}
-  spec.homepage      = ""
+  spec.homepage      = "https://rubygems.org/gems/ldclient-rb"
   spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -25,5 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday", "~> 0.9"
   spec.add_runtime_dependency "faraday-http-cache", "~> 0.4"
   spec.add_runtime_dependency "thread_safe", "~> 0.3"
-  spec.add_runtime_dependency "net-http-persistent", "~> 2.9.4"
+  spec.add_runtime_dependency "net-http-persistent", "~> 2.9"
+  spec.add_runtime_dependency "concurrent-ruby", "~> 0.9"
+  spec.add_runtime_dependency "hashdiff", "~> 0.2"
+  spec.add_runtime_dependency "ld-em-eventsource", "~> 0.2"
 end

data/lib/ldclient-rb.rb

@@ -2,4 +2,5 @@ require "ldclient-rb/version"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/store"
 require "ldclient-rb/config"
-require "ldclient-rb/newrelic"
+require "ldclient-rb/newrelic"
+require "ldclient-rb/stream"

data/lib/ldclient-rb/config.rb

@@ -23,6 +23,7 @@ module LaunchDarkly
     # @return [type] [description]
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
+      @stream_uri = (opts[:stream_uri] || Config.default_stream_uri).chomp("/")
       @capacity = opts[:capacity] || Config.default_capacity
       @logger = opts[:logger] || Config.default_logger
       @store = opts[:store] || Config.default_store
@@ -30,6 +31,9 @@ module LaunchDarkly
       @connect_timeout = opts[:connect_timeout] || Config.default_connect_timeout
       @read_timeout = opts[:read_timeout] || Config.default_read_timeout
       @log_timings = opts[:log_timings] || Config.default_log_timings
+      @stream = opts[:stream] || Config.default_stream
+      @feature_store = opts[:feature_store] || Config.default_feature_store
+      @debug_stream = opts[:debug_stream] || Config.default_debug_stream
     end
 
     # 
@@ -40,6 +44,32 @@ module LaunchDarkly
       @base_uri
     end
 
+    #
+    # The base URL for the LaunchDarkly streaming server.
+    # 
+    # @return [String] The configured base URL for the LaunchDarkly streaming server.
+    def stream_uri
+      @stream_uri
+    end
+
+    #
+    # Whether streaming mode should be enabled. Streaming mode asynchronously updates
+    # feature flags in real-time using server-sent events.
+    # 
+    # @return [Boolean] True if streaming mode should be enabled
+    def stream?
+      @stream
+    end
+
+    #
+    # Whether we should debug streaming mode. If set, the client will fetch features via polling
+    # and compare the retrieved feature with the value in the feature store
+    # 
+    # @return [Boolean] True if we should debug streaming mode
+    def debug_stream?
+      @debug_stream
+    end
+
     # 
     # The number of seconds between flushes of the event buffer. Decreasing the flush interval means
     # that the event buffer is less likely to reach capacity.
@@ -100,6 +130,13 @@ module LaunchDarkly
       @log_timings
     end
 
+    # 
+    # TODO docs
+    #
+    def feature_store
+      @feature_store
+    end
+
     # 
     # The default LaunchDarkly client configuration. This configuration sets reasonable defaults for most users.
     # 
@@ -116,6 +153,10 @@ module LaunchDarkly
       "https://app.launchdarkly.com"
     end
 
+    def self.default_stream_uri
+      "https://stream.launchdarkly.com"
+    end
+
     def self.default_store
       defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
     end    
@@ -140,5 +181,17 @@ module LaunchDarkly
       false
     end
 
+    def self.default_stream
+      false
+    end
+
+    def self.default_feature_store
+      nil
+    end
+
+    def self.default_debug_stream
+      false
+    end
+
   end
 end

data/lib/ldclient-rb/ldclient.rb

@@ -5,6 +5,7 @@ require 'thread'
 require 'logger'
 require 'net/http/persistent'
 require 'benchmark'
+require 'hashdiff'
 
 module LaunchDarkly
 
@@ -38,6 +39,10 @@ module LaunchDarkly
       end
       @offline = false
 
+      if @config.stream?
+        @stream_processor = StreamProcessor.new(api_key, config)
+      end
+
       @worker = create_worker()
     end
 
@@ -51,7 +56,6 @@ module LaunchDarkly
       rescue
       end
 
-
       if !events.empty?()
         res = log_timings("Flush events") {
           next @client.post (@config.base_uri + "/api/events/bulk") do |req|
@@ -124,12 +128,35 @@ module LaunchDarkly
           return default
         end
 
-        value = get_flag_int(key, user, default)
+        unless user
+          @config.logger.error("[LDClient] Must specify user")
+          return default
+        end
+
+        if @config.stream? and not @stream_processor.started?
+          @stream_processor.start
+        end
+
+        if @config.stream? and @stream_processor.initialized?
+          feature = get_flag_stream(key)
+          if @config.debug_stream?
+            polled = get_flag_int(key)
+            diff = HashDiff.diff(feature, polled)
+            if not diff.empty?
+              @config.logger.error("Streamed flag differs from polled flag " + diff.to_s)
+            end
+          end
+        else
+          feature = get_flag_int(key)
+        end
+        value = evaluate(feature, user)
+        value.nil? ? default : value
+
         add_event({:kind => 'feature', :key => key, :user => user, :value => value})
         LDNewRelic.annotate_transaction(key, value)
         return value
       rescue StandardError => error
-        @config.logger.error("[LDClient] Unhandled exception in get_flag: (#{error.class.name}) #{error.to_s}\n\t#{error.backtrace.join("\n\t")}")
+        @config.logger.error("[LDClient] Unhandled exception in toggle: (#{error.class.name}) #{error.to_s}\n\t#{error.backtrace.join("\n\t")}")
         default
       end
     end
@@ -142,7 +169,7 @@ module LaunchDarkly
         event[:creationDate] = (Time.now.to_f * 1000).to_i
         @queue.push(event)
 
-        if ! @worker.alive?
+        if !@worker.alive?
           @worker = create_worker()
         end
       else
@@ -175,7 +202,7 @@ module LaunchDarkly
     # Tracks that a user performed an event
     # 
     # @param event_name [String] The name of the event
-    # @param user [Hash] The user that performed the event. This should be the same user hash used in calls to {#get_flag?}
+    # @param user [Hash] The user that performed the event. This should be the same user hash used in calls to {#toggle?}
     # @param data [Hash] A hash containing any additional data associated with the event
     # 
     # @return [void]
@@ -183,14 +210,37 @@ module LaunchDarkly
       add_event({:kind => 'custom', :key => event_name, :user => user, :data => data })
     end
 
-    def get_flag_int(key, user, default)
+    #
+    # Returns the key of every feature
+    #
+    def feature_keys
+      get_features.map {|feature| feature[:key]}
+    end
 
-      unless user
-        @config.logger.error("[LDClient] Must specify user")
-        return default
+    #
+    # Returns all features
+    #
+    def get_features
+      res = @client.get (@config.base_uri + '/api/features') do |req|
+        req.headers['Authorization'] = 'api_key ' + @api_key
+        req.headers['User-Agent'] = 'RubyClient/' + LaunchDarkly::VERSION
+        req.options.timeout = @config.read_timeout
+        req.options.open_timeout = @config.connect_timeout
       end
 
-      res = log_timings("Flush events") {
+      if res.status == 200 then
+        return JSON.parse(res.body, symbolize_names: true)[:items]
+      else
+        @config.logger.error("[LDClient] Unexpected status code #{res.status}")
+      end
+    end
+
+    def get_flag_stream(key)
+      @stream_processor.get_feature(key)
+    end
+
+    def get_flag_int(key)
+      res = log_timings("Feature request") {
         next @client.get (@config.base_uri + '/api/eval/features/' + key) do |req|
           req.headers['Authorization'] = 'api_key ' + @api_key
           req.headers['User-Agent'] = 'RubyClient/' + LaunchDarkly::VERSION
@@ -201,25 +251,21 @@ module LaunchDarkly
 
       if res.status == 401
         @config.logger.error("[LDClient] Invalid API key")
-        return default
+        return nil
       end
 
       if res.status == 404
         @config.logger.error("[LDClient] Unknown feature key: #{key}")
-        return default
+        return nil
       end
 
       if res.status != 200
         @config.logger.error("[LDClient] Unexpected status code #{res.status}")
-        return default
+        return nil
       end
 
 
-      feature = JSON.parse(res.body, :symbolize_names => true)
-
-      val = evaluate(feature, user)
-
-      val == nil ? default : val
+      JSON.parse(res.body, :symbolize_names => true)
     end
 
     def param_for_user(feature, user)
@@ -289,13 +335,13 @@ module LaunchDarkly
     end
 
     def evaluate(feature, user)
-      unless feature[:on]
+      if feature.nil? || !feature[:on]
         return nil
       end
 
       param = param_for_user(feature, user)
 
-      if param == nil
+      if param.nil?
         return nil
       end
 
@@ -344,7 +390,7 @@ module LaunchDarkly
       return res
     end
 
-    private :add_event, :get_flag_int, :param_for_user, :match_target?, :match_user?, :match_variation?, :evaluate, :create_worker, :log_timings
+    private :add_event, :get_flag_stream, :get_flag_int, :param_for_user, :match_target?, :match_user?, :match_variation?, :evaluate, :create_worker, :log_timings
 
   end
 end

data/lib/ldclient-rb/stream.rb

@@ -0,0 +1,166 @@
+require 'concurrent/atomics'
+require 'json'
+require 'ld-em-eventsource'
+
+module LaunchDarkly
+
+  PUT = "put"
+  PATCH = "patch"
+  DELETE = "delete"
+
+  class InMemoryFeatureStore
+    def initialize()
+      @features = Hash.new
+      @lock = Concurrent::ReadWriteLock.new
+      @initialized = Concurrent::AtomicBoolean.new(false)
+    end
+
+    def get(key)
+      @lock.with_read_lock {
+        f = @features[key.to_sym]
+        (f.nil? || f[:deleted]) ? nil : f
+      }
+    end
+
+    def all()
+      @lock.with_read_lock {
+        @features.select {|k,f| not f[:deleted]}  
+      }
+    end
+
+    def delete(key, version)
+      @lock.with_write_lock {
+        old = @features[key.to_sym]
+
+        if old != nil and old[:version] < version
+          old[:deleted] = true
+          old[:version] = version
+          @features[key.to_sym] = old
+        elsif old.nil?
+          @features[key.to_sym] = {:deleted => true, :version => version}
+        end
+      }
+    end
+
+    def init(fs)
+      @lock.with_write_lock {
+        @features.replace(fs)
+        @initialized.make_true
+      }
+    end
+
+    def upsert(key, feature)
+      @lock.with_write_lock {
+        old = @features[key.to_sym]
+
+        if old.nil? or old[:version] < feature[:version]
+          @features[key.to_sym] = feature
+        end
+      }
+    end
+
+    def initialized?()
+      @initialized.value
+    end    
+  end
+
+  class StreamProcessor
+    def initialize(api_key, config)
+      @api_key = api_key
+      @config = config
+      @store = config.feature_store ? config.feature_store : InMemoryFeatureStore.new
+      @disconnected = Concurrent::AtomicReference.new(nil)
+      @started = Concurrent::AtomicBoolean.new(false)
+    end
+
+    def initialized?()
+      @store.initialized?
+    end
+
+    def started?()
+      @started.value
+    end
+
+    def get_feature(key)
+      if not initialized?
+        throw :uninitialized
+      end
+      @store.get(key)
+    end
+
+    def start_reactor()
+      if defined?(Thin)
+        @config.logger.debug("Running in a Thin environment-- not starting EventMachine")        
+      elsif EM.reactor_running?
+        @config.logger.debug("EventMachine already running")
+      else
+        @config.logger.debug("Starting EventMachine")
+        Thread.new { EM.run {} }
+        Thread.pass until EM.reactor_running?
+      end
+      EM.reactor_running?
+    end
+
+    def start()
+      # Try to start the reactor. If it's not started, we shouldn't start
+      # the stream processor
+      if not start_reactor
+        return
+      end
+
+      # If someone else booted the stream processor connection, just return
+      if not @started.make_true
+        return
+      end
+
+      # If we're the first and only thread to set started, boot
+      # the stream processor connection
+      EM.defer do
+        source = EM::EventSource.new(@config.stream_uri + "/features",
+                                    {},
+                                    {'Accept' => 'text/event-stream',
+                                     'Authorization' => 'api_key ' + @api_key,
+                                     'User-Agent' => 'RubyClient/' + LaunchDarkly::VERSION})
+        source.on PUT do |message|
+          features = JSON.parse(message, :symbolize_names => true)
+          @store.init(features)
+          set_connected            
+        end
+        source.on PATCH do |message|
+          json = JSON.parse(message, :symbolize_names => true)
+          @store.upsert(json[:path][1..-1], json[:data])
+          set_connected
+        end
+        source.on DELETE do |message|
+          json = JSON.parse(message, :symbolize_names => true)
+          @store.delete(json[:path][1..-1], json[:version])
+          set_connected
+        end
+        source.error do |error|
+          @config.logger.error("[LDClient] Error subscribing to stream API: #{error}")
+          set_disconnected
+        end
+        source.inactivity_timeout = 0
+        source.start
+      end
+    end
+
+    def set_disconnected()
+      @disconnected.set(Time.now)
+    end
+
+    def set_connected()
+      @disconnected.set(nil)
+    end
+
+    def should_fallback_update()
+      disc = @disconnected.get
+      disc != nil and disc < (Time.now - 120)
+    end
+
+    # TODO mark private methods
+    private :set_connected, :set_disconnected, :start_reactor
+
+  end
+
+end

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Catamorphic Co
+- LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,24 +100,65 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.4
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.4
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ld-em-eventsource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Official LaunchDarkly SDK for Ruby
 email:
-- team@catamorphic.com
+- team@launchdarkly.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -127,8 +168,9 @@ files:
 - lib/ldclient-rb/ldclient.rb
 - lib/ldclient-rb/newrelic.rb
 - lib/ldclient-rb/store.rb
+- lib/ldclient-rb/stream.rb
 - lib/ldclient-rb/version.rb
-homepage: ''
+homepage: https://rubygems.org/gems/ldclient-rb
 licenses:
 - Apache 2.0
 metadata: {}

data/Gemfile.lock

@@ -1,30 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ldclient-rb (0.1.0)
-      faraday (~> 0.9)
-      faraday-http-cache (~> 0.4)
-      json (~> 1.8)
-      net-http-persistent (~> 2.9.4)
-      thread_safe (~> 0.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    faraday-http-cache (0.4.2)
-      faraday (~> 0.8)
-    json (1.8.2)
-    multipart-post (2.0.0)
-    net-http-persistent (2.9.4)
-    rake (10.4.2)
-    thread_safe (0.3.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.7)
-  ldclient-rb!
-  rake (~> 10.0)