postdb 0.1.5

data/lib/postdb/domain.rb

@@ -0,0 +1,62 @@
+module PostDB
+  class Domain < ActiveRecord::Base
+    self.table_name = 'virtual_domains'
+
+    serialize :dkim, OpenSSL::PKey::RSA
+
+    has_many :users,   dependent: :destroy
+    has_many :aliases, dependent: :destroy
+
+    validates :name, presence: true, uniqueness: true
+    validates :dkim, presence: true, uniqueness: true
+
+    before_validation(on: :create) do |domain|
+      domain.regenerate_dkim
+    end
+
+    after_save do
+      PostDB::DKIM.generate_configuration
+    end
+
+    after_destroy do
+      PostDB::DKIM.generate_configuration
+    end
+
+    # Get all forwarding aliases
+    # This excludes aliases where source == destination
+    #
+    # Example:
+    #   >> domain.forwarding_aliases
+    #   => []
+    #
+    def forwarding_aliases
+      # self.aliases.select { |a| a.source != a.destination }
+      self.aliases.where('source != destination')
+    end
+
+    # Get the path to the DKIM key file
+    #
+    # Example:
+    #   >> domain.dkim_path
+    #   => "..."
+    #
+    def dkim_path
+      keys_directory = PostDB::DKIM.keys_directory
+
+      File.join(keys_directory, "#{self.name}.private")
+    end
+
+    # Generate a new DKIM key
+    #
+    # Arguments:
+    #   size: (Integer) (Default: 2048)
+    #
+    # Example:
+    #   >> domain.regenerate_dkim
+    #   => #<OpenSSL::PKey::RSA:0x00000000000000>
+    #
+    def regenerate_dkim(size = 2048)
+      self.dkim = OpenSSL::PKey::RSA.new(size)
+    end
+  end
+end

data/lib/postdb/errors.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.expand_path('../errors/**/*.rb', __FILE__)).each do |matcher|
+  require(matcher)
+end

data/lib/postdb/errors/dkim.rb

@@ -0,0 +1,45 @@
+module PostDB
+  # The DKIMError error is used by the DKIM class
+  #
+  class DKIMError < StandardError
+    # A suberror to describe the error in more detail
+  	#
+  	attr_reader :attribute
+
+    # An array containing additional arguments
+    #
+    attr_reader :arguments
+
+  	# Create a new instance of this exception
+  	#
+  	# Arguments:
+  	#   suberror: (Symbol|String)
+    #   args: (Array)
+  	#
+  	# Example:
+  	#   >> raise PostDB::DKIMError.new
+  	#   => #<PostDB::DKIMError:0x00000000000000>
+  	#
+  	def initialize(suberror = nil, *args)
+  		# Store the suberror property (if provided)
+  		@suberror = suberror if suberror
+
+      # Store the arguments
+      @arguments = args
+  	end
+
+    # Convert the error to a string
+    #
+    # Example:
+    #   >> error.to_s
+    #   => "Error Description"
+    #
+    def to_s
+      case @suberror
+      when nil
+      else
+        super.to_s
+      end
+    end
+  end
+end

data/lib/postdb/errors/mail_location.rb

@@ -0,0 +1,46 @@
+module PostDB
+  # The MailLocationError error is used by the MailLocation class
+  #
+  class MailLocationError < StandardError
+    # A suberror to describe the error in more detail
+  	#
+  	attr_reader :attribute
+
+    # An array containing additional arguments
+    #
+    attr_reader :arguments
+
+  	# Create a new instance of this exception
+  	#
+  	# Arguments:
+  	#   suberror: (Symbol|String)
+    #   args: (Array)
+  	#
+  	# Example:
+  	#   >> raise PostDB::MailLocationError.new
+  	#   => #<PostDB::MailLocationError:0x00000000000000>
+  	#
+  	def initialize(suberror = nil, *args)
+  		# Store the suberror property (if provided)
+  		@suberror = suberror if suberror
+
+      # Store the arguments
+      @arguments = args
+  	end
+
+    # Convert the error to a string
+    #
+    # Example:
+    #   >> error.to_s
+    #   => "Error Description"
+    #
+    def to_s
+      case @suberror
+      when :malformed_location
+        "'#{@arguments[0]}' is not a valid location."
+      else
+        super.to_s
+      end
+    end
+  end
+end

data/lib/postdb/errors/setup.rb

@@ -0,0 +1,62 @@
+module PostDB
+  # The SetupError error is used when a setup error occurs
+  #
+  class SetupError < StandardError
+    # A suberror to describe the error in more detail
+  	#
+  	attr_reader :attribute
+
+    # An array containing additional arguments
+    #
+    attr_reader :arguments
+
+  	# Create a new instance of this exception
+  	#
+  	# Arguments:
+  	#   suberror: (Symbol|String)
+    #   args: (Array)
+  	#
+  	# Example:
+  	#   >> raise PostDB::SetupError.new
+  	#   => #<PostDB::SetupError:0x00000000000000>
+  	#
+  	def initialize(suberror = nil, *args)
+  		# Store the suberror property (if provided)
+  		@suberror = suberror if suberror
+
+      # Store the arguments
+      @arguments = args
+  	end
+
+    # Convert the error to a string
+    #
+    # Example:
+    #   >> error.to_s
+    #   => "Error Description"
+    #
+    def to_s
+      case @suberror
+      when :invalid_adapter
+        "The adapter '#{@arguments[0]}' is not valid."
+      when :missing_database_args
+        "You must provide the database configuration."
+      when :missing_mail_args
+        "You must provide the mail configuration."
+      when :missing_dkim_args
+        "You must provide the DKIM configuration."
+      when :missing_mail_location
+        "You must provide the mail location string."
+      when :missing_dkim_directory
+        "You must provide the path to the DKIM keys directory."
+      when :missing_trusted_hosts_path
+        "You must provide the path to the DKIM TrustedHosts file."
+      when :missing_key_table_path
+        "You must provide the path to the DKIM KeyTable file."
+      when :missing_signing_table_path
+        "You must provide the path to the DKIM SigningTable file."
+      else
+        super.to_s
+      end
+    end
+  end
+end

data/lib/postdb/helpers.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.expand_path('../helpers/**/*.rb', __FILE__)).each do |matcher|
+  require(matcher)
+end

data/lib/postdb/helpers/array.rb

@@ -0,0 +1,15 @@
+class Array
+  # Add padding to each element in the array
+  #
+  # Arguments:
+  #   padding: (String) The padding to apply before and after the element
+  #
+  # Example:
+  #   >> array = [ "Name" ]
+  #   >> array.pad(" ")
+  #   => [ " Name " ]
+  #
+  def pad(padding)
+    map { |element| "#{padding}#{element}#{padding}" }
+  end
+end

data/lib/postdb/helpers/inflections.rb

@@ -0,0 +1,3 @@
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym 'DKIM'
+end

data/lib/postdb/helpers/openssl/pkey/rsa.rb

@@ -0,0 +1,55 @@
+module OpenSSL
+  module PKey
+    class RSA
+      class << self
+        # Dump the object
+        #
+        # Arguments:
+        #   object: (OpenSSL::PKey::RSA)
+        #
+        # Example:
+        #   >> OpenSSL::PKey::RSA.dump(rsa)
+        #   => "..."
+        #
+        def dump(object)
+          unless object.is_a?(self)
+            raise ActiveRecord::SerializationTypeMismatch, "Expected '#{self}' got '#{object.class}'."
+          end
+
+          object.to_der
+        end
+
+        # Load the object
+        #
+        # Arguments:
+        #   object: (String)
+        #
+        # Example:
+        #   >> OpenSSL::PKey::RSA.load(object)
+        #   => #<OpenSSL::PKey::RSA:0x00000000000000>
+        #
+        def load(object)
+          return nil unless object
+
+          new(object)
+        end
+      end
+
+      # Check if the RSA key is valid
+      #
+      # Example:
+      #   >> key.valid?
+      #   => true
+      #
+      def valid?
+        begin
+          self.class.new(self.to_der)
+        rescue OpenSSL::PKey::RSAError => e
+          return false
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/postdb/helpers/string.rb

