ldclient-rb 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc6641c4985b42abedd6da85f32ed76818b06cec
-  data.tar.gz: 9fe5a3fe32f171e31c5adc07dca2f7ef929a5e11
+  metadata.gz: f00287e6e246a9644375d4945034f25ee7ff7df2
+  data.tar.gz: 6899db722f33a0ca552998a0fd4a738576e353f2
 SHA512:
-  metadata.gz: 788de2316e42990ae14abc3e7e681ce95f27862b450c571cc4dc63c503ffea9e0592795adedbd7e01186107274512514ca9c3fde4824d2dc16b595218b9d8c7f
-  data.tar.gz: b0a5ddca1665c94a7bffd6467eac2cecde7777172db079ed2be16feeeadbdc3d86b748a6a1c44bb6b3b7c1e3b83c4c7428705f6c1ac4f2a3d166ac289b5c69b6
+  metadata.gz: 9642d199535a1805364241d7bfdef403355583ac0bedf9cee0df09b472baf67c8724a5f7c4293152ace3d7b970319e2bccd9b32761ebbbc230c9528bc0afd149
+  data.tar.gz: f6730d8bddbe1eda1cb271ecb4ba39e4d47050fc3d5119d1a7c037bdd4f3fd50a58b3031f6cb1de61cd7de2817def0ecd99baee1e8ef1e1a42289d76d677e18e

data/lib/ldclient-rb/config.rb

@@ -17,6 +17,10 @@ module LaunchDarkly
     #   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 [String] :stream_uri ("https://stream.launchdarkly.com") The
+    #   URL for the LaunchDarkly streaming events server. Most users should use the default value.
+    # @option opts [String] :events_uri ("https://events.launchdarkly.com") The
+    #   URL for the LaunchDarkly events 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,
@@ -35,6 +39,7 @@ module LaunchDarkly
     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
       @store = opts[:store] || Config.default_store
@@ -59,6 +64,12 @@ module LaunchDarkly
     # @return [String] The configured base URL for the LaunchDarkly streaming server.
     attr_reader :stream_uri
 
+    #
+    # The base URL for the LaunchDarkly events server.
+    #
+    # @return [String] The configured base URL for the LaunchDarkly events server.
+    attr_reader :events_uri
+
     #
     # Whether streaming mode should be enabled. Streaming mode asynchronously updates
     # feature flags in real-time using server-sent events.
@@ -155,6 +166,10 @@ module LaunchDarkly
       "https://stream.launchdarkly.com"
     end
 
+    def self.default_events_uri
+      "https://events.launchdarkly.com"
+    end
+
     def self.default_store
       defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
     end

data/lib/ldclient-rb/ldclient.rb

@@ -16,6 +16,7 @@ module LaunchDarkly
   #
   #
   class LDClient
+    include Settings
     #
     # Creates a new client instance that connects to LaunchDarkly. A custom
     # configuration parameter can also supplied to specify advanced options,
@@ -60,7 +61,7 @@ module LaunchDarkly
 
     def post_flushed_events(events)
       res = log_timings("Flush events") do
-        next @client.post (@config.base_uri + "/api/events/bulk") do |req|
+        next @client.post (@config.events_uri + "/bulk") do |req|
           req.headers["Authorization"] = "api_key " + @api_key
           req.headers["User-Agent"] = "RubyClient/" + LaunchDarkly::VERSION
           req.headers["Content-Type"] = "application/json"
@@ -146,7 +147,7 @@ module LaunchDarkly
       value = evaluate(feature, user)
       value = value.nil? ? default : value
 
-      add_event(kind: "feature", key: key, user: user, value: value)
+      add_event(kind: "feature", key: key, user: user, value: value, default: default)
       LDNewRelic.annotate_transaction(key, value)
       return value
     rescue StandardError => error

data/lib/ldclient-rb/settings.rb

@@ -0,0 +1,40 @@
+module LaunchDarkly
+
+  #
+  # Module to manage user flag settings
+  #
+  module Settings
+    #
+    # Specifically enable or disable a feature flag for a user based
+    # on their key.
+    #
+    # @param user_key [String] the key of the user
+    # @param flag_key [String] the unique feature key for the feature flag, as shown
+    #   on the LaunchDarkly dashboard
+    # @param setting [Boolean] the new setting, one of:
+    #    true: the feature is always on
+    #    false: the feature is never on
+    #    nil: remove the setting (assign user per defined rules)
+    def update_user_flag_setting(user_key, flag_key, setting=nil)
+      unless user_key
+        @config.logger.error("[LDClient] Must specify user")
+        return
+      end      
+      
+      res = log_timings('update_user_flag_setting') do
+        @client.put("#{@config.base_uri}/api/users/#{user_key}/features/#{flag_key}") do |req|
+          req.headers['Authorization'] = "api_key #{@api_key}"
+          req.headers['User-Agent'] = "RubyClient/#{LaunchDarkly::VERSION}"
+          req.headers['Content-Type'] = 'application/json'
+          req.body = {setting: setting}.to_json
+          req.options.timeout = @config.read_timeout
+          req.options.open_timeout = @config.connect_timeout
+        end
+      end
+
+      unless res.success?
+        @config.logger.error("[LDClient] Failed to change setting, status: #{res.status}")
+      end
+    end
+  end
+end

data/lib/ldclient-rb/version.rb

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

data/lib/ldclient-rb.rb

@@ -1,4 +1,5 @@
 require "ldclient-rb/version"
+require "ldclient-rb/settings"
 require "ldclient-rb/ldclient"
 require "ldclient-rb/store"
 require "ldclient-rb/config"

data/spec/config_spec.rb

@@ -22,6 +22,16 @@ describe LaunchDarkly::Config do
       expect(subject.new.base_uri).to eq subject.default_base_uri
     end
   end
+  describe "@events_uri" do
+    it "can be read" do
+      expect(subject.new.events_uri).to eq subject.default_events_uri
+    end
+  end
+  describe "@stream_uri" do
+    it "can be read" do
+      expect(subject.new.stream_uri).to eq subject.default_stream_uri
+    end
+  end
   describe ".default_store" do
     it "uses Rails cache if it is available" do
       rails = instance_double("Rails", cache: :cache)

data/spec/ldclient_spec.rb

@@ -15,6 +15,21 @@ describe LaunchDarkly::LDClient do
     JSON.parse(data, symbolize_names: true)
   end
 
+  context 'user flag settings' do
+    describe '#update_user_flag_setting' do
+      it 'requires user' do
+        expect(client.instance_variable_get(:@config).logger).to receive(:error)
+        client.update_user_flag_setting(nil, feature[:key], true)
+      end
+
+      it 'puts the new setting' do
+        result = double('result', success?: true, status: 204)
+        expect(client.instance_variable_get(:@client)).to receive(:put).and_return(result)
+        client.update_user_flag_setting(user[:key], feature[:key], true)
+      end
+    end
+  end
+
   describe '#flush' do
     it "will flush and post all events" do
       client.instance_variable_get(:@queue).push "asdf"
@@ -34,7 +49,7 @@ describe LaunchDarkly::LDClient do
     let(:events) { ["event"] }
     it "will flush and post all events" do
       result = double("result", status: 200)
-      expect(client.instance_variable_get(:@client)).to receive(:post).and_return result
+      expect(client.instance_variable_get(:@client)).to receive(:post).with(LaunchDarkly::Config.default_events_uri + "/bulk").and_return result
       expect(client.instance_variable_get(:@config).logger).to_not receive :error
       client.send(:post_flushed_events, events)
       expect(client.instance_variable_get(:@queue).length).to eq 0
@@ -61,6 +76,10 @@ describe LaunchDarkly::LDClient do
       result = client.toggle?(feature[:key], user, "default")
       expect(result).to eq "default"
     end
+    it "will specify the default value in the feature request event" do
+      expect(client).to receive(:add_event).with(hash_including(default: "default"))
+      result = client.toggle?(feature[:key], user, "default")
+    end
     it "requires user" do
       expect(client.instance_variable_get(:@config).logger).to receive(:error)
       result = client.toggle?(feature[:key], nil, "default")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldclient-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - LaunchDarkly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ files:
 - lib/ldclient-rb/config.rb
 - lib/ldclient-rb/ldclient.rb
 - lib/ldclient-rb/newrelic.rb
+- lib/ldclient-rb/settings.rb
 - lib/ldclient-rb/store.rb
 - lib/ldclient-rb/stream.rb
 - lib/ldclient-rb/version.rb
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: LaunchDarkly SDK for Ruby