easy_ab 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a56efe571167899ce6a67e013c3815c3ac9bd8b
-  data.tar.gz: 8a3b0357ce34f6e420e7aa10276afc3a09eb1266
+  metadata.gz: 068d106a909b0229bc7fc28960f275fca34bd5e9
+  data.tar.gz: 411b8a8f520e4d4f1dd627065e1105b08175acee
 SHA512:
-  metadata.gz: 1315a89fd9ad3cb5e1fede3ab862c6608222cbe5faba02b2604a8eff3cd3b66c875a90d95ca4a89db687f56a3fb408dedbed7ee8b47c66f5915901171b02536b
-  data.tar.gz: 5e40c5b8f23e94a782e2a9b9dcb9f66711384be59b734bff18281e5adb1eeb25ca85db7dd0465d7eb36942dbb401e02be3c23eebfe18d519b0546afbca8f9ccf
+  metadata.gz: 4429ad954dcf221b315d43766c04446e72ee1bb21cef672510e1aebd17214d9224b0a20fa0af06755f52e8818c6da1f1cca317827085fe8c6b03ee956701cb8f
+  data.tar.gz: 01924f52c1e3a40dde96fcfee2bf8e5d39b79b2f16df5b8c55a4a51e71e471ae60984a2452a06a8e6b51d03654c6d1e3ee539db45a141219b91a742e0e600916

data/CHANGELOG.md

@@ -1,14 +1,17 @@
-# HEAD
-* Supports scope in config to define whether a user can join an experiment or not.
+# 0.4.0 (2017-08-16)
+- You can specify user in `ab_test()` This useful when requests do not contain current_user. A well-known example is controllers which handle payment results by listening requests from 3rd party payment gateway.
+
+# 0.3.0 (2017-08-16)
+- Supports scope in config to define whether a user can join an experiment or not.
 
 # 0.2.0 (2017-08-15)
-* **API change**: If all rules failed, `ab_test` returns nil, instead of the first variant.
+- **API change**: If all rules failed, `ab_test` returns nil, instead of the first variant.
 
 # 0.1.0
-* Support winner
+- Support winner
 
 # 0.0.3
-* Add new API `all_participated_experiments` to list current user's all participated experiments
+- Add new API `all_participated_experiments` to list current user's all participated experiments
 
 # 0.0.1
-* The first version :)
+- The first version :)

data/app/models/easy_ab/grouping.rb

@@ -5,7 +5,7 @@ module EasyAb
     validates :experiment, presence: true
     validates :variant, presence: true
     validates :user_id, uniqueness: { scope: [:experiment] }
-    validates :cookie,  uniqueness: { scope: [:experiment] }
+    validate :cookie_should_be_unique_when_user_id_is_nil
     validate :user_should_be_present
 
     private
@@ -16,5 +16,11 @@ module EasyAb
           errors.add(:cookie, "or user_id can't be blank")
         end
       end
+
+      def cookie_should_be_unique_when_user_id_is_nil
+        if user_id.nil?
+          errors.add(:cookie, "already exists") if self.class.where(cookie: cookie, user_id: nil).exists?
+        end
+      end
   end
 end

data/lib/easy_ab/experiment.rb

@@ -64,29 +64,35 @@ module EasyAb
       grouping.variant
     end
 
+    # TODO: add spec
     def find_grouping_by_user_recognition(user_recognition)
-      user_id = user_recognition[:id]
-      cookie  = user_recognition[:cookie]
+      user_id  = user_recognition[:id].presence
+      cookie   = user_recognition[:cookie].presence
+      raise 'User not found: both user_id and cookie are empty' if user_id.nil? && cookie.nil?
+
+      # Cases should take into consideration
+      # Case I: user participated experiment with login and return again
+      # Case II: user participated experiment with login and return by another device with login
+      # Case III: user participated experiment with login and return by the same device, but cookie was cleared between last and this participation
+      # => Both II and III already exist a record with the same user_id but different cookie
+      #    In the above two cases, we update the cookie of the exising record
+      #
+      # Case IV: User participated experiment without login and return with login
+      # => Assign user_id to the existing record
+      #
+      # Case V: User participated experiment without login and return without login, too
       grouping = nil
