defra_ruby_validators 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e71fe5778e8e21ba88af8230696cc2b27945e0f2d93b596f1c662cab90bfee0
-  data.tar.gz: 6de129130f3cf5f15efe684b9a6c442d0a1d63f4c64df45a89d7b2d3e7df7891
+  metadata.gz: ebc819c7234646da1f7ae2f33a2560bd108e2b7165e0baca0656d135244f348a
+  data.tar.gz: dccbcfa5fa4e7cff92a616cba000f608ecfedb042e659e16210c6bc43026e5d5
 SHA512:
-  metadata.gz: 59c38ea607d53c77fa38f5aecdc38a68687e1aa1c92ab15e6c07ffbb14cbb2cfe4a18f1ae67ae24ef6c0de9a35951a5359259217827f396d6245e74336373796
-  data.tar.gz: 41f073a068c11e7932b86e1aefe37a7d636e66e44c8c1f7c8c2d284b7e7c40943c216bd510c05bbf99a488ab00a9cb71a70c35fc09b001f706b77932e1f315b3
+  metadata.gz: de0050634d392a792b6f642a9b68ca8a5ad30fa74ce71d8393859358f27604900b89ed0ca4ab3f2e417e4f2c8595b9e2f0eb50c192f5e0469c1e813ef8d214cc
+  data.tar.gz: 73031c690a724e7948769f2dab5518c8e8b5a86ff1ea1a26cc4686e7c6997ebb89206dd3fc830c0e264edfcf8763d6e314d17705c2f65a9c208a0b3fe782b7e7

data/README.md

@@ -63,9 +63,10 @@ This validator checks the company registration number provided. Specifically it
 If the format is valid, it then makes a call to Companies House to validate that the number
 
 - is recognised
-- belongs to an 'active' company
+- belongs to a company with an allowed status
 
-A company can be in various states for example liquidation, which means for the purposes of Defra its not a valid entity. So we check the status along with the number as part of the validation.
+Allowed statuses default to `active` and `voluntary-arrangement`, preserving the existing behaviour.
+Services can override this when they need to accept other Companies House statuses.
 
 Add it to your model or form object using
 
@@ -79,6 +80,14 @@ The company number also accepts a `company_type` option. This checks the `type`
 validates :company_no, "defra_ruby/validators/companies_house_number": { company_type: "ltd" }
 ```
 
+The allowed Companies House statuses can be changed with the `permitted_statuses` option:
+
+```ruby
+validates :company_no, "defra_ruby/validators/companies_house_number": {
+  permitted_statuses: %i[active voluntary-arrangement liquidation]
+}
+```
+
 Note: to mock the Companies House service with the `company_type` option, you will need to be running at least v2.2.0 of [defra-ruby-mocks](https://github.com/DEFRA/defra-ruby-mocks#companies-house).
 
 ### Email

data/config/locales/defra_ruby/validators/companies_house_number_validator/en.yml

@@ -7,5 +7,5 @@ en:
         not_found: Companies House couldn't find a company with this number
         inactive: Your company must be registered as an active company
         unsupported_company_type: Your company must be registered as a limited company or a limited liability partnership
-        argument_error: Invalid permitted_types value. It must be nil, a string or an array of strings.
+        argument_error: Invalid permitted_types or permitted_statuses value. It must be nil, a string or an array.
         error: There was an error connecting with Companies House. Hopefully this is a one off and will work if you try again.

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -17,7 +17,8 @@ module DefraRuby
         return false unless format_is_valid?(record, attribute, value)
 
         permitted_types = options[:permitted_types]
-        validate_with_companies_house(record, attribute, value, permitted_types)
+        permitted_statuses = options[:permitted_statuses]
+        validate_with_companies_house(record, attribute, value, permitted_types, permitted_statuses)
       end
 
       private
@@ -37,8 +38,8 @@ module DefraRuby
         false
       end
 
-      def validate_with_companies_house(record, attribute, value, permitted_types)
-        case CompaniesHouseService.new(company_number: value, permitted_types:).status
+      def validate_with_companies_house(record, attribute, value, permitted_types, permitted_statuses)
+        case CompaniesHouseService.new(company_number: value, permitted_types:, permitted_statuses:).status
         when :active
           true
         when :inactive

data/lib/defra_ruby/validators/companies_house_service.rb

@@ -5,11 +5,18 @@ require "defra_ruby/companies_house"
 module DefraRuby
   module Validators
     class CompaniesHouseService
-      def initialize(company_number:, permitted_types: nil)
+      DEFAULT_PERMITTED_STATUSES = %i[active voluntary-arrangement].freeze
+      ARGUMENT_ERROR_TRANSLATION_KEY = "defra_ruby.validators.CompaniesHouseNumberValidator.argument_error"
+
+      private_constant :ARGUMENT_ERROR_TRANSLATION_KEY
+
+      def initialize(company_number:, permitted_types: nil, permitted_statuses: nil)
         @company_number = company_number
         @permitted_types = permitted_types
+        @permitted_statuses = permitted_statuses
 
         validate_permitted_types
+        validate_permitted_statuses
       end
 
       def status
@@ -27,15 +34,28 @@ module DefraRuby
       end
 
       def validate_permitted_types
-        return if @permitted_types.nil?
+        return if valid_permitted_option?(@permitted_types)
+
+        raise ArgumentError, I18n.t(ARGUMENT_ERROR_TRANSLATION_KEY)
+      end
 
-        return if @permitted_types.is_a?(String) || @permitted_types.is_a?(Array)
+      def validate_permitted_statuses
+        return if valid_permitted_option?(@permitted_statuses)
 
-        raise ArgumentError, I18n.t("defra_ruby.validators.CompaniesHouseNumberValidator.argument_error")
+        raise ArgumentError, I18n.t(ARGUMENT_ERROR_TRANSLATION_KEY)
+      end
+
+      def valid_permitted_option?(option)
+        option.nil? || option.is_a?(String) || option.is_a?(Array)
       end
 
       def status_is_allowed?(companies_house_response)
-        %i[active voluntary-arrangement].include?(companies_house_response[:company_status])
+        normalised_permitted_statuses.include?(companies_house_response[:company_status].to_s.to_sym)
+      end
+
+      def normalised_permitted_statuses
+        @permitted_statuses ||= DEFAULT_PERMITTED_STATUSES
+        Array(@permitted_statuses).map { |status| status.to_s.to_sym }
       end
 
       def company_type_is_allowed?(companies_house_response)
@@ -48,7 +68,7 @@ module DefraRuby
         when Array
           @permitted_types.include?(companies_house_response[:company_type].to_s)
         else
-          raise ArgumentError, I18n.t("defra_ruby.validators.CompaniesHouseNumberValidator.argument_error")
+          raise ArgumentError, I18n.t(ARGUMENT_ERROR_TRANSLATION_KEY)
         end
       end
     end

data/lib/defra_ruby/validators/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Validators
-    VERSION = "3.0.1"
+    VERSION = "3.1.0"
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_validators
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Defra
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -190,6 +191,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -204,7 +206,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Defra ruby on rails validations
 test_files: []