absmartly-sdk 1.2.2 → 1.3.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a2b6f96e452fc60de76e49bc1166b6df3030b1ab424e99cdaf72554493ac0b3
-  data.tar.gz: aae37038713a693935209e387dee6ac5a33f84d4c74a27edec5d2ed69152e1e7
+  metadata.gz: 01cba8157effb3de46d5392c80d36d4247b1a802f0c4ec5fab1758bb2f1059b7
+  data.tar.gz: dfbe07427f077cd936ec28449f3d42d8efcbb9d09d90b0a171998976acdb442e
 SHA512:
-  metadata.gz: 6c5feb92c44db0ea6b24d33f40812626d4fdeaa6339c258c5da5926e522382f0981a0550b2508ae7a79ca6b0b1d6c18d54ed2a0f1b24c4241b45cad3d3a39edb
-  data.tar.gz: 113ba3c0c2594537dd8ea6c02021bc447f7918783b7175106317d60893013a843f0f93f4eb4411deab9b502f97b539120593d66a0d9c4b50e2fc201cf1d2e531
+  metadata.gz: 5920cdb96b212aa2fbc08d52212b7d15fd11eab5493b50d22d05e51dac2f30414fe2080735ac1f4b1a30c61723c1e41f4841bfc4a623a40686c30d12ef0f4fc0
+  data.tar.gz: 45cc5a139fd3fdca0c2b97ba98da1ed0caf14b63a70684f3ae983f473016e8147ea269ca7f90f00b5752ddb0f1779c7362d7d706d10079d257f581c1c5914fe3

data/Gemfile

@@ -8,6 +8,8 @@ gemspec
 gem "rake", "~> 13.0"
 gem "murmurhash3"
 gem "faraday"
+gem "faraday-net_http_persistent"
+gem "connection_pool", "< 3"
 
 group :test do
   gem "rspec", "~> 3.5"

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    absmartly-sdk (1.2.2)
+    absmartly-sdk (1.3.0.pre.1)
       base64 (~> 0.2)
       faraday (~> 2.0)
+      faraday-net_http_persistent (~> 2.0)
       faraday-retry (~> 2.0)
       murmurhash3 (~> 0.1.7)
 
@@ -13,11 +14,15 @@ GEM
     ast (2.4.2)
     base64 (0.3.0)
     byebug (11.1.3)
+    connection_pool (2.5.5)
     diff-lcs (1.5.0)
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    faraday-net_http_persistent (2.3.1)
+      faraday (~> 2.5)
+      net-http-persistent (>= 4.0.4, < 5)
     faraday-retry (2.4.0)
       faraday (~> 2.0)
     io-console (0.5.6)
@@ -25,6 +30,8 @@ GEM
       reline (>= 0.1.5)
     json (2.6.2)
     murmurhash3 (0.1.7)
+    net-http-persistent (4.0.8)
+      connection_pool (>= 2.2.4, < 4)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -70,7 +77,9 @@ PLATFORMS
 DEPENDENCIES
   absmartly-sdk!
   byebug
+  connection_pool (< 3)
   faraday
+  faraday-net_http_persistent
   irb
   murmurhash3
   rake (~> 13.0)

data/README.md

@@ -29,6 +29,10 @@ Absmartly.configure_client do |config|
   config.api_key = "YOUR-API-KEY"
   config.application = "website"
   config.environment = "development"
+  config.connect_timeout = 3.0
+  config.connection_request_timeout = 3.0
+  config.retry_interval = 0.5
+  config.max_retries = 5
 end
 ```
 
@@ -37,21 +41,50 @@ end
 | Config      | Type                                 | Required? |                 Default                 | Description                                                                                                                                                                   |
 | :---------- | :----------------------------------- | :-------: | :-------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | endpoint    | `string`                             |  ✅  |               `undefined`               | The URL to your API endpoint. Most commonly `"your-company.absmartly.io"`                                                                                                     |
-| apiKey      | `string`                             |  ✅  |               `undefined`               | Your API key which can be found on the Web Console.                                                                                                                           |
+| api_key      | `string`                             |  ✅  |               `undefined`               | Your API key which can be found on the Web Console.                                                                                                                           |
 | environment | `"production"` or `"development"`    |  ✅  |               `undefined`               | The environment of the platform where the SDK is installed. Environments are created on the Web Console and should match the available environments in your infrastructure.   |
 | application | `string`                             |  ✅  |               `undefined`               | The name of the application where the SDK is installed. Applications are created on the Web Console and should match the applications where your experiments will be running. |
-| retries     | `number`                             | ❌  |                   `5`                   | The number of retries before the SDK stops trying to connect.                                                                                                                 |
-| timeout     | `number`                             | ❌  |                 `3000`                  | An amount of time, in milliseconds, before the SDK will stop trying to connect.                                                                                               |
-| eventLogger | `(context, eventName, data) => void` | ❌  | See "Using a Custom Event Logger" below | A callback function which runs after SDK events.                                                                                                                              |
+| connect_timeout     | `number`                             | ❌  |                   `3.0`                   | The socket connection timeout in seconds.                                                                                                                 |
+| connection_request_timeout     | `number`                             | ❌  |                 `3.0`                  | The request timeout in seconds.                                                                                               |
+| retry_interval     | `number`                             | ❌  |                   `0.5`                   | The initial retry interval in seconds (uses exponential backoff).                                                                                                                 |
+| max_retries     | `number`                             | ❌  |                 `5`                  | The maximum number of retries before giving up.                                                                                               |
+| event_logger | `ContextEventLogger` | ❌  | See "Using a Custom Event Logger" below | A `ContextEventLogger` instance implementing `handle_event(event, data)` to receive SDK events.                                                                                                                              |
 
 ### Using a Custom Event Logger
 
 The A/B Smartly SDK can be instantiated with an event logger used for all
 contexts. In addition, an event logger can be specified when creating a
-particular context, in the `[CONTEXT_CONFIG_VARIABLE]`.
+particular context in the context config.
 
-```
-Custom Event Logger Code
+```ruby
+class MyEventLogger < ContextEventLogger
+  def handle_event(event, data)
+    case event
+    when EVENT_TYPE::EXPOSURE
+      puts "Exposure: #{data}"
+    when EVENT_TYPE::GOAL
+      puts "Goal: #{data}"
+    when EVENT_TYPE::ERROR
+      puts "Error: #{data}"
+    when EVENT_TYPE::PUBLISH
+      puts "Publish: #{data}"
+    when EVENT_TYPE::READY
+      puts "Ready: #{data}"
+    when EVENT_TYPE::REFRESH
+      puts "Refresh: #{data}"
+    when EVENT_TYPE::CLOSE
+      puts "Close"
+    end
+  end
+end
+
+Absmartly.configure_client do |config|
+  config.endpoint = "https://your-company.absmartly.io/v1"
+  config.api_key = "YOUR-API-KEY"
+  config.application = "website"
+  config.environment = "development"
+  config.event_logger = MyEventLogger.new
+end
 ```
 
 The data parameter depends on the type of event. Currently, the SDK logs the

data/absmartly.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   # 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-net_http_persistent", "~> 2.0"
   spec.add_dependency "faraday-retry", "~> 2.0"
   spec.add_dependency "murmurhash3", "~> 0.1.7"
 

data/lib/absmartly/version.rb

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

data/lib/absmartly.rb

@@ -12,7 +12,9 @@ module Absmartly
   end
 
   class << self
-    attr_accessor :endpoint, :api_key, :application, :environment
+    attr_accessor :endpoint, :api_key, :application, :environment,
+                  :connect_timeout, :connection_request_timeout, :retry_interval, :max_retries,
+                  :event_logger
 
     def configure_client
       yield self
@@ -45,12 +47,17 @@ module Absmartly
         @client_config.api_key = @api_key
         @client_config.application = @application
         @client_config.environment = @environment
+        @client_config.connect_timeout = @connect_timeout
+        @client_config.connection_request_timeout = @connection_request_timeout
+        @client_config.retry_interval = @retry_interval
+        @client_config.max_retries = @max_retries
         @client_config
       end
 
       def sdk_config
         @sdk_config = ABSmartlyConfig.create
         @sdk_config.client = Client.create(client_config)
+        @sdk_config.context_event_logger = @event_logger
         @sdk_config
       end
 

data/lib/client.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "default_http_client"
-require_relative "default_http_client_config"
 require_relative "default_context_data_deserializer"
 require_relative "default_context_event_serializer"
 
@@ -10,7 +9,7 @@ class Client
   attr_reader :data_future, :promise, :exception
 
   def self.create(config, http_client = nil)
-    Client.new(config, http_client || DefaultHttpClient.create(DefaultHttpClientConfig.create))
+    Client.new(config, http_client || DefaultHttpClient.create(config.http_client_config))
   end
 
   def initialize(config, http_client = nil)

data/lib/client_config.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "default_http_client_config"
+
 class ClientConfig
   attr_accessor :endpoint, :api_key, :environment, :application, :deserializer,
-                :serializer, :executor
+                :serializer, :executor, :connect_timeout, :connection_request_timeout,
+                :retry_interval, :max_retries
 
   def self.create
     ClientConfig.new
@@ -40,4 +43,13 @@ class ClientConfig
   def context_event_serializer=(serializer)
     @serializer = serializer
   end
+
+  def http_client_config
+    http_config = DefaultHttpClientConfig.create
+    http_config.connect_timeout = @connect_timeout unless @connect_timeout.nil?
+    http_config.connection_request_timeout = @connection_request_timeout unless @connection_request_timeout.nil?
+    http_config.retry_interval = @retry_interval unless @retry_interval.nil?
+    http_config.max_retries = @max_retries unless @max_retries.nil?
+    http_config
+  end
 end

data/lib/default_http_client.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require "faraday"
-require 'faraday/retry'
+require "faraday/net_http_persistent"
+require "faraday/retry"
 require "uri"
 require_relative "http_client"
 
@@ -22,6 +23,9 @@ class DefaultHttpClient < HttpClient
                 backoff_factor: 2
       f.options.timeout = config.connect_timeout
       f.options.open_timeout = config.connection_request_timeout
+      f.adapter :net_http_persistent, pool_size: 20 do |http|
+        http.idle_timeout = 5
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: absmartly-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0.pre.1
 platform: ruby
 authors:
 - absmartly
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement