kissable 1.0.0a1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5611d750b261b15bec5f0346201da93242760de9
-  data.tar.gz: 5ded8116d3087727da8568298be44f2ac955284c
+  metadata.gz: 66f1916ee0bfa93ae6cbd1c4e92b692eaddbd61e
+  data.tar.gz: 85a2312187c0f231fb35f5706d4069d05b7e66ff
 SHA512:
-  metadata.gz: 5a1fd37813bde009fcfec08855c54a00220685cf59603df7fc98927fd9771635de2fc0cc13096808122f0b9bb4a3a6af06ba538b4f6ddc155b61c168e835a5d4
-  data.tar.gz: 1c413d7254748ec7e94ed7260973243f171a5175cf4e34e5f6515fd8291c2cc2ec84147fb5af5dac496e997de5355040a36aaf96a62ae77d85944e115b99fd43
+  metadata.gz: b269414862c154f45ddf6126b9888441095430c1fe5f0a42b36c6a164e5837e80f92dff25a720ad5cf3555dcedebd61c4d83298e5bb8ee0779e393dcc30b495b
+  data.tar.gz: 55570ccd11791c5f87a6bb6254cbeef05b6b34c1b5d6dd82c887c20ad9eb7fa135901cec823f84fdad360f8720df9d3fda01c78d5aad778c3a180b6a9215e639

data/.gitignore

@@ -2,9 +2,11 @@
 *.rbc
 .bundle
 .config
+.vagrant
 .yardoc
 Gemfile.lock
 InstalledFiles
+Vagrantfile
 _yardoc
 coverage
 doc/

data/README.md

@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-Kissable enables you to conduct a/b tests contingent on users having cookies enabled. To conduct a test you need to have a name for a test and specify how many groups you want and the ratios of these groups.
+Kissable helps you run A/B tests by breaking up your users into test groups (e.g. Original vs. Variant). Name your test, list your test groups, and the ratio at which people should be distributed to each group. Kissable does the assignment pseudo-randomly.
+
+For anonymous users cookies must be enabled. Cookies are used to assign a user to a group and keep him there. For logged in users a unique identifier (e.g. login) is used instead for the same purpose.
 
 You instantiate the object with these items.
 
@@ -56,6 +58,14 @@ end
   ab_test.tracking_script(users_ab_group)
 ```
 
+* For logged in users, you can use some unique identifier instead.
+
+```ruby
+  ab_test = Kissable::AB.new('top-navigation test')
+  users_ab_group = ab_test.group(email)
+  # Add your custom tracking code here.
+```
+
 ### Rails
 
 ```ruby

data/lib/kissable/ab.rb

@@ -4,7 +4,7 @@ module Kissable
   class AB
     MAX_GROUP_COUNT = 4
 
-    attr_reader :groups, :ratios, :test_name
+    attr_reader :groups, :login, :ratios, :test_name
 
     def initialize(test_name, groups=nil, ratios=nil)
       @test_name = test_name
@@ -19,8 +19,10 @@ module Kissable
       validate_ratios
     end
 
-    def group(cookies)
-      @cookies = cookies
+    # Assigns a test group based on the 'abid' cookie or login (email).
+    # Takes either a cookies object (Hash-like) or login (String).
+    def group(object)
+      (object.is_a? String) ? (@login = object) : (@cookies = object)
 
       abset.each do |i, val|
         return i if val > seed
@@ -46,7 +48,14 @@ module Kissable
     end
 
     def seed
-      @seed ||= (sha ^ ab_cookie_value) % 100
+      return @seed if @seed
+
+      xor = @login ? login_sha : ab_cookie_value
+      @seed = (sha ^ xor) % 100
+    end
+
+    def login_sha
+      @login_sha = Digest::SHA1.hexdigest(login).to_i(16)
     end
 
     def abset

data/lib/kissable/version.rb

@@ -1,3 +1,3 @@
 module Kissable
-  VERSION = "1.0.0a1"
+  VERSION = "1.0.1"
 end

data/spec/kissable/ab_spec.rb

@@ -5,6 +5,7 @@ describe Kissable::AB do
   let(:groups) { nil }
   let(:ratios) { nil }
   let(:cookies) { {} }
