Module: PostDB

Defined in:
lib/postdb.rb,
lib/postdb/cli.rb,
lib/postdb/dkim.rb,
lib/postdb/mail.rb,
lib/postdb/user.rb,
lib/postdb/alias.rb,
lib/postdb/domain.rb,
lib/postdb/cli/main.rb,
lib/postdb/database.rb,
lib/postdb/cli/users.rb,
lib/postdb/constants.rb,
lib/postdb/cli/helper.rb,
lib/postdb/cli/aliases.rb,
lib/postdb/cli/domains.rb,
lib/postdb/errors/dkim.rb,
lib/postdb/cli/database.rb,
lib/postdb/errors/setup.rb,
lib/postdb/configuration.rb,
lib/postdb/mail_location.rb,
lib/postdb/cli/domains/dkim.rb,
lib/postdb/errors/mail_location.rb

Overview

The PostDB main module

Defined Under Namespace

Modules: CLI Classes: Alias, Configuration, DKIM, DKIMError, Database, Domain, Mail, MailLocation, MailLocationError, SetupError, User

Constant Summary collapse

VERSION = 
'0.1.5'

Class Method Summary collapse

Class Method Details

.require! ⇒ Object

Require dependencies

Example:

>> PostDB.require!
=> nil



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/postdb.rb', line 11

def require!
  require 'cgi'
  require 'openssl'
  require 'fileutils'
  require 'active_support'
  require 'active_record'
  require 'attr_password'

  require 'postdb/constants'
  require 'postdb/errors'
  require 'postdb/helpers'
  require 'postdb/configuration'
  require 'postdb/database'
  require 'postdb/mail_location'
  require 'postdb/mail'
  require 'postdb/dkim'
  require 'postdb/domain'
  require 'postdb/user'
  require 'postdb/alias'
end

.setup(path) ⇒ Object

Setup the gem

Arguments:

path: (String) The path to the configuration file

Example:

>> PostDB.setup(path)
=> true



41
42
43
44
45
46
47
48
49
 
# File 'lib/postdb.rb', line 41

def setup(path)
  PostDB::Configuration.load_file(path)

  PostDB::Database.setup_with_configuration!
  PostDB::Mail.setup_with_configuration!
  PostDB::DKIM.setup_with_configuration!

  true
end