Merge pull request #69 from launchdarkly/jko/sdk-key

api_key -> sdk_key

Author: jkodumal

README.md

@@ -23,10 +23,10 @@ gem install ldclient-rb
 require 'ldclient-rb'
 ```
 
-2. Create a new LDClient with your API key:
+2. Create a new LDClient with your SDK key:
 
 ```ruby
-client = LaunchDarkly::LDClient.new("your_api_key")
+client = LaunchDarkly::LDClient.new("your_sdk_key")
 ```
 
 ### Ruby on Rails
@@ -36,7 +36,7 @@ client = LaunchDarkly::LDClient.new("your_api_key")
 1.  Initialize the launchdarkly client in `config/initializers/launchdarkly.rb`:
 
 ```ruby
-Rails.configuration.ld_client = LaunchDarkly::LDClient.new("your_api_key")
+Rails.configuration.ld_client = LaunchDarkly::LDClient.new("your_sdk_key")
 ```
 
 2.  You may want to include a function in your ApplicationController

lib/ldclient-rb/evaluation.rb

@@ -118,7 +118,7 @@ def eval_internal(flag, user, store, events)
             begin
               prereq_res = eval_internal(prereq_flag, user, store, events)
               variation = get_variation(prereq_flag, prerequisite[:variation])
-              events.push(kind: "feature", key: prereq_flag[:key], value: prereq_res)
+              events.push(kind: "feature", key: prereq_flag[:key], value: prereq_res, version: prereq_flag[:version], prereqOf: flag[:key])
               if prereq_res.nil? || prereq_res!= variation
                 failed_prereq = true
               end

lib/ldclient-rb/events.rb

@@ -4,9 +4,9 @@
 module LaunchDarkly
 
   class EventProcessor
-    def initialize(api_key, config)
+    def initialize(sdk_key, config)
       @queue = Queue.new
-      @api_key = api_key
+      @sdk_key = sdk_key
       @config = config
       @client = Faraday.new
       @worker = create_worker
@@ -27,7 +27,7 @@ def create_worker
 
     def post_flushed_events(events)
       res = @client.post (@config.events_uri + "/bulk") do |req|
-        req.headers["Authorization"] = "api_key " + @api_key
+        req.headers["Authorization"] = @sdk_key
         req.headers["User-Agent"] = "RubyClient/" + LaunchDarkly::VERSION
         req.headers["Content-Type"] = "application/json"
         req.body = events.to_json

lib/ldclient-rb/ldclient.rb

@@ -7,7 +7,7 @@
 
 module LaunchDarkly
   #
-  # A client for the LaunchDarkly API. Client instances are thread-safe. Users
+  # A client for LaunchDarkly. Client instances are thread-safe. Users
   # should create a single client instance for the lifetime of the application.
   #
   #
@@ -19,26 +19,26 @@ class LDClient
     # but for most use cases, the default configuration is appropriate.
     #
     #
-    # @param api_key [String] the API key for your LaunchDarkly account
+    # @param sdk_key [String] the SDK key for your LaunchDarkly account
     # @param config [Config] an optional client configuration object
     #
     # @return [LDClient] The LaunchDarkly client instance
-    def initialize(api_key, config = Config.default, wait_for_sec = 5)
-      @api_key = api_key
+    def initialize(sdk_key, config = Config.default, wait_for_sec = 5)
+      @sdk_key = sdk_key
       @config = config
       @store = config.feature_store
-      requestor = Requestor.new(api_key, config)
+      requestor = Requestor.new(sdk_key, config)
 
       if !@config.offline?
         if @config.stream?
-          @update_processor = StreamProcessor.new(api_key, config, requestor)
+          @update_processor = StreamProcessor.new(sdk_key, config, requestor)
         else 
           @update_processor = PollingProcessor.new(config, requestor)
         end
         @update_processor.start
       end
 
-      @event_processor = EventProcessor.new(api_key, config)
+      @event_processor = EventProcessor.new(sdk_key, config)
 
       if !@config.offline? && wait_for_sec > 0
         begin
@@ -61,8 +61,7 @@ def toggle?(key, user, default = False)
     end
 
     def secure_mode_hash(user)
-      puts @api_key
-      OpenSSL::HMAC.hexdigest('sha256', @api_key, user[:key].to_s)
+      OpenSSL::HMAC.hexdigest('sha256', @sdk_key, user[:key].to_s)
     end
 
     #
@@ -115,26 +114,32 @@ def variation(key, user, default)
       sanitize_user(user)
       feature = @store.get(key)
 
-        begin
-          res = evaluate(feature, user, @store)
-          if !res[:events].nil?
-            res[:events].each do |event|
-              @event_processor.add_event(event)
-            end
-          end
-          if !res[:value].nil?
-            @event_processor.add_event(kind: "feature", key: key, user: user, value: res[:value], default: default)
-            return res[:value]
-          else
-            @config.logger.debug("[LDClient] Result value is null in toggle")
-            @event_processor.add_event(kind: "feature", key: key, user: user, value: default, default: default)        
-            return default            
+      if feature.nil?
+        @config.logger.error("[LDClient] Unknown feature flag #{key}. Returning default value")
+        @event_processor.add_event(kind: "feature", key: key, value: default, default: default)
+        return default
+      end
+
+      begin
+        res = evaluate(feature, user, @store)
+        if !res[:events].nil?
+          res[:events].each do |event|
+            @event_processor.add_event(event)
           end
-        rescue => exn
-          @config.logger.warn("[LDClient] Error evaluating feature flag: #{exn.inspect}. \nTrace: #{exn.backtrace}")
-          @event_processor.add_event(kind: "feature", key: key, user: user, value: default, default: default)
-          return default
         end
+        if !res[:value].nil?
+          @event_processor.add_event(kind: "feature", key: key, user: user, value: res[:value], default: default, version: feature[:version])
+          return res[:value]
+        else
+          @config.logger.debug("[LDClient] Result value is null in toggle")
+          @event_processor.add_event(kind: "feature", key: key, user: user, value: default, default: default, version: feature[:version])        
+          return default            
+        end
+      rescue => exn
+        @config.logger.warn("[LDClient] Error evaluating feature flag: #{exn.inspect}. \nTrace: #{exn.backtrace}")
+        @event_processor.add_event(kind: "feature", key: key, user: user, value: default, default: default, version: feature[:version])
+        return default
+      end
     end
 
     #

lib/ldclient-rb/requestor.rb

@@ -5,8 +5,8 @@
 module LaunchDarkly
 
   class Requestor
-    def initialize(api_key, config)
-      @api_key = api_key
+    def initialize(sdk_key, config)
+      @sdk_key = sdk_key
       @config = config
       @client = Faraday.new do |builder|
         builder.use :http_cache, store: @config.cache_store
@@ -25,14 +25,14 @@ def request_flag(key)
 
     def make_request(path)
       res = @client.get (@config.base_uri + path) do |req|
-        req.headers["Authorization"] = "api_key " + @api_key
+        req.headers["Authorization"] = @sdk_key
         req.headers["User-Agent"] = "RubyClient/" + LaunchDarkly::VERSION
         req.options.timeout = @config.read_timeout
         req.options.open_timeout = @config.connect_timeout
       end
 
       if res.status == 401
-        @config.logger.error("[LDClient] Invalid API key")
+        @config.logger.error("[LDClient] Invalid SDK key")
         return nil
       end
 

lib/ldclient-rb/stream.rb

@@ -10,8 +10,8 @@ module LaunchDarkly
   INDIRECT_PATCH = :'indirect/patch'
 
   class StreamProcessor
-    def initialize(api_key, config, requestor)
-      @api_key = api_key
+    def initialize(sdk_key, config, requestor)
+      @sdk_key = sdk_key
       @config = config
       @store = config.feature_store
       @requestor = requestor
@@ -30,7 +30,7 @@ def start
 
       headers = 
       {
-        'Authorization' => 'api_key ' + @api_key,
+        'Authorization' => @sdk_key,
         'User-Agent' => 'RubyClient/' + LaunchDarkly::VERSION
       }
       opts = {:headers => headers, :with_credentials => true}

spec/stream_spec.rb

@@ -33,8 +33,8 @@
 describe LaunchDarkly::StreamProcessor do
   subject { LaunchDarkly::StreamProcessor }
   let(:config) { LaunchDarkly::Config.new }
-  let(:requestor) { LaunchDarkly::Requestor.new("api_key", config)}
-  let(:processor) { subject.new("api_key", config, requestor) }
+  let(:requestor) { LaunchDarkly::Requestor.new("sdk_key", config)}
+  let(:processor) { subject.new("sdk_key", config, requestor) }
 
   describe '#process_message' do
     let(:put_message) { OpenStruct.new({data: '{"key": {"value": "asdf"}}'}) }