airbrake 3.0.2 → 3.0.3

data/CHANGELOG

@@ -1,3 +1,10 @@
+Version 3.0.3 - Sat Sep 03 13:18:26 -0400 2011
+===============================================================================
+David Czarnecki(1):
+    Use capistrano's logger, improve tests around capistrano deploy.
+Florent Guilleux(1):
+    README updates
+
 Version 3.0.2 - Mon Aug 29 10:32:04 -0400 2011
 ===============================================================================
 Harold Gimenez(1)
@@ -464,5 +471,6 @@ Nick Quaranto (3):
 
 
 
+
 
 

data/README.md

@@ -130,7 +130,7 @@ this rake task (from RAILS_ROOT):
 
     rake airbrake:test
 
-If everything is configured properly, that task will send a notice to Hoptoad
+If everything is configured properly, that task will send a notice to Airbrake
 which will be visible immediately.
 
 Rack
@@ -219,8 +219,8 @@ ID of the error that is returned from Airbrake.
 
 You can also turn the middleware that handles this completely off by setting `config.user_information` to false.
 
-Tracking deployments in Hoptoad
--------------------------------
+Tracking deployments in Airbrake
+--------------------------------
 
 Paying Airbrake plans support the ability to track deployments of your application in Airbrake.
 By notifying Airbrake of your application deployments, all errors are resolved when a deploy occurs,
@@ -263,7 +263,7 @@ While in your controllers you use the `notify_airbrake` method, anywhere else in
 your code, use `Airbrake.notify`. Airbrake will get all the information
 about the error itself. As for a hash, these are the keys you should pass:
 
-* `:error_class` - Use this to group similar errors together. When Hoptoad catches an exception it sends the class name of that exception object.
+* `:error_class` - Use this to group similar errors together. When Airbrake catches an exception it sends the class name of that exception object.
 * `:error_message` - This is the title of the error you see in the errors list. For exceptions it is "#{exception.class.name}: #{exception.message}"
 * `:parameters` - While there are several ways to send additional data to Airbrake, passing a Hash as :parameters as in the example above is the most common use case. When Airbrake catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
 
