bugsnag-capistrano 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDg1ZGZiMDhkYTNiOWZiYmZiMWZmOGRiZDU1NzNkMjc1YTIzNThkYg==
-  data.tar.gz: !binary |-
-    ZGFkNTMxYTEwYjBiYmUxNDhkMTc2Y2YyNGIwYWI0NWFmNzhmYWI2Zg==
+SHA1:
+  metadata.gz: 79c3760c59cce6a32240955ba0ffb0604c789135
+  data.tar.gz: 69b90256827c6e24a07f7a1e9491337a0c5e9cee
 SHA512:
-  metadata.gz: !binary |-
-    MDk4NWQzMDE3NTRlZWUyNzcxNTdmZWY2YThiZWU0MjYzODVhM2Y5NGQ4YmVk
-    ZWIzNWU1YjY0ZGM0MTgwMTgwMTA2ZTBhMWNmZDc2YmU2ZmRjNzBlZDk5N2Fh
-    M2RlODI4YzY2YmY5YWIyOTg1NjE3MTZiZjU4OTlmNzVkNGQ4MmY=
-  data.tar.gz: !binary |-
-    Y2Q1NmYxZTNlM2Q3MzFiZWQwYmFmNWNjMzE3YTM0NjczOTk0MDFiOGQ0ZTdm
-    NTZiMjI2NjkwYzJhOTdiMTAyZTE1MTkwMWIxMWQxYzRjMDVhYmU2MzAwOWQ4
-    NTI5YzVlOTc2ZmVlOGRhM2Y2NmI2YTRkYzhmZGQwM2QwNzFiZGE=
+  metadata.gz: f7c991ec8c557f2d2e6ce823b2b9b24ec21daf4bf532a568b389f4824f81f64144402c09e49d854807314409d9777430ca5540c86aab5fcdeeb44bf280b568c0
+  data.tar.gz: 35c9f306c9abae72d6a3eb2c89102163b8f801c98e3f7d040a92dce882bab119cf1efa826891600d816c793bfbb440c049a2c5031464c321cfdb8538b0d93045

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.1.0 (23-11-2017)
+
+### Enhancements
+
+* Add Heroku deployment hooks task
+  | [#5](https://github.com/bugsnag/bugsnag-capistrano/pull/5)
+
 ## 1.0.1 (09-11-2017)
 
 ### Bug fixes

data/README.md

@@ -6,11 +6,19 @@ application with [Capistrano](https://github.com/capistrano/capistrano),
 allowing to correlate deploys with new errors and increased error rates in
 Bugsnag.
 
+It also includes a Rake task for manually sending deploy notifications or
+for projects not using Capistrano.
+
 [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) to start
 capturing exceptions from your applications.
 
+## Getting started
+
+* [Integrating with Capistrano](https://docs.bugsnag.com/api/deploy-tracking/capistrano/)
+* [Integrating with Rake](https://docs.bugsnag.com/api/deploy-tracking/rake/)
+
 ## Contributing
 
 All contributors are welcome! For information on how to build, test,
@@ -20,6 +28,6 @@ and release `bugsnag-capistrano`, see our
 
 ## License
 
-The Bugsnag Cocoa library is free software released under the MIT License.
+The Bugsnag Capistrano library is free software released under the MIT License.
 See [LICENSE.txt](https://github.com/bugsnag/bugsnag-capistrano/blob/master/LICENSE.txt)
 for details.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/bugsnag-capistrano/deploy.rb

@@ -1,5 +1,6 @@
 require "json"
 require "net/http"
+require "logger"
 
 module Bugsnag
   module Capistrano

data/lib/bugsnag-capistrano/tasks/bugsnag-capistrano.rake

@@ -1,4 +1,4 @@
-require "bugsnag"
+require "bugsnag-capistrano/deploy"
 
 namespace :bugsnag do
 
@@ -10,6 +10,7 @@ namespace :bugsnag do
     revision = ENV["BUGSNAG_REVISION"]
     repository = ENV["BUGSNAG_REPOSITORY"]
     branch = ENV["BUGSNAG_BRANCH"]
+    endpoint = ENV["BUGSNAG_ENDPOINT"]
 
     Rake::Task["load"].invoke unless api_key
     
@@ -19,10 +20,61 @@ namespace :bugsnag do
       :app_version => app_version,
       :revision => revision,
       :repository => repository,
-      :branch => branch
+      :branch => branch,
+      :endpoint => endpoint,
     })
   end
 
+  namespace :heroku do
+    desc "Add a heroku deploy hook to notify Bugsnag of deploys"
+    task :add_deploy_hook => :load do
+      # Wrapper to run command safely even in bundler
+      run_command = lambda { |command|
+        defined?(Bundler.with_clean_env) ? Bundler.with_clean_env { `#{command}` } : `#{command}`
+      }
+
+      # Fetch heroku config settings
+      config_command = "heroku config --shell"
+      config_command += " --app #{ENV["HEROKU_APP"]}" if ENV["HEROKU_APP"]
+      heroku_env = run_command.call(config_command).split(/[\n\r]/).each_with_object({}) do |c, obj|
+        k,v = c.split("=")
+        obj[k] = (v.nil? || v.strip.empty?) ? nil : v
+      end
+
+      # Check for Bugsnag API key (required) using Bugsnag configuration only if available
+      begin
+        require 'bugsnag'
+        api_key = heroku_env["BUGSNAG_API_KEY"] || Bugsnag.configuration.api_key || ENV["BUGSNAG_API_KEY"]
+      rescue LoadError
+        api_key = heroku_env["BUGSNAG_API_KEY"] || ENV["BUGSNAG_API_KEY"]
+      end
+
+      unless api_key
+        puts "Error: No API key found, have you run 'heroku config:set BUGSNAG_API_KEY=your-api-key'?"
+        next
+      end
+
+      # Build the request, making use of deploy hook variables
+      # (https://devcenter.heroku.com/articles/deploy-hooks#customizing-messages)
+      params = {
+        :apiKey => api_key,
+        :branch => "master",
+        :revision => "{{head_long}}",
+        :releaseStage => heroku_env["RAILS_ENV"] || ENV["RAILS_ENV"] || "production"
+      }
+      repo = `git config --get remote.origin.url`.strip
+      params[:repository] = repo unless repo.empty?
+
+      # Add the hook
+      url = "https://notify.bugsnag.com/deploy?" + params.map {|k,v| "#{k}=#{v}"}.join("&")
+      command = "heroku addons:add deployhooks:http --url=\"#{url}\""
+      command += " --app #{ENV["HEROKU_APP"]}" if ENV["HEROKU_APP"]
+
+      puts "$ #{command}"
+      run_command.call(command)
+    end
+  end
+
 end
 
 task :load do

data/spec/rake_spec.rb

@@ -0,0 +1,64 @@
+require 'webmock/rspec'
+require 'rspec/expectations'
+require 'rspec/mocks'
+
+require 'webrick'
+
+describe "bugsnag rake", :always do
+
+  server = nil
+  queue = Queue.new
+  fixture_path = '../examples/rake'
+  exec_string = 'bundle exec rake bugsnag:deploy'
+  example_path = File.join(File.dirname(__FILE__), fixture_path)
+
+  before do
+    server = WEBrick::HTTPServer.new :Port => 0, :Logger => WEBrick::Log.new(STDOUT), :AccessLog => []
+    server.mount_proc '/deploy' do |req, res|
+      queue.push req.body
+      res.status = 200
+      res.body = "OK\n"
+    end
+    Thread.new{ server.start }
+  end
+
+  after do
+    server.stop
+    queue.clear
+  end
+
+  let(:request) { JSON.parse(queue.pop) }
+  
+  it "sends a deploy notification to the set endpoint" do
+    ENV['BUGSNAG_ENDPOINT'] = "http://localhost:" + server.config[:Port].to_s + "/deploy"
+    ENV['BUGSNAG_API_KEY'] = "YOUR_API_KEY"
+    
+    Dir.chdir(example_path) do
+      system(exec_string)
+    end
+
+    payload = request()
+    expect(payload["apiKey"]).to eq('YOUR_API_KEY')
+  end
+
+  it "allows modifications of deployment characteristics" do
+    ENV['BUGSNAG_ENDPOINT'] = "http://localhost:" + server.config[:Port].to_s + "/deploy"
+    ENV['BUGSNAG_API_KEY'] = "this is a test key"
+    ENV['BUGSNAG_RELEASE_STAGE'] = "test"
+    ENV['BUGSNAG_REVISION'] = "test"
+    ENV['BUGSNAG_APP_VERSION'] = "1"
+    ENV['BUGSNAG_REPOSITORY'] = "test@repo.com:test/test_repo.git"
+
+    Dir.chdir(example_path) do
+      system(exec_string)
+    end
+
+    payload = request()
+    expect(payload["apiKey"]).to eq('this is a test key')
+    expect(payload["releaseStage"]).to eq('test')
+    expect(payload["repository"]).to eq("test@repo.com:test/test_repo.git")
+    expect(payload["appVersion"]).to eq("1")
+    expect(payload["revision"]).to eq("test")
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-capistrano
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Keegan Lowenstein
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-11-23 00:00:00.000000000 Z
 dependencies: []
 description: Correlate Capistrano deploys with new errors and increased error rates
   in Bugsnag
@@ -23,8 +23,8 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -42,6 +42,7 @@ files:
 - lib/bugsnag-capistrano/tasks/bugsnag.cap
 - spec/capistrano_spec.rb
 - spec/deploy_spec.rb
+- spec/rake_spec.rb
 homepage: http://github.com/bugsnag/bugsnag-capistrano
 licenses:
 - MIT
@@ -52,17 +53,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Notify Bugsnag when deploying with Capistrano