plek 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dce9ccd2cdfbd98e5f5d400b89afc268e7ac85eede91425d6999a45d8c8241e7
-  data.tar.gz: fb644ee1e4abefa8d133083e6dae182c4d6292cd9079a39e890a7d81a7d7846e
+  metadata.gz: 1157f1b8a26836a70c428e595d27392858f6a858043dd44bfeda13314c4e7e99
+  data.tar.gz: 7b970caacd3c079d9bd31836fbc53dee83d98da3110982f67e16d618c89e5f91
 SHA512:
-  metadata.gz: 152b9b257a2d0ccc8dc1a0854e0e63ee75464173561d4b6eb781caafbb9a89abcd56ff9bb0cd31bb24f297a23a45d07f6bbd45ceb7911ff34ca88b8539391211
-  data.tar.gz: df7e4c1d134ede43491e7bb1e8ff0f1568bf3e9b39a64a2487fae48f800fdda709ca43f092bbaa1eca451a6e3324a7d5c33d73b6e23ea9947032d2efb6e85dd5
+  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 = "4.0.0".freeze
+  VERSION = "4.1.0".freeze
 end

data/lib/plek.rb

@@ -19,10 +19,7 @@ class Plek
   # The fallback parent domain to use in development mode.
   DEV_DOMAIN = "dev.gov.uk".freeze
 
-  # Domains to return http URLs for.
-  HTTP_DOMAINS = [DEV_DOMAIN].freeze
-
-  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)
+    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] || 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.
@@ -128,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
@@ -159,6 +164,17 @@ class Plek
 
 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])
       var
@@ -172,13 +188,8 @@ private
   end
 
   def defined_service_uri_for(service)
-    service_name = service.upcase.gsub(/-/, "_")
-    var_name = "PLEK_SERVICE_#{service_name}_URI"
-
-    if (uri = ENV[var_name]) && !uri.empty?
-      return uri
-    end
-
-    nil
+    service_name = service.upcase.tr("-", "_")
+    uri = ENV.fetch("PLEK_SERVICE_#{service_name}_URI", "")
+    uri.empty? ? nil : uri
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plek
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.0
 description: Find the right hostname for each service in an environment-dependent
   manner
 email:
@@ -90,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.3
+rubygems_version: 3.3.22
 signing_key: 
 specification_version: 4
 summary: Locations for services