launchdarkly-server-sdk 5.5.7

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/azure-pipelines.yml

@@ -0,0 +1,51 @@
+jobs:
+  - job: build
+    pool:
+      vmImage: 'vs2017-win2016'
+    steps:
+      - task: PowerShell@2
+        displayName: 'Setup Dynamo'
+        inputs:
+          targetType: inline
+          workingDirectory: $(System.DefaultWorkingDirectory)
+          script: |
+            iwr -outf dynamo.zip https://s3-us-west-2.amazonaws.com/dynamodb-local/dynamodb_local_latest.zip
+            mkdir dynamo
+            Expand-Archive -Path dynamo.zip -DestinationPath dynamo
+            cd dynamo
+            javaw -D"java.library.path=./DynamoDBLocal_lib" -jar DynamoDBLocal.jar
+      - task: PowerShell@2
+        displayName: 'Setup Consul'
+        inputs:
+          targetType: inline
+          workingDirectory: $(System.DefaultWorkingDirectory)
+          script: |
+            iwr -outf consul.zip https://releases.hashicorp.com/consul/1.4.2/consul_1.4.2_windows_amd64.zip
+            mkdir consul
+            Expand-Archive -Path consul.zip -DestinationPath consul
+            cd consul
+            sc.exe create "Consul" binPath="$(System.DefaultWorkingDirectory)/consul/consul.exe agent -dev"
+            sc.exe start "Consul"
+      - task: PowerShell@2
+        displayName: 'Setup Redis'
+        inputs:
+          targetType: inline
+          workingDirectory: $(System.DefaultWorkingDirectory)
+          script: |
+            iwr -outf redis.zip https://github.com/MicrosoftArchive/redis/releases/download/win-3.0.504/Redis-x64-3.0.504.zip
+            mkdir redis
+            Expand-Archive -Path redis.zip -DestinationPath redis
+            cd redis
+            ./redis-server --service-install
+            ./redis-server --service-start
+      - task: PowerShell@2
+        displayName: 'Setup SDK and Test'
+        inputs:
+          targetType: inline
+          workingDirectory: $(System.DefaultWorkingDirectory)
+          script: |
+            ruby -v
+            gem install bundler -v 1.17.3
+            bundle install
+            mkdir rspec
+            bundle exec rspec --format progress --format RspecJunitFormatter -o ./rspec/rspec.xml spec

data/ext/mkrf_conf.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+
+
+# From http://stackoverflow.com/questions/5830835/how-to-add-openssl-dependency-to-gemspec
+# the whole reason this file exists:   to return an error if openssl
+# isn't installed.
+require "openssl"
+
+f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")   # create dummy rakefile to indicate success
+f.write("task :default\n")
+f.close

data/launchdarkly-server-sdk.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ldclient-rb/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = "launchdarkly-server-sdk"
+  spec.version       = LaunchDarkly::VERSION
+  spec.authors       = ["LaunchDarkly"]
+  spec.email         = ["team@launchdarkly.com"]
+  spec.summary       = "LaunchDarkly SDK for Ruby"
+  spec.description   = "Official LaunchDarkly SDK for Ruby"
+  spec.homepage      = "https://github.com/launchdarkly/ruby-server-sdk"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extensions    = 'ext/mkrf_conf.rb'
+
+  spec.add_development_dependency "aws-sdk-dynamodb", "~> 1.18"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0"
+  spec.add_development_dependency "diplomat", ">= 2.0.2"
+  spec.add_development_dependency "redis", "~> 3.3.5"
+  spec.add_development_dependency "connection_pool", ">= 2.1.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+  spec.add_development_dependency "listen", "~> 3.0" # see file_data_source.rb
+
+  spec.add_runtime_dependency "json", [">= 1.8", "< 3"]
+  spec.add_runtime_dependency "semantic", "~> 1.6"
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_runtime_dependency "ld-eventsource", '~> 1.0'
+end

data/lib/ldclient-rb.rb

@@ -0,0 +1,29 @@
+
+#
+# Namespace for the LaunchDarkly Ruby SDK.
+#
+module LaunchDarkly
+end
+
+require "ldclient-rb/version"
+require "ldclient-rb/interfaces"
+require "ldclient-rb/util"
+require "ldclient-rb/evaluation"
+require "ldclient-rb/flags_state"
+require "ldclient-rb/ldclient"
+require "ldclient-rb/cache_store"
+require "ldclient-rb/expiring_cache"
+require "ldclient-rb/memoized_value"
+require "ldclient-rb/in_memory_store"
+require "ldclient-rb/config"
+require "ldclient-rb/newrelic"
+require "ldclient-rb/stream"
+require "ldclient-rb/polling"
+require "ldclient-rb/user_filter"
+require "ldclient-rb/simple_lru_cache"
+require "ldclient-rb/non_blocking_thread_pool"
+require "ldclient-rb/event_summarizer"
+require "ldclient-rb/events"
+require "ldclient-rb/requestor"
+require "ldclient-rb/file_data_source"
+require "ldclient-rb/integrations"

data/lib/ldclient-rb/cache_store.rb

@@ -0,0 +1,45 @@
+require "concurrent/map"
+
+module LaunchDarkly
+  #
+  # A thread-safe in-memory store that uses the same semantics that Faraday would expect, although we
+  # no longer use Faraday. This is used by Requestor, when we are not in a Rails environment.
+  #
+  # @private
+  #
+  class ThreadSafeMemoryStore
+    #
+    # Default constructor
+    #
+    # @return [ThreadSafeMemoryStore] a new store
+    def initialize
+      @cache = Concurrent::Map.new
+    end
+
+    #
+    # Read a value from the cache
+    # @param key [Object] the cache key
+    #
+    # @return [Object] the cache value
+    def read(key)
+      @cache[key]
+    end
+
+    #
+    # Store a value in the cache
+    # @param key [Object] the cache key
+    # @param value [Object] the value to associate with the key
+    #
+    # @return [Object] the value
+    def write(key, value)
+      @cache[key] = value
+    end
+
+    #
+    # Delete a value in the cache
+    # @param key [Object] the cache key
+    def delete(key)
+      @cache.delete(key)
+    end
+  end
+end

data/lib/ldclient-rb/config.rb

@@ -0,0 +1,411 @@
+require "logger"
+
+module LaunchDarkly
+  #
+  # This class exposes advanced configuration options for the LaunchDarkly
+  # client library. Most users will not need to use a custom configuration--
+  # the default configuration sets sane defaults for most use cases.
+  #
+  #
+  class Config
+    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+
+    #
+    # Constructor for creating custom LaunchDarkly configurations.
+    #
+    # @param opts [Hash] the configuration options
+    # @option opts [Logger] :logger See {#logger}.
+    # @option opts [String] :base_uri ("https://app.launchdarkly.com") See {#base_uri}.
+    # @option opts [String] :stream_uri ("https://stream.launchdarkly.com") See {#stream_uri}.
+    # @option opts [String] :events_uri ("https://events.launchdarkly.com") See {#events_uri}.
+    # @option opts [Integer] :capacity (10000) See {#capacity}.
+    # @option opts [Float] :flush_interval (30) See {#flush_interval}.
+    # @option opts [Float] :read_timeout (10) See {#read_timeout}.
+    # @option opts [Float] :connect_timeout (2) See {#connect_timeout}.
+    # @option opts [Object] :cache_store See {#cache_store}.
+    # @option opts [Object] :feature_store See {#feature_store}.
+    # @option opts [Boolean] :use_ldd (false) See {#use_ldd?}.
+    # @option opts [Boolean] :offline (false) See {#offline?}.
+    # @option opts [Float] :poll_interval (30) See {#poll_interval}.
+    # @option opts [Boolean] :stream (true) See {#stream?}.
+    # @option opts [Boolean] all_attributes_private (false) See {#all_attributes_private}.
+    # @option opts [Array] :private_attribute_names See {#private_attribute_names}.
+    # @option opts [Boolean] :send_events (true) See {#send_events}.
+    # @option opts [Integer] :user_keys_capacity (1000) See {#user_keys_capacity}.
+    # @option opts [Float] :user_keys_flush_interval (300) See {#user_keys_flush_interval}.
+    # @option opts [Boolean] :inline_users_in_events (false) See {#inline_users_in_events}.
+    # @option opts [Object] :data_source See {#data_source}.
+    # @option opts [Object] :update_processor Obsolete synonym for `data_source`.
+    # @option opts [Object] :update_processor_factory Obsolete synonym for `data_source`.
+    #
+    def initialize(opts = {})
+      @base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
+      @stream_uri = (opts[:stream_uri] || Config.default_stream_uri).chomp("/")
+      @events_uri = (opts[:events_uri] || Config.default_events_uri).chomp("/")
+      @capacity = opts[:capacity] || Config.default_capacity
+      @logger = opts[:logger] || Config.default_logger
+      @cache_store = opts[:cache_store] || Config.default_cache_store
+      @flush_interval = opts[:flush_interval] || Config.default_flush_interval
+      @connect_timeout = opts[:connect_timeout] || Config.default_connect_timeout
+      @read_timeout = opts[:read_timeout] || Config.default_read_timeout
+      @feature_store = opts[:feature_store] || Config.default_feature_store
+      @stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
+      @use_ldd = opts.has_key?(:use_ldd) ? opts[:use_ldd] : Config.default_use_ldd
+      @offline = opts.has_key?(:offline) ? opts[:offline] : Config.default_offline
+      @poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > Config.default_poll_interval ? opts[:poll_interval] : Config.default_poll_interval
+      @all_attributes_private = opts[:all_attributes_private] || false
+      @private_attribute_names = opts[:private_attribute_names] || []
+      @send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
+      @user_keys_capacity = opts[:user_keys_capacity] || Config.default_user_keys_capacity
+      @user_keys_flush_interval = opts[:user_keys_flush_interval] || Config.default_user_keys_flush_interval
+      @inline_users_in_events = opts[:inline_users_in_events] || false
+      @data_source = opts[:data_source] || opts[:update_processor] || opts[:update_processor_factory]
+      @update_processor = opts[:update_processor]
+      @update_processor_factory = opts[:update_processor_factory]
+    end
+
+    #
+    # The base URL for the LaunchDarkly server. This is configurable mainly for testing
+    # purposes; most users should use the default value.
+    # @return [String]
+    #
+    attr_reader :base_uri
+
+    #
+    # The base URL for the LaunchDarkly streaming server. This is configurable mainly for testing
+    # purposes; most users should use the default value.
+    # @return [String]
+    #
+    attr_reader :stream_uri
+
+    #
+    # The base URL for the LaunchDarkly events server. This is configurable mainly for testing
+    # purposes; most users should use the default value.
+    # @return [String]
+    #
+    attr_reader :events_uri
+
+    #
+    # Whether streaming mode should be enabled. Streaming mode asynchronously updates
+    # feature flags in real-time using server-sent events. Streaming is enabled by default, and
+    # should only be disabled on the advice of LaunchDarkly support.
+    # @return [Boolean]
+    #
+    def stream?
+      @stream
+    end
+
+    #
+    # Whether to use the LaunchDarkly relay proxy in daemon mode. In this mode, the client does not
+    # use polling or streaming to get feature flag updates from the server, but instead reads them
+    # from the {#feature_store feature store}, which is assumed to be a database that is populated by
+    # a LaunchDarkly relay proxy. For more information, see ["The relay proxy"](https://docs.launchdarkly.com/v2.0/docs/the-relay-proxy)
+    # and ["Using a persistent feature store"](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+    #
+    # All other properties related to streaming or polling are ignored if this option is set to true.
+    #
+    # @return [Boolean]
+    #
+    def use_ldd?
+      @use_ldd
+    end
+    
+    #
+    # Whether the client should be initialized in offline mode. In offline mode, default values are
+    # returned for all flags and no remote network requests are made.
+    # @return [Boolean]
+    #
+    def offline?
+      @offline
+    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.
+    # @return [Float]
+    #
+    attr_reader :flush_interval
+
+    #
+    # The number of seconds to wait before polling for feature flag updates. This option has no
+    # effect unless streaming is disabled.
+    # @return [Float]
+    #
+    attr_reader :poll_interval
+
+    #
+    # The configured logger for the LaunchDarkly client. The client library uses the log to
+    # print warning and error messages. If not specified, this defaults to the Rails logger
+    # in a Rails environment, or stdout otherwise.
+    # @return [Logger]
+    #
+    attr_reader :logger
+
+    #
+    # The capacity of the events buffer. The client buffers up to this many
+    # events in memory before flushing. If the capacity is exceeded before
+    # the buffer is flushed, events will be discarded.
+    # Increasing the capacity means that events are less likely to be discarded,
+    # at the cost of consuming more memory.
+    # @return [Integer]
+    #
+    attr_reader :capacity
+
+    #
+    # A store for HTTP caching (used only in polling mode). This must support the semantics used by
+    # the [`faraday-http-cache`](https://github.com/plataformatec/faraday-http-cache) gem, although
+    # the SDK no longer uses Faraday. Defaults to the Rails cache in a Rails environment, or a
+    # thread-safe in-memory store otherwise.
+    # @return [Object]
+    #
+    attr_reader :cache_store
+
+    #
+    # The read timeout for network connections in seconds. This does not apply to the streaming
+    # connection, which uses a longer timeout since the server does not send data constantly.
+    # @return [Float]
+    #
+    attr_reader :read_timeout
+
+    #
+    # The connect timeout for network connections in seconds.
+    # @return [Float]
+    #
+    attr_reader :connect_timeout
+
+    #
+    # A store for feature flags and related data. The client uses it to store all data received
+    # from LaunchDarkly, and uses the last stored data when evaluating flags. Defaults to
+    # {InMemoryFeatureStore}; for other implementations, see {LaunchDarkly::Integrations}.
+    #
+    # For more information, see ["Using a persistent feature store"](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+    #
+    # @return [LaunchDarkly::Interfaces::FeatureStore]
+    #
+    attr_reader :feature_store
+
+    #
+    # True if all user attributes (other than the key) should be considered private. This means
+    # that the attribute values will not be sent to LaunchDarkly in analytics events and will not
+    # appear on the LaunchDarkly dashboard.
+    # @return [Boolean]
+    # @see #private_attribute_names
+    #
+    attr_reader :all_attributes_private
+
+    #
+    # A list of user attribute names that should always be considered private. This means that the
+    # attribute values will not be sent to LaunchDarkly in analytics events and will not appear on
+    # the LaunchDarkly dashboard.
+    #
+    # You can also specify the same behavior for an individual flag evaluation by storing an array
+    # of attribute names in the `:privateAttributeNames` property (note camelcase name) of the
+    # user object.
+    #
+    # @return [Array<String>]
+    # @see #all_attributes_private
+    #
+    attr_reader :private_attribute_names
+    
+    #
+    # Whether to send events back to LaunchDarkly. This differs from {#offline?} in that it affects
+    # only the sending of client-side events, not streaming or polling for events from the server.
+    # @return [Boolean]
+    #
+    attr_reader :send_events
+
+    #
+    # The number of user keys that the event processor can remember at any one time. This reduces the
+    # amount of duplicate user details sent in analytics events.
+    # @return [Integer]
+    # @see #user_keys_flush_interval
+    #
+    attr_reader :user_keys_capacity
+
+    #
+    # The interval in seconds at which the event processor will reset its set of known user keys.
+    # @return [Float]
+    # @see #user_keys_capacity
+    #
+    attr_reader :user_keys_flush_interval
+
+    #
+    # Whether to include full user details in every analytics event. By default, events will only
+    # include the user key, except for one "index" event that provides the full details for the user.
+    # The only reason to change this is if you are using the Analytics Data Stream.
+    # @return [Boolean]
+    #
+    attr_reader :inline_users_in_events
+
+    #
+    # An object that is responsible for receiving feature flag data from LaunchDarkly. By default,
+    # the client uses its standard polling or streaming implementation; this is customizable for
+    # testing purposes.
+    #
+    # This may be set to either an object that conforms to {LaunchDarkly::Interfaces::DataSource},
+    # or a lambda (or Proc) that takes two parameters-- SDK key and {Config}-- and returns such an
+    # object.
+    #
+    # @return [LaunchDarkly::Interfaces::DataSource|lambda]
+    # @see FileDataSource
+    #
+    attr_reader :data_source
+
+    # @deprecated This is replaced by {#data_source}.
+    attr_reader :update_processor
+    
+    # @deprecated This is replaced by {#data_source}.
+    attr_reader :update_processor_factory
+
+    #
+    # The default LaunchDarkly client configuration. This configuration sets
+    # reasonable defaults for most users.
+    # @return [Config] The default LaunchDarkly configuration.
+    #
+    def self.default
+      Config.new
+    end
+
+    #
+    # The default value for {#capacity}.
+    # @return [Integer] 10000
+    #
+    def self.default_capacity
+      10000
+    end
+
+    #
+    # The default value for {#base_uri}.
+    # @return [String] "https://app.launchdarkly.com"
+    #
+    def self.default_base_uri
+      "https://app.launchdarkly.com"
+    end
+
+    #
+    # The default value for {#stream_uri}.
+    # @return [String] "https://stream.launchdarkly.com"
+    #
+    def self.default_stream_uri
+      "https://stream.launchdarkly.com"
+    end
+
+    #
+    # The default value for {#events_uri}.
+    # @return [String] "https://events.launchdarkly.com"
+    #
+    def self.default_events_uri
+      "https://events.launchdarkly.com"
+    end
+
+    #
+    # The default value for {#cache_store}.
+    # @return [Object] the Rails cache if in Rails, or a simple in-memory implementation otherwise
+    #
+    def self.default_cache_store
+      defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
+    end
+
+    #
+    # The default value for {#flush_interval}.
+    # @return [Float] 10
+    #
+    def self.default_flush_interval
+      10
+    end
+
+    #
+    # The default value for {#read_timeout}.
+    # @return [Float] 10
+    #
+    def self.default_read_timeout
+      10
+    end
+
+    #
+    # The default value for {#connect_timeout}.
+    # @return [Float] 10
+    #
+    def self.default_connect_timeout
+      2
+    end
+
+    #
+    # The default value for {#logger}.
+    # @return [Logger] the Rails logger if in Rails, or a default Logger at WARN level otherwise
+    #
+    def self.default_logger
+      if defined?(Rails) && Rails.respond_to?(:logger)
+        Rails.logger 
+      else 
+        log = ::Logger.new($stdout)
+        log.level = ::Logger::WARN
+        log
+      end
+    end
+
+    #
+    # The default value for {#stream?}.
+    # @return [Boolean] true
+    #
+    def self.default_stream
+      true
+    end
+
+    #
+    # The default value for {#use_ldd?}.
+    # @return [Boolean] false
+    #
+    def self.default_use_ldd
+      false
+    end
+
+    #
+    # The default value for {#feature_store}.
+    # @return [LaunchDarkly::Interfaces::FeatureStore] an {InMemoryFeatureStore}
+    #
+    def self.default_feature_store
+      InMemoryFeatureStore.new
+    end
+
+    #
+    # The default value for {#offline?}.
+    # @return [Boolean] false
+    #
+    def self.default_offline
+      false
+    end
+
+    #
+    # The default value for {#poll_interval}.
+    # @return [Float] 30
+    #
+    def self.default_poll_interval
+      30
+    end
+
+    #
+    # The default value for {#send_events}.
+    # @return [Boolean] true
+    #
+    def self.default_send_events
+      true
+    end
+
+    #
+    # The default value for {#user_keys_capacity}.
+    # @return [Integer] 1000
+    #
+    def self.default_user_keys_capacity
+      1000
+    end
+
+    #
+    # The default value for {#user_keys_flush_interval}.
+    # @return [Float] 300
+    #
+    def self.default_user_keys_flush_interval
+      300
+    end
+  end
+end