saas_pulse-ruby 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jonah Honeyman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,76 @@
+saas\_pulse-ruby
+================
+
+A simple API wrapper for integrating your rails application with [SaaSPulse](http://www.saaspulse.com).
+
+Installation
+------------
+
+`gem install saas_pulse-ruby`
+
+Usage
+-----
+
+First, build your client with your API id:
+
+    SaasPulse.srv_id "YOUR_ID_GOES_HERE"
+
+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

data/lib/saas_pulse/adapter.rb

@@ -0,0 +1,9 @@
+module SaasPulse
+  class << self; attr_accessor :adapter end
+
+  class Adapter
+    attr_accessor :name, :hook, :action_finder
+  end
+end
+
+

data/lib/saas_pulse/adapters/base.rb

@@ -0,0 +1,41 @@
+module SaasPulse
+  module Adapters
+    module Base
+      def self.extended(base)
+        base.instance_variable_set :@__current_adapter__, SaasPulse::Adapter.new
+      end
+
+      private
+
+      def included(klass)
+        SaasPulse.adapter = adapter
+        klass.send(:include, SaasPulse::Resource) unless klass.include?(SaasPulse::Resource)
+        (@defaults || []).each do |e|
+          klass.sp_default *e
+        end
+      end
+
+      def sp_default(k, v)
+        @defaults ||= []
+        @defaults << [k,v]
+      end
+
+      def register_adapter(name)
+        adapter.name = name
+      end
+
+      def hook_method(name)
+        adapter.hook = name
+      end
+
+      def action_finder(name)
+        adapter.action_finder = name
+      end
+
+      def adapter
+        @__current_adapter__
+      end
+    end
+  end
+end
+

data/lib/saas_pulse/adapters/merb.rb

@@ -0,0 +1,15 @@
+module SaasPulse
+  module Adapters
+    module Merb
+      extend SaasPulse::Adapters::Base
+
+      register_adapter :merb
+      hook_method :after
+      action_finder :action_name
+
+      sp_default :activity, proc { action_name }
+      sp_default :module,   proc { controller_name }
+    end
+  end
+end
+

data/lib/saas_pulse/adapters/rails.rb

@@ -0,0 +1,15 @@
+module SaasPulse
+  module Adapters
+    module Rails
+      extend SaasPulse::Adapters::Base
+
+      register_adapter :rails
+      hook_method :after_filter
+      action_finder :action_name
+
+      sp_default :activity, proc { action_name }
+      sp_default :module,   proc { controller_name }
+    end
+  end
+end
+

data/lib/saas_pulse/arg_parser.rb

@@ -0,0 +1,60 @@
+module SaasPulse
+  class InvalidParamError < StandardError; end
+
+  class ArgParser
+    class <<self
+      attr_reader :named_args
+
+      def parse(args)
+        new.tap do |parser|
+          args.each do |arg, val|
+            param = registered_args[arg]
+            raise InvalidParamError, "'#{arg}' does not map to a valid param" unless param
+
+            parser[param] = val
+          end
+        end
+      end
+
+      private
+
+      def parses_arg(name, *aliases)
+        register_named_arg! name
+        attr_reader name
+
+        aliases.unshift(name).each do |argname|
+          registered_args[argname] = name
+        end
+      end
+
+      def registered_args
+        @__registered_args__ ||= {}
+      end
+
+      def register_named_arg!(name)
+        @named_args ||= []
+        @named_args << name
+      end
+    end
+
+    parses_arg :sdr_a, :a, :act, :activity
+    parses_arg :sdr_o, :o, :org, :organization
+    parses_arg :sdr_m, :m, :mod, :module
+    parses_arg :sdr_u, :u, :user
+
+    def to_params
+      ArgParser.named_args.map do |arg|
+        [arg, CGI.escape(self[arg].to_s)].join("=")
+      end.join("&")
+    end
+
+    def [](arg)
+      instance_variable_get :"@#{arg}"
+    end
+
+    def []=(arg, val)
+      instance_variable_set :"@#{arg}", val
+    end
+  end
+end
+

data/lib/saas_pulse/client.rb

@@ -0,0 +1,47 @@
+module SaasPulse
+  BASE_URI = "http://sdr.saaspulse.com/pixel.gif/?sdr_s=".freeze unless self.const_defined?(:BASE_URI)
+
+  class NoClientError < StandardError; end
+
+  class << self
+    attr_reader :client
+
+    def track(data)
+      raise NoClientError, "You must set the current client first" unless client
+      client.track(data)
+    end
+
+    def srv_id(srv_id)
+      @client = Client.new(srv_id)
+    end
+
+    def on?
+      !!@on
+    end
+
+    def on!
+      @on = true
+    end
+  end
+
+  class Client
+    def initialize(srv_id)
+      @srv_id = srv_id
+    end
+
+    def track(data={})
+      url = build_url(data)
+
+      if SaasPulse.on?
+        Thread.new {open(url)}
+      else
+        puts "[SaasPulse] Fake call to #{url}. To make a real call, run SaasPulse.on!"
+      end
+    end
+
+    def build_url(data)
+      [BASE_URI, @srv_id, "&", ArgParser.parse(data).to_params].join
+    end
+  end
+end
+

data/lib/saas_pulse/resource.rb

@@ -0,0 +1,80 @@
+module SaasPulse
+  class NoAdapterError < StandardError; end
+
+  module Resource
+    @sp_defaults = {
+      :organization => "Default Org",
+      :user => "Default User",
+      :activity => "Default Activity",
+      :module => "Default Module"
+    }
+
+    module ClassMethods
+      def sp_default(key, val)
+        raise ArgumentError, "Key #{key.inspect} is not a valid option" unless @sp_defaults.keys.member?(key)
+
+        sp_defaults[key] = val
+      end
+
+      # action<Symbol>:: Action to track
+      # opts<Hash>:: Override defaults and set conditional tracking
+      def track(action, *opts)
+        tracker = SaasPulse::Tracker.new(action, *opts)
+        sp_trackers << tracker unless sp_trackers.find {|t| t.action.to_s == action.to_s}
+      end
+
+      def sp_trackers
+        @__sp_trackers__ ||= []
+      end
+
+      private
+
+      def inherited(klass)
+        super(klass)
+        klass.instance_variable_set :@sp_defaults, @sp_defaults.dup
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+      class << base; attr_reader :sp_defaults end
+      base.instance_variable_set :@sp_defaults, @sp_defaults.dup
+      base.send(SaasPulse.adapter.hook, :sp_run)
+    end
+
+    private
+
+    def sp_run
+      raise NoAdapterError, "No adapter has been set" unless SaasPulse.adapter
+
+      tracker = self.class.sp_trackers.find do |t|
+        t.action.to_s == send(SaasPulse.adapter.action_finder).to_s
+      end
+
+      return unless tracker
+
+      if condition = tracker.opts[:if]
+        return unless instance_eval(&condition)
+      end
+
+      SaasPulse.track({
+        :o => sp_opt(tracker, :organization),
+        :a => sp_opt(tracker, :activity),
+        :m => sp_opt(tracker, :module),
+        :u => sp_opt(tracker, :user)
+      })
+    end
+
+    def sp_opt(tracker, param)
+      value = tracker.opts[param] || sp_defaults[param]
+
+      return instance_eval(&value) if Proc === value
+      value
+    end
+
+    def sp_defaults
+      self.class.sp_defaults
+    end
+  end
+end
+

data/lib/saas_pulse/tracker.rb

@@ -0,0 +1,23 @@
+module SaasPulse
+  class Tracker
+    def initialize(action, *opts)
+      @action = action
+      activity = opts.shift
+      @opts = opts.empty? ? {} : opts.shift
+
+      return unless activity
+
+      case activity
+      when String
+        @opts[:activity] = activity
+      when Hash
+        @opts = activity
+      else
+        raise ArgumentError, "activity must be a String or Hash"
+      end
+    end
+
+    attr_reader :action, :opts
+  end
+end
+

data/lib/saas_pulse/version.rb

@@ -0,0 +1,3 @@
+module SaasPulse
+  VERSION = "0.1.1" unless defined?(::SaasPulse::VERSION)
+end

data/lib/saas_pulse.rb

@@ -0,0 +1,15 @@
+lib = File.expand_path('../../lib/', __FILE__) 
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'open-uri'
+require 'cgi'
+
+require 'saas_pulse/client'
+require 'saas_pulse/arg_parser'
+require 'saas_pulse/tracker'
+require 'saas_pulse/adapter'
+require 'saas_pulse/resource'
+require 'saas_pulse/adapters/base'
+require 'saas_pulse/adapters/merb'
+require 'saas_pulse/adapters/rails'
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: saas_pulse-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- jonah honeyman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Enables easy integration of SaaSPulse tracking, with options for different ruby web frameworks
+email: 
+- jonah@honeyman.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/saas_pulse.rb
+- lib/saas_pulse/version.rb
+- lib/saas_pulse/arg_parser.rb
+- lib/saas_pulse/client.rb
+- lib/saas_pulse/resource.rb
+- lib/saas_pulse/adapters/base.rb
+- lib/saas_pulse/adapters/rails.rb
+- lib/saas_pulse/adapters/merb.rb
+- lib/saas_pulse/adapter.rb
+- lib/saas_pulse/tracker.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: https://github.com/jonuts/saas_pulse-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: saas_pulse-ruby
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: API wrapper for SaaSPulse tracking integration
+test_files: []
+