absmartly-sdk 0.1.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16d7c8f31de8bdbceddf60618c90ddfc81ab73381403d957a7bd8a3fbdb43d3a
-  data.tar.gz: 2145b7d168f0e425164e1fcccb14d3efbd1ac4d91ddc3c5ebc120fca32734cdf
+  metadata.gz: 85cc6f9a1f752cedc113e346ddd7fbbe885e18a571d94cb4696fbeb65afcfaf3
+  data.tar.gz: 7a16ba9a23c51f82030beb5cc25e0bff6da063bacdecfef24d506a843d63c29d
 SHA512:
-  metadata.gz: 840d40d52e3878321a7d08ebfe1bb38e9db8994a3296afc2d3de43383ca01b8b0cc0513a2a0e4480b679ef38a8c3edda3688bd0bbcbb7b5a82c39a7f979ba595
-  data.tar.gz: cb15ab60ca2a4cd40e736b8b69b5a32b131f9a92ac8942cb3b48d16fb20b67915636035b30dd2b8d5c7039ec787509fcd3080773aa902fe23988742cce027269
+  metadata.gz: 7ce160a8e6898a17504f4292f87443ba8c8b18c15f953464ba04e16388a98dc091c73854cebc7e18fa0d6cce02be73969a5b3979d9a2e281913ce6753e592bca
+  data.tar.gz: 6e057f2dcdaa1a7d1b5916baf6f28eaec66b8240433d6c28ea776238e87b39f179ca0084f30ed7bef1dda372d7e8dc0a42b3e5bac090ebe8ad1ad6ea1edb0cc7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    absmartly (0.1.0)
+    absmartly-sdk (1.0.5)
 
 GEM
   remote: https://rubygems.org/
@@ -78,7 +78,7 @@ PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
-  absmartly!
+  absmartly-sdk!
   arraybuffer
   byebug
   faraday

data/README.md

@@ -0,0 +1,253 @@
+# A/B Smartly SDK
+
+A/B Smartly Ruby SDK
+
+## Compatibility
+
+The A/B Smartly Ruby SDK is compatible with Ruby versions 2.7 and later.  For the best performance and code readability, Ruby 3 or later is recommended. This SDK is being constantly tested with the nightly builds of Ruby, to ensure it is compatible with the latest Ruby version.
+
+
+## Getting Started
+
+### Install the SDK
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add absmartly-sdk
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install absmartly-sdk
+
+## Import and Initialize the SDK
+
+Once the SDK is installed, it can be initialized in your project.
+
+```ruby
+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"
+end
+```
+
+**SDK Options**
+
+| 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.                                                                                                                           |
+| 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.                                                                                                                              |
+
+### 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]`.
+
+```
+Custom Event Logger Code
+```
+
+The data parameter depends on the type of event. Currently, the SDK logs the
+following events:
+
+| eventName    | when                                                    | data                                         |
+| ------------ | ------------------------------------------------------- | -------------------------------------------- |
+| `"error"`    | `Context` receives an error                             | error object thrown                          |
+| `"ready"`    | `Context` turns ready                                   | data used to initialize the context          |
+| `"refresh"`  | `Context.refresh()` method succeeds                     | data used to refresh the context             |
+| `"publish"`  | `Context.publish()` method succeeds                     | data sent to the A/B Smartly event collector |
+| `"exposure"` | `Context.treatment()` method succeeds on first exposure | exposure data enqueued for publishing        |
+| `"goal"`     | `Context.track()` method succeeds                       | goal data enqueued for publishing            |
+| `"close"` | `Context.close()` method succeeds the first time     | nil                                    |
+
+## Create a New Context Request
+
+
+```ruby
+context_config = Absmartly.create_context_config
+```
+
+**With Prefetched Data**
+
+```ruby
+client_config = ClientConfig.new(
+  endpoint: 'https://your-company.absmartly.io/v1',
+  api_key: 'YOUR-API-KEY',
+  application: 'website',
+  environment: 'development')
+
+sdk_config = ABSmartlyConfig.create
+sdk_config.client = Client.create(client_config)
+
+sdk = Absmartly.create(sdk_config)
+```
+
+**Refreshing the Context with Fresh Experiment Data**
+
+For long-running contexts, the context is usually created once when the
+application is first started. However, any experiments being tracked in your
+production code, but started after the context was created, will not be
+triggered.
+
+Alternatively, the `refresh` method can be called manually. The
+`refresh` method pulls updated experiment data from the A/B
+Smartly collector and will trigger recently started experiments when
+`treatment` is called again.
+
+**Setting Extra Units**
+
+You can add additional units to a context by calling the `set_unit()` or
+`set_units()` methods. These methods may be used, for example, when a user
+logs in to your application and you want to use the new unit type in the
+context.
+
+Please note, you cannot override an already set unit type as that would be
+a change of identity and would throw an exception. In this case, you must
+create a new context instead. The `set_unit()` and
+`set_units()` methods can be called before the context is ready.
+
+```ruby
+context_config.set_unit('session_id', 'bf06d8cb5d8137290c4abb64155584fbdb64d8')
+context_config.set_unit('user_id', '123456')
+context = Absmartly.create_context(context_config)
+```
+or 
+```ruby
+context_config.set_units(
+  session_id: 'bf06d8cb5d8137290c4abb64155584fbdb64d8',
+  user_id: '123456'
+)
+context = Absmartly.create_context(context_config)
+```
+
+## Basic Usage
+
+### Selecting A Treatment
+
+```ruby
+treatment = context.treatment('exp_test_experiment')
+
+if treatment.zero?
+  # user is in control group (variant 0)
+else
+  # user is in treatment group
+end
+```
+
+### Treatment Variables
+
+```ruby
+default_button_color_value = 'red'
+
+context.variable_value('experiment_name', default_button_color_value)
+```
+
+### Peek at Treatment Variants
+
+Although generally not recommended, it is sometimes necessary to peek at
+a treatment or variable without triggering an exposure. The A/B Smartly
+SDK provides a `peek_treatment()` method for that.
+
+```ruby
+treatment = context.peek_treatment('exp_test_experiment')
+```
+
+#### Peeking at variables
+
+```ruby
+treatment = context.peek_variable_value('exp_test_experiment')
+```
+
+### Overriding Treatment Variants
+
+During development, for example, it is useful to force a treatment for an
+experiment. This can be achieved with the `set_override()` and/or `set_overrides()`
+methods. These methods can be called before the context is ready.
+
+```ruby
+context.set_override("exp_test_experiment", 1) # force variant 1 of treatment
+
+context.set_overrides(
+    'exp_test_experiment' => 1,
+    'exp_another_experiment' => 0,
+)
+```
+
+## Advanced
+
+### Context Attributes
+
+Attributes are used to pass meta-data about the user and/or the request.
+They can be used later in the Web Console to create segments or audiences.
+They can be set using the `set_attribute()` or `set_attributes()`
+methods, before or after the context is ready.
+
+```ruby
+context.set_attribute('session_id', session_id)
+context.set_attributes(
+    'customer_age' => 'new_customer'
+)
+```
+
+### Custom Assignments
+
+Sometimes it may be necessary to override the automatic selection of a
+variant. For example, if you wish to have your variant chosen based on
+data from an API call. This can be accomplished using the
+`set_custom_assignment()` method.
+
+```ruby
+chosen_variant = 1
+context.set_custom_assignment('experiment_name', chosen_variant)
+```
+
+If you are running multiple experiments and need to choose different
+custom assignments for each one, you can do so using the
+`set_custom_assignments()` method.
+
+```ruby
+assignments = [
+    'experiment_name' => 1,
+    'another_experiment_name' => 0,
+    'a_third_experiment_name' => 2
+]
+
+context.set_custom_assignments(assignments)  
+```
+
+### Publish
+
+Sometimes it is necessary to ensure all events have been published to the
+A/B Smartly collector, before proceeding. You can explicitly call the
+`publish()` methods.
+
+```
+context.publish
+```
+
+### Finalize
+
+The `close()` method will ensure all events have been
+published to the A/B Smartly collector, like `publish()`, and will also
+"seal" the context, throwing an error if any method that could generate
+an event is called.
+
+```
+context.close
+```
+
+### Tracking Goals
+
+```ruby
+context.track(
+    'payment',
+    { item_count: 1, total_amount: 1999.99 }
+)
+```

