plek 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db58b6a4a924d4c06eed2f4aa05251a733b71ccf
-  data.tar.gz: 4a59305d33e96a082ecce8e9908aadacc8bc21f6
+  metadata.gz: 42c206eb83b9c41dc31647b2d72dc48efaaff889
+  data.tar.gz: 5c8371aed356ad734c2ce789e488e3a2c473d794
 SHA512:
-  metadata.gz: db7341e606a4629f61f87ccf1cb2087f2b70a10bf3513cd301e6e867313eab3dc52ca3bfc6a2e69a900352f66f707634f8ebc33866e70d50ecba071f5d5f81d3
-  data.tar.gz: afc6924a5f847f6268f16561caa194fbe491509d3f899b38bc36d022dd5f6c62e6a0c1f1920432b2d8f483d04646ef4a9dbbb02cd217471a5bcf0299233c3ea0
+  metadata.gz: dee761715a61b7ab2cd78b874b3ca0e22810893b31cdd9273b10ff629fdf5451572e409ed5015ca3685259197e74a2c3a2c14d83ebf942a84352c850b233ab26
+  data.tar.gz: 4049d5ad0a3f9b58a14109e0f47c677c80314b385b34ad1e78e3dfa11934c4d82012db7de2d9e9918d819274642ca4367411649a426a7113bc8888e3869e6cc7

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.publishing.service.gov.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
 

data/lib/plek.rb

@@ -26,15 +26,19 @@ class Plek
 
   # 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.
+  # @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_var_or_dev_fallback("GOVUK_APP_DOMAIN_EXTERNAL", 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

data/lib/plek/version.rb

@@ -1,3 +1,3 @@
 class Plek
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plek
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Craig R Webster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake