Merge branch 'master' into eb/no-faraday

# Conflicts:
#	lib/ldclient-rb/requestor.rb
#	spec/http_util.rb
#	spec/requestor_spec.rb

Author: eli-darkly

.circleci/config.yml

@@ -19,7 +19,7 @@ ruby-docker-template: &ruby-docker-template
           gem install jruby-openssl; # required by bundler, no effect on Ruby MRI
         fi
     - run: ruby -v
-    - run: gem install bundler -v "~> 1.7"
+    - run: gem install bundler -v 1.17.3
     - run: bundle install
     - run: mkdir ./rspec
     - run: bundle exec rspec --format progress --format RspecJunitFormatter -o ./rspec/rspec.xml spec
@@ -33,30 +33,35 @@ jobs:
     <<: *ruby-docker-template
     docker:
       - image: circleci/ruby:2.2.10-jessie
+      - image: consul
       - image: redis
       - image: amazon/dynamodb-local
   test-2.3:
     <<: *ruby-docker-template
     docker:
       - image: circleci/ruby:2.3.7-jessie
+      - image: consul
       - image: redis
       - image: amazon/dynamodb-local
   test-2.4:
     <<: *ruby-docker-template
     docker:
       - image: circleci/ruby:2.4.5-stretch
+      - image: consul
       - image: redis
       - image: amazon/dynamodb-local
   test-2.5:
     <<: *ruby-docker-template
     docker:
       - image: circleci/ruby:2.5.3-stretch
+      - image: consul
       - image: redis
       - image: amazon/dynamodb-local
   test-jruby-9.2:
     <<: *ruby-docker-template
     docker:
       - image: circleci/jruby:9-jdk
+      - image: consul
       - image: redis
       - image: amazon/dynamodb-local
 
@@ -90,13 +95,24 @@ jobs:
               fi
               # bundler 2.0 may be preinstalled, we need to remove it if so
               yes | gem uninstall bundler --version '>=2.0' || true;
-              gem install bundler -v "~> 1.7";
+              gem install bundler -v 1.17.3;
               bundle install;
               mv Gemfile.lock "Gemfile.lock.$i"
             done
       - run:
+          name: start DynamoDB
           command: docker run -p 8000:8000 amazon/dynamodb-local
           background: true
+      - run:
+          name: download Consul
+          command: wget https://releases.hashicorp.com/consul/0.8.0/consul_0.8.0_linux_amd64.zip
+      - run:
+          name: extract Consul
+          command: unzip consul_0.8.0_linux_amd64.zip
+      - run:
+          name: start Consul
+          command: ./consul agent -dev
+          background: true
       - run:
           name: run tests for all versions
           shell: /bin/bash -leo pipefail

