postdb 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7eb8c10674d608a4ebe84dc2c0a3c324235d4550
+  data.tar.gz: a932e7b6771517dfb39e57960ad49ec74fbfa93b
+SHA512:
+  metadata.gz: 075eb7656fc26bef5b300e9beea11b1964fa91412c900959ab12224a82592de199e272bdf9f2e685e44ad7f1b468e2bcd7e7c2b8de02fae0cb210b43e838faa1
+  data.tar.gz: 97aae2ed0cef5e610e489ee38fb1bd754ec202f4686f54155958d54d14cc483195849bcab0c3141219d37a72307750792625885a748716f158c524dcd85c0838

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :sqlite do
+  gem 'dm-sqlite-adapter', '~> 1.2'
+end
+
+group :mysql do
+  gem 'dm-mysql-adapter', '~> 1.2'
+end
+
+group :postgres do
+  gem 'dm-postgres-adapter', '~> 1.2'
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'postdb'
+
+require 'irb'
+
+IRB.start

data/bin/postdb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'postdb/cli'
+
+PostDB::CLI::Main.start(ARGV)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/db/migrate/20160508215354_create_domains.rb

@@ -0,0 +1,10 @@
+class CreateDomains < ActiveRecord::Migration
+  def change
+    create_table :virtual_domains do |t|
+      t.string :name, null: false
+      t.binary :dkim, null: false
+
+      t.timestamps(null: false)
+    end
+  end
+end

data/db/migrate/20160508215355_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :virtual_users do |t|
+      t.integer :domain_id,        null: false
+      t.string  :email,            null: false
+      t.string  :crypted_password, null: false
+
+      t.timestamps(null: false)
+    end
+  end
+end

data/db/migrate/20160508215356_create_aliases.rb

@@ -0,0 +1,12 @@
+class CreateAliases < ActiveRecord::Migration
+  def change
+    create_table :virtual_aliases do |t|
+      t.integer :domain_id,   null: false
+      t.integer :user_id,     null: true
+      t.string  :source,      null: false
+      t.string  :destination, null: false
+
+      t.timestamps(null: false)
+    end
+  end
+end

data/lib/postdb.rb

@@ -0,0 +1,55 @@
+# The PostDB main module
+#
+module PostDB
+  class << self
+    # Require dependencies
+    #
+    # Example:
+    #   >> PostDB.require!
+    #   => nil
+    #
+    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 the gem
+    #
+    # Arguments:
+    #   path: (String) The path to the configuration file
+    #
+    # Example:
+    #   >> PostDB.setup(path)
+    #   => true
+    #
+    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
+  end
+end
+
+# Require dependencies
+#
+PostDB.require!

data/lib/postdb/alias.rb

@@ -0,0 +1,24 @@
+module PostDB
+  class Alias < ActiveRecord::Base
+    self.table_name = 'virtual_aliases'
+
+    belongs_to :domain
+    belongs_to :user
+
+    validates :source,      presence: true
+    validates :destination, presence: true
+
+    validate do |aliaz|
+      alias_count = self.class.where(
+        source: aliaz.source,
+        destination: aliaz.destination
+      ).where.not(
+        id: aliaz.id
+      ).count
+
+      next unless alias_count > 0
+
+      errors.add(:source_and_destination, "must be unique")
+    end
+  end
+end

data/lib/postdb/cli.rb

@@ -0,0 +1,54 @@
+# The PostDB main module
+#
+module PostDB
+  # The CLI module
+  #
+  module CLI
+    class << self
+      # Require dependencies
+      #
+      # Example:
+      #   >> PostDB.require!
+      #   => nil
+      #
+      def require!
+        require 'yaml'
+        require 'thor'
+        require 'tty-prompt'
+        require 'tty-table'
+        require 'postdb'
+
+        require 'postdb/cli/helper'
+        require 'postdb/cli/database'
+        require 'postdb/cli/domains/dkim'
+        require 'postdb/cli/domains'
+        require 'postdb/cli/users'
+        require 'postdb/cli/aliases'
+        require 'postdb/cli/main'
+      end
+
+      # Ensure superuser
+      #
+      # Example:
+      #   >> PostDB::CLI.ensure_superuser!
+      #   => nil
+      #
+      def ensure_superuser!
+        return nil if 0 == Process.uid
+
+        prompt = TTY::Prompt.new
+        prompt.error("PostDB requires superuser privileges to run!")
+
+        exit 1
+      end
+    end
+  end
+end
+
+# Require dependencies
+#
+PostDB::CLI.require!
+
+# Ensure superuser privileges
+#
+PostDB::CLI.ensure_superuser!

