ab_panel 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,7 +1,25 @@
+[![Build Status](https://travis-ci.org/Springest/ab_panel.png?branch=master)](https://travis-ci.org/Springest/ab_panel)
+
 # AbPanel
 
 Run A/B test experiments on your Rails 3+ site using Mixpanel as a backend.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ab_panel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ab_panel
+
+## Usage
+
 Create a config file with one or more experiments and conditions.
 
 In `config/ab_panel.yml`
@@ -22,6 +40,23 @@ You can add as many experiments and conditions as you want. Every visitor
 will be assigned randomly to one condition for each scenario for as long as
 their session remains active.
 
+To track events in [Mixpanel](https://mixpanel.com), add a file called `config/mixpanel.yml` with your
+api key, api secret, and the token of of your project, like so:
+
+```yaml
+api_key: 383340bfea74ab839ebb667ab3c59fa3
+api_secret: 3990703d6d73d2b7fd78a1d19de66605
+token: 735cc06a1b1ded4827d7faff385ad6fc
+```
+
+Enable the Mixpanel Middleware by creating a file `config/initializers/mixpanel_middleware.rb`:
+
+```ruby
+Example::Application.config.middleware.use "Mixpanel::Middleware", AbPanel::Mixpanel::Config.token, persist: true
+```
+
+See [Mixpanel Gem docs](https://github.com/zevarito/mixpanel#rack-middleware) on the Middleware for more info.
+
 In your application controller:
 
 ```ruby
@@ -40,6 +75,18 @@ class CoursesController < ApplicationController
 end
 ```
 
+You can track variables from within your controller actions:
+
+```ruby
+def show
+  # A single variable
+  track_variable :id, params[:id]
+
+  # Or a hash with variables
+  track_variables params
+end
+```
+
 Use conditions based on experiments and conditions throughout your code, e.g. in your views:
 
 ```erb
@@ -67,23 +114,7 @@ else
 end
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'ab_panel'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ab_panel
-
-## Usage
-
-TODO: Write usage instructions here
+Make sure to check the [Example App](https://github.com/Springest/ab_panel/tree/master/example)
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task :default do
+  system 'bundle exec rspec spec'
+end

data/lib/ab_panel/controller_additions.rb

@@ -2,6 +2,24 @@ module AbPanel
   module ControllerAdditions
     extend ActiveSupport::Concern
 
+    # Track a single variable
+    #
+    # Example:
+    #  track_variable :name, value
+    def track_variable(name, value)
+      ab_panel_options[name.to_sym] = value
+    end
+
+    # Track multiple variables at once.
+    #
+    # Example:
+    #  track_variables { foo: 'bar', ping: 'pong'}
+    def track_variables(variables={})
+      variables.each do |key, val|
+        track_variable key, val
+      end
+    end
+
     # This sets a unique id for this user.
     #
     # You could override this in your ApplicationController to use your
@@ -29,6 +47,10 @@ module AbPanel
       }
     end
 
+    def ab_panel_options
+      @ab_panel_options ||= {}
+    end
+
     module ClassMethods
       # Initializes AbPanel's environment.
       #
@@ -99,6 +121,8 @@ module AbPanel
             end
           end
 
+          options.merge controller.ab_panel_options
+
           AbPanel.identify(controller.ab_panel_id)
           AbPanel.track name, options
 

data/lib/ab_panel/version.rb

@@ -1,3 +1,3 @@
 module AbPanel
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ab_panel
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-16 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -230,7 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4159639941527965212
+      hash: 4452037711961914346
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -239,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4159639941527965212
+      hash: 4452037711961914346
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23