tripwire_notifier 0.1.1 → 0.2.1

data/README.rdoc

@@ -1,8 +1,8 @@
-= Tripwire::Notifier
+= TripwireNotifier
 
 Stop hurting your users!
 
-Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The Tripwire::Notifier gem makes it easy to hook up your app to the Tripwire web service.
+Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.
 
 If you haven't already signed up for a Tripwire account and set up your project, visit http://tripwireapp.com to do so now.
 
@@ -23,7 +23,9 @@ If you haven't already signed up for a Tripwire account and set up your project,
 
 * In your Rails app, create config/initializers/tripwire_notifier.rb and add the following line with the API key for your Tripwire project:
 
-    Tripwire::Notifier.api_key = "<YOUR API KEY>"
+    TripwireNotifier.configure do |config|
+      config.api_key = "<YOUR API KEY>"
+    end
 
 Your validation failures will now be tracked on your create and update actions in production mode. Feel free to start script/server in production mode and trigger some of your own.
 
@@ -32,13 +34,13 @@ Your validation failures will now be tracked on your create and update actions i
 
 === Tracking custom actions
 
-Tripwire::Notifier assumes your app is RESTful, so it only monitors the create and update actions by default. If you're creating or updating records in non-RESTful actions, you can use an after_filter to make sure any validation failures in those actions are caught as well:
+TripwireNotifier assumes your app is RESTful, so it only monitors the create and update actions by default. If you're creating or updating records in non-RESTful actions, you can use an after_filter to make sure any validation failures in those actions are caught as well:
 
     after_filter :log_validation_failures_to_tripwire, :only => [:create, :update, :my_custom_action]
 
 === Filtering params
 
-Tripwire::Notifier tracks the parameters submitted in actions that cause validation errors. Because your app may handle sensitive data, like passwords, credit card numbers, and nuclear launch codes, Tripwire::Notifier respects the built-in Rails parameter filtering that you enable with filter_parameter_logging in your ApplicationController. For example:
+TripwireNotifier tracks the parameters submitted in actions that cause validation errors. Because your app may handle sensitive data, like passwords, credit card numbers, and nuclear launch codes, TripwireNotifier respects the built-in Rails parameter filtering that you enable with filter_parameter_logging in your ApplicationController. For example:
 
     # Scrub sensitive parameters from your log
     filter_parameter_logging :password, :secret
@@ -47,9 +49,9 @@ Per the Rails standard, those params will show up as "[FILTERED]" in the data su
 
 === Running in other environments
 
-Tripwire::Notifier is only enabled in the production environment by default.  If you want to enable it in additional environments, such as staging, you'll need to add the following line to your initializer file:
+TripwireNotifier is only enabled in the production environment by default. If you want to enable it in additional environments, such as staging, you'll need to add the following line to your Tripwire initializer:
 
-    Tripwire::Notifier.monitored_environments << 'staging'
+    config.monitored_environments << 'staging'
 
 
 We plan to streamline the setup process in the future and provide additional detailed configuration options and documentation. Please feel free to contact us with feedback, questions, or suggestions about this process. Thanks!

data/Rakefile

@@ -1,12 +1,14 @@
 require 'rubygems'
 require 'rake'
