defra_ruby_validators 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e2b90f695b85e87e772c0ff9706b022a889ddfc
-  data.tar.gz: d0fda70ca250ed7cedc5cb0243f9704858f5a3a3
+  metadata.gz: 0a6c04c81d7df4234ebf4905a40680e9f27be96b
+  data.tar.gz: 42b56455e1072d95b796c8403453326ce6d6ab85
 SHA512:
-  metadata.gz: 6ce3932e23c36d6d657759fcfeb35976bf82d123469d702b18c681c0dc3fb32027309ec6070903d642a26bb1ce47712641dd7843266c85e3a50aca8cb5947f47
-  data.tar.gz: 1784ad53fb92e0d93550bb583109c84ccff475ed50dc43120467ed2db5f0a86ef1d3304f8b939b7a8c7d3b1f4e10c97bda1a176838261070eb87dbd9aebb6d46
+  metadata.gz: f3464caf2e33d2a4dea606ad62728e82becb0416b4122728759e9f7973a877e7d19fcb7957dd175ac5302166ab189a616707b8d25e042f30664b0c9b068ac73a
+  data.tar.gz: 8c55a4ffba3ba440ecbefb37cb9de61b654373ea436c07f9c34841440437ba4105f90171b7058472f83b4376ef7e78fc92d40c8d26fd0c2fb88edc9b3561b545

data/README.md

@@ -45,24 +45,7 @@ A company can be in various states for example liquidation, which means for the
 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>
