defra_ruby_alert 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd752fb4d156ca20aa6c449a7a537ccc174b2749c738f086e8f1ba3834fefbf9
-  data.tar.gz: 8b7038c5c82b72d17c8e600de490becc8cd93686e61571c62a666493e2e1e842
+  metadata.gz: 3405f17d06604e4c71bfdf9617c2112434414096ed1a931679a164ea30dd3858
+  data.tar.gz: b7db1d0d918989e3d90cdd5aa9fa0bfbd51d82f0228088725c2df7bfb17f5f3a
 SHA512:
-  metadata.gz: 58fb7b1763a226d9b9e17625512242f0f641256dca858959ecc1cbba6de55e32170396bcc2f2ed79aff9a1ee47a43eb03aa11de7adc8113c54c6af3bcdc39f7d
-  data.tar.gz: 7668f51ade4c8a7debe50c56508521d984def72d73e561308d4bc1092151d2b58477445227ff7a9bd7baf18f6aeb4f057cd5f56e7a17085b3f74fc32afc3381f
+  metadata.gz: 6665fd599e7929ae90bdd901620909a4f068cdc8ed2c34232eab30d6d9b3065c440337deb7dafac1139def32205cf1c6a04995cef90f5435bc3b14efcf4c5d88
+  data.tar.gz: dfc6099e2fe16c8f6455c4a88172d3d9a2adea865eb97e30f4fa5bdb35142f08e6565dc8895d3a6d0cf835282a6fbe58ce0209d278b3d65e062202aa98727622

data/README.md

@@ -1,6 +1,6 @@
 # Defra Ruby Alert
 
