km_everything 0.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in km_everything.gemspec
+gemspec
+
+gem "rake"
+

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    km_everything (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.2)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  km_everything!
+  rake
+  rspec (~> 2.11)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Case Commons, LLC
+
+MIT License
+
+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,31 @@
+# km_everything
+
+Log Rails controller actions to KissMetrics
+
+## Requirements
+  * Ruby 1.9
+
+## Installation
+
+TBD
+
+## Usage
+
+In config/initializers/km\_everything\_.rb:
+
+  KmEverything.event_names = YAML.load(File.open("path/to/file.yml"))
+  KmEverything.record_every_controller_action = true
+
+In config/km\_everything\_.yml:
+
+  controller_1:
+    action_1: My Event Name for Action 1
+
+In application_controller.rb:
+
+  after_filter :queue_kissmetrics, if: :user_signed_in?
+
+  def queue_kissmetrics
+    event_name = KmEverything::KmEvent.new(controller_name, action_name).event
+    KmResque.record(current_user.id, event_name, {}) unless event_name.nil?
+  end

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/km_everything.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/km_everything/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Trace Wax", "Justin Schier", "Alex Kramer", "Case Commons LLC"]
+  gem.email         = ["gems@tracedwax.com"]
+  gem.summary       = "Log Rails controller actions to KissMetrics"
+  gem.homepage      = "https://github.com/tracedwax/km_everything"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "km_everything"
+  gem.require_paths = ["lib"]
+  gem.version       = KmEverything::VERSION
+  gem.license       = "MIT"
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.add_development_dependency 'rspec', '~> 2.11'
+end

data/lib/km_everything.rb

@@ -0,0 +1,36 @@
+module KmEverything
+  class << self
+    attr_accessor :record_every_controller_action
+    attr_accessor :event_names
+    attr_accessor :events_to_exclude
+  end
+
+  class KmEvent < Struct.new(:controller_name, :action_name)
+    def event
+      unless event_excluded?
+        specified_event || unspecified_event
+      end
+    end
+
+    private
+
+    def specified_event
+      controller_actions = KmEverything.event_names[controller_name]
+      controller_actions[action_name] if controller_actions
+    end
+
+    def unspecified_event
+      "#{controller_name}##{action_name}" if KmEverything.record_every_controller_action
+    end
+
+    def event_excluded?
+      if events_to_exclude && events_to_exclude[controller_name]
+        events_to_exclude[controller_name].include?(action_name)
+      end
+    end
+
+    def events_to_exclude
+      KmEverything.events_to_exclude
+    end
+  end
+end

data/lib/km_everything/version.rb

@@ -0,0 +1,3 @@
+module KmEverything
+  VERSION = "0.1.0"
+end

data/spec/km_everything_spec.rb

@@ -0,0 +1,105 @@
+require 'km_everything'
+
+describe KmEverything::KmEvent do
+  let(:km_event) { KmEverything::KmEvent.new(controller_name, action_name) }
+
+  describe "#event" do
+    before do
+      KmEverything.event_names = { "users" => { "show" => "Viewed User Page" } }
+    end
+
+    describe "blacklisting events" do
+      context "when using a blacklist" do
+        before do
+          KmEverything.record_every_controller_action = true
+          KmEverything.events_to_exclude = { "notifications" => ["show", "index"]  }
+        end
+
+        context "and the event is on the blacklist" do
+          let(:controller_name) {"notifications"}
+          let(:action_name) { "show"}
+
+          it "does not return the event" do
+            km_event.event.should be_nil
+          end
+        end
+
+        context "and the event is not on the blacklist" do
+          let(:controller_name) {"sessions"}
+          let(:action_name) { "create"}
+
+          it "returns the event" do
+            km_event.event.should == "sessions#create"
+          end
+        end
+
+        after do
+          KmEverything.events_to_exclude = nil
+        end
+      end
+    end
+
+    describe "whitelisting events" do
+      context "when the controller name is present" do
+        let(:controller_name) { "users" }
+
+        context "when the action name is present" do
+          let(:action_name) { "show" }
+
+          it "returns the event name" do
+            km_event.event.should == "Viewed User Page"
+          end
+        end
+
+        context "when the action name is not present" do
+          let(:action_name) { "create" }
+
+          context "when the app is configured to record all controller actions" do
+            before do
+              KmEverything.record_every_controller_action = true
+            end
+
+            it "returns the controller and action name" do
+              km_event.event.should == "users#create"
+            end
+          end
+
+          context "when the app is configured to NOT record all controller actions" do
+            before do
+              KmEverything.record_every_controller_action = false
+            end
+
+            it "does not return an event name" do
+              km_event.event.should be_nil
+            end
+          end
+        end
+      end
+
+      context "when the controller name is not present" do
+        let(:controller_name) { "some_other_controller" }
+        let(:action_name) { "some_other_action" }
+
+        context "when the app is configured to record all controller actions" do
+          before do
+            KmEverything.record_every_controller_action = true
+          end
+
+          it "returns the controller and action name" do
+            km_event.event.should == "some_other_controller#some_other_action"
+          end
+        end
+
+        context "when the app is configured to NOT record all controller actions" do
+          before do
+            KmEverything.record_every_controller_action = false
+          end
+
+          it "does not return an event name" do
+            km_event.event.should be_nil
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: km_everything
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Trace Wax
+- Justin Schier
+- Alex Kramer
+- Case Commons LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: 
+email:
+- gems@tracedwax.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- km_everything.gemspec
+- lib/km_everything.rb
+- lib/km_everything/version.rb
+- spec/km_everything_spec.rb
+homepage: https://github.com/tracedwax/km_everything
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Log Rails controller actions to KissMetrics
+test_files:
+- spec/km_everything_spec.rb
+has_rdoc: