companies_house_input_gateway 0.0.6

data/lib/companies_house_input_gateway/validations/confirmation_statement.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Validations
+    ConfirmationStatement = Dry::Validation.Schema do
+      configure do
+        config.messages_file = File.join(Base.root, './errors.yml')
+
+        def shareholders_names_presence?(shareholdings)
+          check = shareholdings.map do |holdings|
+            holdings[:shareholders].any? do |i|
+              ((i[:name][:surname] && i[:name][:forename]) && !i[:name][:amalgamated_name]) ||
+                (!(i[:name][:surname] || i[:name][:forename]) && i[:name][:amalgamated_name])
+            end
+          end
+          check.all?
+        end
+
+        def other_foreign_country?(shareholdings)
+          check = shareholdings.map do |holdings|
+            check = holdings[:shareholders].any? do |i|
+              next true unless i[:address]
+
+              !(i[:address][:country] && i[:address][:other_foreign_country])
+            end
+          end
+          check.all?
+        end
+      end
+
+      optional(:trading_on_market).filled(:bool?)
+      optional(:dtr_5_applies).filled(:bool?)
+      optional(:psc_exempt_as_trading_on_regulated_market).filled(:bool?)
+      optional(:psc_exempt_as_shares_admitted_on_market).filled(:bool?)
+      optional(:psc_exempt_as_trading_on_uk_regulated_market).filled(:bool?)
+      required(:review_date).filled(:date?)
+
+      optional(:sic_codes).schema do
+        required(:sic_code).each(:str?)
+      end
+      # optional(:statement_of_capital).schema do
+      #   required(:capital).each do
+      #     schema do
+      #       required(:total_amount_unpaid).filled(:decimal?)
+      #       required(:total_number_of_issued_shares).filled(:decimal?)
+      #       required(:share_currency).filled(:str?)
+      #       required(:total_aggregate_nominal_value).filled(:decimal?)
+      #       required(:shares).each do
+      #         schema do
+      #           required(:share_class).filled(:str?)
+      #           required(:prescribed_particulars).filled(:str?)
+      #           required(:num_shares).filled(:decimal?)
+      #           required(:aggregate_nominal_value).filled(:decimal?)
+      #         end
+      #       end
+      #     end
+      #   end
+      # end
+
+      # required(:shareholdings).each do
+      #   schema do
+      #     required(:share_class).filled(:str?)
+      #     required(:number_held).filled(:decimal?)
+      #     required(:transfers).each do
+      #       schema do
+      #         required(:date_of_transfer).filled(:date?)
+      #         required(:number_shares_transferred).filled(:decimal?)
+      #       end
+      #     end
+      #
+      #     optional(:shareholders).each do
+      #       schema do
+      #         required(:name).schema do
+      #           optional(:surname).filled(:str?)
+      #           optional(:forename).filled(:str?)
+      #           optional(:amalgamated_name).filled(:str?)
+      #         end
+      #         optional(:address).schema do
+      #           required(:premise).filled(:str?)
+      #           required(:street).filled(:str?)
+      #           required(:thoroughfare).filled(:str?)
+      #           required(:post_town).filled(:str?)
+      #           required(:county).filled(:str?)
+      #           optional(:country).filled(included_in?: CompaniesHouseInputGateway::Constants::COUNTRIES)
+      #           optional(:other_foreign_country).filled(:str?)
+      #         end
+      #       end
+      #     end
+      #   end
+      # end
+      required(:state_confirmation).filled(:bool?)
+      # required(:shareholdings).filled(:shareholders_names_presence?)
+      # required(:shareholdings).filled(:other_foreign_country?)
+    end
+  end
+end

data/lib/companies_house_input_gateway/validations/form_submission.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Validations
+    FormSubmission = 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(:date_signed).filled(:date?)
+      required(:company_number).filled(:str?)
+      required(:company_name).filled(:str?)
+      required(:company_authentication_code).filled(:str?)
+      required(:package_reference).filled(:str?)
+      required(:submission_number).filled(:str?, size?: 6)
+      required(:company_number).filled(:company_number_format?)
+    end
+  end
+end

