govuk_personalisation 0.7.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba6e9b0f0533ecc545582e031f6faf0f734d727e42478ffea40ddac7635986e
-  data.tar.gz: '0974635ac43c8dfacb6894787db3d36b2608438117b41640364bfd40dcecb125'
+  metadata.gz: e6aba4a93adaa9cf995e9933fb12276d84e8d0e3011c17ec4689a63a5cf8f4a0
+  data.tar.gz: 97b6c20b940afef6fb31671187b619b89f58222922b7b2b8c9ae6233d2dcec0e
 SHA512:
-  metadata.gz: 0fdb4622d551eae409978cac47ea4dfc78205a33d6e6b324b0a4eae4ab97eb5730571cd038a49ae9d74167a50093771aa96e60062a8fadfe33dc9b57206da2a1
-  data.tar.gz: f11fc215ac0ab1bb8147c973398b1bba72a1f58a7ea838473ea05f305a2ac169bd527fb61e8eb7e5676be14fb02fde5ef821800868488b6250b0591e64e6aab0
+  metadata.gz: f431ca7c35aca6f808d968d82eca6420ce0fab31c00766ec39226284790c7a46f8a49bf2d1dda60784853c85a8f836972d628b21ee7a77d213b6d5d0090a1715
+  data.tar.gz: 43eb1db4b1c9cbd2c7a44d8610dc22f33e0ddd37e844038d5b0ca32140cc9c42f0d9519be395d5f247df9963ce17736b106dddd05de0a8f34e1d30366561c3ec

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 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))
+
 # 0.7.0
 
 - Add `GovukPersonalisation::Urls` module ([#14](https://github.com/alphagov/govuk_personalisation/pull/14) [#16](https://github.com/alphagov/govuk_personalisation/pull/16))

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

@@ -5,7 +5,7 @@ module GovukPersonalisation::Urls
   #
   # @return [String] the URL
   def self.sign_in
-    find_govuk_url(var: "SIGN_IN", application: "frontend", path: "/sign-in")
+    find_govuk_url(var: "SIGN_IN", application: "frontend", path: "/sign-in/redirect")
   end
 
   # Find the GOV.UK URL for the "sign out" page

data/lib/govuk_personalisation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GovukPersonalisation
-  VERSION = "0.7.0"
+  VERSION = "0.10.1"
 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.7.0
+  version: 0.10.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-31 00:00:00.000000000 Z
+date: 2021-11-23 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