ab_panel 0.3.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe1dec59d88584288c8ada336cae1788b0fd0543
-  data.tar.gz: d212f5ecd9685c359720bf935750582fe6036be9
+SHA256:
+  metadata.gz: 37ee0a4c2ef876a4211289f684ba7db3d620d34bfdd2a54081bbc92c0b94240b
+  data.tar.gz: 47f71b412b1021c6b3f7034e209f4c80a490950b1ce1b92e68070b1d12ae84d8
 SHA512:
-  metadata.gz: 980f2a2130011fce8dd78002f15546d701ddf15de16477588aeba852b140431e4931854d63ac660443757358d8b4fb38c74a094beb715583debf1bebde515fc3
-  data.tar.gz: 582ef9a3270130ad244b76137225cf0df80b88154f00a2e20a4cee68706a924ada234619ddb8928ba8a20f946ccf505d32a1eab15890530ed9128cda6a37a854
+  metadata.gz: becb21058455ab271a01771df8643c0002141d0f8836ae77503f516aaaeee2f187cc7d6965c6207cee572ef54413a186e230c6bc64fb72f1f89f0c7a0051fde6
+  data.tar.gz: cbb3437fd90843d080251acf50302be43abd2f12403129442f5d1c439789bdcf8061cd9861327b1b9c5b3df1dc0d91120fd0f9e885c4723a8b24877444d5cd31

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 script: 'bundle exec rspec spec'
 rvm:
-  - 2.1.5
+  - 2.1.7

data/ab_panel.gemspec

@@ -6,10 +6,9 @@ require 'ab_panel/version'
 Gem::Specification.new do |spec|
   spec.name          = "ab_panel"
   spec.version       = AbPanel::VERSION
-  spec.authors       = ["Wouter de Vos", "Mark Mulder", "Peter de Ruijter"]
-  spec.email         = ["wouter@springest.com", "markmulder@gmail.com", "hello@thisiswho.im"]
-  spec.description   = %q{Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.}
-  spec.summary       = %q{Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.}
+  spec.authors       = ["Dennis Paagman", "Eugene Pimenov", "Jordy van Gelder", "Mark Mulder", "Peter de Ruijter", "Tim Flapper", "Wouter de Vos"]
+  spec.description   = %q{Run A/B test experiments on your Rails 4+ site using Mixpanel as a backend.}
+  spec.summary       = %q{Run A/B test experiments on your Rails 4+ site using Mixpanel as a backend.}
   spec.homepage      = "https://github.com/Springest/ab_panel"
   spec.license       = "MIT"
 
@@ -19,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rails", '~> 3.2'
   spec.add_development_dependency "rake"
   spec.add_development_dependency "fakeweb"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "byebug"
 
+  spec.add_runtime_dependency "rails", '>= 4.0'
   spec.add_runtime_dependency "mixpanel"
 end

data/lib/ab_panel.rb

@@ -22,6 +22,16 @@ module AbPanel
       Thread.current[:ab_panel_conditions] ||= assign_conditions!
     end
 
+    def serialized_conditions
+      cs = {}
+
+      conditions.each_pair do |key, value|
+        cs[key] = value.marshal_dump
+      end
+
+      cs.to_json
+    end
+
     # Set the experiment's conditions.
     #
     # This is used to persist conditions from
@@ -74,11 +84,30 @@ module AbPanel
       funnels.add(funnel) if funnel.present?
     end
 
+    def environment
+      props = { distinct_id: self.env["distinct_id"] }
+      props.merge!(self.properties) if self.properties
+
+      self.funnels.each { |f| props["funnel_#{f}"] = true }
+
+      self.experiments.each { |exp| props[exp] = self.conditions.send(exp).condition }
+
+      props
+    end
+
     private # ----------------------------------------------------------------------------
 
     def assign_conditions!(already_assigned=nil)
       cs = {}
 
+      if already_assigned
+        already_assigned.each do |key, value|
+          already_assigned[key] = OpenStruct.new(already_assigned[key])
+        end
+      end
+
+      already_assigned = OpenStruct.new already_assigned
+
       experiments.each do |experiment|
         cs[experiment] ||= {}
 

