tripwire_notifier 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeffrey Chupp and Jeremy Weiskotten
+
+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.rdoc

@@ -0,0 +1,76 @@
+= Tripwire::Notifier
+
+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.
+
+If you haven't already signed up for a Tripwire account and set up your project, visit http://tripwireapp.com to do so now.
+
+
+= Basic Usage
+
+* Install the gem:
+
+    gem install tripwire_notifier
+
+* Modify your config/environment.rb file to make your app aware of the tripwire_notifier gem by adding the following line to config/environment.rb:
+
+    config.gem 'tripwire_notifier'
+
+* (Optionally) unpack the gem into your Rails app:
+
+    rake gems:unpack
+
+* 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>"
+
+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.
+
+
+= More Advanced Usage
+
+=== 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:
+
+    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:
+
+    # Scrub sensitive parameters from your log
+    filter_parameter_logging :password, :secret
+
+Per the Rails standard, those params will show up as "[FILTERED]" in the data submitted to Tripwire.
+
+=== 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:
+
+    Tripwire::Notifier.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!
+
+== Contact information
+
+* Twitter: @tripwireapp
+* Email: jeremy@tripwireapp.com, jeff@tripwireapp.com
+
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Jeffrey Chupp and Jeremy Weiskotten. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    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.email = ""
+    gem.homepage = "http://github.com/jeremyw/tripwire_notifier"
+    gem.authors = ["Jeffrey Chupp", "Jeremy Weiskotten"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tripwire_notifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/tripwire_notifier.rb

@@ -0,0 +1,107 @@
+require 'net/http'
+require 'uri'
+require 'timeout'
+
+# 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/'
+
+    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
+      )
+
+      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
+    end
+  end
+end
+
+ActionController::Base.send(:include, Tripwire::Notifier)

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'redgreen'
+require 'test/unit'
+require 'ostruct'
+require 'shoulda'
+require 'action_controller'
+require 'fakeweb'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tripwire_notifier'
+
+class Test::Unit::TestCase
+end
+
+class FooController < ActionController::Base
+  filter_parameter_logging :password
+end
+
+class BarController < ActionController::Base
+  def current_user
+    "joe"
+  end
+end
+
+class Rails
+end

data/test/test_tripwire.rb

@@ -0,0 +1,115 @@
+require 'helper'
+
+class TestTripwire < Test::Unit::TestCase
+  def fake_controller(klass)
+    fake = klass.new
+    fake.params = {'action' => "foo", 'controller' => "bar"}
+    fake.request = OpenStruct.new(
+      :user_agent => 'FooFox',
+      :cookies => {'one' => 'two', 'three' => 'four'},
+      :session => {'something' => 'ok'}
+    )
+    fake
+  end
+
+  def setup
+    Rails.stubs(:env => 'production')
+
+    @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']
+
+    @model_one   = OpenStruct.new(:errors => {"bar" => "is blank"})
+    @model_two   = OpenStruct.new(:errors => {"baz" => "is blank"})
+    @model_three = OpenStruct.new(:errors => {"f1" => "is blank","f2" => ["is too large", "is delicious"]})
+
+    @foo_controller.instance_variable_set("@lol", @model_one)
+    @foo_controller.instance_variable_set("@wtf", [@model_two, @model_three])
+
+    # we also set a non-errored model just to ensure that it is not matched
+    @foo_controller.instance_variable_set("@bbq", OpenStruct.new(:errors => []))
+  end
+
+  should "set an api key" do
+    Tripwire::Notifier.api_key = "Foo"
+
+    assert_equal "Foo", Tripwire::Notifier.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
+  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
+  end
+
+  should "respect monitored environments" do
+    assert @foo_controller.send(:should_log_failures_to_tripwire?)
+
+    Tripwire::Notifier.monitored_environments = ['stage', 'development']
+    assert !@foo_controller.send(:should_log_failures_to_tripwire?)
+  end
+
+  should "identify no errors by default" do
+    assert_equal [], FooController.new.send(:records_with_errors)
+  end
+
+  should "identify records with errors" do
+    assert_same_elements [@model_one, @model_two, @model_three], @foo_controller.send(:records_with_errors)
+  end
+
+  should "create params via tripwire_params" do
+    expected = [
+      {"model"=>"OpenStruct", "field"=>"baz", "message"=>"is blank"},
+      {"model"=>"OpenStruct", "field"=>"f1", "message"=>"is blank"},
+      {"model"=>"OpenStruct", "field"=>"f2", "message"=>"is too large"},
+      {"model"=>"OpenStruct", "field"=>"f2", "message"=>"is delicious"},
+      {"model"=>"OpenStruct", "field"=>"bar", "message"=>"is blank"}
+    ]
+
+    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 "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))
+    @foo_controller.send(:log_validation_failures_to_tripwire)
+  end
+
+  should "log controller and action" do
+    assert_equal @foo_controller.params['action'], @foo_controller.send(:tripwire_params)[:_action]
+    assert_equal @foo_controller.params['controller'], @foo_controller.send(:tripwire_params)[:_controller]
+  end
+
+  should "log params" do
+    @foo_controller.params.merge!('lolcats' => "no longer funny")
+    assert_equal @foo_controller.params, JSON.parse(@foo_controller.send(:tripwire_params)[:data])['params']
+  end
+
+  should "filter params" do
+    @foo_controller.params.merge!('password' => "do not show", 'password_confirmation' => 'rollerskates')
+    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
+    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']
+  end
+
+  [:cookies, :session, :user_agent].each do |kind|
+    should "log #{kind}" do
+      assert @foo_controller.request.send(kind).present?
+      assert_equal @foo_controller.request.send(kind), JSON.parse(fake_controller(BarController).send(:tripwire_params)[:data])[kind.to_s]
+    end
+  end
+end

data/tripwire_notifier.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tripwire_notifier}
+  s.version = "0.1.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.email = %q{}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tripwire_notifier.rb",
+     "test/helper.rb",
+     "test/test_tripwire.rb",
+     "tripwire_notifier.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jeremyw/tripwire_notifier}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Tripwire (http://tripwireapp.com) captures validation errors from your Ruby on Rails application.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_tripwire.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: tripwire_notifier
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jeffrey Chupp
+- Jeremy Weiskotten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        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.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tripwire_notifier.rb
+- test/helper.rb
+- test/test_tripwire.rb
+- tripwire_notifier.gemspec
+has_rdoc: true
+homepage: http://github.com/jeremyw/tripwire_notifier
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tripwire (http://tripwireapp.com) captures validation errors from your Ruby on Rails application.
+test_files: 
+- test/helper.rb
+- test/test_tripwire.rb