bugsnag-capistrano 1.1.0 → 2.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative './helpers/server'
+require_relative './helpers/capistrano'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-capistrano
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Keegan Lowenstein
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies: []
 description: Correlate Capistrano deploys with new errors and increased error rates
   in Bugsnag
@@ -23,26 +23,32 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
+- ".github/ISSUE_TEMPLATE/A.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/support.md"
+- ".github/workflows/tests.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - 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/helpers/capistrano.rb
+- spec/helpers/server.rb
+- spec/release_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/bugsnag/bugsnag-capistrano
 licenses:
 - MIT
@@ -62,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.11
 signing_key: 
 specification_version: 4
 summary: Notify Bugsnag when deploying with Capistrano

data/.travis.yml

@@ -1,77 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-before_install:
-- gem update --system 2.6.11
-- gem install bundler -v 1.12.0
-- gem --version
-
-before_script:
-- bundle list | grep 'bugsnag\|capistrano'
-script: bundle exec rake spec
-
-jobs:
-  include:
-  # JRuby 1.9
-  - stage: test
-    env: CAP_2_TEST=true
-    install: bundle _1.12.0_ install --with test bugsnag
-    rvm: jruby-19mode
-  - stage: test
-    env: CAP_2_TEST=true
-    install: bundle _1.12.0_ install --with test --without bugsnag
-    rvm: jruby-19mode
-  - stage: test
-    install: bundle _1.12.0_ install --with test bugsnag
-    rvm: jruby-19mode
-  - stage: test
-    install: bundle _1.12.0_ install --with test --without bugsnag
-    rvm: jruby-19mode
-
-  # Ruby 2.0.0
-  - stage: test
-    env: CAP_2_TEST=true
-    install: bundle install --with test bugsnag --binstubs
-    rvm: 2.0.0
-  - stage: test
-    env: CAP_2_TEST=true
-    install: bundle install --with test --without bugsnag --binstubs
-    rvm: 2.0.0
-  - stage: test
-    install: bundle install --with test bugsnag --binstubs
-    rvm: 2.0.0
-  - stage: test
-    install: bundle install --with test --without bugsnag --binstubs
-    rvm: 2.0.0
-
-  # Ruby 2.1.10
-  - stage: test
-    env: CAP_2_TEST=true
-    install: bundle install --with test bugsnag --binstubs
-    rvm: 2.1.10
-  - stage: test
-    env: CAP_2_TEST=true
-    install: bundle install --with test --without bugsnag --binstubs
-    rvm: 2.1.10
-  - stage: test
-    install: bundle install --with test bugsnag --binstubs
-    rvm: 2.1.10
-  - stage: test
-    install: bundle install --with test --without bugsnag --binstubs
-    rvm: 2.1.10
-
-  # Ruby 2.3.0
-  - stage: test
-    install: bundle install --with test bugsnag --binstubs
-    rvm: 2.3.0
-  - stage: test
-    install: bundle install --with test --without bugsnag --binstubs
-    rvm: 2.3.0
-
-  # Ruby 2.4.2
-  - stage: test
-    install: bundle install --with test bugsnag --binstubs
-    rvm: 2.4.2
-  - stage: test
-    install: bundle install --with test --without bugsnag --binstubs
-    rvm: 2.4.2

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
-        else
-          endpoint = (configuration.use_ssl ? "https://" : "http://") + configuration.endpoint
-        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["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,66 +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)
-      Bugsnag::Capistrano::Deploy.notify()
-    end
-  end
-
-  describe "without notifier loadable", :without_notifier do
-    it "should call notify_without bugsnag" do
-      expect(Bugsnag::Capistrano::Deploy).to receive(:deliver)
-      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
-