-[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-alert.svg?branch=main)](https://travis-ci.com/DEFRA/defra-ruby-alert)
+![Build Status](https://github.com/DEFRA/defra-ruby-alert/workflows/CI/badge.svg?branch=main)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-alert&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-alert)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-alert&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-alert)
 [![security](https://hakiri.io/github/DEFRA/defra-ruby-alert/main.svg)](https://hakiri.io/github/DEFRA/defra-ruby-alert/main)

data/lib/defra_ruby/alert/airbrake_runner.rb

@@ -64,6 +64,17 @@ module DefraRuby
           # replaced.
           # https://github.com/airbrake/airbrake-ruby#blocklist_keys
           c.blocklist_keys = DefraRuby::Alert.configuration.blocklist
+
+          # Latest versions of Airbrake support performance stats being
+          # automatically sent to Airbrake. We actually use Errbit at Defra
+          # which doesn't support this feature. So all we see is lots of 404
+          # errors in our logs. To prevent this we disable this feature.
+          # https://github.com/airbrake/airbrake-ruby#performance_stats
+          c.performance_stats = false
+
+          # Prevent Airbrake from trying to auto-load remote config from Airbrake servers
+          # as this fails (our projects are not on Airbrake) and disables Airbrake in the app
+          c.remote_config = false
         end
       end
     end

data/lib/defra_ruby/alert/configuration.rb

@@ -3,8 +3,7 @@
 module DefraRuby
   module Alert
     class Configuration
-      attr_accessor :root_directory, :logger, :environment
-      attr_accessor :host, :project_key, :blocklist, :enabled
+      attr_accessor :root_directory, :logger, :environment, :host, :project_key, :blocklist, :enabled
 
       def initialize
         @blocklist = []

data/lib/defra_ruby/alert/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Alert
-    VERSION = "2.1.0"
+    VERSION = "2.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_alert
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake
@@ -24,132 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: defra_ruby_style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 description: Provides a single source of functionality for initialising and managing
   Alert in our apps.
 email:
@@ -168,22 +42,13 @@ files:
 - lib/defra_ruby/alert/airbrake_runner.rb
 - lib/defra_ruby/alert/configuration.rb
 - lib/defra_ruby/alert/version.rb
-- spec/defra_ruby/alert/airbrake_runner_spec.rb
-- spec/defra_ruby/alert/configuration_spec.rb
-- spec/defra_ruby/alert_spec.rb
-- spec/examples.txt
-- spec/spec_helper.rb
-- spec/support/defra_ruby_alert.rb
-- spec/support/dotenv.rb
-- spec/support/pry.rb
-- spec/support/simplecov.rb
-- spec/support/webmock.rb
 homepage: https://github.com/DEFRA/defra-ruby-alert
 licenses:
 - The Open Government Licence (OGL) Version 3
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,25 +56,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Defra ruby on rails Alert gem
-test_files:
-- spec/spec_helper.rb
-- spec/defra_ruby/alert_spec.rb
-- spec/defra_ruby/alert/configuration_spec.rb
-- spec/defra_ruby/alert/airbrake_runner_spec.rb
-- spec/examples.txt
-- spec/support/defra_ruby_alert.rb
-- spec/support/simplecov.rb
-- spec/support/webmock.rb
-- spec/support/pry.rb
-- spec/support/dotenv.rb
+test_files: []

data/spec/defra_ruby/alert/airbrake_runner_spec.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Alert
-    RSpec.describe AirbrakeRunner do
-      before do
-        DefraRuby::Alert.configure do |c|
-          c.enabled = enabled
-          c.host = host
-          c.project_key = project_key
-        end
-
-        allow(configuration).to receive_messages(
-          :host= => nil,
-          :project_key= => nil,
-          :project_id= => nil,
-          :root_directory= => nil,
-          :logger= => nil,
-          :environment= => nil,
-          :ignore_environments= => nil,
-          :blocklist_keys= => nil
-        )
-
-        allow(Airbrake).to receive(:configure).and_yield(configuration)
-      end
-
-      let(:configuration) { double("Configuration") }
-
-      let(:enabled) { true }
-      let(:host) { "http://localhost:8005" }
-      let(:project_key) { "ABC123456789" }
-
-      describe ".invoke" do
-        it "configures Airbrake" do
-          expect(configuration).to receive(:host=).with(host)
-          expect(configuration).to receive(:project_key=).with(project_key)
-
-          described_class.invoke
-        end
-
-        context "when airbrake is enabled" do
-          it "does not tell Airbrake to ignore everything" do
-            expect(Airbrake).not_to receive(:add_filter)
-
-            described_class.invoke
-          end
-        end
-
-        context "when airbrake is not enabled" do
-          let(:enabled) { false }
-
-          it "tells Airbrake to ignore everything" do
-            expect(Airbrake).to receive(:add_filter) { |&block| expect(block).to be(&:ignore!) }
-
-            described_class.invoke
-          end
-        end
-      end
-
-    end
-  end
-end

data/spec/defra_ruby/alert/configuration_spec.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Alert
-    RSpec.describe Configuration do
-      it "sets the appropriate default config settings" do
-        fresh_config = described_class.new
-
-        expect(fresh_config.root_directory).to be_nil
-        expect(fresh_config.logger).to be_nil
-        expect(fresh_config.environment).to be_nil
-
-        expect(fresh_config.host).to be_nil
-        expect(fresh_config.project_key).to be_nil
-        expect(fresh_config.blocklist).to eq([])
-        expect(fresh_config.enabled).to eq(false)
-      end
-    end
-  end
-end

data/spec/defra_ruby/alert_spec.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe DefraRuby::Alert do
-  describe "VERSION" do
-    it "is a version string in the correct format" do
-      expect(DefraRuby::Alert::VERSION).to be_a(String)
-      expect(DefraRuby::Alert::VERSION).to match(/\d+\.\d+\.\d+/)
-    end
-  end
-
-  describe ".configuration" do
-    context "when the host app has not provided configuration" do
-      it "returns a DefraRuby::Alert::Configuration instance" do
-        expect(described_class.configuration).to be_an_instance_of(DefraRuby::Alert::Configuration)
-      end
-    end
-
-    context "when the host app has provided configuration" do
-      let(:host) { "http://localhost:9012" }
-
-      it "returns an DefraRuby::Alert::Configuration instance with a matching host" do
-        described_class.configure { |config| config.host = host }
-
-        expect(described_class.configuration.host).to eq(host)
-      end
-    end
-  end
-
-  describe ".start" do
-    before do
-      DefraRuby::Alert.configure do |c|
-        c.enabled = false
-        c.host = "http://localhost:8005"
-        c.project_key = "ABC123456789"
-      end
-    end
-    it "invokes 'AirbrakeRunner'" do
-      expect(DefraRuby::Alert::AirbrakeRunner).to receive(:invoke)
-
-      described_class.start
-    end
-  end
-end

data/spec/examples.txt

@@ -1,10 +0,0 @@
-example_id                                               | status | run_time        |
--------------------------------------------------------- | ------ | --------------- |
-./spec/defra_ruby/alert/airbrake_runner_spec.rb[1:1:1]   | passed | 0.00255 seconds |
-./spec/defra_ruby/alert/airbrake_runner_spec.rb[1:1:2:1] | passed | 0.00052 seconds |
-./spec/defra_ruby/alert/airbrake_runner_spec.rb[1:1:3:1] | passed | 0.00062 seconds |
-./spec/defra_ruby/alert/configuration_spec.rb[1:1]       | passed | 0.00259 seconds |
-./spec/defra_ruby/alert_spec.rb[1:1:1]                   | passed | 0.00304 seconds |
-./spec/defra_ruby/alert_spec.rb[1:2:1:1]                 | passed | 0.0017 seconds  |
-./spec/defra_ruby/alert_spec.rb[1:2:2:1]                 | passed | 0.00178 seconds |
-./spec/defra_ruby/alert_spec.rb[1:3:1]                   | passed | 0.01859 seconds |

data/spec/spec_helper.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-
-# Require and run our simplecov initializer as the very first thing we do.
-# This is as per its docs https://github.com/colszowka/simplecov#getting-started
-require "./spec/support/simplecov"
-
-# Requires supporting ruby files with custom matchers and macros, etc, in
-# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
-# run as spec files by default. This means that files in spec/support that end
-# in _spec.rb will both be required and run as specs, causing the specs to be
-# run twice. It is recommended that you do not name files matching this glob to
-# end with _spec.rb. You can configure this pattern with the --pattern
-# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-#
-# We make an exception for simplecov because that will already have been
-# required and run at the very top of spec_helper.rb
-support_files = Dir["./spec/support/**/*.rb"].reject { |file| file == "./spec/support/simplecov.rb" }
-support_files.each { |f| require f }
-
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-end

data/spec/support/defra_ruby_alert.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-# Need to require our actual code files.
-require "defra_ruby/alert"

data/spec/support/dotenv.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-# Load env vars from a text file
-require "dotenv/load"

data/spec/support/pry.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# Support debugging in the tests. Add `binding.pry` wherever you want execution
-# to stop and the debugger to kick in.
-# Details on the debugging commands can be found here
-# https://github.com/deivid-rodriguez/pry-byebug#commands
-require "pry-byebug"

data/spec/support/simplecov.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "simplecov"
-
-# We start it with the rails param to ensure it includes coverage for all code
-# started by the rails app, and not just the files touched by our unit tests.
-# This gives us the most accurate assessment of our unit test coverage
-# https://github.com/colszowka/simplecov#getting-started
-SimpleCov.start do
-  # We filter the spec folder, mainly to ensure that any dummy apps don't get
-  # included in the coverage report. However our intent is that nothing in the
-  # spec folder should be included
-  add_filter "/spec/"
-  # The version file is simply just that, so we do not feel the need to ensure
-  # we have a test for it
-  add_filter "lib/defra_ruby/alert/version"
-end

data/spec/support/webmock.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-# Stubbing HTTP requests
-require "webmock/rspec"