+  let(:login) { 'jsmith@example.com' }
   let(:ab_test) { described_class.new(test_name, groups, ratios) }
 
   describe '#initialize' do
@@ -63,67 +64,84 @@ describe Kissable::AB do
   end
 
   describe '#group' do
-    let(:group) { ab_test.group(cookies) }
+    context "when using cookies" do
+      let(:group) { ab_test.group(cookies) }
 
-    it "is returns Original or Variant" do
-      expect(group).to match(/Original|Variant/)
-    end
-
-    context "when cookie exists" do
-      before :each do
-        ab_test.stub(:cookies).and_return('abid' => 1)
+      it "returns Original or Variant" do
+        expect(group).to match(/Original|Variant/)
       end
 
-      it "doesn't change the cookie" do
-        expect { group }.to_not change { ab_test.cookies }
-      end
-    end
+      context "when cookie exists" do
+        before :each do
+          ab_test.stub(:cookies).and_return('abid' => 1)
+        end
 
-    context "when cookie doesn't exist" do
-      it "sets a cookie" do
-        expect { group }.to change { ab_test.cookies }.from({})
+        it "doesn't change the cookie" do
+          expect { group }.to_not change { ab_test.cookies }
+        end
       end
 
-      describe "the cookie" do
-        let(:cookie) { ab_test.cookies['abid'] }
+      context "when cookie doesn't exist" do
+        it "sets a cookie" do
+          expect { group }.to change { ab_test.cookies }.from({})
+        end
+
+        describe "the cookie" do
+          let(:cookie) { ab_test.cookies['abid'] }
+
+          context "when the domain has been configured" do
+            let(:domain) { 'someaweseomedomain.com' }
 
-        context "when the domain has been configured" do
-          let(:domain) { 'someaweseomedomain.com' }
+            it "has the domain key set to the correct value" do
+              Kissable.configure do |config|
+                config.domain = domain
+              end
 
-          it "has the domain key set to the correct value" do
-            Kissable.configure do |config|
-              config.domain = domain
+              group
+              expect(cookie).to include(:domain => domain)
             end
+          end
+
+          context "when the domain hasn't been configured" do
+            it "doesn't include a domain key" do
+              Kissable.configure do |config|
+                config.domain = nil
+              end
 
+              group
+              expect(cookie).to_not include(:domain)
+            end
+          end
+
+          it "expires" do
             group
-            expect(cookie).to include(:domain => domain)
+            expect(cookie).to include(:expires)
           end
-        end
 
-        context "when the domain hasn't been configured" do
-          it "doesn't include a domain key" do
-            Kissable.configure do |config|
-              config.domain = nil
-            end
+          it "has a path" do
+            group
+            expect(cookie).to include(:path => "/")
+          end
 
+          it "contains a value" do
             group
-            expect(cookie).to_not include(:domain)
+            expect(cookie).to include(:value)
           end
         end
+      end
+    end
 
-        it "expires" do
-          group
-          expect(cookie).to include(:expires)
-        end
+    context "when using login" do
+      let(:group) { ab_test.group(login) }
 
-        it "has a path" do
-          group
-          expect(cookie).to include(:path => "/")
-        end
+      it "returns Original or Variant" do
+        expect(group).to match(/Original|Variant/)
+      end
 
-        it "contains a value" do
-          group
-          expect(cookie).to include(:value)
+      it "always returns the same group" do
+        10.times do
+          test_copy = described_class.new(test_name)
+          expect(test_copy.group(login)).to eq(group)
         end
       end
     end

data/spec/kissable/configuration_spec.rb

@@ -20,7 +20,7 @@ describe Kissable::Configuration do
 
   context "when Logger is written to" do
     it "doesn't have an error" do
-      expect(Kissable.configuration.logger.info("test")).to_not raise_error
+      expect { Kissable.configuration.logger.info("test") }.to_not raise_error
     end
   end
 end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: kissable
 version: !ruby/object:Gem::Version
-  version: 1.0.0a1
+  version: 1.0.1
 platform: ruby
 authors:
 - Brett Hardin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Track and identify users via cookie in order to run A/B tests.
@@ -171,10 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .hound.yml
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -201,17 +201,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Track and identify users via cookie in order to run A/B tests.