defra_ruby_validators 0.1.1 → 1.0.0

data/spec/support/shared_examples/validators/valid_record.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "a valid record" do |validatable|
+  it "confirms the object is valid" do
+    expect(validatable).to be_valid
+  end
+
+  it "the errors are empty" do
+    validatable.valid?
+    expect(validatable.errors).to be_empty
+  end
+end

data/spec/support/shared_examples/validators/validator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "a validator" do
+  it "is a type of BaseValidator" do
+    expect(described_class.ancestors)
+      .to include(DefraRuby::Validators::BaseValidator)
+  end
+end

data/spec/support/simplecov.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+# We start it with the rails param to ensure it includes coverage for all code
+# started by the rails app, and not just the files touched by our unit tests.
+# This gives us the most accurate assessment of our unit test coverage
+# https://github.com/colszowka/simplecov#getting-started
+SimpleCov.start do
+  # We filter the spec folder, mainly to ensure that any dummy apps don't get
+  # included in the coverage report. However our intent is that nothing in the
+  # spec folder should be included
+  add_filter "/spec/"
+  # The version file is simply just that, so we do not feel the need to ensure
+  # we have a test for it
+  add_filter "lib/defra_ruby/validators/version"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_validators
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-30 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: defra_ruby_style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: defra_ruby_style
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github_changelog_generator
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -204,23 +204,33 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- config/locales/defra_ruby_validators/companies_house_number/en.yml
+- config/locales/defra_ruby/validators/companies_house_number_validator/en.yml
+- lib/defra_ruby/validators.rb
+- lib/defra_ruby/validators/base_validator.rb
+- lib/defra_ruby/validators/companies_house_number_validator.rb
+- lib/defra_ruby/validators/companies_house_service.rb
+- lib/defra_ruby/validators/configuration.rb
+- lib/defra_ruby/validators/engine.rb
+- lib/defra_ruby/validators/version.rb
 - lib/defra_ruby_validators.rb
-- lib/defra_ruby_validators/companies_house_number_validator.rb
-- lib/defra_ruby_validators/companies_house_service.rb
-- lib/defra_ruby_validators/engine.rb
-- lib/defra_ruby_validators/validators.rb
-- lib/defra_ruby_validators/version.rb
 - spec/cassettes/company_no_inactive.yml
 - spec/cassettes/company_no_not_found.yml
 - spec/cassettes/company_no_valid.yml
-- spec/defra_ruby_validators/companies_house_number_validator_spec.rb
-- spec/defra_ruby_validators/companies_house_service_spec.rb
-- spec/defra_ruby_validators/version_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_spec.rb
 - spec/examples.txt
 - spec/spec_helper.rb
 - spec/support/defra_ruby_validators.rb
+- spec/support/dotenv.rb
+- spec/support/helpers/translator.rb
 - spec/support/i18n.rb
+- spec/support/pry.rb
+- spec/support/shared_examples/validators/invalid_record.rb
+- spec/support/shared_examples/validators/valid_record.rb
+- spec/support/shared_examples/validators/validator.rb
+- spec/support/simplecov.rb
 - spec/support/vcr.rb
 homepage: https://github.com/DEFRA/defra-ruby-validators
 licenses:
@@ -249,13 +259,21 @@ specification_version: 4
 summary: Defra ruby on rails validations
 test_files:
 - spec/spec_helper.rb
-- spec/defra_ruby_validators/companies_house_service_spec.rb
-- spec/defra_ruby_validators/version_spec.rb
-- spec/defra_ruby_validators/companies_house_number_validator_spec.rb
+- spec/defra_ruby/validators_spec.rb
+- spec/defra_ruby/validators/companies_house_service_spec.rb
+- spec/defra_ruby/validators/configuration_spec.rb
+- spec/defra_ruby/validators/companies_house_number_validator_spec.rb
 - spec/examples.txt
 - spec/cassettes/company_no_not_found.yml
 - spec/cassettes/company_no_valid.yml
 - spec/cassettes/company_no_inactive.yml
+- spec/support/simplecov.rb
 - spec/support/i18n.rb
 - spec/support/vcr.rb
+- spec/support/pry.rb
+- spec/support/dotenv.rb
 - spec/support/defra_ruby_validators.rb
+- spec/support/helpers/translator.rb
+- spec/support/shared_examples/validators/invalid_record.rb
+- spec/support/shared_examples/validators/valid_record.rb
+- spec/support/shared_examples/validators/validator.rb

data/config/locales/defra_ruby_validators/companies_house_number/en.yml

@@ -1,14 +0,0 @@
-en:
-  defra_ruby_validators:
-    companies_house_number:
-      hint: An 8 digit number, or 2 letters followed by a 6 digit number, or 2 letters followed by 5 digits and another letter
-      help:
-        heading: What's a registration number?
-        limitedCompany: This is issued when the company is registered, and can be found on your Certificate of Incorporation and any paperwork from Companies House.
-        limitedLiabilityPartnership: This is issued when the limited liability partnership is registered, and can be found on your Certificate of Incorporation and any paperwork from Companies House.
-      errors:
-        blank: Enter a company registration number
-        invalid: "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
-        error: There was an error connecting with Companies House. Hopefully this is a one off and will work if you try again.

data/lib/defra_ruby_validators/companies_house_number_validator.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyValidators
-  class CompaniesHouseNumberValidator < ActiveModel::EachValidator
-
-    # Examples we need to validate are
-    # 10997904, 09764739
-    # 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(
-      /\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)
-      return false unless format_is_valid?(record, attribute, value)
-
-      validate_with_companies_house(record, attribute, value)
-    end
-
-    private
-
-    def value_is_present?(record, attribute, value)
-      return true if value.present?
-
-      record.errors[attribute] << error_message("blank")
-      false
-    end
-
-    def format_is_valid?(record, attribute, value)
-      return true if value.match?(VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX)
-
-      record.errors[attribute] << error_message("invalid")
-      false
-    end
-
-    def validate_with_companies_house(record, attribute, value)
-      case CompaniesHouseService.new(value).status
-      when :active
-        true
-      when :inactive
-        record.errors[attribute] << error_message("inactive")
-      when :not_found
-        record.errors[attribute] << error_message("not_found")
-      end
-    rescue StandardError
-      record.errors[attribute] << error_message("error")
-    end
-
-    def error_message(error)
-      I18n.t("defra_ruby_validators.companies_house_number.errors.#{error}")
-    end
-
-  end
-end

data/lib/defra_ruby_validators/companies_house_service.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require "rest-client"
-
-module DefraRubyValidators
-  class CompaniesHouseService
-    def initialize(company_no)
-      @company_no = company_no
-      @url = "#{DefraRubyValidators.configuration.companies_house_host}#{@company_no}"
-      @api_key = DefraRubyValidators.configuration.companies_house_api_key
-    end
-
-    def status
-      response = RestClient::Request.execute(
-        method: :get,
-        url: @url,
-        user: @api_key,
-        password: ""
-      )
-
-      json = JSON.parse(response)
-
-      status_is_allowed?(json["company_status"]) ? :active : :inactive
-    rescue RestClient::ResourceNotFound
-      :not_found
-    end
-
-    private
-
-    def status_is_allowed?(status)
-      %w[active voluntary-arrangement].include?(status)
-    end
-  end
-end

data/lib/defra_ruby_validators/engine.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "defra_ruby_validators/validators"
-
-module DefraRubyValidators
-  # Engine used to load in the custom validations
-  class Engine < ::Rails::Engine
-    isolate_namespace DefraRubyValidators
-
-    # Add a load path for this specific Engine
-    config.autoload_paths += Dir[File.join(config.root, "lib", "**")]
-
-    # Load I18n translation files from engine before loading ones from the host app
-    # This means values in the host app can override those in the engine
-    config.before_initialize do
-      engine_locales = Dir["#{config.root}/config/locales/**/*.yml"]
-      config.i18n.load_path = engine_locales + config.i18n.load_path
-    end
-  end
-end

data/lib/defra_ruby_validators/validators.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "active_model"
-require "defra_ruby_validators/version"
-require "defra_ruby_validators/companies_house_service"
-
-require "defra_ruby_validators/companies_house_number_validator"
-
-module DefraRubyValidators
-  # Enable the ability to configure the gem from its host app, rather than
-  # reading directly from env vars. Derived from
-  # https://robots.thoughtbot.com/mygem-configure-block
-  class << self
-    attr_writer :configuration
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  class Configuration
-    attr_accessor :companies_house_host, :companies_house_api_key
-
-    def initialize
-      @companies_house_host = "https://api.companieshouse.gov.uk/company/"
-      @companies_house_api_key = nil
-    end
-  end
-end

data/lib/defra_ruby_validators/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyValidators
-  VERSION = "0.1.1"
-end

data/spec/defra_ruby_validators/companies_house_number_validator_spec.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyValidators
-  RSpec.describe CompaniesHouseNumberValidator do
-    context "when given a valid company number" do
-      before do
-        allow_any_instance_of(CompaniesHouseService).to receive(:status).and_return(:active)
-      end
-
-      %w[10997904 09764739 SC534714 IP00141R].each do |company_no|
-        context "like #{company_no}" do
-          it "confirms the number is valid" do
-            expect(DummyCompaniesHouseNumber.new(company_no)).to be_valid
-          end
-        end
-      end
-    end
-
-    context "when given an invalid company number" do
-      context "because it is blank" do
-        subject { DummyCompaniesHouseNumber.new("") }
-
-        it "confirms the number is not valid" do
-          expect(subject).to_not be_valid
-        end
-        it "adds an error to the subject's errors collection" do
-          subject.valid?
-          expect(subject.errors.count).to eq(1)
-        end
-        it "adds an error with the correct message" do
-          subject.valid?
-          expect(subject.errors[:company_no][0]).to eq(I18n.t("defra_ruby_validators.companies_house_number.errors.blank"))
-        end
-      end
-
-      context "because the format is wrong" do
-        subject { DummyCompaniesHouseNumber.new("foobar42") }
-
-        it "confirms the number is not valid" do
-          expect(subject).to_not be_valid
-        end
-        it "adds an error to the subject's errors collection" do
-          subject.valid?
-          expect(subject.errors.count).to eq(1)
-        end
-        it "adds an error with the correct message" do
-          subject.valid?
-          expect(subject.errors[:company_no][0]).to eq(I18n.t("defra_ruby_validators.companies_house_number.errors.invalid"))
-        end
-      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
-
-        subject { DummyCompaniesHouseNumber.new("99999999") }
-
-        it "confirms the number is not valid" do
-          expect(subject).to_not be_valid
-        end
-        it "adds an error to the subject's errors collection" do
-          subject.valid?
-          expect(subject.errors.count).to eq(1)
-        end
-        it "adds an error with the correct message" do
-          subject.valid?
-          expect(subject.errors[:company_no][0]).to eq(I18n.t("defra_ruby_validators.companies_house_number.errors.not_found"))
-        end
-      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
-
-        subject { DummyCompaniesHouseNumber.new("07281919") }
-
-        it "confirms the number is not valid" do
-          expect(subject).to_not be_valid
-        end
-        it "adds an error to the subject's errors collection" do
-          subject.valid?
-          expect(subject.errors.count).to eq(1)
-        end
-        it "adds an error with the correct message" do
-          subject.valid?
-          expect(subject.errors[:company_no][0]).to eq(I18n.t("defra_ruby_validators.companies_house_number.errors.inactive"))
-        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
-
-      subject { DummyCompaniesHouseNumber.new("10997904") }
-
-      it "confirms the number is not valid" do
-        expect(subject).to_not be_valid
-      end
-      it "adds an error to the subject's errors collection" do
-        subject.valid?
-        expect(subject.errors.count).to eq(1)
-      end
-      it "adds an error with the correct message" do
-        subject.valid?
-        expect(subject.errors[:company_no][0]).to eq(I18n.t("defra_ruby_validators.companies_house_number.errors.error"))
-      end
-    end
-
-    class DummyCompaniesHouseNumber
-      include ActiveModel::Model
-
-      attr_accessor :company_no
-
-      def initialize(company_no)
-        @company_no = company_no
-      end
-
-      validates :company_no, "defra_ruby_validators/companies_house_number": true
-    end
-  end
-end