@@ -298,7 +298,7 @@ them even logged.
 This filter will only be applied to automatic notifications, not manual
 notifications (when #notify is called directly).
 
-Hoptoad ignores the following exceptions by default:
+Airbrake ignores the following exceptions by default:
 
     AbstractController::ActionNotFound
     ActiveRecord::RecordNotFound
@@ -341,7 +341,7 @@ To ignore exceptions based on other conditions, use #ignore_by_filter:
       end
     end
 
-To replace sensitive information sent to the Hoptoad service with [FILTERED] use #params_filters:
+To replace sensitive information sent to the Airbrake service with [FILTERED] use #params_filters:
 
     Airbrake.configure do |config|
       config.api_key      = '1234567890abcdef'
@@ -421,7 +421,7 @@ Credits
 
 Airbrake is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
 
-Thank you to all [the contributors](https://github.com/thoughtbot/hoptoad_notifier/contributors)!
+Thank you to all [the contributors](https://github.com/thoughtbot/airbrake/contributors)!
 
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 

data/airbrake.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rspec",         "~> 2.6.0")
   s.add_development_dependency("sham_rack",     "~> 1.3.0")
   s.add_development_dependency("shoulda",       "~> 2.11.3")
+  s.add_development_dependency("capistrano",    "~> 2.8.0")
 
   s.authors = ["thoughtbot, inc"]
   s.email   = %q{support@airbrakeapp.com}

data/lib/airbrake.rb

@@ -35,7 +35,7 @@ module Airbrake
 
     # A Airbrake configuration object. Must act like a hash and return sensible
     # values for all Airbrake configuration options. See Airbrake::Configuration.
-    attr_accessor :configuration
+    attr_writer :configuration
 
     # Tell the log that the Notifier is good to go
     def report_ready
@@ -77,12 +77,17 @@ module Airbrake
     #     config.secure  = false
     #   end
     def configure(silent = false)
-      self.configuration ||= Configuration.new
       yield(configuration)
       self.sender = Sender.new(configuration)
       report_ready unless silent
     end
 
+    # The configuration object.
+    # @see Airbrake.configure
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
     # Sends an exception manually using this method, even when you are not in a controller.
     #
     # @param [Exception] exception The exception you want to notify Airbrake about.

data/lib/airbrake/capistrano.rb

@@ -1,21 +1,32 @@
 # Defines deploy:notify_airbrake which will send information about the deploy to Airbrake.
+require 'capistrano'
 
-Capistrano::Configuration.instance(:must_exist).load do
-  after "deploy",            "deploy:notify_airbrake"
-  after "deploy:migrations", "deploy:notify_airbrake"
+module Airbrake
+  module Capistrano
+    def self.load_into(configuration)
+      configuration.load do
+        after "deploy",            "airbrake:notify"
+        after "deploy:migrations", "airbrake:notify"
 
-  namespace :deploy do
-    desc "Notify Airbrake of the deployment"
-    task :notify_airbrake, :except => { :no_release => true } do
-      rails_env = fetch(:airbrake_env, fetch(:rails_env, "production"))
-      local_user = ENV['USER'] || ENV['USERNAME']
-      executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
-      notify_command = "#{executable} airbrake:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
-      notify_command << " DRY_RUN=true" if dry_run
-      notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
-      puts "Notifying Airbrake of Deploy (#{notify_command})"
-      `#{notify_command}`
-      puts "Airbrake Notification Complete."
+        namespace :airbrake do
+          desc "Notify Airbrake of the deployment"
+          task :notify, :except => { :no_release => true } do
+            rails_env = fetch(:airbrake_env, fetch(:rails_env, "production"))
+            local_user = ENV['USER'] || ENV['USERNAME']
+            executable = RUBY_PLATFORM.downcase.include?('mswin') ? fetch(:rake, 'rake.bat') : fetch(:rake, 'rake')
+            notify_command = "#{executable} airbrake:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}"
+            notify_command << " DRY_RUN=true" if dry_run
+            notify_command << " API_KEY=#{ENV['API_KEY']}" if ENV['API_KEY']
+            logger.info "Notifying Airbrake of Deploy (#{notify_command})"
+            `#{notify_command}` if !configuration.dry_run
+            logger.info "Airbrake Notification Complete."
+          end
+        end
+      end
     end
   end
 end
+
+if Capistrano::Configuration.instance
+  Airbrake::Capistrano.load_into(Capistrano::Configuration.instance)
+end

data/lib/airbrake/version.rb

@@ -1,3 +1,3 @@
 module Airbrake
-  VERSION = "3.0.2".freeze
+  VERSION = "3.0.3".freeze
 end

data/test/capistrano_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/helper'
+
+require 'capistrano/configuration'
+require 'airbrake/capistrano'
+
+class CapistranoTest < Test::Unit::TestCase
+  def setup
+    super
+    reset_config
+    
+    @configuration = Capistrano::Configuration.new
+    Airbrake::Capistrano.load_into(@configuration)
+    @configuration.dry_run = true
+  end
+  
+  should "define deploy:notify_airbrake task" do
+    assert_not_nil @configuration.find_task('airbrake:notify')
+  end
+  
+  should "log when calling deploy:notify_airbrake task" do
+    @configuration.set(:current_revision, '084505b1c0e0bcf1526e673bb6ac99fbcb18aecc')
+    @configuration.set(:repository, 'repository')
+    io = StringIO.new
+    logger = Capistrano::Logger.new(:output => io)
+    logger.level = Capistrano::Logger::MAX_LEVEL
+    
+    @configuration.logger = logger
+    @configuration.find_and_execute_task('airbrake:notify')
+    
+    assert io.string.include?('** Notifying Airbrake of Deploy')
+    assert io.string.include?('** Airbrake Notification Complete')
+  end
+end

data/test/configuration_test.rb

@@ -181,6 +181,11 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_equal "CUSTOM LOGGER", config.logger
   end
 
+  should 'give a new instance if non defined' do
+    Airbrake.configuration = nil
+    assert_kind_of Airbrake::Configuration, Airbrake.configuration
+  end
+
   def assert_config_default(option, default_value, config = nil)
     config ||= Airbrake::Configuration.new
     assert_equal default_value, config.send(option)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: airbrake
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 3
   - 0
-  - 2
-  version: 3.0.2
+  - 3
+  version: 3.0.3
 platform: ruby
 authors: 
 - thoughtbot, inc
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 Z
+date: 2011-09-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -205,6 +205,22 @@ dependencies:
         version: 2.11.3
   type: :development
   version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id013
 description: 
 email: support@airbrakeapp.com
 executables: []
@@ -280,6 +296,7 @@ files:
 - test/airbrake_2_2.xsd
 - test/airbrake_tasks_test.rb
 - test/backtrace_test.rb
+- test/capistrano_test.rb
 - test/catcher_test.rb
 - test/configuration_test.rb
 - test/helper.rb
@@ -348,6 +365,7 @@ test_files:
 - test/airbrake_2_2.xsd
 - test/airbrake_tasks_test.rb
 - test/backtrace_test.rb
+- test/capistrano_test.rb
 - test/catcher_test.rb
 - test/configuration_test.rb
 - test/helper.rb