defra_ruby_mocks 4.2.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6394eef6671bf7402ae9086113fa641729b149df46d6f1fcb6a1d3281c19b742
-  data.tar.gz: 5e0606b7bb200a849cea22cd1abbee314cbbf0449fb7003de05b85be7ef57136
+  metadata.gz: f12b1df78280f62fd050fc87d169a323a5596e170a3f4908d6e98eac105bbd35
+  data.tar.gz: c01fdde1d3574ad5c12fc89256ae31af9fb326a96d505410f5b3d3189b62f003
 SHA512:
-  metadata.gz: 1dea451c6e0c2e98c913b8d8c5d0c67915a7548a0d3a648f1d891df3c0b4ca40b7c47d8c82ecc2a8b8d9e3a9ec290e07bb628452dfa37fea9e8fa940d381ef5e
-  data.tar.gz: 762b4407b39d0538f7386a3733b915a217dd810c787ca0080b4be8684ed4857349e6b26258e3eb4a7cf74eddf90cfa3c385a3b3df5235fe72dc9d100a9e8540a
+  metadata.gz: fe25184586116d837320be07f712f56c47c9728c906b6d7a43ceddd908614fffae27fd5a408181633f90c20a50818fa2cee11f0c6e3a6c6dac19707dced20a76
+  data.tar.gz: 1d54bd00a0bca62769bc1b91c27a2521b27de9cce062905787e7cec8c72d58297805a48700de041a287db7aebc21a77bd305484cbfca617eb43860a900de83dd

data/app/controllers/defra_ruby_mocks/govpay_test_helpers_controller.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class GovpayTestHelpersController < ::DefraRubyMocks::ApplicationController
+
+    skip_before_action :verify_authenticity_token
+
+    # These are helpers for the automated acceptance tests.
+
+    # The mock will use the value passed in to populate the status field on all future payments.
+    def set_test_payment_response_status
+      Rails.logger.info "MOCKS: Setting payment response status to #{params[:status]}"
+
+      AwsBucketService.write(s3_bucket_name, "test_payment_response_status", params[:status])
+
+      head 200
+    end
+
+    # The mock will use the value passed in to populate the status field on all future refunds.
+    def set_test_refund_response_status
+      Rails.logger.info "MOCKS: Setting refund response status to #{params[:status]}"
+
+      AwsBucketService.write(s3_bucket_name, "test_refund_response_status", params[:status])
+
+      head 200
+    end
+
+    # This schedules a job to send a mock payment webhook.
+    def send_payment_webhook
+      Rails.logger.warn "MOCKS: Sending payment webhook for #{params[:govpay_id]}, status #{params[:payment_status]}"
+      %w[govpay_id 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],
+        callback_url: params[:callback_url],
+        signing_secret: params[:signing_secret]
+      )
+
+      head 200
+    end
+
+    # This schedules a job to send a mock refund webhook.
+    def send_refund_webhook
+      Rails.logger.warn "MOCKS: Sending refund webhook for #{params[:govpay_id]}, status #{params[:refund_status]}"
+      %w[govpay_id 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],
+        callback_url: params[:callback_url],
+        signing_secret: params[:signing_secret]
+      )
+
+      head 200
+    end
+
+    private
+
+    def s3_bucket_name
+      @s3_bucket_name = ENV.fetch("AWS_DEFRA_RUBY_MOCKS_BUCKET", nil)
+    end
+  end
+end

data/app/jobs/application_job.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+  queue_as :default
+end

data/app/jobs/base_send_webhook_job.rb

@@ -0,0 +1,31 @@
+# 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 "MOCKS: sending #{webhook_type} webhook for #{govpay_id}, status \"#{status}\" to #{callback_url}"
+    RestClient::Request.execute(
+      method: :get,
+      url: callback_url,
+      body: body,
+      headers: { "Pay-Signature": webhook_signature(body, signing_secret) }
+    )
+  rescue StandardError => e
+    Rails.logger.error "MOCKS: error sending #{webhook_type} webhook to #{callback_url}: #{e}\n#{e.backtrace}"
+  end
+
+  private
+
+  def webhook_type
+    raise NotImplementedError
+  end
+
+  def webhook_body(govpay_id:, status:)
+    raise NotImplementedError
+  end
+
+  def webhook_signature(webhook_body, signing_secret)
+    OpenSSL::HMAC.hexdigest("sha256", signing_secret.encode("utf-8"), webhook_body.to_json.encode("utf-8"))
+  end
+
+end

data/app/jobs/send_payment_webhook_job.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class SendPaymentWebhookJob < BaseSendWebhookJob
+
+  private
+
+  def webhook_type
+    "payment"
+  end
+
+  def webhook_body(govpay_id:, status:)
+    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
+  end
+end

data/app/jobs/send_refund_webhook_job.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class SendRefundWebhookJob < BaseSendWebhookJob
+
+  private
+
+  def webhook_type
+    "refund"
+  end
+
+  def webhook_body(govpay_id:, status:)
+    webhook_body ||= JSON.parse(File.read("lib/fixtures/files/govpay/webhook_refund_update_body.json"))
+
+    webhook_body["payment_id"] = govpay_id
+    webhook_body["status"] = status
+
+    webhook_body
+  end
+end

data/app/services/defra_ruby_mocks/aws_bucket_service.rb

@@ -16,10 +16,15 @@ module DefraRubyMocks
       new.read(bucket_name, file_name)
     end
 
+    def self.remove(bucket_name, file_name)
+      Rails.logger.debug ":::::: mocks removing #{file_name} on S3"
+      new.remove(bucket_name, file_name)
+    end
+
     def write(bucket_name, file_name, content)
       @bucket_name = bucket_name
       @file_name = file_name
-      Rails.logger.debug ":::::: mocks writing to S3"
+      Rails.logger.debug ":::::: mocks writing #{file_name} to S3"
 
       write_temp_file(content)
 
@@ -31,20 +36,30 @@ module DefraRubyMocks
     def read(bucket_name, file_name)
       @bucket_name = bucket_name
       @file_name = file_name
-      Rails.logger.debug ":::::: mocks reading from S3"
+      Rails.logger.debug ":::::: mocks reading #{file_name} from S3"
+
+      s3.get_object(bucket: bucket_name, key: file_name).body.read
+    end
+
+    def remove(bucket_name, file_name)
+      @bucket_name = bucket_name
+      Rails.logger.debug ":::::: mocks removing #{file_name} from S3"
 
