companies_house_input_gateway 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76d1a45ee9a75590b55377e828568d02003f3f3fe39e912b7dc8cad6e73e305c
+  data.tar.gz: 5fb3eff3d7eb8a43775141f51f7807fc39e258a89f9c93ad33ea118c60848c7e
+SHA512:
+  metadata.gz: 7f41ea2e376bd5f447b0e137b0fda339ad2a5b12b23514dfe510f647880d66d6f1d4a5ccd0933ec2ff2522484a7e78902d5b1bb4a505257c78e2432283736d5a
+  data.tar.gz: 5e96ab1ab1b0df528c86200d93a1b1e1bc0ab87da230f9f92cbd06cfa66c97d49dd39b40884eeff124af39c7580380dd57e68ad8d030be7f21623e749b12bcd2

data/lib/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class Base
+    def self.root
+      File.dirname __dir__
+    end
+  end
+end

data/lib/companies_house_input_gateway/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class Client
+    def initialize(config = nil)
+      @config = (config || CompaniesHouseInputGateway.config).clone
+    end
+
+    def perform_check(*args)
+      request = Request.new(connection, @config)
+      request.perform(*args)
+    end
+
+    attr_reader :config
+
+    Constants::SUPPORTED_REQUESTS.each do |name|
+      class_eval <<-EOM
+        def #{Util.underscore(name)}(*args)
+          check = CompaniesHouseInputGateway::Requests.const_get(:#{name}).new(self)
+          check.perform(*args)
+        end
+      EOM
+    end
+
+    private
+
+    def connection
+      options = {
+        ssl: { verify: false },
+        url: @config[:api_endpoint],
+        headers: {
+          'Accept' => 'application/xml',
+          'User-Agent' => @config[:user_agent]
+        }
+      }
+
+      Faraday.new(options) do |c|
+        c.response :check_ch_response unless @config[:raw] # Check XML
+        c.response :xml unless @config[:raw] # Parse response
+        c.response :follow_redirects, limit: 3              # Follow redirect
+        c.response :raise_error                             # Raise errors
+        c.adapter @config[:adapter]
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class Config
+    DEFAULT_OPTIONS = {
+      adapter: Faraday.default_adapter,
+      sender_id: nil,
+      password: nil,
+      email: nil,
+      gateway: nil,
+      raw: false,
+      api_endpoint: 'https://xmlgw.companieshouse.gov.uk/v1-0/xmlgw/Gateway',
+      user_agent: "CompaniesHouseGateway Ruby Gem #{CompaniesHouseInputGateway::VERSION}",
+      open_timeout: 1,
+      timeout: 3
+    }.freeze
+
+    def initialize
+      @config = {}
+      yield self if block_given?
+    end
+
+    def [](name)
+      @config.fetch(name, DEFAULT_OPTIONS[name])
+    end
+
+    def []=(name, val)
+      @config[name] = val
+    end
+
+    def clone
+      Config.new { |config| @config.each { |k, v| config[k] = v } }
+    end
+  end
+end

data/lib/companies_house_input_gateway/constants.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Constants
+    SUPPORTED_REQUESTS = %w[ReturnofAllotmentShares ConfirmationStatement GetSubmissionStatus CompanyDataRequest].freeze
+
+    COUNTRIES = %w[USA IRL DEU FRA ITA ESP PRT NLD POL BEL NOR SWE DNK
+                   AUS NZL CAN ZAF AUT HRV CYP CZE EST HUN GRC LTU GBR GB-ENG GB-WLS GB-SCT GB-NIR].freeze
+
+    SPECIAL_FIELDS_MAPPER = {
+      dtr_5_applies: 'DTR5Applies',
+      psc_exempt_as_trading_on_regulated_market: 'PSCExemptAsTradingOnRegulatedMarket',
+      psc_exempt_as_shares_admitted_on_market: 'PSCExemptAsSharesAdmittedOnMarket',
+      psc_exempt_as_trading_on_uk_regulated_market: 'PSCExemptAsTradingOnUKRegulatedMarket',
+      sic_codes: 'SICCodes',
+      sic_code: 'SICCode',
+      presenter_id: 'PresenterID',
+      'SICCode' => 'SICCode'
+    }.freeze
+  end
+end

data/lib/companies_house_input_gateway/errors/api_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class APIError < CompaniesHouseGatewayError
+    attr_accessor :error_code
+
+    def initialize(message = nil, error_code = nil, status = nil, response_body = nil)
+      super(message, status, response_body)
+      @error_code = error_code
+    end
+
+    def to_s
+      str = super
+      str += " [Error code: #{error_code}]" if error_code
+      str
+    end
+  end
+end

data/lib/companies_house_input_gateway/errors/companies_house_gateway_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class CompaniesHouseGatewayError < StandardError
+    attr_reader :message
+    attr_reader :status
+    attr_reader :response_body
+
+    def initialize(message = nil, status = nil, _response = nil)
+      @message = message
+      @status = status
+      @response_body = response_body
+    end
+
+    def to_s
+      status_string = @status.nil? ? '' : "(Status #{@status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/companies_house_input_gateway/errors/invalid_request_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class InvalidRequestError < CompaniesHouseGatewayError
+    attr_accessor :param
+
+    def initialize(message = nil, param = nil, status = nil, response_body = nil)
+      super(message, status, response_body)
+      @param = param
+    end
+  end
+end

data/lib/companies_house_input_gateway/errors/invalid_response_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class InvalidResponseError < CompaniesHouseGatewayError
+  end
+end

data/lib/companies_house_input_gateway/form_validator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class FormValidator
+    def self.validate(data, request_class)
+      form_validator = new(data, request_class)
+      validation = form_validator.validate_data
+
+      if validation.failure?
+        msg = "#{request_class} - has request parameters error: #{validation.errors.to_hash}"
+        raise InvalidRequestError.new(msg, data)
+      end
+      validation
+    end
+
+    def initialize(data, request_class)
+      @data = data
+      @request_class = request_class
+    end
+
+    def validate_data
+      Validations.const_get(:"#{request_class}").call(data)
+    end
+
+    private
+
+    attr_reader :data, :request_class
+  end
+end

data/lib/companies_house_input_gateway/forms/form_abstract_builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Forms
+    class FormAbstractBuilder
+      attr_reader :xml, :data
+
+      def initialize(xml: nil, data: {})
+        @xml = xml
+        @data = data
+      end
+
+      def build_form(_request_type, _requested_form = nil)
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+
+      def generate_xml_from_incoming_data(data, request_type, parent = nil, first_iteration = false)
+        return if data.to_s.empty?
+        return unless data.is_a?(Hash)
+
+        unless parent
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.send(request_type, form_namespace) do
+              generate_xml_from_incoming_data(data, request_type, xml)
+            end
+          end
+
+          return builder
+        end
+
+        if first_iteration
+          request_type = Util.camelize(request_type)
+          parent.send(request_type, form_namespace) do
+            generate_xml_from_incoming_data(data, request_type, parent)
+          end
+
+          return parent
+        end
+
+        data.each do |label, value|
+          label = Constants::SPECIAL_FIELDS_MAPPER[label] || Util.camelize(label)
+          if value.is_a?(Hash)
+            parent.send(label) do
+              generate_xml_from_incoming_data(value, request_type, parent)
+            end
+
+          elsif value.is_a?(Array)
+            value.each do |el|
+              el = { label => el }
+              generate_xml_from_incoming_data(el, request_type, parent)
+            end
+
+          else
+            value = value.is_a?(BigDecimal) ? value.to_f : value
+            parent.send(label, value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/forms/form_company_data_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Forms
+    class FormCompanyDataRequest < FormAbstractBuilder
+      def build_form(request_type, requested_form = nil)
+        generate_xml_from_incoming_data(data, request_type, requested_form, true)
+      end
+
+      def form_namespace
+        {
+
+          'xmlns' => 'http://xmlgw.companieshouse.gov.uk',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://xmlgw.companieshouse.gov.uk http://xmlgw.companieshouse.gov.uk/v2-1/schema/CompanyData-v3-4.xsd'
+        }
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/forms/form_confirmation_statement.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Forms
+    class FormConfirmationStatement < FormAbstractBuilder
+      def build_form(request_type, requested_form = nil)
+        generate_xml_from_incoming_data(data, request_type, requested_form, true)
+      end
+
+      def form_namespace
+        {
+
+          'xmlns' => 'http://xmlgw.companieshouse.gov.uk',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://xmlgw.companieshouse.gov.uk http://xmlgw.companieshouse.gov.uk/v1-0/schema/forms/ConfirmationStatement-v1-2.xsd'
+
+        }
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/forms/form_get_submission_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Forms
+    class FormGetSubmissionStatus < FormAbstractBuilder
+      def build_form(request_type, requested_form = nil)
+        generate_xml_from_incoming_data(data, request_type, requested_form, true)
+      end
+
+      def form_namespace
+        {
+
+          'xmlns' => 'http://xmlgw.companieshouse.gov.uk',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://xmlgw.companieshouse.gov.uk http://xmlgw.companieshouse.gov.uk/v1-0/schema/forms/GetSubmissionStatus-v2-9.xsd'
+
+        }
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/forms/form_returnof_allotment_shares.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Forms
+    class FormReturnofAllotmentShares < FormAbstractBuilder
+      def build_form(request_type, requested_form = nil)
+        generate_xml_from_incoming_data(data, request_type, requested_form, true)
+      end
+
+      def form_namespace
+        {
+
+          'xmlns' => 'http://xmlgw.companieshouse.gov.uk',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://xmlgw.companieshouse.gov.uk http://xmlgw.companieshouse.gov.uk/v1-0/schema/forms/ReturnofAllotmentShares-v3-0.xsd'
+
+        }
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/forms/form_submission.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Forms
+    class FormSubmission < FormAbstractBuilder
+      def build_form(request_type, requested_form = nil)
+        FormValidator.validate(data, Util.demodulize(self.class))
+
+        xml.FormSubmission(submission_namespace) do
+          form_header(xml, request_type, data)
+          xml.DateSigned data[:date_signed] # "2015-07-01"
+          xml.Form do
+            requested_form.build_form(request_type, xml)
+          end
+        end
+      end
+
+      def submission_namespace
+        {
+          'xmlns' => 'http://xmlgw.companieshouse.gov.uk/Header',
+          'xmlns:bs' => 'http://xmlgw.companieshouse.gov.uk',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://xmlgw.companieshouse.gov.uk/Header http://xmlgw.companieshouse.gov.uk/v1-0/schema/forms/FormSubmission-v2-9.xsd'
+        }
+      end
+
+      def form_header(root_xml, request_type, data)
+        root_xml.FormHeader do
+          root_xml.CompanyNumber data[:company_number]
+          root_xml.CompanyName data[:company_name]
+          root_xml.CompanyAuthenticationCode data[:company_authentication_code]
+          root_xml.PackageReference data[:package_reference]
+          root_xml.FormIdentifier Util.camelize(request_type)
+          root_xml.SubmissionNumber data[:submission_number]
+        end
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/middleware/check_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Middleware
+    class CheckResponse < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |item|
+          check_for_errors(item)
+          response_values(item)
+        end
+      end
+
+      def response_values(env)
+        { status: env[:status], headers: env[:headers], body: env[:body] }
+      end
+
+      def check_for_errors(env)
+        body = env[:body]['GovTalkMessage']
+        raise InvalidResponseError.new(env[:body], env[:status], env) unless body && body['GovTalkDetails']
+
+        if body['GovTalkDetails']['GovTalkErrors']
+          error = body['GovTalkDetails']['GovTalkErrors'].values.flatten.first
+          raise APIError.new(error['Text'], error['Number'], env[:status], env)
+        end
+      end
+    end
+
+    Faraday::Response.register_middleware check_ch_response: CheckResponse
+  end
+end

data/lib/companies_house_input_gateway/request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class Request
+    def initialize(connection, config)
+      @connection = connection
+      @config = config
+    end
+
+    def perform(request_type, request_data = {}, require_submission_form)
+      xml_form = XmlFormsBinder.new(request_type, @config, request_data)
+
+      request_type = Util.camelize(request_type)
+      unless Constants::SUPPORTED_REQUESTS.include?(request_type)
+        msg = "Unsupported request type #{request_type}"
+        raise CompaniesHouseGatewayError, msg
+      end
+
+      response = @connection.post do |request|
+        request.path = @config[:api_endpoint]
+        request_body = xml_form.build_request_xml(require_submission_form).to_s
+        if defined?(Rails)
+          Rails.logger.tagged('CompaniesHouseInputGateway', 'XmlRequest') do
+            Rails.logger.info xml_data: request_body
+          end
+        end
+        request.body = request_body
+        request.options.open_timeout = @config[:open_timeout]
+        request.options.timeout = @config[:timeout]
+      end
+
+      xml_response = @config[:raw] ? response : response.body
+      if defined?(Rails)
+        Rails.logger.tagged('CompaniesHouseInputGateway', 'XmlResponse') do
+          Rails.logger.info xml_data: xml_response
+        end
+      end
+      xml_response
+    rescue Faraday::ClientError => e
+      if e.response.nil?
+        raise CompaniesHouseGatewayError
+      else
+        raise CompaniesHouseGatewayError.new(e.response[:body],
+                                             e.response[:status],
+                                             e.response)
+      end
+    rescue Faraday::ServerError => e
+      raise CompaniesHouseGatewayError.new(e.response[:body],
+                                           e.response[:status],
+                                           e.response)
+    rescue Faraday::ParsingError => e
+      raise CompaniesHouseGatewayError.new(e.response[:body],
+                                           e.response[:status],
+                                           e.response)
+    end
+  end
+end

data/lib/companies_house_input_gateway/requests/abstract_performer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Requests
+    module AbstractPerformer
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def initialize(client)
+        @client = client
+      end
+
+      def perform(data = {})
+        require_submission_form = self.class.submission_form
+        validate_params(data, Util.demodulize(self.class))
+        check_type = Util.underscore(Util.demodulize(self.class))
+        response = @client.perform_check(check_type, data, require_submission_form)
+
+        @client.config[:raw] ? response : response_body(response)
+      end
+
+      private
+
+      def validate_params(data, request_class)
+        FormValidator.validate(data[:request_data], request_class)
+      end
+
+      def response_body(response)
+        body = response['GovTalkMessage']['Body']
+
+        return response if body.nil?
+
+        body[Util.demodulize(self.class)] || body.dig('SubmissionStatus', 'Status') || body['CompanyData']
+      end
+
+      module ClassMethods
+        def require_submission_form(value)
+          unless [true, false].include?(value)
+            raise ArgumentError, "The method #{__method__} in called in  accepts only Boolean true, false values"
+          end
+
+          @submission_form = value
+        end
+
+        def submission_form
+          @submission_form
+        end
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/requests/company_data_request.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Requests
+    class CompanyDataRequest
+      include AbstractPerformer
+    end
+  end
+end

data/lib/companies_house_input_gateway/requests/confirmation_statement.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Requests
+    class ConfirmationStatement
+      include AbstractPerformer
+
+      require_submission_form true
+    end
+  end
+end

data/lib/companies_house_input_gateway/requests/get_submission_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Requests
+    class GetSubmissionStatus
+      include AbstractPerformer
+    end
+  end
+end

data/lib/companies_house_input_gateway/requests/returnof_allotment_shares.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Requests
+    class ReturnofAllotmentShares
+      include AbstractPerformer
+
+      require_submission_form true
+    end
+  end
+end

data/lib/companies_house_input_gateway/util.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module CompaniesHouseInputGateway
+  module Util
+    module_function
+
+    def camelize(str)
+      str.to_s.split('_').map(&:capitalize).join
+    end
+
+    def underscore(str)
+      str.to_s.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+         .tr('-', '_')
+         .downcase
+    end
+
+    def demodulize(str)
+      str.to_s.split('::').last
+    end
+
+    def create_digest(value)
+      Digest::MD5.hexdigest(value)
+    end
+  end
+end

data/lib/companies_house_input_gateway/validations/company_data_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Validations
+    CompanyDataRequest = Dry::Validation.Schema do
+      configure do
+        config.messages_file = File.join(Base.root, './errors.yml')
+
+        def company_number_format?(value)
+          value ? value.match(/^([\d]*\d){8}$/) : true
+        end
+      end
+
+      required(:company_number).filled(:str?)
+      required(:company_authentication_code).filled(:str?, size?: 6)
+      required(:made_up_date).filled(:date?)
+      required(:company_number).filled(:company_number_format?)
+    end
+  end
+end