saas_pulse-ruby

A simple API wrapper for integrating your rails application with SaaSPulse.

Installation

gem install saas_pulse-ruby

Usage

First, build your client with your API id:

SaasPulse.srv_id "YOUR_ID_GOES_HERE"

You must turn the tracker on - otherwise the url will be printed to stdout and no call will be performed.

SaasPulse.on!

You will probably only want to do this in production mode.

You can then interact with SaasPulse.client to do your bidding:

SaasPulse.client.track({
  :organization => "Current organization",
  :user => "Current user",
  :activity => "Current activity",
  :module => "Current module"
})

There is also the option for integration with different ruby frameworks.

Rails

class ApplicationController < ActionController::Base
  include SaasPulse::Adapters::Rails

  #...
end

That will build your tracking code based around a couple of sane defaults. By default it will set the current module to params[:controller] and activity to params[:action]. If you wish to override the defaults you can do so in your controllers:

class MyController < ApplictationController
  sp_default :activity, "Whatever you want here"
  # You may also send a Proc object as the value so that it is
  # evaluated in the context of the current controller. For example:
  sp_default :user, proc { method_to_determine_current_user }
end

To track different actions, you must now tell SaasPulse which actions you would like to track:

class MyController < ApplictationController
  track :index
  track :show, "Override default activity text here"
  track :edit, :user => "override other defaults in a hash"
  track :destroy, :if => proc { params[:my_boolean] } # Use conditionals to only run tracking based on the eval'd code in the Proc object
end

Rolling your own adapter

There are currently adapters for rails and merb, but it is simple to write your own adapter

module MySPAdapter
  extend SaasPulse::Adapters::Base

  register_adapter :my_adapter
  hook_method :before_hook      # Hook method name that will be called before or after each action
  action_finder :action_name    # Method that determines the current action being hit

  # You can set defaults from here that will be set on the controller class
  # that includes your adapter and all of its subclasses
  sp_default :activity, proc {action_name}
  sp_default :module, proc {controller_name}
end

TODO

• Adapter tests
• JS client integration