defra_ruby_validators 2.4.1 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21bdd325a2591dc6b3240957791d511239cadf35
-  data.tar.gz: dbf3657df6f3c814a3f2081a4c576f3319c5c713
+SHA256:
+  metadata.gz: 3a8cefa4eee1eb9fcc363935f64760eb88aafd35d29ac09cfd3663105aafa3eb
+  data.tar.gz: 0dbc80e1d0c36fc4452257e6ade5377d83f04b860f9ec0375975526aca43f961
 SHA512:
-  metadata.gz: 22c834aeb4feacd105d153c38a0db5ba1ea3951e8f4e78fb8bb8f48fb1a797ba64973b98565ea4c51904ca623a40934f1e9d6f57b7bb7319197762480cf17938
-  data.tar.gz: 3553f860583d638a6fcd86038240c507dd3fc4f89ad16e1fd87ec68bbf5386a27d36f46ecb7536717f2f060804ae5f8d9fdaa1ef784cbc05194df1beedf63b44
+  metadata.gz: 0417b991688a935460cbd8e96d28dd8d1496838d7aa5d56420f9a0e5ac701d652b278657a1a733c905e1f3b8ae6880e659b58071e90673af351224c9a3445ed2
+  data.tar.gz: 88fb21c5eb3ca1cc365ce4b52aeb8171540ec1cc5776b32cab5122fccb978215f46ea92ff13ceedde13fedd4b700d8f757a74db50f08e4e0e45e049c6ab2dfde

data/README.md

@@ -1,9 +1,8 @@
 # Defra Ruby Validators
 
-[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-validators.svg?branch=main)](https://travis-ci.com/DEFRA/defra-ruby-validators)
+![Build Status](https://github.com/DEFRA/defra-ruby-validators/workflows/CI/badge.svg?branch=main)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-validators&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-validators)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-validators&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-validators)
-[![security](https://hakiri.io/github/DEFRA/defra-ruby-validators/main.svg)](https://hakiri.io/github/DEFRA/defra-ruby-validators/main)
 [![Gem Version](https://badge.fury.io/rb/defra_ruby_validators.svg)](https://badge.fury.io/rb/defra_ruby_validators)
 [![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
 
@@ -74,6 +73,14 @@ Add it to your model or form object using
 validates :company_no, "defra_ruby/validators/companies_house_number": true
 ```
 
+The company number also accepts a `company_type` option. This checks the `type` attribute in the API response. To validate that the company number is for a Limited Company, for example:
+
+```ruby
+validates :company_no, "defra_ruby/validators/companies_house_number": { company_type: "ltd" }
+```
+
+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
 
 This validator checks the value is present and in a format that meets [RFC 2822](https://tools.ietf.org/html/rfc2822) and [RFC 3696](https://tools.ietf.org/html/rfc3696) (we use [validates_email_format_of](https://github.com/validates-email-format-of/validates_email_format_of) to check the format).

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -17,7 +17,8 @@ module DefraRuby
         return false unless value_is_present?(record, attribute, value)
         return false unless format_is_valid?(record, attribute, value)
 
-        validate_with_companies_house(record, attribute, value)
+        company_type = options[:company_type]
+        validate_with_companies_house(record, attribute, value, company_type)
       end
 
       private
@@ -30,25 +31,28 @@ 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
       end
 
-      def validate_with_companies_house(record, attribute, value)
-        case CompaniesHouseService.new(value).status
+      def validate_with_companies_house(record, attribute, value, company_type)
+        case CompaniesHouseService.new(value, company_type).status
         when :active
           true
         when :inactive
           add_validation_error(record, attribute, :inactive)
         when :not_found
           add_validation_error(record, attribute, :not_found)
+        else
+          # Sonarcloud suggested that not having an `else` is a code smell
+          add_validation_error(record, attribute, :error)
         end
       rescue StandardError
         add_validation_error(record, attribute, :error)
       end
-
     end
   end
 end

data/lib/defra_ruby/validators/companies_house_service.rb

@@ -5,31 +5,45 @@ require "rest-client"
 module DefraRuby
   module Validators
     class CompaniesHouseService
-      def initialize(company_no)
+      def initialize(company_no, company_type = nil)
         @company_no = company_no
         @url = "#{DefraRuby::Validators.configuration.companies_house_host}#{@company_no}"
         @api_key = DefraRuby::Validators.configuration.companies_house_api_key
+        @company_type = company_type
       end
 
       def status
-        response = RestClient::Request.execute(
-          method: :get,
-          url: @url,
-          user: @api_key,
-          password: ""
-        )
+        return :not_found unless company_type_is_allowed?(json_response)
 
-        json = JSON.parse(response)
-
-        status_is_allowed?(json["company_status"]) ? :active : :inactive
+        status_is_allowed?(json_response) ? :active : :inactive
       rescue RestClient::ResourceNotFound
         :not_found
       end
 
+      def json_response
+        @_json_response ||=
+          JSON.parse(
+            RestClient::Request.execute(
+              method: :get,
+              url: @url,
+              user: @api_key,
+              password: ""
+            )
+          )
+      end
+
       private
 
-      def status_is_allowed?(status)
-        %w[active voluntary-arrangement].include?(status)
+      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?
+
+        @company_type.to_s == json_response["type"]
       end
     end
   end

data/lib/defra_ruby/validators/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Validators
-    VERSION = "2.4.1"
+    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.4.1
+  version: 2.5.1
 platform: ruby
 authors:
 - Defra
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-07 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,39 +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/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
@@ -289,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: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-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/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,108 +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
-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
-        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,70 +0,0 @@
-# frozen_string_literal: true
-
-require "webmock/rspec"
-
-RSpec.describe DefraRuby::Validators::CompaniesHouseService do
-  let(:subject) { described_class.new("09360070") }
-  let(:host) { "https://api.companieshouse.gov.uk/" }
-
-  describe "#status" do
-    context "when the company_no is for an active company" do
-      before do
-        expected_body = { "company_status": "active" }
-
-        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" }
-
-        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 "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