kameleoon-client-ruby 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ada1f2651143c67ac458a8adab629e1d6ad17e95a204809a0a2b44f0ee3a28
-  data.tar.gz: 306fab877c00913cc4b13cecfdf9e773c2bb735be110747df37d509b537d2e01
+  metadata.gz: 7d51a71ea79cd23f422a5235fce6f2e3fb94cae538b01222dd4c23b770985e59
+  data.tar.gz: 29f2501a20ffedf1637ee6d441b637358982761955d6235317f49b5284f17b70
 SHA512:
-  metadata.gz: 38ff8932ce2f9a0e9d72644ae47de0d0f34434943f33328f0459607e34769c83e64ff6325989f9722cc8cb202d440d5d8891dea073179d269e01d6b49fa361f9
-  data.tar.gz: b3ee0f99356eac881b01970269cde022435872c270268ffc6ec8c0dc0d31abe3816914a497edb15e744810f60190165c84424f4799876ff56d1e24e1590d56f8
+  metadata.gz: 7f4855238a2e8731458757336bc964a36d537e77e7e1b30eb73b5c7e270ee59ee021813b620c0997b9781a8e062b10f3a4797eaceffcd9ca731e5e86f11f1e12
+  data.tar.gz: e7d3659d4de54bc0be3aadf6ed96d213bf148ce481306ad8668b589dd892a26a74e78206c6d78dd9577c915e96bab1351c19f08c95ce8b4ae85aaef237b6bd6f

data/lib/kameleoon/client.rb

@@ -37,21 +37,13 @@ module Kameleoon
     ##
     # You should create Client with the Client Factory only.
     #
-    def initialize(site_code, path_config_file, interval, default_timeout, client_id = nil, client_secret = nil)
-      config = YAML.load_file(path_config_file)
+    def initialize(site_code, config)
       @site_code = site_code
-      @default_timeout = config['default_timeout'] || default_timeout # in ms
-      refresh_interval = config['actions_configuration_refresh_interval']
-      @interval = refresh_interval.nil? ? interval : "#{refresh_interval}m"
+      read_config(config)
       @real_time_configuration_service = nil
       @update_configuration_handler = nil
       @fetch_configuration_update_job = nil
-      @client_id = client_id || config['client_id']
-      @client_secret = client_secret || config['client_secret']
-      @data_maximum_size = config['visitor_data_maximum_size'] || 500 # mb
-      @environment = config['environment'] || DEFAULT_ENVIRONMENT
       @settings = Kameleoon::Configuration::Settings.new
-      @verbose_mode = config['verbose_mode'] || false
       @experiments = []
       @feature_flags = []
       @data = {}
@@ -513,11 +505,23 @@ module Kameleoon
     private
 
     REFERENCE = 0
-    DEFAULT_ENVIRONMENT = 'production'
     CACHE_EXPIRATION_TIMEOUT = 5
     attr :site_code, :client_id, :client_secret, :access_token, :experiments, :feature_flags, :scheduler, :data,
          :tracking_url, :default_timeout, :interval, :memory_limit, :verbose_mode
 
+    def read_config(config)
+      @client_id = config.client_id
+      @client_secret = config.client_secret
+      @default_timeout = config.default_timeout # in ms
+      @interval = "#{config.configuration_refresh_interval}m"
+      @data_maximum_size = config.visitor_data_maximum_size
+      @environment = config.environment
+      @verbose_mode = config.verbose_mode
+      if @client_id.nil? || @client_secret.nil?
+        warn 'Kameleoon SDK: Credentials are invalid: client_id or client_secret (or both) are empty'
+      end
+    end
+
     def fetch_configuration
       Rufus::Scheduler.singleton.in '0s' do
         log('Initial configuration fetch is started.')

data/lib/kameleoon/client_config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  # Client configuration which can be used instead of an external configuration file
+  class ClientConfig
+    CONFIGURATION_UPDATE_INTERVAL = 60
+    VISITOR_DATA_MAXIMUM_SIZE = 500
+    DEFAULT_TIMEOUT = 2000 # milli-seconds
+
+    attr_reader :client_id, :client_secret, :data_refresh_interval, :default_timeout, :configuration_refresh_interval,
+                :visitor_data_maximum_size, :environment, :verbose_mode
+
+    def initialize(
+      client_id: nil,
+      client_secret: nil,
+      configuration_refresh_interval: CONFIGURATION_UPDATE_INTERVAL,
+      default_timeout: DEFAULT_TIMEOUT,
+      visitor_data_maximum_size: VISITOR_DATA_MAXIMUM_SIZE,
+      environment: nil,
+      verbose_mode: false
+    )
+      @client_id = client_id
+      @client_secret = client_secret
+      @configuration_refresh_interval = configuration_refresh_interval || CONFIGURATION_UPDATE_INTERVAL
+      @default_timeout = default_timeout || DEFAULT_TIMEOUT
+      @visitor_data_maximum_size = visitor_data_maximum_size || VISITOR_DATA_MAXIMUM_SIZE
+      @environment = environment
+      @verbose_mode = verbose_mode || false
+    end
+
+    def self.make_from_yaml(yaml)
+      yaml ||= {}
+      ClientConfig.new(
+        client_id: yaml['client_id'],
+        client_secret: yaml['client_secret'],
+        configuration_refresh_interval: yaml['actions_configuration_refresh_interval'],
+        default_timeout: yaml['default_timeout'],
+        visitor_data_maximum_size: yaml['visitor_data_maximum_size'],
+        environment: yaml['environment'],
+        verbose_mode: yaml['verbose_mode']
+      )
+    end
+  end
+end

data/lib/kameleoon/factory.rb

@@ -1,29 +1,43 @@
 # frozen_string_literal: true
 
 require 'kameleoon/client'
+require 'kameleoon/client_config'
 
 module Kameleoon
   # A Factory class for creating kameleoon clients
   module ClientFactory
-    CONFIGURATION_UPDATE_INTERVAL = '60m'
     CONFIG_PATH = '/etc/kameleoon/client-ruby.yaml'
-    DEFAULT_TIMEOUT = 2000 # milli-seconds
 
     @clients = {}
 
-    def self.create(site_code, config_path = CONFIG_PATH, client_id = nil, client_secret = nil)
-      if @clients[site_code].nil?
-        client = Client.new(site_code, config_path, CONFIGURATION_UPDATE_INTERVAL,
-                            DEFAULT_TIMEOUT, client_id, client_secret)
+    def self.create(site_code, config_path = CONFIG_PATH, config: nil)
+      if config.nil?
+        config_yaml = YAML.load_file(config_path) if File.exist?(config_path)
+        if config_yaml.nil?
+          warn "Kameleoon SDK: Configuration file with path #{config_path} does not exist" if config_yaml.nil?
+          config_yaml = {}
+        end
+      end
+      environment = config&.environment || (config_yaml || {})['environment']
+      client = @clients[get_client_key(site_code, environment)]
+      if client.nil?
+        config = ClientConfig.make_from_yaml(config_yaml) if config.nil?
+        client = Client.new(site_code, config)
         client.send(:log, "Client created with site code: #{site_code}")
         client.send(:fetch_configuration)
         @clients.store(site_code, client)
       end
-      @clients[site_code]
+      client
+    end
+
+    def self.forget(site_code, environment = '')
+      @clients.delete(get_client_key(site_code, environment))
     end
 
-    def self.forget(site_code)
-      @clients.delete(site_code)
+    private_class_method
+
+    def self.get_client_key(site_code, environment)
+      site_code + (environment || '')
     end
   end
 end

data/lib/kameleoon/version.rb

@@ -2,7 +2,7 @@
 
 module Kameleoon
   SDK_NAME = 'RUBY'
-  SDK_VERSION = '2.2.0'
+  SDK_VERSION = '2.3.0'
 
   # SdkManager is a helper method for fetching / obtaining version of SDK from string
   class SdkVersion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -76,6 +76,7 @@ files:
 - README.md
 - lib/kameleoon.rb
 - lib/kameleoon/client.rb
+- lib/kameleoon/client_config.rb
 - lib/kameleoon/configuration/experiment.rb
 - lib/kameleoon/configuration/feature_flag.rb
 - lib/kameleoon/configuration/rule.rb