bugsnag-capistrano 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f6f524f128bab3669bce3a96d112179743da22a18f4d44d428f7ac745714b051
-  data.tar.gz: 7f60bb949db8f888a5567220a31b9fd90bc4ff18861076e7f89e4f399c37427a
+SHA1:
+  metadata.gz: d7777843eff43a04d774d3bdee4d5a88dd73d6b1
+  data.tar.gz: 8289fc24a6372a988304b5195458c4d5552e06db
 SHA512:
-  metadata.gz: 192f1dbb3273b4861004b49168b1ac11132c2b99fc1adc4114790ff31408581d5efa8d4e029c839869fd690019f61957a04e84679bed57598172af2d8bf4d287
-  data.tar.gz: e56422aa7e466ca375bb906a48606c40084de29bd8f54abe2b84a2091c41724dafc73fea00d0efbe7f1f3955966311c9c882a419e51f495971c400cea20a1fc8
+  metadata.gz: 7aba8fdb6fa4637c860f7648d418bc94c65252b900ff780828389572df7b81bdb82a6de1ed29e6cc7f2f5500ce5b5fe2fd0e5971dbec077e919839a50e7e80e7
+  data.tar.gz: 30486a327c9896b6a0d0bb2756f2e35a3e2787cf33a311d5db8f44d6b57358e6a0bd448b3f369bedb47ab6020c470e274c3287c774f30dda88e26529a97bf7ad

data/CHANGELOG.md

@@ -1,9 +1,11 @@
-## 1.1.2 (06-06-2018)
+## 2.0.0 (03-04-2018)
 
-### Fixes
+Major changes have been made with the 2.0.0 release. For a full list please consult the [upgrading guide](https://github.com/bugsnag/bugsnag-capistrano/blob/master/UPGRADING.md).
+
+### Enhancements
 
-* Fixes a case where deployment notifications were delivered to an incorrect
-  endpoint, causing them to not appear on the dashboard timeline
+* Rewritten tool to notify [Bugsnag Build API](https://docs.bugsnag.com/build-integrations/)
+  | [#13](https://github.com/bugsnag/bugsnag-capistrano/pull/13)
 
 ## 1.1.1 (14-12-2017)
 

data/Gemfile

@@ -10,8 +10,4 @@ group :test, optional: true do
   gem 'capistrano', ENV['CAP_2_TEST'] == 'true' ? '~> 2.15.0': '~> 3.9.0'
 end
 
-group :bugsnag, optional: true do
-  gem 'bugsnag', '~> 6.0'
-end
-
 gemspec

data/README.md

@@ -16,8 +16,7 @@ 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/)
+* [Integrating with Capistrano](https://docs.bugsnag.com/build-integrations/capistrano/)
 
 ## Contributing
 

data/Rakefile

@@ -25,14 +25,7 @@ end
 require 'rspec/core'
 require "rspec/core/rake_task"
 
-tags = '--format documentation --tag always '
-
-begin
-  require 'bugsnag'
-  tags += '--tag with_notifier '
-rescue LoadError
-  tags += '--tag without_notifier '
-end
+tags = '--format documentation'
 
 RSpec::Core::RakeTask.new(:spec) do |opts|
   opts.rspec_opts = tags

data/UPGRADING.md

@@ -0,0 +1,27 @@
+# Upgrade Guide
+
+## 1.x to 2.x
+
+_Our Capistrano build-integration has changed to accommodate changes to our [Build API](https://docs.bugsnag.com/build-integrations/), and there may be changes required to continue to notify of your Capistrano releases_
+
+#### Heroku
+
+Heroku deployment notifications have been removed from this gem. You can find information on how to set up a Heroku deploy hook at [our documentation](https://docs.bugsnag.com/build-integrations/heroku/).
+
+#### Rake
+
+Rake deployment notifications have been removed from this gem. While we don't have an explicit replacement for the Rake tasks, information on how to send a build notification can be found in [our Build API documentation](https://docs.bugsnag.com/build-integrations/).
+
+#### Task names
+
+The task `:deploy` has been renamed to `:release`. Any references to it should be renamed accordingly.
+
+#### Configuration
+
+- `branch` has been removed.
+- `bugsnag_builder` has been added. This should be the name of the person or machine that has triggered the release. Can also be set using the environment variables `BUGSNAG_BUILDER_NAME` or `USER`.  Will default to the result of the `whoami` command on the releasing machine.
+- `bugsnag_auto_assign_release` has been added.  Thi#s will ensure **all** event notifications received will be assigned to this release. This should only be used if you are not using the `app_version` configuration option within your application.  Can be set using the environment variable `BUGSNAG_AUTO_ASSIGN_RELEASE`.  Will default to `false`.
+- `bugsnag_source_control_provider` has been added. This contains the type of on-premise server the application uses for source-control, and therefore should only be used if an on-premise source-control solution is used. Valid settings are: `github-enterprise`, `gitlab-onpremise`, and `bitbucket-server`. Can be set using the environment variable `BUGSNAG_SOURCE_CONTROL_PROVIDER`. Defaults to `nil`.
+- `bugsnag-metadata` has been added. This should be a hash containing any additional data you wish to attach to your release notification.
+
+A full list of configuration options can be found at the [Capistrano build-integration guide](https://docs.bugsnag.com/build-integrations/capistrano/).

data/VERSION

@@ -1 +1 @@
-1.1.2
+2.0.0

data/lib/bugsnag-capistrano/capistrano.rb

@@ -1,4 +1,4 @@
-require_relative "deploy"
+require_relative "release"
 
 if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
   load File.expand_path('../tasks/bugsnag.cap', __FILE__)

data/lib/bugsnag-capistrano/capistrano2.rb

@@ -2,25 +2,28 @@ module Bugsnag
   module Capistrano
     def self.load_into(configuration)
       configuration.load do
-        after "deploy",            "bugsnag:deploy"
-        after "deploy:migrations", "bugsnag:deploy"
+        after "deploy",            "bugsnag:release"
 
         namespace :bugsnag do
-          desc "Notify Bugsnag that new production code has been deployed"
-          task :deploy, :except => { :no_release => true }, :on_error => :continue do
+          desc "Notify Bugsnag that new production code has been released"
+          task :release, :except => { :no_release => true }, :on_error => :continue do
             begin
-              Bugsnag::Capistrano::Deploy.notify({
+              auto_assign_release_bool = ENV["BUGSNAG_AUTO_ASSIGN_RELEASE"] == 'true'
+              Bugsnag::Capistrano::Release.notify({
                 :api_key => fetch(:bugsnag_api_key, ENV["BUGSNAG_API_KEY"]),
+                :app_version => fetch(:app_version, ENV["BUGSNAG_APP_VERSION"]),
+                :auto_assign_release => fetch(:bugsnag_auto_assign_release, auto_assign_release_bool),
+                :builder_name => fetch(:bugsnag_builder, ENV["BUGSNAG_BUILDER_NAME"] || ENV["USER"]),
+                :metadata => fetch(:bugsnag_metadata, nil),
                 :release_stage => fetch(:bugsnag_env) || ENV["BUGSNAG_RELEASE_STAGE"] || fetch(:rails_env) || fetch(:stage) || "production",
                 :revision => fetch(:current_revision, ENV["BUGSNAG_REVISION"]),
                 :repository => fetch(:repo_url, ENV["BUGSNAG_REPOSITORY"]),
-                :branch => fetch(:branch, ENV["BUGSNAG_BRANCH"]),
-                :app_version => fetch(:app_version, ENV["BUGSNAG_APP_VERSION"]),
-                :endpoint => fetch(:bugsnag_endpoint)
+                :source_control_provider => fetch(:bugsnag_source_control_provider, ENV["BUGSNAG_SOURCE_CONTROL_PROVIDER"]),
+                :endpoint => fetch(:bugsnag_endpoint, nil)
               })
-              logger.info "Bugsnag deploy notification complete."
+              logger.info "Bugsnag release notification complete."
             rescue
-              logger.important("Bugnsag deploy notification failed, #{$!.inspect}")
+              logger.important("Bugsnag release notification failed, #{$!.inspect}")
             end
           end
         end

data/lib/bugsnag-capistrano/release.rb

@@ -0,0 +1,85 @@
+require "json"
+require "net/http"
+require "logger"
+
+module Bugsnag
+  module Capistrano
+    class Release
+
+      HEADERS = {"Content-Type" => "application/json"}
+      DEFAULT_BUILD_ENDPOINT = "https://build.bugsnag.com/"
+      DEFAULT_BUILD_TOOL_NAME = "bugsnag-capistrano"
+
+      def self.notify(opts = {})
+        # Try and get some config from Bugsnag
+        begin
+          require 'bugsnag'
+
+          opts[:api_key] ||= Bugsnag.configuration.api_key
+          opts[:app_version] ||= Bugsnag.configuration.app_version
+          opts[:release_stage] ||= Bugsnag.configuration.release_stage
+        rescue LoadError
+        end
+
+        opts[:endpoint] ||= DEFAULT_BUILD_ENDPOINT
+        opts[:builder_name] ||= `whoami`
+        opts[:build_tool] ||= DEFAULT_BUILD_TOOL_NAME
+
+        parameters = {
+          "apiKey" => opts[:api_key],
+          "appVersion" => opts[:app_version],
+          "autoAssignRelease" => opts[:auto_assign_release],
+          "builderName" => opts[:builder_name],
+          "buildTool" => opts[:build_tool],
+          "metadata" => opts[:metadata],
+          "releaseStage" => opts[:release_stage],
+          "sourceControl" => {
+            "provider" => opts[:source_control_provider],
+            "revision" => opts[:revision],
+            "repository" => opts[:repository]
+          }
+        }
+
+        if parameters["apiKey"].nil?
+          logger.warn("Cannot deliver notification. Missing required apiKey")
+        elsif parameters["appVersion"].nil?
+          logger.warn("Cannot deliver notification. Missing required appVersion")
+        else
+          payload_string = ::JSON.dump(parameters)
+          self.deliver(opts[:endpoint], payload_string)
+        end
+      end
+
+      def self.deliver(url, body)
+        begin
+          request(url, body)
+        rescue StandardError => e
+          logger.warn("Notification to #{url} failed, #{e.inspect}")
+          logger.warn(e.backtrace)
+        end
+      end
+
+      def self.request(url, body)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = 15
+        http.open_timeout = 15
+
+        http.use_ssl = uri.scheme == "https"
+
+        uri.path == "" ? "/" : uri.path
+        request = Net::HTTP::Post.new(uri, HEADERS)
+        request.body = body
+        http.request(request)
+      end
+
+      def self.logger
+        if @logger.nil?
+          @logger = Logger.new(STDOUT)
+          @logger.level = Logger::INFO
+        end
+        @logger
+      end
+    end
+  end
+end

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

@@ -1,46 +1,42 @@
 namespace :load do
-
   task :defaults do
-
     set :bugsnag_default_hooks, ->{ true }
-
   end
-
 end
 
 namespace :deploy do
-
   before :starting, :bugsnag_hooks do
     invoke 'bugsnag:add_default_hooks' if fetch(:bugsnag_default_hooks)
   end
-
 end
 
 namespace :bugsnag do
-
   task :add_default_hooks do
-    after 'deploy:published', 'bugsnag:deploy'
+    after 'deploy:published', 'bugsnag:release'
   end
 
-  desc 'Notify Bugsnag that new production code has been deployed'
-  task :deploy do
+  desc 'Notify Bugsnag that new production code has been released'
+  task :release do
     run_locally do
       begin
-        Bugsnag::Capistrano::Deploy.notify({
+        auto_assign_release_bool = ENV["BUGSNAG_AUTO_ASSIGN_RELEASE"] == 'true'
+        Bugsnag::Capistrano::Release.notify({
           :api_key => fetch(:bugsnag_api_key, ENV["BUGSNAG_API_KEY"]),
+          :app_version => fetch(:app_version, ENV["BUGSNAG_APP_VERSION"]),
+          :auto_assign_release => fetch(:bugsnag_auto_assign_release, auto_assign_release_bool),
+          :builder_name => fetch(:bugsnag_builder, ENV["BUGSNAG_BUILDER_NAME"] || ENV["USER"]),
+          :metadata => fetch(:bugsnag_metadata),
           :release_stage => fetch(:bugsnag_env) || ENV["BUGSNAG_RELEASE_STAGE"] || fetch(:rails_env) || fetch(:stage) || "production",
           :revision => fetch(:current_revision, ENV["BUGSNAG_REVISION"]),
           :repository => fetch(:repo_url, ENV["BUGSNAG_REPOSITORY"]),
-          :branch => fetch(:branch, ENV["BUGSNAG_BRANCH"]),
-          :app_version => fetch(:app_version, ENV["BUGSNAG_APP_VERSION"]),
+          :source_control_provider => fetch(:bugsnag_source_control_provider, ENV["BUGSNAG_SOURCE_CONTROL_PROVIDER"]),
           :endpoint => fetch(:bugsnag_endpoint)
         })
-        info 'Bugsnag deploy notification complete.'
+        info 'Bugsnag release notification complete.'
       rescue
-        error "Bugsnag deploy notification failed, #{$!.inspect}"
+        error "Bugsnag release notification failed, #{$!.inspect}"
       end
     end
   end
-
 end
 # vi:ft=ruby

data/spec/capistrano_spec.rb

@@ -4,7 +4,7 @@ require 'rspec/mocks'
 
 require 'webrick'
 
-describe "bugsnag capistrano", :always do
+describe "bugsnag capistrano" do
 
   server = nil
   queue = Queue.new
@@ -29,16 +29,18 @@ describe "bugsnag capistrano", :always do
   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_APP_VERSION'] = "1"
+
     Dir.chdir(example_path) do
       system(exec_string)
     end
 
     payload = request()
     expect(payload["apiKey"]).to eq('YOUR_API_KEY')
+    expect(payload["appVersion"]).to eq("1")
     expect(payload["releaseStage"]).to eq('production')
   end
 
@@ -49,6 +51,8 @@ describe "bugsnag capistrano", :always do
     ENV['BUGSNAG_REVISION'] = "test"
     ENV['BUGSNAG_APP_VERSION'] = "1"
     ENV['BUGSNAG_REPOSITORY'] = "test@repo.com:test/test_repo.git"
+    ENV['BUGSNAG_SOURCE_CONTROL_PROVIDER'] = "github"
+    ENV['BUGSNAG_AUTO_ASSIGN_RELEASE'] = 'true'
 
     Dir.chdir(example_path) do
       system(exec_string)
@@ -57,9 +61,12 @@ describe "bugsnag capistrano", :always do
     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")
+    expect(payload["sourceControl"]).to_not be_nil
+    expect(payload["sourceControl"]["revision"]).to eq("test")
+    expect(payload["sourceControl"]["repository"]).to eq("test@repo.com:test/test_repo.git")
+    expect(payload["sourceControl"]["provider"]).to eq("github")
+    expect(payload["autoAssignRelease"]).to eq(true)
   end
 end
 

data/spec/release_spec.rb

@@ -0,0 +1,96 @@
+require 'webmock/rspec'
+require 'rspec/expectations'
+require 'rspec/mocks'
+require 'logger'
+require 'json'
+
+require 'webrick'
+
+require 'bugsnag-capistrano/release'
+
+module Bugsnag::Capistrano
+  class Release
+    attr_accessor :logger
+  end
+end
+
+describe Bugsnag::Capistrano::Release do
+  it "should call notify_without bugsnag" do
+    expect(Bugsnag::Capistrano::Release).to receive(:deliver)
+    Bugsnag::Capistrano::Release.notify({:api_key => "test", :app_version => "1"})
+  end
+
+  it "delivers a request to the given url" do
+    url = "http://localhost:56456"
+    stub_request(:post, url)
+      .to_return(status:200, body: "")
+    Bugsnag::Capistrano::Release.deliver(url, nil)
+  end
+
+  it "delivers a body unmodified" do
+    body = ::JSON.dump({
+      "paramA" => 'a',
+      "paramB" => 'b',
+      "paramHash" => {
+        "one" => 1,
+        "two" => 2,
+        "three" => 3
+      }
+    })
+    url = "http://localhost:56456"
+    request = stub_request(:post, url)
+      .with(body: body, headers: { 'Content-Type' => 'application/json'})
+      .to_return(status:200, body: "")
+    Bugsnag::Capistrano::Release.deliver(url, body)
+    assert_requested request
+  end
+
+  it "cannot send without an apikey" do
+    expect(Bugsnag::Capistrano::Release).to_not receive(:deliver)
+    expect(Bugsnag::Capistrano::Release.logger).to receive(:warn).with("Cannot deliver notification. Missing required apiKey")
+
+    Bugsnag::Capistrano::Release.notify()
+  end
+
+  it "cannot send without an appVersion" do
+    expect(Bugsnag::Capistrano::Release).to_not receive(:deliver)
+    expect(Bugsnag::Capistrano::Release.logger).to receive(:warn).with("Cannot deliver notification. Missing required appVersion")
+
+    Bugsnag::Capistrano::Release.notify({:api_key => "test"})
+  end
+
+  context "with bugsnag installed" do
+    before do
+      module Kernel
+        alias_method :old_require, :require
+        def require(path)
+          old_require(path) unless /^bugsnag/.match(path)
+        end
+      end
+    end
+
+    it "gets information from bugsnag configuration if available" do
+      config = double
+      allow(config).to receive(:api_key).and_return("bugsnag_api_key")
+      allow(config).to receive(:app_version).and_return("bugsnag_app_version")
+      allow(config).to receive(:release_stage).and_return("bugsnag_release_stage")
+
+      allow(Bugsnag).to receive(:configuration).and_return(config)
+      expect(Bugsnag::Capistrano::Release).to receive(:deliver) do |uri, body_string|
+        expect(uri).to eq(Bugsnag::Capistrano::Release::DEFAULT_BUILD_ENDPOINT)
+        body = ::JSON.parse(body_string)
+        expect(body["apiKey"]).to eq("bugsnag_api_key")
+        expect(body["appVersion"]).to eq("bugsnag_app_version")
+        expect(body["releaseStage"]).to eq("bugsnag_release_stage")
+      end
+
+      Bugsnag::Capistrano::Release.notify()
+    end
+
+    after do
+      module Kernel
+        alias_method :require, :old_require
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-capistrano
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Keegan Lowenstein
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies: []
 description: Correlate Capistrano deploys with new errors and increased error rates
   in Bugsnag
@@ -31,18 +31,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING.md
 - VERSION
 - bugsnag-capistrano.gemspec
 - lib/bugsnag-capistrano.rb
 - lib/bugsnag-capistrano/capistrano.rb
 - lib/bugsnag-capistrano/capistrano2.rb
-- lib/bugsnag-capistrano/deploy.rb
-- lib/bugsnag-capistrano/tasks.rb
-- lib/bugsnag-capistrano/tasks/bugsnag-capistrano.rake
+- lib/bugsnag-capistrano/release.rb
 - lib/bugsnag-capistrano/tasks/bugsnag.cap
 - spec/capistrano_spec.rb
-- spec/deploy_spec.rb
-- spec/rake_spec.rb
+- spec/release_spec.rb
 homepage: http://github.com/bugsnag/bugsnag-capistrano
 licenses:
 - MIT
@@ -63,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Notify Bugsnag when deploying with Capistrano

data/lib/bugsnag-capistrano/deploy.rb

@@ -1,98 +0,0 @@
-require "json"
-require "net/http"
-require "logger"
-
-module Bugsnag
-  module Capistrano
-    class Deploy
-
-      HEADERS = {"Content-Type" => "application/json"}
-      DEFAULT_DEPLOY_ENDPOINT = "https://notify.bugsnag.com/deploy"
-
-      def self.notify(opts = {})
-        begin
-          require 'bugsnag'
-          self.notify_using_bugsnag(opts)
-        rescue LoadError
-          self.notify_without_bugsnag(opts)
-        end
-      end
-
-      def self.notify_using_bugsnag(opts = {})
-
-        configuration = Bugsnag.configuration.dup
-
-        [:api_key, :app_version, :release_stage, :endpoint, :use_ssl,
-        :proxy_host, :proxy_port, :proxy_user, :proxy_password].each do |param|
-          unless opts[param].nil?
-            configuration.send :"#{param}=", opts[param]
-          end
-        end
-
-        if Gem::Version.new(Bugsnag::VERSION).release >= Gem::Version.new('6.0.0')
-          endpoint = configuration.endpoint + '/deploy'
-        else
-          endpoint = (configuration.use_ssl ? "https://" : "http://") + configuration.endpoint + '/deploy'
-        end
-
-        parameters = {
-          "apiKey" => configuration.api_key,
-          "releaseStage" => configuration.release_stage,
-          "appVersion" => configuration.app_version,
-          "revision" => opts[:revision],
-          "repository" => opts[:repository],
-          "branch" => opts[:branch]
-        }.reject {|k,v| v == nil}
-
-        raise RuntimeError.new("No API key found when notifying of deploy") if !parameters["apiKey"] || parameters["apiKey"].empty?
-
-
-        payload_string = ::JSON.dump(parameters)
-        Bugsnag::Delivery::Synchronous.deliver(endpoint, payload_string, configuration)
-      end
-      
-      def self.notify_without_bugsnag(opts = {})
-        endpoint = (opts[:endpoint].nil? ? DEFAULT_DEPLOY_ENDPOINT : opts[:endpoint])
-
-        parameters = {
-          "apiKey" => opts[:api_key],
-          "releaseStage" => opts[:release_stage],
-          "appVersion" => opts[:app_version],
-          "revision" => opts[:revision],
-          "repository" => opts[:repository],
-          "branch" => opts[:branch]
-        }.reject {|k, v| v == nil}
-        
-        raise RuntimeError.new("No API key found when notifying of deploy") if !parameters["apiKey"] || parameters["apiKey"].empty?
-
-        payload_string = ::JSON.dump(parameters)
-        self.deliver(endpoint, payload_string)
-      end
-
-      def self.deliver(url, body)
-        logger = Logger.new(STDOUT)
-        logger.level = Logger::INFO
-        begin
-          request(url, body)
-        rescue StandardError => e
-          logger.warn("Notification to #{url} failed, #{e.inspect}")
-          logger.warn(e.backtrace)
-        end
-      end
- 
-      def self.request(url, body)
-        uri = URI.parse(url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.read_timeout = 15
-        http.open_timeout = 15
-
-        http.use_ssl = uri.scheme == "https"
-
-        uri.path == "" ? "/" : uri.path
-        request = Net::HTTP::Post.new(uri, HEADERS)
-        request.body = body
-        http.request(request)
-      end
-    end
-  end
-end

data/lib/bugsnag-capistrano/tasks.rb

@@ -1,2 +0,0 @@
-require_relative 'deploy'
-load File.join(File.dirname(File.expand_path(__FILE__)), 'tasks/bugsnag-capistrano.rake')

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

@@ -1,85 +0,0 @@
-require "bugsnag-capistrano/deploy"
-
-namespace :bugsnag do
-
-  desc "Notify Bugsnag of a new deploy."
-  task :deploy do
-    api_key = ENV["BUGSNAG_API_KEY"]
-    release_stage = ENV["BUGSNAG_RELEASE_STAGE"]
-    app_version = ENV["BUGSNAG_APP_VERSION"]
-    revision = ENV["BUGSNAG_REVISION"]
-    repository = ENV["BUGSNAG_REPOSITORY"]
-    branch = ENV["BUGSNAG_BRANCH"]
-    endpoint = ENV["BUGSNAG_ENDPOINT"]
-
-    Rake::Task["load"].invoke unless api_key
-    
-    Bugsnag::Capistrano::Deploy.notify({
-      :api_key => api_key,
-      :release_stage => release_stage,
-      :app_version => app_version,
-      :revision => revision,
-      :repository => repository,
-      :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["BUGSNAG_RELEASE_STAGE"] || 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
-  begin
-    Rake::Task["environment"].invoke
-  rescue
-  end
-end

data/spec/deploy_spec.rb

@@ -1,97 +0,0 @@
-require 'webmock/rspec'
-require 'rspec/expectations'
-require 'rspec/mocks'
-require 'logger'
-require 'json'
-
-require 'webrick'
-
-require 'bugsnag-capistrano/deploy'
-
-describe Bugsnag::Capistrano::Deploy do
-  describe "with notifier loadable", :with_notifier do
-
-    before do
-      require "bugsnag"
-      Bugsnag.configure do |config|
-        config.api_key = "TEST_API_KEY"
-        config.release_stage = "production"
-        config.logger = Logger.new(StringIO.new)
-      end
-    end
-
-    after do
-      Bugsnag.configuration.clear_request_data
-    end
-    
-    it "should call notify_with_bugsnag" do
-      expect(Bugsnag::Delivery::Synchronous).to receive(:deliver).with(
-        "https://notify.bugsnag.com/deploy",
-        "{\"apiKey\":\"TEST_API_KEY\",\"releaseStage\":\"production\"}",
-        instance_of(Bugsnag::Configuration)
-      )
-      Bugsnag::Capistrano::Deploy.notify()
-    end
-
-    context "provide custom endpoint" do
-      before do
-        Bugsnag.configure do |config|
-          config.endpoint = "http://localhost:56302"
-        end
-      end
-
-      after do
-        Bugsnag.configure do |config|
-          config.endpoint = nil
-        end
-      end
-
-      it "uses the custom endpoint" do
-        expect(Bugsnag::Delivery::Synchronous).to receive(:deliver).with(
-          "http://localhost:56302/deploy",
-          "{\"apiKey\":\"TEST_API_KEY\",\"releaseStage\":\"production\"}",
-          instance_of(Bugsnag::Configuration)
-        )
-        Bugsnag::Capistrano::Deploy.notify()
-      end
-    end
-  end
-
-  describe "without notifier loadable", :without_notifier do
-    it "should call notify_without bugsnag" do
-      stub_request(:post, "https://notify.bugsnag.com/deploy").to_return(status:200, body: "")
-      expect(Bugsnag::Capistrano::Deploy).to receive(:deliver).with(
-        "https://notify.bugsnag.com/deploy",
-        "{\"apiKey\":\"test\"}"
-      )
-      Bugsnag::Capistrano::Deploy.notify({:api_key => "test"})
-    end
-  end
-
-  describe "the delivery function", :always do
-    it "delivers a request to the given url" do
-      url = "http://localhost:56456"
-      stub_request(:post, url)
-        .to_return(status:200, body: "")
-      Bugsnag::Capistrano::Deploy.deliver(url, nil)
-    end
-
-    it "delivers a body unmodified" do
-      body = ::JSON.dump({
-        "paramA" => 'a',
-        "paramB" => 'b',
-        "paramHash" => {
-          "one" => 1,
-          "two" => 2,
-          "three" => 3
-        }
-      })
-      url = "http://localhost:56456"
-      request = stub_request(:post, url)
-        .with(body: body, headers: { 'Content-Type' => 'application/json'})
-        .to_return(status:200, body: "")
-      Bugsnag::Capistrano::Deploy.deliver(url, body)
-      assert_requested request
-    end
-  end
-end

data/spec/rake_spec.rb

@@ -1,64 +0,0 @@
-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
-