postfix_admin 0.1.0 → 0.1.1

data/lib/postfix_admin/models.rb

@@ -1,28 +1,10 @@
 require 'data_mapper'
 
-#
-# This extension is to avoid 'ArgumentError: invalid date' when datetime value of
-# MySQL is '0000-00-00 00:00:00'.
-#
-class DateTime
-  class << self
-
-    alias org_new new
-    def new(year = -4712, mon = 1, mday = 1, hour = 0, min = 0, sec = 0, offset = 0, start = Date::ITALY)
-      if year == 0
-        nil
-      else
-        org_new(year, mon, mday, hour, min, sec, offset, start)
-      end
-    end
-  end
-end
-
 module PostfixAdmin
   class Admin
     include ::DataMapper::Resource
     property :username, String, :key => true
-    property :password, String
+    property :password, String, :length => 0..255
     property :created, DateTime, :default => DateTime.now
     property :modified, DateTime, :default => DateTime.now
 
@@ -51,6 +33,11 @@ module PostfixAdmin
       exist_domain?('ALL')
     end
 
+    def clear_domains
+      domains.clear
+      save or raise "Could save Admin"
+    end
+
     def self.find(username)
       Admin.first(:username => username)
     end
@@ -59,12 +46,6 @@ module PostfixAdmin
       !!Admin.find(username)
     end
 
-    def self.unnecessary
-      all.delete_if do |admin|
-        admin.domains.size > 0
-      end
-    end
-
     private
 
     def exist_domain?(domain_name)
@@ -110,6 +91,11 @@ module PostfixAdmin
     def num_total_aliases
       aliases.count - mailboxes.count
     end
+
+    def clear_admins
+      admins.clear
+      save or raise "Could not save Domain"
+    end
   end
 
   class DomainAdmin
@@ -128,7 +114,7 @@ module PostfixAdmin
     property :username, String, :key => true
     property :name, String
     property :domain_name, String, :field => 'domain'
-    property :password, String
+    property :password, String, :length => 0..255
     property :maildir, String
     property :quota, Integer
     #  property :local_part, String
@@ -160,6 +146,15 @@ module PostfixAdmin
 
     storage_names[:default] = 'alias'
 
+    def self.mailbox(address)
+      mail_alias = Alias.new
+      mail_alias.attributes = {
+        :address     => address,
+        :goto        => address,
+      }
+      mail_alias
+    end
+
     def self.find(address)
       Alias.first(:address => address)
     end
@@ -167,5 +162,9 @@ module PostfixAdmin
     def self.exist?(address)
       !!Alias.find(address)
     end
+
+    def mailbox?
+      Mailbox.exist?(address)
+    end
   end
 end

data/lib/postfix_admin/runner.rb

@@ -14,7 +14,7 @@ module PostfixAdmin
       runner{ @cli.show_summary(domain_name) }
     end
 
-    desc "show [example.com]", "List of domains"
+    desc "show [example.com | user@example.com]", "Show domains or mailboxes"
     def show(domain_name=nil)
       runner{ @cli.show(domain_name) }
     end
@@ -45,6 +45,21 @@ module PostfixAdmin
       runner{ @cli.add_domain(domain_name) }
     end
 
+    desc "edit_domain example.com", "Edit a domain limitation"
+    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"
+    def edit_domain(domain_name)
+      runner do
+        if options.size == 0
+          warn "Use one or more options."
+          help('edit_domain')
+        else
+          @cli.edit_domain(domain_name, options)
+        end
+      end
+    end
+
     desc "delete_domain example.com", "Delete a domain"
     def delete_domain(domain_name)
       runner{ @cli.delete_domain(domain_name) }
@@ -65,6 +80,19 @@ module PostfixAdmin
       runner{ @cli.add_account(address, password) }
     end
 
