publishing_platform_location 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cea489133b10f18be67c20af744c161aa686bf4c73e204b3098ea64a2420179e
+  data.tar.gz: d5c354319edcb0c9bbd6ef5a21097f3fc62218cbe7086e10c0445d2042a262ac
+SHA512:
+  metadata.gz: 4bc9629278aadbfc40ac6528ce68be1b8a01ab93bfa124a93a37764b04c26d23e345e795e562d3364319dca22a669887469cf50cb287ab91f94990c9ec2ca9ad
+  data.tar.gz: cb498ea0b259573b7e359b697de94a5bd5fc7a92ddef343828b88ca68cb98e4b56baa68275c77ad8696499c72a7bf9b490303b90b9d983199f60415cd6c76bbc

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Publishing Platform
+Copyright (c) 2011 Crown Copyright
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# publishing_platform_location
+Generates URLs for publishing platform services based on environment.

data/lib/publishing_platform_location/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class PublishingPlatformLocation
+  VERSION = "0.1.0"
+end

data/lib/publishing_platform_location.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "publishing_platform_location/version"
+require "forwardable"
+
+class PublishingPlatformLocation
+  # Raised when a required environment variable is not set.
+  class NoConfigurationError < StandardError; end
+
+  # The fallback parent domain to use in development mode.
+  DEV_DOMAIN = "dev.publishing-platform.co.uk"
+
+  attr_reader :parent_domain, :external_domain
+
+  # Construct a new PublishingPlatformLocation instance.
+  def initialize(domain_to_use = nil, external_domain = nil)
+    @parent_domain = domain_to_use || env_var_or_fallback("PUBLISHING_PLATFORM_APP_DOMAIN", DEV_DOMAIN) # empty string for internal services
+    @external_domain = external_domain || ENV.fetch("PUBLISHING_PLATFORM_APP_DOMAIN_EXTERNAL", @parent_domain)
+  end
+
+  # Find the base URL for a service/application.
+  def find(service, options = {})
+    name = valid_service_name(service)
+
+    domain = options[:external] ? external_domain : parent_domain
+    domain_suffix = domain.empty? ? "" : ".#{domain}" # empty string for internal services
+
+    scheme = if options[:force_http] || http_domain?(domain)
+               "http:"
+             else
+               "https:"
+             end
+
+    "#{scheme}//#{name}#{domain_suffix}".freeze
+  end
+
+  # Find the external URL for a service/application.
+  def external_url_for(service, options = {})
+    find(service, options.merge(external: true))
+  end
+
+  # Find the base URL for the public website frontend.
+  def website_root
+    env_var_or_fallback("PUBLISHING_PLATFORM_WEBSITE_ROOT") { find("www") }
+  end
+
+  class << self
+    extend Forwardable
+
+    def_delegators :new, :find, :external_url_for, :website_root
+  end
+
+private
+
+  def valid_service_name(name)
+    service_name = name.to_s
+    return service_name if service_name.match?(/\A[a-z1-9.-]+\z/)
+
+    raise ArgumentError, "PublishingPlatformLocation expects a service name to only contain lowercase a-z, numbers . (period) and - (dash) characters."
+  end
+
+  def http_domain?(domain)
+    [DEV_DOMAIN, ""].include?(domain) # internal services
+  end
+
+  def env_var_or_fallback(var_name, fallback_str = nil)
+    if (var = ENV[var_name])
+      var
+    elsif ENV["RAILS_ENV"] == "production" || ENV["RACK_ENV"] == "production"
+      raise(NoConfigurationError, "Expected #{var_name} to be set.")
+    elsif block_given?
+      yield
+    else
+      fallback_str
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: publishing_platform_location
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Publishing Platform
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-06-03 00:00:00.000000000 Z
+dependencies:
+- !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: publishing_platform_rubocop
+  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'
+description: Generates URLs for publishing platform services based on environment.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/publishing_platform_location.rb
+- lib/publishing_platform_location/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Generates URLs for publishing platform services based on environment.
+test_files: []