data/lib/postdb/cli/aliases.rb

@@ -0,0 +1,123 @@
+module PostDB
+  module CLI
+    class Aliases < Thor
+      SOURCE_REGEX = /^([A-Za-z0-9\-\_\.\+]+)?@[A-Za-z0-9\-]+\.[A-Za-z0-9\-\.]+$/
+
+      no_tasks do
+        include PostDB::CLI::Helper
+      end
+
+      desc "list DOMAIN", "List all aliases"
+      def list(domain = nil)
+        domains = PostDB::Domain.where(**(domain ? { name: domain } : {}))
+
+        if domains.empty?
+          if domain
+            exit_with_warning("The domain '#{domain}' could not be found.")
+          else
+            exit_with_warning("There don't appear to be any domains on this system.")
+          end
+        end
+
+        domains = domains.to_a
+        domains.sort! { |a, b| a.name <=> b.name }
+
+        domains.each_with_index do |domain, index|
+          aliases = domain.forwarding_aliases.sort { |a, b| a.source <=> b.source }
+
+          if aliases.empty?
+            puts TTY::Table.new(
+              header: [domain.name].pad(' '),
+              rows: [['No Aliases'].pad(' ')]
+            ).render(:ascii)
+          else
+            puts TTY::Table.new(
+              header: [" " + domain.name + " \n Source: ", "\n Destination: "],
+              rows: aliases.map { |a| [a.source, a.destination].pad(' ') }
+            ).render(:ascii, multiline: true)
+          end
+
+          new_line unless (index + 1) == domains.count
+        end
+      end
+
+      desc "add SOURCE DESTINATION", "Add an alias"
+      def add(source = nil, destination = nil)
+        unless source
+          source = prompt.ask("Source:") do |q|
+            q.required(true)
+            q.validate(SOURCE_REGEX)
+          end
+        end
+
+        unless destination
+          destination = prompt.ask("Destination:") do |q|
+            q.required(true)
+            q.validate(:email)
+          end
+        end
+
+        source = source.downcase
+        destination = destination.downcase
+
+        if source == destination
+          exit_with_error("The alias '#{source} -> #{destination}' is managed automatically by PostDB.")
+        end
+
+        if PostDB::Alias.where(source: source, destination: destination).count > 0
+          exit_with_warning("The alias '#{source} -> #{destination}' has already been added.")
+        end
+
+        domain_name = source.split('@')[1]
+
+        unless domain = PostDB::Domain.where(name: domain_name).first
+          exit_with_error("The domain '#{domain_name}' is not available.")
+        end
+
+        PostDB::Alias.create(domain: domain, source: source, destination: destination)
+
+        prompt.ok("The alias '#{source} -> #{destination}' has been added.")
+      end
+
+      desc "remove SOURCE DESTINATION", "Remove an alias"
+      option :force, type: :boolean, default: false
+      def remove(source = nil, destination = nil)
+        unless source && destination
+          aliases = PostDB::Alias.all.select { |a| a.source != a.destination }
+
+          if aliases.empty?
+            exit_with_warning("There don't appear to be any aliases on this system.")
+          end
+
+          a = prompt.select("Alias:", aliases.map { |a| ["#{a.source} -> #{a.destination}", a] }.to_h)
+
+          source = a.source
+          destination = a.destination
+        end
+
+        source = source.downcase
+        destination = destination.downcase
+
+        if source == destination
+          exit_with_error("The alias '#{source} -> #{destination}' is managed automatically by PostDB.")
+        end
+
+        aliases = PostDB::Alias.where(source: source, destination: destination)
+
+        if aliases.empty?
+          exit_with_warning("The alias '#{source} -> #{destination}' could not be found.")
+        end
+
+        unless options[:force]
+          confirm_action!("Remove the alias '#{source} -> #{destination}'?", "'#{source} -> #{destination}' left untouched.")
+        end
+
+        aliases.each(&:destroy)
+
+        prompt.ok("The alias '#{source} -> #{destination}' has been removed.")
+      end
+
+      default_task :list
+    end
+  end
+end

data/lib/postdb/cli/database.rb

@@ -0,0 +1,39 @@
+module PostDB
+  module CLI
+    class Database < Thor
+      no_tasks do
+        include PostDB::CLI::Helper
+
+        # Get the ActiveRecord::Base connection
+        #
+        # Example:
+        #   >> connection
+        #   => ?
+        #
+        def connection
+          ActiveRecord::Base.connection
+        end
+
+        # Get the database configuration
+        #
+        # Example:
+        #   >> configuration
+        #   => { adapter: "mysql", host: "127.0.0.1", username: "mail", password: "...", database: "mail" }
+        #
+        def configuration
+          PostDB::Configuration[:database]
+        end
+      end
+
+      desc "migrate VERSION", "Migrate the database"
+      def migrate(version = nil)
+        # Get the path to the migrations directory
+        migrations = File.join('..', '..', '..', '..', 'db', 'migrate')
+        migrations = File.expand_path(migrations, __FILE__)
+
+        # Run the migrations
+        ActiveRecord::Migrator.migrate(migrations, version)
+      end
+    end
+  end
+end

data/lib/postdb/cli/domains.rb

@@ -0,0 +1,89 @@
+module PostDB
+  module CLI
+    class Domains < Thor
+      no_tasks do
+        include PostDB::CLI::Helper
+      end
+
+      desc "list", "List all domains"
+      def list
+        domains = PostDB::Domain.all
+
+        if domains.empty?
+          exit_with_warning("There don't appear to be any domains on this system.")
+        end
+
+        domains = domains.to_a
+        domains.sort! { |a, b| a.name <=> b.name }
+
+        puts TTY::Table.new(
+          header: ["Domain Name", "Total Users", "Total Aliases"].pad(' '),
+          rows: domains.map { |d| [d.name, d.users.count, d.forwarding_aliases.count].pad(' ') }
+        ).render(:ascii, multiline: true)
+      end
+
+      desc "add DOMAIN", "Add a domain"
+      def add(domain_name = nil)
+        unless domain_name
+          domain_name = prompt.ask("Domain:") do |q|
+            q.required(true)
+          end
+        end
+
+        domain_name = domain_name.downcase
+
+        if PostDB::Domain.where(name: domain_name).count > 0
+          exit_with_warning("The domain '#{domain_name}' has already been added.")
+        end
+
+        domain = PostDB::Domain.new
+        domain.name = domain_name
+
+        if domain.save
+          prompt.ok("The domain '#{domain_name}' has been added.")
+        else
+          errors = domain.errors.full_messages.map { |m| " #{m}" }
+          exit_with_error("The domain '#{domain_name}' couldn't be added:", *errors)
+        end
+      end
+
+      desc "remove DOMAIN", "Remove a domain"
+      option :force, type: :boolean, default: false
+      def remove(domain_name = nil)
+        unless domain_name
+          domains = PostDB::Domain.all
+
+          if domains.empty?
+            exit_with_warning("There don't appear to be any domains on this system.")
+          end
+
+          domains = domains.to_a
+          domains.sort! { |a, b| a.name <=> b.name }
+
+          domain_name = prompt.select("Domain:", domains.map(&:name))
+        end
+
+        domain_name = domain_name.downcase
+
+        domains = PostDB::Domain.where(name: domain_name)
+
+        if domains.empty?
+          exit_with_warning("The domain '#{domain_name}' could not be found.")
+        end
+
+        unless options[:force]
+          confirm_action!("Remove the domain '#{domain_name}'?", "'#{domain_name}' left untouched.")
+        end
+
+        domains.each(&:destroy)
+
+        prompt.ok("The domain '#{domain_name}' has been removed.")
+      end
+
+      desc "dkim SUBCOMMAND ...ARGS", "Manage DKIM keys"
+      subcommand "dkim", PostDB::CLI::Domains::DKIM
+
+      default_task :list
+    end
+  end
+end