Module: CompaniesHouseGateway

Defined in:
lib/companies_house_gateway.rb,
lib/companies_house_gateway/util.rb,
lib/companies_house_gateway/client.rb,
lib/companies_house_gateway/config.rb,
lib/companies_house_gateway/request.rb,
lib/companies_house_gateway/version.rb,
lib/companies_house_gateway/constants.rb,
lib/companies_house_gateway/validations.rb,
lib/companies_house_gateway/checks/check.rb,
lib/companies_house_gateway/checks/document.rb,
lib/companies_house_gateway/checks/mortgages.rb,
lib/companies_house_gateway/errors/api_error.rb,
lib/companies_house_gateway/checks/name_search.rb,
lib/companies_house_gateway/checks/document_info.rb,
lib/companies_house_gateway/checks/number_search.rb,
lib/companies_house_gateway/checks/filing_history.rb,
lib/companies_house_gateway/checks/officer_search.rb,
lib/companies_house_gateway/checks/company_details.rb,
lib/companies_house_gateway/checks/officer_details.rb,
lib/companies_house_gateway/middleware/check_response.rb,
lib/companies_house_gateway/checks/company_appointments.rb,
lib/companies_house_gateway/errors/invalid_request_error.rb,
lib/companies_house_gateway/errors/invalid_response_error.rb,
lib/companies_house_gateway/errors/companies_house_gateway_error.rb

Defined Under Namespace

Modules: Checks, Constants, Middleware, Util, Validations Classes: APIError, Client, CompaniesHouseGatewayError, Config, InvalidRequestError, InvalidResponseError, Request

Constant Summary collapse

VERSION = 
'0.4.1'.freeze

Class Method Summary collapse

Class Method Details

.config ⇒ Object

Require configuration before use



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/companies_house_gateway.rb', line 48

def self.config
  if @config
    @config
  else
    msg = "No config found. Use CompaniesHouseGateway.configure to set "
          "username and password. See " +
          "https://github.com/gocardless/companies-house-gateway " +
          "for details."
    raise CompaniesHouseGatewayError.new(msg)
  end
end

.configure(&block) ⇒ Object 



31
32
33
 
# File 'lib/companies_house_gateway.rb', line 31

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

.perform_check(*args) ⇒ Object 



35
36
37
 
# File 'lib/companies_house_gateway.rb', line 35

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