bugsnag-capistrano 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79c3760c59cce6a32240955ba0ffb0604c789135
-  data.tar.gz: 69b90256827c6e24a07f7a1e9491337a0c5e9cee
+SHA256:
+  metadata.gz: 3168c9e9326354256532148f5b3e4549c265ed24f5e2839d1acdad19dc11aae6
+  data.tar.gz: 168d0ce8410d7bb134a3c25e3419c3fa443fa3f87c261fc3e206fdb713780203
 SHA512:
-  metadata.gz: f7c991ec8c557f2d2e6ce823b2b9b24ec21daf4bf532a568b389f4824f81f64144402c09e49d854807314409d9777430ca5540c86aab5fcdeeb44bf280b568c0
-  data.tar.gz: 35c9f306c9abae72d6a3eb2c89102163b8f801c98e3f7d040a92dce882bab119cf1efa826891600d816c793bfbb440c049a2c5031464c321cfdb8538b0d93045
+  metadata.gz: 7ded5c9418e59257e5fb753df27810d85e1d7577c65551fb35f250379f41bf131e3187f30c740a6dc70792e851381a1227316a6cf56be4d09cf4e01444eb4bf6
+  data.tar.gz: 384d6f05fcec38924bf69e26f6d54ccd0953c55c6d79145660257729f95561b7f1bfb898df7f51b4eea5671e4e06a454f8833d46b6e39756a7af75bc68902613

data/.github/ISSUE_TEMPLATE/A.md

@@ -0,0 +1,14 @@
+---
+name: Having trouble getting started?
+about: Please contact us at support@bugsnag.com for assistance with integrating Bugsnag
+  into your application.
+title: ''
+labels: ''
+assignees: ''
+
+---
+Please checkout our [documentation](https://docs.bugsnag.com/build-integrations/capistrano/) for guides, references and tutorials.
+
+If you have questions about your integration please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).
+
+Alternatively, view additional options at [support.md](../SUPPORT.md).

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,50 @@
+---
+name: Bug report
+about: Create a report to help us improve the library
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Before raising, please check if somebody else has already reported your issue. -->
+
+### Describe the bug
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Environment
+* Bugsnag version:
+* Ruby version:
+* Bundle version:
+* Capfile:
+
+<!--
+  Below are a few approaches you might take to communicate the issue, in
+  descending order of awesomeness. Please choose one and feel free to delete
+  the others from this template.
+-->
+
+### Example Repo <!-- Option 1 -->
+
+- [ ] Create a minimal repository that can reproduce the issue
+- [ ] Link to it here:
+
+### Example code snippet <!-- Option 2 -->
+
+```
+# (Insert code sample to reproduce the problem)
+```
+
+<!-- Error messages, if any -->
+<details><summary>Error messages:</summary>
+
+```
+
+```
+</details>

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Before creating, please check if somebody else has already reported your feature request. -->
+
+### Description
+<!-- Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+-->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+<!--Add any other context about the feature request here.-->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Goal
+
+<!-- Why is this change necessary? -->
+
+## Design
+
+<!-- Why was this approach used? -->
+
+## Changeset
+
+<!-- What changed? -->
+
+## Testing
+
+<!-- How was it tested? What manual and automated tests were
+     run/added? -->

data/.github/support.md

@@ -0,0 +1,22 @@
+## Are you having trouble getting started?
+If you haven't already, please checkout our [documentation](https://docs.bugsnag.com/build-integrations/capistrano/) for guides, references and tutorials.
+
+Or, if you wish you can [contact us directly](mailto:support@bugsnag.com) for assistance on integrating Bugsnag into your application, troubleshooting an issue or a question about our supported features.
+
+When contacting support, please include as much information as necessary, including:
+
+- example code snippet
+- steps to reproduce
+- expected/actual behaviour 
+
+* Bugsnag version:
+* Ruby version:
+* Bundle version:
+* Capfile:
+
+## Bug or Feature Requests
+If you would like to raise a bug or feature request please do so by creating a [New Issue](https://github.com/bugsnag/bugsnag-capistrano/issues/new/choose) and selecting bug or feature.
+Please note: we cannot promise that we will fulfil all requests
+
+## Pull Requests
+If you have made a fix and would like to raise a pull request, please read our [CONTRIBUTING.md](../CONTRIBUTING.md) file before creating the pull request.

data/.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.0', '2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+        use-capistrano-2: ['false']
+        include:
+          - ruby-version: '2.0'
+            use-capistrano-2: 'true'
+          - ruby-version: '2.1'
+            use-capistrano-2: 'true'
+
+    env:
+      BUNDLE_WITH: test
+      CAP_2_TEST: ${{ matrix.use-capistrano-2 }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - run: bundle info capistrano
+
+      - run: bundle exec rake spec

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 2.1.0 (13-07-2021)
+
+### Enhancements
+
+* Allow using a Bugsnag-specific repo URL with a new `:bugsnag_repo_url` variable
+  | [#22](https://github.com/bugsnag/bugsnag-capistrano/pull/22)
+  | [Simon](https://github.com/stoivo)
+
+## 2.0.0 (03-04-2018)
+
+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
+
+* 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)
+
+### Fixes
+
+* Load BUGSNAG_RELEASE_STAGE before RAILS_ENV
+  | [#6](https://github.com/bugsnag/bugsnag-capistrano/pull/6)
+  | [Samnang Chhun](https://github.com/samnang)
+
 ## 1.1.0 (23-11-2017)
 
 ### Enhancements

data/CONTRIBUTING.md

@@ -64,7 +64,8 @@ bugsnag-capistrano.
 * Release to RubyGems
 
     ```
-    bundle exec rake release
+    gem build bugsnag-capistrano.gemspec
+    gem push bugsnag-capistrano-[version].gem
     ```
 
 * Update docs.bugsnag.com with any new content

data/Gemfile

@@ -8,10 +8,13 @@ group :test, optional: true do
   gem 'addressable', '~>2.3.8'
   gem 'webmock', RUBY_VERSION <= '1.9.3' ? '2.3.2': '>2.3.2'
   gem 'capistrano', ENV['CAP_2_TEST'] == 'true' ? '~> 2.15.0': '~> 3.9.0'
-end
 
-group :bugsnag, optional: true do
-  gem 'bugsnag', '~> 6.0'
+  # WEBrick is no longer in the stdlib in Ruby 3.0
+  gem 'webrick' if RUBY_VERSION >= '3.0.0'
+  gem 'rexml', '< 3.2.5' if RUBY_VERSION == '2.0.0'
+
+  # i18n added a call to Module#using in 1.3.0, which doesn't exist until Ruby 2.1
+  gem 'i18n', '< 1.3.0' if RUBY_VERSION == '2.0.0'
 end
 
 gemspec

data/README.md

@@ -1,5 +1,4 @@
 # Bugsnag deploy tracking with Capistrano
-[![Build status](https://travis-ci.org/bugsnag/bugsnag-capistrano.svg?branch=master)](https://travis-ci.org/bugsnag/bugsnag-capistrano)
 
 Bugsnag Capistrano automatically notifies Bugsnag when you deploy your
 application with [Capistrano](https://github.com/capistrano/capistrano),
@@ -16,8 +15,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

@@ -1,16 +1,5 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
-require 'bundler/gem_tasks'
-begin
-  Bundler.setup(:default)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -25,14 +14,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.0
+2.1.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)
+                :repository => fetch(:bugsnag_repo_url, fetch(:repo_url, ENV["BUGSNAG_REPOSITORY"])),
+                :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