postfix_admin 0.1.1 → 0.1.2

data/lib/postfix_admin/runner.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require 'postfix_admin'
 require 'postfix_admin/cli'
+require 'postfix_admin/doveadm'
 
 module PostfixAdmin
   class Runner < Thor
@@ -14,9 +15,14 @@ module PostfixAdmin
       runner{ @cli.show_summary(domain_name) }
     end
 
-    desc "show [example.com | user@example.com]", "Show domains or mailboxes"
-    def show(domain_name=nil)
-      runner{ @cli.show(domain_name) }
+    desc "schemes", "List all supported password schemes"
+    def schemes
+      runner{ puts PostfixAdmin::Doveadm.schemes.join(' ') }
+    end
+
+    desc "show [example.com | admin@example.com | user@example.com]", "Show domains or admins or mailboxes"
+    def show(name=nil)
+      runner{ @cli.show(name) }
     end
 
     desc "setup example.com password", "Setup a domain"
@@ -76,27 +82,55 @@ module PostfixAdmin
     end
 
     desc "add_account user@example.com password", "Add an account"
+    method_option :scheme, :type => :string, :aliases => "-s", :desc => "password scheme"
+    method_option :name,   :type => :string, :aliases => "-n", :desc => "full name"
     def add_account(address, password)
-      runner{ @cli.add_account(address, password) }
+      runner do
+        if options[:scheme] == 'scheme'
+          warn "Specify password scheme"
+          help('add_account')
+        else
+          if options[:name] == 'name'
+            warn "Specify name"
+            help('add_account')
+          else
+            @cli.add_account(address, password, options[:scheme], options[:name])
+          end
+        end
+      end
     end
 
     desc "edit_account user@example.com", "Edit an account"
-    method_option :quota, :type => :numeric, :aliases => "-q", :desc => "Edit quota limitation"
+    method_option :quota, :type => :numeric, :aliases => "-q", :desc => "quota limitation"
+    method_option :name,  :type => :string,  :aliases => "-n", :desc => "full name"
     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)
+          if options[:name] == 'name'
+            warn "Specify name"
+            help('edit_account')
+          else
+            @cli.edit_account(address, options)
+          end
         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"
+    method_option :super, :type => :boolean, :aliases => "-S", :desc => "register as a super admin"
+    method_option :scheme, :type => :string, :aliases => "-s", :desc => "password scheme"
     def add_admin(user_name, password)
-      runner{ @cli.add_admin(user_name, password, options[:super]) }
+      runner do
+        if options[:scheme] == 'scheme'
+          warn "Specify password scheme"
+          help('add_admin')
+        else
+          @cli.add_admin(user_name, password, options[:super], options[:scheme])
+        end
+      end
     end
 
     desc "add_admin_domain admin@example.com example.com", "Add admin_domain"
@@ -120,6 +154,11 @@ module PostfixAdmin
       runner{ @cli.delete_alias(address) }
     end
 
+    desc "dump", "Dump all data"
+    def dump
+      runner{ @cli.dump }
+    end
+
     desc "version", "Show postfix_admin version"
     def version
       require 'postfix_admin/version'
@@ -132,7 +171,7 @@ module PostfixAdmin
       begin
         yield
       rescue Error, ArgumentError => e
-        warn e.message
+        abort e.message
       end
     end
   end

data/lib/postfix_admin/version.rb

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

data/postfix_admin.gemspec

@@ -3,9 +3,10 @@ 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 'do_mysql', '>= 0.10.17'
   gem.add_dependency 'dm-mysql-adapter'
-  gem.add_development_dependency 'rspec', '~> 2.11.0'
+  gem.add_development_dependency 'rake', '~> 10.5.0'
+  gem.add_development_dependency 'rspec', '~> 3.4.0'
   gem.add_development_dependency 'dm-sqlite-adapter'
 
   gem.authors       = ["Hitoshi Kurokawa"]

data/spec/base_spec.rb

@@ -12,7 +12,8 @@ describe PostfixAdmin::Base do
         'database'  => 'mysql://postfix:password@localhost/postfix',
         'aliases'   => 30,
         'mailboxes' => 30,
