defra_ruby_mocks 5.1.3 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aecd68d9ac0f7dd9256d9d8f39eb645d7fc32c45cf9bc8a6e76315029156d81e
-  data.tar.gz: 470e1e68a160dcc92895eccfc862ca7b302fb8a185505afe554d56798a7b7f7a
+  metadata.gz: e5df956ffaf0644fb9dae96ae157ec7f45b8121d6bc42e5cd96164de8470342a
+  data.tar.gz: 6da12c96f050164e579932bf9ad188866198db203893ab436fc84c0a1e4ceeb8
 SHA512:
-  metadata.gz: f5fe8f9332df764a30bc808156ec2c61c31ab582bd0d8784bcef5da2a7cdbb7b16d14d9459bcd97b9918f9775803f60ecbbd487d46fd7bfd8c11b7a711f91e54
-  data.tar.gz: bce6423f17b916a7d7447faaee544f9786934e1425e16735b2de95742676cdccfad6746f75caae1c8241d9a1898a0c38e33fd1dd90daf68c7485b6ac3321aceb
+  metadata.gz: df8d21f730573cdf3d97f10a6e41a4c2d7464e62ac3c5d032190fb6b5b9a21c9bc7a76cce56fadcfb757affd1cb21b1c2b5a6bc8a24c33c1a8db882543ffab14
+  data.tar.gz: bed07b31c14573ba390b13294a69f3209538616bd360379d0efb7b6dcc7b57c42406b6b4cc6e1cdc307933851e07c4537f876c0f9f8e80afdc953bdeec10a47d

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/controllers/defra_ruby_mocks/govpay_test_helpers_controller.rb

@@ -25,16 +25,16 @@ module DefraRubyMocks
 
     # This schedules a job to send a mock payment webhook.
     def send_payment_webhook
-      Rails.logger.warn "[DefraRubyMocks] [send_payment_webhook] " \
-                        "params: #{params[:govpay_id]}, status #{params[:payment_status]}"
+      Rails.logger.warn "[DefraRubyMocks] [send_payment_webhook] #{params.slice(:govpay_payment_id,
+                                                                                :govpay_payment_payment_status)}"
 
-      %w[govpay_id payment_status callback_url signing_secret].each do |p|
+      %w[govpay_payment_id govpay_payment_status callback_url signing_secret].each do |p|
         raise StandardError, "Missing parameter: '#{p}'" unless params[p].present?
       end
 
       SendPaymentWebhookJob.perform_later(
-        govpay_id: params[:govpay_id],
-        status: params[:payment_status],
+        govpay_payment_id: params[:govpay_payment_id],
+        govpay_payment_status: params[:govpay_payment_status],
         callback_url: params[:callback_url],
         signing_secret: params[:signing_secret]
       )
@@ -44,16 +44,17 @@ module DefraRubyMocks
 
     # This schedules a job to send a mock refund webhook.
     def send_refund_webhook
-      Rails.logger.warn "[DefraRubyMocks] [send_refund webhook] " \
-                        "params: #{params[:govpay_id]}, status #{params[:refund_status]}"
+      Rails.logger.warn "[DefraRubyMocks] [send_refund webhook] #{params.slice(:govpay_refund_id, :govpay_payment_id,
+                                                                               :govpay_refund_status)}"
 
-      %w[govpay_id refund_status callback_url signing_secret].each do |p|
+      %w[govpay_payment_id govpay_refund_id govpay_refund_status callback_url signing_secret].each do |p|
         raise StandardError, "Missing parameter: '#{p}'" unless params[p].present?
       end
 
       SendRefundWebhookJob.perform_later(
-        govpay_id: params[:govpay_id],
-        status: params[:refund_status],
+        govpay_payment_id: params[:govpay_payment_id],
+        govpay_refund_id: params[:govpay_refund_id],
+        govpay_refund_status: params[:govpay_refund_status],
         callback_url: params[:callback_url],
         signing_secret: params[:signing_secret]
       )

data/app/jobs/base_send_webhook_job.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 class BaseSendWebhookJob < ApplicationJob
-  def perform(govpay_id:, status:, callback_url:, signing_secret:)
-    body = webhook_body(govpay_id:, status:)
-    Rails.logger.warn "[DefraRubyMocks] [BaseSendWebhookJob] sending #{webhook_type} webhook " \
-                      "for #{govpay_id}, status \"#{status}\" to #{callback_url}"
+  attr_accessor :govpay_payment_id, :callback_url, :signing_secret
+
+  def post_callback
+    body = webhook_body
+
     RestClient::Request.execute(
       method: :post,
       url: callback_url,
-      payload: body.to_json,
-      headers: { "Pay-Signature": webhook_signature(body, signing_secret) }
+      headers: { "Pay-Signature": webhook_signature(body, signing_secret) },
+      payload: body.to_json
     )
   rescue StandardError => e
     Rails.logger.error "[DefraRubyMocks] [BaseSendWebhookJob] error sending  " \