@@ -0,0 +1,22 @@
+class String
+  # Check if the string is a crypt
+  #
+  # Arguments:
+  #   crypt: (Symbol)
+  #
+  # Example:
+  #   >> crypt = "$6$AzeWWlznoLKPRJ1m$MeWkZqWKJp1XD.Jnt66D.Riubq7HT9vrRV0AwFXov2rxyzONR50ULiUFj7Kl6ykmh4EXsmpox8QUr6EUIo3NB0"
+  #   >> crypt.is_crypt?(:sha512)
+  #   => true
+  #
+  def is_crypt?(crypt)
+    case crypt
+    when :sha512
+      return false unless self =~ /^(\$6\$[a-zA-Z0-9]{16}\$[a-zA-Z0-9\.\/\\]{86})$/
+
+      true
+    else
+      false
+    end
+  end
+end

data/lib/postdb/mail.rb

@@ -0,0 +1,31 @@
+module PostDB
+  class Mail
+    class << self
+      # The template path to the mail location
+      #
+      attr_reader :mail_location
+
+      # Setup the mail configuration
+      #
+      # Example:
+      #   >> PostDB::Mail.setup_with_configuration!
+      #   => nil
+      #
+      def setup_with_configuration!
+        configuration = PostDB::Configuration[:mail]
+
+        unless configuration.is_a?(Hash)
+          raise PostDB::SetupError.new(:missing_mail_args)
+        end
+
+        unless configuration[:location]
+          raise PostDB::SetupError.new(:missing_mail_location)
+        end
+
+        @mail_location = PostDB::MailLocation.new(configuration[:location])
+
+        nil
+      end
+    end
+  end
+end

data/lib/postdb/mail_location.rb

@@ -0,0 +1,33 @@
+module PostDB
+  class MailLocation
+    attr_reader :type
+    attr_reader :path
+    attr_reader :components
+
+    def initialize(location)
+      unless location =~ /^[A-Za-z0-9]+:(.*)$/
+        raise PostDB::MailLocationError.new(:malformed_location)
+      end
+
+      components = location.split(':')
+
+      @type = components[0].to_sym
+      @path = components[1]
+
+      begin
+        @components = Hash[*components[2..-1].map { |c| c.split('=') }.flatten]
+      rescue => e
+        raise PostDB::MailLocationError.new(:malformed_location)
+      end
+    end
+
+    def get_path(username, domain, home_dir = nil)
+      path = @path.dup
+      path.gsub!('%u', username)
+      path.gsub!('%n', username.split('@')[0])
+      path.gsub!('%d', domain)
+      path.gsub!('%h', home_dir) if home_dir
+      path
+    end
+  end
+end

data/lib/postdb/user.rb

@@ -0,0 +1,42 @@
+module PostDB
+  class User < ActiveRecord::Base
+    self.table_name = 'virtual_users'
+
+    has_password :sha512
+
+    has_one :alias, dependent: :destroy
+
+    belongs_to :domain
+
+    validates :email,            presence: true, uniqueness: true
+    validates :crypted_password, presence: true
+
+    before_save do |user|
+      user.alias ||= PostDB::Alias.create(
+        domain: user.domain,
+        source: user.email,
+        destination: user.email
+      )
+    end
+
+    after_destroy do |user|
+      user.delete_account_data
+    end
+
+    def delete_account_data
+      mail_location = PostDB::Mail.mail_location
+
+      path = mail_location.get_path(self.email, self.domain.name)
+
+      return false unless File.exist?(path)
+
+      begin
+        FileUtils.rm_rf(path)
+      rescue => e
+        return false
+      end
+
+      true
+    end
+  end
+end

data/postdb.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postdb/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postdb'
+  spec.version       = PostDB::VERSION
+  spec.authors       = ['Rediweb Hosting']
+  spec.email         = ['support@rediwebhosting.uk']
+
+  spec.summary       = %q{Postfix Database Management}
+  spec.description   = %q{An easy to use library for managing your postfix database.}
+  spec.homepage      = 'https://rubygems.org/gems/postdb'
+  spec.license       = 'GPL-3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/(?!((console|setup)$))}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord',  '~> 4.2'
+  spec.add_dependency 'attr_password', '~> 0.1'
+  spec.add_dependency 'thor',          '~> 0.19.1'
+  spec.add_dependency 'tty-prompt',    '~> 0.3'
+  spec.add_dependency 'tty-table',     '~> 0.4'
+
+  spec.add_dependency 'mysql',         '~> 2.9'
+  spec.add_dependency 'mysql2',        '~> 0.4'
+  spec.add_dependency 'postgresql',    '~> 1.0'
+  spec.add_dependency 'sqlite3',       '~> 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+end