+    desc "edit_account user@example.com", "Edit an account"
+    method_option :quota, :type => :numeric, :aliases => "-q", :desc => "Edit quota limitation"
+    def edit_account(address)
+      runner do
+        if options.size == 0
+          warn "Use one or more options."
+          help('edit_account')
+        else
+          @cli.edit_account(address, options)
+        end
+      end
+    end
+
     desc "add_admin admin@example.com password", "Add an admin user"
     method_option :super, :type => :boolean, :aliases => "-s", :desc => "register as a super admin"
     def add_admin(user_name, password)
@@ -76,6 +104,12 @@ module PostfixAdmin
       runner{ @cli.add_admin_domain(user_name, domain_name) }
     end
 
+    desc "delete_admin_domain admin@example.com example.com", "Delete admin_domain"
+    def delete_admin_domain(user_name, domain_name)
+      runner{ @cli.delete_admin_domain(user_name, domain_name) }
+    end
+
+
     desc "add_alias alias@example.com goto@example.net", "Add an alias"
     def add_alias(address, goto)
       runner{ @cli.add_alias(address, goto) }
@@ -89,7 +123,7 @@ module PostfixAdmin
     desc "version", "Show postfix_admin version"
     def version
       require 'postfix_admin/version'
-      say "postfix_admin #{VERSION}"
+      runner{ say "postfix_admin #{VERSION}" }
     end
 
     private
@@ -97,7 +131,7 @@ module PostfixAdmin
     def runner
       begin
         yield
-      rescue => e
+      rescue Error, ArgumentError => e
         warn e.message
       end
     end

data/lib/postfix_admin/version.rb

@@ -1,3 +1,3 @@
 module PostfixAdmin
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/postfix_admin.gemspec

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/postfix_admin/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.add_dependency 'thor'
   gem.add_dependency 'data_mapper'
+  gem.add_dependency 'do_mysql', '>= 0.10.9'
   gem.add_dependency 'dm-mysql-adapter'
+  gem.add_development_dependency 'rspec', '~> 2.11.0'
   gem.add_development_dependency 'dm-sqlite-adapter'
 
   gem.authors       = ["Hitoshi Kurokawa"]

data/spec/base_spec.rb

@@ -32,7 +32,7 @@ describe PostfixAdmin::Base do
     @base.config[:aliases].should == 30
     @base.config[:mailboxes].should == 30
     @base.config[:maxquota].should == 100
-    @base.config[:mailbox_quota].should == 100 * 1024 * 1000
+    @base.config[:mailbox_quota].should == 100 * KB_TO_MB
   end
 
   it "#domain_exist?" do
@@ -112,9 +112,7 @@ describe PostfixAdmin::Base do
   describe "#add_admin_domain" do
     it "#add_admin_domain" do
       @base.add_admin_domain('admin@example.com', 'example.org')
-      Admin.find('admin@example.com').domains.find do |domain|
-        domain.domain_name == 'example.org'
-      end.should be_true
+      Admin.find('admin@example.com').has_domain?('example.org').should be_true
     end
 
     it "can not add unknown domain for an admin" do
@@ -130,6 +128,25 @@ describe PostfixAdmin::Base do
     end
   end
 
+  describe "#delete_admin_domain" do
+    it "#delete_admin_domain" do
+      lambda{ @base.delete_admin_domain('admin@example.com', 'example.com') }.should_not raise_error
+      Admin.find('admin@example.com').has_domain?('example.com').should be_false
+    end
+
+    it "can not delete not administrated domain" do
+      lambda{ @base.delete_admin_domain('admin@example.com', 'example.org') }.should raise_error Error
+    end
+
+    it "raise error when unknown admin" do
+      lambda{ @base.delete_admin_domain('unknown_admin@example.com', 'example.com') }.should raise_error Error
+    end
+
+    it "raise error when unknown domain" do
+      lambda{ @base.delete_admin_domain('admin@example.com', 'unknown.example.com') }.should raise_error Error
+    end
+ end
+
   describe "#add_alias" do
     it "can add a new alias" do
       num_aliases   = Alias.count

data/spec/cli_spec.rb

@@ -1,10 +1,52 @@
 
 require 'postfix_admin/cli'
 
