ruby doc configuration

Author: rashidsp

.gitignore

@@ -6,6 +6,7 @@ Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
+!/doc/README.md
 /spec/reports/
 /tmp/
 *.DS_Store

.yardopts

@@ -0,0 +1,11 @@
+--query '@api.text != "no-doc"'
+lib/optimizely/error_handler.rb
+lib/optimizely/exceptions.rb
+lib/optimizely/event_dispatcher.rb
+lib/optimizely/logger.rb
+lib/optimizely/notification_center.rb
+lib/optimizely.rb
+lib/optimizely/user_profile_service.rb
+-
+CONTRIBUTING.md
+.rubocop.yml

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.2
+June 19th, 2018
+
+- Fix: send impression event for Feature Test when Feature is disabled ([#110](https://github.com/optimizely/ruby-sdk/pull/110)).
+
 ## 2.0.1
 April 25th, 2018
 

docs/README.md renamed to doc/README.md

@@ -7,11 +7,7 @@
 * There's a possible chance your Ruby install lacks RDoc, which is occasionally used by YARD to convert markup to HTML. If RDoc not installed, install by issuing:
 * `$ apt-get install rdoc`
 
-* `$ yardoc 'lib/**/*.rb'...etc...`
-
-**OR**
-
-* `$ yardoc 'lib/*.rb' 'lib/optimizely/event_dispatcher.rb' 'lib/optimizely/notification_center.rb' 'lib/optimizely/logger.rb' 'lib/optimizely/error_handler.rb' 'lib/optimizely/user_profile_service.rb'`
+* `$ yardoc`
 
 * This will generate HTML documentation in **doc** directory.
 * Open **index.html** in **doc** directory.

lib/optimizely.rb

@@ -25,13 +25,13 @@ def dispatch_event(event); end
   end
 
   class EventDispatcher
+    # @api constants
     REQUEST_TIMEOUT = 10
 
+    # Dispatch the event being represented by the Event object.
+    #
+    # @param event - Event object
     def dispatch_event(event)
-      # Dispatch the event being represented by the Event object.
-      #
-      # event - Event object
-
       if event.http_verb == :get
         begin
           HTTParty.get(event.url, headers: event.headers, query: event.params, timeout: REQUEST_TIMEOUT)

lib/optimizely/event_dispatcher.rb

@@ -17,8 +17,8 @@
 #
 module Optimizely
   class NotificationCenter
-    attr_reader :notifications
-    attr_reader :notification_id
+    # @api no-doc
+    attr_reader :notifications, :notification_id
 
     NOTIFICATION_TYPES = {
       ACTIVATE: 'ACTIVATE: experiment, user_id, attributes, variation, event',
@@ -33,16 +33,14 @@ def initialize(logger, error_handler)
       @error_handler = error_handler
     end
 
-    def add_notification_listener(notification_type, notification_callback)
-      # Adds notification callback to the notification center
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-      #  notification_callback: function to call when the event is sent
-
-      # Returns:
-      #  notification ID used to remove the notification
+    # Adds notification callback to the notification center
+    #
+    # @param notification_type -  One of the constants in NOTIFICATION_TYPES
+    # @param notification_callback -  Function to call when the event is sent
+    #
+    # @return [notification ID] Used to remove the notification
 
+    def add_notification_listener(notification_type, notification_callback)
       return nil unless notification_type_valid?(notification_type)
 
       unless notification_callback
@@ -64,13 +62,13 @@ def add_notification_listener(notification_type, notification_callback)
       notification_id
     end
 
-    def remove_notification_listener(notification_id)
-      # Removes previously added notification callback
+    # Removes previously added notification callback
+    #
+    # @param notification_id
+    #
+    # @return [Boolean] The function returns true if found and removed, false otherwise
 
-      # Args:
-      #  notification_id:
-      # Returns:
-      #  The function returns true if found and removed, false otherwise
+    def remove_notification_listener(notification_id)
       unless notification_id
         @logger.log Logger::ERROR, 'Notification ID can not be empty.'
         return nil
@@ -86,30 +84,30 @@ def remove_notification_listener(notification_id)
       false
     end
 
-    def clear_notifications(notification_type)
-      # Removes notifications for a certain notification type
-      #
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
+    # Removes notifications for a certain notification type
+    #
+    # @param notification_type - one of the constants in NOTIFICATION_TYPES
 
+    def clear_notifications(notification_type)
       return nil unless notification_type_valid?(notification_type)
 
       @notifications[notification_type] = []
       @logger.log Logger::INFO, "All callbacks for notification type #{notification_type} have been removed."
     end
 
+    # Removes all notifications
     def clean_all_notifications
-      # Removes all notifications
       @notifications.each_key { |key| @notifications[key] = [] }
     end
 
+    # Sends off the notification for the specific event.  Uses var args to pass in a
+    # arbitrary list of parameters according to which notification type was sent
+    #
+    # @param notification_type - one of the constants in NOTIFICATION_TYPES
+    # @param args - list of arguments to the callback
+    #
+    # @api no-doc
     def send_notifications(notification_type, *args)
-      # Sends off the notification for the specific event.  Uses var args to pass in a
-      # arbitrary list of parameters according to which notification type was sent
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-      #  args: list of arguments to the callback
       return nil unless notification_type_valid?(notification_type)
 
       @notifications[notification_type].each do |notification|

lib/optimizely/notification_center.rb

@@ -21,18 +21,15 @@ class BaseUserProfileService
     # Class encapsulating user profile service functionality.
     # Override with your own implementation for storing and retrieving user profiles.
 
-    def lookup(user_id)
-      # Retrieve the Hash user profile associated with a given user ID.
-      #
-      # user_id - String user ID
-      #
-      # Returns Hash user profile.
-    end
+    # Retrieve the Hash user profile associated with a given user ID.
+    #
+    # @param user_id - String user ID
+    # @return [Hash] user profile.
+    def lookup(user_id); end
 
-    def save(user_profile)
-      # Saves a given user profile.
-      #
-      # user_profile - Hash user profile.
-    end
+    # Saves a given user profile.
+    #
+    # @param user_profile - Hash user profile.
+    def save(user_profile); end
   end
 end

lib/optimizely/user_profile_service.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

lib/optimizely/version.rb

@@ -834,7 +834,8 @@ class InvalidErrorHandler; end
       expect(spy_logger).to have_received(:log).once.with(Logger::INFO, "Feature 'multi_variate_feature' is enabled for user 'test_user'.")
     end
 
-    it 'should return false, if the user is bucketed into a feature experiment but the featureEnabled property is false' do
+    it 'should return false and send impression if the user is bucketed into a feature experiment but the featureEnabled property is false' do
+      allow(project_instance.event_dispatcher).to receive(:dispatch_event).with(instance_of(Optimizely::Event))
       experiment_to_return = config_body['experiments'][3]
       variation_to_return = experiment_to_return['variations'][1]
       decision_to_return = Optimizely::DecisionService::Decision.new(
@@ -846,6 +847,7 @@ class InvalidErrorHandler; end
       allow(project_instance.decision_service).to receive(:get_variation_for_feature).and_return(decision_to_return)
 
       expect(project_instance.is_feature_enabled('multi_variate_feature', 'test_user')).to be false
+      expect(project_instance.event_dispatcher).to have_received(:dispatch_event).with(instance_of(Optimizely::Event)).once
       expect(spy_logger).to have_received(:log).once.with(Logger::INFO, "Feature 'multi_variate_feature' is not enabled for user 'test_user'.")
     end
   end
@@ -893,6 +895,17 @@ class InvalidErrorHandler; end
     user_id = 'test_user'
     user_attributes = {}
 
+    it 'should return nil when called with invalid project config' do
+      logger = double('logger')
+      allow(logger).to receive(:log)
+      allow(Optimizely::SimpleLogger).to receive(:new) { logger }
+      invalid_project = Optimizely::Project.new('invalid', nil, spy_logger)
+      expect(invalid_project.get_feature_variable_string('string_single_variable_feature', 'string_variable', user_id, user_attributes))
+        .to eq(nil)
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format.')
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format. Aborting get_feature_variable_string.')
+    end
+
     describe 'when the feature flag is enabled for the user' do
       describe 'and a variable usage instance is not found' do
         it 'should return the default variable value' do
@@ -1027,6 +1040,17 @@ class InvalidErrorHandler; end
     user_id = 'test_user'
     user_attributes = {}
 
+    it 'should return nil when called with invalid project config' do
+      logger = double('logger')
+      allow(logger).to receive(:log)
+      allow(Optimizely::SimpleLogger).to receive(:new) { logger }
+      invalid_project = Optimizely::Project.new('invalid', nil, spy_logger)
+      expect(invalid_project.get_feature_variable_boolean('boolean_single_variable_feature', 'boolean_variable', user_id, user_attributes))
+        .to eq(nil)
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format.')
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format. Aborting get_feature_variable_boolean.')
+    end
+
     it 'should return the variable value for the variation for the user is bucketed into' do
       boolean_feature = project_instance.config.feature_flag_key_map['boolean_single_variable_feature']
       rollout = project_instance.config.rollout_id_map[boolean_feature['rolloutId']]
@@ -1053,6 +1077,17 @@ class InvalidErrorHandler; end
     user_id = 'test_user'
     user_attributes = {}
 
+    it 'should return nil when called with invalid project config' do
+      logger = double('logger')
+      allow(logger).to receive(:log)
+      allow(Optimizely::SimpleLogger).to receive(:new) { logger }
+      invalid_project = Optimizely::Project.new('invalid', nil, spy_logger)
+      expect(invalid_project.get_feature_variable_double('double_single_variable_feature', 'double_variable', user_id, user_attributes))
+        .to eq(nil)
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format.')
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format. Aborting get_feature_variable_double.')
+    end
+
     it 'should return the variable value for the variation for the user is bucketed into' do
       double_feature = project_instance.config.feature_flag_key_map['double_single_variable_feature']
       experiment_to_return = project_instance.config.experiment_id_map[double_feature['experimentIds'][0]]
@@ -1080,6 +1115,17 @@ class InvalidErrorHandler; end
     user_id = 'test_user'
     user_attributes = {}
 
+    it 'should return nil when called with invalid project config' do
+      logger = double('logger')
+      allow(logger).to receive(:log)
+      allow(Optimizely::SimpleLogger).to receive(:new) { logger }
+      invalid_project = Optimizely::Project.new('invalid', nil, spy_logger)
+      expect(invalid_project.get_feature_variable_integer('integer_single_variable_feature', 'integer_variable', user_id, user_attributes))
+        .to eq(nil)
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format.')
+      expect(logger).to have_received(:log).once.with(Logger::ERROR, 'Provided datafile is in an invalid format. Aborting get_feature_variable_integer.')
+    end
+
     it 'should return the variable value for the variation for the user is bucketed into' do
       integer_feature = project_instance.config.feature_flag_key_map['integer_single_variable_feature']
       experiment_to_return = project_instance.config.experiment_id_map[integer_feature['experimentIds'][0]]