refact: Updates OptimizelyFactory methods. (#183)

Author: rashidsp

lib/optimizely/optimizely_factory.rb

@@ -19,26 +19,41 @@
 require 'optimizely'
 module Optimizely
   class OptimizelyFactory
-    def self.create_default_instance_with_sdk_key(sdk_key)
-      Optimizely::Project.new(nil, nil, nil, nil, nil, nil, sdk_key)
-    end
-
-    def self.create_default_instance_with_sdk_key_and_datafile(sdk_key, datafile = nil)
+    # Returns a new optimizely instance.
+    #
+    # @params sdk_key - Required String uniquely identifying the fallback datafile corresponding to project.
+    # @param fallback datafile - Optional JSON string datafile.
+    def self.default_instance(sdk_key, datafile = nil)
       Optimizely::Project.new(datafile, nil, nil, nil, nil, nil, sdk_key)
     end
 
-    def self.create_default_instance_with_config_manager(config_manager)
+    # Returns a new optimizely instance.
+    #
+    # @param config_manager - Required ConfigManagerInterface Responds to get_config.
+    def self.default_instance_with_config_manager(config_manager)
       Optimizely::Project.new(nil, nil, nil, nil, nil, nil, nil, config_manager)
     end
 
-    def self.create_default_instance(
+    # Returns a new optimizely instance.
+    #
+    # @params sdk_key - Required String uniquely identifying the datafile corresponding to project.
+    # @param fallback datafile - Optional JSON string datafile.
+    # @param event_dispatcher - Optional EventDispatcherInterface Provides a dispatch_event method which if given a URL and params sends a request to it.
+    # @param logger - Optional LoggerInterface Provides a log method to log messages. By default nothing would be logged.
+    # @param error_handler - Optional ErrorHandlerInterface which provides a handle_error method to handle exceptions.
+    #                 By default all exceptions will be suppressed.
+    # @param skip_json_validation - Optional Boolean param to skip JSON schema validation of the provided datafile.
+    # @param user_profile_service - Optional UserProfileServiceInterface Provides methods to store and retreive user profiles.
+    # @param config_manager - Optional ConfigManagerInterface Responds to get_config.
+    # @param notification_center - Optional Instance of NotificationCenter.
+    def self.custom_instance(
+      sdk_key,
       datafile = nil,
       event_dispatcher = nil,
       logger = nil,
       error_handler = nil,
       skip_json_validation = false,
       user_profile_service = nil,
-      sdk_key = nil,
       config_manager = nil,
       notification_center = nil
     )

spec/optimizely_factory_spec.rb

@@ -30,60 +30,40 @@
   let(:event_dispatcher) { Optimizely::EventDispatcher.new }
   let(:notification_center) { Optimizely::NotificationCenter.new(spy_logger, error_handler) }
 
-  describe '.create_default_instance' do
-    it 'should take static project config manager when sdk_key and config manager are not given' do
-      allow(Optimizely::StaticProjectConfigManager).to receive(:new)
-      static_project_config_manager = Optimizely::StaticProjectConfigManager.new(datafile, spy_logger, error_handler, false)
-      optimizely_instance = Optimizely::OptimizelyFactory.create_default_instance(
-        datafile,
-        event_dispatcher,
-        spy_logger,
-        error_handler,
-        false,
-        user_profile_service,
-        nil,
-        nil,
-        notification_center
-      )
-      expect(optimizely_instance.config_manager). to eq(static_project_config_manager)
-    end
-  end
-
-  describe '.create_default_instance_with_config_manager' do
-    it 'should take provided custom config manager' do
-      class CustomConfigManager
-        def get_config; end
-      end
-
-      custom_config_manager = CustomConfigManager.new
-      optimizely_instance = Optimizely::OptimizelyFactory.create_default_instance_with_config_manager(custom_config_manager)
-      expect(optimizely_instance.config_manager). to eq(custom_config_manager)
-    end
-  end
-
-  describe '.create_default_instance_with_sdk_key' do
+  describe '.default_instance' do
     it 'should take http config manager' do
       allow(Optimizely::HTTPProjectConfigManager).to receive(:new)
 
       http_project_config_manager = Optimizely::HTTPProjectConfigManager.new(
         sdk_key: 'sdk_key',
-        datafile: nil,
+        datafile: datafile,
         logger: spy_logger,
         error_handler: error_handler,
         skip_json_validation: false,
         notification_center: notification_center
       )
 
-      optimizely_instance = Optimizely::OptimizelyFactory.create_default_instance_with_sdk_key('sdk_key')
+      optimizely_instance = Optimizely::OptimizelyFactory.default_instance('sdk_key', datafile)
 
       expect(optimizely_instance.config_manager). to eq(http_project_config_manager)
     end
   end
 
-  describe '.create_default_instance_with_sdk_key_and_datafile' do
-    it 'should take http config manager' do
-      allow(Optimizely::HTTPProjectConfigManager).to receive(:new)
+  describe '.default_instance_with_manager' do
+    it 'should take provided custom config manager' do
+      class CustomConfigManager
+        def get_config; end
+      end
+
+      custom_config_manager = CustomConfigManager.new
+      optimizely_instance = Optimizely::OptimizelyFactory.default_instance_with_config_manager(custom_config_manager)
+      expect(optimizely_instance.config_manager). to eq(custom_config_manager)
+    end
+  end
 
+  describe '.custom_instance' do
+    it 'should take http config manager when sdk key is given' do
+      allow(Optimizely::HTTPProjectConfigManager).to receive(:new)
       http_project_config_manager = Optimizely::HTTPProjectConfigManager.new(
         sdk_key: 'sdk_key',
         datafile: datafile,
@@ -93,8 +73,17 @@ def get_config; end
         notification_center: notification_center
       )
 
-      optimizely_instance = Optimizely::OptimizelyFactory.create_default_instance_with_sdk_key_and_datafile('sdk_key', datafile)
-
+      optimizely_instance = Optimizely::OptimizelyFactory.custom_instance(
+        'sdk_key',
+        datafile,
+        event_dispatcher,
+        spy_logger,
+        error_handler,
+        false,
+        user_profile_service,
+        nil,
+        notification_center
+      )
       expect(optimizely_instance.config_manager). to eq(http_project_config_manager)
     end
   end