data/lib/companies_house_input_gateway/validations/get_submission_status.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Validations
+    GetSubmissionStatus = 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
+
+      optional(:company_number).maybe(:str?)
+      optional(:submission_number).filled(:str?)
+      required(:presenter_id).filled(:str?)
+      optional(:company_number).filled(:company_number_format?)
+
+      rule(company_number_or_submission_number_presence: %i[company_number submission_number]) do |company_number, submission_number|
+        company_number.filled?.then(submission_number.none?) & submission_number.filled?.then(company_number.none?)
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/validations/returnof_allotment_shares.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  module Validations
+    ReturnofAllotmentShares = Dry::Validation.Schema do
+      required(:start_period_shares_allotted).filled(:date?)
+      optional(:end_period_shares_allotted).filled(:date?)
+
+      required(:statement_of_capital).schema do
+        required(:capital).each do
+          schema do
+            required(:total_amount_unpaid).filled(:str?)
+            required(:total_number_of_issued_shares).filled(:str?)
+            required(:share_currency).filled(:str?)
+            required(:total_aggregate_nominal_value).filled(:str?)
+            required(:shares).each do
+              schema do
+                required(:share_class).filled(:str?)
+                required(:prescribed_particulars).filled(:str?)
+                required(:num_shares).filled(:str?)
+                required(:aggregate_nominal_value).filled(:str?)
+              end
+            end
+          end
+        end
+      end
+
+      required(:allotment).each do
+        schema do
+          required(:share_class).filled(:str?)
+          required(:num_shares).filled(:str?)
+          required(:amount_paid_due_per_share).filled(:str?)
+          required(:amount_unpaid_per_share).filled(:str?)
+          required(:share_currency).filled(:str?)
+          required(:share_value).filled(:str?)
+          optional(:consideration).filled(:str?)
+        end
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  VERSION = '0.0.6'
+end

data/lib/companies_house_input_gateway/xml_forms_binder.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module CompaniesHouseInputGateway
+  class XmlFormsBinder
+    def initialize(request_type, config, request_data = {})
+      @request_type = request_type
+      @request_data = request_data
+      @config = config
+    end
+
+    def build_request_xml(submission_form, transaction_id = (Time.now.to_f * 100).to_i)
+      # transaction_id = (Time.now.to_f * 100).to_i
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.GovTalkMessage(header_namespace) do
+          xml.EnvelopeVersion '1.0'
+          xml.Header do
+            message_details(xml, request_type, transaction_id)
+            sender_authentication(xml)
+          end
+          xml.GovTalkDetails do
+            xml.Keys
+          end
+          xml.Body do
+            build_form(xml, request_type, @request_data, submission_form)
+          end
+        end
+      end
+      builder.doc
+    end
+
+    private
+
+    attr_reader :request_type, :request_data, :config
+
+    def header_namespace
+      {
+        'xmlns' => 'http://www.govtalk.gov.uk/CM/envelope',
+        'xmlns:dsig' => 'http://www.w3.org/2000/09/xmldsig#',
+        'xmlns:gt' => 'http://www.govtalk.gov.uk/schemas/govtalk/core',
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:schemaLocation' => 'http://www.govtalk.gov.uk/CM/envelope http://xmlgw.companieshouse.gov.uk/v2-1/schema/Egov_ch-v2-0.xsd'
+      }
+    end
+
+    def build_form(xml, request_type, _request_data, submission_form)
+      request_form = Forms.const_get(:"Form#{Util.camelize request_type}").new(xml: xml, data: @request_data[:request_data])
+
+      if submission_form
+        submission_form = Forms::FormSubmission.new(xml: xml, data: @request_data[:submission_data])
+        return submission_form.build_form(request_type, request_form)
+      end
+
+      request_form.build_form(request_type, xml)
+    end
+
+    def message_details(xml, request_type, transaction_id)
+      request_class = Util.camelize(request_type)
+      request_class = request_class == 'ReturnofAllotmentShares' ? 'ReturnOfAllotmentShares' : request_class
+
+      xml.MessageDetails do
+        xml.Class request_class
+        xml.Qualifier 'request'
+        xml.TransactionID transaction_id
+        xml.GatewayTest @config[:gateway].to_i
+      end
+    end
+
+    def sender_authentication(xml)
+      xml.SenderDetails do
+        xml.IDAuthentication do
+          xml.SenderID Util.create_digest(@config[:sender_id])
+          xml.Authentication do
+            xml.Method 'clear'
+            xml.Value Util.create_digest(@config[:password])
+          end
+        end
+        xml.EmailAddress @config[:email] if @config[:email]
+      end
+    end
+  end
+end