data/lib/ab_panel/controller_additions.rb

@@ -27,8 +27,20 @@ module AbPanel
     #
     #   `current_user.id` for logged in users.
     def distinct_id
-      cookies.signed['distinct_id'] ||=
-        (0..4).map { |i| i.even? ? ('A'..'Z').to_a[rand(26)] : rand(10) }.join
+      distinct_id = cookies.signed['distinct_id']
+
+      return distinct_id if distinct_id
+
+      distinct_id = (0..4).map { |i| i.even? ? ('A'..'Z').to_a[rand(26)] : rand(10) }.join
+
+      cookies.signed['distinct_id'] =
+        {
+          value: distinct_id,
+          httponly: true,
+          secure: request.ssl?
+        }
+
+      distinct_id
     end
 
     def ab_panel_options
@@ -48,10 +60,27 @@ module AbPanel
     # in the user's session.
     def initialize_ab_panel!(options = {})
       AbPanel.reset!
-      AbPanel.conditions = cookies.signed['ab_panel_conditions']
-      cookies.signed['ab_panel_conditions'] = AbPanel.conditions
-      AbPanel.funnels = cookies.signed['ab_panel_funnels']
-      cookies.signed['ab_panel_funnels'] = AbPanel.funnels
+
+
+      AbPanel.conditions =
+        if cookies.signed[:ab_panel_conditions]
+          JSON.parse(cookies.signed[:ab_panel_conditions])
+        else
+          nil
+        end
+
+      cookies.signed[:ab_panel_conditions] = {
+        value: AbPanel.serialized_conditions,
+        httponly: true,
+        secure: request.ssl?
+      }
+
+      AbPanel.funnels = Set.new(cookies.signed[:ab_panel_funnels])
+      cookies.signed[:ab_panel_funnels] = {
+        value: AbPanel.funnels,
+        httponly: true,
+        secure: request.ssl?
+      }
 
       {
         'distinct_id' => distinct_id,
@@ -80,7 +109,6 @@ module AbPanel
 
       options = {
         distinct_id: distinct_id,
-        ip:          request.remote_ip,
         time:        Time.now.utc,
       }.merge(properties)
 

data/lib/ab_panel/javascript.rb

@@ -1,14 +1,8 @@
 module AbPanel
   class Javascript
     def self.environment
-      props = { distinct_id: AbPanel.env["distinct_id"] }
-      props.merge!(AbPanel.properties) if AbPanel.properties
-
-      AbPanel.funnels.each { |f| props["funnel_#{f}"] = true }
-
-      AbPanel.experiments.each { |exp| props[exp] = AbPanel.conditions.send(exp).condition }
-
-      props.to_json
+      AbPanel.environment.to_json
     end
+
   end
 end

data/lib/ab_panel/version.rb

@@ -1,3 +1,3 @@
 module AbPanel
-  VERSION = "0.3.3"
+  VERSION = "0.4.4"
 end

data/spec/ab_panel/config_spec.rb

@@ -4,32 +4,32 @@ describe AbPanel::Config do
   let(:config) { AbPanel::Config.new }
   context "config" do
     before do
-      AbPanel::Config.any_instance.stub(:settings) { { exp1: { scenario1: 25, scenario2: 75 } } }
+      allow_any_instance_of(AbPanel::Config).to receive(:settings) { { exp1: { scenario1: 25, scenario2: 75 } } }
     end
 
     describe '.experiments' do
       subject { config.experiments }
-      it { should =~ [:exp1] }
+      it { is_expected.to match_array [:exp1] }
     end
 
     describe '.weights' do
       subject { config.weights('exp1') }
 
-      it { should =~ [75.0, 25.0] }
+      it { is_expected.to match_array [75.0, 25.0] }
     end
   end
   context "empty config" do
     before do
-      YAML.stub(:load) { false }
+      allow(YAML).to receive(:load) { false }
     end
     describe ".settings" do
       subject { config.settings }
-      it { should eq nil }
+      it { is_expected.to eq nil }
     end
 
     describe ".experiments" do
       subject { config.experiments }
-      it { should == {} }
+      it { is_expected.to eq({}) }
     end
   end
 end

data/spec/ab_panel/controller_additions_spec.rb

@@ -13,9 +13,12 @@ describe AbPanel::ControllerAdditions do
 
   describe "#distinct_id" do
     let(:cookies) { {} }
-    before { controller.stub_chain(:cookies, :signed).and_return(cookies) }
+    before do
+      allow(controller).to receive_message_chain(:request, :ssl?).and_return(true)
+      allow(controller).to receive_message_chain(:cookies, :signed).and_return(cookies)
+    end
     subject { controller.distinct_id }
 
-    it { should match /^([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])$/ }
+    it { is_expected.to match /^([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])([A-Z]|[0-9])$/ }
   end
 end

data/spec/ab_panel/javascript_spec.rb

@@ -5,12 +5,12 @@ describe AbPanel::Javascript do
     AbPanel.set_env('distinct_id', 'distinct_id')
     AbPanel.set_env(:properties, { post_name: 'test' })
     result = JSON.parse(AbPanel::Javascript.environment)
-    result['distinct_id'].should == 'distinct_id'
+    expect(result['distinct_id']).to eq 'distinct_id'
   end
 
   it 'works without extra properties' do
     AbPanel.set_env(:properties, nil)
     result = JSON.parse(AbPanel::Javascript.environment)
-    result['distinct_id'].should == 'distinct_id'
+    expect(result['distinct_id']).to eq 'distinct_id'
   end
 end

data/spec/ab_panel_spec.rb

@@ -4,14 +4,14 @@ describe AbPanel do
   describe ".experiments" do
     subject { AbPanel.experiments }
 
-    it { should =~ %w(experiment1 experiment2).map(&:to_sym) }
+    it { is_expected.to match_array %w(experiment1 experiment2).map(&:to_sym) }
   end
 
   describe ".weights" do
     let(:experiment) { AbPanel.experiments.first }
     subject { AbPanel.weights(experiment) }
 
-    it { should == [25, 25, 25, 25] }
+    it { is_expected.to eq [25, 25, 25, 25] }
 
     describe "With a nonexistent experiment" do
       let(:experiment) { :does_not_exist }
@@ -27,7 +27,7 @@ describe AbPanel do
 
     let(:experiment) { AbPanel.experiments.first }
 
-    it { should =~ %w( scenario1 scenario2 scenario3 original ).map(&:to_sym) }
+    it { is_expected.to match_array %w( scenario1 scenario2 scenario3 original ).map(&:to_sym) }
 
     describe "With an nonexistent experiment" do
       let(:experiment) { :does_not_exist }
@@ -41,8 +41,8 @@ describe AbPanel do
   describe ".conditions" do
     subject { AbPanel.conditions.experiment1 }
 
-    it { should respond_to :scenario1? }
-    it { should respond_to :original? }
+    it { is_expected.to respond_to :scenario1? }
+    it { is_expected.to respond_to :original? }
 
     describe 'uniqueness' do
       let(:conditions) do
@@ -54,10 +54,10 @@ describe AbPanel do
         ]
       end
 
-      it { conditions.any?.should be true }
-      it { conditions.all?.should be false }
-      it { conditions.select{|c| c}.size.should be 1 }
-      it { conditions.reject{|c| c}.size.should be 3 }
+      it { expect(conditions.any?).to be true }
+      it { expect(conditions.all?).to be false }
+      it { expect(conditions.select{|c| c}.size).to be 1 }
+      it { expect(conditions.reject{|c| c}.size).to be 3 }
     end
   end
 
@@ -72,24 +72,24 @@ describe AbPanel do
 
     it 'adds a funnel' do
       AbPanel.add_funnel('search')
-      AbPanel.funnels.to_a.should == ['search']
+      expect(AbPanel.funnels.to_a).to eq ['search']
     end
 
     it 'only adds a funnel when present' do
       AbPanel.add_funnel(nil)
-      AbPanel.funnels.to_a.should == []
+      expect(AbPanel.funnels.to_a).to eq []
     end
 
     it 'does not add a funnel twice' do
       AbPanel.add_funnel('search')
       AbPanel.add_funnel('search')
-      AbPanel.funnels.to_a.should == ['search']
+      expect(AbPanel.funnels.to_a).to eq ['search']
     end
 
     it 'sets funnels' do
       funnels = Set.new ['search', 'cta']
       AbPanel.funnels = funnels
-      AbPanel.funnels.to_a.should == funnels.to_a
+      expect(AbPanel.funnels.to_a).to eq funnels.to_a
     end
   end
 

data/spec/array_spec.rb

@@ -3,47 +3,47 @@ require 'spec_helper'
 describe Array do
   describe '.weighted_sample' do
     before do
-      Kernel.stub(:rand) { 0.5 }
+      allow(Kernel).to receive(:rand) { 0.5 }
     end
 
     context "Stub test" do
       subject { Kernel.rand }
-      it { should eq 0.5 }
+      it { is_expected.to eq 0.5 }
     end
 
     let(:array) { [1, 2, 3, 4] }
     subject { array.weighted_sample }
 
-    it { should eq 3 }
+    it { is_expected.to eq 3 }
 
     context "different random" do
       before do
-        Kernel.stub(:rand) { 0 }
+        allow(Kernel).to receive(:rand) { 0 }
       end
 
-      it { should eq 1 }
+      it { is_expected.to eq 1 }
     end
 
     context "different random" do
       before do
-        Kernel.stub(:rand) { 1 }
+        allow(Kernel).to receive(:rand) { 1 }
       end
 
-      it { should eq 4 }
+      it { is_expected.to eq 4 }
     end
 
     context "with weights" do
       subject { array.weighted_sample([1, 0, 0, 0]) }
-      it { should eq 1 }
+      it { is_expected.to eq 1 }
     end
-    
+
     context "all the same weights" do
-      before { Kernel.stub(:rand) { 1 } }
+      before { allow(Kernel).to receive(:rand) { 1 } }
       subject { array.weighted_sample([0, 0, 0, 0]) }
-      it { should eq 4 }
+      it { is_expected.to eq 4 }
       context "random 0" do
-        before { Kernel.stub(:rand) { 0 } }
-        it { should eq 1 }
+        before { allow(Kernel).to receive(:rand) { 0 } }
+        it { is_expected.to eq 1 }
       end
     end
   end

data/spec/spec_helper.rb

@@ -5,4 +5,3 @@ require 'active_support/all'
 require File.join(File.dirname(__FILE__), "../lib", "ab_panel")
 
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
-

data/spec/support/rails.rb

@@ -2,7 +2,7 @@ require 'rails'
 
 RSpec.configure do |c|
   c.before do
-    Rails.stub(:root) { File.expand_path( '../files', __FILE__ ) }
-    Rails.stub(:env) { 'test' }
+    allow(Rails).to receive(:root) { File.expand_path( '../files', __FILE__ ) }
+    allow(Rails).to receive(:env) { 'test' }
   end
 end

metadata

@@ -1,16 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: ab_panel
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.4
 platform: ruby
 authors:
-- Wouter de Vos
+- Dennis Paagman
+- Eugene Pimenov
+- Jordy van Gelder
 - Mark Mulder
 - Peter de Ruijter
-autorequire: 
+- Tim Flapper
+- Wouter de Vos
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,21 +31,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -55,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mixpanel
   requirement: !ruby/object:Gem::Requirement
@@ -110,11 +114,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.
+description: Run A/B test experiments on your Rails 4+ site using Mixpanel as a backend.
 email:
-- wouter@springest.com
-- markmulder@gmail.com
-- hello@thisiswho.im
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -212,7 +213,7 @@ homepage: https://github.com/Springest/ab_panel
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -227,11 +228,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.
+summary: Run A/B test experiments on your Rails 4+ site using Mixpanel as a backend.
 test_files:
 - example/.gitignore
 - example/Gemfile