tripwire_notifier 0.2.2 → 0.2.3

data/README.rdoc

@@ -4,33 +4,42 @@ Stop hurting your users!
 
 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.
+If you haven't already signed up for a Tripwire account, visit http://tripwireapp.com.
 
 
-= Basic Usage
+= Installation
+
+=== Rails 3
+
+* Add the following line to Gemfile:
+
+    gem 'tripwire_notifier'
 
 * Install the gem:
 
-    gem install tripwire_notifier
+    bundle install
 
-* 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:
+=== Rails 2.3
+
+* Add the following line to config/environment.rb:
 
     config.gem 'tripwire_notifier'
 
-* (Optionally) unpack the gem into your Rails app:
+* Install the gem:
+
+    [sudo] rake gems:install GEM=tripwire_notifier
 
-    rake gems:unpack
+= Configuration
 
-* In your Rails app, create config/initializers/tripwire_notifier.rb and add the following line with the API key for your Tripwire project:
+In your Rails app, create config/initializers/tripwire_notifier.rb and add the following line with the API key for your Tripwire project:
 
     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.
-
+Validation errors will now be submitted to the Tripwire service on your create and update actions in production mode.
 
-= More Advanced Usage
+= Advanced Usage
 
 === Tracking custom actions
 
@@ -38,23 +47,27 @@ TripwireNotifier assumes your app is RESTful, so it only monitors the create and
 
     after_filter :log_validation_failures_to_tripwire, :only => [:create, :update, :my_custom_action]
 
-=== Filtering params
+=== Running in other environments
 
-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:
+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:
 
-    # Scrub sensitive parameters from your log
-    filter_parameter_logging :password, :secret
+config.monitored_environments << 'staging'
 
-Per the Rails standard, those params will show up as "[FILTERED]" in the data submitted to Tripwire.
+=== SSL
 
-=== Running in other environments
+TripwireNotifier does not use SSL by default, but you can enable it easily:
 
-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:
+    config.secure = true
 
-    config.monitored_environments << 'staging'
+=== Filtering params
+
+TripwireNotifier records 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
 
+Per Rails convention, those params will show up as "[FILTERED]" in the data submitted to Tripwire.
 
-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
 
@@ -68,7 +81,7 @@ We plan to streamline the setup process in the future and provide additional det
 * 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.
+* 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.
 

data/Rakefile

@@ -9,7 +9,7 @@ begin
     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 TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.}
-    gem.email = ""
+    gem.email = "support@tripwireapp.com"
     gem.homepage = "http://github.com/jeremyw/tripwire_notifier"
     gem.authors = ["Jeffrey Chupp", "Jeremy Weiskotten"]
     gem.add_development_dependency "shoulda", ">= 0"
@@ -23,7 +23,7 @@ end
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
 
@@ -31,7 +31,7 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
+    test.pattern = 'test/**/*_test.rb'
     test.verbose = true
   end
 rescue LoadError

data/lib/tripwire_notifier/configuration.rb

@@ -1,14 +1,18 @@
 module TripwireNotifier
   class Configuration
-    attr_accessor :notifier_version
+    attr_reader :notifier_version
     attr_accessor :api_key
     attr_accessor :monitored_environments
     attr_accessor :timeout_in_seconds
+    attr_accessor :secure
+
+    alias_method :secure?, :secure
 
     def initialize
       @notifier_version = VERSION
       @timeout_in_seconds = 5
       @monitored_environments = ['production']
+      @secure = false
     end
   end
 end

data/lib/tripwire_notifier/rails/action_controller_monitor.rb

@@ -11,16 +11,7 @@ module TripwireNotifier
 
       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
-            warn "Could not submit tripwireapp notification: #{ex.class} - #{ex.message}"
-          end
+          TripwireNotifier.notify(tripwire_params)
         end
       end
 
@@ -47,13 +38,10 @@ module TripwireNotifier
 
       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[:_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)

data/lib/tripwire_notifier/sender.rb

@@ -0,0 +1,43 @@
+module TripwireNotifier
+  class Sender
+    attr_reader :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def protocol
+      self.configuration.secure? ? 'https' : 'http'
+    end
+
+    def port
+      self.configuration.secure? ? 443 : 80
+    end
+
+    def host
+      'api.tripwireapp.com'
+    end
+
+    def uri
+      URI.parse("#{protocol}://#{host}:#{port}").merge('/')
+    end
+
+    def send_to_tripwire(data)
+      uri = self.uri
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = self.configuration.timeout_in_seconds
+      http.use_ssl      = self.configuration.secure?
+      http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data(data)
+
+      begin
+        response = http.request(request)
+      rescue Exception => ex
+        warn "Could not submit tripwireapp notification: #{ex.class} - #{ex.message}"
+      end
+    end
+  end
+end

data/lib/tripwire_notifier/version.rb

@@ -1,3 +1,3 @@
 module TripwireNotifier
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/tripwire_notifier.rb

@@ -1,20 +1,34 @@
 require 'net/http'
+require 'net/https'
 require 'uri'
-require 'timeout'
 require 'tripwire_notifier/version'
 require 'tripwire_notifier/configuration'
+require 'tripwire_notifier/sender'
 require 'tripwire_notifier/rails/action_controller_monitor'
 
 module TripwireNotifier
   API_VERSION = "alpha 1"
-  API_URL     = 'http://api.tripwireapp.com/'
 
   class << self
     attr_accessor :configuration
+    attr_accessor :sender
 
     def configure
       self.configuration ||= Configuration.new