-
-      raise 'should assign a cookie' unless cookie
-
-      if user_id # If user login
-        # Case I: User participated experiment with login and return again
-        # Case II: user participated experiment with login and return by another device with login
-        # Case III: user participated experiment with login and return by the same device, but cookie was cleared between last and this participation
-        # => Both II and III already exist a record with the same user_id but different cookie
-        # In the above two cases, we update the cookie of the exising record
+      if user_id # User is signed in
+        # Case I, II, III
         return grouping if (grouping = groupings.where(user_id: user_id).first) && ((cookie && grouping.cookie = cookie) || true)
-
-        # User participated experiment without login, but this time with login => assign user_id to the existing record
-        return grouping if (grouping = groupings.where(user_id: nil, cookie: cookie).first) && grouping.user_id = user_id
-      else # If user not login
+        # Case IV
+        return grouping if (cookie && grouping = groupings.where(user_id: nil, cookie: cookie).first) && ((grouping.user_id = user_id) || true) # Assign user_id
+      elsif cookie # User is not signed in
+        # Case V
         return grouping if grouping = groupings.where(cookie: cookie).first
       end
 
-      # User have yet to participate experiment
-      nil
+      grouping
     end
 
     def groupings

data/lib/easy_ab/helpers.rb

@@ -7,7 +7,7 @@ module EasyAb
 
       if respond_to?(:request) && params[:ab_test] && params[:ab_test][experiment_name]
         # Check current user is admin or not by proc defined by gem user
-        if current_user_is_admin?
+        if easy_ab_user_is_admin?(options)
           options[:variant] ||= params[:ab_test][experiment_name]
         end
         # TODO: exclude bot
@@ -15,21 +15,23 @@ module EasyAb
 
       experiment = EasyAb::Experiment.find_by_name!(experiment_name)
 
-      # Obtain context
+      # Obtain context for rules
       if experiment.rules.present?
         @rules_with_current_context ||= experiment.rules.map { |rule| Proc.new { instance_exec(&rule)} }
         options[:contexted_rules] = @rules_with_current_context
       end
 
-      # Obtain context
+      # Obtain context for scope
       if experiment.scope.present?
         @scope ||= Proc.new { instance_exec(&experiment.scope) }
         options[:scope] = @scope
       end
 
       @variant_cache ||= {}
-      @variant_cache[experiment_name] ||= experiment.assign_variant(user_recognition, options)
-      block_given? ? yield(@variant_cache[experiment_name]) : @variant_cache[experiment_name]
+      @variant_cache[easy_ab_user_id(options)] ||= {}
+      @variant_cache[easy_ab_user_id(options)][experiment_name] ||= experiment.assign_variant(user_recognition, options)
+      variant = @variant_cache[easy_ab_user_id(options)][experiment_name]
+      block_given? ? yield(variant) : variant
     end
 
     # Return all participated experiments and the corresponding variants for current user
@@ -62,21 +64,46 @@ module EasyAb
         # TODO:
         # return (raise NotImplementedError) if options[:user] && (users << options[:user])
 
-        user_recognition[:id] = current_user_id if current_user_signed_in?
+        # if options[:user] && options[:user].id
+        #   user_recognition[:id] = options[:user].id
+        # else
+        #   user_recognition[:id] = current_user_id if current_user_signed_in?
+        # end
+
+        user_recognition[:id] = easy_ab_user_id(options)
+
         # Controllers and views
         user_recognition[:cookie] = find_or_create_easy_ab_cookie if respond_to?(:request)
 
         user_recognition
       end
 
+      def easy_ab_user_signed_in?
+        current_user_signed_in?
+      end
+
       def current_user_signed_in?
         user_signed_in_method_proc.call
       end
 
+      def easy_ab_user_id(options)
+        if options[:user]
+          options[:user].id
+        elsif easy_ab_user_signed_in?
+          current_user_id
+        else
+          nil
+        end
+      end
+
       def current_user_id
         current_user_id_proc.call
       end
 
+      def easy_ab_user_is_admin?(options)
+        options[:user] ? false : current_user_is_admin?
+      end
+
       def current_user_is_admin?
         authorize_admin_with_proc.call
       end

data/lib/easy_ab/version.rb

@@ -1,3 +1,3 @@
 module EasyAb
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_ab
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gary Chu