Module: Jerbil

Defined in:
lib/jerbil.rb,
lib/jerbil/config.rb,
lib/jerbil/errors.rb,
lib/jerbil/monitor.rb,
lib/jerbil/servers.rb,
lib/jerbil/service.rb,
lib/jerbil/support.rb,
lib/jerbil/version.rb

Overview

Created by Jevoom

26-Oct-2014

Tweaked Rubydoc.info address to get to the right readme page.

Defined Under Namespace

Modules: Support Classes: Broker, Config, InvalidPrivateKey, InvalidServerKey, InvalidService, InvalidServiceKey, JerbilAuthenticationError, JerbilConfigError, JerbilError, JerbilServerError, JerbilServiceError, MissingJerbilService, MissingServer, Monitor, ServerConnectError, Servers, ServiceAlreadyRegistered, ServiceCallbackMissing, ServiceConfigError, ServiceConnectError, ServiceNotFound, ServiceNotLocal, ServiceRecord, UnauthorizedMethod

Constant Summary collapse

Version =

version set to 1.4.8

'1.4.8'
Version_Date =

date set to 26-Oct-2014

'26-Oct-2014'
Ident =

ident string set to: jerbil-1.4.8 26-Oct-2014

'jerbil-1.4.8 26-Oct-2014'

Class Method Summary collapse

Class Method Details

.get_config(config_file = nil) ⇒ Hash

Note:

This method is used to get the environment for the Jerbil Server and therefore find the server.

get the Jerbil config options

This will create a hash of the Jerbil Server config options from either the given config file or, if none is provided, the default file. The location of the default file is currently defined by the Jeckyl gem as the default location for all Jeckyl config files.

Parameters:

  • config_file (String) (defaults to: nil) —

    path to jerbil config file

Returns:

  • (Hash) —

    of config options

Raises:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/jerbil/support.rb', line 144

def Jerbil.get_config(config_file=nil)
   # check that the config_file has been specified
  if config_file.nil? then
    # no, so set the default
    config_file = File.join(Jeckyl.config_dir, "/jerbil.rb")
  end

  # read the config file
  return Jerbil::Config.new(config_file)

rescue Jeckyl::JeckylError =>err
  # something went wrong with the config file
  raise Jerbil::JerbilConfigError, err.message
end