Module: CompaniesHouseInputGateway

Defined in:
lib/base.rb,
lib/companies_house_input_gateway.rb,
lib/companies_house_input_gateway/util.rb,
lib/companies_house_input_gateway/client.rb,
lib/companies_house_input_gateway/config.rb,
lib/companies_house_input_gateway/request.rb,
lib/companies_house_input_gateway/version.rb,
lib/companies_house_input_gateway/constants.rb,
lib/companies_house_input_gateway/form_validator.rb,
lib/companies_house_input_gateway/errors/api_error.rb,
lib/companies_house_input_gateway/xml_forms_binder.rb,
lib/companies_house_input_gateway/forms/form_submission.rb,
lib/companies_house_input_gateway/middleware/check_response.rb,
lib/companies_house_input_gateway/forms/form_abstract_builder.rb,
lib/companies_house_input_gateway/requests/abstract_performer.rb,
lib/companies_house_input_gateway/validations/form_submission.rb,
lib/companies_house_input_gateway/errors/invalid_request_error.rb,
lib/companies_house_input_gateway/errors/invalid_response_error.rb,
lib/companies_house_input_gateway/requests/company_data_request.rb,
lib/companies_house_input_gateway/requests/get_submission_status.rb,
lib/companies_house_input_gateway/forms/form_company_data_request.rb,
lib/companies_house_input_gateway/requests/confirmation_statement.rb,
lib/companies_house_input_gateway/forms/form_get_submission_status.rb,
lib/companies_house_input_gateway/validations/company_data_request.rb,
lib/companies_house_input_gateway/forms/form_confirmation_statement.rb,
lib/companies_house_input_gateway/validations/get_submission_status.rb,
lib/companies_house_input_gateway/requests/returnof_allotment_shares.rb,
lib/companies_house_input_gateway/validations/confirmation_statement.rb,
lib/companies_house_input_gateway/errors/companies_house_gateway_error.rb,
lib/companies_house_input_gateway/forms/form_returnof_allotment_shares.rb,
lib/companies_house_input_gateway/validations/returnof_allotment_shares.rb

Defined Under Namespace

Modules: Constants, Forms, Middleware, Requests, Util, Validations Classes: APIError, Base, Client, CompaniesHouseGatewayError, Config, FormValidator, InvalidRequestError, InvalidResponseError, Request, XmlFormsBinder

Constant Summary collapse

VERSION = 
'0.0.6'

Class Method Summary collapse

Class Method Details

.config ⇒ Object

Require configuration before use



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/companies_house_input_gateway.rb', line 60

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

.configure(&block) ⇒ Object 



43
44
45
 
# File 'lib/companies_house_input_gateway.rb', line 43

def self.configure(&block)
  @config = Config.new(&block)
end

.perform_check(*args) ⇒ Object 



47
48
49
 
# File 'lib/companies_house_input_gateway.rb', line 47

def self.perform_check(*args)
  client.perform_check(*args)
end