.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--markup markdown
+--embed-mixins
+lib/*.rb
+lib/**/*.rb
+lib/**/**/*.rb
+lib/**/**/**/*.rb
+-
+README.md

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to the LaunchDarkly Ruby SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [5.5.2] - 2019-01-18
+### Fixed:
+- Like 5.5.1, this release contains only documentation fixes. Implementation classes that are not part of the supported API are now hidden from the [generated documentation](https://www.rubydoc.info/gems/ldclient-rb).
+
+
+## [5.5.1] - 2019-01-17
+### Fixed:
+- Fixed several documentation comments that had the wrong parameter names. There are no other changes in this release; it's only to correct the documentation.
+
+## [5.5.0] - 2019-01-17
+### Added:
+- It is now possible to use Consul or DynamoDB as a persistent feature store, similar to the existing Redis integration. See the `LaunchDarkly::Integrations::Consul` and `LaunchDarkly::Integrations::DynamoDB` modules, and the reference guide [Using a persistent feature store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+- There is now a `LaunchDarkly::Integrations::Redis` module, which is the preferred method for creating a Redis feature store.
+- All of the database feature stores now support local caching not only for individual feature flag queries, but also for `all_flags_state`.
+- The `Config` property `data_source` is the new name for `update_processor` and `update_processor_factory`.
+
+### Changed:
+- The implementation of the SSE protocol for streaming has been moved into a separate gem, [`ld-eventsource`](https://github.com/launchdarkly/ruby-eventsource). This has no effect on streaming functionality.
+
+### Fixed:
+- Added or corrected a large number of documentation comments. All API classes and methods are now documented, and internal implementation details have been hidden from the documentation. You can view the latest documentation on [RubyDoc](https://www.rubydoc.info/gems/ldclient-rb).
+- Fixed a problem in the Redis feature store that would only happen under unlikely circumstances: trying to evaluate a flag when the LaunchDarkly client had not yet been fully initialized and the store did not yet have data in it, and then trying again when the client was still not ready but the store _did_ have data (presumably put there by another process). Previously, the second attempt would fail.
+- In polling mode, the SDK did not correctly handle non-ASCII Unicode characters in feature flag data. ([#90](https://github.com/launchdarkly/ruby-client/issues/90))
+
+### Deprecated:
+- `RedisFeatureStore.new`. This implementation class may be changed or moved in the future; use `LaunchDarkly::Integrations::Redis::new_feature_store`.
+- `Config.update_processor` and `Config.update_processor_factory`; use `Config.data_source`.
+
 ## [5.4.3] - 2019-01-11
 ### Changed:
 - The SDK is now compatible with `net-http-persistent` 3.x. (Thanks, [CodingAnarchy](https://github.com/launchdarkly/ruby-client/pull/113)!)

CONTRIBUTING.md

@@ -2,15 +2,3 @@ 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/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
-
-Dependencies
-------------
-[ld-em-eventsource](https://github.com/launchdarkly/em-eventsource)
-
-
-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).
-

Gemfile.lock

@@ -6,6 +6,7 @@ PATH
       faraday (>= 0.9, < 2)
       faraday-http-cache (>= 1.3.0, < 3)
       json (>= 1.8, < 3)
+      ld-eventsource (~> 1.0)
       net-http-persistent (>= 2.9, < 4.0)
       semantic (~> 1.6)
 
@@ -28,6 +29,9 @@ GEM
     concurrent-ruby (1.1.4)
     connection_pool (2.2.1)
     diff-lcs (1.3)
+    diplomat (2.0.2)
+      faraday (~> 0.9)
+      json
     docile (1.1.5)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
@@ -36,7 +40,6 @@ GEM
     ffi (1.9.25)
     ffi (1.9.25-java)
     hitimes (1.3.0)
-    hitimes (1.3.0-java)
     http_tools (0.4.5)
     jmespath (1.4.0)
     json (1.8.6)
@@ -92,6 +95,7 @@ DEPENDENCIES
   bundler (~> 1.7)
   codeclimate-test-reporter (~> 0)
   connection_pool (>= 2.1.2)
+  diplomat (>= 2.0.2)
   ldclient-rb!
   listen (~> 3.0)
   rake (~> 10.0)

README.md

@@ -15,37 +15,37 @@ This version of the LaunchDarkly SDK has a minimum Ruby version of 2.2.6, or 9.1
 Quick setup
 -----------
 
-0. Install the Ruby SDK with `gem`
+1. Install the Ruby SDK with `gem`
 
-```shell
+    ```shell
 gem install ldclient-rb
 ```
 
-1. Require the LaunchDarkly client:
+2. Require the LaunchDarkly client:
 
-```ruby
+    ```ruby
 require 'ldclient-rb'
 ```
 
-2. Create a new LDClient with your SDK key:
+3. Create a new LDClient with your SDK key:
 
-```ruby
+    ```ruby
 client = LaunchDarkly::LDClient.new("your_sdk_key")
 ```
 
 ### Ruby on Rails
 
-0.  Add `gem 'ldclient-rb'` to your Gemfile and `bundle install`
+1. Add `gem 'ldclient-rb'` to your Gemfile and `bundle install`
 
-1.  Initialize the launchdarkly client in `config/initializers/launchdarkly.rb`:
+2. Initialize the launchdarkly client in `config/initializers/launchdarkly.rb`:
 
-```ruby
+    ```ruby
 Rails.configuration.ld_client = LaunchDarkly::LDClient.new("your_sdk_key")
 ```
 
-2.  You may want to include a function in your ApplicationController
+3.  You may want to include a function in your ApplicationController
 
-```ruby
+    ```ruby
     def launchdarkly_settings
       if current_user.present?
         {
@@ -72,31 +72,44 @@ Rails.configuration.ld_client = LaunchDarkly::LDClient.new("your_sdk_key")
     end
 ```
 
-3.  In your controllers, access the client using
+4. In your controllers, access the client using
 
-```ruby
+    ```ruby
 Rails.application.config.ld_client.variation('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 whether the flag is on for each user:
+
+```ruby
+if client.variation("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
+```
+
 HTTPS proxy
-------------
-The Ruby SDK uses Faraday and Socketry to handle its network traffic. Both of these provide built-in support for the use of an  HTTPS proxy. If the HTTPS_PROXY environment variable is present then the SDK will proxy all network requests through the URL provided.
+-----------
+
+The Ruby SDK uses Faraday and Socketry to handle its network traffic. Both of these provide built-in support for the use of an  HTTPS proxy. If the HTTPS_PROXY environment variable is present then the SDK will proxy all network requests through the URL provided. (HTTP_PROXY is not used because all LaunchDarkly services require HTTPS.)
 
 How to set the HTTPS_PROXY environment variable on Mac/Linux systems:
 ```
 export HTTPS_PROXY=https://web-proxy.domain.com:8080
 ```
 
-
 How to set the HTTPS_PROXY environment variable on Windows systems:
 ```
 set HTTPS_PROXY=https://web-proxy.domain.com:8080
 ```
 
-
 If your proxy requires authentication then you can prefix the URN with your login information:
 ```
 export HTTPS_PROXY=http://user:pass@web-proxy.domain.com:8080
@@ -106,34 +119,22 @@ or
 set HTTPS_PROXY=http://user:pass@web-proxy.domain.com:8080
 ```
 
-
-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 whether the flag is on for each user:
-
-```ruby
-if client.variation("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
-```
-
 Database integrations
 ---------------------
 
-Feature flag data can be kept in a persistent store using Redis or DynamoDB. These adapters are implemented in the `LaunchDarkly::Integrations::Redis` and `LaunchDarkly::Integrations::DynamoDB` modules; to use them, call the `new_feature_store` method in the module, and put the returned object in the `feature_store` property of your client configuration. See the [source code](https://github.com/launchdarkly/ruby-client-private/tree/master/lib/ldclient-rb/integrations) and the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store) for more information.
+Feature flag data can be kept in a persistent store using Redis, DynamoDB, or Consul. These adapters are implemented in the `LaunchDarkly::Integrations::Redis`, `LaunchDarkly::Integrations::DynamoDB`, and `LaunchDarkly::Integrations::Consul` modules; to use them, call the `new_feature_store` method in the module, and put the returned object in the `feature_store` property of your client configuration. See the [API documentation](https://www.rubydoc.info/gems/ldclient-rb/LaunchDarkly/Integrations) and the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store) for more information.
 
 Using flag data from a file
 ---------------------------
-For testing purposes, the SDK can be made to read feature flag state from a file or files instead of connecting to LaunchDarkly. See [`file_data_source.rb`](https://github.com/launchdarkly/ruby-client/blob/master/lib/ldclient-rb/file_data_source.rb) for more details.
+
+For testing purposes, the SDK can be made to read feature flag state from a file or files instead of connecting to LaunchDarkly. See `LaunchDarkly::FileDataSource` or the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/reading-flags-from-a-file) for more details.
 
 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/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 [reference guide for this SDK](http://docs.launchdarkly.com/docs/ruby-sdk-reference).
+
+Generated API documentation is on [RubyDoc.info](https://www.rubydoc.info/gems/ldclient-rb).
 
 Testing
 -------
@@ -143,10 +144,10 @@ We run integration tests for all our SDKs using a centralized test harness. This
 Contributing
 ------------
 
-See [Contributing](https://github.com/launchdarkly/ruby-client/blob/master/CONTRIBUTING.md)
+See [Contributing](https://github.com/launchdarkly/ruby-client/blob/master/CONTRIBUTING.md).
 
 About LaunchDarkly
------------
+------------------
 
 * LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard.  With LaunchDarkly, you can:
     * Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.

ldclient-rb.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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"

lib/ldclient-rb/config.rb

@@ -332,7 +332,7 @@ def self.default_connect_timeout
 
     #
     # The default value for {#logger}.
-    # @return [::Logger] the Rails logger if in Rails, or a default [::Logger] at WARN level otherwise
+    # @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)

lib/ldclient-rb/impl.rb

@@ -1,10 +1,11 @@
 
 module LaunchDarkly
   #
-  # Low-level implementation classes. Everything in this module should be considered non-public
-  # and subject to change with any release.
+  # Internal implementation classes. Everything in this module should be considered unsupported
+  # and subject to change.
   #
   # @since 5.5.0
+  # @private
   #
   module Impl
     # code is in ldclient-rb/impl/