ldclient-rb 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f00287e6e246a9644375d4945034f25ee7ff7df2
-  data.tar.gz: 6899db722f33a0ca552998a0fd4a738576e353f2
+  metadata.gz: 33eb7dda18b6978902b85844e4eeb2a6aeb78cbd
+  data.tar.gz: a14cdb94a462d9ba7892dbaac4b98eb29977fca3
 SHA512:
-  metadata.gz: 9642d199535a1805364241d7bfdef403355583ac0bedf9cee0df09b472baf67c8724a5f7c4293152ace3d7b970319e2bccd9b32761ebbbc230c9528bc0afd149
-  data.tar.gz: f6730d8bddbe1eda1cb271ecb4ba39e4d47050fc3d5119d1a7c037bdd4f3fd50a58b3031f6cb1de61cd7de2817def0ecd99baee1e8ef1e1a42289d76d677e18e
+  metadata.gz: f9ffd77abc85bd1275ed2a626a074d057a96648f29cd59c98ba59485dad33b552a9e1da1f7699f7c0ec909dca0447b6ac4098e48512e62ee955c2b0754fd5234
+  data.tar.gz: 3c8f4cbdc179df8803da79cf76c0205af931908b79d9c043bc2115c77249e4a6816665f1d997a8fa148ea8d1f52b70d683cbff349a16b28489f91520999c03a6

data/lib/ldclient-rb/ldclient.rb

@@ -134,6 +134,7 @@ module LaunchDarkly
         @config.logger.error("[LDClient] Must specify user")
         return default
       end
+      sanitize_user(user)
 
       if @config.stream? && !@stream_processor.started?
         @stream_processor.start
@@ -176,6 +177,7 @@ module LaunchDarkly
     # @param [Hash] The user to register
     #
     def identify(user)
+      sanitize_user(user)
       add_event(kind: "identify", key: user[:key], user: user)
     end
 
@@ -200,29 +202,45 @@ module LaunchDarkly
     #
     # @return [void]
     def track(event_name, user, data)
+      sanitize_user(user)
       add_event(kind: "custom", key: event_name, user: user, data: data)
     end
 
     #
-    # Returns the key of every feature
+    # Returns the key of every feature flag
     #
-    def feature_keys
-      get_features.map { |feature| feature[:key] }
+    def all_keys
+      all_flags.keys
     end
 
     #
-    # Returns all features
+    # Returns all feature flags
     #
-    def get_features
-      res = make_request "/api/features"
+    def all_flags
+      return Hash.new if @offline
 
-      if res.status / 100 == 2
-        return JSON.parse(res.body, symbolize_names: true)[:items]
+      if @config.stream? && !@stream_processor.started?
+        @stream_processor.start
+      end
+
+      if @config.stream? && @stream_processor.initialized?
+        @stream_processor.get_all_features
       else
-        @config.logger.error("[LDClient] Unexpected status code #{res.status}")
+        res = make_request "/api/eval/features"
+
+        if res.status / 100 == 2
+          JSON.parse(res.body, symbolize_names: true)         
+        else
+          @config.logger.error("[LDClient] Unexpected status code #{res.status}")
+          Hash.new
+        end
       end
     end
 
+    def get_user_settings(user)
+      Hash[all_flags.map { |key, feature| [key, evaluate(feature, user)]}]
+    end
+
     def get_streamed_flag(key)
       feature = get_flag_stream(key)
       if @config.debug_stream?
@@ -391,9 +409,15 @@ module LaunchDarkly
       @config.logger.error(error)
     end
 
+    def sanitize_user(user)
+      if user[:key]
+        user[:key] = user[:key].to_s
+      end
+    end
+
     private :post_flushed_events, :add_event, :get_streamed_flag,
             :get_flag_stream, :get_flag_int, :make_request, :param_for_user,
             :match_target?, :match_user?, :match_variation?, :evaluate,
-            :create_worker, :log_timings, :log_exception
+            :create_worker, :log_timings, :log_exception, :sanitize_user
   end
 end

data/lib/ldclient-rb/stream.rb

@@ -80,6 +80,13 @@ module LaunchDarkly
       @started.value
     end
 
+    def get_all_features
+      if not initialized?
+        throw :uninitialized
+      end
+      @store.all
+    end
+
     def get_feature(key)
       if not initialized?
         throw :uninitialized
@@ -125,7 +132,7 @@ module LaunchDarkly
       source.on(PATCH) { |message| process_message(message, PATCH) }
       source.on(DELETE) { |message| process_message(message, DELETE) }
       source.error do |error|
