plek 1.12.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1314ffc3512610c4d3b415b260286a96e21219f
-  data.tar.gz: 6c93d8d7b008a5c3c33e5dbfb0e04d748a086bca
+SHA256:
+  metadata.gz: dce9ccd2cdfbd98e5f5d400b89afc268e7ac85eede91425d6999a45d8c8241e7
+  data.tar.gz: fb644ee1e4abefa8d133083e6dae182c4d6292cd9079a39e890a7d81a7d7846e
 SHA512:
-  metadata.gz: 38c576ef1e98d8d05a9e74e95f0475f5ca72409b93c30b32c6d656f4df14f0c9851c64fe073e48c425576802406425157c6828a92efbf1487179169df2d2406c
-  data.tar.gz: d93efae49515bc45665f2a57953c156f523f46cc4c2e4bf44af89a6083361f817bf977dc039c7ff68033d0bd50ede418283eb17ed47b18a644f366d76d520412
+  metadata.gz: 152b9b257a2d0ccc8dc1a0854e0e63ee75464173561d4b6eb781caafbb9a89abcd56ff9bb0cd31bb24f297a23a45d07f6bbd45ceb7911ff34ca88b8539391211
+  data.tar.gz: df7e4c1d134ede43491e7bb1e8ff0f1568bf3e9b39a64a2487fae48f800fdda709ca43f092bbaa1eca451a6e3324a7d5c33d73b6e23ea9947032d2efb6e85dd5

data/README.md

@@ -3,14 +3,28 @@
 "Plek" is Afrikaans. It means "Location". Plek is used to generate the correct
 base URLs for internal GOV.UK services, eg:
 
-```ruby
-Plek.find('frontend')
 ```
+# on a dev machine
+> Plek.find('frontend')
+=> "http://frontend.dev.gov.uk"
+# on a production machine
+> Plek.find('frontend')
+=> "https://frontend.publishing.service.gov.uk"
+```
+
+This means we can use this in our code and let our environment configuration
+figure out the correct hosts for us at runtime.
+
+In an environment where we have internal hostnames and external ones an option
+of `external` can be provided to determine whether an internal or external
+host is returned.
 
-returns `http://frontend.dev.gov.uk` on a development machine and
-`https://frontend.production.alphagov.co.uk` on a production machine. This
-means we can use this in our code and let our environment configuration figure
-out the correct hosts for us at runtime.
+```
+> Plek.find('frontend')
+=> "https://frontend.integration.govuk-internal.digital"
+> Plek.find('frontend', external: true)
+=> "https://frontend.integration.publishing.service.gov.uk"
+```
 
 ## Technical documentation
 
@@ -34,7 +48,7 @@ For example, the variable for `static` would be `PLEK_SERVICE_STATIC_URI`.
 
 #### Others
 
-To override the development environment base domain, set `DEV_DOMAIN`. The default is `dev.gov.uk`. The environment can be set using either `RAILS_ENV` or `RACK_ENV`.
+To domain is based on the environment, and defaults to 'dev.gov.uk'. The environment can be set using either `RAILS_ENV` or `RACK_ENV`.
 
 You can prepend strings to the hostnames generated using: `PLEK_HOSTNAME_PREFIX`.
 

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,22 +17,28 @@ class Plek
   class NoConfigurationError < StandardError; end
 
   # The fallback parent domain to use in development mode.
-  DEV_DOMAIN = ENV['DEV_DOMAIN'] || 'dev.gov.uk'
+  DEV_DOMAIN = "dev.gov.uk".freeze
 
   # Domains to return http URLs for.
-  HTTP_DOMAINS = [ DEV_DOMAIN ]
+  HTTP_DOMAINS = [DEV_DOMAIN].freeze
 
-  attr_accessor :parent_domain
+  attr_accessor :parent_domain, :external_domain
 
   # Construct a new Plek instance.
   #
-  # @param domain_to_use [String] Optionally override the parent domain to use.
-  #   If unspecified, this uses the +GOVUK_APP_DOMAIN+ environment variable.
+  # @param domain_to_use [String, nil] Optionally override the parent domain
+  #   to use. If unspecified, this uses the +GOVUK_APP_DOMAIN+ environment
+  #   variable.
   #
   #   In development mode, this falls back to {DEV_DOMAIN} if the environment
   #   variable is unset.
-  def initialize(domain_to_use = nil)
+  # @param external_domain [String, nil] Optionally override the external
+  #   domain to use. If unspecified it will fall back to using
+  #   +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
   end
 
   # Find the base URL for a service/application. This constructs the URL from
@@ -57,25 +63,34 @@ class Plek
   # @return [String] The base URL for the service.
   def find(service, options = {})
     name = name_for(service)
-    if service_uri = defined_service_uri_for(name)
+    if (service_uri = defined_service_uri_for(name))
       return service_uri
     end
 
-    host = "#{name}.#{parent_domain}"
+    host = "#{name}.#{options[:external] ? external_domain : parent_domain}"
 
-    if host_prefix = ENV['PLEK_HOSTNAME_PREFIX']
+    if (host_prefix = ENV["PLEK_HOSTNAME_PREFIX"])
       host = "#{host_prefix}#{host}"
     end
 
     if options[:scheme_relative]
-      "//#{host}"
-    elsif options[:force_http] or HTTP_DOMAINS.include?(parent_domain)
-      "http://#{host}"
+      "//#{host}".freeze
+    elsif options[:force_http] || HTTP_DOMAINS.include?(parent_domain)
+      "http://#{host}".freeze
     else
-      "https://#{host}"
+      "https://#{host}".freeze
     end
   end
 
+  # Find the external URL for a service/application.
+  #
+  # @param service [String] the name of the service to lookup.  This should be
+  #   the hostname of the service.
+  # @param options [Hash] see the documentation for find.
+  def external_url_for(service, options = {})
+    find(service, options.merge(external: true))
+  end
+
   # Find the base URL for a service/application, and parse as a URI object.
   # This wraps #find and returns the parsed result.
   #
@@ -92,13 +107,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.
@@ -125,7 +133,7 @@ class Plek
     name = service.to_s.dup
     name.downcase!
     name.strip!
-    name.gsub!(/[^a-z\.-]+/, '')
+    name.gsub!(/[^a-z\.-]+/, "")
     name
   end
 
@@ -149,10 +157,10 @@ class Plek
     end
   end
 
-  private
+private
 
   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>?")
@@ -164,12 +172,13 @@ class Plek
   end
 
   def defined_service_uri_for(service)
-    service_name = service.upcase.gsub(/-/,'_')
+    service_name = service.upcase.gsub(/-/, "_")
     var_name = "PLEK_SERVICE_#{service_name}_URI"
 
-    if (uri = ENV[var_name] and ! uri.empty?)
+    if (uri = ENV[var_name]) && !uri.empty?
       return uri
     end
-    return nil
+
+    nil
   end
 end

data/lib/plek/version.rb

@@ -1,3 +1,3 @@
 class Plek
-  VERSION = '1.12.0'
+  VERSION = "4.0.0".freeze
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: plek
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 4.0.0
 platform: ruby
 authors:
-- Craig R Webster
+- GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gem_publisher
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: climate_control
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +69,7 @@ dependencies:
 description: Find the right hostname for each service in an environment-dependent
   manner
 email:
-- craig@barkingiguana.com
+- govuk-dev@digital.cabinet-office.gov.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -97,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Locations for services