defra_ruby_mocks 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2050966a0416ac33fdb18d7b5e99dddb3548ef4d704792441a7a77a6c664b58e
-  data.tar.gz: 555e7313d1587a5f83108a5f3ed42de143cb5b0695ab4e11582e883e0fe0e0a3
+  metadata.gz: e24d648c7432078c7cc69a30923d8200fa3583702c60f573b28a02aeb46e3a73
+  data.tar.gz: 4748ab1db603a4a773ca7bd397895050606175b10c5f04ddf6f6b8aea4390cc4
 SHA512:
-  metadata.gz: 6a423e4730a149e0999d21e47b601b0fa83a011b3048c7eb03eebd2534f01752143b3c0f3c273dc6df37191287e6345cb32b1075c7fe745aab415034f6c8b43e
-  data.tar.gz: 1cb2bc2402d47184315227ba57d31687c1163c0eeacde31b2addd75cdf0e0d41bdbe3710f5c4853a9abbd2d4489a28ccee48f8aeaf4dcaf2beae464b8b4e1696
+  metadata.gz: 5d5e22baf1ebcb28785f32a5578511ec0b5b7fd8888d7ec54a95970d7fef440f691f5ce2699b5590b601ea21b7f66d5c04556703ef5774c56f6ae96916ef637a
+  data.tar.gz: 9a4c263655f8903e6e452e1eeb996ae27c754d06dc852ae409b1cc962e3e88d25d41445f17dbe74c8200749cd1db2363c81c9fb66a2a3a29cf231d52b709e77a

data/README.md

@@ -132,6 +132,41 @@ The list of possible statuses was taken from
 - [Companies House API](https://developer.companieshouse.gov.uk/api/docs/company/company_number/companyProfile-resource.html)
 - [Companies House API enumerations](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml)
 
+### OS Places
+
+When mounted into an app you can make requests to `/mocks/places/v1/postcode?postcode=[postcode]` to get a mock address lookup response in the OS Places API DPA format.
+
+```bash
+curl "http://localhost:3000/mocks/places/v1/postcode?postcode=BS1%205AH"
+{
+    "results": [
+        {
+            "DPA": {
+                "UPRN": "340116",
+                "ADDRESS": "ENVIRONMENT AGENCY, HORIZON HOUSE, DEANERY ROAD, BRISTOL, BS1 5AH",
+                "ORGANISATION_NAME": "ENVIRONMENT AGENCY",
+                "BUILDING_NAME": "HORIZON HOUSE",
+                "THOROUGHFARE_NAME": "DEANERY ROAD",
+                "POST_TOWN": "BRISTOL",
+                "POSTCODE": "BS1 5AH",
+                "X_COORDINATE": 358205.0,
+                "Y_COORDINATE": 172708.0,
+                ...
+            }
+        },
+        ...
+    ]
+}
+```
+
+#### Postcodes
+
+The mock normalizes postcodes by converting to uppercase and removing spaces. Currently the following postcodes return mock data:
+
+- `BS1 5AH` - Returns two addresses (Environment Agency Horizon House, Bristol)
+
+Any other postcode will return `{"results": []}`.
+
 ### Govpay
 
 When mounted into an app you can simulate interacting with the Govpay hosted pages service. The following endpoints are supported:

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class OsPlacesController < ::DefraRubyMocks::ApplicationController
+    def postcode
+      results = OsPlacesService.run(params[:postcode]).results
+      render json: { "results" => results }
+    end
+  end
+end

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/aws_bucket_service.rb

@@ -21,6 +21,7 @@ module DefraRubyMocks
       new.remove(bucket_name, file_name)
     end
 
+    # rubocop:disable Naming/PredicateMethod
     def write(bucket_name, file_name, content)
       @bucket_name = bucket_name
       @file_name = file_name
@@ -32,6 +33,7 @@ module DefraRubyMocks
 
       true
     end
+    # rubocop:enable Naming/PredicateMethod
 
     def read(bucket_name, file_name)
       @bucket_name = bucket_name

data/app/services/defra_ruby_mocks/os_places_service.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class OsPlacesService < BaseService
+    # Mock addresses in OS Places API DPA format, keyed by normalized postcode
+    MOCK_ADDRESSES = {
+      "BS15AH" => [
+        {
+          "DPA" => {
+            "UPRN" => "340116",
+            "ADDRESS" => "ENVIRONMENT AGENCY, HORIZON HOUSE, DEANERY ROAD, BRISTOL, BS1 5AH",
+            "ORGANISATION_NAME" => "ENVIRONMENT AGENCY",
+            "BUILDING_NAME" => "HORIZON HOUSE",
+            "THOROUGHFARE_NAME" => "DEANERY ROAD",
+            "POST_TOWN" => "BRISTOL",
+            "POSTCODE" => "BS1 5AH",
+            "X_COORDINATE" => 358_205.0,
+            "Y_COORDINATE" => 172_708.0,
+            "DEPENDENT_LOCALITY" => "",
+            "MATCH" => 1.0,
+            "MATCH_DESCRIPTION" => "EXACT",
+            "LANGUAGE" => "EN",
+            "LAST_UPDATE_DATE" => "2024-01-01",
+            "ENTRY_DATE" => "2020-01-01",
+            "BLPU_STATE_CODE" => "2",
+            "BLPU_STATE_CODE_DESCRIPTION" => "In use",
+            "CLASSIFICATION_CODE" => "CO01",
+            "CLASSIFICATION_CODE_DESCRIPTION" => "Office / Work Studio",
+            "POSTAL_ADDRESS_CODE" => "D",
+            "POSTAL_ADDRESS_CODE_DESCRIPTION" => "A record which is linked to PAF",
+            "LOGICAL_STATUS_CODE" => "1",
+            "STATUS" => "APPROVED",
+            "TOPOGRAPHY_LAYER_TOID" => "",
+            "PARENT_UPRN" => "",
+            "USRN" => ""
+          }
+        },
+        {
+          "DPA" => {
+            "UPRN" => "340117",
+            "ADDRESS" => "THRIVE RENEWABLES PLC, DEANERY ROAD, BRISTOL, BS1 5AH",
+            "ORGANISATION_NAME" => "THRIVE RENEWABLES PLC",
+            "BUILDING_NAME" => "",
+            "THOROUGHFARE_NAME" => "DEANERY ROAD",
+            "POST_TOWN" => "BRISTOL",
+            "POSTCODE" => "BS1 5AH",
+            "X_COORDINATE" => 358_130.0,
+            "Y_COORDINATE" => 172_687.0,
+            "DEPENDENT_LOCALITY" => "",
+            "MATCH" => 1.0,
+            "MATCH_DESCRIPTION" => "EXACT",
+            "LANGUAGE" => "EN",
+            "LAST_UPDATE_DATE" => "2024-01-01",
+            "ENTRY_DATE" => "2020-01-01",
+            "BLPU_STATE_CODE" => "2",
+            "BLPU_STATE_CODE_DESCRIPTION" => "In use",
+            "CLASSIFICATION_CODE" => "CO01",
+            "CLASSIFICATION_CODE_DESCRIPTION" => "Office / Work Studio",
+            "POSTAL_ADDRESS_CODE" => "D",
+            "POSTAL_ADDRESS_CODE_DESCRIPTION" => "A record which is linked to PAF",
+            "LOGICAL_STATUS_CODE" => "1",
+            "STATUS" => "APPROVED",
+            "TOPOGRAPHY_LAYER_TOID" => "",
+            "PARENT_UPRN" => "",
+            "USRN" => ""
+          }
+        }
+      ]
+    }.freeze
+
+    def run(postcode)
+      @postcode = normalize_postcode(postcode)
+      self
+    end
+
+    def results
+      MOCK_ADDRESSES.fetch(@postcode, [])
+    end
+
+    private
+
+    def normalize_postcode(postcode)
+      postcode.to_s.upcase.gsub(/\s+/, "")
+    end
+  end
+end

data/config/routes.rb

@@ -11,6 +11,11 @@ DefraRubyMocks::Engine.routes.draw do # rubocop:disable Metrics/BlockLength
       as: "company_officers",
       constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
+  get "/places/v1/postcode",
+      to: "os_places#postcode",
+      as: "os_places_addresses",
+      constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
   post "/govpay/v1/payments",
        to: "govpay#create_payment",
        as: "govpay_create_payment",
@@ -47,12 +52,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-11 00:00:00.000000000 Z
+date: 2026-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +96,7 @@ files:
 - 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/controllers/defra_ruby_mocks/os_places_controller.rb
 - app/jobs/application_job.rb
 - app/jobs/base_send_webhook_job.rb
 - app/jobs/send_payment_webhook_job.rb
@@ -107,6 +108,7 @@ files:
 - app/services/defra_ruby_mocks/govpay_get_payment_service.rb
 - app/services/defra_ruby_mocks/govpay_refund_details_service.rb
 - app/services/defra_ruby_mocks/govpay_request_refund_service.rb
+- app/services/defra_ruby_mocks/os_places_service.rb
 - app/views/defra_ruby_mocks/company/not_found.json.erb
 - app/views/defra_ruby_mocks/company/officers.json.erb
 - app/views/defra_ruby_mocks/company/show.json.erb