postfix_admin 0.2.1 → 0.3.1

data/lib/postfix_admin/runner.rb

@@ -24,36 +24,86 @@ module PostfixAdmin
       runner { puts PostfixAdmin::Doveadm.schemes.join(' ') }
     end
 
-    desc "show [example.com | admin@example.com | user@example.com]", "Show domains or admins or mailboxes"
+    desc "show [example.com | admin@example.com | user@example.com]",
+         "Display details about domains, admins, or accounts"
     def show(name = nil)
       runner { @cli.show(name) }
     end
 
-    desc "setup example.com password", "Setup a domain"
+    desc "admins", "List all admin users"
+    def admins
+      runner { @cli.show_admins }
+    end
+
+    desc "domains", "List all domains"
+    def domains
+      runner { @cli.show_domains }
+    end
+
+    desc "accounts", "List all accounts"
+    def accounts
+      runner { @cli.show_accounts }
+    end
+
+    desc "aliases", "List all aliases"
+    def aliases
+      runner { @cli.show_aliases }
+    end
+
+    desc "forwards", "List all forwards"
+    def forwards
+      runner { @cli.show_forwards }
+    end
+
+    desc "setup example.com password", "Set up a domain (add a domain and an admin user for it)"
+    method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
+    method_option :rounds, type: :string, aliases: "-r", desc: "encryption rounds for BLF-CRYPT, SHA256-CRYPT and SHA512-CRYPT schemes"
     def setup(domain_name, password)
-      runner { @cli.setup_domain(domain_name, password) }
+      runner do
+        @cli.setup_domain(domain_name, password,
+                          scheme: options[:scheme], rounds: options[:rounds])
+      end
     end
 
-    desc "admin_passwd admin@example.com new_password", "Change password of admin"
+    desc "teardown example.com", "Tear down a domain (delete a domain and an admin user for it)"
+    def teardown(domain_name)
+      runner { @cli.teardown_domain(domain_name) }
+    end
+
+    desc "admin_passwd admin@example.com new_password",
+         "Change the password of an admin user"
+    method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
+    method_option :rounds, type: :string, aliases: "-r", desc: "encryption rounds for BLF-CRYPT, SHA256-CRYPT and SHA512-CRYPT schemes"
     def admin_passwd(user_name, password)
-      runner { @cli.change_admin_password(user_name, password) }
+      runner do
+        @cli.change_admin_password(user_name, password,
+                                   scheme: options[:scheme], rounds: options[:rounds])
+      end
     end
 
-    desc "account_passwd user@example.com new_password", "Change password of account"
+    desc "account_passwd user@example.com new_password",
+         "Change the password of an account"
+    method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
+    method_option :rounds, type: :string, aliases: "-r", desc: "encryption rounds for BLF-CRYPT, SHA256-CRYPT and SHA512-CRYPT schemes"
     def account_passwd(user_name, password)
-      runner { @cli.change_account_password(user_name, password) }
+      runner do
+        @cli.change_account_password(user_name, password,
+                                     scheme: options[:scheme], rounds: options[:rounds])
+      end
     end
 
-    desc "add_domain example.com", "Add a domain"
+    desc "add_domain example.com", "Add a new domain"
+    method_option :description, type: :string, aliases: "-d", desc: "description"
     def add_domain(domain_name)
-      runner { @cli.add_domain(domain_name) }
+      runner { @cli.add_domain(domain_name, description: options[:description]) }
     end
 
-    desc "edit_domain example.com", "Edit a domain limitation"
+    desc "edit_domain example.com", "Edit a domain"
     method_option :aliases,   type: :numeric, aliases: "-a", desc: "Edit aliases limitation"
     method_option :mailboxes, type: :numeric, aliases: "-m", desc: "Edit mailboxes limitation"
     method_option :maxquota,  type: :numeric, aliases: "-q", desc: "Edit max quota limitation"
     method_option :active, type: :boolean, desc: "Update active status"
+    method_option :description, type: :string, aliases: "-d", desc: "Edit description"
     def edit_domain(domain_name)
       runner do
         if options.size == 0
@@ -70,7 +120,7 @@ module PostfixAdmin
       runner { @cli.delete_domain(domain_name) }
     end
 
-    desc "delete_admin admin@example.com", "Delete an admin"
+    desc "delete_admin admin@example.com", "Delete an admin user"
     def delete_admin(user_name)
       runner { @cli.delete_admin(user_name) }
     end
@@ -80,9 +130,10 @@ module PostfixAdmin
       runner { @cli.delete_account(address) }
     end
 
-    desc "add_account user@example.com password", "Add an account"
-    method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
+    desc "add_account user@example.com password", "Add a new account"
     method_option :name,   type: :string, aliases: "-n", desc: "full name"
+    method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
+    method_option :rounds, type: :string, aliases: "-r", desc: "encryption rounds for BLF-CRYPT, SHA256-CRYPT and SHA512-CRYPT schemes"
     def add_account(address, password)
       runner do
         if options[:scheme] == 'scheme'
@@ -93,17 +144,22 @@ module PostfixAdmin
             warn "Specify name"
             help('add_account')
           else
-            @cli.add_account(address, password, options[:scheme], options[:name])
+            @cli.add_account(address, password, name: options[:name],
+                             scheme: options[:scheme], rounds: options[:rounds])
           end
         end
       end
     end
 
     desc "edit_account user@example.com", "Edit an account"
-    method_option :goto,  type: :string,  aliases: "-g", desc: "mailboxes, addresses e-mails are delivered to"
-    method_option :quota, type: :numeric, aliases: "-q", desc: "quota limitation (MB)"
-    method_option :name,  type: :string,  aliases: "-n", desc: "full name"
-    method_option :active, type: :boolean, desc: "Update active status"
+    method_option :goto,  type: :string,  aliases: "-g",
+                  desc: "mailboxes, addresses e-mails are delivered to"
+    method_option :quota, type: :numeric, aliases: "-q",
+                  desc: "quota limitation (MB)"
+    method_option :name,  type: :string,  aliases: "-n",
+                  desc: "full name"
+    method_option :active, type: :boolean,
+                  desc: "Update active status"
     def edit_account(address)
       runner do
         if options.size == 0
@@ -134,26 +190,31 @@ module PostfixAdmin
       end
     end
 
-    desc "add_admin admin@example.com password", "Add an admin user"
+    desc "add_admin admin@example.com password", "Add a new admin user"
     method_option :super, type: :boolean, aliases: "-S", desc: "register as a super admin"
     method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
+    method_option :rounds, type: :string, aliases: "-r", desc: "encryption rounds for BLF-CRYPT, SHA256-CRYPT and SHA512-CRYPT schemes"
     def add_admin(user_name, password)
       runner do
         if options[:scheme] == 'scheme'
           warn "Specify password scheme"
           help('add_admin')
         else
-          @cli.add_admin(user_name, password, options[:super], options[:scheme])
+          @cli.add_admin(user_name, password,
+                         super_admin: options[:super], scheme: options[:scheme],
+                         rounds: options[:rounds])
         end
       end
     end
 
-    desc "add_admin_domain admin@example.com example.com", "Add admin_domain"
+    desc "add_admin_domain admin@example.com example.com",
+         "Grant an admin user access to a specific domain"
     def add_admin_domain(user_name, domain_name)
       runner { @cli.add_admin_domain(user_name, domain_name) }
     end
 
-    desc "delete_admin_domain admin@example.com example.com", "Delete admin_domain"
+    desc "delete_admin_domain admin@example.com example.com",
+         "Revoke an admin user's access to a specific domain"
     def delete_admin_domain(user_name, domain_name)
       runner { @cli.delete_admin_domain(user_name, domain_name) }
     end
@@ -173,7 +234,7 @@ module PostfixAdmin
       end
     end
 
-    desc "add_alias alias@example.com goto@example.net", "Add an alias"
+    desc "add_alias alias@example.com goto@example.net", "Add a new alias"
     def add_alias(address, goto)
       runner { @cli.add_alias(address, goto) }
     end
@@ -183,9 +244,11 @@ module PostfixAdmin
       runner { @cli.delete_alias(address) }
     end
 
-    desc "log", "Show action logs"
+    desc "log", "Display action logs"
+    method_option :domain, type: :string, aliases: "-d", desc: "Filter by domain"
+    method_option :last,   type: :numeric, aliases: "-l", desc: "Display the last N lines"
     def log
-      runner { @cli.log }
+      runner { @cli.log(domain: options[:domain], last: options[:last]) }
     end
 
     desc "dump", "Dump all data"
@@ -193,7 +256,7 @@ module PostfixAdmin
       runner { @cli.dump }
     end
 
-    desc "version", "Show postfix_admin version"
+    desc "version", "Display the version of postfix_admin"
     def version
       require 'postfix_admin/version'
       runner { say "postfix_admin #{VERSION}" }
@@ -201,9 +264,9 @@ module PostfixAdmin
 
     private
 
-    def runner
+    def runner(&block)
       @cli.db_setup
-      yield
+      block.call
     rescue StandardError => e
       abort "Error: #{e.message}"
     end

data/lib/postfix_admin/version.rb

@@ -1,3 +1,3 @@
 module PostfixAdmin
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/postfix_admin.gemspec

@@ -1,4 +1,4 @@
-require File.expand_path('../lib/postfix_admin/version', __FILE__)
+require File.expand_path("../lib/postfix_admin/version", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "postfix_admin"
@@ -10,19 +10,21 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Command Line Tools for Postfix Admin}
   gem.homepage      = "https://github.com/krhitoshi/postfix_admin"
 
-  gem.required_ruby_version = ">= 2.5.0"
+  gem.required_ruby_version = ">= 2.6.0"
 
-  gem.add_dependency 'thor', '~> 1.0.1'
-  gem.add_dependency 'activerecord', '~> 6.0.3'
-  gem.add_dependency 'mysql2', '>= 0.5.3'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rake', '~> 13.0.1'
-  gem.add_development_dependency 'rubocop'
-  gem.add_development_dependency 'rspec', '~> 3.9.0'
+  gem.add_dependency "thor", "~> 1.3.1"
+  gem.add_dependency "activerecord", "~> 6.1.7"
+  gem.add_dependency "mysql2", "~> 0.5"
+  gem.add_dependency "terminal-table", "~> 3.0.2"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "factory_bot", "~> 6.3.0"
+  gem.add_development_dependency "rake", "~> 13.2.1"
+  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency "rspec", "~> 3.13.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  gem.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  gem.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   gem.bindir        = "exe"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postfix_admin
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Hitoshi Kurokawa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,42 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 6.1.7
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.13.0
 description: Command Line Tools for Postfix Admin
 email:
 - hitoshi@nextseed.jp
@@ -116,7 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -126,11 +154,11 @@ files:
 - Rakefile
 - Thorfile
 - bin/console
+- db/reset.rb
+- db/seeds.rb
 - docker-admin/Dockerfile
 - docker-admin/config.local.php
-- docker-app-2.5/Dockerfile
 - docker-app/Dockerfile
-- docker-app/docker-entrypoint.sh
 - docker-app/my.cnf
 - docker-compose.yml
 - docker-db/postfix.v1841.sql
@@ -138,30 +166,29 @@ files:
 - docker-db/postfix.v740.sql
 - exe/postfix_admin
 - lib/postfix_admin.rb
-- lib/postfix_admin/admin.rb
-- lib/postfix_admin/alias.rb
-- lib/postfix_admin/application_record.rb
 - lib/postfix_admin/base.rb
 - lib/postfix_admin/cli.rb
-- lib/postfix_admin/concerns/.keep
-- lib/postfix_admin/concerns/dovecot_cram_md5_password.rb
-- lib/postfix_admin/concerns/existing_timestamp.rb
-- lib/postfix_admin/domain.rb
-- lib/postfix_admin/domain_admin.rb
 - lib/postfix_admin/doveadm.rb
 - lib/postfix_admin/error.rb
-- lib/postfix_admin/log.rb
-- lib/postfix_admin/mail_domain.rb
-- lib/postfix_admin/mailbox.rb
 - lib/postfix_admin/models.rb
-- lib/postfix_admin/quota.rb
+- lib/postfix_admin/models/admin.rb
+- lib/postfix_admin/models/alias.rb
+- lib/postfix_admin/models/application_record.rb
+- lib/postfix_admin/models/concerns/.keep
+- lib/postfix_admin/models/concerns/existing_timestamp.rb
+- lib/postfix_admin/models/concerns/has_password.rb
+- lib/postfix_admin/models/domain.rb
+- lib/postfix_admin/models/domain_admin.rb
+- lib/postfix_admin/models/log.rb
+- lib/postfix_admin/models/mailbox.rb
+- lib/postfix_admin/models/quota2.rb
 - lib/postfix_admin/runner.rb
 - lib/postfix_admin/version.rb
 - postfix_admin.gemspec
 homepage: https://github.com/krhitoshi/postfix_admin
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,15 +196,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []

data/.github/workflows/ruby.yml

@@ -1,37 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
-      with:
-        ruby-version: 2.6
-    - name: docker-compose up
-      run: docker-compose up -d
-    - name: Run tests for Ruby 2.6
-      run: docker-compose exec -T app /wait-for-it.sh db:3306 -- rake
-    - name: Remove Gemfile.lock
-      run: rm -f Gemfile.lock
-    - name: Run tests for Ruby 2.5.0
-      run: docker-compose exec -T app2.5 rake

data/docker-app/docker-entrypoint.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-set -eu
-
-exec "$@"

data/docker-app-2.5/Dockerfile

@@ -1,15 +0,0 @@
-FROM ruby:2.5.0
-
-RUN apt-get update && \
-    apt-get install -y dovecot-core iproute2 mariadb-client && \
-    rm -rf /var/lib/apt/lists/*
-
-WORKDIR /app
-
-COPY Gemfile postfix_admin.gemspec ./
-COPY ./lib/postfix_admin/version.rb ./lib/postfix_admin/version.rb
-
-RUN gem install bundler && bundle install
-
-COPY spec/postfix_admin.conf /root/.postfix_admin.conf
-COPY docker-app/my.cnf /root/.my.cnf

data/lib/postfix_admin/concerns/dovecot_cram_md5_password.rb

@@ -1,30 +0,0 @@
-require 'active_support/concern'
-
-module DovecotCramMD5Password
-  extend ActiveSupport::Concern
-
-  included do
-    validates :password_unencrypted, length: { minimum: 5 }, allow_blank: true
-    validates_confirmation_of :password_unencrypted, allow_blank: true
-
-    validate do |record|
-      record.errors.add(:password_unencrypted, :blank) unless record.password.present?
-    end
-
-    attr_reader :password_unencrypted
-    attr_accessor :password_unencrypted_confirmation
-  end
-
-  def password_unencrypted=(unencrypted_password)
-    if unencrypted_password.nil?
-      self.password = nil
-    elsif !unencrypted_password.empty?
-      @password_unencrypted = unencrypted_password
-      self.password = DovecotCrammd5.calc(unencrypted_password)
-    end
-  end
-
-  def authenticate(unencrypted_password)
-    password == DovecotCrammd5.calc(unencrypted_password) && self
-  end
-end

data/lib/postfix_admin/domain.rb

@@ -1,98 +0,0 @@
-module PostfixAdmin
-  class Domain < ApplicationRecord
-    self.table_name = :domain
-    self.primary_key = :domain
-
-    validates :domain, presence: true, uniqueness: { case_sensitive: false },
-                       format: { with: RE_DOMAIN_NAME_LIKE_WITH_ANCHORS,
-                                 message: "must be a valid domain name" }
-    validates :transport, presence: true
-
-    validates :aliases, presence: true,
-                        numericality: { only_integer: true,
-                                        greater_than_or_equal_to: 0 }
-    validates :mailboxes, presence: true,
-                          numericality: { only_integer: true,
-                                          greater_than_or_equal_to: 0 }
-    validates :maxquota, presence: true,
-                         numericality: { only_integer: true,
-                                         greater_than_or_equal_to: 0 }
-
-    has_many :rel_mailboxes, class_name: "Mailbox", foreign_key: :domain,
-                             dependent: :destroy
-    has_many :rel_aliases, class_name: "Alias", foreign_key: :domain,
-                           dependent: :destroy
-
-    has_many :domain_admins, foreign_key: :domain, dependent: :delete_all
-    has_many :admins, through: :domain_admins
-
-    before_validation do |domain|
-      domain.domain = domain.domain.downcase unless domain.domain.empty?
-      domain.transport = "virtual"
-    end
-
-    scope :without_all, -> { where.not(domain: "ALL") }
-
-    def pure_aliases
-      rel_aliases.pure
-    end
-
-    def aliases_unlimited?
-      aliases.zero?
-    end
-
-    def mailboxes_unlimited?
-      mailboxes.zero?
-    end
-
-    def aliases_str
-      num_str(aliases)
-    end
-
-    def mailboxes_str
-      num_str(mailboxes)
-    end
-
-    def aliases_short_str
-      num_short_str(aliases)
-    end
-
-    def mailboxes_short_str
-      num_short_str(mailboxes)
-    end
-
-    def maxquota_str
-      if maxquota.zero?
-        "Unlimited"
-      else
-        "#{maxquota} MB"
-      end
-    end
-
-    def maxquota_short_str
-      if maxquota.zero?
-        "--"
-      else
-        "#{maxquota} MB"
-      end
-    end
-
-    private
-
-    def num_str(num)
-      if num.zero?
-        "Unlimited"
-      else
-        num.to_s
-      end
-    end
-
-    def num_short_str(num)
-      if num.zero?
-        "--"
-      else
-        num.to_s
-      end
-    end
-  end
-end