defra_ruby_validators 2.5.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8964c61f339abf2c0d3a469cad34c7234caf819e1844f3968e04d85147cc67c4
-  data.tar.gz: bf2ad073d11e02f698039b03286c1519ff01126d384119b8f3c0785b2c1cf6cd
+  metadata.gz: 54f780cf89fcc1888cd3b9af95707c6e3ac2a0d0dcd1e304ab6d9b2933b69ef9
+  data.tar.gz: 895551a30493fb79367289728c28e7e09873c1c6def93e685c70f7076b67f46c
 SHA512:
-  metadata.gz: f24569969b429ffd1c1d7db53c94420f47aa0b32538c0584403458ee4fdf45cb72a911341ef993c959a298a8256b94b3511867a54cb9fa098d04e4573547ee6a
-  data.tar.gz: 4b40e37219533ce6c295b33b00c267c45550855790832f37f363db07f63d83c8d2a04cbfd4a8bf6f1762f52639f56888b614d741b13712614ed02fe0113cbad0
+  metadata.gz: '07863b0bde9327c8384a93b8e1c681b02ef7fedce040a36d4f17aa9435a4783e4db51fcf41a29469ea3b6d9599324b89f8ab5c3c830040b563894db33449d8e9'
+  data.tar.gz: 4e07b525aae83437d5ad450e4e3989f402caf04346efc130543440a41084e2a4ecc48168894f88e261fc66c269aa48389282dedd17b2031ce0a889924b99720c

data/README.md

@@ -144,6 +144,16 @@ Add it to your model or form object using
 validates :phone_number, "defra_ruby/validators/phone_number": true
 ```
 
+### Mobile phone number
+
+This validator checks the value is present, is not too long (15 is th maximum length for any phone number), is a mobile phone number, and is in the correct format as per [E.164](https://en.wikipedia.org/wiki/E.164) (we use [phonelib](https://github.com/daddyz/phonelib) to check the format).
+
+Add it to your model or form object using
+
+```ruby
+validates :mobile_phone_number, "defra_ruby/validators/mobile_phone_number": true
+```
+
 ### Position
 
 This validator checks the value provided for 'position' i.e. someones role or title within an organisation. This is an optional field so the validator has to handle the value being blank. If it's not then it can be no longer than 70 characters and only include letters, spaces, commas, full stops, hyphens and apostrophes else it will return an error.

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

@@ -0,0 +1,7 @@
+en:
+  defra_ruby:
+    validators:
+      MobilePhoneNumberValidator:
+        blank: "Enter a mobile phone number"
+        invalid_format: "Enter a valid mobile phone number"
+        too_long: "Check the number you entered - it should have no more than than 15 characters"

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -9,9 +9,8 @@ module DefraRuby
       # SC534714, CE000958
       # IP00141R, IP27702R, SP02252R
       # https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/426891/uniformResourceIdentifiersCustomerGuide.pdf
-      VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX = Regexp.new(
+      VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX =
         /\A(\d{8,8}$)|([a-zA-Z]{2}\d{6}$)|([a-zA-Z]{2}\d{5}[a-zA-Z]{1}$)\z/i
-      ).freeze
 
       def validate_each(record, attribute, value)
         return false unless value_is_present?(record, attribute, value)
@@ -31,7 +30,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/mobile_phone_number_validator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "phonelib"
+
+module DefraRuby
+  module Validators
+    class MobilePhoneNumberValidator < BaseValidator
+      include CanValidatePresence
+      include CanValidateLength
+
+      MAX_LENGTH = 15
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, attribute, value)
+        return false unless value_is_not_too_long?(record, attribute, value, MAX_LENGTH)
+
+        valid_format?(record, attribute, value)
+      end
+
+      private
+
+      def valid_format?(record, attribute, value)
+        Phonelib.default_country = "GB"
+        return true if Phonelib.valid?(value) && Phonelib.parse(value).type == :mobile
+
+        add_validation_error(record, attribute, :invalid_format)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/version.rb

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

data/lib/defra_ruby/validators.rb

@@ -18,6 +18,7 @@ require_relative "validators/email_validator"
 require_relative "validators/grid_reference_validator"
 require_relative "validators/location_validator"
 require_relative "validators/phone_number_validator"
+require_relative "validators/mobile_phone_number_validator"
 require_relative "validators/position_validator"
 require_relative "validators/token_validator"
 require_relative "validators/true_false_validator"

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.2
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2023-06-26 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
@@ -223,6 +125,7 @@ files:
 - config/locales/defra_ruby/validators/email_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
 - config/locales/defra_ruby/validators/past_date_validator/en.yml
 - config/locales/defra_ruby/validators/phone_number_validator/en.yml
 - config/locales/defra_ruby/validators/position_validator/en.yml
@@ -242,6 +145,7 @@ files:
 - lib/defra_ruby/validators/engine.rb
 - lib/defra_ruby/validators/grid_reference_validator.rb
 - lib/defra_ruby/validators/location_validator.rb
+- lib/defra_ruby/validators/mobile_phone_number_validator.rb
 - lib/defra_ruby/validators/past_date_validator.rb
 - lib/defra_ruby/validators/phone_number_validator.rb
 - lib/defra_ruby/validators/position_validator.rb
@@ -249,40 +153,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 +167,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