govuk_web_banners 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e90dcafd54461fe4a723458faccd96d342d6d4d4ad26451ea38431b94d56c2b4
-  data.tar.gz: c12a85485ac267611ca6096fd3185bbb9c84123fb106f0102d9f88e872aeda11
+  metadata.gz: 812e2ba243433622af29da5ae03a118d2eeca1b92b2f1a293fd9faa7c7c7d8be
+  data.tar.gz: cc707567b6715229a8c68efa4bf3ad3b447a30a7fe2301ac739d740fe3f4edea
 SHA512:
-  metadata.gz: 68690f93a35d664a9d6ed0103b6082987196a190b8089005ca0b6fe7a0cf3892106836f6e27c1f0bd033edf33dc9c9ddc5994cad80cca419ea5c2cf95cee6d1c
-  data.tar.gz: a40d8c454e7b64ade2254e18c6ef09965b0023b1d79223771177c703d0182b9ffb14e7db63d3048223b1f054d4431b0bdee3aa589bf8f432895fea9600148a84
+  metadata.gz: 5608eaab07cfb7c5e5f6da27c6db19310fae258986e1334ff33cb54f8a2a9c3d9fcd6cadc95f6e0175f43bb60698bc0ae821957808ffe8ae06553d664b0f0701
+  data.tar.gz: dd2726aacb5d69fd888169ca167fb08f9f1b297789993c57c6b9b5d6aa35f0ad2315cc7f0e099be83e47e2d889f7e09b0a2ef5812f7d265e71083097b892b358

data/README.md

@@ -3,7 +3,7 @@ Proof of Concept for centralising handling of Recruitment, Global, and Emergency
 banners (currently spread across apps)
 
 ## Usage
-Currently supports recruitment banners
+Currently supports the emergency banner and recruitment banners.
 
 ## Adding the gem to your application
 Add this line to your application's Gemfile:
