plek 3.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f009f7c15f4e0b0fa5a5b5f3866e327101ff3ed1a7cc4527e5d3346398bcf3
-  data.tar.gz: 8ed2fcfc3453d92b3a049f0941bf6026d0f6294f33b51bab9e0d69bfa6608af7
+  metadata.gz: 1157f1b8a26836a70c428e595d27392858f6a858043dd44bfeda13314c4e7e99
+  data.tar.gz: 7b970caacd3c079d9bd31836fbc53dee83d98da3110982f67e16d618c89e5f91
 SHA512:
-  metadata.gz: a7f2980ae077e50f4f277ad26ece95057c9f486f8f1883e24cb80f47f60b02fc35cd58ab7812642a7348a90d648b2223572609702220e281180e0f5e3b4a8610
-  data.tar.gz: 48664f58cd9f619b78dea7db04afe260153ac596ce79977d5e07911ef23a68f0e308f9e71ff135ee4636c7ebc6eb9f85880bdf88ec94515a874bac2f2c32a57a
+  metadata.gz: bffcec46ce28fbfdc43d276ddea36fc741dca07a3db9292952d5f7717ecd0eed704a15a96c0ca223f29260b903843374e1c6e317a1e0ba8193dd332cfa07f4bd
+  data.tar.gz: 74501f62f53fb5263e6a41d679604685ca07147599c42d48afbd9921936f18e7c7f900d163ad5255bbfbd7022f0cef8ae1551cfdd61b67deafa528afc57bb92f

data/README.md

@@ -52,14 +52,24 @@ To domain is based on the environment, and defaults to 'dev.gov.uk'. The environ
 
 You can prepend strings to the hostnames generated using: `PLEK_HOSTNAME_PREFIX`.
 
+If `PLEK_HOSTNAME_PREFIX` is present, it will be prepended to the hostname
+unless the hostname appears in the comma-separated list
+`PLEK_UNPREFIXABLE_HOSTS`.
+
 Override the asset URL with: `GOVUK_ASSET_ROOT`. The default is to generate a URL for the `static` service.
 
 Override the website root with `GOVUK_WEBSITE_ROOT`. The default is to generate a URL for the `www` service.
 
+If `PLEK_USE_HTTP_FOR_SINGLE_LABEL_DOMAINS=1` (or anything beginning with `t`
+or `y`), Plek will use `http` as the URL scheme instead of `https` for
+single-label domains. Single-label domains are domains with just a single name
+component, for example `frontend` or `content-store`, as opposed to
+`frontend.example.com` or `content-store.test.govuk.digital`.
+
 ## Licence
 
 [MIT License](LICENCE)
 
 ## Versioning policy
 
-This is versioned according to [Semantic Versioning 2.0](http://semver.org/)
+This is versioned according to [Semantic Versioning 2.0](https://semver.org/)

data/lib/plek/version.rb

@@ -1,3 +1,3 @@
 class Plek
-  VERSION = '3.0.0'
+  VERSION = "4.1.0".freeze
 end

data/lib/plek.rb

@@ -1,5 +1,5 @@
-require 'plek/version'
-require 'uri'
+require "plek/version"
+require "uri"
 
 # Plek resolves service names to a corresponding base URL.
 #
@@ -17,12 +17,9 @@ class Plek
   class NoConfigurationError < StandardError; end
 
   # The fallback parent domain to use in development mode.
-  DEV_DOMAIN = 'dev.gov.uk'
+  DEV_DOMAIN = "dev.gov.uk".freeze
 
-  # Domains to return http URLs for.
-  HTTP_DOMAINS = [ DEV_DOMAIN ]
-
-  attr_accessor :parent_domain, :external_domain
+  attr_reader :parent_domain, :external_domain
 
   # Construct a new Plek instance.
   #
@@ -37,8 +34,12 @@ class Plek
   #   +GOVUK_APP_DOMAIN_EXTERNAL+ and if that is unavailable the parent domain
   #   will be used
   def initialize(domain_to_use = nil, external_domain = nil)
-    self.parent_domain = domain_to_use || env_var_or_dev_fallback("GOVUK_APP_DOMAIN", DEV_DOMAIN)
-    self.external_domain = external_domain || ENV["GOVUK_APP_DOMAIN_EXTERNAL"] || parent_domain
+    truth_re = /^[1ty]/i
+    @parent_domain = domain_to_use || env_var_or_dev_fallback("GOVUK_APP_DOMAIN", DEV_DOMAIN)
+    @external_domain = external_domain || ENV.fetch("GOVUK_APP_DOMAIN_EXTERNAL", @parent_domain)
+    @host_prefix = ENV.fetch("PLEK_HOSTNAME_PREFIX", "")
+    @unprefixable_hosts = ENV.fetch("PLEK_UNPREFIXABLE_HOSTS", "").split(",").map(&:strip)
+    @use_http_for_single_label_domains = truth_re.match?(ENV.fetch("PLEK_USE_HTTP_FOR_SINGLE_LABEL_DOMAINS", ""))
   end
 
   # Find the base URL for a service/application. This constructs the URL from
@@ -47,12 +48,20 @@ class Plek
   # will be https.
   #
   # If PLEK_HOSTNAME_PREFIX is present in the environment, it will be prepended
-  # to the hostname.
+  # to the hostname unless the hostname appears in the comma-separated list
+  # PLEK_UNPREFIXABLE_HOSTS.
+  #
+  # If PLEK_USE_HTTP_FOR_SINGLE_LABEL_DOMAINS=1 in the environment, Plek will use
+  # "http" as the URL scheme instead of "https" for single-label domains.
+  # Single-label domains are domains with just a single name component, for
+  # example "frontend" or "content-store", as opposed to
+  # "frontend.example.com" or "content-store.test.govuk.digital".
   #
   # The URL for a given service can be overridden by setting a corresponding
   # environment variable.  eg if +PLEK_SERVICE_EXAMPLE_CHEESE_THING_URI+ was
   # set, +Plek.new.find('example-cheese-thing')+ would return the value of that
-  # variable.
+  # variable. This overrides both the "internal" and "external" URL for the
+  # service. It is not possible to override them separately.
   #
   # @param service [String] the name of the service to lookup.  This should be
   #   the hostname of the service.
@@ -62,24 +71,25 @@ class Plek
   #   scheme (eg `//foo.example.com`)
   # @return [String] The base URL for the service.
   def find(service, options = {})
-    name = name_for(service)
-    if service_uri = defined_service_uri_for(name)
+    name = clean_name(service)
+    if (service_uri = defined_service_uri_for(name))
       return service_uri
     end
 
-    host = "#{name}.#{options[:external] ? external_domain : parent_domain}"
+    name = "#{host_prefix}#{name}" unless unprefixable_hosts.include?(name)
 
-    if host_prefix = ENV['PLEK_HOSTNAME_PREFIX']
-      host = "#{host_prefix}#{host}"
-    end
+    domain = options[:external] ? external_domain : parent_domain
+    domain_suffix = domain.empty? ? "" : ".#{domain}"
 
-    if options[:scheme_relative]
-      "//#{host}".freeze
-    elsif options[:force_http] or HTTP_DOMAINS.include?(parent_domain)
-      "http://#{host}".freeze
-    else
-      "https://#{host}".freeze
-    end
+    scheme = if options[:scheme_relative]
+               ""
+             elsif options[:force_http] || http_domain?(domain)
+               "http:"
+             else
+               "https:"
+             end
+
+    "#{scheme}//#{name}#{domain_suffix}".freeze
   end
 
   # Find the external URL for a service/application.
@@ -107,13 +117,6 @@ class Plek
     env_var_or_dev_fallback("GOVUK_ASSET_ROOT") { find("static") }
   end
 
-  # Find the asset host used to serve assets to the public
-  #
-  # @return [String] The public-facing asset base URL
-  def public_asset_host
-    env_var_or_dev_fallback("GOVUK_ASSET_HOST") { find("static") }
-  end
-
   # Find the base URL for the public website frontend.
   #
   # @return [String] The website base URL.
@@ -135,21 +138,16 @@ class Plek
     URI(website_root)
   end
 
-  # @api private
-  def name_for(service)
-    name = service.to_s.dup
-    name.downcase!
-    name.strip!
-    name.gsub!(/[^a-z\.-]+/, '')
-    name
-  end
-
+  # TODO: clean up all references to these and then remove them.
   class << self
     # This alias allows calls to be made in the old style:
     #     Plek.current.find('foo')
     # as well as the new style:
     #     Plek.new.find('foo')
-    alias_method :current, :new
+    def current(...)
+      warn "Plek.current is deprecated and will be removed. Use Plek.new or Plek.find instead."
+      new(...)
+    end
 
     # Convenience wrapper.  The same as calling +Plek.new.find+.
     # @see #find
@@ -164,10 +162,21 @@ class Plek
     end
   end
 
-  private
+private
+
+  attr_reader :host_prefix, :unprefixable_hosts, :use_http_for_single_label_domains
+
+  # TODO: clean up call sites throughout alphagov and then delete clean_name.
+  def clean_name(service)
+    service.to_s.downcase.strip.gsub(/[^a-z.-]+/, "")
+  end
+
+  def http_domain?(domain)
+    domain == DEV_DOMAIN || domain == "" && use_http_for_single_label_domains
+  end
 
   def env_var_or_dev_fallback(var_name, fallback_str = nil)
-    if var = ENV[var_name]
+    if (var = ENV[var_name])
       var
     elsif ENV["RAILS_ENV"] == "production" || ENV["RACK_ENV"] == "production"
       raise(NoConfigurationError, "Expected #{var_name} to be set. Perhaps you should run your task through govuk_setenv <appname>?")
@@ -179,12 +188,8 @@ class Plek
   end
 
   def defined_service_uri_for(service)
-    service_name = service.upcase.gsub(/-/,'_')
-    var_name = "PLEK_SERVICE_#{service_name}_URI"
-
-    if (uri = ENV[var_name] and ! uri.empty?)
-      return uri
-    end
-    return nil
+    service_name = service.upcase.tr("-", "_")
+    uri = ENV.fetch("PLEK_SERVICE_#{service_name}_URI", "")
+    uri.empty? ? nil : uri
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: plek
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: climate_control
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-govuk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.0
 description: Find the right hostname for each service in an environment-dependent
   manner
 email:
@@ -76,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.3.22
 signing_key: 
 specification_version: 4
 summary: Locations for services