ldclient-rb 5.5.3 → 5.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e5398b81dc216177803939d535b130edbb0361a
-  data.tar.gz: 4c50f29da29da753db0a36064c29a22191960808
+  metadata.gz: 59ce5212d9da56a89b81f777b4167917a888dd81
+  data.tar.gz: f6bae254bfd984bf899629c7a12a42771742b49a
 SHA512:
-  metadata.gz: 894d4f29200b6a5df70608942f15223a9b9d5bdeb426913f3afe9feb7d23b02b2ef544874ba7c39570b3f8e8c098caafab638ff9b779b9aec69ca444d1115b62
-  data.tar.gz: 41c088debbc36d16b7518b20af0ddc4c9b488e0da16b9e465d573ab6e715f00612fb53ee4fe492692cf0d065aa16c3e85ba2d17314c1c326110415ac4667b310
+  metadata.gz: f53b38fe2d082a621b728ba98479468923ddf5cd05a6bb0ddf05632210524d149dde39041055c5294fc6186e7fe908b175612926c8c6c107eb22213db79d3b2f
+  data.tar.gz: fa22bf113cca0bc31a91cba3d218063a246b47209ea55482962a6ff6f7c8db18625d560388d62e1ef06b8244ee9847dec0ae5f41d9b5d16528a1639d9529d168

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is this a support request?**
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the SDK code. If you're not sure whether the problem you are having is specifically related to the SDK, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing support@launchdarkly.com.
+
+Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add any log output related to your problem.
+
+**SDK version**
+The version of this SDK that you are using.
+
+**Language version, developer tools**
+For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
+
+**OS/platform**
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.4] - 2019-03-29
+### Fixed:
+- Fixed a missing `require` that could sometimes cause a `NameError` to be thrown when starting the client, depending on what other gems were installed. This bug was introduced in version 5.5.3. ([#129](https://github.com/launchdarkly/ruby-client/issues/129))
+- When an analytics event was generated for a feature flag because it is a prerequisite for another flag that was evaluated, the user data was being omitted from the event. ([#128](https://github.com/launchdarkly/ruby-client/issues/128))
+- If `track` or `identify` is called without a user, the SDK now logs a warning, and does not send an analytics event to LaunchDarkly (since it would not be processed without a user).
+- Added a link from the SDK readme to the guide regarding the client initialization.
+
 ## [5.5.3] - 2019-02-13
 ### Changed:
 - The SDK previously used the `faraday` and `net-http-persistent` gems for all HTTP requests other than streaming connections. Since `faraday` lacks a stable version and has a known issue with character encoding, and `net-http-persistent` is no longer maintained, these have both been removed. This should not affect any SDK functionality.

data/README.md

@@ -33,6 +33,8 @@ require 'ldclient-rb'
 client = LaunchDarkly::LDClient.new("your_sdk_key")
 ```
 
+*NOTE: Please refer to [our documentation](https://docs.launchdarkly.com/docs/ruby-sdk-reference#section-initializing-ldclient-using-spring-unicorn-or-puma) for additional instructions on how to use LaunchDarkly with [Spring](https://github.com/rails/spring), [Unicorn](https://bogomips.org/unicorn/), or [Puma](https://github.com/puma/puma).*
+
 ### Ruby on Rails
 
 1. Add `gem 'ldclient-rb'` to your Gemfile and `bundle install`

data/lib/ldclient-rb/evaluation.rb

@@ -263,6 +263,7 @@ module LaunchDarkly
             event = {
               kind: "feature",
               key: prereq_key,
+              user: user,
               variation: prereq_res.variation_index,
               value: prereq_res.value,
               version: prereq_flag[:version],
@@ -272,7 +273,7 @@ module LaunchDarkly
             }
             events.push(event)
           rescue => exn
-            Util.log_exception(logger, "Error evaluating prerequisite flag \"#{prereq_key}\" for flag \"{flag[:key]}\"", exn)
+            Util.log_exception(logger, "Error evaluating prerequisite flag \"#{prereq_key}\" for flag \"#{flag[:key]}\"", exn)
             prereq_ok = false
           end
         end

data/lib/ldclient-rb/ldclient.rb

@@ -211,6 +211,10 @@ module LaunchDarkly
     # @return [void]
     #
     def identify(user)
+      if !user || user[:key].nil?
+        @config.logger.warn("Identify called with nil user or nil user key!")
+        return
+      end
       sanitize_user(user)
       @event_processor.add_event(kind: "identify", key: user[:key], user: user)
     end
@@ -229,6 +233,10 @@ module LaunchDarkly
     # @return [void]
     #
     def track(event_name, user, data)
+      if !user || user[:key].nil?
+        @config.logger.warn("Track called with nil user or nil user key!")
+        return
+      end
       sanitize_user(user)
       @event_processor.add_event(kind: "custom", key: event_name, user: user, data: data)
     end

data/lib/ldclient-rb/util.rb

@@ -1,3 +1,4 @@
+require "net/http"
 require "uri"
 
 module LaunchDarkly

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "5.5.3"
+  VERSION = "5.5.4"
 end

data/spec/evaluation_spec.rb

@@ -127,7 +127,7 @@ describe LaunchDarkly::Evaluation do
       detail = LaunchDarkly::EvaluationDetail.new('b', 1,
         { kind: 'PREREQUISITE_FAILED', prerequisiteKey: 'feature1' })
       events_should_be = [{
-        kind: 'feature', key: 'feature1', variation: nil, value: nil, version: 2, prereqOf: 'feature0',
+        kind: 'feature', key: 'feature1', user: user, variation: nil, value: nil, version: 2, prereqOf: 'feature0',
         trackEvents: nil, debugEventsUntilDate: nil
       }]
       result = evaluate(flag, user, features, logger)
@@ -159,7 +159,7 @@ describe LaunchDarkly::Evaluation do
       detail = LaunchDarkly::EvaluationDetail.new('b', 1,
         { kind: 'PREREQUISITE_FAILED', prerequisiteKey: 'feature1' })
       events_should_be = [{
-        kind: 'feature', key: 'feature1', variation: 1, value: 'e', version: 2, prereqOf: 'feature0',
+        kind: 'feature', key: 'feature1', user: user, variation: 1, value: 'e', version: 2, prereqOf: 'feature0',
         trackEvents: nil, debugEventsUntilDate: nil
       }]
       result = evaluate(flag, user, features, logger)
@@ -189,7 +189,7 @@ describe LaunchDarkly::Evaluation do
       detail = LaunchDarkly::EvaluationDetail.new('b', 1,
         { kind: 'PREREQUISITE_FAILED', prerequisiteKey: 'feature1' })
       events_should_be = [{
-        kind: 'feature', key: 'feature1', variation: 0, value: 'd', version: 2, prereqOf: 'feature0',
+        kind: 'feature', key: 'feature1', user: user, variation: 0, value: 'd', version: 2, prereqOf: 'feature0',
         trackEvents: nil, debugEventsUntilDate: nil
       }]
       result = evaluate(flag, user, features, logger)
@@ -218,7 +218,7 @@ describe LaunchDarkly::Evaluation do
       user = { key: 'x' }
       detail = LaunchDarkly::EvaluationDetail.new('a', 0, { kind: 'FALLTHROUGH' })
       events_should_be = [{
-        kind: 'feature', key: 'feature1', variation: 1, value: 'e', version: 2, prereqOf: 'feature0',
+        kind: 'feature', key: 'feature1', user: user, variation: 1, value: 'e', version: 2, prereqOf: 'feature0',
         trackEvents: nil, debugEventsUntilDate: nil
       }]
       result = evaluate(flag, user, features, logger)

data/spec/ldclient_spec.rb

@@ -8,7 +8,8 @@ describe LaunchDarkly::LDClient do
     subject.new("secret", offline_config)
   end
   let(:null_data) { LaunchDarkly::NullUpdateProcessor.new }
-  let(:config) { LaunchDarkly::Config.new({send_events: false, data_source: null_data}) }
+  let(:logger) { double().as_null_object }
+  let(:config) { LaunchDarkly::Config.new({ send_events: false, data_source: null_data, logger: logger }) }
   let(:client) do
     subject.new("secret", config)
   end
@@ -17,16 +18,31 @@ describe LaunchDarkly::LDClient do
     JSON.parse(data, symbolize_names: true)
   end
   let(:user) do
-    data = File.read(File.join("spec", "fixtures", "user.json"))
-    JSON.parse(data, symbolize_names: true)
+    {
+      key: "user@test.com",
+      custom: {
+          groups: [ "microsoft", "google" ]
+      }
+    }
   end
   let(:numeric_key_user) do
-    data = File.read(File.join("spec", "fixtures", "numeric_key_user.json"))
-    JSON.parse(data, symbolize_names: true)
+    {
+      key: 33,
+      custom: {
+          groups: [ "microsoft", "google" ]
+      }
+    }
   end
   let(:sanitized_numeric_key_user) do
-    data = File.read(File.join("spec", "fixtures", "sanitized_numeric_key_user.json"))
-    JSON.parse(data, symbolize_names: true)
+    {
+      key: "33",
+      custom: {
+          groups: [ "microsoft", "google" ]
+      }
+    }
+  end
+  let(:user_without_key) do
+    { name: "Keyless Joe" }
   end
 
   def event_processor
@@ -342,6 +358,18 @@ describe LaunchDarkly::LDClient do
       expect(event_processor).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
       client.track("custom_event_name", numeric_key_user, nil)
     end
+
+    it "does not send an event, and logs a warning, if user is nil" do
+      expect(event_processor).not_to receive(:add_event)
+      expect(logger).to receive(:warn)
+      client.track("custom_event_name", nil, nil)
+    end
+
+    it "does not send an event, and logs a warning, if user key is nil" do
+      expect(event_processor).not_to receive(:add_event)
+      expect(logger).to receive(:warn)
+      client.track("custom_event_name", user_without_key, nil)
+    end
   end
 
   describe '#identify' do 
@@ -354,6 +382,18 @@ describe LaunchDarkly::LDClient do
       expect(event_processor).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
       client.identify(numeric_key_user)
     end
+
+    it "does not send an event, and logs a warning, if user is nil" do
+      expect(event_processor).not_to receive(:add_event)
+      expect(logger).to receive(:warn)
+      client.identify(nil)
+    end
+
+    it "does not send an event, and logs a warning, if user key is nil" do
+      expect(event_processor).not_to receive(:add_event)
+      expect(logger).to receive(:warn)
+      client.identify(user_without_key)
+    end
   end
 
   describe 'with send_events: false' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.5.3
+  version: 5.5.4
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -235,6 +235,8 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
@@ -297,8 +299,6 @@ files:
 - spec/file_data_source_spec.rb
 - spec/fixtures/feature.json
 - spec/fixtures/feature1.json
-- spec/fixtures/numeric_key_user.json
-- spec/fixtures/sanitized_numeric_key_user.json
 - spec/fixtures/user.json
 - spec/flags_state_spec.rb
 - spec/http_util.rb
@@ -353,8 +353,6 @@ test_files:
 - spec/file_data_source_spec.rb
 - spec/fixtures/feature.json
 - spec/fixtures/feature1.json
-- spec/fixtures/numeric_key_user.json
-- spec/fixtures/sanitized_numeric_key_user.json
 - spec/fixtures/user.json
 - spec/flags_state_spec.rb
 - spec/http_util.rb

data/spec/fixtures/numeric_key_user.json

@@ -1,9 +0,0 @@
-{
-    "key": 33,
-    "custom":{
-        "groups":[
-            "microsoft",
-            "google"
-        ]
-    }
-}

data/spec/fixtures/sanitized_numeric_key_user.json

@@ -1,9 +0,0 @@
-{
-    "key": "33",
-    "custom":{
-        "groups":[
-            "microsoft",
-            "google"
-        ]
-    }
-}