README.rdoc

GuardrailNotifier¶ ↑

<img src=“https://travis-ci.org/terriblelabs/guardrail_notifier.png” />

Stop hurting your users!

Guardrail captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The GuardrailNotifier gem makes it easy to hook up your app to the Guardrail web service.

If you haven’t already signed up for a Guardrail account, visit guardrailapp.com.

Installation¶ ↑

Rails 3¶ ↑

• Add the following line to Gemfile:

  gem 'guardrail_notifier'
  

• Install the gem:

  bundle install
  

Rails 2.3¶ ↑

• Add the following line to config/environment.rb:

  config.gem 'guardrail_notifier'
  

• Install the gem:

  [sudo] rake gems:install GEM=guardrail_notifier

Configuration¶ ↑

In your Rails app, create config/initializers/guardrail_notifier.rb and add the following line with the API key for your Guardrail project:

GuardrailNotifier.configure do |config|
  config.api_key = "<YOUR API KEY>"
end

Or, if you prefer to keep API keys and the like out of your code, set the GUARDRAIL_API_KEY environment variable and GuardrailNotifier will find it automatically.

Validation errors will now be submitted to the Guardrail service on your create and update actions in production mode.

Advanced Usage¶ ↑

Tracking custom actions¶ ↑

GuardrailNotifier 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_guardrail, :only => [:create, :update, :my_custom_action]

Running in other environments¶ ↑

GuardrailNotifier 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 Guardrail initializer:

GuardrailNotifier.configure do |config|
  config.monitored_environments << 'staging'
end

SSL¶ ↑

GuardrailNotifier uses a secure connection over SSL by default, but you can easily disable it if you prefer:

GuardrailNotifier.configure do |config|
  config.secure = false
end

Filtering params¶ ↑

GuardrailNotifier 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, GuardrailNotifier respects the parameter filtering that you configure in Rails in config/application.rb (Rails 3) or ApplicationController (Rails 2.3). For example in Rails 3:

config.filter_parameters += [:password, :secret, :cvv]

Per Rails convention, those params will show up as “[FILTERED]” in the data submitted to Guardrail.

Contact information¶ ↑

• Twitter: @guardrailapp

• Email: [email protected]

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 © 2012 Terrible Labs, Inc. See LICENSE for details.