defra_ruby_validators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 423deb6f44961525a9612a533db996555e296701
+  data.tar.gz: 3b0e8e06f17f4e5fb7999ab5e684f76453fe792d
+SHA512:
+  metadata.gz: 86868cd7dd7b19ea0b7112599c90c534151f02491fafc1af0e3fdeb816c3ff9e90f4299b196f323da3e4791431146a1c7d8acf58295b9bc7ed7d2caffa099bdf
+  data.tar.gz: b39a209754d3676202d5b2c95d7af7d11a2228b3befd60c68d3084b60b0de6a9bfbdca304354864a669555bcbbcf32c9e97780f140569e1f697c1780652dc2e8

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2019 Environment Agency
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,87 @@
+<img src="/defra-ruby-validators.png" alt="Defra ruby validators logo" />
+
+[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-validators.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-validators)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a0f8611f1a879786f642/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-validators/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a0f8611f1a879786f642/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-validators/test_coverage)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
+
+Package of validations commonly used in Defra Rails based digital services.
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem "defra_ruby_validators"
+```
+
+And then update your dependencies by calling
+
+```bash
+bundle install
+```
+
+## Usage
+
+With this gem installed, a number of active model based validators become available.
+
+### Companies House number
+
+This validator checks the company registration number provided. Specifically it first checks that it matches a known format. All registration numbers are 8 characters long but can be formatted in the following ways.
+
+- 09764739
+- 10997904
+- SC534714
+- IP00141R
+
+If the format is valid, it then makes a call to Companies House to validate that the number
+
+- is recognised
+- belongs to an 'active' company
+
+A company can be in various states for example liquidation, which means for the purposes of Defra its not a valid entity. So we check the status along with the number as part of the validation.
+
+Add it to your model or form object using
+
+```ruby
+validates :company_no, "defra_ruby_validators/companies_house_number": true
+```
+
+A locale hint plus help text is also available for your views, that details what a registration number is and the restrictions, e.g
+
+```erb
+  <span class="form-hint"><%= t("defra_validators.companies_house_number.hint") %></span>
+
+  <div class="form-group">
+    <details>
+      <summary>
+        <span class="summary"><%= t("defra_validators.companies_house_number.help.heading") %></span>
+      </summary>
+      <div class="panel panel-border-narrow">
+        <p><%= t("defra_validators.companies_house_number.help.#{@form.business_type}") %></p>
+      </div>
+    </details>
+  </div>
+```
+
+## Contributing to this project
+
+If you have an idea you'd like to contribute please log an issue.
+
+All contributions should be submitted via a pull request.
+
+## License
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
+
+# This is wrapped to prevent an error when rake is called in environments where
+# rspec may not be available, e.g. production. As such we don't need to handle
+# the error.
+# rubocop:disable Lint/HandleExceptions
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+
+begin
+  require "github_changelog_generator/task"
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  end
+rescue LoadError
+  # no changelog available
+end
+# rubocop:enable Lint/HandleExceptions

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "defra/ruby/validators"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/defra_ruby_validators.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "defra_ruby_validators/engine"
+
+module DefraRubyValidators
+  # See lib/defra_ruby_validators/validators.rb for the main content.
+  # We have this file which just require's engine.rb to support using the gem
+  # in a rails project.
+  # For our test suite, we just want the typical listing of `require "filex"`,
+  # as the engine references using Rails.
+  # We also have the gem setup to support being configured from the host app.
+  # This is all done in `validators.rb`, which is picked up by `engine.rb` as
+  # well.
+end

data/lib/defra_ruby_validators/companies_house_number_validator.rb

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

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

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

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

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

data/spec/cassettes/company_no_inactive.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.companieshouse.gov.uk/company/07281919
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.3.0 x86_64) ruby/2.4.2p198
+      Host:
+      - api.companieshouse.gov.uk
+      Authorization:
+      - Basic MnZodWowb1dhYk13N2h6TnpBVWlTT2ctNktpVVRCcFhCRF83Zktibzo=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 28 Jan 2019 09:38:50 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '979'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Headers:
+      - X-RateLimit-Query, origin, content-type, content-length, user-agent, host,
+        accept, authorization
+      Access-Control-Expose-Headers:
+      - Location,www-authenticate,cache-control,pragma,content-type,expires,last-modified
+      - X-RateLimit-Window, X-RateLimit-Limit, X-RateLimit-Remain, X-RateLimit-Reset,
+        Location, www-authenticate, cache-control, pragma, content-type, expires,
+        last-modified
+      Access-Control-Max-Age:
+      - '3600'
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Ratelimit-Limit:
+      - '600'
+      X-Ratelimit-Remain:
+      - '596'
+      X-Ratelimit-Reset:
+      - '1548668445'
+      X-Ratelimit-Window:
+      - 5m
+      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
+        7EJ","locality":"Edgware","region":"Middlesex","address_line_1":"8th Floor
+        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: Mon, 28 Jan 2019 09:38:50 GMT
+recorded_with: VCR 4.0.0

data/spec/cassettes/company_no_not_found.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.companieshouse.gov.uk/company/99999999
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.3.0 x86_64) ruby/2.4.2p198
+      Host:
+      - api.companieshouse.gov.uk
+      Authorization:
+      - Basic MnZodWowb1dhYk13N2h6TnpBVWlTT2ctNktpVVRCcFhCRF83Zktibzo=
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Mon, 28 Jan 2019 09:38:50 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '70'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Headers:
+      - X-RateLimit-Query, origin, content-type, content-length, user-agent, host,
+        accept, authorization
+      Access-Control-Expose-Headers:
+      - Location,www-authenticate,cache-control,pragma,content-type,expires,last-modified
+      - X-RateLimit-Window, X-RateLimit-Limit, X-RateLimit-Remain, X-RateLimit-Reset,
+        Location, www-authenticate, cache-control, pragma, content-type, expires,
+        last-modified
+      Access-Control-Max-Age:
+      - '3600'
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Ratelimit-Limit:
+      - '600'
+      X-Ratelimit-Remain:
+      - '597'
+      X-Ratelimit-Reset:
+      - '1548668445'
+      X-Ratelimit-Window:
+      - 5m
+      Server:
+      - CompaniesHouse
+    body:
+      encoding: UTF-8
+      string: '{"errors":[{"error":"company-profile-not-found","type":"ch:service"}]}'
+    http_version: 
+  recorded_at: Mon, 28 Jan 2019 09:38:50 GMT
+recorded_with: VCR 4.0.0

data/spec/cassettes/company_no_valid.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.companieshouse.gov.uk/company/09360070
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.3.0 x86_64) ruby/2.4.2p198
+      Host:
+      - api.companieshouse.gov.uk
+      Authorization:
+      - Basic MnZodWowb1dhYk13N2h6TnpBVWlTT2ctNktpVVRCcFhCRF83Zktibzo=
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 27 Jan 2019 23:57:58 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1178'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Headers:
+      - X-RateLimit-Query, origin, content-type, content-length, user-agent, host,
+        accept, authorization
+      Access-Control-Expose-Headers:
+      - Location,www-authenticate,cache-control,pragma,content-type,expires,last-modified
+      - X-RateLimit-Window, X-RateLimit-Limit, X-RateLimit-Remain, X-RateLimit-Reset,
+        Location, www-authenticate, cache-control, pragma, content-type, expires,
+        last-modified
+      Access-Control-Max-Age:
+      - '3600'
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      X-Ratelimit-Limit:
+      - '600'
+      X-Ratelimit-Remain:
+      - '598'
+      X-Ratelimit-Reset:
+      - '1548633621'
+      X-Ratelimit-Window:
+      - 5m
+      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: Sun, 27 Jan 2019 23:57:58 GMT
+recorded_with: VCR 4.0.0

data/spec/defra_ruby_validators/companies_house_number_validator_spec.rb

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

data/spec/defra_ruby_validators/companies_house_service_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DefraRubyValidators
+  RSpec.describe CompaniesHouseService do
+    let(:companies_house_service) { CompaniesHouseService.new("09360070") }
+
+    context "when a company_no is for an active company" do
+      it "returns :active" do
+        VCR.use_cassette("company_no_valid") do
+          expect(companies_house_service.status).to eq(:active)
+        end
+      end
+    end
+
+    context "when a company_no is not found" do
+      let(:companies_house_service) { CompaniesHouseService.new("99999999") }
+
+      it "returns :not_found" do
+        VCR.use_cassette("company_no_not_found") do
+          expect(companies_house_service.status).to eq(:not_found)
+        end
+      end
+    end
+
+    context "when a company_no is inactive" do
+      let(:companies_house_service) { CompaniesHouseService.new("07281919") }
+
+      it "returns :inactive" do
+        VCR.use_cassette("company_no_inactive") do
+          expect(companies_house_service.status).to eq(:inactive)
+        end
+      end
+    end
+
+    context "when the request times out" do
+      it "raises an exception" do
+        VCR.turned_off do
+          host = "https://api.companieshouse.gov.uk/"
+          stub_request(:any, /.*#{host}.*/).to_timeout
+          expect { companies_house_service.status }.to raise_error(StandardError)
+        end
+      end
+    end
+
+    context "when the request returns an error" do
+      it "raises an exception" do
+        VCR.turned_off do
+          host = "https://api.companieshouse.gov.uk/"
+          stub_request(:any, /.*#{host}.*/).to_raise(SocketError)
+          expect { companies_house_service.status }.to raise_error(StandardError)
+        end
+      end
+    end
+  end
+end

data/spec/defra_ruby_validators/version_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe DefraRubyValidators do
+  it "has a version number" do
+    expect(DefraRubyValidators::VERSION).not_to be nil
+  end
+end

data/spec/examples.txt

@@ -0,0 +1,15 @@
+example_id                                                                     | status | run_time               |
+------------------------------------------------------------------------------ | ------ | ---------------------- |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:1:1] | passed | 0.02962 seconds        |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:2:1] | passed | 0.00043 seconds        |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:3:1] | passed | 0.00026 seconds        |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:1:4:1] | passed | 0.00026 seconds        |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:1:1] | passed | 0.01795 seconds        |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:1:2] | passed | 1 minute 29.46 seconds |
+./spec/defra_ruby_validators/companies_house_number_validator_spec.rb[1:2:2:1] | failed | 0.02416 seconds        |
+./spec/defra_ruby_validators/companies_house_service_spec.rb[1:1:1]            | passed | 0.0289 seconds         |
+./spec/defra_ruby_validators/companies_house_service_spec.rb[1:2:1]            | passed | 0.01738 seconds        |
+./spec/defra_ruby_validators/companies_house_service_spec.rb[1:3:1]            | passed | 0.01767 seconds        |
+./spec/defra_ruby_validators/companies_house_service_spec.rb[1:4:1]            | passed | 0.01833 seconds        |
+./spec/defra_ruby_validators/companies_house_service_spec.rb[1:5:1]            | passed | 0.01512 seconds        |
+./spec/defra_ruby_validators/version_spec.rb[1:1]                              | passed | 0.00209 seconds        |

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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 }
+
+RSpec.configure do |config|
+  # 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`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/defra_ruby_validators.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+DefraRubyValidators.configure do |configuration|
+  configuration.companies_house_api_key = ENV["COMPANIES_HOUSE_API_KEY"]
+end