@@ -22,7 +23,7 @@ class BaseSendWebhookJob < ApplicationJob
     raise NotImplementedError
   end
 
-  def webhook_body(govpay_id:, status:)
+  def webhook_body
     raise NotImplementedError
   end
 

data/app/jobs/send_payment_webhook_job.rb

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
 
 class SendPaymentWebhookJob < BaseSendWebhookJob
+  attr_accessor :govpay_payment_status
+
+  def perform(govpay_payment_id:, govpay_payment_status:, callback_url:, signing_secret:)
+    @govpay_payment_id = govpay_payment_id
+    @govpay_payment_status = govpay_payment_status
+    @callback_url = callback_url
+    @signing_secret = signing_secret
+
+    Rails.logger.warn "[DefraRubyMocks] [SendPaymentWebhookJob] sending #{webhook_type} webhook " \
+                      "for #{govpay_payment_id}, status \"#{govpay_payment_status}\" to #{callback_url}"
+
+    post_callback
+  end
 
   private
 
@@ -8,11 +21,11 @@ class SendPaymentWebhookJob < BaseSendWebhookJob
     "payment"
   end
 
-  def webhook_body(govpay_id:, status:)
+  def webhook_body
     webhook_body ||= JSON.parse(File.read("lib/fixtures/files/govpay/webhook_payment_update_body.json"))
 
-    webhook_body["resource"]["payment_id"] = govpay_id
-    webhook_body["resource"]["state"]["status"] = status
+    webhook_body["resource"]["payment_id"] = govpay_payment_id
+    webhook_body["resource"]["state"]["status"] = govpay_payment_status
 
     webhook_body
   end

data/app/jobs/send_refund_webhook_job.rb

@@ -1,6 +1,21 @@
 # frozen_string_literal: true
 
 class SendRefundWebhookJob < BaseSendWebhookJob
+  attr_accessor :govpay_refund_id, :govpay_refund_status
+
+  def perform(govpay_payment_id:, govpay_refund_id:, govpay_refund_status:, callback_url:, signing_secret:)
+    @govpay_payment_id = govpay_payment_id
+    @govpay_refund_status = govpay_refund_status
+    @govpay_refund_id = govpay_refund_id
+    @callback_url = callback_url
+    @signing_secret = signing_secret
+
+    Rails.logger.warn "[DefraRubyMocks] [SendRefundWebhookJob] sending #{webhook_type} webhook " \
+                      "for payment #{govpay_payment_id}, refund #{govpay_refund_id}, status  " \
+                      "\"#{govpay_refund_status}\" to #{callback_url}"
+
+    post_callback
+  end
 
   private
 
@@ -8,11 +23,12 @@ class SendRefundWebhookJob < BaseSendWebhookJob
     "refund"
   end
 
-  def webhook_body(govpay_id:, status:)
+  def webhook_body
     webhook_body ||= JSON.parse(File.read("lib/fixtures/files/govpay/webhook_refund_update_body.json"))
 
-    webhook_body["refund_id"] = govpay_id
-    webhook_body["status"] = status
+    webhook_body["refund_id"] = govpay_refund_id
+    webhook_body["payment_id"] = govpay_payment_id
+    webhook_body["status"] = govpay_refund_status
 
     webhook_body
   end

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/config/routes.rb

@@ -47,12 +47,12 @@ DefraRubyMocks::Engine.routes.draw do # rubocop:disable Metrics/BlockLength
       as: "govpay_set_test_refund_response_status",
       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
-  post "/govpay/v1/payments/:govpay_id/send_payment_webhook",
+  post "/govpay/v1/payments/send_payment_webhook",
        to: "govpay_test_helpers#send_payment_webhook",
        as: "send_payment_webhook",
        constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
-  post "/govpay/v1/payments/:govpay_id/send_refund_webhook",
+  post "/govpay/v1/payments/send_refund_webhook",
        to: "govpay_test_helpers#send_refund_webhook",
        as: "send_refund_webhook",
        constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }

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.3.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.3.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 2025-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails