amplitude-experiment 1.0.0.beta.3 → 1.0.0.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70f2c8f1fb01b7e1de84104c7d1b875868ea11da376725b172ad062c14789746
-  data.tar.gz: 94849ff0ec78e5ceb05169594203d84d793cbd9d1455e6f60be1383a26788237
+  metadata.gz: 625ebf6baeed965a20e5b19c0b9655337523b0749edb5ca39d742c07d4421ce6
+  data.tar.gz: 83d0a1bf035e355ba94804368e44ca11efb8eb80a86288a7a8ea9d81040a30c5
 SHA512:
-  metadata.gz: 31a6213acb520c87654f4a6120b930ba6cfe17111eca31e986d7eb544aa53164e5caf2723e8f0850bf674411df76c0a5d8c5e4823c34e01af8d61f7244532c36
-  data.tar.gz: 949cffd01dc77def83fd1c64f9d323ffc34f8b2081a850f72530c6d0f19f23fcd3d73edb61b8c8b27d7f135e7bb534db8d3c3bda0e9b2418119021d22c0bd5e4
+  metadata.gz: a4fa14dff27f5b8d3126df2337169a03c931d22c431b1f30e6067086839f95eff0ac4e6d3c3fcef19bdbf224df82da57f7b7726e40f23ba9656b32996814bbc7
+  data.tar.gz: b0eb2539296c79d0d1de7c9f878a73d9f1cf93d1089da33fc73989ee29c60c5c8e811550ec4fc8d120ca2187d093db6cf0f6fbac5a03ad6d58806b3d92314681

data/README.md

@@ -33,10 +33,10 @@ require 'amplitude-experiment'
 apiKey = 'YOUR-API-KEY'
 
 # (2) Initialize the experiment client
-experiment = Experiment.init(api_key)
+experiment = AmplitudeExperiment.init(api_key)
 
 # (3) Fetch variants for a user
-user = Experiment::User.new(user_id: 'user@company.com', device_id: 'abcezas123', user_properties: {'premium' => true})
+user = AmplitudeExperiment::User.new(user_id: 'user@company.com', device_id: 'abcezas123', user_properties: {'premium' => true})
 
 # (4) Lookup a flag's variant
 # 
@@ -65,7 +65,9 @@ end
 ```
 
 ## More Information
-[Experiment Ruby SDK Docs](https://amplitude.github.io/experiment-ruby-server/)
+Please visit our :100:[Developer Center](https://www.docs.developers.amplitude.com/experiment/sdks/ruby-sdk/) for more instructions on using our the SDK.
+
+See our [Experiment Ruby SDK Docs](https://amplitude.github.io/experiment-ruby-server/) for a list and description of all available SDK methods.
 
 ## Need Help?
 If you have any problems or issues over our SDK, feel free to [create a github issue](https://github.com/amplitude/experiments-ruby-server/issues/new) or submit a request on [Amplitude Help](https://help.amplitude.com/hc/en-us/requests/new).

data/lib/amplitude-experiment.rb

@@ -1 +1,12 @@
-require 'experiment'
+require 'experiment/version'
+require 'experiment/config'
+require 'experiment/cookie'
+require 'experiment/user'
+require 'experiment/variant'
+require 'experiment/factory'
+require 'experiment/persistent_http_client'
+require 'experiment/client'
+
+# Amplitude Experiment Module
+module AmplitudeExperiment
+end

data/lib/experiment/client.rb

@@ -3,7 +3,7 @@ require 'json'
 require 'uri'
 require 'logger'
 
-module Experiment
+module AmplitudeExperiment
   # Main client for fetching variant data.
   class Client
     # Creates a new Experiment Client instance.
@@ -40,6 +40,7 @@ module Experiment
     #
     # This method will automatically retry if configured (default).
     # @param [User] user
+    # @yield [User, Hash] callback block takes user object and variants hash
     def fetch_async(user, &callback)
       Thread.new do
         variants = fetch_internal(user)
@@ -129,7 +130,7 @@ module Experiment
           # value was previously under the "key" field
           variant_value = value.fetch('key')
         end
-        variants.store(key, Variant.new(variant_value, value.fetch('payload')))
+        variants.store(key, Variant.new(variant_value, value.fetch('payload', nil)))
       end
       variants
     end
@@ -138,7 +139,7 @@ module Experiment
     # @return [User, Hash] user with library context
     def add_context(user)
       user = {} if user.nil?
-      user.library = "experiment-ruby-server/#{VERSION}" if user.library.nil?
+      user.library = "experiment-ruby-server/#{VERSION}"
       user
     end
   end

data/lib/experiment/config.rb

@@ -1,4 +1,4 @@
-module Experiment
+module AmplitudeExperiment
   # Configuration
   class Config
     # Default server url

data/lib/experiment/cookie.rb

@@ -1,6 +1,6 @@
 require 'base64'
 
-module Experiment
+module AmplitudeExperiment
   # This class provides utility functions for parsing and handling identity from Amplitude cookies.
   class AmplitudeCookie
     # Get the cookie name that Amplitude sets for the provided

data/lib/experiment/factory.rb

@@ -1,5 +1,5 @@
 # Provides factory methods for storing singleton instance of Client
-module Experiment
+module AmplitudeExperiment
   @instances = {}
   @default_instance = '$default_instance'
 

data/lib/experiment/persistent_http_client.rb

@@ -1,4 +1,4 @@
-module Experiment
+module AmplitudeExperiment
   # Persist Http Client to reuse connection and reduce IO
   class PersistentHttpClient
     DEFAULT_OPTIONS = { read_timeout: 80 }.freeze

data/lib/experiment/user.rb

@@ -1,4 +1,4 @@
-module Experiment
+module AmplitudeExperiment
   # Defines a user context for evaluation.
   # `device_id` and `user_id` are used for identity resolution.
   # All other predefined fields and user properties are used for

data/lib/experiment/variant.rb

@@ -1,4 +1,4 @@
-module Experiment
+module AmplitudeExperiment
   # Variant
   class Variant
     # The value of the variant determined by the flag configuration.

data/lib/experiment/version.rb

@@ -1,3 +1,3 @@
-module Experiment
-  VERSION = '1.0.0.beta.3'.freeze
+module AmplitudeExperiment
+  VERSION = '1.0.0.beta.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.3
+  version: 1.0.0.beta.6
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -119,7 +119,6 @@ files:
 - Gemfile
 - README.md
 - lib/amplitude-experiment.rb
-- lib/experiment.rb
 - lib/experiment/client.rb
 - lib/experiment/config.rb
 - lib/experiment/cookie.rb

data/lib/experiment.rb

@@ -1,12 +0,0 @@
-require 'experiment/version'
-require 'experiment/config'
-require 'experiment/cookie'
-require 'experiment/user'
-require 'experiment/variant'
-require 'experiment/factory'
-require 'experiment/persistent_http_client'
-require 'experiment/client'
-
-# Amplitude Experiment Module
-module Experiment
-end