-      s3 = Aws::S3::Client.new(
+      bucket.delete(file_name)
+    end
+
+    private
+
+    def s3
+      @s3 ||= Aws::S3::Client.new(
         region: ENV.fetch("AWS_REGION", nil),
         credentials: Aws::Credentials.new(
           ENV.fetch("AWS_DEFRA_RUBY_MOCKS_ACCESS_KEY_ID", nil),
           ENV.fetch("AWS_DEFRA_RUBY_MOCKS_SECRET_ACCESS_KEY", nil)
         )
       )
-      s3.get_object(bucket: bucket_name, key: file_name).body.read
     end
 
-    private
-
     def temp_filepath
       "#{Dir.tmpdir}/#{file_name}"
     end

data/app/services/defra_ruby_mocks/govpay_create_payment_service.rb

@@ -21,6 +21,19 @@ module DefraRubyMocks
 
     private
 
+    def s3_bucket_name
+      @s3_bucket_name = ENV.fetch("AWS_DEFRA_RUBY_MOCKS_BUCKET", nil)
+    end
+
+    # Check if a non-default status value has been requested
+    def test_payment_response_status
+      AwsBucketService.read(s3_bucket_name, "test_payment_response_status") || "created"
+    rescue StandardError => e
+      # This is expected behaviour when the payment status default override file is not present.
+      Rails.logger.warn ":::::: mocks failed to read test_payment_response_status: #{e}"
+      "created"
+    end
+
     def base_url
       File.join(DefraRubyMocks.configuration.govpay_domain, "/payments")
     end
@@ -34,7 +47,7 @@ module DefraRubyMocks
       {
         created_date: "2020-03-03T16:17:19.554Z",
         state: {
-          status: "created",
+          status: test_payment_response_status,
           finished: false
         },
         _links: {

data/app/services/defra_ruby_mocks/govpay_get_payment_service.rb

@@ -19,6 +19,15 @@ module DefraRubyMocks
 
     private
 
+    # Check if a non-default status value has been requested
+    def test_payment_response_status
+      AwsBucketService.read(s3_bucket_name, "test_payment_response_status") || "success"
+    rescue StandardError => e
+      # This is expected behaviour when the payment status default override file is not present.
+      Rails.logger.warn ":::::: mocks failed to read test_payment_response_status: #{e}"
+      "success"
+    end
+
     # rubocop:disable Metrics/MethodLength
     def response_success
       {
@@ -32,7 +41,7 @@ module DefraRubyMocks
         },
         email: "sherlock.holmes@example.com",
         state: {
-          status: "success",
+          status: test_payment_response_status,
           finished: true
         },
         payment_id: "cnnffa1e6s3u9a6n24u2cp527d",

data/app/services/defra_ruby_mocks/govpay_refund_details_service.rb

@@ -19,14 +19,24 @@ module DefraRubyMocks
 
     private
 
-    # "submitted" for up to GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG seconds after the last refund request, then "success"
+    # Check if a non-default status value has been requested
+    def test_refund_response_status
+      AwsBucketService.read(s3_bucket_name, "test_refund_response_status") || "submitted"
+    rescue StandardError => e
+      # This is expected behaviour when the refund status default override file is not present.
+      Rails.logger.warn ":::::: mocks failed to read test_refund_response_status: #{e}"
+      "submitted"
+    end
+
+    # "submitted" (or other, if default override is in place) for up to GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG
+    # seconds after the last refund request, then "success"
     def status
       last_refund_time = refund_request_timestamp
       submitted_success_lag = ENV.fetch("GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG", 0).to_i
       cutoff_time = (last_refund_time + submitted_success_lag.seconds).to_time
       return "success" if submitted_success_lag.zero?
 
-      Time.zone.now < cutoff_time ? "submitted" : "success"
+      Time.zone.now < cutoff_time ? test_refund_response_status : "success"
     rescue Errno::ENOENT
       write_timestamp_file
 
@@ -40,7 +50,7 @@ module DefraRubyMocks
     end
 
     def s3_bucket_name
-      @s3_bucket_name = ENV.fetch("GOVPAY_MOCKS_BUCKET", "defra-ruby-mocks-s3bkt001")
+      @s3_bucket_name = ENV.fetch("AWS_DEFRA_RUBY_MOCKS_BUCKET", nil)
     end
 
     def timestamp_file_name

data/app/services/defra_ruby_mocks/govpay_request_refund_service.rb

@@ -6,17 +6,25 @@ module DefraRubyMocks
     def run(payment_id:, amount:, refund_amount_available:) # rubocop:disable Lint/UnusedMethodArgument
       write_timestamp
 
-      # This currently supports only "submitted" status:
       {
         amount: amount,
         created_date: "2019-09-19T16:53:03.213Z",
         refund_id: SecureRandom.hex(22),
-        status: "submitted"
+        status: test_refund_response_status
       }
     end
 
     private
 
+    # Check if a non-default status value has been requested
+    def test_refund_response_status
+      AwsBucketService.read(s3_bucket_name, "test_refund_response_status") || "submitted"
+    rescue StandardError => e
+      # This is expected behaviour when the refund status default override file is not present.
+      Rails.logger.warn ":::::: mocks failed to read test_refund_response_status: #{e}"
+      "submitted"
+    end
+
     # let the refund details service know how long since the refund was requested
     def write_timestamp
       Rails.logger.warn ":::::: storing refund request timestamp"
@@ -24,7 +32,7 @@ module DefraRubyMocks
     end
 
     def s3_bucket_name
-      @s3_bucket_name = ENV.fetch("GOVPAY_MOCKS_BUCKET", "defra-ruby-mocks-s3bkt001")
+      @s3_bucket_name = ENV.fetch("AWS_DEFRA_RUBY_MOCKS_BUCKET", nil)
     end
 
     def timestamp_file_name

data/config/routes.rb

@@ -35,4 +35,25 @@ DefraRubyMocks::Engine.routes.draw do # rubocop:disable Metrics/BlockLength
       to: "govpay#refund_details",
       as: "govpay_refund_details",
       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
+  # test helpers, not mocks:
+  get "/govpay/v1/payments/set_test_payment_response_status/:status",
+      to: "govpay_test_helpers#set_test_payment_response_status",
+      as: "govpay_set_test_payment_response_status",
+      constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
+  get "/govpay/v1/payments/set_test_refund_response_status/:status",
+      to: "govpay_test_helpers#set_test_refund_response_status",
+      as: "govpay_set_test_refund_response_status",
+      constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
+  post "/govpay/v1/payments/:govpay_id/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",
+       to: "govpay_test_helpers#send_refund_webhook",
+       as: "send_refund_webhook",
+       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 end

data/lib/defra_ruby_mocks/version.rb

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

data/lib/fixtures/files/govpay/webhook_payment_update_body.json

@@ -0,0 +1,48 @@
+{
+    "webhook_message_id": "123abc",
+    "api_version": 1,
+    "created_date": "2019-07-11T10:36:26.988Z",
+    "resource_id": "hu20sqlact5260q2nanm0q8u93",
+    "resource_type": "payment",
+    "event_type": "card_payment_captured",
+    "resource": {
+      "amount": 5000,
+      "description": "Pay your council tax",
+      "reference": "12345",
+      "language": "en",
+      "email": "sherlock.holmes@example.com",
+      "state": {
+        "status": "success",
+        "finished": false
+      },
+      "payment_id": "hu20sqlact5260q2nanm0q8u93",
+      "payment_provider": "stripe",
+      "created_date": "2021-10-19T10:05:45.454Z",
+      "refund_summary": {
+        "status": "pending",
+        "amount_available": 5000,
+        "amount_submitted": 0
+      },
+      "settlement_summary": {},
+      "card_details": {
+        "last_digits_card_number": "1234",
+        "first_digits_card_number": "123456",
+        "cardholder_name": "Sherlock Holmes",
+        "expiry_date": "04/24",
+        "billing_address": {
+          "line1": "221 Baker Street",
+          "line2": "Flat b",
+          "postcode": "NW1 6XE",
+          "city": "London",
+          "country": "GB"
+        },
+        "card_brand": "Visa",
+        "card_type": "debit"
+      },
+      "delayed_capture": false,
+      "moto": false,
+      "provider_id": "10987654321",
+      "return_url": "https://your.service.gov.uk/completed"
+    }
+  }
+  

data/lib/fixtures/files/govpay/webhook_refund_update_body.json

@@ -0,0 +1,8 @@
+{
+    "refund_id": "345",
+    "created_date": "2022-01-26T16:52:41.178Z",
+    "amount": 2000,
+    "status": "success",
+    "settlement_summary": {},
+    "payment_id": "789"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: A Rails engine which can be used to mock external services when loaded
   into an application
 email:
@@ -80,6 +94,11 @@ files:
 - app/controllers/defra_ruby_mocks/application_controller.rb
 - app/controllers/defra_ruby_mocks/company_controller.rb
 - app/controllers/defra_ruby_mocks/govpay_controller.rb
+- app/controllers/defra_ruby_mocks/govpay_test_helpers_controller.rb
+- app/jobs/application_job.rb
+- app/jobs/base_send_webhook_job.rb
+- app/jobs/send_payment_webhook_job.rb
+- app/jobs/send_refund_webhook_job.rb
 - app/services/defra_ruby_mocks/aws_bucket_service.rb
 - app/services/defra_ruby_mocks/base_service.rb
 - app/services/defra_ruby_mocks/companies_house_service.rb
@@ -97,6 +116,8 @@ files:
 - lib/defra_ruby_mocks/invalid_config_error.rb
 - lib/defra_ruby_mocks/missing_resource_error.rb
 - lib/defra_ruby_mocks/version.rb
+- lib/fixtures/files/govpay/webhook_payment_update_body.json
+- lib/fixtures/files/govpay/webhook_refund_update_body.json
 - lib/tasks/changelog.rake
 - lib/tasks/defra_ruby_mocks_tasks.rake
 homepage: https://github.com/DEFRA/defra-ruby-mocks