publishing_platform_app_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11e94f7bba1b501b8bff7c62ad70627dfa8b963ddba0a57ce9c308713556c065
+  data.tar.gz: 0f4081a9a9aafdf33f303bc6b514805aaaf113b1717769d100437f6ba3d220fc
+SHA512:
+  metadata.gz: a87d39eeceeb4cc6dc18553d09d602d7e53665ceb5bdbc91c2ec25682316f174635a195e986ff92f4ea5d60d4aebadb665a4b9f747ec85e2e0fcc62fd2d355d1
+  data.tar.gz: 41a93c4372595ec6a7d6404dc2cd0503567a1ba592024c78e7ce4baef0a0af72ae8f747184aa9f00ea1f3f585ab4a171185f4c3004a02e3d4fc7d3f2b65c8c43

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.1.2'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  publishing_platform_rubocop:
+    - config/default.yml

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in publishing_platform_app_config.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Publishing Platform
+Copyright (c) 2017 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# Publishing Platform App Config
+Gem to configure Publishing Platform Ruby applications

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "publishing_platform_app_config"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/publishing_platform_app_config/publishing_platform_error/configuration.rb

@@ -0,0 +1,59 @@
+require "delegate"
+
+module PublishingPlatformError
+  class Configuration < SimpleDelegator
+    def initialize(_sentry_configuration)
+      super
+      set_up_defaults
+    end
+
+    def set_up_defaults
+      self.excluded_exceptions = [
+        # Default ActionDispatch rescue responses
+        "ActionController::RoutingError",
+        "AbstractController::ActionNotFound",
+        "ActionController::MethodNotAllowed",
+        "ActionController::UnknownHttpMethod",
+        "ActionController::NotImplemented",
+        "ActionController::UnknownFormat",
+        "Mime::Type::InvalidMimeType",
+        "ActionController::MissingExactTemplate",
+        "ActionController::InvalidAuthenticityToken",
+        "ActionController::InvalidCrossOriginRequest",
+        "ActionDispatch::Http::Parameters::ParseError",
+        "ActionController::BadRequest",
+        "ActionController::ParameterMissing",
+        "Rack::QueryParser::ParameterTypeError",
+        "Rack::QueryParser::InvalidParameterError",
+        # Default ActiveRecord rescue responses
+        "ActiveRecord::RecordNotFound",
+        "ActiveRecord::StaleObjectError",
+        "ActiveRecord::RecordInvalid",
+        "ActiveRecord::RecordNotSaved",
+        # Additional items
+        "ActiveJob::DeserializationError",
+        "CGI::Session::CookieStore::TamperedWithCookie",
+        # TODO
+        # "GdsApi::HTTPIntermittentServerError",
+        # "GdsApi::TimedOutException",
+        "PublishingPlatform::SSO::PermissionDeniedError",
+        "Mongoid::Errors::DocumentNotFound",
+        "Puma::HttpParserError",
+        "Sinatra::NotFound",
+        "Slimmer::IntermittentRetrievalError",
+        "Slimmer::SourceWrapperNotFoundError",
+        "Sidekiq::JobRetry::Skip",
+        "SignalException",
+      ]
+
+      # This will exclude exceptions that are triggered by one of the ignored
+      # exceptions. For example, when any exception occurs in a template,
+      # Rails will raise a ActionView::Template::Error, instead of the original error.
+      self.inspect_exception_causes_for_exclusion = true
+
+      # Avoid "Sending envelope with items ... to Sentry" logspew, since we
+      # don't use Sentry's automatic session tracking.
+      self.auto_session_tracking = false
+    end
+  end
+end

data/lib/publishing_platform_app_config/publishing_platform_error.rb

@@ -0,0 +1,45 @@
+require "sentry-ruby"
+require "sentry-rails" if defined?(Rails)
+require "publishing_platform_app_config/publishing_platform_error/configuration"
+require "publishing_platform_app_config/version"
+
+module PublishingPlatformError
+  class AlreadyInitialised < StandardError
+    def initialize(msg = "You can only call PublishingPlatformError.configure once!")
+      super
+    end
+  end
+
+  def self.notify(exception_or_message, args = {})
+    # Allow users to use `parameters` as a key like the Airbrake
+    # client, allowing easy upgrades.
+    args[:extra] ||= {}
+    args[:extra].merge!(parameters: args.delete(:parameters))
+
+    args[:tags] ||= {}
+    args[:tags][:publishing_platform_app_config_version] = PublishingPlatformAppConfig::VERSION
+
+    if exception_or_message.is_a?(String)
+      Sentry.capture_message(exception_or_message, **args)
+    else
+      Sentry.capture_exception(exception_or_message, **args)
+    end
+  end
+
+  def self.is_configured?
+    Sentry.get_current_client != nil
+  end
+
+  def self.configure
+    raise PublishingPlatformError::AlreadyInitialised if is_configured?
+
+    if defined?(Sidekiq) && !defined?(Sentry::Sidekiq)
+      warn "Warning: PublishingPlatformAppConfig is not configured to track Sidekiq errors, install the sentry-sidekiq gem to track them."
+    end
+
+    Sentry.init do |sentry_config|
+      config = Configuration.new(sentry_config)
+      yield config if block_given?
+    end
+  end
+end

data/lib/publishing_platform_app_config/railtie.rb

@@ -0,0 +1,7 @@
+module PublishingPlatformAppConfig
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      PublishingPlatformError.configure unless PublishingPlatformError.is_configured?
+    end
+  end
+end

data/lib/publishing_platform_app_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PublishingPlatformAppConfig
+  VERSION = "0.1.0"
+end

data/lib/publishing_platform_app_config.rb

@@ -0,0 +1,6 @@
+require "publishing_platform_app_config/version"
+require "publishing_platform_app_config/publishing_platform_error"
+
+if defined?(Rails)
+  require "publishing_platform_app_config/railtie"
+end

data/publishing_platform_app_config.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "lib/publishing_platform_app_config/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "publishing_platform_app_config"
+  spec.version = PublishingPlatformAppConfig::VERSION
+  spec.authors = ["Publishing Platform"]
+
+  spec.summary = "Base configuration for Publishing Platform applications"
+  spec.description = "Base configuration for Publishing Platform applications"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.files =  `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency "sentry-rails", "~> 5.3"
+  spec.add_dependency "sentry-ruby", "~> 5.3"
+
+  spec.add_development_dependency "publishing_platform_rubocop"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: publishing_platform_app_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Publishing Platform
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: publishing_platform_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'
+description: Base configuration for Publishing Platform applications
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/publishing_platform_app_config.rb
+- lib/publishing_platform_app_config/publishing_platform_error.rb
+- lib/publishing_platform_app_config/publishing_platform_error/configuration.rb
+- lib/publishing_platform_app_config/railtie.rb
+- lib/publishing_platform_app_config/version.rb
+- publishing_platform_app_config.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Base configuration for Publishing Platform applications
+test_files: []