+describe PostfixAdmin::CLI, "when config file does not exist" do
+  before do
+    config_initialize
+    @file = File.join(File.dirname(__FILE__) , 'tmp/postfix_admin.conf')
+    CLI.config_file = @file
+    FileUtils.rm(@file) if File.exist?(@file)
+  end
+
+  it "::config_file#=" do
+    CLI.config_file.should == @file
+  end
+
+  it "#new should raise SystemExit and create config_file, permission should be 600" do
+    lambda { CLI.new }.should raise_error SystemExit
+    File.exist?(@file).should === true
+    ("%o" % File.stat(@file).mode).should == "100600"
+  end
+end
+
 describe PostfixAdmin::CLI do
   before do
     db_initialize
-    @cli = PostfixAdmin::CLI.new
+    @cli = CLI.new
+  end
+
+  describe "#show" do
+    it "show all domains information by nil domain name" do
+      lambda { @cli.show(nil) }.should_not raise_error
+    end
+
+    it "show domain information" do
+      lambda { @cli.show('example.com') }.should_not raise_error
+    end
+
+    it "can use frozen domain name" do
+      domain = 'example.com'
+      lambda { @cli.show(domain.freeze) }.should_not raise_error
+    end
+
+    it "upcase will convert to downcase" do
+      lambda { @cli.show('ExAmpLe.CoM') }.should_not raise_error
+    end
+
+    it "when unknown domain, raises Error" do
+      lambda { @cli.show('unknown.example.com') }.should raise_error Error
+    end
   end
 
   it "#show_domain" do
@@ -12,9 +54,33 @@ describe PostfixAdmin::CLI do
     capture(:stdout){ @cli.show_domain }.should_not =~ /ALL/
   end
 
-  it "#show_summary" do
-    lambda { @cli.show_summary }.should_not raise_error
-    lambda { @cli.show_summary('unknown.example.com') }.should raise_error Error
+  describe "#show_account" do
+    it "shows information of an account" do
+      lambda {  @cli.show_account('user@example.com') }.should_not raise_error
+      capture(:stdout){ @cli.show_account('user@example.com') }.should =~ /Quota/
+    end
+
+    it "raises error when unknown account" do
+      lambda {  @cli.show_account('unknown@example.com') }.should raise_error Error
+    end
+  end
+
+  describe "#show_summary" do
+    it "show summary of all domain" do
+      lambda { @cli.show_summary }.should_not raise_error
+    end
+
+    it "show summary of domain" do
+      lambda { @cli.show_summary('example.com') }.should_not raise_error
+    end
+
+    it "upcase will convert to downcase" do
+      lambda { @cli.show_summary('example.COM') }.should_not raise_error
+    end
+
+    it "when unknown domain, raises Error" do
+      lambda { @cli.show_summary('unknown.example.com') }.should raise_error Error
+    end
   end
 
   it "#show_admin" do
@@ -87,6 +153,17 @@ describe PostfixAdmin::CLI do
       Admin.exist?('admin@example.com').should be_false
     end
 
+    it "can delete a super admin" do
+      lambda { @cli.delete_admin('all@example.com') }.should_not raise_error
+      Admin.exist?('all@example.com').should be_false
+    end
+
+    it "can delete an admin whish has multiple domains" do
+      @cli.add_admin_domain('admin@example.com', 'example.org')
+      lambda { @cli.delete_admin('admin@example.com') }.should_not raise_error
+      Admin.exist?('admin@example.com').should be_false
+    end
+
     it "can not delete unknown admin" do
       lambda { @cli.delete_admin('unknown_admin@example.com') }.should raise_error Error
     end
@@ -132,34 +209,78 @@ describe PostfixAdmin::CLI do
     end
   end
 
-  it "add and delete methods" do
-    lambda { @cli.add_domain('example.net') }.should_not raise_error
+  describe "#add_domain" do
+    it "can add a new domain" do
+      lambda { @cli.add_domain('example.net') }.should_not raise_error
+    end
 
-    lambda { @cli.add_admin('admin@example.net', 'password') }.should_not raise_error
-    lambda { @cli.add_admin_domain('admin@example.net', 'example.net') }.should_not raise_error
+    it "upcase will convert to downcase" do
+      lambda{ @cli.add_domain('ExAmPle.NeT') }.should_not raise_error
+      Domain.exist?('example.net').should be_true
+    end
 
-    @cli.add_admin('admin2@example.net', 'password')
-    @cli.add_admin_domain('admin2@example.net', 'example.net')
+    it "can not add exist domain" do
+      lambda{ @cli.add_domain('example.com') }.should raise_error Error
+      lambda{ @cli.add_domain('ExAmPle.Com') }.should raise_error Error
+    end
+  end
 
-    @cli.add_admin('common@example.net', 'password')
-    @cli.add_admin_domain('common@example.net', 'example.com')
-    @cli.add_admin_domain('common@example.net', 'example.net')
-    lambda { @cli.delete_admin('common@example.net') }.should_not raise_error
-    Admin.exist?('common@example.net').should be_false
+  describe "#edit_domain" do
+    it "can update domain limitations" do
+      lambda{ @cli.edit_domain('example.com', {:aliases => 40, :mailboxes => 40, :maxquota => 400}) }.should_not raise_error
+      domain = Domain.find('example.com')
+      domain.maxaliases.should == 40
+      domain.maxmailboxes.should == 40
+      domain.maxquota.should == 400
+    end
+  end
 
-    @cli.add_admin('common@example.net', 'password')
-    @cli.add_admin_domain('common@example.net', 'example.com')
-    @cli.add_admin_domain('common@example.net', 'example.net')
+  describe "#edit_account" do
+    it "can update account" do
+      lambda { @cli.edit_account('user@example.com', {:quota => 50}) }.should_not raise_error
+      Mailbox.find('user@example.com').quota.should == 50 * KB_TO_MB
+    end
 
-    lambda { @cli.add_account('user1@example.net', 'password') }.should_not raise_error
-    lambda { @cli.add_account('user2@example.net', 'password') }.should_not raise_error
+    it "raise error when unknown account" do
+      lambda { @cli.edit_account('unknown@example.com', {:quota => 50}) }.should raise_error Error
+    end
+  end
+
+  describe "#delete_domain" do
+    it "can delete exist domain" do
+      lambda { @cli.delete_domain('example.com') }.should_not raise_error
+      Domain.exist?('example.net').should be_false
+    end
+
+    it "upcase will convert to downcase" do
+      lambda { @cli.delete_domain('eXaMplE.cOm') }.should_not raise_error
+      Domain.exist?('example.com').should be_false
+    end
+
+    it "can delete related admins, addresses and aliases" do
+      @cli.add_admin('admin@example.org', 'password')
+      @cli.add_admin_domain('admin@example.org', 'example.org')
+      @cli.add_account('user2@example.com', 'password')
 
-    lambda { @cli.delete_domain('example.net') }.should_not raise_error
-    Admin.exist?('admin@example.net').should be_false
-    Admin.exist?('admin2@example.net').should be_false
+      @cli.add_admin('other_admin@example.com', 'password')
+      @cli.add_admin_domain('other_admin@example.com', 'example.com')
 
-    Admin.exist?('common@example.net').should be_true
-    lambda { @cli.delete_admin('common@example.net') }.should_not raise_error
-    Admin.exist?('common@example.net').should be_false
+      @cli.add_admin('no_related@example.com', 'password')
+
+      lambda { @cli.delete_domain('example.com') }.should_not raise_error
+      Admin.exist?('admin@example.com').should be_false
+      Admin.exist?('admin@example.org').should be_true
+      Admin.exist?('other_admin@example.com').should be_false
+      Admin.exist?('no_related@example.com').should be_true
+
+      # aliases should be removed
+      Alias.exist?('alias@example.com').should be_false
+      Alias.exist?('user@example.com').should be_false
+      Alias.exist?('user2@example.com').should be_false
+
+      # mailboxes should be removed
+      Mailbox.exist?('user@example.com').should be_false
+      Mailbox.exist?('user2@example.com').should be_false
+    end
   end
 end