defra_ruby_validators 0.1.1 → 1.0.0

data/spec/defra_ruby/validators/companies_house_number_validator_spec.rb

@@ -0,0 +1,88 @@
+# 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, :company_no, :blank)
+
+            it_behaves_like "an invalid record", validatable, :company_no, error_message
+          end
+
+          context "because the format is wrong" do
+            validatable = Test::CompaniesHouseNumberValidatable.new(invalid_format_number)
+            error_message = Helpers::Translator.error_message(CompaniesHouseNumberValidator, :company_no, :invalid)
+
+            it_behaves_like "an invalid record", validatable, :company_no, 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, :company_no, :not_found)
+
+            it_behaves_like "an invalid record", validatable, :company_no, 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, :company_no, :inactive)
+
+            it_behaves_like "an invalid record", validatable, :company_no, 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, :company_no, :error)
+
+          it_behaves_like "an invalid record", validatable, :company_no, error_message
+        end
+      end
+    end
+  end
+end

data/spec/defra_ruby/validators/companies_house_service_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+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(:each) { VCR.insert_cassette("company_no_valid") }
+      after(:each) { VCR.eject_cassette }
+
+      it "returns :active" do
+        expect(subject.status).to eq(:active)
+      end
+    end
+
+    context "when the company_no is not found" do
+      let(:subject) { described_class.new("99999999") }
+      before(:each) { VCR.insert_cassette("company_no_not_found") }
+      after(:each) { VCR.eject_cassette }
+
+      it "returns :not_found" do
+        expect(subject.status).to eq(:not_found)
+      end
+    end
+
+    context "when the company_no is inactive" do
+      let(:subject) { described_class.new("07281919") }
+      before(:each) { VCR.insert_cassette("company_no_inactive") }
+      after(:each) { VCR.eject_cassette }
+
+      it "returns :inactive" do
+        expect(subject.status).to eq(:inactive)
+      end
+    end
+
+    context "when there is a problem with the Companies House API" do
+      before(:each) { VCR.turn_off! }
+      after(:each) { VCR.turn_on! }
+
+      context "and the request times out" do
+        before(:each) { 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(:each) { 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

@@ -0,0 +1,49 @@
+# 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

data/spec/defra_ruby/validators_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe DefraRuby::Validators do
+  describe "VERSION" do
+    it "is a version string in the correct format" do
+      expect(DefraRuby::Validators::VERSION).to be_a(String)
+      expect(DefraRuby::Validators::VERSION).to match(/\d+\.\d+\.\d+/)
+    end
+  end
+end

data/spec/examples.txt

@@ -1,27 +1,36 @@
-example_id                                                                     | status | run_time        |
------------------------------------------------------------------------------- | ------ | --------------- |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:1:1] | passed | 0.01413 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:2:1] | passed | 0.0008 seconds  |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:3:1] | passed | 0.00053 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:4:1] | passed | 0.00051 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:1:1] | passed | 0.00043 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:1:2] | passed | 0.00134 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:1:3] | passed | 0.00047 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:2:1] | passed | 0.00035 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:2:2] | passed | 0.00025 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:2:3] | passed | 0.00024 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:3:1] | passed | 0.00077 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:3:2] | passed | 0.00077 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:3:3] | passed | 0.00076 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:4:1] | passed | 0.00064 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:4:2] | passed | 0.00056 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:4:3] | passed | 0.00058 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:3:1]   | passed | 0.00064 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:3:2]   | passed | 0.00057 seconds |
-./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:3:3]   | passed | 0.00066 seconds |
-./spec/defra_ruby_validators/companies_house_service_spec.rb[1:1:1]            | passed | 0.04998 seconds |
-./spec/defra_ruby_validators/companies_house_service_spec.rb[1:2:1]            | passed | 0.02093 seconds |
-./spec/defra_ruby_validators/companies_house_service_spec.rb[1:3:1]            | passed | 0.02306 seconds |
-./spec/defra_ruby_validators/companies_house_service_spec.rb[1:4:1]            | passed | 0.02332 seconds |
-./spec/defra_ruby_validators/companies_house_service_spec.rb[1:5:1]            | passed | 0.01492 seconds |
-./spec/defra_ruby_validators/version_spec.rb[1:1]                              | passed | 0.00312 seconds |
+example_id                                                                         | status | run_time        |
+---------------------------------------------------------------------------------- | ------ | --------------- |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:1:1]       | passed | 0.00014 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:1:1:1] | passed | 0.00062 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:1:1:2] | passed | 0.00048 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:2:1:1] | passed | 0.00081 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:2:1:2] | passed | 0.0005 seconds  |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:3:1:1] | passed | 0.00047 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:3:1:2] | passed | 0.00047 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:4:1:1] | passed | 0.00044 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:1:4:1:2] | passed | 0.00052 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:1:1:1] | passed | 0.00172 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:1:1:2] | passed | 0.00018 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:1:1:3] | passed | 0.00764 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:2:1:1] | passed | 0.00055 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:2:1:2] | passed | 0.00028 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:2:1:3] | passed | 0.0002 seconds  |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:3:1:1] | passed | 0.00049 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:3:1:2] | passed | 0.00915 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:3:1:3] | passed | 0.00051 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:4:1:1] | passed | 0.00049 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:4:1:2] | passed | 0.00043 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:2:4:1:3] | passed | 0.00046 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:3:1:1]   | passed | 0.00055 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:3:1:2]   | passed | 0.00049 seconds |
+./spec/defra_ruby/validators/companies_house_number_validator_spec.rb[1:2:3:1:3]   | passed | 0.00061 seconds |
+./spec/defra_ruby/validators/companies_house_service_spec.rb[1:1:1:1]              | passed | 0.02711 seconds |
+./spec/defra_ruby/validators/companies_house_service_spec.rb[1:1:2:1]              | passed | 0.01832 seconds |
+./spec/defra_ruby/validators/companies_house_service_spec.rb[1:1:3:1]              | passed | 0.01756 seconds |
+./spec/defra_ruby/validators/companies_house_service_spec.rb[1:1:4:1:1]            | passed | 0.03546 seconds |
+./spec/defra_ruby/validators/companies_house_service_spec.rb[1:1:4:2:1]            | passed | 0.01611 seconds |
+./spec/defra_ruby/validators/configuration_spec.rb[1:1:1]                          | passed | 0.00407 seconds |
+./spec/defra_ruby/validators/configuration_spec.rb[1:2]                            | passed | 0.0001 seconds  |
+./spec/defra_ruby/validators/configuration_spec.rb[1:3:1:1]                        | passed | 0.00021 seconds |
+./spec/defra_ruby/validators/configuration_spec.rb[1:3:2:1]                        | passed | 0.00021 seconds |
+./spec/defra_ruby/validators_spec.rb[1:1:1]                                        | passed | 0.00494 seconds |

data/spec/spec_helper.rb

@@ -2,32 +2,82 @@
 
 require "bundler/setup"
 
-# Test coverage reporting
-require "simplecov"
-SimpleCov.start
-
-# Support debugging in the tests
-require "byebug"
-# Load env vars from a text file
-require "dotenv/load"
-# Need to require our actual code files
-require "defra_ruby_validators/validators"
-
-# The following line is provided for convenience purposes. It has the downside
-# of increasing the boot-up time by auto-requiring all files in the support
-# directory. However in a small gem like this the increase should be neglible
-Dir[File.join(__dir__, "support", "**", "*.rb")].each { |f| require f }
+# Require and run our simplecov initializer as the very first thing we do.
+# This is as per its docs https://github.com/colszowka/simplecov#getting-started
+require "./spec/support/simplecov"
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# We make an exception for simplecov because that will already have been
+# required and run at the very top of spec_helper.rb
+support_files = Dir["./spec/support/**/*.rb"].reject { |file| file == "./spec/support/simplecov.rb" }
+support_files.each { |f| require f }
 
 RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
   # Allows RSpec to persist some state between runs in order to support
   # the `--only-failures` and `--next-failure` CLI options. We recommend
   # you configure your source control system to ignore this file.
   config.example_status_persistence_file_path = "spec/examples.txt"
 
-  # Disable RSpec exposing methods globally on `Module` and `main`
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
   config.disable_monkey_patching!
 
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end

data/spec/support/defra_ruby_validators.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 
-DefraRubyValidators.configure do |configuration|
-  configuration.companies_house_api_key = ENV["COMPANIES_HOUSE_API_KEY"]
+# Need to require our actual code files. We don't just require everything in
+# lib/defra_ruby because it contains the engine file which has a dependency on
+# rails. We don't have that as a dependency of this project because it is
+# a given this will be used in a rails project. So instead we require the
+# validators file directly to load the content covered by our tests.
+require "defra_ruby/validators"
+
+DefraRuby::Validators.configure do |c|
+  def raise_missing_env_var(variable)
+    raise("Environment variable #{variable} has not been set")
+  end
+
+  c.companies_house_api_key = (ENV["COMPANIES_HOUSE_API_KEY"] || raise_missing_env_var("COMPANIES_HOUSE_API_KEY"))
 end

data/spec/support/dotenv.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Load env vars from a text file
+require "dotenv/load"

data/spec/support/helpers/translator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Helpers
+  module Translator
+    def self.error_message(klass, attribute, error)
+      class_name = klass_name(klass)
+      I18n.t("defra_ruby.validators.#{class_name}.#{attribute}.#{error}")
+    end
+
+    def self.klass_name(klass)
+      klass.name.split("::").last
+    end
+  end
+end

data/spec/support/pry.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Support debugging in the tests. Add `binding.pry` wherever you want execution
+# to stop and the debugger to kick in.
+# Details on the debugging commands can be found here
+# https://github.com/deivid-rodriguez/pry-byebug#commands
+require "pry-byebug"

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "an invalid record" do |validatable, property, error_message|
+  it "confirms the object is invalid" do
+    expect(validatable).to_not be_valid
+  end
+
+  it "adds a single validation error to the record" do
+    validatable.valid?
+    expect(validatable.errors[property].count).to eq(1)
+  end
+
+  it "adds an appropriate validation error" do
+    validatable.valid?
+    expect(error_message).to_not include("translation missing:")
+    expect(validatable.errors[property]).to eq([error_message])
+  end
+end