amplitude-experiment 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c2b4d645d6bc1a63154135eca42b2123dbaef5fb6597e77ea3c4d602235bbe7
-  data.tar.gz: b521d6b1f7af00b62fc9ec14e8c8e1db63a63b9330e8e73139fcf09ffb5f5dca
+  metadata.gz: 5bebb227696dfbf198819fdba2640a000c67ca3a9c89d593cc03a4433ef532c8
+  data.tar.gz: fb79230b6409d82cf3d849f07cb1705abc22ae10a27e7bdfbbe6d1add1e100d0
 SHA512:
-  metadata.gz: 68d5921c26baf78c5f1dcff97e4b58124e35f5be6de93b02be240e593c12f67d32ecba973ea95cb8df66908132c280a55e94d9be2025f351c536129663359570
-  data.tar.gz: 5a66ce54c1ed89ae0bef261578ad006151c34292805aa6cf68725b7a61085089de4a96769401a52631fb2a57a759d89b0b7fe6a2e570ca25af49415badd5a1c2
+  metadata.gz: bc2885c715208465d15a6b4217e684a2caa0eb055963b1a5ff0fcdc7829239b894d685f305383cd483fff2b082592c395672c1d75140e0537543b5479e425557
+  data.tar.gz: 6d1c6b2488ddc5e28d0162e3535be65c3ed3c5767e08af71acdf7933a6f42a20c3d6994638b45713c8f9a9dd20ccfe054a9323465badff1acdd6960fb5cf9376

data/lib/experiment/remote/client.rb

@@ -19,24 +19,37 @@ module AmplitudeExperiment
                       else
                         Logger::INFO
                       end
-      endpoint = "#{@config.server_url}/sdk/vardata"
+      endpoint = "#{@config.server_url}/sdk/v2/vardata?v=0"
       @uri = URI(endpoint)
       raise ArgumentError, 'Experiment API key is empty' if @api_key.nil? || @api_key.empty?
     end
 
-    # Fetch all variants for a user synchronous.
+    # Fetch all variants for a user synchronously.
     #
     # This method will automatically retry if configured (default).
     # @param [User] user
     # @return [Hash] Variants Hash
     def fetch(user)
+      filter_default_variants(fetch_internal(user))
+    rescue StandardError => e
+      @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
+      {}
+    end
+
+    # Fetch all variants for a user synchronously.
+    #
+    # This method will automatically retry if configured (default). This function differs from fetch as it will
+    # return a default variant object if the flag was evaluated but the user was not assigned (i.e. off).
+    # @param [User] user
+    # @return [Hash] Variants Hash
+    def fetch_v2(user)
       fetch_internal(user)
     rescue StandardError => e
       @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
       {}
     end
 
-    # Fetch all variants for a user asynchronous.
+    # Fetch all variants for a user asynchronously.
     #
     # This method will automatically retry if configured (default).
     # @param [User] user
@@ -53,6 +66,24 @@ module AmplitudeExperiment
       end
     end
 
+    # Fetch all variants for a user asynchronously. This function differs from fetch as it will
+    # return a default variant object if the flag was evaluated but the user was not assigned (i.e. off).
+    #
+    # 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_v2(user, &callback)
+      Thread.new do
+        variants = fetch_internal(user)
+        yield(user, filter_default_variants(variants)) unless callback.nil?
+        variants
+      rescue StandardError => e
+        @logger.error("[Experiment] Failed to fetch variants: #{e.message}")
+        yield(user, {}) unless callback.nil?
+        {}
+      end
+    end
+
     private
 
     # @param [User] user
@@ -132,7 +163,7 @@ module AmplitudeExperiment
           # value was previously under the "key" field
           variant_value = value.fetch('key')
         end
-        variants.store(key, Variant.new(variant_value, value.fetch('payload', nil)))
+        variants.store(key, Variant.new(variant_value, value.fetch('payload', nil), value.fetch('key', nil), value.fetch('metadata', nil)))
       end
       variants
     end
@@ -150,5 +181,18 @@ module AmplitudeExperiment
 
       true
     end
+
+    def filter_default_variants(variants)
+      variants.each do |key, value|
+        default = value&.metadata&.fetch('default', nil)
+        deployed = value&.metadata&.fetch('deployed', nil)
+        default = false if default.nil?
+        deployed = true if deployed.nil?
+        variants.delete(key) if default || !deployed
+      end
+      variants
+    end
+
+    private :filter_default_variants
   end
 end

data/lib/experiment/variant.rb

@@ -1,6 +1,10 @@
 module AmplitudeExperiment
   # Variant
   class Variant
+    # The key of the variant determined by the flag configuration.
+    # @return [String] the value of variant key
+    attr_accessor :key
+
     # The value of the variant determined by the flag configuration.
     # @return [String] the value of variant value
     attr_accessor :value
@@ -9,17 +13,21 @@ module AmplitudeExperiment
     # @return [Object, nil] the value of variant payload
     attr_accessor :payload
 
+    attr_accessor :metadata
+
     # @param [String] value The value of the variant determined by the flag configuration.
     # @param [Object, nil] payload The attached payload, if any.
-    def initialize(value, payload = nil)
+    def initialize(value, payload = nil, key = nil, metadata = nil)
+      @key = key
       @value = value
       @payload = payload
+      @metadata = metadata
     end
 
     # Determine if current variant equal other variant
     # @param [Variant] other
     def ==(other)
-      value == other.value &&
+      key == other.key && value == other.value &&
         payload == other.payload
     end
   end

data/lib/experiment/version.rb

@@ -1,3 +1,3 @@
 module AmplitudeExperiment
-  VERSION = '1.2.6'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-experiment
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors:
 - Amplitude
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby