README-exception_notifier install.rb install/initializer.rb @@ -1,13 +1,68 @@ RailzScout ========== -Introduction goes here. +The RailzScout plugin implements FogBugz's BugzScout system for Rails apps. +It works by submitting your bugs to your FogBugz installation directly via +HTTP post. +The plugin is based on the Exception Notifier plugin by Jamis Buck. Much +works the same, but email code has been replaced with code that posts to +scoutSubmit in your FogBugz installation. -Example -======= -Example goes here. +Usage +===== +1. Include the ExceptionNotifiable mixin in whichever controller you want to + report errors to FogBugz. (ApplicationController for the whole app.): -Copyright (c) 2008 [name of plugin creator], released under the MIT license + class ApplicationController < ActionController::Base + include ExceptionNotifiable + … + +2. If you installed the plugin via default methods, you should find a + railz_scout.rb file in your app's config/initializers/ directory. + (Otherwise, create the file or just edit environment.rb.) + You should see something like this: + + RAILZ_SCOUT_CONFIG = { + :url => "http://example.com/FogBugz/scoutSubmit.php", + # :username => 'RailzScout', + # :project => 'Inbox', + # :area => 'Undecided', + # :force_new => false, + } + + RailzScout.config.merge! RAILZ_SCOUT_CONFIG + + + + + +Customizations +============== + +The rendering code from Exception Notifier has barely been touched. Therefore, +the same customizations that apply to the original plugin should apply here. + +For more info, see their original README, included with this copy. + + + + + + +# :title / Description +# If the description field matches exactly to any other bug, this submission +# will be APPENDED to that bug's history, and a new bug will NOT be created. +# The occurrences field for this bug will increase by 1. + +# force_new / ForceNewBug +# force FogBUGZ to create a new bug for this entry, instead of appending to +# bug with matching description + + + + +Copyright (c) 2008 Caio Chassot, released under the MIT license +with parts from Exception Notifier plugin, Copyright (c) 2005 Jamis Buck, released under the MIT license README README - exception_notification 5f7db19626e859502239860f8e8528412a4aae25 Caio Chassot dev@caiochassot.com http://github.com/kch/railz_scout/commit/d5814796a34a7e7d077d91190fd186a47fd9f90e d5814796a34a7e7d077d91190fd186a47fd9f90e 2008-03-06T15:15:45-08:00 2008-03-06T15:15:45-08:00 incomplete readme and install git-svn-id: http://svn.14bits.com.br/plugins/railz_scout/trunk@65 04d0f4c2-ae31-0410-9209-bd6456675336 34209620a8f3f48a954b4b1ef33683e32844cf34 Caio Chassot dev@caiochassot.com