-        'maxquota'  => 100
+        'maxquota'  => 100,
+        'scheme'    => 'CRAM-MD5',
     }
   end
 
@@ -33,25 +34,26 @@ describe PostfixAdmin::Base do
     @base.config[:mailboxes].should == 30
     @base.config[:maxquota].should == 100
     @base.config[:mailbox_quota].should == 100 * KB_TO_MB
+    @base.config[:scheme].should == 'CRAM-MD5'
   end
 
   it "#domain_exist?" do
-    Domain.exist?('example.com').should be_true
+    Domain.exist?('example.com').should be true
   end
 
   it "#alias_exist?" do
-    Alias.exist?('user@example.com').should be_true
-    Alias.exist?('unknown@example.com').should be_false
+    Alias.exist?('user@example.com').should be true
+    Alias.exist?('unknown@example.com').should be false
   end
 
   it "#mailbox_exist?" do
-    Mailbox.exist?('user@example.com').should be_true
-    Mailbox.exist?('unknown@example.com').should be_false
+    Mailbox.exist?('user@example.com').should be true
+    Mailbox.exist?('unknown@example.com').should be false
   end
 
   it "#admin_exist?" do
-    Admin.exist?('admin@example.com').should be_true
-    Admin.exist?('unknown_admin@example.com').should be_false
+    Admin.exist?('admin@example.com').should be true
+    Admin.exist?('unknown_admin@example.com').should be false
   end
 
   describe "#add_domain" do
@@ -79,6 +81,14 @@ describe PostfixAdmin::Base do
         (Alias.count - num_aliases).should be(1)
     end
 
+    it "refuse empty password" do
+      lambda{ @base.add_account('new_user@example.com', '') }.should raise_error Error
+    end
+
+    it "refuse nil password" do
+      lambda{ @base.add_account('new_user@example.com', nil) }.should raise_error Error
+    end
+
     it "can not add account which hsas invalid address" do
       lambda{ @base.add_account('invalid.example.com', 'password') }.should raise_error Error
     end
@@ -100,10 +110,18 @@ describe PostfixAdmin::Base do
     it "can add an new admin" do
       num_admins = Admin.count
       @base.add_admin('admin@example.net', 'password')
-      Admin.exist?('admin@example.net').should be_true
+      Admin.exist?('admin@example.net').should be true
       (Admin.count - num_admins).should be(1)
     end
 
+    it "refuse empty password" do
+      lambda{ @base.add_admin('admin@example.net', '') }.should raise_error Error
+    end
+
+    it "refuse nil password" do
+      lambda{ @base.add_admin('admin@example.net', nil) }.should raise_error Error
+    end
+
     it "can not add exist admin" do
       lambda{ @base.add_admin('admin@example.com', 'password') }.should raise_error Error
     end
@@ -112,7 +130,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').has_domain?('example.org').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
@@ -131,7 +149,7 @@ describe PostfixAdmin::Base do
   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
+      Admin.find('admin@example.com').has_domain?('example.com').should be false
     end
 
     it "can not delete not administrated domain" do
@@ -152,7 +170,7 @@ describe PostfixAdmin::Base do
       num_aliases   = Alias.count
       lambda { @base.add_alias('new_alias@example.com', 'goto@example.jp') }.should_not raise_error
       (Alias.count - num_aliases).should be(1)
-      Alias.exist?('new_alias@example.com').should be_true
+      Alias.exist?('new_alias@example.com').should be true
     end
 
     it "can not add an alias which has a same name as a mailbox" do
@@ -172,7 +190,7 @@ describe PostfixAdmin::Base do
   describe "#delete_alias" do
     it "can delete an alias" do
       lambda{ @base.delete_alias('alias@example.com') }.should_not raise_error
-      Alias.exist?('alias@example.com').should be_false
+      Alias.exist?('alias@example.com').should be false
     end
 
     it "can not delete mailbox" do
@@ -196,8 +214,8 @@ describe PostfixAdmin::Base do
     it "can delete a domain" do
       lambda{ @base.delete_domain('example.com') }.should_not raise_error
 
