govuk_personalisation 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03aab9f90629204c9ebb98b0eb31c739206533b5e63b91e2a2181bc5b2b1517f
-  data.tar.gz: 7720c391869279bd8841e24ce815b85d8ce52e251e9bb1f6ce15e525b06b9922
+  metadata.gz: 72e80d8e2a45cc9b258a963263e91468d69372505d0452205393eb735cf569fa
+  data.tar.gz: 6cb230637923f915ef5117b812f6790ba244a07c45a29823ad52c51e6ae33f03
 SHA512:
-  metadata.gz: a3619a1c907c386f134dd0e8153851a123e27783810d22885bd969a20b33b7faeed88be4735c1a84673053a7c7c99ba05cb422af42b8952157ce1538e2b02c95
-  data.tar.gz: 3fbfd164e7f62849cb8f14dc735734ade9f44dbb4621a160f374544fd63c36c4519313e9989c972a318d49aab04f5a2533e568b035183119c19507e0adcdcdfc
+  metadata.gz: f527d1acb925660f6b975ceab7bfc87b188578ddecef6e5af15dd340128daed02a84d2c5d042248c79a8b9c9e007a2238c7242fe41cf1dbd4070bea481230eca
+  data.tar.gz: 67b6f46b435a2e9480515cd41f98e6381286ede5d0f2c16d97e4f30f248dd52657d2bd95de056515c1c2a3ec5e24a9f51076cf71cdad285d41bdf5d3fb0e9d2a

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.11.0
+
+- Remove references to the account manager from the URLs module ([#26](https://github.com/alphagov/govuk_personalisation/pull/26))
+
+# 0.10.1
+
+- Make session-change events uncacheable ([#24](https://github.com/alphagov/govuk_personalisation/pull/24))
+
+# 0.10.0
+- Add `url_with_analytics` helper to allow apps to access the URL used for `redirect_with_analytics` ([#22](https://github.com/alphagov/govuk_personalisation/pull/22))
+
+# 0.9.0
+- Add `redirect_with_analytics` helper, attaches _ga and cookie_consent values from existing params to redirects. ([#19](https://github.com/alphagov/govuk_personalisation/pull/19))
+- Add `GovukPersonalisation::Redirect` and `.build_url` helper to construct valid URLs with additional parameters. ([#19](https://github.com/alphagov/govuk_personalisation/pull/19))
+
 # 0.8.0
 
 - Change sign in path to `/sign-in/redirect` ([#17](https://github.com/alphagov/govuk_personalisation/pull/17))

data/lib/govuk_personalisation/controller_concern.rb

@@ -83,6 +83,8 @@ module GovukPersonalisation
       session_with_flash = GovukPersonalisation::Flash.encode_session(@account_session_header, @new_account_flash.keys)
 
       response.headers[ACCOUNT_SESSION_HEADER_NAME] = session_with_flash
+      response.headers["Cache-Control"] = "no-store"
+
       if Rails.env.development?
         cookies[ACCOUNT_SESSION_DEV_COOKIE_NAME] = {
           value: session_with_flash,
@@ -95,7 +97,10 @@ module GovukPersonalisation
     # header.
     def logout!
       response.headers[ACCOUNT_END_SESSION_HEADER_NAME] = "1"
+      response.headers["Cache-Control"] = "no-store"
+
       @account_session_header = nil
+
       if Rails.env.development?
         cookies[ACCOUNT_SESSION_DEV_COOKIE_NAME] = {
           value: "",
@@ -125,5 +130,21 @@ module GovukPersonalisation
       @new_account_flash = @account_flash.merge(@new_account_flash)
       set_account_session_header
     end
+
+    # Redirect to a URL adding parameters necessary for cross-domain analytics
+    # and cookie consent
+    #
+    # @param url [String] The URL to redirect to
+    def redirect_with_analytics(url)
+      redirect_to url_with_analytics(url)
+    end
+
+    # Build a URL adding parameters necessary for cross-domain analytics
+    # and cookie consent
+    #
+    # @param url [String] The URL
+    def url_with_analytics(url)
+      GovukPersonalisation::Redirect.build_url(url, params.permit(:_ga, :cookie_consent).to_h)
+    end
   end
 end

data/lib/govuk_personalisation/redirect.rb

@@ -0,0 +1,23 @@
+module GovukPersonalisation::Redirect
+  # Builds a URL with additional query parameters
+  #
+  # Allows for a simple method call to add params on to an existing
+  # URL, for instance when adding _ga tracking params to a redirect
+  #
+  # @param          base_url          [String] The URL to attach additional parameters to
+  # @param optional additional_params [Hash{String,Symbol => String}] additional parameters
+  #                                   to be added to the URL. If empty, returns the base URL.
+  #
+  # @return                           [String] a new URL with additional parameters
+  def self.build_url(base_url, additional_params = {})
+    return base_url if additional_params.empty?
+
+    additional_query = additional_params.to_a.map { |param| param.join("=") }.join("&")
+
+    if base_url.include? "?"
+      "#{base_url}&#{additional_query}"
+    else
+      "#{base_url}?#{additional_query}"
+    end
+  end
+end

data/lib/govuk_personalisation/urls.rb

@@ -26,21 +26,21 @@ module GovukPersonalisation::Urls
   #
   # @return [String] the URL
   def self.manage
-    find_external_url(var: "MANAGE", application: "account-manager", path: "/account/manage")
+    find_external_url(var: "MANAGE", url: "https://#{digital_identity_domain}?link=manage-account")
   end
 
   # Find the external URL for the "security" page
   #
   # @return [String] the URL
   def self.security
-    find_external_url(var: "SECURITY", application: "account-manager", path: "/account/security")
+    find_external_url(var: "SECURITY", url: "https://#{digital_identity_domain}?link=security-privacy")
   end
 
   # Find the external URL for the "feedback" page
   #
   # @return [String] the URL
   def self.feedback
-    find_external_url(var: "FEEDBACK", application: "account-manager", path: "/feedback")
+    find_external_url(var: "FEEDBACK", url: "https://signin.account.gov.uk/support")
   end
 
   # Finds a URL on www.gov.uk.  This method is used so we can have
@@ -76,12 +76,23 @@ module GovukPersonalisation::Urls
   #
   # Otherwise, an application URL generated by Plek will be returned.
   #
-  # @param var         [String] the name of the variable to look up
-  # @param application [String] the name of the frontend application, passed to Plek (if the env var is set, this is ignored)
-  # @param path        [String] the path to use (if the env var is set this is ignored)
+  # @param var [String] the name of the variable to look up
+  # @param url [String] the url to default to if there is no environment variable set
   #
   # @return [String] the URL
-  def self.find_external_url(var:, application:, path:)
-    ENV.fetch("GOVUK_PERSONALISATION_#{var}_URI", "#{Plek.find(application)}#{path}")
+  def self.find_external_url(var:, url:)
+    ENV.fetch("GOVUK_PERSONALISATION_#{var}_URI", url)
+  end
+
+  # Gets the Digital Identity domain for the current environment
+  #
+  # @return [String] the domain
+  def self.digital_identity_domain
+    environment = ENV["DIGITAL_IDENTITY_ENVIRONMENT"]
+    if environment
+      "#{environment}.account.gov.uk"
+    else
+      "account.gov.uk"
+    end
   end
 end

data/lib/govuk_personalisation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GovukPersonalisation
-  VERSION = "0.8.0"
+  VERSION = "0.11.0"
 end

data/lib/govuk_personalisation.rb

@@ -3,6 +3,7 @@
 require "govuk_personalisation/version"
 require "govuk_personalisation/controller_concern"
 require "govuk_personalisation/flash"
+require "govuk_personalisation/redirect"
 require "govuk_personalisation/test_helpers/features"
 require "govuk_personalisation/test_helpers/requests"
 require "govuk_personalisation/urls"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_personalisation
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.11.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -146,6 +146,7 @@ files:
 - lib/govuk_personalisation.rb
 - lib/govuk_personalisation/controller_concern.rb
 - lib/govuk_personalisation/flash.rb
+- lib/govuk_personalisation/redirect.rb
 - lib/govuk_personalisation/test_helpers/features.rb
 - lib/govuk_personalisation/test_helpers/requests.rb
 - lib/govuk_personalisation/urls.rb