govuk_personalisation 0.6.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b691342c4c22592162f9eb11e8c8f74b8fea75af5669568c71d15337166626'
-  data.tar.gz: 0e266ec1d1f91a7537ccef2c1a4398e90b4c0435546772d41877cfd34e9df092
+  metadata.gz: d966869deca66c3fbea1730d7b2478ca77bc019d499b824269a9456eeffa82d9
+  data.tar.gz: fc4735bde8c3077c1e8e2795e4deb496b2c7816bfe6006057b0c8e59ceb27196
 SHA512:
-  metadata.gz: 5f265633173eee3b60e436c781ddb4047d849471cc1760d88e8c3e497a79d8a0fd188a4c3908feb33fecf3b8c2b171dbbc1ea7f08ed837fae2d58cfc5658ae35
-  data.tar.gz: d90dc8a74720981e16d7d379939c08072806ead930d012bb40c1a57ac2e90ae3879a10d7fb0bfbe3d874d39c70312952d72c0c9eca452fd757906c253ecb402e
+  metadata.gz: 826c826f13b08be03d467655bab27bab323ec6b8823bdddc25b52f0d20906344ee4ece5c95a31bf7726e2aabdea0511b46934b5a37137d7e8788d496b570395f
+  data.tar.gz: a74b510d5f549e3d0cc9df6b533763d5ac9a3c9211e424f49372b705acb9bb64229f35794f0aadaeee5492d8108040a5780acdc9a8e4d5c7bb4cf54a88b4b979

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 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))
+
 # 0.6.0
 
 - Add `GovukPersonalisation::Flash` and helper methods to the concern ([#9](https://github.com/alphagov/govuk_personalisation/pull/9))

data/govuk_personalisation.gemspec

@@ -25,9 +25,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.add_dependency "plek", ">= 1.9.0"
   spec.add_dependency "rails", "~> 6"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "climate_control"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec-rails"

data/lib/govuk_personalisation/controller_concern.rb

@@ -125,5 +125,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

@@ -0,0 +1,87 @@
+require "plek"
+
+module GovukPersonalisation::Urls
+  # Find the GOV.UK URL for the "sign in" page
+  #
+  # @return [String] the URL
+  def self.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
+  #
+  # @return [String] the URL
+  def self.sign_out
+    find_govuk_url(var: "SIGN_OUT", application: "frontend", path: "/sign-out")
+  end
+
+  # Find the GOV.UK URL for the "your account" page
+  #
+  # @return [String] the URL
+  def self.your_account
+    find_govuk_url(var: "YOUR_ACCOUNT", application: "frontend", path: "/account/home")
+  end
+
+  # Find the external URL for the "manage" page
+  #
+  # @return [String] the URL
+  def self.manage
+    find_external_url(var: "MANAGE", application: "account-manager", path: "/account/manage")
+  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")
+  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")
+  end
+
+  # Finds a URL on www.gov.uk.  This method is used so we can have
+  # links which work both in production (where the website root is
+  # returned) and in local development (where an application URL is
+  # returned).
+  #
+  # If `GOVUK_PERSONALISATION_#{var}_URI` is in the environment, that
+  # will be returned.
+  #
+  # Otherwise, a `www.gov.uk` URL will be returned (a `dev.gov.uk`
+  # domain in development mode)
+  #
+  # @param var         [String] the name of the variable to look up
+  # @param application [String] the name of the frontend application, passed to Plek, to use in development mode (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)
+  #
+  # @return [String] the URL
+  def self.find_govuk_url(var:, application:, path:)
+    value_from_env_var = ENV["GOVUK_PERSONALISATION_#{var}_URI"]
+    if value_from_env_var
+      value_from_env_var
+    else
+      plek_application_uri = Rails.env.development? ? Plek.find(application) : Plek.new.website_root
+      "#{plek_application_uri}#{path}"
+    end
+  end
+
+  # Finds a URL outside www.gov.uk
+  #
+  # If `GOVUK_PERSONALISATION_#{var}_URI` is in the environment, that
+  # will be returned.
+  #
+  # 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)
+  #
+  # @return [String] the URL
+  def self.find_external_url(var:, application:, path:)
+    ENV.fetch("GOVUK_PERSONALISATION_#{var}_URI", "#{Plek.find(application)}#{path}")
+  end
+end

data/lib/govuk_personalisation/version.rb

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

data/lib/govuk_personalisation.rb

@@ -3,7 +3,9 @@
 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"
 
 module GovukPersonalisation; end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: govuk_personalisation
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.10.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: plek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -118,8 +146,10 @@ 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
 - lib/govuk_personalisation/version.rb
 homepage: https://github.com/alphagov/govuk_personalisation
 licenses: