defra_ruby_validators 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e9394d56a860bc591e8858943843bae425845124bdca40f68f90fa864e3bbc6
-  data.tar.gz: 259e137a79906fb23ca984322d0e7d87dfa117cd87f4b5f87df182a69fec8cd5
+  metadata.gz: 8cb145644c2a51c737b951282707e436d9b740ab756c04f93d761cf05cbc91a6
+  data.tar.gz: 45ce24942e9e95030e8d051f06db0f20facff88f2320445b96b7c695a35b17f8
 SHA512:
-  metadata.gz: 5336207fa6acbb53f0c36cb3759ea3d31e507de9392e2c0081bed9160bad765de799a88b6a8b4295daa80ec534f00ab158ae606e6592d624bbd8cfa48d34c69a
-  data.tar.gz: c81e615d1b0337ff9e21380f80a91d50670ec5b95c950a35e346feda88822e34f0e9660f81b7e75d200b6b0fc83cff2d05af79e383b78123c7edab9fb46563e8
+  metadata.gz: 7c6c390badabbd364ed4174746857062d0f85d92405981c2b83e72498e493c6440e5663bc8ade16bc0d87534da467db4ea1a9dcb1871f9b1cc7f810dede007fb
+  data.tar.gz: 31404af40d4a8da9da8c726bb9b081d6d9838eb0843ede3042b270d9dd7036c5810f00becde67f8fcdb0e723ea8f79883b970a8eec38a9eea581b31d9b93c376

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

@@ -6,4 +6,6 @@ en:
         invalid_format: "Enter a valid number - it should have 8 digits, or 2 letters followed by 6 digits, or 2 letters followed by 5 digits and another letter. If your number has only 7 digits, enter it with a zero at the start."
         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.
         error: There was an error connecting with Companies House. Hopefully this is a one off and will work if you try again.

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

@@ -0,0 +1,5 @@
+en:
+  defra_ruby:
+    validators:
+      FutureDateValidator:
+        future_date: "Date cannot be in the past"

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -16,8 +16,8 @@ module DefraRuby
         return false unless value_is_present?(record, attribute, value)
         return false unless format_is_valid?(record, attribute, value)
 
-        company_type = options[:company_type]
-        validate_with_companies_house(record, attribute, value, company_type)
+        permitted_types = options[:permitted_types]
+        validate_with_companies_house(record, attribute, value, permitted_types)
       end
 
       private
@@ -37,18 +37,21 @@ module DefraRuby
         false
       end
 
-      def validate_with_companies_house(record, attribute, value, company_type)
-        case CompaniesHouseService.new(value, company_type).status
+      def validate_with_companies_house(record, attribute, value, permitted_types)
+        case CompaniesHouseService.new(company_number: value, permitted_types:).status
         when :active
           true
         when :inactive
           add_validation_error(record, attribute, :inactive)
         when :not_found
           add_validation_error(record, attribute, :not_found)
+        when :unsupported_company_type
+          add_validation_error(record, attribute, :unsupported_company_type)
         else
-          # Sonarcloud suggested that not having an `else` is a code smell
           add_validation_error(record, attribute, :error)
         end
+      rescue ArgumentError
+        add_validation_error(record, attribute, :argument_error)
       rescue StandardError
         add_validation_error(record, attribute, :error)
       end

data/lib/defra_ruby/validators/companies_house_service.rb

@@ -5,15 +5,18 @@ require "rest-client"
 module DefraRuby
   module Validators
     class CompaniesHouseService
-      def initialize(company_no, company_type = nil)
-        @company_no = company_no
-        @url = "#{DefraRuby::Validators.configuration.companies_house_host}#{@company_no}"
+      def initialize(company_number:, permitted_types: nil)
+        @company_number = company_number
+        @permitted_types = permitted_types
+
+        validate_permitted_types
+
+        @url = "#{DefraRuby::Validators.configuration.companies_house_host}#{@company_number}"
         @api_key = DefraRuby::Validators.configuration.companies_house_api_key
-        @company_type = company_type
       end
 
       def status
-        return :not_found unless company_type_is_allowed?(json_response)
+        return :unsupported_company_type unless company_type_is_allowed?(json_response)
 
         status_is_allowed?(json_response) ? :active : :inactive
       rescue RestClient::ResourceNotFound
@@ -34,16 +37,30 @@ module DefraRuby
 
       private
 
+      def validate_permitted_types
+        return if @permitted_types.nil?
+
+        return if @permitted_types.is_a?(String) || @permitted_types.is_a?(Array)
+
+        raise ArgumentError, I18n.t("defra_ruby.validators.CompaniesHouseNumberValidator.argument_error")
+      end
+
       def status_is_allowed?(json_response)
         %w[active voluntary-arrangement].include?(json_response["company_status"])
       end
 
       def company_type_is_allowed?(json_response)
-        # if a company_type has not been defined in the validator,
-        # we skip this check
-        return true if @company_type.blank?
+        # if permitted_types has not been defined in the validator, we skip this check
+        return true if @permitted_types.blank?
 
-        @company_type.to_s == json_response["type"]
+        case @permitted_types
+        when String
+          @permitted_types.to_s == json_response["type"]
+        when Array
+          @permitted_types.include?(json_response["type"])
+        else
+          raise ArgumentError, I18n.t("defra_ruby.validators.CompaniesHouseNumberValidator.argument_error")
+        end
       end
     end
   end

data/lib/defra_ruby/validators/future_date_validator.rb_park

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class FutureDateValidator < BaseValidator
+      def validate_each(record, attribute, value)
+        return false if value.blank?
+
+        date = value.to_date
+
+        if date <= Date.today
+          add_validation_error(record, attribute, :future_date)
+
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/defra_ruby/validators/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Validators
-    VERSION = "2.6.0"
+    VERSION = "2.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_validators
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -137,6 +137,7 @@ files:
 - config/locales/defra_ruby/validators/business_type_validator/en.yml
 - config/locales/defra_ruby/validators/companies_house_number_validator/en.yml
 - config/locales/defra_ruby/validators/email_validator/en.yml
+- config/locales/defra_ruby/validators/future_date_validator/en.yml
 - config/locales/defra_ruby/validators/grid_reference_validator/en.yml
 - config/locales/defra_ruby/validators/location_validator/en.yml
 - config/locales/defra_ruby/validators/mobile_phone_number_validator/en.yml
@@ -158,6 +159,7 @@ files:
 - lib/defra_ruby/validators/configuration.rb
 - lib/defra_ruby/validators/email_validator.rb
 - lib/defra_ruby/validators/engine.rb
+- lib/defra_ruby/validators/future_date_validator.rb_park
 - lib/defra_ruby/validators/grid_reference_validator.rb
 - lib/defra_ruby/validators/location_validator.rb
 - lib/defra_ruby/validators/mobile_phone_number_validator.rb