defra_ruby_mocks 5.1.3 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aecd68d9ac0f7dd9256d9d8f39eb645d7fc32c45cf9bc8a6e76315029156d81e
-  data.tar.gz: 470e1e68a160dcc92895eccfc862ca7b302fb8a185505afe554d56798a7b7f7a
+  metadata.gz: 2050966a0416ac33fdb18d7b5e99dddb3548ef4d704792441a7a77a6c664b58e
+  data.tar.gz: 555e7313d1587a5f83108a5f3ed42de143cb5b0695ab4e11582e883e0fe0e0a3
 SHA512:
-  metadata.gz: f5fe8f9332df764a30bc808156ec2c61c31ab582bd0d8784bcef5da2a7cdbb7b16d14d9459bcd97b9918f9775803f60ecbbd487d46fd7bfd8c11b7a711f91e54
-  data.tar.gz: bce6423f17b916a7d7447faaee544f9786934e1425e16735b2de95742676cdccfad6746f75caae1c8241d9a1898a0c38e33fd1dd90daf68c7485b6ac3321aceb
+  metadata.gz: 6a423e4730a149e0999d21e47b601b0fa83a011b3048c7eb03eebd2534f01752143b3c0f3c273dc6df37191287e6345cb32b1075c7fe745aab415034f6c8b43e
+  data.tar.gz: 1cb2bc2402d47184315227ba57d31687c1163c0eeacde31b2addd75cdf0e0d41bdbe3710f5c4853a9abbd2d4489a28ccee48f8aeaf4dcaf2beae464b8b4e1696

data/README.md

@@ -171,19 +171,25 @@ This Govpay mock replicates those 2 interactions with the following url
 
 #### Configuration
 
-In order to use the govpay mock you'll need to provide additional configuration details:
+In order to use the govpay mock you'll need to provide additional configuration details.
+- The root Govpay mock URLs for both front- and back-office. Both are required because the mocks for front-office point at back-office and vice-versa, and the mock gem needs to know both values for the two hosting applications.
+- The external URL for both applications. These are required because the mock gem needs to map from internal-EC2 only URLs to externally accessible URLs.
+
+For example, for a front-office application, where the front-office and back-office mocks are mounted on `/fo/mocks` and `/bo/mocks` respectively:
 
 ```ruby
 config/initializers/defra_ruby_mocks.rb
 require "defra_ruby_mocks"
 
 DefraRubyMocks.configure do |config|
-  config.govpay_domain = File.join(ENV["WCRS_GOVPAY_MOCK_DOMAIN"] || "http://localhost:3002", "/fo/mocks/govpay/v1")
+  configuration.govpay_mocks_external_root_url = ENV.fetch("MOCK_FO_GOVPAY_URL", "https://back-office.domain.cloud/bo/mocks/govpay/v1")
+  configuration.govpay_mocks_external_root_url_other = ENV.fetch("MOCK_BO_GOVPAY_URL", "https://front-office.domain.cloud/fo/mocks/govpay/v1")
+
+  configuration.govpay_mocks_internal_root_url = ENV.fetch("MOCK_FO_GOVPAY_URL_INTERNAL", "https://back-office-internal.domain.cloud:8001/bo/mocks/govpay/v1")
+  configuration.govpay_mocks_internal_root_url_other = ENV.fetch("MOCK_BO_GOVPAY_URL_INTERNAL", "https://front-office-internal.domain.cloud:8002/fo/mocks/govpay/v1")
 end
 ```
 
-The domain is used when generating the URL we tell the app to redirect users to. As this is just an engine and not a standalone service, we need to tell it what domain it is running from.
-
 You'll also need to provide AWS configuration details for the mocks, for example:
 
 ```ruby

data/app/services/defra_ruby_mocks/govpay_create_payment_service.rb

@@ -8,17 +8,7 @@ module DefraRubyMocks
     include CanUseAwsS3
 
     def run(amount:, description:)
-      success_response.merge(
-        {
-          _links: {
-            self: { href: "#{base_url}/#{payment_id}", method: "GET" },
-            next_url: { href: "#{base_url}/secure/next-url-uuid-abc123", method: "GET" }
-          },
-          amount: amount.to_i,
-          description: description,
-          payment_id: payment_id
-        }
-      )
+      success_response(amount, description)
     end
 
     private
@@ -28,15 +18,31 @@ module DefraRubyMocks
     end
 
     def base_url
-      File.join(DefraRubyMocks.configuration.govpay_domain, "/payments")
+      File.join(DefraRubyMocks.configuration.govpay_mocks_internal_root_url, "/payments")
     end
 
     def payment_id
       @payment_id ||= SecureRandom.alphanumeric(26)
     end
 
+    def return_url
+      "#{DefraRubyMocks.configuration.govpay_mocks_internal_root_url}/payments/secure/next-url-uuid-abc123"
+    end
+
+    def next_url
+      "#{DefraRubyMocks.configuration.govpay_mocks_external_root_url_other}/payments/secure/next-url-uuid-abc123"
+    end
+
+    def url_root(url)
+      uri = URI.parse(url)
+      url_root = "#{uri.scheme}://#{uri.host}"
+      url_root += ":#{uri.port}" if uri.port.present? && uri.port != 80
+
+      url_root
+    end
+
     # rubocop:disable Metrics/MethodLength
-    def success_response
+    def success_response(amount, description)
       {
         created_date: "2020-03-03T16:17:19.554Z",
         state: {
@@ -45,19 +51,19 @@ module DefraRubyMocks
         },
         _links: {
           self: {
-            href: "https://publicapi.payments.service.gov.uk/v1/payments/hu20sqlact5260q2nanm0q8u93",
+            href: "#{base_url}/#{payment_id}",
             method: "GET"
           },
           next_url: {
-            href: "https://www.payments.service.gov.uk/secure/bb0a272c-8eaf-468d-b3xf-ae5e000d2231",
+            href: next_url,
             method: "GET"
           }
         },
-        amount: 14_500,
+        amount: amount.to_i,
         reference: "12345",
-        description: "Pay your council tax",
-        return_url: "https://your.service.gov.uk/completed",
-        payment_id: "hu20sqlact5260q2nanm0q8u93",
+        description:,
+        return_url:,
+        payment_id:,
         payment_provider: "worldpay",
         provider_id: "10987654321"
       }

data/lib/defra_ruby_mocks/configuration.rb

@@ -5,7 +5,10 @@ module DefraRubyMocks
 
     DEFAULT_DELAY = 1000
 
-    attr_accessor :govpay_domain
+    attr_accessor :govpay_mocks_external_root_url,
+                  :govpay_mocks_external_root_url_other,
+                  :govpay_mocks_internal_root_url,
+                  :govpay_mocks_internal_root_url_other
     attr_reader :delay
 
     def initialize

data/lib/defra_ruby_mocks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DefraRubyMocks
-  VERSION = "5.1.3"
+  VERSION = "5.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 5.1.3
+  version: 5.2.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails