absmartly-sdk 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc6b910c683119e99ad8800165f98b47b280ccd5f9e44a915d1043e1256888c
-  data.tar.gz: 8d8d61b7f4f8ed27280a4c3aa4ea7cf9bf8519b5b6743a809c3a799bd38e6c5f
+  metadata.gz: 4a2b6f96e452fc60de76e49bc1166b6df3030b1ab424e99cdaf72554493ac0b3
+  data.tar.gz: aae37038713a693935209e387dee6ac5a33f84d4c74a27edec5d2ed69152e1e7
 SHA512:
-  metadata.gz: c6a4e6f5e52ffeb1f29a60d0a9a08474c460c28355dfd6c1471c3c756254248cac33c2c7fe0760e8b415e1b699cbee882217177f32a9aeffdbfe5fa2e65a0b45
-  data.tar.gz: 1d714b5d6288e2a87982fec2e45f76ff2ef3aaeb2d227e43c3dbaaeafb419f9a33bff7acdd615326454067bee3dcce7682caf11e7ba3a921229d065eb4d51ee0
+  metadata.gz: 6c5feb92c44db0ea6b24d33f40812626d4fdeaa6339c258c5da5926e522382f0981a0550b2508ae7a79ca6b0b1d6c18d54ed2a0f1b24c4241b45cad3d3a39edb
+  data.tar.gz: 113ba3c0c2594537dd8ea6c02021bc447f7918783b7175106317d60893013a843f0f93f4eb4411deab9b502f97b539120593d66a0d9c4b50e2fc201cf1d2e531

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    absmartly-sdk (1.2.1)
+    absmartly-sdk (1.2.2)
       base64 (~> 0.2)
       faraday (~> 2.0)
       faraday-retry (~> 2.0)

data/absmartly.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# $:.push File.expand_path("../lib", __FILE__)
+require File.expand_path("lib/absmartly/version", __dir__)
+Gem::Specification.new do |spec|
+  spec.name = "absmartly-sdk"
+  spec.version = Absmartly::VERSION
+  spec.authors = ["absmartly"]
+  spec.email = ["sdks@absmartly.com"]
+
+  spec.summary = "Absmartly gem"
+  spec.description = "Absmartly gem"
+
+  spec.homepage = "https://github.com/absmartly/ruby-sdk"
+
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.extra_rdoc_files = ["README.md"]
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/absmartly/ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/absmartly/ruby-sdk"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Required for Ruby 3.4+ where base64 is no longer a default gem.
+  # Faraday 2.7.x uses base64 but doesn't declare it as a dependency.
+  spec.add_dependency "base64", "~> 0.2"
+  spec.add_dependency "faraday", "~> 2.0"
+  spec.add_dependency "faraday-retry", "~> 2.0"
+  spec.add_dependency "murmurhash3", "~> 0.1.7"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/a_b_smartly.rb

@@ -1,51 +1,88 @@
 # frozen_string_literal: true
 
 require "time"
-require "singleton"
-require "forwardable"
 require_relative "context"
 require_relative "audience_matcher"
-require_relative "a_b_smartly_config"
-require_relative "absmartly/version"
+require_relative "default_context_data_provider"
+require_relative "default_context_event_handler"
+require_relative "default_variable_parser"
+require_relative "default_audience_deserializer"
+require_relative "scheduled_thread_pool_executor"
 
 class ABSmartly
-  extend Forwardable
-
-  attr_reader :config
-
-  def_delegators :@config, :context_data_provider, :context_event_handler, :variable_parser, :context_event_logger,
-                 :audience_deserializer, :client
-
-  def_delegators :@config, :endpoint, :api_key, :application, :environment
+  attr_accessor :context_data_provider, :context_event_handler,
+                :variable_parser, :scheduler, :context_event_logger,
+                :audience_deserializer, :client
 
   def self.create(config)
-    new(config)
+    ABSmartly.new(config)
   end
 
   def initialize(config)
-    config.validate!
+    @context_data_provider = config.context_data_provider
+    @context_event_handler = config.context_event_handler
+    @context_event_logger = config.context_event_logger
+    @variable_parser = config.variable_parser
+    @audience_deserializer = config.audience_deserializer
+    @scheduler = config.scheduler
+
+    if @context_data_provider.nil? || @context_event_handler.nil?
+      @client = config.client
+      raise ArgumentError.new("Missing Client instance configuration") if @client.nil?
+
+      if @context_data_provider.nil?
+        @context_data_provider = DefaultContextDataProvider.new(@client)
+      end
+
+      if @context_event_handler.nil?
+        @context_event_handler = DefaultContextEventHandler.new(@client)
+      end
+    end
 
-    @config = config
+    if @variable_parser.nil?
+      @variable_parser = DefaultVariableParser.new
+    end
+
+    if @audience_deserializer.nil?
+      @audience_deserializer = DefaultAudienceDeserializer.new
+    end
+    if @scheduler.nil?
+      @scheduler = ScheduledThreadPoolExecutor.new(1)
+    end
   end
 
-  def create_context(context_config)
-    Context.create(get_utc_format, context_config, context_data,
-                   context_data_provider, context_event_handler, context_event_logger, variable_parser,
-                   AudienceMatcher.new(audience_deserializer))
+  def create_context(config)
+    validate_params(config)
+    Context.create(get_utc_format, config, @context_data_provider.context_data,
+                   @context_data_provider, @context_event_handler, @context_event_logger, @variable_parser,
+                   AudienceMatcher.new(@audience_deserializer))
   end
 
-  def create_context_with(context_config, data)
-    Context.create(get_utc_format, context_config, data,
-                   context_data_provider, context_event_handler, context_event_logger, variable_parser,
-                   AudienceMatcher.new(audience_deserializer))
+  def create_context_with(config, data)
+    validate_params(config)
+    Context.create(get_utc_format, config, data,
+                   @context_data_provider, @context_event_handler, @context_event_logger, @variable_parser,
+                   AudienceMatcher.new(@audience_deserializer))
   end
 
   def context_data
-    context_data_provider.context_data
+    @context_data_provider.context_data
   end
 
   private
     def get_utc_format
       Time.now.utc.iso8601(3)
     end
+
+    def validate_params(params)
+      params.units.each do |key, value|
+        unless value.is_a?(String) || value.is_a?(Numeric)
+          raise ArgumentError.new("Unit '#{key}' UID is of unsupported type '#{value.class}'. UID must be one of ['string', 'number']")
+        end
+
+        if value.to_s.size.zero?
+          raise ArgumentError.new("Unit '#{key}' UID length must be >= 1")
+        end
+      end
+    end
 end

data/lib/a_b_smartly_config.rb

@@ -1,65 +1,45 @@
 # frozen_string_literal: true
 
-require "forwardable"
-
-require_relative "client"
-require_relative "client_config"
-require_relative "default_context_data_provider"
-require_relative "default_context_event_handler"
-require_relative "default_variable_parser"
-require_relative "default_audience_deserializer"
-
 class ABSmartlyConfig
-  extend Forwardable
-
-  attr_accessor :scheduler
-
-  attr_writer :context_data_provider, :context_event_handler, :audience_deserializer, :variable_parser, :client
-
-  attr_reader :client_config, :context_event_logger
-
-  def_delegators :@client_config, :endpoint, :api_key, :application, :environment
-  def_delegators :@client_config, :connect_timeout, :connection_request_timeout, :retry_interval, :max_retries
-
+  attr_accessor :context_data_provider, :context_event_handler,
+                :variable_parser, :scheduler, :context_event_logger,
+                :client, :audience_deserializer
   def self.create
-    new
+    ABSmartlyConfig.new
   end
 
-  def initialize
-    @client_config = ClientConfig.new
+  def context_data_provider=(context_data_provider)
+    @context_data_provider = context_data_provider
+    self
   end
 
-  def validate!
-    raise ArgumentError.new("event logger not configured") if context_event_logger.nil?
-    raise ArgumentError.new("failed to initialize client") if client.nil?
-    raise ArgumentError.new("failed to initialize context_data_provider") if context_data_provider.nil?
+  def context_event_handler=(context_event_handler)
+    @context_event_handler = context_event_handler
+    self
   end
 
-  def context_event_logger=(context_event_logger)
-    if context_event_logger.is_a?(Proc)
-      @context_event_logger = ContextEventLoggerCallback.new(context_event_logger)
-    else
-      @context_event_logger = context_event_logger
-    end
+  def variable_parser=(variable_parser)
+    @variable_parser = variable_parser
+    self
   end
 
-  def variable_parser
-    @variable_parser ||= DefaultVariableParser.new
+  def scheduler=(scheduler)
+    @scheduler = scheduler
+    self
   end
 
-  def audience_deserializer
-    @audience_deserializer ||= DefaultAudienceDeserializer.new
-  end
-
-  def context_data_provider
-    @context_data_provider ||= DefaultContextDataProvider.new(client)
+  def context_event_logger=(context_event_logger)
+    @context_event_logger = context_event_logger
+    self
   end
 
-  def context_event_handler
-    @context_event_handler ||= DefaultContextEventHandler.new(client)
+  def audience_deserializer=(audience_deserializer)
+    @audience_deserializer = audience_deserializer
+    self
   end
 
-  def client
-    @client ||= Client.new(client_config)
+  def client=(client)
+    @client = client
+    self
   end
 end

data/lib/absmartly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Absmartly
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/absmartly.rb

