Sorry, this project is unmaintained. Check out sourcebuster-js instead

Sourcebuster

Description

Sourcebuster tracks sources of your visitors.

It stores information about visitor's sources, handles sources overriding just like Google Analytics do and lets you store this info for further analysis.

Setup

Add these lines to your application's Gemfile:

gem 'sourcebuster', :git => "git@github.com:alexfedoseev/sourcebuster.git"

Add these lines to your application's routes.rb:

mount Sourcebuster::Engine => "/sourcebuster"

Run in your shell:

bundle install
bundle exec rake sourcebuster:install:migrations
bundle exec rake db:migrate

And now allow to setup cookies by your application's application_controller.rb:

class ApplicationController < ActionController::Base
  include Sourcebuster::CookieSettersHelper
  before_filter :set_sourcebuster_data
  helper_method :extract_sourcebuster_data

  # your code

  private

    def set_sourcebuster_data
      set_sourcebuster_cookies
    end

end

Usage

Use following method params to get sourcebuster data:

# First source type (utm / organic / referral / typein)
extract_sourcebuster_data(:sb_first, :typ)

# First utm_source
extract_sourcebuster_data(:sb_first, :src)

# First utm_medium
extract_sourcebuster_data(:sb_first, :mdm)

# First utm_campaign
extract_sourcebuster_data(:sb_first, :cmp)

# First utm_content
extract_sourcebuster_data(:sb_first, :cnt)

# First utm_term
extract_sourcebuster_data(:sb_first, :trm)


# Current source type (utm / organic / referral / typein)
extract_sourcebuster_data(:sb_current, :typ)

# Current utm_source
extract_sourcebuster_data(:sb_current, :src)

# Current utm_medium
extract_sourcebuster_data(:sb_current, :mdm)

# Current utm_campaign
extract_sourcebuster_data(:sb_current, :cmp)

# Current utm_content
extract_sourcebuster_data(:sb_current, :cnt)

# Current utm_term
extract_sourcebuster_data(:sb_current, :trm)


# Date of first visit
extract_sourcebuster_data(:sb_first_add, :fd)

# Entrance point
extract_sourcebuster_data(:sb_first_add, :ep)

# Full referer (when source override occur)
extract_sourcebuster_data(:sb_referer, :ref)

# user ip
extract_sourcebuster_data(:sb_udata, :uip)

# user agent
extract_sourcebuster_data(:sb_udata, :uag)

Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don't break it in a future version unintentionally.
• Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
• Send me a pull request. Bonus points for topic branches.

License

MIT License, see the {file:LICENSE}.