data/spec/support/i18n.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Support using the locale files within our tests (else we'd rely on loading the
+# gem in a rails app to confirm these are being pulled through correctly.)
+require "i18n"
+
+I18n.load_path << Dir[File.expand_path("config/locales") + "/**/*.yml"]
+I18n.default_locale = :en

data/spec/support/vcr.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Stubbing HTTP requests
+require "webmock/rspec"
+# Auto generate fake responses for web-requests
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/cassettes"
+  c.hook_into :webmock
+
+  c.ignore_hosts "127.0.0.1", "codeclimate.com"
+
+  SECONDS_IN_DAY = 24 * 60 * 60
+
+  c.default_cassette_options = { re_record_interval: (14 * SECONDS_IN_DAY) }
+
+  # Strip out authorization info
+  c.filter_sensitive_data("Basic <API_KEY>") do |interaction|
+    auth = interaction.request.headers["Authorization"]
+    auth.first if auth.nil? || auth.empty?
+  end
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: defra_ruby_validators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Defra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: byebug
+  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: 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
+  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: rake
+  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: 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: rubocop
+  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: simplecov
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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/examples.txt
+- spec/spec_helper.rb
+- spec/support/defra_ruby_validators.rb
+- spec/support/i18n.rb
+- spec/support/vcr.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+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/examples.txt
+- spec/cassettes/company_no_not_found.yml
+- spec/cassettes/company_no_valid.yml
+- spec/cassettes/company_no_inactive.yml
+- spec/support/i18n.rb
+- spec/support/vcr.rb
+- spec/support/defra_ruby_validators.rb