defra_ruby_validators 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8964c61f339abf2c0d3a469cad34c7234caf819e1844f3968e04d85147cc67c4
-  data.tar.gz: bf2ad073d11e02f698039b03286c1519ff01126d384119b8f3c0785b2c1cf6cd
+  metadata.gz: 3a8cefa4eee1eb9fcc363935f64760eb88aafd35d29ac09cfd3663105aafa3eb
+  data.tar.gz: 0dbc80e1d0c36fc4452257e6ade5377d83f04b860f9ec0375975526aca43f961
 SHA512:
-  metadata.gz: f24569969b429ffd1c1d7db53c94420f47aa0b32538c0584403458ee4fdf45cb72a911341ef993c959a298a8256b94b3511867a54cb9fa098d04e4573547ee6a
-  data.tar.gz: 4b40e37219533ce6c295b33b00c267c45550855790832f37f363db07f63d83c8d2a04cbfd4a8bf6f1762f52639f56888b614d741b13712614ed02fe0113cbad0
+  metadata.gz: 0417b991688a935460cbd8e96d28dd8d1496838d7aa5d56420f9a0e5ac701d652b278657a1a733c905e1f3b8ae6880e659b58071e90673af351224c9a3445ed2
+  data.tar.gz: 88fb21c5eb3ca1cc365ce4b52aeb8171540ec1cc5776b32cab5122fccb978215f46ea92ff13ceedde13fedd4b700d8f757a74db50f08e4e0e45e049c6ab2dfde

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -31,7 +31,8 @@ module DefraRuby
       end
 
       def format_is_valid?(record, attribute, value)
-        return true if value.match?(VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX)
+        # All-zero values are invalid, despite matching the main regex
+        return true if value.match?(VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX) && !value.match(/^0+$/)
 
         add_validation_error(record, attribute, :invalid_format)
         false

data/lib/defra_ruby/validators/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Validators
-    VERSION = "2.5.0"
+    VERSION = "2.5.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_validators
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: os_map_ref
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: phonelib
+  name: matrix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,21 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !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'
-- !ruby/object:Gem::Dependency
-  name: validates_email_format_of
+  name: os_map_ref
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,55 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: defra_ruby_style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: i18n
+  name: phonelib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -137,75 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: validates_email_format_of
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 description: Package of validations commonly used in Defra Rails based digital services
 email:
 - alan.cruikshanks@environment-agency.gov.uk
@@ -249,40 +151,13 @@ files:
 - lib/defra_ruby/validators/true_false_validator.rb
 - lib/defra_ruby/validators/version.rb
 - lib/defra_ruby_validators.rb
-- spec/defra_ruby/validators/business_type_validator_spec.rb
-- spec/defra_ruby/validators/companies_house_number_validator_spec.rb
-- spec/defra_ruby/validators/companies_house_service_spec.rb
-- spec/defra_ruby/validators/configuration_spec.rb
-- spec/defra_ruby/validators/email_validator_spec.rb
-- spec/defra_ruby/validators/grid_reference_validator_spec.rb
-- spec/defra_ruby/validators/location_validator_spec.rb
-- spec/defra_ruby/validators/past_date_validator_spec.rb
-- spec/defra_ruby/validators/phone_number_validator_spec.rb
-- spec/defra_ruby/validators/position_validator_spec.rb
-- spec/defra_ruby/validators/token_validator_spec.rb
-- spec/defra_ruby/validators/true_false_validator_spec.rb
-- spec/defra_ruby/validators_spec.rb
-- spec/examples.txt
-- spec/spec_helper.rb
-- spec/support/defra_ruby_validators.rb
-- spec/support/helpers/text_generator.rb
-- spec/support/helpers/translator.rb
-- spec/support/i18n.rb
-- spec/support/pry.rb
-- spec/support/shared_examples/validators/characters_validator.rb
-- spec/support/shared_examples/validators/invalid_record.rb
-- spec/support/shared_examples/validators/length_validator.rb
-- spec/support/shared_examples/validators/presence_validator.rb
-- spec/support/shared_examples/validators/selection_validator.rb
-- spec/support/shared_examples/validators/valid_record.rb
-- spec/support/shared_examples/validators/validator.rb
-- spec/support/simplecov.rb
 homepage: https://github.com/DEFRA/defra-ruby-validators
 licenses:
 - The Open Government Licence (OGL) Version 3
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -290,43 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Defra ruby on rails validations
-test_files:
-- spec/spec_helper.rb
-- spec/defra_ruby/validators_spec.rb
-- spec/defra_ruby/validators/past_date_validator_spec.rb
-- spec/defra_ruby/validators/companies_house_service_spec.rb
-- spec/defra_ruby/validators/configuration_spec.rb
-- spec/defra_ruby/validators/phone_number_validator_spec.rb
-- spec/defra_ruby/validators/position_validator_spec.rb
-- spec/defra_ruby/validators/grid_reference_validator_spec.rb
-- spec/defra_ruby/validators/business_type_validator_spec.rb
-- spec/defra_ruby/validators/companies_house_number_validator_spec.rb
-- spec/defra_ruby/validators/token_validator_spec.rb
-- spec/defra_ruby/validators/true_false_validator_spec.rb
-- spec/defra_ruby/validators/location_validator_spec.rb
-- spec/defra_ruby/validators/email_validator_spec.rb
-- spec/examples.txt
-- spec/support/simplecov.rb
-- spec/support/i18n.rb
-- spec/support/pry.rb
-- spec/support/defra_ruby_validators.rb
-- spec/support/helpers/translator.rb
-- spec/support/helpers/text_generator.rb
-- spec/support/shared_examples/validators/selection_validator.rb
-- spec/support/shared_examples/validators/invalid_record.rb
-- spec/support/shared_examples/validators/presence_validator.rb
-- spec/support/shared_examples/validators/characters_validator.rb
-- spec/support/shared_examples/validators/length_validator.rb
-- spec/support/shared_examples/validators/valid_record.rb
-- spec/support/shared_examples/validators/validator.rb
+test_files: []

data/spec/defra_ruby/validators/business_type_validator_spec.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  BusinessTypeValidatable = Struct.new(:business_type) do
-    include ActiveModel::Validations
-
-    validates :business_type, "defra_ruby/validators/business_type": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe BusinessTypeValidator do
-
-      valid_type = %w[soleTrader limitedCompany partnership limitedLiabilityPartnership localAuthority charity].sample
-      invalid_type = "coven"
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a selection validator",
-        BusinessTypeValidator,
-        Test::BusinessTypeValidatable,
-        :business_type,
-        valid: valid_type, invalid: invalid_type
-      )
-
-      context "when the value is overseas" do
-        validatable = Test::BusinessTypeValidatable.new("overseas")
-
-        context "when overseas_allowed is enabled" do
-          before do
-            allow_any_instance_of(DefraRuby::Validators::BaseValidator).to receive(:options).and_return(allow_overseas: true)
-          end
-
-          it_behaves_like "a valid record", validatable
-        end
-
-        context "when overseas_allowed is not enabled" do
-          before do
-            allow_any_instance_of(DefraRuby::Validators::BaseValidator).to receive(:options).and_return({})
-          end
-
-          error_message = Helpers::Translator.error_message(BusinessTypeValidator, :inclusion)
-
-          it_behaves_like "an invalid record",
-                          validatable: validatable,
-                          attribute: :business_type,
-                          error: :inclusion,
-                          error_message: error_message
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/companies_house_number_validator_spec.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  CompaniesHouseNumberValidatable = Struct.new(:company_no) do
-    include ActiveModel::Validations
-
-    validates :company_no, "defra_ruby/validators/companies_house_number": true
-  end
-
-  CompaniesHouseCompanyTypeAndNumberValidatable = Struct.new(:company_no) do
-    include ActiveModel::Validations
-
-    validates :company_no, "defra_ruby/validators/companies_house_number": { company_type: "ltd" }
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe CompaniesHouseNumberValidator do
-
-      valid_numbers = %w[10997904 09764739 SC534714 IP00141R]
-      invalid_format_number = "foobar42"
-      unknown_number = "99999999"
-      inactive_number = "07281919"
-
-      it_behaves_like "a validator"
-
-      describe "#validate_each" do
-        context "when given a valid company number" do
-          before do
-            allow_any_instance_of(CompaniesHouseService).to receive(:status).and_return(:active)
-          end
-
-          valid_numbers.each do |company_no|
-            context "like #{company_no}" do
-              it_behaves_like "a valid record", Test::CompaniesHouseNumberValidatable.new(company_no)
-            end
-          end
-        end
-
-        context "when given an invalid company number" do
-          context "because it is blank" do
-            validatable = Test::CompaniesHouseNumberValidatable.new
-            error_message = Helpers::Translator.error_message(CompaniesHouseNumberValidator, :blank)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :company_no,
-                            error: :blank,
-                            error_message: error_message
-          end
-
-          context "because the format is wrong" do
-            validatable = Test::CompaniesHouseNumberValidatable.new(invalid_format_number)
-            error_message = Helpers::Translator.error_message(CompaniesHouseNumberValidator, :invalid_format)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :company_no,
-                            error: :invalid_format,
-                            error_message: error_message
-          end
-
-          context "because it's not found on companies house" do
-            before do
-              allow_any_instance_of(CompaniesHouseService).to receive(:status).and_return(:not_found)
-            end
-
-            validatable = Test::CompaniesHouseNumberValidatable.new(unknown_number)
-            error_message = Helpers::Translator.error_message(CompaniesHouseNumberValidator, :not_found)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :company_no,
-                            error: :not_found,
-                            error_message: error_message
-          end
-
-          context "because it's not 'active' on companies house" do
-            before do
-              allow_any_instance_of(CompaniesHouseService).to receive(:status).and_return(:inactive)
-            end
-
-            validatable = Test::CompaniesHouseNumberValidatable.new(inactive_number)
-            error_message = Helpers::Translator.error_message(CompaniesHouseNumberValidator, :inactive)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :company_no,
-                            error: :inactive,
-                            error_message: error_message
-          end
-
-          context "with a company_type option" do
-            let(:company_no) { valid_numbers.first }
-
-            it "calls the companies house service with the `ltd` param" do
-              expect(CompaniesHouseService).to receive(:new).with(company_no, "ltd")
-
-              Test::CompaniesHouseCompanyTypeAndNumberValidatable.new(company_no).valid?
-            end
-          end
-        end
-
-        context "when there is an error connecting with companies house" do
-          before do
-            allow_any_instance_of(CompaniesHouseService).to receive(:status).and_raise(StandardError)
-          end
-
-          validatable = Test::CompaniesHouseNumberValidatable.new(valid_numbers.sample)
-          error_message = Helpers::Translator.error_message(CompaniesHouseNumberValidator, :error)
-
-          it_behaves_like "an invalid record",
-                          validatable: validatable,
-                          attribute: :company_no,
-                          error: :error,
-                          error_message: error_message
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/companies_house_service_spec.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-require "webmock/rspec"
-
-RSpec.describe DefraRuby::Validators::CompaniesHouseService do
-  let(:host) { "https://api.companieshouse.gov.uk/" }
-
-  describe "#status" do
-    let(:subject) { described_class.new("09360070") }
-
-    context "when the company_no is for an active company" do
-      before do
-        expected_body = { "company_status": "active", "type": "ltd" }
-
-        stub_request(:any, /.*#{host}.*/).to_return(
-          status: 200,
-          body: expected_body.to_json
-        )
-      end
-
-      it "returns :active" do
-        expect(subject.status).to eq(:active)
-      end
-    end
-
-    context "when the company_no is not found" do
-      before do
-        stub_request(:any, /.*#{host}.*/).to_return(
-          status: 404
-        )
-      end
-
-      it "returns :not_found" do
-        expect(subject.status).to eq(:not_found)
-      end
-    end
-
-    context "when the company_no is inactive" do
-      before do
-        expected_body = { "company_status": "dissolved", "type": "ltd" }
-
-        stub_request(:any, /.*#{host}.*/).to_return(
-          status: 200,
-          body: expected_body.to_json
-        )
-      end
-
-      it "returns :inactive" do
-        expect(subject.status).to eq(:inactive)
-      end
-    end
-
-    context "checking the company_type" do
-      let(:subject) { described_class.new("09360070", "llp") }
-
-      context "when the company_no is for a LLP" do
-        before do
-          stub_request(:any, /.*#{host}.*/).to_return(
-            status: 200,
-            body: expected_body.to_json
-          )
-        end
-
-        let(:expected_body) { { "company_status": "active", "type": "llp" } }
-
-        it "returns :active" do
-          expect(subject.status).to eq(:active)
-        end
-
-        context "but a ltd company is found" do
-          let(:expected_body) { { "company_status": "active", "type": "ltd" } }
-
-          it "returns :not_found" do
-            expect(subject.status).to eq(:not_found)
-          end
-        end
-      end
-    end
-
-    context "when there is a problem with the Companies House API" do
-      context "and the request times out" do
-        before { stub_request(:any, /.*#{host}.*/).to_timeout }
-
-        it "raises an exception" do
-          expect { subject.status }.to raise_error(StandardError)
-        end
-      end
-
-      context "and request returns an error" do
-        before { stub_request(:any, /.*#{host}.*/).to_raise(SocketError) }
-
-        it "raises an exception" do
-          expect { subject.status }.to raise_error(StandardError)
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/configuration_spec.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe DefraRuby::Validators::Configuration do
-  describe "ATTRIBUTES" do
-    it "represents the expected config settings and only those settings" do
-      expected_attributes = %i[
-        companies_house_host
-        companies_house_api_key
-      ]
-
-      expect(described_class::ATTRIBUTES).to match_array(expected_attributes)
-    end
-  end
-
-  it "sets the appropriate default config settings" do
-    fresh_config = described_class.new
-
-    expect(fresh_config.companies_house_host).to eq("https://api.companieshouse.gov.uk/company/")
-    expect(fresh_config.companies_house_api_key).to eq(nil)
-  end
-
-  describe "#ensure_valid" do
-    before(:each) do
-      described_class::ATTRIBUTES.each do |attribute|
-        subject.public_send("#{attribute}=", "foo")
-      end
-    end
-
-    context "when all of the attributes are present" do
-      it "does not raise an error" do
-        expect { subject.ensure_valid }.to_not raise_error
-        expect(subject.ensure_valid).to eq(true)
-      end
-    end
-
-    context "when at least one of the attributes is missing" do
-      before(:each) do
-        subject.companies_house_api_key = nil
-      end
-
-      it "raises an error" do
-        message = "The following DefraRuby::Validators configuration attributes are missing: [:companies_house_api_key]"
-        expect { subject.ensure_valid }.to raise_error(message)
-      end
-    end
-  end
-end