+require File.dirname(__FILE__) + "/lib/tripwire_notifier/version.rb"
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
+    gem.version = TripwireNotifier::VERSION
     gem.name = "tripwire_notifier"
     gem.summary = %Q{Tripwire (http://tripwireapp.com) captures validation errors from your Ruby on Rails application.}
-    gem.description = %Q{Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The Tripwire::Notifier gem makes it easy to hook up your app to the Tripwire web service.}
+    gem.description = %Q{Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.}
     gem.email = ""
     gem.homepage = "http://github.com/jeremyw/tripwire_notifier"
     gem.authors = ["Jeffrey Chupp", "Jeremy Weiskotten"]
@@ -44,7 +46,7 @@ task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = TripwireNotifier::VERSION
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "tripwire_notifier #{version}"

data/lib/tripwire_notifier.rb

@@ -1,107 +1,20 @@
 require 'net/http'
 require 'uri'
 require 'timeout'
+require 'tripwire_notifier/version'
+require 'tripwire_notifier/configuration'
+require 'tripwire_notifier/rails/action_controller_monitor'
 
-# TODO: namespace the methods apart from log_validation_failures_to_tripwire ?
-module Tripwire
-  module Notifier
-    API_VERSION = "alpha 1"
-    API_URL     = 'http://api.tripwireapp.com/'
+module TripwireNotifier
+  API_VERSION = "alpha 1"
+  API_URL     = 'http://api.tripwireapp.com/'
 
-    class << self
-      attr_accessor :api_key, :monitored_environments, :timeout_in_seconds
-    end
-
-    def self.included(base)
-      # set our defaults
-      self.monitored_environments = ['production']
-      self.timeout_in_seconds     = 5
-
-      base.after_filter :log_validation_failures_to_tripwire, :only => [:create, :update]
-    end
-
-    def log_validation_failures_to_tripwire
-      if should_log_failures_to_tripwire? && records_with_errors.present?
-        begin
-          timeout(Tripwire::Notifier.timeout_in_seconds) do
-            Net::HTTP.post_form(
-              URI.parse(API_URL),
-              tripwire_params
-            )
-          end
-        rescue Exception => ex
-          warn "Could not submit tripwireapp notification: #{ex.class} - #{ex.message}" unless Rails.env.production?
-        end
-      end
-    end
-
-    private
-
-    def should_log_failures_to_tripwire?
-      Tripwire::Notifier.monitored_environments.include?(Rails.env.to_s)
-    end
-
-    def records_with_errors
-      @records_with_errors ||= begin
-        instance_variable_names.map do |var_name|
-          var = instance_variable_get(var_name)
-          if var.is_a?(Array)
-            var.select{|v| record_has_errors?(v)}
-          else
-            var if record_has_errors?(var)
-          end
-        end.flatten.compact
-      end
-    end
-
-    def record_has_errors?(record)
-      record.respond_to?(:errors) && record.errors.present?
-    end
-
-    # TODO: remove assumptions about being called within a rails app (request, etc.) as part of framework agnosticism
-    def tripwire_params
-      # TODO: limit this in size - how big?
-      data = {:params => filtered_params} # TODO: this is going to make controller and action redundant
-
-      data.merge!(:current_user => current_user) if respond_to?(:current_user)
-      data.merge!(
-        :user_agent => request.user_agent,
-        :cookies    => request.cookies,
-        :session    => request.session
-      )
+  class << self
+    attr_accessor :configuration
 
-      query = {
-        :api_key     => Tripwire::Notifier.api_key,
-        :api_version => Tripwire::Notifier::API_VERSION,
-        :_controller => params['controller'],
-        :_action     => params['action'],
-        :path        => request.path,
-        :data        => data.to_json
-      }
-
-      query[:failures] = records_with_errors.map do |record|
-        record.errors.map do |field, messages|
-          Array(messages).map do |message|
-            {
-              :model   => record.class.to_s,
-              :field   => field,
-              :message => message
-            }
-          end
-        end
-      end.flatten.to_json
-
-      query
-    end
-
-    def filtered_params
-      if respond_to?(:filter_parameters)
-        filter_parameters(params)
-      else
-        params
-      end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
     end
   end
 end
-
-ActionController::Base.send(:include, Tripwire::Notifier)

data/lib/tripwire_notifier/configuration.rb

@@ -0,0 +1,14 @@
+module TripwireNotifier
+  class Configuration
+    attr_accessor :notifier_version
+    attr_accessor :api_key
+    attr_accessor :monitored_environments
+    attr_accessor :timeout_in_seconds
+
+    def initialize
+      @notifier_version = VERSION
+      @timeout_in_seconds = 5
+      @monitored_environments = ['production']
+    end
+  end
+end

data/lib/tripwire_notifier/rails/action_controller_monitor.rb

@@ -0,0 +1,110 @@
+module TripwireNotifier
+  module Rails
+    # This module is mixed into ActionController::Base.
+    module ActionControllerMonitor
+
+      def self.included(base)
+        base.after_filter :log_validation_failures_to_tripwire, :only => [:create, :update]
+      end
+
+      protected
+
+      def log_validation_failures_to_tripwire
+        if should_log_failures_to_tripwire? && records_with_errors.present?
+          begin
+            timeout(TripwireNotifier.configuration.timeout_in_seconds) do
+              Net::HTTP.post_form(
+                URI.parse(TripwireNotifier::API_URL),
+                tripwire_params
+              )
+            end
+          rescue Exception => ex
+            error "Could not submit tripwireapp notification: #{ex.class} - #{ex.message}"
+          end
+        end
+      end
+
+      def should_log_failures_to_tripwire?
+        TripwireNotifier.configuration.monitored_environments.include?(::Rails.env.to_s)
+      end
+
+      def records_with_errors
+        @records_with_errors ||= begin
+          instance_variable_names.map do |var_name|
+            var = instance_variable_get(var_name)
+            if var.is_a?(Array)
+              var.select{|v| record_has_errors?(v)}
+            else
+              var if record_has_errors?(var)
+            end
+          end.flatten.compact
+        end
+      end
+
+      def record_has_errors?(record)
+        record.respond_to?(:errors) && record.errors.present?
+      end
+
+      def tripwire_params
+        {}.tap do |query|
+          query[:notifier_version] = TripwireNotifier.configuration.notifier_version
+          query[:api_key]          = TripwireNotifier.configuration.api_key
+          query[:api_version]      = TripwireNotifier::API_VERSION
+          query[:_controller]      = params['controller']
+          query[:_action]          = params['action']
+          query[:path]             = request.path
+          query[:data]             = request_data.to_json
+
+          query[:failures] = records_with_errors.map do |record|
+            error_hashes(record)
+          end.flatten.to_json
+        end
+      end
+
+      def error_hashes(record)
+        record.errors.map do |field, messages|
+          Array.wrap(messages).map do |message|
+            error_hash(record.class, field, message)
+          end
+        end
+      end
+
+      def error_hash(clazz, field, message)
+        {
+          :model   => clazz.to_s,
+          :field   => field,
+          :message => message
+        }
+      end
+
+      def request_data
+        {}.tap do |data|
+          # TODO: limit this in size - how big?
+          data[:params] = filtered_params # TODO: controller and action are redundant
+
+          if respond_to?(:current_user) && !current_user.nil?
+            data[:current_user] = current_user.id
+          end
+
+          data[:user_agent] = request.user_agent
+          data[:cookies] = request.cookies
+          data[:session] = request.session
+        end
+      end
+
+      def filtered_params
+        if respond_to?(:filter_parameters)
+          # pre-Rails 3
+          filter_parameters(params)
+        elsif request.respond_to?(:filtered_parameters)
+          # Rails 3
+          request.filtered_parameters
+        else
+          params
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.send(:include, TripwireNotifier::Rails::ActionControllerMonitor)

data/lib/tripwire_notifier/version.rb

@@ -0,0 +1,3 @@
+module TripwireNotifier
+  VERSION = '0.2.1'
+end

data/test/helper.rb

@@ -18,9 +18,16 @@ class FooController < ActionController::Base
   filter_parameter_logging :password
 end
 
+class User
+  attr_accessor :id
+  def initialize
+    @id = 53077
+  end
+end
+
 class BarController < ActionController::Base
   def current_user
-    "joe"
+    User.new
   end
 end
 

data/test/test_tripwire.rb

@@ -17,9 +17,12 @@ class TestTripwire < Test::Unit::TestCase
 
     @foo_controller = fake_controller(FooController)
 
-    FakeWeb.register_uri(:post, Tripwire::Notifier::API_URL, :body => "")
-    Tripwire::Notifier.api_key = "SOME API KEY"
-    Tripwire::Notifier.monitored_environments = ['production']
+    FakeWeb.register_uri(:post, TripwireNotifier::API_URL, :body => "")
+
+    TripwireNotifier.configure do |config|
+      config.api_key = "SOME API KEY"
+      config.monitored_environments = ['production']
+    end
 
     @model_one   = OpenStruct.new(:errors => {"bar" => "is blank"})
     @model_two   = OpenStruct.new(:errors => {"baz" => "is blank"})
@@ -33,27 +36,26 @@ class TestTripwire < Test::Unit::TestCase
   end
 
   should "set an api key" do
-    Tripwire::Notifier.api_key = "Foo"
-
-    assert_equal "Foo", Tripwire::Notifier.api_key
+    TripwireNotifier.configure { |c| c.api_key = "Foo" }
+    assert_equal "Foo", TripwireNotifier.configuration.api_key
   end
 
   should "set a timeout_in_seconds" do
-    assert_equal 5, Tripwire::Notifier.timeout_in_seconds
-    Tripwire::Notifier.timeout_in_seconds = 6
-    assert_equal 6, Tripwire::Notifier.timeout_in_seconds
+    assert_equal 5, TripwireNotifier.configuration.timeout_in_seconds
+    TripwireNotifier.configure { |c| c.timeout_in_seconds = 6 }
+    assert_equal 6, TripwireNotifier.configuration.timeout_in_seconds
   end
 
   should "set monitored environments" do
-    assert_equal ["production"], Tripwire::Notifier.monitored_environments
-    Tripwire::Notifier.monitored_environments = ['stage', 'development']
-    assert_equal ['stage', 'development'], Tripwire::Notifier.monitored_environments
+    assert_equal ["production"], TripwireNotifier.configuration.monitored_environments
+    TripwireNotifier.configure { |c| c.monitored_environments = ['stage', 'development'] }
+    assert_equal ['stage', 'development'], TripwireNotifier.configuration.monitored_environments
   end
 
   should "respect monitored environments" do
     assert @foo_controller.send(:should_log_failures_to_tripwire?)
 
-    Tripwire::Notifier.monitored_environments = ['stage', 'development']
+    TripwireNotifier.configuration.monitored_environments = ['stage', 'development']
     assert !@foo_controller.send(:should_log_failures_to_tripwire?)
   end
 
@@ -77,12 +79,12 @@ class TestTripwire < Test::Unit::TestCase
     params = @foo_controller.send(:tripwire_params)
     failures = JSON.parse(params[:failures])
     assert_same_elements expected, failures
-    assert_same_elements Tripwire::Notifier::API_VERSION, params[:api_version]
+    assert_same_elements TripwireNotifier::API_VERSION, params[:api_version]
     assert_same_elements "SOME API KEY", params[:api_key]
   end
 
   should "submit errors via log_validation_failures_to_tripwire" do
-    Net::HTTP.expects(:post_form).with(URI.parse(Tripwire::Notifier::API_URL), @foo_controller.send(:tripwire_params))
+    Net::HTTP.expects(:post_form).with(URI.parse(TripwireNotifier::API_URL), @foo_controller.send(:tripwire_params))
     @foo_controller.send(:log_validation_failures_to_tripwire)
   end
 
@@ -101,9 +103,9 @@ class TestTripwire < Test::Unit::TestCase
     assert_equal @foo_controller.params.merge('password' => "[FILTERED]", 'password_confirmation' => '[FILTERED]'), JSON.parse(@foo_controller.send(:tripwire_params)[:data])['params']
   end
 
-  should "log current user if the method is exposed" do
+  should "log current user's id if the method is exposed" do
     assert_equal nil, JSON.parse(@foo_controller.send(:tripwire_params)[:data])['current_user']
-    assert_equal "joe", JSON.parse(fake_controller(BarController).send(:tripwire_params)[:data])['current_user']
+    assert_equal 53077, JSON.parse(fake_controller(BarController).send(:tripwire_params)[:data])['current_user']
   end
 
   [:cookies, :session, :user_agent].each do |kind|

data/tripwire_notifier.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tripwire_notifier}
-  s.version = "0.1.1"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeffrey Chupp", "Jeremy Weiskotten"]
-  s.date = %q{2010-07-12}
-  s.description = %q{Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The Tripwire::Notifier gem makes it easy to hook up your app to the Tripwire web service.}
+  s.date = %q{2010-08-19}
+  s.description = %q{Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.}
   s.email = %q{}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,8 +22,10 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.rdoc",
      "Rakefile",
-     "VERSION",
      "lib/tripwire_notifier.rb",
+     "lib/tripwire_notifier/configuration.rb",
+     "lib/tripwire_notifier/rails/action_controller_monitor.rb",
+     "lib/tripwire_notifier/version.rb",
      "test/helper.rb",
      "test/test_tripwire.rb",
      "tripwire_notifier.gemspec"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tripwire_notifier
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 21
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 1
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jeffrey Chupp
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-12 00:00:00 -04:00
+date: 2010-08-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
-description: Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The Tripwire::Notifier gem makes it easy to hook up your app to the Tripwire web service.
+description: Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.
 email: ""
 executables: []
 
@@ -48,8 +48,10 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/tripwire_notifier.rb
+- lib/tripwire_notifier/configuration.rb
+- lib/tripwire_notifier/rails/action_controller_monitor.rb
+- lib/tripwire_notifier/version.rb
 - test/helper.rb
 - test/test_tripwire.rb
 - tripwire_notifier.gemspec

data/VERSION

@@ -1 +0,0 @@
-0.1.1