-      Domain.exist?('example.com').should be_false
-      Admin.exist?('admin@example.com').should be_false
+      Domain.exist?('example.com').should be false
+      Admin.exist?('admin@example.com').should be false
 
       Alias.all(:domain_name => 'example.com').count.should be(0)
       Mailbox.all(:domain_name => 'example.com').count.should be(0)
@@ -213,7 +231,7 @@ describe PostfixAdmin::Base do
   describe "#delete_admin" do
     it "can delete an admin" do
       lambda{ @base.delete_admin('admin@example.com') }.should_not raise_error
-      Admin.exist?('admin@example.com').should be_false
+      Admin.exist?('admin@example.com').should be false
     end
 
     it "can not delete unknown admin" do
@@ -224,8 +242,8 @@ describe PostfixAdmin::Base do
   describe "#delete_account" do
     it "can delete an account" do
       lambda{ @base.delete_account('user@example.com') }.should_not raise_error
-      Mailbox.exist?('user@example.com').should be_false
-      Alias.exist?('user@example.com').should be_false
+      Mailbox.exist?('user@example.com').should be false
+      Alias.exist?('user@example.com').should be false
     end
 
     it "can not delete unknown account" do

data/spec/cli_spec.rb

@@ -54,14 +54,16 @@ describe PostfixAdmin::CLI do
     capture(:stdout){ @cli.show_domain }.should_not =~ /ALL/
   end
 
-  describe "#show_account" do
+  describe "#show_account_details" 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/
+      lambda {  @cli.show_account_details('user@example.com') }.should_not raise_error
+      result = capture(:stdout){ @cli.show_account_details('user@example.com') }
+      result.should =~ /Name/
+      result.should =~ /Quota/
     end
 
     it "raises error when unknown account" do
-      lambda {  @cli.show_account('unknown@example.com') }.should raise_error Error
+      lambda {  @cli.show_account_details('unknown@example.com') }.should raise_error Error
     end
   end
 
@@ -104,12 +106,12 @@ describe PostfixAdmin::CLI do
   describe "#super_admin" do
     it "enables super admin flag of an admin" do
       lambda{ @cli.super_admin('admin@example.com', false) }.should_not raise_error
-      Admin.find('admin@example.com').super_admin?.should be_true
+      Admin.find('admin@example.com').super_admin?.should be true
     end
 
     it "disable super admin flag of an admin" do
       lambda{ @cli.super_admin('all@example.com', true) }.should_not raise_error
-      Admin.find('all@example.com').super_admin?.should be_false
+      Admin.find('all@example.com').super_admin?.should be false
     end
 
     it "can not user for unknown admin" do
@@ -119,7 +121,7 @@ describe PostfixAdmin::CLI do
 
   it "#change_admin_password" do
     lambda { @cli.change_admin_password('admin@example.com', 'new_password') }.should_not raise_error
-    Admin.find('admin@example.com').password.should == 'new_password'
+    Admin.find('admin@example.com').password.should == CRAM_MD5_NEW_PASS
     lambda { @cli.change_admin_password('unknown_admin@example.com', 'new_password') }.should raise_error Error
 
     lambda { @cli.change_admin_password('admin@example.com', '1234') }.should raise_error ArgumentError
@@ -127,7 +129,7 @@ describe PostfixAdmin::CLI do
 
   it "#change_account_password" do
     lambda { @cli.change_account_password('user@example.com', 'new_password') }.should_not raise_error
-    Mailbox.find('user@example.com').password.should == 'new_password'
+    Mailbox.find('user@example.com').password.should == CRAM_MD5_NEW_PASS
     lambda { @cli.change_account_password('unknown@example.com', 'new_password') }.should raise_error Error
     lambda { @cli.change_account_password('user@example.com', '1234') }.should raise_error ArgumentError
   end
@@ -135,7 +137,7 @@ describe PostfixAdmin::CLI do
   describe "#add_admin" do
     it "can add a new admin" do
       lambda { @cli.add_admin('new_admin@example.com', 'password') }.should_not raise_error
-      Admin.exist?('new_admin@example.com').should be_true
+      Admin.exist?('new_admin@example.com').should be true
     end
 
     it "can not add exist admin" do
@@ -150,18 +152,18 @@ describe PostfixAdmin::CLI do
   describe "#delete_admin" do
     it "can delete an admin" do
       lambda { @cli.delete_admin('admin@example.com') }.should_not raise_error
-      Admin.exist?('admin@example.com').should be_false
+      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
+      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
+      Admin.exist?('admin@example.com').should be false
     end
 
     it "can not delete unknown admin" do
@@ -170,22 +172,22 @@ describe PostfixAdmin::CLI do
   end
 
   it "#add_alias and #delete_alias" do
-    lambda { @cli.add_alias('user@example.com', 'goto@example.jp') }.should raise_error
-    lambda { @cli.delete_alias('user@example.com') }.should raise_error
-    lambda { @cli.delete_alias('unknown@example.com') }.should raise_error
+    lambda { @cli.add_alias('user@example.com', 'goto@example.jp') }.should raise_error Error
+    lambda { @cli.delete_alias('user@example.com') }.should raise_error Error
+    lambda { @cli.delete_alias('unknown@example.com') }.should raise_error Error
 
     lambda { @cli.add_alias('new_alias@example.com', 'goto@example.jp') }.should_not raise_error
-    Alias.exist?('new_alias@example.com').should be_true
+    Alias.exist?('new_alias@example.com').should be true
 
     lambda { @cli.delete_alias('new_alias@example.com') }.should_not raise_error
-    Alias.exist?('new_alias@example.com').should be_false
+    Alias.exist?('new_alias@example.com').should be false
   end
 
   describe "#add_account" do
     it "can add an account" do
       lambda { @cli.add_account('new_user@example.com', 'password') }.should_not raise_error
-      Mailbox.exist?('new_user@example.com').should be_true
-      Alias.exist?('new_user@example.com').should be_true
+      Mailbox.exist?('new_user@example.com').should be true
+      Alias.exist?('new_user@example.com').should be true
     end
 
     it "can not add account of unknown domain" do
@@ -200,8 +202,8 @@ describe PostfixAdmin::CLI do
   describe "#delete_accont" do
     it "can delete an account" do
       lambda { @cli.delete_account('user@example.com') }.should_not raise_error
-      Mailbox.exist?('user@example.com').should be_false
-      Alias.exist?('user@example.com').should be_false
+      Mailbox.exist?('user@example.com').should be false
+      Alias.exist?('user@example.com').should be false
     end
 
     it "can not delete unknown account" do
@@ -216,7 +218,7 @@ describe PostfixAdmin::CLI do
 
     it "upcase will convert to downcase" do
       lambda{ @cli.add_domain('ExAmPle.NeT') }.should_not raise_error
-      Domain.exist?('example.net').should be_true
+      Domain.exist?('example.net').should be true
     end
 
     it "can not add exist domain" do
@@ -249,12 +251,12 @@ describe PostfixAdmin::CLI do
   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
+      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
+      Domain.exist?('example.com').should be false
     end
 
     it "can delete related admins, addresses and aliases" do
@@ -268,19 +270,35 @@ describe PostfixAdmin::CLI do
       @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
+      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
+      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
+      Mailbox.exist?('user@example.com').should be false
+      Mailbox.exist?('user2@example.com').should be false
+    end
+  end
+
+  describe "#dump" do
+    it do
+      lambda { @cli.dump }.should_not raise_error
+    end
+
+    it "print infomation of all domains" do
+      result = capture(:stdout){ @cli.dump }
+      result.should =~ /example.com,100,true/
+      result.should =~ /example.org,100,true/
+      result.should =~ /admin@example.com,"9186d855e11eba527a7a52ca82b313e180d62234f0acc9051b527243d41e2740",false,true/
+      result.should =~ /user@example.com,"","9186d855e11eba527a7a52ca82b313e180d62234f0acc9051b527243d41e2740",102400000,"example.com\/user@example.com\/",true/
+      result.should =~ /alias@example.com,"goto@example.jp",true/
+      result.should =~ /user@example.com,"goto@example.jp",true/
     end
   end
 end