@@ -28,6 +28,39 @@ Add the JS dependencies to your existing asset dependencies file:
 //= require govuk_web_banners/dependencies
 ```
 
+## Adding emergency banners
+
+Emergency banners are passed to the [Layout for Public](https://components.publishing.service.gov.uk/component-guide/layout_for_public) component, which is currently applied to each frontend app by the slimmer/static wrapping code - so you will only need to handle emergency banners in your app when Slimmer is removed from it. Once Slimmer is removed and you are calling the layout_for_public component directly in your app, add the emergency banner partial to the component's `emergency_banner:` key:
+
+```
+<%= render "govuk_publishing_components/components/layout_for_public", {
+  draft_watermark: draft_environment,
+  emergency_banner: render("govuk_web_banners/emergency_banner"), # <-- Add this line
+  full_width: false,
+  ...etc
+```
+
+if you want the homepage variant of the banner, you can add `homepage: true` to the render call:
+
+```
+<%= render "govuk_publishing_components/components/layout_for_public", {
+  draft_watermark: draft_environment,
+  emergency_banner: render("govuk_web_banners/emergency_banner", homepage: true), # <-- Add this line
+  full_width: full_width,
+  ...etc
+```
+
+Your app will also need access to the whitehall shared redis cluster (which is used to signal the emergency banner is up), via the `EMERGENCY_BANNER_REDIS_URL` environment variable (here is an example of [setting this in govuk-helm-charts](https://github.com/alphagov/govuk-helm-charts/blob/7818eaa22fc194d21548f316bcc5a46c2023dcb6/charts/app-config/values-staging.yaml#L3337-L3338)). You'll need to allow this in all three environments.
+
+Finally, you'll need to configure a connection to the redis cluster, available at `Rails.application.config.emergency_banner_redis_client`. The suggested way of doing this is creating an initializer at `/config/initializers/govuk_web_banners.rb` with the content:
+
+```
+Rails.application.config.emergency_banner_redis_client = Redis.new(
+  url: ENV["EMERGENCY_BANNER_REDIS_URL"],
+  reconnect_attempts: [15, 30, 45, 60],
+)
+```
+
 ## Adding recruitment banners
 
 Add a call to the partial in the layout or view that you want banners to appear

data/app/views/govuk_web_banners/_emergency_banner.html.erb

@@ -0,0 +1,11 @@
+<% emergency_banner = GovukWebBanners::EmergencyBanner.new %>
+<% if emergency_banner.active? %>
+  <%= render "govuk_publishing_components/components/emergency_banner", {
+      campaign_class: emergency_banner.campaign_class,
+      heading: emergency_banner.heading,
+      link: emergency_banner.link,
+      link_text: emergency_banner.link_text,
+      short_description: emergency_banner.short_description,
+      homepage: local_assigns[:homepage] || false,
+  } %>
+<% end %>

data/config/govuk_web_banners/recruitment_banners.yml

@@ -45,3 +45,31 @@ banners:
     - /business-finance-support
   start_date: 11/11/2024
   end_date: 06/01/2025
+- name: HMRC banner 03/01/2025
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
+  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_CCG_Compliance
+  page_paths:
+    # government-frontend
+    - /government/collections/tax-compliance-detailed-information
+    - /government/collections/hm-revenue-and-customs-compliance-checks-factsheets
+    - /difficulties-paying-hmrc
+    - /tax-help
+    - /get-help-hmrc-extra-support
+    - /guidance/voluntary-and-community-sector-organisations-who-can-give-you-extra-support
+    - /tax-appeals
+    - /guidance/tax-disputes-alternative-dispute-resolution-adr
+  start_date: 03/01/2025
+  end_date: 31/01/2025
+- name: UKVI banner 30/12/2025
+  suggestion_text: "Help improve GOV.UK"
+  suggestion_link_text: "Take part in user research (opens in a new tab)"
+  survey_url: https://surveys.publishing.service.gov.uk/s/XYVRGN/
+  page_paths:
+    # frontend
+    - /contact-ukvi-inside-outside-uk
+    # collections
+    - /browse/visas-immigration
+    - /government/organisations/uk-visas-and-immigration
+  start_date: 30/12/2024
+  end_date: 27/01/2025

data/lib/govuk_web_banners/emergency_banner.rb

@@ -0,0 +1,37 @@
+require "govuk_app_config/govuk_error"
+require "redis"
+
+module GovukWebBanners
+  class EmergencyBanner
+    attr_reader :campaign_class, :heading, :short_description, :link, :link_text
+
+    def initialize
+      content = content_from_redis
+
+      @campaign_class = content[:campaign_class].presence
+      @heading = content[:heading].presence
+      @short_description = content[:short_description].presence
+      @link = content[:link].presence
+      @link_text = content[:link_text].presence
+    end
+
+    def active?
+      [campaign_class, heading].all?
+    end
+
+  private
+
+    def redis_client
+      Rails.application.config.emergency_banner_redis_client
+    end
+
+    def content_from_redis
+      Rails.cache.fetch("#emergency_banner/config", expires_in: 1.minute) do
+        redis_client.hgetall("emergency_banner").try(:symbolize_keys)
+      end
+    rescue StandardError => e
+      GovukError.notify(e, extra: { context: "Emergency Banner Redis" })
+      {}
+    end
+  end
+end

data/lib/govuk_web_banners/version.rb

@@ -1,3 +1,3 @@
 module GovukWebBanners
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/govuk_web_banners.rb

@@ -1,5 +1,6 @@
 require "govuk_publishing_components"
 
+require "govuk_web_banners/emergency_banner"
 require "govuk_web_banners/engine"
 require "govuk_web_banners/recruitment_banner"
 require "govuk_web_banners/version"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: govuk_web_banners
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
+original_platform: ''
 authors:
 - GOV.UK Dev
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: govuk_app_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: govuk_publishing_components
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -148,9 +176,11 @@ files:
 - Rakefile
 - app/assets/config/govuk_web_banners_manifest.js
 - app/assets/javascripts/govuk_web_banners/dependencies.js
+- app/views/govuk_web_banners/_emergency_banner.html.erb
 - app/views/govuk_web_banners/_recruitment_banner.html.erb
 - config/govuk_web_banners/recruitment_banners.yml
 - lib/govuk_web_banners.rb
+- lib/govuk_web_banners/emergency_banner.rb
 - lib/govuk_web_banners/engine.rb
 - lib/govuk_web_banners/recruitment_banner.rb
 - lib/govuk_web_banners/version.rb
@@ -161,7 +191,6 @@ metadata:
   homepage_uri: https://github.com/alphagov/govuk_web_banners
   source_code_uri: https://www.github.com/alphagov/govuk_web_banners
   changelog_uri: https://www.github.com/alphagov/govuk_web_banners/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -176,8 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.1
 specification_version: 4
 summary: A gem to support banners on GOV.UK frontend applications
 test_files: []