data/lib/companies_house_input_gateway.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'faraday_middleware'
+require 'nokogiri'
+require 'dry-validation'
+
+require 'base'
+require 'companies_house_input_gateway/version'
+require 'companies_house_input_gateway/constants'
+require 'companies_house_input_gateway/util'
+require 'companies_house_input_gateway/config'
+require 'companies_house_input_gateway/request'
+require 'companies_house_input_gateway/client'
+require 'companies_house_input_gateway/form_validator'
+require 'companies_house_input_gateway/xml_forms_binder'
+require 'companies_house_input_gateway/middleware/check_response'
+
+require 'companies_house_input_gateway/errors/companies_house_gateway_error'
+require 'companies_house_input_gateway/errors/invalid_request_error'
+require 'companies_house_input_gateway/errors/invalid_response_error'
+require 'companies_house_input_gateway/errors/api_error'
+
+require 'companies_house_input_gateway/requests/abstract_performer'
+require 'companies_house_input_gateway/requests/returnof_allotment_shares'
+require 'companies_house_input_gateway/requests/confirmation_statement'
+require 'companies_house_input_gateway/requests/get_submission_status'
+require 'companies_house_input_gateway/requests/company_data_request'
+
+require 'companies_house_input_gateway/forms/form_abstract_builder'
+require 'companies_house_input_gateway/forms/form_submission'
+require 'companies_house_input_gateway/forms/form_returnof_allotment_shares'
+require 'companies_house_input_gateway/forms/form_confirmation_statement'
+require 'companies_house_input_gateway/forms/form_get_submission_status'
+require 'companies_house_input_gateway/forms/form_company_data_request'
+
+require 'companies_house_input_gateway/validations/returnof_allotment_shares'
+require 'companies_house_input_gateway/validations/form_submission'
+require 'companies_house_input_gateway/validations/confirmation_statement'
+require 'companies_house_input_gateway/validations/get_submission_status'
+require 'companies_house_input_gateway/validations/company_data_request'
+
+module CompaniesHouseInputGateway
+  def self.configure(&block)
+    @config = Config.new(&block)
+  end
+
+  def self.perform_check(*args)
+    client.perform_check(*args)
+  end
+
+  Constants::SUPPORTED_REQUESTS.each do |name|
+    class_eval <<-EOM
+      def self.#{Util.underscore(name)}(*args)
+        client.send(:#{Util.underscore(name)}, *args)
+      end 
+    EOM
+  end
+
+  # Require configuration before use
+  def self.config
+    if @config
+      @config
+    else
+      msg = 'No config found. Use CompaniesHouseGateway.configure to set '
+      'username and password. See ' \
+        'https://github.com/irbux/companies_house_input_gateway' \
+        'for details.'
+      raise CompaniesHouseGatewayError, msg
+    end
+  end
+
+  def self.client
+    @client ||= Client.new(config)
+  end
+  private_class_method :client
+end

data/spec/client_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+shared_examples 'it delegates to the check' do |method_name|
+  it "delegates #{method_name} to " +
+     CompaniesHouseInputGateway::Util.camelize(method_name).to_s do
+    expect_any_instance_of(CompaniesHouseInputGateway::Requests
+      .const_get(CompaniesHouseInputGateway::Util.camelize(method_name)))
+      .to receive(:perform).once
+    client.send(method_name, {})
+  end
+end
+
+describe CompaniesHouseInputGateway::Client do
+  let(:client) { described_class.new(config) }
+  let(:config) { CompaniesHouseInputGateway::Config.new }
+
+  describe '#new' do
+    context 'without a config' do
+      before { configure_companies_house_input_gateway }
+      subject(:new_client) { described_class.new }
+
+      describe '#config' do
+        subject { super().config }
+        it { should_not == CompaniesHouseInputGateway.config }
+      end
+      it 'has the attributes of the global config' do
+        new_client.config[:sender_id] ==
+          CompaniesHouseInputGateway.config[:sender_id]
+      end
+    end
+
+    context 'with a config' do
+      before { config[:first_name] = 'test' }
+      subject(:new_client) { described_class.new(config) }
+
+      describe '#config' do
+        subject { super().config }
+        it { should_not == config }
+      end
+      it 'has the attributes of the passed in config' do
+        new_client.config[:sender_id] == config[:sender_id]
+      end
+    end
+  end
+
+  describe '#perform_check' do
+    it 'delegates to an instance of Request' do
+      expect_any_instance_of(CompaniesHouseInputGateway::Request)
+        .to receive(:perform).once
+      client.perform_check({}, {})
+    end
+  end
+
+  it_behaves_like 'it delegates to the check', :returnof_allotment_shares
+  it_behaves_like 'it delegates to the check', :confirmation_statement
+  it_behaves_like 'it delegates to the check', :get_submission_status
+end

data/spec/companies_house_input_gateway_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+shared_examples 'it delegates to the client' do |method_name|
+  before { configure_companies_house_input_gateway }
+  let(:data) { 'data' }
+
+  it "delegates #{method_name} to the client" do
+    expect_any_instance_of(CompaniesHouseInputGateway::Client)
+      .to receive(method_name).with(data)
+    CompaniesHouseInputGateway.send(method_name, data)
+  end
+end
+
+describe CompaniesHouseInputGateway do
+  before { CompaniesHouseInputGateway.instance_variable_set(:@config, nil) }
+
+  describe '#configure' do
+    subject { CompaniesHouseInputGateway.config }
+    CompaniesHouseInputGateway::Config::DEFAULT_OPTIONS.keys.each do |key|
+      context "setting #{key}" do
+        before do
+          CompaniesHouseInputGateway.configure { |config| config[key] = key }
+        end
+
+        describe [key] do
+          subject { super()[key] }
+          it { should == key }
+        end
+      end
+    end
+  end
+
+  describe '#config' do
+    subject(:config) { CompaniesHouseInputGateway.config }
+
+    it "raises an error if CompaniesHouseInputGateway hasn't been configured" do
+      expect { config }
+        .to raise_error CompaniesHouseInputGateway::CompaniesHouseGatewayError
+    end
+  end
+
+  it_behaves_like 'it delegates to the client', :returnof_allotment_shares
+  it_behaves_like 'it delegates to the client', :confirmation_statement
+  it_behaves_like 'it delegates to the client', :get_submission_status
+end

data/spec/data_samples.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+returnof_allotment_shares = {
+  submission_data: {
+    date_signed: Date.parse('2015-07-01'),
+    company_number: '11111111',
+    company_name: 'EXAMPLE COMPANY',
+    company_authentication_code: '123456',
+    package_reference: '0012',
+    submission_number: '100068'
+  },
+  request_data: {
+    start_period_shares_allotted: Date.parse('2016-05-13'),
+    end_period_shares_allotted: Date.parse('2016-05-13'),
+    statement_of_capital: {
+      capital: [{
+        total_amount_unpaid: 50.to_s,
+        total_number_of_issued_shares: 200.to_s,
+        share_currency: 'GBP',
+        total_aggregate_nominal_value: 224.6912.to_s,
+        shares: [
+          { share_class: 'Ordinary A', prescribed_particulars: 'A Particulars', num_shares: 100.to_s, aggregate_nominal_value: 112.3456.to_s },
+          { share_class: 'Ordinary B', prescribed_particulars: 'B Particulars', num_shares: 100.to_s, aggregate_nominal_value: 112.3456.to_s }
+        ]
+      }]
+    },
+    allotment: [
+      {
+        share_class: 'Ordinary A',
+        num_shares: 100.to_s,
+        amount_paid_due_per_share: 6.to_s,
+        amount_unpaid_per_share: 4.to_s,
+        share_currency: 'GBP',
+        share_value: 1.123456.to_s,
+        consideration: 'Text for A Consideration'
+      },
+      { share_class: 'Ordinary B',
+        num_shares: 100.to_s,
+        amount_paid_due_per_share: 6.to_s,
+        amount_unpaid_per_share: 4.to_s,
+        share_currency: 'GBP',
+        share_value: 1.123456.to_s,
+        consideration: 'Text for B Consideration' }
+    ]
+  }
+}
+
+confirmation_statement = {
+  submission_data: {
+    date_signed: Date.parse('2015-07-01'),
+    company_number: '11111111',
+    company_name: 'EXAMPLE COMPANY',
+    company_authentication_code: '123456',
+    package_reference: '0012',
+    submission_number: '100070'
+  },
+  request_data: {
+    trading_on_market: true,
+    dtr_5_applies: false,
+    psc_exempt_as_trading_on_regulated_market: false,
+    psc_exempt_as_shares_admitted_on_market: false,
+    psc_exempt_as_trading_on_uk_regulated_market: false,
+    review_date: Time.now.to_date,
+    sic_codes: { sic_code: %w[10410 01130] },
+    statement_of_capital: {
+      capital: [{
+        total_amount_unpaid: 50.to_d,
+        total_number_of_issued_shares: 100.to_d,
+        share_currency: 'GBP',
+        total_aggregate_nominal_value: 112.3456.to_d,
+        shares: [{
+          share_class: 'Ordinary A',
+          prescribed_particulars: 'A Particulars',
+          num_shares: 200.to_d,
+          aggregate_nominal_value: 112.3456.to_d
+        }]
+      }]
+    },
+    shareholdings: [
+      {
+        share_class: 'Ordinary A',
+        number_held: 100.to_d,
+        transfers: [
+          { date_of_transfer: Time.now.to_date, number_shares_transferred: 1000.to_d }
+        ],
+        shareholders: [
+          {
+            name: { surname: 'Master', forename: 'Ruby' },
+            address: {
+              premise: 'AddressLine 1',
+              street: 'AddressLine2',
+              thoroughfare: 'AddressLine3',
+              post_town: 'PostCode12345',
+              county: 'Address County',
+              country: 'POL'
+            }
+          }
+        ]
+
+      },
+      {
+        share_class: 'Ordinary A',
+        number_held: 100.to_d,
+        transfers: [
+          { date_of_transfer: Time.now.to_date, number_shares_transferred: 1000.to_d }
+        ],
+        shareholders: [
+          {
+            name: { amalgamated_name: 'Mater Go Lang' },
+            address: {
+              premise: 'AddressLine 1',
+              street: 'AddressLine2',
+              thoroughfare: 'AddressLine3',
+              post_town: 'PostCode12345',
+              county: 'Address County',
+              country: 'POL'
+            }
+          }
+        ]
+      }
+    ],
+    state_confirmation: true
+  }
+}
+
+get_submission_status = {
+  request_data: {
+    # company_number: "11111111", # we can request either by company number or by particular  submission number
+    submission_number: '100086',
+    presenter_id: '74d3658da6d7cecf1cfdb1b413c661f2'
+  }
+}
+
+company_data_request = {
+  request_data: {
+    company_number: '11111111',
+    company_authentication_code: '100031',
+    made_up_date: Date.parse('2016-05-13')
+  }
+}
+
+REQUEST_DATA = {
+  returnof_allotment_shares: returnof_allotment_shares,
+  confirmation_statement: confirmation_statement,
+  get_submission_status: get_submission_status,
+  company_data_request: company_data_request
+}.freeze

data/spec/fixtures/bad_response.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<GovTalkMessage xsi:schemaLocation="http://www.govtalk.gov.uk/CM/envelope http://xmlgw.companieshouse.gov.uk/v1-1/schema/Egov_ch-v2-0.xsd" xmlns="http://www.govtalk.gov.uk/CM/envelope" xmlns:dsig="http://www.w3.org/2000/09/xmldsig#" xmlns:gt="http://www.govtalk.gov.uk/schemas/govtalk/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
+  <EnvelopeVersion>1.0</EnvelopeVersion>
+  <Header>
+    <MessageDetails>
+      <Class>Document</Class>
+      <Qualifier>error</Qualifier>
+      <TransactionID>139335771961</TransactionID>
+      <GatewayTimestamp>2014-02-25T19:48:40-00:00</GatewayTimestamp>
+    </MessageDetails>
+    <SenderDetails>
+      <IDAuthentication>
+        <SenderID>XMLGatewayTestUserID</SenderID>
+        <Authentication>
+          <Method>CHMD5</Method>
+          <Value>760b2d181e070027c70761eaf1e93f05</Value>
+        </Authentication>
+      </IDAuthentication>
+    </SenderDetails>
+  </Header>
+  <GovTalkDetails>
+    <Keys/>
+  <GovTalkErrors>
+    <Error>
+      <RaisedBy>Document</RaisedBy>
+      <Number>604</Number>
+      <Type>fatal</Type>
+      <Text>Error text</Text>
+      <Location></Location>
+    </Error>
+  </GovTalkErrors>
+  </GovTalkDetails>
+  <Body>
+  </Body>
+</GovTalkMessage>