defra_ruby_validators 1.1.0 → 1.2.0

data/lib/defra_ruby/validators/location_validator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class LocationValidator < BaseValidator
+      include CanValidateSelection
+
+      def validate_each(record, _attribute, value)
+        valid_options = %w[england northern_ireland scotland wales]
+
+        value_is_included?(record, :location, value, valid_options)
+      end
+    end
+  end
+end

data/lib/defra_ruby/validators/phone_number_validator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "phonelib"
+
+module DefraRuby
+  module Validators
+    class PhoneNumberValidator < BaseValidator
+      include CanValidatePresence
+      include CanValidateLength
+
+      MAX_LENGTH = 15
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, :phone_number, value)
+        return false unless value_is_not_too_long?(record, :phone_number, 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)
+
+        record.errors[attribute] << error_message(:phone_number, :invalid_format)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/position_validator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class PositionValidator < BaseValidator
+      include CanValidateCharacters
+      include CanValidateLength
+
+      MAX_LENGTH = 70
+
+      def validate_each(record, _attribute, value)
+        # Position is an optional field so its immediately valid if it's blank
+        return true if value.blank?
+        return false unless value_has_no_invalid_characters?(record, :position, value)
+
+        value_is_not_too_long?(record, :position, value, MAX_LENGTH)
+        value_has_no_invalid_characters?(record, :position, value)
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/token_validator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class TokenValidator < BaseValidator
+      include CanValidatePresence
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, :token, value)
+
+        valid_format?(record, attribute, value)
+      end
+
+      private
+
+      def valid_format?(record, attribute, value)
+        # The token is assumed to have been generated using
+        # https://github.com/robertomiranda/has_secure_token which creates
+        # 24-character unique tokens
+        return true if value.length == 24
+
+        record.errors[attribute] << error_message(:token, :invalid_format)
+        false
+      end
+    end
+  end
+end

data/lib/defra_ruby/validators/true_false_validator.rb

@@ -5,10 +5,10 @@ module DefraRuby
     class TrueFalseValidator < BaseValidator
       include CanValidateSelection
 
-      def validate_each(record, attribute, value)
+      def validate_each(record, _attribute, value)
         valid_options = %w[true false]
 
-        value_is_included?(record, attribute, value, valid_options)
+        value_is_included?(record, :attribute, value, valid_options)
       end
     end
   end

data/lib/defra_ruby/validators/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Validators
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/cassettes/company_no_inactive.yml

@@ -12,7 +12,7 @@ http_interactions:
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
-      - rest-client/2.0.2 (darwin18.2.0 x86_64) ruby/2.4.2p198
+      - rest-client/2.0.2 (darwin16.7.0 x86_64) ruby/2.4.2p198
       Host:
       - api.companieshouse.gov.uk
       Authorization:
@@ -22,6 +22,14 @@ http_interactions:
       code: 200
       message: OK
     headers:
+      Date:
+      - Tue, 06 Aug 2019 09:09:38 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '979'
+      Connection:
+      - keep-alive
       Access-Control-Allow-Credentials:
       - 'true'
       Access-Control-Allow-Headers:
@@ -36,26 +44,18 @@ http_interactions:
       - '3600'
       Cache-Control:
       - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
-      Content-Type:
-      - application/json
-      Date:
-      - Tue, 04 Jun 2019 22:42:41 GMT
       Pragma:
       - no-cache
-      Server:
-      - CompaniesHouse
       X-Ratelimit-Limit:
       - '600'
       X-Ratelimit-Remain:
-      - '599'
+      - '595'
       X-Ratelimit-Reset:
-      - '1559688461'
+      - '1565082737'
       X-Ratelimit-Window:
       - 5m
-      Content-Length:
-      - '979'
-      Connection:
-      - keep-alive
+      Server:
+      - CompaniesHouse
     body:
       encoding: UTF-8
       string: '{"sic_codes":["82990"],"company_number":"07281919","has_been_liquidated":false,"accounts":{"last_accounts":{"made_up_to":"2013-06-30","type":"total-exemption-small"},"accounting_reference_date":{"day":"30","month":"06"}},"last_full_members_list_date":"2014-06-11","status":"active","type":"ltd","date_of_creation":"2010-06-11","registered_office_address":{"postal_code":"HA8
@@ -63,5 +63,5 @@ http_interactions:
         Elizabeth House","address_line_2":"54-58 High Street"},"undeliverable_registered_office_address":false,"company_name":"DIRECT
         SKIPS UK LTD","annual_return":{"last_made_up_to":"2014-06-11"},"jurisdiction":"england-wales","etag":"1cdef5bc2a020b3e9003b086033b64b78bcb28f6","company_status":"dissolved","has_insolvency_history":false,"has_charges":false,"links":{"self":"/company/07281919","filing_history":"/company/07281919/filing-history","officers":"/company/07281919/officers"},"date_of_cessation":"2016-01-05","can_file":false}'
     http_version: 
-  recorded_at: Tue, 04 Jun 2019 22:42:41 GMT
+  recorded_at: Tue, 06 Aug 2019 09:09:36 GMT
 recorded_with: VCR 4.0.0