+validates :company_no, "defra_ruby/validators/companies_house_number": true
 ```
 
 ## Contributing to this project

data/config/locales/defra_ruby/validators/companies_house_number_validator/en.yml

@@ -0,0 +1,10 @@
+en:
+  defra_ruby:
+    validators:
+      CompaniesHouseNumberValidator:
+        company_no:
+          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.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+require_relative "validators/version"
+require_relative "validators/configuration"
+require_relative "validators/companies_house_service"
+
+require_relative "validators/base_validator"
+require_relative "validators/companies_house_number_validator"
+
+module DefraRuby
+  module Validators
+  end
+end

data/lib/defra_ruby/validators/base_validator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class BaseValidator < ActiveModel::EachValidator
+
+      protected
+
+      def error_message(attribute, error)
+        I18n.t("defra_ruby.validators.#{class_name}.#{attribute}.#{error}")
+      end
+
+      private
+
+      def class_name
+        self.class.name.split("::").last
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class CompaniesHouseNumberValidator < BaseValidator
+
+      # 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(attribute, "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(attribute, "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(attribute, "inactive")
+        when :not_found
+          record.errors[attribute] << error_message(attribute, "not_found")
+        end
+      rescue StandardError
+        record.errors[attribute] << error_message(attribute, "error")
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/companies_house_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rest-client"
+
+module DefraRuby
+  module Validators
+    class CompaniesHouseService
+      def initialize(company_no)
+        @company_no = company_no
+        @url = "#{DefraRuby::Validators.configuration.companies_house_host}#{@company_no}"
+        @api_key = DefraRuby::Validators.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
+end

data/lib/defra_ruby/validators/configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    class Configuration
+      ATTRIBUTES = %i[
+        companies_house_host
+        companies_house_api_key
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize
+        @companies_house_host = "https://api.companieshouse.gov.uk/company/"
+        @companies_house_api_key = nil
+      end
+
+      def ensure_valid
+        missing_attributes = ATTRIBUTES.select { |a| public_send(a).nil? }
+        return true if missing_attributes.empty?
+
+        raise "The following DefraRuby::Validators configuration attributes are missing: #{missing_attributes}"
+      end
+    end
+  end
+end

data/lib/defra_ruby/validators/engine.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "defra_ruby/validators"
+
+module DefraRuby
+  module Validators
+    # Engine used to load in the custom validations
+    class Engine < ::Rails::Engine
+      isolate_namespace DefraRuby::Validators
+
+      # 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
+end

data/lib/defra_ruby/validators/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    VERSION = "1.0.0"
+  end
+end

data/lib/defra_ruby_validators.rb

@@ -1,14 +1,32 @@
 # frozen_string_literal: true
 
-require "defra_ruby_validators/engine"
+require "defra_ruby/validators/engine"
 
+# This breaks from the typical pattern of calling the root file in lib after the
+# root namespace e.g. defra_ruby.rb
+# The specific intent for this gem (engine) is to be used in our services rails
+# engines i.e. an engine mounted in an engine.
+#
+# The standard pattern is to have an engine.rb in the relevant namespace. Hence
+# in this project we have lib/defra_ruby/validators/engine.rb. When it comes to
+# requiring this project in host engine this means it needs to require that
+# file explicitly. For example in lib/waste_exemptions_engine/engine.rb the
+# reference would be
+#
+# require "defra_ruby/validators/engine"
+#
+# That's fine, but it does mean this file becomes meaningless. Its not
+# referenced by our specs as they refer to lib/defra_ruby/validators/validators.rb
+# It's not referenced by engine.rb because it also references validators.rb.
+#
+# However if we call it defra_ruby_validators.rb and include a require to the
+# engine, then the host engine can instead just do the following
+#
+# require "defra_ruby_validators"
+#
+# This makes the require statement consistent with the name of the gem, makes
+# implementation a little simpler, and if we build up a suite of these engines
+# makes them a little clearer to distinguish in the host engine's engine.rb.
 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.
+  # The Defra Ruby packages namespace
 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 (darwin17.3.0 x86_64) ruby/2.4.2p198
+      - rest-client/2.0.2 (darwin18.5.0 x86_64) ruby/2.4.2p198
       Host:
       - api.companieshouse.gov.uk
       Authorization:
@@ -22,14 +22,6 @@ http_interactions:
       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:
@@ -44,18 +36,26 @@ http_interactions:
       - '3600'
       Cache-Control:
       - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 13 May 2019 10:51:59 GMT
       Pragma:
       - no-cache
+      Server:
+      - CompaniesHouse
       X-Ratelimit-Limit:
       - '600'
       X-Ratelimit-Remain:
-      - '596'
+      - '597'
       X-Ratelimit-Reset:
-      - '1548668445'
+      - '1557745019'
       X-Ratelimit-Window:
       - 5m
-      Server:
-      - CompaniesHouse
+      Content-Length:
+      - '979'
+      Connection:
+      - keep-alive
     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: Mon, 28 Jan 2019 09:38:50 GMT
+  recorded_at: Mon, 13 May 2019 10:51:59 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 (darwin17.3.0 x86_64) ruby/2.4.2p198
+      - rest-client/2.0.2 (darwin18.5.0 x86_64) ruby/2.4.2p198
       Host:
       - api.companieshouse.gov.uk
       Authorization:
@@ -22,14 +22,6 @@ http_interactions:
       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:
@@ -44,21 +36,29 @@ http_interactions:
       - '3600'
       Cache-Control:
       - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 13 May 2019 10:51:59 GMT
       Pragma:
       - no-cache
+      Server:
+      - CompaniesHouse
       X-Ratelimit-Limit:
       - '600'
       X-Ratelimit-Remain:
-      - '597'
+      - '598'
       X-Ratelimit-Reset:
-      - '1548668445'
+      - '1557745019'
       X-Ratelimit-Window:
       - 5m
-      Server:
-      - CompaniesHouse
+      Content-Length:
+      - '70'
+      Connection:
+      - keep-alive
     body:
       encoding: UTF-8
-      string: '{"errors":[{"error":"company-profile-not-found","type":"ch:service"}]}'
+      string: '{"errors":[{"type":"ch:service","error":"company-profile-not-found"}]}'
     http_version: 
-  recorded_at: Mon, 28 Jan 2019 09:38:50 GMT
+  recorded_at: Mon, 13 May 2019 10:51:59 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 (darwin17.3.0 x86_64) ruby/2.4.2p198
+      - rest-client/2.0.2 (darwin18.5.0 x86_64) ruby/2.4.2p198
       Host:
       - api.companieshouse.gov.uk
       Authorization:
@@ -22,14 +22,6 @@ http_interactions:
       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:
@@ -44,22 +36,30 @@ http_interactions:
       - '3600'
       Cache-Control:
       - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Type:
+      - application/json
+      Date:
+      - Mon, 13 May 2019 10:51:59 GMT
       Pragma:
       - no-cache
+      Server:
+      - CompaniesHouse
       X-Ratelimit-Limit:
       - '600'
       X-Ratelimit-Remain:
-      - '598'
+      - '599'
       X-Ratelimit-Reset:
-      - '1548633621'
+      - '1557745019'
       X-Ratelimit-Window:
       - 5m
-      Server:
-      - CompaniesHouse
+      Content-Length:
+      - '1178'
+      Connection:
+      - keep-alive
     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_at: Mon, 13 May 2019 10:51:58 GMT
 recorded_with: VCR 4.0.0