-      yield(configuration)
+      yield(self.configuration)
+      self.sender = Sender.new(self.configuration)
+    end
+
+    def notify(data)
+      self.sender.send_to_tripwire(data.merge(notifier_params))
+    end
+
+    def notifier_params
+      {}.tap do |params|
+        params[:notifier_version] = self.configuration.notifier_version
+        params[:api_key]          = self.configuration.api_key
+        params[:api_version]      = API_VERSION
+      end
     end
   end
 end

data/test/sender_test.rb

@@ -0,0 +1,75 @@
+require 'helper'
+
+class SenderTest < Test::Unit::TestCase
+  def setup
+    TripwireNotifier.configure do |c|
+      c.api_key = 'API_KEY'
+    end
+    @sender = TripwireNotifier::Sender.new(TripwireNotifier.configuration)
+  end
+
+  context "initialize" do
+    should "set configuration" do
+      assert_same TripwireNotifier.configuration, @sender.configuration
+      assert_equal 'API_KEY', @sender.configuration.api_key
+    end
+  end
+
+  context "when not configured to be secure" do
+    setup do
+      TripwireNotifier.configuration.secure = false
+    end
+
+    should "return 'http' for #protocol" do
+      assert_equal 'http', @sender.protocol
+    end
+
+    should "return 80 for #port" do
+      assert_equal 80, @sender.port
+    end
+
+    should "post data without ssl on insecure port" do
+      assert_sends_to_tripwire(false, 80)
+    end
+  end
+
+  context "when configured to be secure" do
+    setup do
+      TripwireNotifier.configuration.secure = true
+    end
+
+    should "return 'https' for protocol" do
+      assert_equal 'https', @sender.protocol
+    end
+
+    should "return 443 for #port" do
+      assert_equal 443, @sender.port
+    end
+
+    should "post data with ssl on secure port" do
+      assert_sends_to_tripwire(true, 443)
+    end
+  end
+
+  should "return api.tripwireapp.com for #host" do
+    assert_equal 'api.tripwireapp.com', @sender.host
+  end
+
+
+  def assert_sends_to_tripwire(use_ssl, port)
+    data = {:key => :value}
+
+    mock_request = mock()
+    mock_request.expects(:set_form_data).with(data)
+    Net::HTTP::Post.stubs(:new => mock_request)
+
+    mock_http = mock()
+    mock_http.expects(:open_timeout=)
+    mock_http.expects(:use_ssl=).with(use_ssl)
+    mock_http.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+    mock_http.expects(:request).with(mock_request)
+    Net::HTTP.stubs(:new => mock_http)
+
+    @sender.send_to_tripwire(data)
+  end
+end

data/test/{test_tripwire.rb → tripwire_test.rb}

@@ -17,7 +17,7 @@ class TestTripwire < Test::Unit::TestCase
 
     @foo_controller = fake_controller(FooController)
 
-    FakeWeb.register_uri(:post, TripwireNotifier::API_URL, :body => "")
+    FakeWeb.register_uri(:post, 'http://api.tripwireapp.com', :body => "")
 
     TripwireNotifier.configure do |config|
       config.api_key = "SOME API KEY"
@@ -40,6 +40,11 @@ class TestTripwire < Test::Unit::TestCase
     assert_equal "Foo", TripwireNotifier.configuration.api_key
   end
 
+  should "set secure" do
+    TripwireNotifier.configure { |c| c.secure = true }
+    assert TripwireNotifier.configuration.secure?
+  end
+
   should "set a timeout_in_seconds" do
     assert_equal 5, TripwireNotifier.configuration.timeout_in_seconds
     TripwireNotifier.configure { |c| c.timeout_in_seconds = 6 }
@@ -79,14 +84,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 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(TripwireNotifier::API_URL), @foo_controller.send(:tripwire_params))
-    @foo_controller.send(:log_validation_failures_to_tripwire)
-  end
+  # should "submit errors via log_validation_failures_to_tripwire" do
+  #   Net::HTTP.expects(:post_form).with(URI.parse("http://api.tripwireapp.com:80"), @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]

data/tripwire_notifier.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tripwire_notifier}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   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-08-20}
+  s.date = %q{2010-11-12}
   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.email = %q{support@tripwireapp.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -25,9 +25,11 @@ Gem::Specification.new do |s|
      "lib/tripwire_notifier.rb",
      "lib/tripwire_notifier/configuration.rb",
      "lib/tripwire_notifier/rails/action_controller_monitor.rb",
+     "lib/tripwire_notifier/sender.rb",
      "lib/tripwire_notifier/version.rb",
      "test/helper.rb",
-     "test/test_tripwire.rb",
+     "test/sender_test.rb",
+     "test/tripwire_test.rb",
      "tripwire_notifier.gemspec"
   ]
   s.homepage = %q{http://github.com/jeremyw/tripwire_notifier}
@@ -37,7 +39,8 @@ Gem::Specification.new do |s|
   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"
+     "test/sender_test.rb",
+     "test/tripwire_test.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tripwire_notifier
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jeffrey Chupp
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 -04:00
+date: 2010-11-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
   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 TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.
-email: ""
+email: support@tripwireapp.com
 executables: []
 
 extensions: []
@@ -51,9 +51,11 @@ files:
 - lib/tripwire_notifier.rb
 - lib/tripwire_notifier/configuration.rb
 - lib/tripwire_notifier/rails/action_controller_monitor.rb
+- lib/tripwire_notifier/sender.rb
 - lib/tripwire_notifier/version.rb
 - test/helper.rb
-- test/test_tripwire.rb
+- test/sender_test.rb
+- test/tripwire_test.rb
 - tripwire_notifier.gemspec
 has_rdoc: true
 homepage: http://github.com/jeremyw/tripwire_notifier
@@ -91,4 +93,5 @@ 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
+- test/sender_test.rb
+- test/tripwire_test.rb