@@ -12,12 +12,10 @@ module Absmartly
   end
 
   class << self
-    MUTEX = Thread::Mutex.new
+    attr_accessor :endpoint, :api_key, :application, :environment
 
     def configure_client
-      yield sdk_config
-
-      sdk_config.validate!
+      yield self
     end
 
     def create
@@ -40,15 +38,24 @@ module Absmartly
       sdk.context_data
     end
 
-    private_constant :MUTEX
-
     private
+      def client_config
+        @client_config = ClientConfig.create
+        @client_config.endpoint = @endpoint
+        @client_config.api_key = @api_key
+        @client_config.application = @application
+        @client_config.environment = @environment
+        @client_config
+      end
+
       def sdk_config
-        MUTEX.synchronize { @sdk_config ||= ABSmartlyConfig.create }
+        @sdk_config = ABSmartlyConfig.create
+        @sdk_config.client = Client.create(client_config)
+        @sdk_config
       end
 
       def sdk
-        MUTEX.synchronize { @sdk ||= create }
+        @sdk ||= create
       end
   end
 end

data/lib/client.rb

@@ -1,49 +1,80 @@
 # frozen_string_literal: true
 
-require "forwardable"
 require_relative "default_http_client"
 require_relative "default_http_client_config"
 require_relative "default_context_data_deserializer"
 require_relative "default_context_event_serializer"
 
 class Client
-  extend Forwardable
+  attr_accessor :url, :query, :headers, :http_client, :executor, :deserializer, :serializer
+  attr_reader :data_future, :promise, :exception
 
-  attr_accessor :http_client
-  attr_reader :config, :data_future, :promise, :exception
+  def self.create(config, http_client = nil)
+    Client.new(config, http_client || DefaultHttpClient.create(DefaultHttpClientConfig.create))
+  end
 
-  def_delegators :@config, :url, :query, :headers, :deserializer, :serializer
-  def_delegator :@http_client, :close
-  def_delegator :@promise, :success?
+  def initialize(config, http_client = nil)
+    endpoint = config.endpoint
+    raise ArgumentError.new("Missing Endpoint configuration") if endpoint.nil? || endpoint.empty?
 
-  def self.create(config = nil, http_client = nil)
-    new(config, http_client)
-  end
+    api_key = config.api_key
+    raise ArgumentError.new("Missing APIKey configuration") if api_key.nil? || api_key.empty?
+
+    application = config.application
+    raise ArgumentError.new("Missing Application configuration") if application.nil? || application.empty?
+
+    environment = config.environment
+    raise ArgumentError.new("Missing Environment configuration") if environment.nil? || environment.empty?
+
+    @url = "#{endpoint}/context"
+    @http_client = http_client
+    @deserializer = config.context_data_deserializer
+    @serializer = config.context_event_serializer
+    @executor = config.executor
 
-  def initialize(config = nil, http_client = nil)
-    @config = config || ClientConfig.new
-    @config.validate!
+    @deserializer = DefaultContextDataDeserializer.new if @deserializer.nil?
+    @serializer = DefaultContextEventSerializer.new if @serializer.nil?
 
-    @http_client = http_client || DefaultHttpClient.create(@config.http_client_config)
+    @headers = {
+      "Content-Type": "application/json",
+      "X-API-Key": api_key,
+      "X-Application": application,
+      "X-Environment": environment,
+      "X-Application-Version": "0",
+      "X-Agent": "absmartly-ruby-sdk"
+    }
+
+    @query = {
+      "application": application,
+      "environment": environment
+    }
   end
 
   def context_data
-    @promise = http_client.get(config.url, config.query, config.headers)
+    @promise = @http_client.get(@url, @query, @headers)
     unless @promise.success?
       @exception = Exception.new(@promise.body)
       return self
     end
 
     content = (@promise.body || {}).to_s
-    @data_future = deserializer.deserialize(content, 0, content.size)
+    @data_future = @deserializer.deserialize(content, 0, content.size)
     self
   end
 
   def publish(event)
-    content = serializer.serialize(event)
-    response = http_client.put(config.url, nil, config.headers, content)
+    content = @serializer.serialize(event)
+    response = @http_client.put(@url, nil, @headers, content)
     return Exception.new(response.body) unless response.success?
 
     response
   end
+
+  def close
+    @http_client.close
+  end
+
+  def success?
+    @promise&.success? || false
+  end
 end

data/lib/client_config.rb

@@ -1,33 +1,21 @@
 # frozen_string_literal: true
 
-require "forwardable"
-require_relative "default_context_data_deserializer"
-require_relative "default_context_event_serializer"
-require_relative "default_http_client_config"
-
 class ClientConfig
-  extend Forwardable
-
-  attr_accessor :endpoint, :api_key, :environment, :application
-
-  attr_reader :http_client_config
-
-  attr_writer :context_data_deserializer, :context_event_serializer
-
-  def_delegators :@http_client_config, :connect_timeout, :connection_request_timeout, :retry_interval, :max_retries
+  attr_accessor :endpoint, :api_key, :environment, :application, :deserializer,
+                :serializer, :executor
 
-  def self.create(endpoint: nil, environment: nil, application: nil, api_key: nil)
-    new(endpoint: endpoint, environment: environment, application: application, api_key: api_key)
+  def self.create
+    ClientConfig.new
   end
 
   def self.create_from_properties(properties, prefix)
     properties = properties.transform_keys(&:to_sym)
-    create(
-      endpoint: properties["#{prefix}endpoint".to_sym],
-      environment: properties["#{prefix}environment".to_sym],
-      application: properties["#{prefix}application".to_sym],
-      api_key: properties["#{prefix}apikey".to_sym]
-    )
+    client_config = create
+    client_config.endpoint = properties["#{prefix}endpoint".to_sym]
+    client_config.environment = properties["#{prefix}environment".to_sym]
+    client_config.application = properties["#{prefix}application".to_sym]
+    client_config.api_key = properties["#{prefix}apikey".to_sym]
+    client_config
   end
 
   def initialize(endpoint: nil, environment: nil, application: nil, api_key: nil)
@@ -35,60 +23,21 @@ class ClientConfig
     @environment = environment
     @application = application
     @api_key = api_key
-
-    @http_client_config = DefaultHttpClientConfig.new
   end
 
   def context_data_deserializer
-    @context_data_deserializer ||= DefaultContextDataDeserializer.new
-  end
-
-  def context_event_serializer
-    @context_event_serializer ||= DefaultContextEventSerializer.new
-  end
-
-  def deserializer=(deserializer)
-    @context_data_deserializer = deserializer
-  end
-
-  def serializer=(serializer)
-    @context_event_serializer = serializer
-  end
-
-  def deserializer
-    context_data_deserializer
+    @deserializer
   end
 
-  def serializer
-    context_event_serializer
+  def context_data_deserializer=(deserializer)
+    @deserializer = deserializer
   end
 
-  def url
-    @url ||= "#{endpoint}/context"
-  end
-
-  def headers
-    @headers ||= {
-      "Content-Type": "application/json",
-      "X-API-Key": api_key,
-      "X-Application": application,
-      "X-Environment": environment,
-      "X-Application-Version": "0",
-      "X-Agent": "absmartly-ruby-sdk"
-    }
-  end
-
-  def query
-    @query ||= {
-      "application": application,
-      "environment": environment
-    }
+  def context_event_serializer
+    @serializer
   end
 
-  def validate!
-    raise ArgumentError.new("Missing Endpoint configuration") if endpoint.nil? || endpoint.empty?
-    raise ArgumentError.new("Missing APIKey configuration") if api_key.nil? || api_key.empty?
-    raise ArgumentError.new("Missing Application configuration") if application.nil? || application.empty?
-    raise ArgumentError.new("Missing Environment configuration") if environment.nil? || environment.empty?
+  def context_event_serializer=(serializer)
+    @serializer = serializer
   end
 end

data/lib/context.rb

@@ -10,7 +10,7 @@ require_relative "json/publish_event"
 require_relative "json/goal_achievement"
 
 class Context
-  attr_reader :pending_count
+  attr_reader :data, :pending_count
 
   def self.create(clock, config, data_future, data_provider,
                   event_handler, event_logger, variable_parser, audience_matcher)
@@ -114,10 +114,6 @@ class Context
   def set_unit(unit_type, uid)
     check_not_closed?
 
-    unless uid.is_a?(String) || uid.is_a?(Numeric)
-      raise IllegalStateException.new("Unit '#{unit_type}' UID is of unsupported type '#{uid.class}'. UID must be one of ['string', 'number']")
-    end
-
     previous = @units[unit_type.to_sym]
     if !previous.nil? && previous != uid
       raise IllegalStateException.new("Unit '#{unit_type}' already set.")
@@ -545,6 +541,7 @@ class Context
                 @experimentCustomFieldValues[custom_field_value.name] = value
 
               end
+
             end
           end
 

data/lib/context_config.rb

@@ -69,8 +69,11 @@ class ContextConfig
     @custom_assignments[experiment_name.to_sym]
   end
 
+
   def set_event_logger(event_logger)
     @event_logger = event_logger
     self
   end
+
+  attr_reader :event_logger
 end

data/lib/default_http_client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "faraday/retry"
+require 'faraday/retry'
 require "uri"
 require_relative "http_client"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: absmartly-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - absmartly
@@ -83,6 +83,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- absmartly.gemspec
 - example/example.rb
 - lib/a_b_smartly.rb
 - lib/a_b_smartly_config.rb