ablab 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58f3558e8df0966c774c936d9abb1ea3ef30cb40
-  data.tar.gz: 5296df570693f9db5e472cf6b18a1be20fd5fec0
+  metadata.gz: 6b000e4eb969554a264a4abfc4293be995c35e1c
+  data.tar.gz: 6ef436d7216b99eb8b7b31b8181cbeeccf53ed8c
 SHA512:
-  metadata.gz: 9fddf7df11963b05e36359ff02659070e1211c6c1f06ecd712725dd2ac5f936a7b05e8134bb6c8981236247226b32d4598b64545fd85156f27a815f758ec27a8
-  data.tar.gz: 427443b6a68e2333f898fb916ed2ddb9f895f2f9d1ee0530f120bb5ef5e0945c363e7c68d4b947823176f5a82bdda1f1f3e730c88c55e7bdddd92f761a1a3d81
+  metadata.gz: ade19662889d8bef5926285e67a1715f586adb92ab10de8988ba367d2bc54a2145ec36f6946187b8a1f4acefdf25d4109f8beeeebc400449f9cc5b8b11fa692c
+  data.tar.gz: 56e137554415c1dfa674e6aec64cd2cd3e102fa078b5445a5c2471d9680ffa1b6c5ea5a059436cc6f69fffddc399c741716d44c24b1d5b3f4eee7a47fdc5f376

data/lib/ablab.rb

@@ -6,6 +6,9 @@ require "forwardable"
 
 module Ablab
   module ModuleMethods
+    TRACKING_EXCEPTION_HANDLER = Proc.new { |e| raise e }
+    ALLOW_TRACKING = Proc.new { true }
+
     attr_reader :experiments
 
     def setup(&block)
@@ -44,12 +47,17 @@ module Ablab
       (@callbacks ||= []) << block
     end
 
+    def allow_tracking(&block)
+      @allow_tracking = block if block_given?
+      @allow_tracking || ALLOW_TRACKING
+    end
+
     def on_tracking_exception(&block)
       @tracking_exception_handler = block
     end
 
     def tracking_exception_handler
-      @tracking_exception_handler || Proc.new { |e| raise e }
+      @tracking_exception_handler || TRACKING_EXCEPTION_HANDLER
     end
 
     def callbacks
@@ -118,21 +126,11 @@ module Ablab
     end
 
     def track_view!
-      Ablab.tracker.track_view!(experiment.name, group, session_id)
-      Thread.new do
-        perform_callbacks!(:view)
-      end
-    rescue => e
-      Ablab.tracking_exception_handler.call(e)
+      track!(:view)
     end
 
     def track_success!
-      Ablab.tracker.track_success!(experiment.name, group, session_id)
-      Thread.new do
-        perform_callbacks!(:success)
-      end
-    rescue => e
-      Ablab.tracking_exception_handler.call(e)
+      track!(:success)
     end
 
     def group
@@ -158,6 +156,8 @@ module Ablab
       Ablab.callbacks.each do |cbk|
         cbk.call(event, experiment.name, group, session_id, request)
       end
+    rescue => e
+      Ablab.tracking_exception_handler.call(e)
     end
 
     private def forced_group
@@ -170,6 +170,23 @@ module Ablab
       group = hash[experiment.name.to_s]
       group.to_sym if group && experiment.groups.map { |g| g.name.to_s }.include?(group)
     end
+
+    private def track!(event)
+      if allowed?(experiment.name, group, session_id, request)
+        method = (event == :view) ? :track_view! : :track_success!
+        Ablab.tracker.send(method, experiment.name, group, session_id)
+        Thread.new do
+          perform_callbacks!(event)
+        end
+      end
+    rescue => e
+      Ablab.tracking_exception_handler.call(e)
+    end
+
+    private def allowed?(experiment_name, group, session_id, request)
+      filter = Ablab.allow_tracking
+      filter.call(experiment_name, group, session_id, request)
+    end
   end
 
   class Group

data/lib/ablab/version.rb

@@ -1,3 +1,3 @@
 module Ablab
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

data/spec/ablab_spec.rb

@@ -69,6 +69,15 @@ describe Ablab do
     end
   end
 
+  describe ".allow_tracking" do
+    it "sets and return allow_tracking" do
+      block = Proc.new {}
+      filter = ab.allow_tracking(&block)
+      expect(filter).to eq(block)
+      expect(ab.allow_tracking).to eq(block)
+    end
+  end
+
   describe Ablab::Experiment do
     let(:experiment) do
       Ablab::Experiment.new('foo') do; end
@@ -255,7 +264,7 @@ describe Ablab do
         expect(y).to eq([:view, :foo, run.group, run.session_id, request])
       end
 
-      it "call exception handler if given" do
+      it "calls exception handler if given" do
         exception = nil
         allow(Ablab.tracker).to receive(:track_view!) { raise "Boom!" }
         allow(Ablab).to receive(:tracking_exception_handler)
@@ -263,6 +272,24 @@ describe Ablab do
         expect { run.track_view! }.to_not raise_error
         expect(exception).to be_a(StandardError)
       end
+
+      it "calls exception handler if callback fails" do
+        exception = nil
+        allow(Ablab).to receive(:callbacks) {
+          [ -> (*args) { raise "boom!" } ]
+        }
+        allow(Ablab).to receive(:tracking_exception_handler)
+          .and_return(Proc.new { |e| exception = e })
+        expect { run.track_view!.join }.to_not raise_error
+        expect(exception).to be_a(StandardError)
+      end
+
+      it "does nothing if allow_tracking returns false" do
+        allow(Ablab).to receive(:allow_tracking) { Proc.new { false } }
+        expect(Ablab.tracker).to_not receive(:track_view!)
+        expect(run).to_not receive(:perform_callbacks!)
+        run.track_view!
+      end
     end
 
     describe "#track_success!" do
@@ -286,7 +313,7 @@ describe Ablab do
         expect(y).to eq([:success, :foo, run.group, run.session_id, request])
       end
 
-      it "call exception handler if given" do
+      it "calls exception handler if given" do
         exception = nil
         allow(Ablab.tracker).to receive(:track_success!) { raise "Boom!" }
         allow(Ablab).to receive(:tracking_exception_handler)
@@ -294,6 +321,24 @@ describe Ablab do
         expect { run.track_success! }.to_not raise_error
         expect(exception).to be_a(StandardError)
       end
+
+      it "calls exception handler if callback fails" do
+        exception = nil
+        allow(Ablab).to receive(:callbacks) {
+          [ -> (*args) { raise "boom!" } ]
+        }
+        allow(Ablab).to receive(:tracking_exception_handler)
+          .and_return(Proc.new { |e| exception = e })
+        expect { run.track_success!.join }.to_not raise_error
+        expect(exception).to be_a(StandardError)
+      end
+
+      it "does nothing if allow_tracking returns false" do
+        allow(Ablab).to receive(:allow_tracking) { Proc.new { false } }
+        expect(Ablab.tracker).to_not receive(:track_success!)
+        expect(run).to_not receive(:perform_callbacks!)
+        run.track_success!
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ablab
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Luca Ongaro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails