easy_ab 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50e5179b65bec859cfb55ecec25e5fd7698619ff
-  data.tar.gz: a938f51b36faa0c46cf31a02d0a831ecef4e8c9e
+  metadata.gz: 1c7eddf36ea57f8a4c34fa66755ad8d93a55aeca
+  data.tar.gz: e25036d29777b725fdc401bd5315fadeee044523
 SHA512:
-  metadata.gz: aa8c33658ef5294a3de560dcffe5fb085c9746382dbd60b00e7b1f9d223f7801fc55c81372032601e7136a25946ccfbeb3428afd45ce2861c053a1b3dc347fcb
-  data.tar.gz: 87e59b21a23a6748434bc3fe288edf83aab6e2150d4323915a5286232e78b876252aecf40cf3a2c384b2f987c214e3f62a6ef53ac117e93d6bf3c06f2c94cdec
+  metadata.gz: afcc1ccfa3b319b894223e85997107dc1df50fbd2ba57fb70b7c1d0bb9d0886889c46a8e00694a4eb535923e116b1dfa2bc4564f4aa1bc7f375e120739ffc56e
+  data.tar.gz: 78e202157604d52dd71f90a3aab4905c32ab70bc4cfc4f19042568336350897c6d10138c1226df3e1c5923113ffda7d2a84a9ecf4c9e6855f84afe7f8b8ce400

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.0.3
+* Add new API `all_participated_experiments` to list current user's all participated experiments

data/README.md

@@ -2,7 +2,7 @@
 
 Easy, flexible A/B testing tool for Rails.
 
-* Design for web
+* Design for web.
 * Use your database to keep users' testing info to seamlessly handle the transition from guest to signed in user. You don't need to prepare extra stack like Redis or something else.
 * Grouping your users to your predefined variants with very easy and flexible way:
   * Random with equal weightings.
@@ -32,14 +32,7 @@ Easy, flexible A/B testing tool for Rails.
 * No DSL, just setup your rules with pure Ruby (and Rails) :)
 
 # Notice
-Easy AB is under development. Currently don't use in your production app.
-
-# Why Easy AB?
-## Comparisons
-### Split
-### Field Test
-### Flipper
-### ...
+Easy AB is under development and is in beta phase. Be sure to test before integrating with your production app.
 
 # Installation & Setup
 
@@ -128,6 +121,29 @@ Keep in mind that `ab_test()` helper always returns String. You have to handle t
 @extra_vip_duration = ab_test(:extra_vip_duration).to_i.days
 ```
 
+You can dump experiment data of current user to analytics services (Mixpanel, Google Analytics, etc.) by `all_participated_experiments`
+
+```erb
+# In your view
+<script type="text/javascript">
+  mixpanel.track("My Event", {
+    <% all_participated_experiments.each do |experiment, variant| %>
+      "<%= experiment %>": "<%= variant %>",
+    <% end %>
+  })
+</script>
+```
+
+The return format of `all_participated_experiments`
+
+```ruby
+{
+  'experiment 1' => 'variant 1',
+  'experiment 2' => 'variant 2',
+  ...
+}
+```
+
 # Others
 ## Type of experiments
 Both String and Symbol are valid when defining experiment or passing to `ab_test`.
@@ -168,4 +184,9 @@ end
 
 # In view/controller
 ab_test(:button_color).class # => String
-```
+```
+
+# Todo
+* Add comparisons with existing A/B testing gems
+* Convertion rate
+* Test code

data/easy_ab.gemspec

@@ -5,7 +5,7 @@ require 'easy_ab/version'
 Gem::Specification.new do |s|
   s.name        = 'easy_ab'
   s.version     = EasyAb::VERSION
-  s.summary     = 'Flexible A/B testing and feature toggle for Rails'
+  s.summary     = 'Easy, flexible A/B testing and feature toggle for Rails'
   s.authors     = ['Gary Chu']
   s.email       = 'icarus4.chu@gmail.com'
   s.files       = `git ls-files -z`.split("\x0").reject do |f|

data/lib/easy_ab/helpers.rb

@@ -32,7 +32,7 @@ module EasyAb
     #   'experiment 2' => 'variant 2',
     #   ...
     # }
-    def participated_experiments(options = {})
+    def all_participated_experiments(options = {})
       user_recognition = find_ab_test_user_recognition(options)
       groupings = if user_recognition[:id]
                     EasyAb::Grouping.where("user_id = ? OR cookie = ?", user_recognition[:id], user_recognition[:cookie])

data/lib/easy_ab/version.rb

@@ -1,3 +1,3 @@
 module EasyAb
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_ab
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gary Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: icarus4.chu@gmail.com
@@ -57,6 +57,6 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Flexible A/B testing and feature toggle for Rails
+summary: Easy, flexible A/B testing and feature toggle for Rails
 test_files: []
 has_rdoc: