ldclient-rb 0.4.0 → 0.5.0

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/.bundle/'
+end

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+Contributing to LaunchDarkly SDK for Ruby
+=========================================
+
+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.
+
+Style
+-----
+
+Our pull requests have [Hound CI](https://houndci.com/) set up to do style checking.
+We also run [Rubocop](https://github.com/bbatsov/rubocop).

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/LICENSE.txt

@@ -10,4 +10,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

data/README.md

@@ -1,33 +1,94 @@
 LaunchDarkly SDK for Ruby
 ===========================
 
+[![Gem Version](https://badge.fury.io/rb/ldclient-rb.svg)](http://badge.fury.io/rb/ldclient-rb)
+
+[![Circle CI](https://circleci.com/gh/launchdarkly/ruby-client/tree/master.svg?style=svg)](https://circleci.com/gh/launchdarkly/ruby-client/tree/master)
+[![Code Climate](https://codeclimate.com/github/launchdarkly/ruby-client/badges/gpa.svg)](https://codeclimate.com/github/launchdarkly/ruby-client)
+[![Test Coverage](https://codeclimate.com/github/launchdarkly/ruby-client/badges/coverage.svg)](https://codeclimate.com/github/launchdarkly/ruby-client/coverage)
+[![security](https://hakiri.io/github/launchdarkly/ruby-client/master.svg)](https://hakiri.io/github/launchdarkly/ruby-client/master)
+
 Quick setup
 -----------
 
 0. Install the Ruby SDK with `gem`
 
-        gem install ldclient-rb
+```shell
+gem install ldclient-rb
+```
 
 1. Require the LaunchDarkly client:
 
-        require 'ldclient-rb'
-
+```ruby
+require 'ldclient-rb'
+```
 
 2. Create a new LDClient with your API key:
 
-        client = LaunchDarkly::LDClient.new("your_api_key")
+```ruby
+client = LaunchDarkly::LDClient.new("your_api_key")
+```
+
+### Ruby on Rails
+
+0.  Add `gem 'ldclient-rb'` to your Gemfile and `bundle install`
+
+1.  Initialize the launchdarkly client in `config/initializers/launchdarkly.rb`:
+
+```ruby
+Rails.configuration.ld_client = LaunchDarkly::LDClient.new("your_api_key")
+```
+
+2.  You may want to include a function in your ApplicationController
+
+```ruby
+    def launchdarkly_settings
+      if current_user.present?
+        {
+          key: current_user.id,
+          anonymous: false,
+          email: current_user.email,
+          custom: { groups: current_user.groups.pluck(:name) },
+          # Any other fields you may have
+          # e.g. lastName: current_user.last_name,
+        }
+      else
+        if Rails::VERSION::MAJOR <= 3
+          hash_key = request.session_options[:id]
+        else
+          hash_key = session.id
+        end
+        # session ids should be private to prevent session hijacking
+        hash_key = Digest::SHA256.base64digest hash_key
+        {
+          key: hash_key,
+          anonymous: true,
+        }
+      end
+    end
+```
+
+3.  In your controllers, access the client using
+
+```ruby
+Rails.application.config.ld_client.toggle?('your.flag.key', launchdarkly_settings, false)
+```
+
+Note that this gem will automatically switch to using the Rails logger it is detected.
 
 Your first feature flag
 -----------------------
 
 1. Create a new feature flag on your [dashboard](https://app.launchdarkly.com)
-2. In your application code, use the feature's key to check wthether the flag is on for each user:
+2. In your application code, use the feature's key to check whether the flag is on for each user:
 
-        if client.toggle?("your.flag.key", {:key => "user@test.com"}, false)
-            # application code to show the feature
-        else
-            # the code to run if the feature is off
-        end
+```ruby
+if client.toggle?("your.flag.key", {key: "user@test.com"}, false)
+  # application code to show the feature
+else
+  # the code to run if the feature is off
+end
+```
 
 Learn more
 -----------
@@ -37,7 +98,7 @@ Check out our [documentation](http://docs.launchdarkly.com) for in-depth instruc
 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.
+See [Contributing](https://github.com/launchdarkly/ruby-client/blob/master/CONTRIBUTING.md)
 
 About LaunchDarkly
 -----------
@@ -62,5 +123,3 @@ About LaunchDarkly
     * [docs.launchdarkly.com] (http://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDKs
     * [apidocs.launchdarkly.com] (http://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
     * [blog.launchdarkly.com] (http://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
-
-

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,29 @@
+machine:
+  environment:
+    RUBIES: "ruby-2.2.3;ruby-2.1.7;ruby-2.0.0;ruby-1.9.3;jruby-1.7.22"
+
+dependencies:
+  cache_directories:
+    - '../.rvm/rubies'
+
+  override:
+    - >
+      rubiesArray=(${RUBIES//;/ });
+      for i in "${rubiesArray[@]}";
+      do
+        rvm install $i;
+        rvm use $i;
+        gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
+        gem install bundler;
+        bundle install;
+      done
+
+test:
+  override:
+    - >
+      rubiesArray=(${RUBIES//;/ });
+      for i in "${rubiesArray[@]}";
+      do
+        rvm use $i;
+        bundle exec rspec spec;
+      done

data/ldclient-rb.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ldclient-rb/version'
+require "ldclient-rb/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ldclient-rb"
   spec.version       = LaunchDarkly::VERSION
   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      = "https://rubygems.org/gems/ldclient-rb"
+  spec.summary       = "LaunchDarkly SDK for Ruby"
+  spec.description   = "Official LaunchDarkly SDK for Ruby"
+  spec.homepage      = "https://github.com/launchdarkly/ruby-client"
   spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,13 +20,15 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0"
 
   spec.add_runtime_dependency "json", "~> 1.8"
   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"
-  spec.add_runtime_dependency "concurrent-ruby", "~> 0.9"
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0.0"
   spec.add_runtime_dependency "hashdiff", "~> 0.2"
   spec.add_runtime_dependency "ld-em-eventsource", "~> 0.2"
 end

data/lib/ldclient-rb/config.rb

@@ -1,25 +1,36 @@
-require 'logger'
+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. 
-  # 
-  #   
+  #
+  # 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
-    # 
-    # Constructor for creating custom LaunchDarkly configurations. 
-    # 
+    #
+    # Constructor for creating custom LaunchDarkly configurations.
+    #
     # @param opts [Hash] the configuration options
-    # @option opts [Logger] :logger A logger to use for messages from the LaunchDarkly client. Defaults to the Rails logger in a Rails environment, or stdout otherwise.
-    # @option opts [String] :base_uri ("https://app.launchdarkly.com") The base URL for the LaunchDarkly server. Most users should use the default value.
-    # @option opts [Integer] :capacity (10000) 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.
-    # @option opts [Float] :flush_interval (30) The number of seconds between flushes of the event buffer. 
-    # @option opts [Float] :read_timeout (10) The read timeout for network connections in seconds.
-    # @option opts [Float] :connect_timeout (2) The connect timeout for network connections in seconds.
-    # @option opts [Object] :store A cache store for the Faraday HTTP caching library. Defaults to the Rails cache in a Rails environment, or a thread-safe in-memory store otherwise.
-    # 
+    # @option opts [Logger] :logger A logger to use for messages from the
+    #   LaunchDarkly client. Defaults to the Rails logger in a Rails
+    #   environment, or stdout otherwise.
+    # @option opts [String] :base_uri ("https://app.launchdarkly.com") The base
+    #   URL for the LaunchDarkly server. Most users should use the default value.
+    # @option opts [Integer] :capacity (10000) 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.
+    # @option opts [Float] :flush_interval (30) The number of seconds between
+    #   flushes of the event buffer.
+    # @option opts [Float] :read_timeout (10) The read timeout for network
+    #   connections in seconds.
+    # @option opts [Float] :connect_timeout (2) The connect timeout for network
+    #   connections in seconds.
+    # @option opts [Object] :store A cache store for the Faraday HTTP caching
+    #   library. Defaults to the Rails cache in a Rails environment, or a
+    #   thread-safe in-memory store otherwise.
+    #
     # @return [type] [description]
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
@@ -30,32 +41,28 @@ module LaunchDarkly
       @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
-      @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
+      @stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
+      @log_timings = opts.has_key?(:log_timings) ? opts[:log_timings] : Config.default_log_timings
+      @debug_stream = opts.has_key?(:debug_stream) ? opts[:debug_stream] : Config.default_debug_stream
     end
 
-    # 
+    #
     # The base URL for the LaunchDarkly server.
-    # 
+    #
     # @return [String] The configured base URL for the LaunchDarkly server.
-    def base_uri
-      @base_uri
-    end
+    attr_reader :base_uri
 
     #
     # 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
+    attr_reader :stream_uri
 
     #
     # 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
@@ -64,65 +71,57 @@ module LaunchDarkly
     #
     # 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.
-    # 
+    #
     # @return [Float] The configured number of seconds between flushes of the event buffer.
-    def flush_interval
-      @flush_interval
-    end
+    attr_reader :flush_interval
 
-    # 
+    #
     # The configured logger for the LaunchDarkly client. The client library uses the log to
-    # print warning and error messages. 
-    # 
+    # print warning and error messages.
+    #
     # @return [Logger] The configured logger
-    def logger
-      @logger
-    end
+    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.
-    # 
+    #
+    # 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] The configured capacity of the event buffer
-    def capacity
-      @capacity
-    end
+    attr_reader :capacity
 
-    # 
-    # The store for the Faraday HTTP caching library. Stores should respond to 'read' and 'write' requests.
-    # 
+    #
+    # The store for the Faraday HTTP caching library. Stores should respond to
+    # 'read' and 'write' requests.
+    #
     # @return [Object] The configured store for the Faraday HTTP caching library.
-    def store
-      @store
-    end
+    attr_reader :store
 
     #
     # The read timeout for network connections in seconds.
-    # 
+    #
     # @return [Float] The read timeout in seconds.
-    def read_timeout
-      @read_timeout
-    end
+    attr_reader :read_timeout
 
     #
     # The connect timeout for network connections in seconds.
-    # 
+    #
     # @return [Float] The connect timeout in seconds.
-    def connect_timeout
-      @connect_timeout
-    end
+    attr_reader :connect_timeout
 
     #
-    # Whether timing information should be logged. If it is logged, it will be logged to the DEBUG 
+    # Whether timing information should be logged. If it is logged, it will be logged to the DEBUG
     # level on the configured logger.  This can be very verbose.
     #
     # @return [Boolean] True if timing information should be logged.
@@ -130,19 +129,18 @@ module LaunchDarkly
       @log_timings
     end
 
-    # 
+    #
     # TODO docs
     #
-    def feature_store
-      @feature_store
-    end
+    attr_reader :feature_store
 
-    # 
-    # The default LaunchDarkly client configuration. This configuration sets reasonable defaults for most users.
-    # 
+    #
+    # The default LaunchDarkly client configuration. This configuration sets
+    # reasonable defaults for most users.
+    #
     # @return [Config] The default LaunchDarkly configuration.
     def self.default
-      Config.new()
+      Config.new
     end
 
     def self.default_capacity
@@ -159,7 +157,7 @@ module LaunchDarkly
 
     def self.default_store
       defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
-    end    
+    end
 
     def self.default_flush_interval
       10
@@ -192,6 +190,5 @@ module LaunchDarkly
     def self.default_debug_stream
       false
     end
-
   end
-end
+end