bugsnag 1.1.0 → 1.1.1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 James Smith
+Copyright (c) 2012 Bugsnag
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,18 +1,15 @@
-Official Bugsnag Notifier for Ruby
-==================================
+Bugsnag Notifier for Ruby
+=========================
 
 The Bugsnag Notifier for Ruby gives you instant notification of exceptions
 thrown from your **Rails**, **Sinatra**, **Rack** or **plain Ruby** app.
 Any uncaught exceptions will trigger a notification to be sent to your 
 Bugsnag project.
 
-
-What is Bugsnag?
-----------------
-
 [Bugsnag](http://bugsnag.com) captures errors in real-time from your web, 
 mobile and desktop applications, helping you to understand and resolve them 
-as fast as possible. [Create a free account](http://bugsnag.com).
+as fast as possible. [Create a free account](http://bugsnag.com) to start 
+capturing exceptions from your applications.
 
 
 How to Install (Rails)
@@ -199,6 +196,77 @@ By default, `ignore_classes` contains the following classes:
 ```
 
 
+Deploy Tracking
+---------------
+
+Bugsnag allows you to track deploys of your apps. By sending the 
+source revision or application version to bugsnag.com when you deploy a new
+version of your app, you'll be able to see which deploy each error was
+introduced in.
+
+### Using Capistrano
+
+If you use [capistrano](https://github.com/capistrano/capistrano) to deploy
+your apps, you can enable deploy tracking by adding the following line to your
+app's `deploy.rb`:
+
+```ruby
+require "bugsnag/capistrano"
+```
+
+### Using Rake
+
+If you aren't using capistrano, you can run the following rake command from
+your deploy scripts.
+
+```shell
+rake bugsnag:deploy BUGSNAG_REVISION=source-control-revision BUGSNAG_RELEASE_STAGE=production
+```
+
+The bugsnag rake tasks will be automatically available for Rails 3 
+apps, to make the rake tasks available in other apps, add the following to 
+your `Rakefile`:
+
+```ruby
+require "bugsnag/tasks"
+```
+
+### Configuring Deploy Tracking
+
+You can set the following environmental variables to override or specify
+additional deploy information:
+
+-   **BUGSNAG_RELEASE_STAGE** - 
+    The release stage (eg, production, staging) currently being deployed.
+    This is set automatically from your Bugsnag settings or rails/rack
+    environment.
+
+-   **BUGSNAG_API_KEY** - 
+    Your Bugsnag API key. This is set automatically from your Bugsnag
+    settings in your app.
+    
+-   **BUGSNAG_REPOSITORY** - 
+    The repository from which you are deploying the code. This is set 
+    automatically if you are using capistrano.
+
+-   **BUGSNAG_BRANCH** - 
+    The source control branch from which you are deploying the code.
+    This is set automatically if you are using capistrano.
+
+-   **BUGSNAG_REVISION** - 
+    The source control revision for the code you are currently deploying.
+    This is set automatically if you are using capistrano.
+
+-   **BUGSNAG_APP_VERSION** -
+    The app version of the code you are currently deploying. Only set this
+    if you tag your releases with [semantic version numbers](http://semver.org/)
+    and deploy infrequently.
+
+For more information, check out the [deploy tracking api](https://bugsnag.com/docs/deploy-tracking-api)
+documentation.
+
+
+
 Reporting Bugs or Feature Requests
 ----------------------------------
 
@@ -210,21 +278,15 @@ project here:
 
 Contributing
 ------------
- 
--   Check out the latest master to make sure the feature hasn't been 
-    implemented or the bug hasn't been fixed yet
--   Check out the issue tracker to make sure someone already hasn't requested
-    it and/or contributed it
--   Fork the project
--   Start a feature/bugfix branch
+
+-   [Fork](https://help.github.com/articles/fork-a-repo) the [notifier on github](https://github.com/bugsnag/bugsnag-ruby)
 -   Commit and push until you are happy with your contribution
+-   [Make a pull request](https://help.github.com/articles/using-pull-requests)
 -   Thanks!
 
 
 License
 -------
 
-The Bugsnag ruby notifier is released under the
-Apache License, Version 2.0. Read the full license here:
-
-<http://www.apache.org/licenses/LICENSE-2.0>
+The Bugsnag ruby notifier is free software released under the MIT License. 
+See [LICENSE.txt](https://github.com/bugsnag/bugsnag-ruby/blob/master/LICENSE.txt) for details.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/bugsnag.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bugsnag"
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Smith"]
-  s.date = "2012-06-18"
+  s.date = "2012-07-17"
   s.description = "Ruby notifier for bugsnag.com"
   s.email = "james@bugsnag.com"
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "bugsnag.gemspec",
     "lib/bugsnag.rb",
+    "lib/bugsnag/capistrano.rb",
     "lib/bugsnag/configuration.rb",
     "lib/bugsnag/delay/resque.rb",
     "lib/bugsnag/helpers.rb",
@@ -35,8 +36,10 @@ Gem::Specification.new do |s|
     "lib/bugsnag/rails/action_controller_rescue.rb",
     "lib/bugsnag/rails/controller_methods.rb",
     "lib/bugsnag/railtie.rb",
+    "lib/bugsnag/tasks.rb",
     "lib/bugsnag/version.rb",
     "lib/resque/failure/bugsnag.rb",
+    "lib/tasks/bugsnag.rake",
     "rails/init.rb",
     "test/helper.rb",
     "test/test_bugsnag.rb"
@@ -44,7 +47,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/bugsnag/bugsnag-ruby"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.24"
   s.summary = "Ruby notifier for bugsnag.com"
 
   if s.respond_to? :specification_version then

data/lib/bugsnag.rb

@@ -51,6 +51,15 @@ module Bugsnag
       configuration.logger.info(LOG_PREFIX + message) if configuration.logger
     end
 
+    # Warning logger
+    def warn(message)
+      if configuration.logger
+        configuration.logger.warn(LOG_PREFIX + message)
+      else
+        puts "#{LOG_PREFIX}#{message}"
+      end
+    end
+
     # Configuration getter
     def configuration
       @configuration ||= Bugsnag::Configuration.new

data/lib/bugsnag/capistrano.rb

@@ -0,0 +1,47 @@
+require "httparty"
+require "multi_json"
+
+module Bugsnag
+  module Capistrano
+    ALLOWED_ENV_SETTINGS = %w{BUGSNAG_RELEASE_STAGE BUGSNAG_REPOSITORY BUGSNAG_REVISION BUGSNAG_BRANCH BUGSNAG_API_KEY BUGSNAG_APP_VERSION}
+
+    def self.load_into(configuration)
+      configuration.load do
+        after "deploy",            "bugsnag:deploy"
+        after "deploy:migrations", "bugsnag:deploy"
+
+        namespace :bugsnag do
+          desc "Notify Bugsnag that new production code has been deployed"
+          task :deploy, :except => { :no_release => true }, :on_error => :continue do
+            # Build the rake command
+            rake = fetch(:rake, "rake")
+            rails_env = fetch(:rails_env, "production")
+            rake_command = "cd '#{current_path}' && #{rake} bugsnag:deploy RAILS_ENV=#{rails_env}"
+
+            # Build the new environment to pass through to rake
+            new_env = {
+              "BUGSNAG_RELEASE_STAGE" => rails_env,
+              "BUGSNAG_REVISION" => fetch(:current_revision, nil),
+              "BUGSNAG_REPOSITORY" => fetch(:repository, nil),
+              "BUGSNAG_BRANCH" => fetch(:branch, nil)
+            }.reject {|k,v| v.nil? }
+
+            # Pass through any existing env variables
+            ALLOWED_ENV_SETTINGS.each { |opt| new_env[opt] = ENV[opt] if ENV[opt] }
+
+            # Append the env to the rake command
+            rake_command << " #{new_env.map{|k,v| "#{k}=#{v}"}.join(" ")}"
+
+            # Run the rake command (only on one server)
+            run(rake_command, :once => true)
+            
+            logger.info "Bugsnag deploy notification complete."
+          end
+        end
+      end
+    end
+  end
+end
+
+Bugsnag::Capistrano.load_into(Capistrano::Configuration.instance) if Capistrano::Configuration.instance
+

data/lib/bugsnag/configuration.rb

@@ -1,6 +1,5 @@
 module Bugsnag
   class Configuration
-    # TODO:JS enforce notify_release_stages
     OPTIONS = [
       :api_key, :release_stage, :notify_release_stages, :auto_notify,
       :use_ssl, :project_root, :app_version,
@@ -39,7 +38,8 @@ module Bugsnag
       "ActionController::InvalidAuthenticityToken",
       "CGI::Session::CookieStore::TamperedWithCookie",
       "ActionController::UnknownAction",
-      "AbstractController::ActionNotFound"
+      "AbstractController::ActionNotFound",
+      "Mongoid::Errors::DocumentNotFound"
     ]
 
 

data/lib/bugsnag/helpers.rb

@@ -1,9 +1,11 @@
 module Bugsnag
   module Helpers
+    MAX_STRING_LENGTH = 1024
+
     def self.cleanup_hash(hash)
       return nil unless hash
       hash.inject({}) do |h, (k, v)|
-        h[k.to_s.gsub(/\./, "-")] = v.to_s
+        h[k.to_s.gsub(/\./, "-")] = v.to_s.slice(0, MAX_STRING_LENGTH)
         h
       end
     end

data/lib/bugsnag/notification.rb

@@ -58,6 +58,11 @@ module Bugsnag
     def deliver
       return unless self.notify_release_stages.include?(self.release_stage)
       
+      unless self.api_key
+        Bugsnag.warn "No API key configured, couldn't notify"
+        return
+      end
+      
       endpoint = (self.use_ssl ? "https://" : "http://") + (self.endpoint || DEFAULT_ENDPOINT)
 
       Bugsnag.log("Notifying #{endpoint} of exception")
@@ -65,7 +70,7 @@ module Bugsnag
       payload = {
         :apiKey => self.api_key,
         :notifier => notifier_identification,
-        :errors => [{
+        :events => [{
           :userId => self.user_id,
           :appVersion => self.app_version,
           :releaseStage => self.release_stage,
@@ -75,7 +80,7 @@ module Bugsnag
         }.reject {|k,v| v.nil? }]
       }
 
-      self.class.deliver_exception_payload(endpoint, MultiJson.encode(payload))
+      self.class.deliver_exception_payload(endpoint, MultiJson.dump(payload))
     end
 
     def ignore?

data/lib/bugsnag/rack.rb

@@ -2,6 +2,18 @@ module Bugsnag
   class Rack
     def initialize(app)
       @app = app
+      if Bugsnag.configuration.project_root.nil? || Bugsnag.configuration.project_root.empty?
+        if defined?(settings)
+          Bugsnag.configuration.project_root = settings.root
+        else
+          caller.each do |c|
+            if c =~ /[\/\\]config.ru$/
+              Bugsnag.configuration.project_root = File.dirname(c.split(":").first)
+              break
+            end
+          end
+        end
+      end
     end
 
     def call(env)

data/lib/bugsnag/railtie.rb

@@ -6,7 +6,7 @@ require "rails"
 module Bugsnag
   class Railtie < Rails::Railtie
     rake_tasks do
-      # TODO: Add in rake tasks
+      load "tasks/bugsnag.rake"
     end
 
     initializer "bugsnag.use_rack_middleware" do |app|
@@ -15,11 +15,11 @@ module Bugsnag
 
     config.after_initialize do
       Bugsnag.configure do |config|
-        config.release_stage = Rails.env
-        config.project_root = Rails.root
+        config.release_stage = ::Rails.env
+        config.project_root = ::Rails.root
         config.framework = "Rails: #{::Rails::VERSION::STRING}"
 
-        config.logger ||= Rails.logger
+        config.logger ||= ::Rails.logger
       end
 
       if defined?(::ActionController::Base)

data/lib/bugsnag/tasks.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/../tasks/*.rake"].each do |task|
+  load task
+end

data/lib/resque/failure/bugsnag.rb

@@ -35,8 +35,7 @@ module Resque
       private
       def bugsnag_job_data
         {
-          :user_id => nil, # TODO: How to infer a user id in resque?
-          :context => "resque: #{queue}",
+          :context => "resque##{queue}",
           :meta_data => {
             :payload => payload
           }

data/lib/tasks/bugsnag.rake

@@ -0,0 +1,52 @@
+require "bugsnag"
+require "httparty"
+require "multi_json"
+
+namespace :bugsnag do
+  desc "Notify Bugsnag of a new deploy."
+  task :deploy => :load do
+    # Fetch and check the api key
+    api_key = ENV["BUGSNAG_API_KEY"] || Bugsnag.configuration.api_key
+    raise RuntimeError.new("No API key found when notifying deploy") if !api_key || api_key.empty?
+
+    # Build the deploy payload
+    payload = {
+      :apiKey => api_key,
+      :releaseStage => ENV["BUGSNAG_RELEASE_STAGE"] || Bugsnag.configuration.release_stage
+    }
+    payload[:appVersion] = ENV["BUGSNAG_APP_VERSION"] if ENV["BUGSNAG_APP_VERSION"]
+    payload[:revision] = ENV["BUGSNAG_REVISION"] if ENV["BUGSNAG_REVISION"]
+    payload[:repository] = ENV["BUGSNAG_REPOSITORY"] if ENV["BUGSNAG_REPOSITORY"]
+    payload[:branch] = ENV["BUGSNAG_BRANCH"] if ENV["BUGSNAG_BRANCH"]
+
+    # Post the deploy notification
+    begin
+      endpoint = (Bugsnag.configuration.use_ssl ? "https://" : "http://") \
+               + (Bugsnag.configuration.endpoint || Bugsnag::Notification::DEFAULT_ENDPOINT) \
+               + "/deploy"
+
+      HTTParty.post(endpoint, {
+        :body => MultiJson.dump(payload),
+        :headers => {"Content-Type" => "application/json"}
+      })
+    rescue Exception => e
+      Bugsnag.log("Deploy notification failed, #{e.inspect}")
+    end
+  end
+
+  desc "Send a test exception to Bugsnag."
+  task :test_exception => :load do 
+    begin
+      raise RuntimeError.new("Bugsnag test exception")
+    rescue => e
+      Bugsnag.notify(e, {:context => "rake#test_exception"})
+    end
+  end
+end
+
+task :load do
+  begin 
+    Rake::Task["environment"].invoke
+  rescue
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bugsnag
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - James Smith
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-18 00:00:00 Z
+date: 2012-07-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -28,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
+  prerelease: false
   type: :runtime
   name: multi_json
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -42,12 +41,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
+  prerelease: false
   type: :runtime
   name: httparty
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -56,12 +55,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
+  prerelease: false
   type: :development
   name: shoulda
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -72,12 +71,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id004
+  prerelease: false
   type: :development
   name: bundler
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -88,12 +87,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  requirement: *id005
+  prerelease: false
   type: :development
   name: jeweler
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -102,9 +101,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
+  prerelease: false
   type: :development
   name: rcov
+  version_requirements: *id006
 description: Ruby notifier for bugsnag.com
 email: james@bugsnag.com
 executables: []
@@ -124,6 +124,7 @@ files:
 - VERSION
 - bugsnag.gemspec
 - lib/bugsnag.rb
+- lib/bugsnag/capistrano.rb
 - lib/bugsnag/configuration.rb
 - lib/bugsnag/delay/resque.rb
 - lib/bugsnag/helpers.rb
@@ -133,8 +134,10 @@ files:
 - lib/bugsnag/rails/action_controller_rescue.rb
 - lib/bugsnag/rails/controller_methods.rb
 - lib/bugsnag/railtie.rb
+- lib/bugsnag/tasks.rb
 - lib/bugsnag/version.rb
 - lib/resque/failure/bugsnag.rb
+- lib/tasks/bugsnag.rake
 - rails/init.rb
 - test/helper.rb
 - test/test_bugsnag.rb
@@ -167,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby notifier for bugsnag.com