data/absmartly.gemspec

@@ -0,0 +1,40 @@
+# 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"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/example/example.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../lib/absmartly"
 
 # config file
@@ -25,7 +27,7 @@ treatment3 = ctx.treatment("test")
 puts(treatment3) # 1
 
 ctx.set_unit("db_user_id", 1000013)
-ctx.set_units(db_user_id2: 1000013, session_id: 12311)
+ctx.set_units(db_user_id2: 1000013, session_id2: 12311)
 
 ctx.set_attribute("user_agent", "Chrome 2022")
 ctx.set_attributes(

data/lib/a_b_smartly.rb

@@ -58,7 +58,7 @@ class ABSmartly
 
   def create_context(config)
     validate_params(config)
-    Context.create(get_utc_format, config, @scheduler, @context_data_provider.context_data,
+    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

data/lib/absmartly/version.rb

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

data/lib/context.rb

@@ -2,6 +2,7 @@
 
 require_relative "hashing"
 require_relative "variant_assigner"
+require_relative "context_event_logger"
 require_relative "json/unit"
 require_relative "json/attribute"
 require_relative "json/exposure"
@@ -11,13 +12,13 @@ require_relative "json/goal_achievement"
 class Context
   attr_reader :data, :pending_count
 
-  def self.create(clock, config, scheduler, data_future, data_provider,
+  def self.create(clock, config, data_future, data_provider,
                   event_handler, event_logger, variable_parser, audience_matcher)
-    Context.new(clock, config, scheduler, data_future, data_provider,
+    Context.new(clock, config, data_future, data_provider,
                 event_handler, event_logger, variable_parser, audience_matcher)
   end
 
-  def initialize(clock, config, scheduler, data_future, data_provider,
+  def initialize(clock, config, data_future, data_provider,
                  event_handler, event_logger, variable_parser, audience_matcher)
     @index = []
     @achievements = []
@@ -31,7 +32,6 @@ class Context
     @data_provider = data_provider
     @variable_parser = variable_parser
     @audience_matcher = audience_matcher
-    @scheduler = scheduler
     @closed = false
 
     @units = {}
@@ -49,8 +49,10 @@ class Context
     set_custom_assignments(config.custom_assignments) if config.custom_assignments
     if data_future.success?
       assign_data(data_future.data_future)
+      log_event(ContextEventLogger::EVENT_TYPE::READY, data_future.data_future)
     else
       set_data_failed(data_future.exception)
+      log_error(data_future.exception)
     end
   end
 
@@ -157,11 +159,11 @@ class Context
       assignment.exposed = true
 
       exposure = Exposure.new
-      exposure.id = assignment.id
+      exposure.id = assignment.id || 0
       exposure.name = assignment.name
       exposure.unit = assignment.unit_type
       exposure.variant = assignment.variant
-      exposure.exposed_at = @clock
+      exposure.exposed_at = @clock.to_i
       exposure.assigned = assignment.assigned
       exposure.eligible = assignment.eligible
       exposure.overridden = assignment.overridden
@@ -171,6 +173,7 @@ class Context
 
       @pending_count += 1
       @exposures.push(exposure)
+      log_event(ContextEventLogger::EVENT_TYPE::EXPOSURE, exposure)
     end
   end
 
@@ -221,6 +224,7 @@ class Context
 
     @pending_count += 1
     @achievements.push(achievement)
+    log_event(ContextEventLogger::EVENT_TYPE::GOAL, achievement)
   end
 
   def publish
@@ -236,8 +240,10 @@ class Context
       data_future = @data_provider.context_data
       if data_future.success?
         assign_data(data_future.data_future)
+        log_event(ContextEventLogger::EVENT_TYPE::REFRESH, data_future.data_future)
       else
         set_data_failed(data_future.exception)
+        log_error(data_future.exception)
       end
     end
   end
@@ -248,6 +254,7 @@ class Context
         flush
       end
       @closed = true
+      log_event(ContextEventLogger::EVENT_TYPE::CLOSE, nil)
     end
   end
 
@@ -282,18 +289,20 @@ class Context
             event.hashed = true
             event.published_at = @clock.to_i
             event.units = @units.map do |key, value|
-              Unit.new(key, unit_hash(key, value))
+              Unit.new(key.to_s, unit_hash(key, value))
             end
-            event.attributes = @attributes.empty? ? nil : @attributes
             event.exposures = exposures
-            event.goals = achievements
-            return @event_handler.publish(self, event)
+            event.attributes = @attributes unless @attributes.empty?
+            event.goals = achievements unless achievements.nil?
+            log_event(ContextEventLogger::EVENT_TYPE::PUBLISH, event)
+            @event_handler.publish(self, event)
           end
         end
       else
         @exposures = []
         @achievements = []
         @pending_count = 0
+        @data_failed
       end
     end
 
@@ -365,7 +374,7 @@ class Context
               hash
             end
             match = @audience_matcher.evaluate(experiment.data.audience, attrs)
-            if match.nil? || !match.result
+            if match && !match.result
               assignment.audience_mismatch = true
             end
           end
@@ -471,6 +480,18 @@ class Context
       @failed = true
     end
 
+    def log_event(event, data)
+      unless @event_logger.nil?
+        @event_logger.handle_event(event, data)
+      end
+    end
+
+    def log_error(error)
+      unless @event_logger.nil?
+        @event_logger.handle_event(ContextEventLogger::EVENT_TYPE::ERROR, error.message)
+      end
+    end
+
     attr_accessor :clock,
                   :publish_delay,
                   :event_handler,
@@ -478,7 +499,6 @@ class Context
                   :data_provider,
                   :variable_parser,
                   :audience_matcher,
-                  :scheduler,
                   :units,
                   :failed,
                   :data_lock,

data/lib/context_config.rb

@@ -67,4 +67,12 @@ class ContextConfig
   def custom_assignment(experiment_name)
     @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/context_event_logger.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
 class ContextEventLogger
-  EVENT_TYPE = %w[error ready refresh publish exposure goal close]
-  # @interface method
-  def handle_event
-    raise NotImplementedError.new("You must implement handleEvent method.")
+  module EVENT_TYPE
+    ERROR = "error"
+    READY = "ready"
+    REFRESH = "refresh"
+    PUBLISH = "publish"
+    EXPOSURE = "exposure"
+    GOAL = "goal"
+    CLOSE = "close"
+  end
+
+  def handle_event(event, data)
+    raise NotImplementedError.new("You must implement handle_event method.")
   end
 end

data/lib/context_event_logger_callback.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ContextEventLoggerCallback < ContextEventLogger
+  attr_accessor :callable
+
+  def initialize(callable)
+    @callable = callable
+  end
+
+  def handle_event(event, data)
+    @callable.call(event, data) if @callable.present?
+  end
+end

data/lib/json/exposure.rb

@@ -8,7 +8,7 @@ class Exposure
                  exposed_at = nil, assigned = nil, eligible = nil,
                  overridden = nil, full_on = nil, custom = nil,
                  audience_mismatch = nil)
-    @id = id
+    @id = id || 0
     @name = name
     @unit = unit
     @variant = variant

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: absmartly-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.5
 platform: ruby
 authors:
 - absmartly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-04 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies: []
 description: Absmartly gem
 email:
@@ -16,7 +16,7 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 files:
 - ".rspec"
 - ".rubocop.yml"
@@ -26,8 +26,9 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README
+- README.md
 - Rakefile
+- absmartly.gemspec
 - example/example.rb
 - lib/a_b_smartly.rb
 - lib/a_b_smartly_config.rb
@@ -45,6 +46,7 @@ files:
 - lib/context_data_provider.rb
 - lib/context_event_handler.rb
 - lib/context_event_logger.rb
+- lib/context_event_logger_callback.rb
 - lib/context_event_serializer.rb
 - lib/default_audience_deserializer.rb
 - lib/default_context_data_deserializer.rb
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Absmartly gem

data/README

@@ -1,180 +0,0 @@
-# A/B Smartly SDK
-
-A/B Smartly Ruby SDK
-
-## Compatibility
-
-The A/B Smartly Ruby SDK is compatible with Ruby versions 2.7 and later.  For the best performance and code readability, Ruby 3 or later is recommended. This SDK is being constantly tested with the nightly builds of Ruby, to ensure it is compatible with the latest Ruby version.
-
-## Getting Started
-
-### Install the SDK
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add absmartly
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install absmartly
-
-## Basic Usage
-
-Once the SDK is installed, it can be initialized in your project.
-
-You can create an SDK instance using the API key, application name, environment, and the endpoint URL obtained from A/B Smartly.
-
-```Ruby  
-require 'absmartly'
-
-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"
-end
-```
-#### Creating a new Context with raw promises
-
-```Ruby  
-# define a new context request
-context_config = Absmartly.create_context_config
-context_config.set_unit("session_id", "bf06d8cb5d8137290c4abb64155584fbdb64d8")
-context_config.set_unit("user_id", "123456")
-
-context = Absmartly.create_context(context_config)
-```
-
-### Selecting A Treatment
-
-```Ruby
-treatment = context.treatment('exp_test_experiment')
-
-if treatment.zero?
-  # user is in control group (variant 0)
-else
-  # user is in treatment group
-end
-```  
-
-### Treatment Variables
-
-```Ruby
-default_button_color_value = 'red'
-button_color = context.variable_value('button.color')
-```
-
-### Peek at Treatment Variants
-
-Although generally not recommended, it is sometimes necessary to peek at a treatment or variable without triggering an exposure. The A/B Smartly SDK provides a `Context.peek_treatment()` method for that.
-
-```Ruby
-treatment = context.peek_treatment('exp_test_experiment')
-
-if treatment.zero?
-  # user is in control group (variant 0)
-else
-  # user is in treatment group
-end
-```  
-
-#### Peeking at variables
-
-```Ruby  
-button_color = context.peek_variable_value('button.color', 'red')
-```  
-
-### Overriding Treatment Variants
-
-During development, for example, it is useful to force a treatment for an  
-experiment. This can be achieved with the `Context.set_override()` and/or `Context.set_overrides()`  methods. These methods can be called before the context is ready.
-
-```Ruby
-context.set_override("exp_test_experiment", 1) # force variant 1 of treatment
-
-context.set_overrides(
-    'exp_test_experiment' => 1,
-    'exp_another_experiment' => 0,
-)
-```  
-
-## Advanced
-
-### Context Attributes
-
-Attributes are used to pass meta-data about the user and/or the request.  
-They can be used later in the Web Console to create segments or audiences.  
-They can be set using the `context.set_attribute()` or `context.set_attributes()`  methods, before or after the context is ready.
-
-```Ruby
-context.set_attribute('session_id', session_id)
-context.set_attributes(
-    'customer_age' => 'new_customer'
-)
-```  
-
-### Custom Assignments
-
-Sometimes it may be necessary to override the automatic selection of a variant. For example, if you wish to have your variant chosen based on data from an API call. This can be accomplished using the `Context.set_custom_assignment()` method.
-
-```Ruby  
-chosen_variant = 1
-context.set_custom_assignment("experiment_name", chosen_variant)
-```  
-
-If you are running multiple experiments and need to choose different custom assignments for each one, you can do so using the `Context->setCustomAssignments()` method.
-
-```Ruby  
-assignments = [
-    "experiment_name" => 1,
-    "another_experiment_name" => 0,
-    "a_third_experiment_name" => 2
-]
-
-context.set_custom_assignments(assignments)  
-```
-
-### Publish
-
-Sometimes it is necessary to ensure all events have been published to the A/B Smartly collector, before proceeding. You can explicitly call the `context.publish()` method.
-
-```Ruby
-context.publish
-```  
-
-### Finalize
-
-The `close()` method will ensure all events have been published to the A/B Smartly collector, like `context.publish()`, and will also "seal" the context, throwing an error if any method that could generate an event is called.
-
-```Ruby
-context.close
-```
-
-### Tracking Goals
-
-```Ruby
-context.track(
-    'payment',
-    { item_count: 1, total_amount: 1999.99 }
-)
-```
-
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/omairazam/absmartly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/omairazam/absmartly/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Absmartly project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/omairazam/absmartly/blob/master/CODE_OF_CONDUCT.md).