[![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`

```yaml
my_experiment:
  - condition_b
  - condition_c
```

Note that this will create 3 conditions:

  1. Original condition (control condition)
  2. Condition B
  3. Condition C

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
class ApplicationController < ActionController::Base
  initialize_ab_panel!
end
```

Then track any event you want from your controller:

```ruby
class CoursesController < ApplicationController
  track_action '[visits] Booking form', { :only => :book_now,  :course => :id }

  # controller code here
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
<% if AbPanel.my_experiment.condition_b? %>
  <p>Hi there, you are in Condition B in my experiment.</p>
<% else %>
  <p>Hi there, you are either in the Original condition or in Condition C in my experiment.</p>

  <% if AbPanel.my_experiment.condition_c? %>
    <p>Ah, you're in C.</p>
  <% end %>
<% end %>
```

Or in your controller:

```ruby
case AbPanel.my_experiment.condition
when 'condition_b'
  render 'my_experiment/condition_b'
when 'condition_c'
  render 'my_experiment/condition_c'
else
  render 'index'
end
```

Make sure to check the [Example App](https://github.com/Springest/ab_panel/tree/master/example)

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request