-        @config.logger.info("[LDClient] Error subscribing to stream API: #{error}")
+        @config.logger.info("[LDClient] Stream connection: #{error}")
         set_disconnected
       end
       source.inactivity_timeout = 0

data/lib/ldclient-rb/version.rb

@@ -1,3 +1,3 @@
 module LaunchDarkly
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/fixtures/numeric_key_user.json

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

data/spec/fixtures/sanitized_numeric_key_user.json

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

data/spec/ldclient_spec.rb

@@ -14,6 +14,14 @@ describe LaunchDarkly::LDClient do
     data = File.read(File.join("spec", "fixtures", "user.json"))
     JSON.parse(data, symbolize_names: true)
   end
+  let(:numeric_key_user) do
+    data = File.read(File.join("spec", "fixtures", "numeric_key_user.json"))
+    JSON.parse(data, symbolize_names: true)
+  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)
+  end
 
   context 'user flag settings' do
     describe '#update_user_flag_setting' do
@@ -85,6 +93,10 @@ describe LaunchDarkly::LDClient do
       result = client.toggle?(feature[:key], nil, "default")
       expect(result).to eq "default"
     end
+    it "sanitizes the user in the event" do
+      expect(client).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
+      client.toggle?(feature[:key], numeric_key_user, "default")
+    end
     it "returns value from streamed flag if available" do
       expect(client.instance_variable_get(:@config)).to receive(:stream?).and_return(true).twice
       expect(client.instance_variable_get(:@stream_processor)).to receive(:started?).and_return true
@@ -103,6 +115,28 @@ describe LaunchDarkly::LDClient do
     end
   end
 
+  describe '#identify' do 
+    it "queues up an identify event" do
+      expect(client).to receive(:add_event).with(hash_including(kind: "identify", key: user[:key], user: user))
+      client.identify(user)
+    end
+    it "sanitizes the user in the event" do
+      expect(client).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
+      client.identify(numeric_key_user)
+    end
+  end
+
+  describe '#track' do 
+    it "queues up an custom event" do
+      expect(client).to receive(:add_event).with(hash_including(kind: "custom", key: "custom_event_name", user: user, data: 42))
+      client.track("custom_event_name", user, 42)
+    end
+    it "sanitizes the user in the event" do
+      expect(client).to receive(:add_event).with(hash_including(user: sanitized_numeric_key_user))
+      client.track("custom_event_name", numeric_key_user, nil)
+    end
+  end
+
   describe '#get_streamed_flag' do
     it "will not check the polled flag normally" do
       expect(client).to receive(:get_flag_stream).and_return true
@@ -120,18 +154,18 @@ describe LaunchDarkly::LDClient do
     end
   end
 
-  describe '#get_features' do
+  describe '#all_flags' do
     it "will parse and return the features list" do
-      result = double("Faraday::Response", status: 200, body: '{"items": ["asdf"]}')
-      expect(client).to receive(:make_request).with("/api/features").and_return(result)
-      data = client.send(:get_features)
-      expect(data).to eq ["asdf"]
+      result = double("Faraday::Response", status: 200, body: '{"asdf":"qwer"}')
+      expect(client).to receive(:make_request).with("/api/eval/features").and_return(result)
+      data = client.send(:all_flags)
+      expect(data).to eq(asdf: "qwer")
     end
     it "will log errors" do
       result = double("Faraday::Response", status: 418)
-      expect(client).to receive(:make_request).with("/api/features").and_return(result)
+      expect(client).to receive(:make_request).with("/api/eval/features").and_return(result)
       expect(client.instance_variable_get(:@config).logger).to receive(:error)
-      client.send(:get_features)
+      client.send(:all_flags)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -207,6 +207,8 @@ files:
 - lib/ldclient-rb/version.rb
 - spec/config_spec.rb
 - spec/fixtures/feature.json
+- spec/fixtures/numeric_key_user.json
+- spec/fixtures/sanitized_numeric_key_user.json
 - spec/fixtures/user.json
 - spec/ldclient_spec.rb
 - spec/newrelic_spec.rb
@@ -241,6 +243,8 @@ summary: LaunchDarkly SDK for Ruby
 test_files:
 - spec/config_spec.rb
 - spec/fixtures/feature.json
+- spec/fixtures/numeric_key_user.json
+- spec/fixtures/sanitized_numeric_key_user.json
 - spec/fixtures/user.json
 - spec/ldclient_spec.rb
 - spec/newrelic_spec.rb