govuk_personalisation 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03aab9f90629204c9ebb98b0eb31c739206533b5e63b91e2a2181bc5b2b1517f
-  data.tar.gz: 7720c391869279bd8841e24ce815b85d8ce52e251e9bb1f6ce15e525b06b9922
+  metadata.gz: c790c79fa0ba26b2b84efecd07532446c2497cbfd874586526b65f589ba715ca
+  data.tar.gz: 899f016d1a906e2fe2893b62da8999e33edc9b7c8ae6df9d6caee6ce9c14aa28
 SHA512:
-  metadata.gz: a3619a1c907c386f134dd0e8153851a123e27783810d22885bd969a20b33b7faeed88be4735c1a84673053a7c7c99ba05cb422af42b8952157ce1538e2b02c95
-  data.tar.gz: 3fbfd164e7f62849cb8f14dc735734ade9f44dbb4621a160f374544fd63c36c4519313e9989c972a318d49aab04f5a2533e568b035183119c19507e0adcdcdfc
+  metadata.gz: '0398288ee33c9a21186c833fec51049b38f49e62b7d6e649970599ffae8ae7a3a0096100fc17b325b1f63698030dc7c31c2a2350206b3af65c0bd3fb46e36bd8'
+  data.tar.gz: 2ca84334520a9521f79ca1e49a1a3f36af4e1fc0bccaa5c855f9f4b19628c6909a68af91c3388266039fec8afc2ce8c1883bd8be8aecba36567dd6d3a51c5fe0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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

@@ -125,5 +125,13 @@ 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 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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GovukPersonalisation
-  VERSION = "0.8.0"
+  VERSION = "0.9.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.9.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-10-07 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