data/spec/cassettes/company_no_not_found.yml

@@ -12,7 +12,7 @@ http_interactions:
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
-      - rest-client/2.0.2 (darwin18.2.0 x86_64) ruby/2.4.2p198
+      - rest-client/2.0.2 (darwin16.7.0 x86_64) ruby/2.4.2p198
       Host:
       - api.companieshouse.gov.uk
       Authorization:
@@ -22,6 +22,14 @@ http_interactions:
       code: 404
       message: Not Found
     headers:
+      Date:
+      - Tue, 06 Aug 2019 09:09:39 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '70'
+      Connection:
+      - keep-alive
       Access-Control-Allow-Credentials:
       - 'true'
       Access-Control-Allow-Headers:
@@ -36,29 +44,21 @@ http_interactions:
       - '3600'
       Cache-Control:
       - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
-      Content-Type:
-      - application/json
-      Date:
-      - Tue, 04 Jun 2019 22:42:41 GMT
       Pragma:
       - no-cache
-      Server:
-      - CompaniesHouse
       X-Ratelimit-Limit:
       - '600'
       X-Ratelimit-Remain:
-      - '598'
+      - '593'
       X-Ratelimit-Reset:
-      - '1559688461'
+      - '1565082737'
       X-Ratelimit-Window:
       - 5m
-      Content-Length:
-      - '70'
-      Connection:
-      - keep-alive
+      Server:
+      - CompaniesHouse
     body:
       encoding: UTF-8
-      string: '{"errors":[{"type":"ch:service","error":"company-profile-not-found"}]}'
+      string: '{"errors":[{"error":"company-profile-not-found","type":"ch:service"}]}'
     http_version: 
-  recorded_at: Tue, 04 Jun 2019 22:42:41 GMT
+  recorded_at: Tue, 06 Aug 2019 09:09:36 GMT
 recorded_with: VCR 4.0.0

data/spec/cassettes/company_no_valid.yml

@@ -12,7 +12,7 @@ http_interactions:
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
-      - rest-client/2.0.2 (darwin18.2.0 x86_64) ruby/2.4.2p198
+      - rest-client/2.0.2 (darwin16.7.0 x86_64) ruby/2.4.2p198
       Host:
       - api.companieshouse.gov.uk
       Authorization:
@@ -22,6 +22,14 @@ http_interactions:
       code: 200
       message: OK
     headers:
+      Date:
+      - Tue, 06 Aug 2019 09:09:39 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1178'
+      Connection:
+      - keep-alive
       Access-Control-Allow-Credentials:
       - 'true'
       Access-Control-Allow-Headers:
@@ -36,30 +44,22 @@ http_interactions:
       - '3600'
       Cache-Control:
       - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
-      Content-Type:
-      - application/json
-      Date:
-      - Tue, 04 Jun 2019 22:42:41 GMT
       Pragma:
       - no-cache
-      Server:
-      - CompaniesHouse
       X-Ratelimit-Limit:
       - '600'
       X-Ratelimit-Remain:
-      - '597'
+      - '594'
       X-Ratelimit-Reset:
-      - '1559688461'
+      - '1565082737'
       X-Ratelimit-Window:
       - 5m
-      Content-Length:
-      - '1178'
-      Connection:
-      - keep-alive
+      Server:
+      - CompaniesHouse
     body:
       encoding: UTF-8
       string: '{"type":"ltd","company_name":"0800 WASTE LTD.","has_insolvency_history":false,"accounts":{"next_due":"2019-09-30","next_made_up_to":"2018-12-31","next_accounts":{"overdue":false,"period_start_on":"2018-01-01","due_on":"2019-09-30","period_end_on":"2018-12-31"},"accounting_reference_date":{"month":"12","day":"31"},"last_accounts":{"period_end_on":"2017-12-31","period_start_on":"2017-01-01","made_up_to":"2017-12-31"},"overdue":false},"undeliverable_registered_office_address":false,"etag":"0ec9d00cab0ffee2ef1f5d59f4f714fa5b1618f5","company_number":"09360070","registered_office_address":{"postal_code":"SM3
         9ND","locality":"Sutton","region":"Surrey","address_line_1":"21 Haslam Avenue"},"jurisdiction":"england-wales","date_of_creation":"2014-12-18","company_status":"active","has_charges":false,"sic_codes":["38110"],"last_full_members_list_date":"2015-12-18","confirmation_statement":{"overdue":false,"next_made_up_to":"2020-01-23","last_made_up_to":"2019-01-23","next_due":"2020-02-06"},"links":{"self":"/company/09360070","filing_history":"/company/09360070/filing-history","officers":"/company/09360070/officers"},"registered_office_is_in_dispute":false,"can_file":true}'
     http_version: 
-  recorded_at: Tue, 04 Jun 2019 22:42:41 GMT
+  recorded_at: Tue, 06 Aug 2019 09:09:36 GMT
 recorded_with: VCR 4.0.0

data/spec/defra_ruby/validators/business_type_validator_spec.rb

@@ -0,0 +1,30 @@
+# 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
+      )
+    end
+  end
+end

data/spec/defra_ruby/validators/companies_house_number_validator_spec.rb

@@ -38,9 +38,9 @@ module DefraRuby
           context "because it is blank" do
             validatable = Test::CompaniesHouseNumberValidatable.new
             error_message = Helpers::Translator.error_message(
-              klass: CompaniesHouseNumberValidator,
-              attribute: :company_no,
-              error: :blank
+              CompaniesHouseNumberValidator,
+              :company_no,
+              :blank
             )
 
             it_behaves_like "an invalid record", validatable, :company_no, error_message
@@ -49,9 +49,9 @@ module DefraRuby
           context "because the format is wrong" do
             validatable = Test::CompaniesHouseNumberValidatable.new(invalid_format_number)
             error_message = Helpers::Translator.error_message(
-              klass: CompaniesHouseNumberValidator,
-              attribute: :company_no,
-              error: :invalid
+              CompaniesHouseNumberValidator,
+              :company_no,
+              :invalid
             )
 
             it_behaves_like "an invalid record", validatable, :company_no, error_message
@@ -64,9 +64,9 @@ module DefraRuby
 
             validatable = Test::CompaniesHouseNumberValidatable.new(unknown_number)
             error_message = Helpers::Translator.error_message(
-              klass: CompaniesHouseNumberValidator,
-              attribute: :company_no,
-              error: :not_found
+              CompaniesHouseNumberValidator,
+              :company_no,
+              :not_found
             )
 
             it_behaves_like "an invalid record", validatable, :company_no, error_message
@@ -79,9 +79,9 @@ module DefraRuby
 
             validatable = Test::CompaniesHouseNumberValidatable.new(inactive_number)
             error_message = Helpers::Translator.error_message(
-              klass: CompaniesHouseNumberValidator,
-              attribute: :company_no,
-              error: :inactive
+              CompaniesHouseNumberValidator,
+              :company_no,
+              :inactive
             )
 
             it_behaves_like "an invalid record", validatable, :company_no, error_message
@@ -95,9 +95,9 @@ module DefraRuby
 
           validatable = Test::CompaniesHouseNumberValidatable.new(valid_numbers.sample)
           error_message = Helpers::Translator.error_message(
-            klass: CompaniesHouseNumberValidator,
-            attribute: :company_no,
-            error: :error
+            CompaniesHouseNumberValidator,
+            :company_no,
+            :error
           )
 
           it_behaves_like "an invalid record", validatable, :company_no, error_message

data/spec/defra_ruby/validators/email_validator_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Test
+  EmailValidatable = Struct.new(:email) do
+    include ActiveModel::Validations
+
+    validates :email, "defra_ruby/validators/email": true
+  end
+end
+
+module DefraRuby
+  module Validators
+    RSpec.describe EmailValidator, type: :model do
+
+      valid_email = "test@example.com"
+      invalid_email = "foo@bar"
+
+      it_behaves_like("a validator")
+      it_behaves_like(
+        "a presence validator",
+        EmailValidator,
+        Test::EmailValidatable,
+        :email,
+        valid: valid_email
+      )
+
+      describe "#validate_each" do
+        context "when the email is not valid" do
+          context "because the email is not correctly formatted" do
+            validatable = Test::EmailValidatable.new(invalid_email)
+
+            error_message = Helpers::Translator.error_message(EmailValidator, :email, :invalid_format)
+
+            it_behaves_like "an invalid record", validatable, :email, error_message
+          end
+        end
+      end
+    end
+  end
+end

data/spec/defra_ruby/validators/grid_reference_validator_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Test
+  GridReferenceValidatable = Struct.new(:grid_reference) do
+    include ActiveModel::Validations
+
+    validates :grid_reference, "defra_ruby/validators/grid_reference": true
+  end
+end
+
+module DefraRuby
+  module Validators
+    RSpec.describe GridReferenceValidator, type: :model do
+
+      valid_grid_reference = "ST 58337 72855" # Bristol, City of Bristol
+      invalid_grid_reference = "58337 72855"
+      non_coordinate_grid_reference = "AA 12345 67890"
+
+      it_behaves_like("a validator")
+      it_behaves_like(
+        "a presence validator",
+        GridReferenceValidator,
+        Test::GridReferenceValidatable,
+        :grid_reference,
+        valid: valid_grid_reference
+      )
+
+      describe "#validate_each" do
+        context "when the grid reference is not valid" do
+          context "because the grid reference is not correctly formatted" do
+            validatable = Test::GridReferenceValidatable.new(invalid_grid_reference)
+            error_message = Helpers::Translator.error_message(GridReferenceValidator, :grid_reference, :wrong_format)
+
+            it_behaves_like "an invalid record", validatable, :grid_reference, error_message
+          end
+
+          context "because the grid reference is not a coordinate" do
+            validatable = Test::GridReferenceValidatable.new(non_coordinate_grid_reference)
+            error_message = Helpers::Translator.error_message(GridReferenceValidator, :grid_reference, :invalid)
+
+            it_behaves_like "an invalid record", validatable, :grid_reference, error_message
+          end
+        end
+      end
+    end
+  end
+end