sugoi-mail 0.0.1 → 0.0.2

data/app/controllers/sugoi_admin_controller.rb

@@ -19,6 +19,7 @@ class SugoiAdminController < CommandlineController
     def error(error_text)
         callername = caller[0].gsub(/.*\`(\w+)\'.*/, '\1')
         @error = "#{callername}: #{error_text}"
+        nil
     end
 
     def message(message_text)
@@ -99,6 +100,8 @@ class SugoiAdminController < CommandlineController
             user.password = password
             user.password_confirmation = password_confirmation
             user.description = description
+            user.domainadmin = false
+
             if user.save then
                 message "User \"#{username}@#{domain_name}\" created successfully"
                 if email_address then
@@ -139,35 +142,37 @@ class SugoiAdminController < CommandlineController
 
     alias help_list_mlclasses help_list_mailinglist_classes
 
-    def create_mailing_list mailinglist_class_id, mailinglist_name, 
-        domain_name, user_name, description = nil
+    def create_list mailinglist_name, 
+        domain_name, user_name, description = nil, mailinglist_class_id = 2
 
         mlclass = begin 
                       MailinglistClass.find mailinglist_class_id.to_i
                   rescue ActiveRecord::RecordNotFound
                       nil
                   end
-        if mlclass then
-            domain = Domain.find_by_name domain_name 
-            if domain then
-                user = User.find_by_login_and_domain_id user_name, domain.id 
-                if user then
-                    ml=Mailinglist.new
-                    ml.user = user
-                    ml.description = description
-                    ml.mailinglist_class = mlclass
-                    ml.name = mailinglist_name
-                    if ml.save then
-                        message "Mailing list \"#{ml.address}\" created successfully."
-                    end
-                else
-                    error "User \"#{user_name}\" not found in domain \"#{domain_name}\"."
-                end
-            else
-                error "Domain \"#{domain_name}\" not found."
-            end
-        else
-            error "Invalid mailing list class: #{mailinglist_class_id}"
+        unless mlclass
+            return error("Invalid mailing list class: #{mailinglist_class_id}")
+        end
+
+        domain = Domain.find_by_name domain_name 
+        unless domain
+            return error("Domain \"#{domain_name}\" not found.")
+        end
+
+        user = User.find_by_login_and_domain_id user_name, domain.id 
+        unless user
+            return error("User \"#{user_name}\" not found "+
+                         "in domain \"#{domain_name}\".")
+        end
+
+        ml=Mailinglist.new
+        ml.user = user
+        ml.description = description
+        ml.mailinglist_class = mlclass
+        ml.name = mailinglist_name
+
+        if ml.save then
+            message "Mailing list \"#{ml.address}\" created successfully."
         end
     end
 
@@ -175,8 +180,7 @@ class SugoiAdminController < CommandlineController
        address=Address.find_or_create_by_address new_address
        ml=Mailinglist.find_by_address(mailinglist_address)
        unless ml
-           error "Mailing list \"#{mailinglist_address}\" does not exist!"
-           return
+           return error("Mailing list \"#{mailinglist_address}\" not found.")
        end
        ml=ml[0]
        ml.addresses << address
@@ -195,21 +199,19 @@ class SugoiAdminController < CommandlineController
     def unsubscribe(mailinglist_address, address_to_remove)
         address = Address.find_by_address address_to_remove
         unless address
-            error "Address \"#{address_to_remove}\" unknown."
-            return
+            return error("Address \"#{address_to_remove}\" unknown.")
         end
 
         mailinglist = Mailinglist.find_by_address mailinglist_address
         unless mailinglist
-            error "Mailing list \"#{mailinglist_address}\" does not exist."
-            return
+            return error("Mailing list \"#{mailinglist_address}\" unknown.")
         end
 
         @mailinglist = mailinglist[0]
 
         unless @mailinglist.addresses.member? address
-            error "Address \"#{address}\" not in mailing list \"#{mailinglist_address}\""
-            return
+            return error("Address \"#{address}\" not in " + "
+                mailing list \"#{mailinglist_address}\"")
         end
 
         @removed_addresses=@mailinglist.remove_addresses address

data/app/models/mailinglist.rb

@@ -86,9 +86,15 @@ class Mailinglist < ActiveRecord::Base
     end
 
     def before_save
-        welcome_admin_message   ||= AdminMessage.find 1
-        confirmed_admin_message ||= AdminMessage.find 2
-        sayonara_admin_message  ||= AdminMessage.find 3
+        welcome_admin_message   ||= 
+            AdminMessage.find SysConfig.default_welcome_admin_message_id
+        confirmed_admin_message ||=
+            AdminMessage.find SysConfig.default_confirmed_admin_message_id
+        sayonara_admin_message ||=
+            AdminMessage.find SysConfig.default_farewell_admin_message_id
+        # welcome_admin_message   ||= AdminMessage.find 1 # XXX MAGIC CONSTANT 
+        # confirmed_admin_message ||= AdminMessage.find 2 # XXX MAGIC CONSTANT
+        # sayonara_admin_message  ||= AdminMessage.find 3 # XXX MAGIC CONSTANT
     end
 
     #------------------------------------------------------------------------
@@ -106,9 +112,22 @@ class Mailinglist < ActiveRecord::Base
     # rumble's mailing-list class).
     #------------------------------------------------------------------------
 
-    def address; "#{name}@#{user.domain.name}"; end
-    def bounceaddress; "#{name}-bounce@#{user.domain.name}"; end
-    def requestaddress; "#{name}-request@#{user.domain.name}"; end
+    def address
+        name + "@" + user.domain.name
+        # "#{name}@#{user.domain.name}"
+    end
+
+    def bounceaddress
+        name + SysConfig.address_separator + SysConfig.bounce_suffix + "@" +
+            user.domain.name
+        # "#{name}-bounce@#{user.domain.name}"   # XXX MAGIC CONSTANT XXX
+    end
+
+    def requestaddress
+        name + SysConfig.address_separator + SysConfig.request_suffix + "@" +
+            user.domain.name
+        # "#{name}-request@#{user.domain.name}"  # XXX MAGIC CONSTANT XXX
+    end
 
     def self.find_by_address addr
         if ml = find_by_basic_address(addr) then
@@ -134,7 +153,7 @@ class Mailinglist < ActiveRecord::Base
     end
 
     def self.find_by_proxy_address addr
-        if matchdata=addr.match(/-([0-9]+)\@/) then
+        if matchdata=addr.match(/#{Regexp.escape(SysConfig.address_separator)}([0-9]+)\@/) then
             proxy_id=matchdata[1].to_i
             if ml=find_by_basic_address(addr.sub(/-[0-9]+\@/,"@")) then
                 begin

data/app/models/message.rb

@@ -261,8 +261,13 @@ class Message < ActiveRecord::Base
         # else.  Fix later.
         #
         # (This should actually be in the database somewhere, I'm thinking.)
-        smtpserver  = "localhost"
-        smtpport    = 25
+        smtpserver = SysConfig.smtpserver
+        smtpport   = SysConfig.smtpport
+        mysmtpname = SysConfig.mysmtpname
+
+        # smtpserver = "localhost"      # XXX MAGIC CONSTANT XXX
+        # smtpport   = 25               # XXX MAGIC CONSTANT XXX
+        # mysmtpname = "localhost"      # XXX MAGIC CONSTNAT XXX
 
         if smtpdetails.has_key? :smtpserver then
             smtpserver = smtpdetails[:smtpserver] 
@@ -271,8 +276,11 @@ class Message < ActiveRecord::Base
             smtpport = smtpdetails[:smtpport] || 25
         end
 
-        fromaddress = "#{mailinglist.name}-bounces@#{mailinglist.user.domain.name}"
-        Net::SMTP.start(smtpserver, smtpport, "localhost") do |smtp|
+        fromaddress = mailinglist.name + SysConfig.address_separator +
+            SysConfig.bounce_suffix + "@" + mailinglist.user.domain.name
+        # XXX MAGIC CONSTANT XXX
+        # fromaddress = "#{mailinglist.name}-bounces@#{mailinglist.user.domain.name}"
+        Net::SMTP.start(smtpserver, smtpport, mysmtpname) do |smtp|
             # puts "Will send email to #{addresses.inspect}"
             # puts "Message id is #{id}"
             smtp.send_message messagetext, fromaddress, addresses

data/app/models/sys_config.rb

@@ -0,0 +1,51 @@
+# The sys_config table stores the system configuration for a Sugoi-Mail
+# This includes things like the mail server and the default mailing list
+# class for new users.
+#
+# sys_config has the following data members, although you probably won't
+# need to know them due to the fact that you access configuration parameters
+# directly rather than by searching for them:
+# +name+::        The name of the configuration parameter.
+# +value+::       The value of the configuration parameter.  This is
+#                 serialized as YAML for the moment, until the YAML
+#                 storage format starts presenting problems.
+#
+# To use this library, simply refer to SysConfig.parameter_name.  For example,
+# if the SMTP host were stored in the parameter "smtphost", you'd retrieve
+# it with a simple
+#
+#     SysConfig.smtphost
+#
+# and you'd set it with:
+#
+#     SysConfig.smtphost = "localhost"
+
+class SysConfig < ActiveRecord::Base
+    serialize :value
+
+    def self.method_missing meth, *args
+        begin
+            super(meth, *args)
+        rescue NoMethodError
+            config_param = meth.to_s
+            if config_param =~ /\=$/ then
+                if args.length > 1 then
+                    raise ArgumentError, "How did you manage that?"
+                end
+                config_param.sub! /\=$/,''
+                conf = self.find_or_create_by_name config_param
+                conf.value = args[0]
+                if conf.save
+                    return conf
+                end
+            else
+                conf = self.find_by_name config_param
+                unless conf
+                    raise ActiveRecord::RecordNotFound, 
+                        "config param #{config_param} does not exist"
+                end
+                conf.value
+            end
+        end
+    end
+end

data/app/models/user.rb

@@ -82,7 +82,7 @@ class User < ActiveRecord::Base
     #   @user = User.authenticate('bob', 'bobpass')
     #
     def self.authenticate(login, pass)
-        find_first(["login = ? AND password = ?", login, sha1(pass)])
+        find_by_login_and_password login, sha1(pass)
     end  
 
 
@@ -109,7 +109,7 @@ class User < ActiveRecord::Base
         ml=Mailinglist.new
         ml.name=self.login
         ml.user_id=self.id
-        ml.mailinglist_class=MailinglistClass.find 1
+        ml.mailinglist_class=MailinglistClass.find 1 # XXX MAGIC CONSTANT XXX
         if @description then
             ml.description = @description
         end

data/bin/sugoi-mail

@@ -6,6 +6,11 @@ class AppInstaller < RailsInstaller
     application_name 'sugoi-mail'
     support_location 'http://invio.co.jp/'
     rails_version '1.1.6'
+
+    def post_install_hook
+        system("rake db:fixtures:load FIXTURES=mailinglist_classes,admin_messages,sys_configs RAILS_ENV=production")
+        system("rake db:fixtures:load FIXTURES=mailinglist_classes,admin_messages,sys_configs RAILS_ENV=development") # for the hackers
+    end
 end
 
 # Installer program

data/db/migrate/026_create_sys_configs.rb

@@ -0,0 +1,14 @@
+class CreateSysConfigs < ActiveRecord::Migration
+  def self.up
+    create_table :sys_configs do |t|
+      t.column :name,        :string
+      t.column :value,       :string
+      t.column :description, :string
+      t.column :priority,    :integer
+    end
+  end
+
+  def self.down
+    drop_table :sys_configs
+  end
+end

data/db/schema.rb

@@ -2,7 +2,7 @@
 # migrations feature of ActiveRecord to incrementally modify your database, and
 # then regenerate this schema definition.
 
-ActiveRecord::Schema.define(:version => 25) do
+ActiveRecord::Schema.define(:version => 26) do
 
   create_table "addresses", :force => true do |t|
     t.column "address", :text
@@ -72,6 +72,13 @@ ActiveRecord::Schema.define(:version => 25) do
     t.column "address_id", :integer, :null => false
   end
 
+  create_table "sys_configs", :force => true do |t|
+    t.column "name", :string
+    t.column "value", :string
+    t.column "description", :string
+    t.column "priority", :integer
+  end
+
   create_table "users", :force => true do |t|
     t.column "login", :text, :null => false
     t.column "password", :text, :null => false

data/test/fixtures/sys_configs.yml

@@ -0,0 +1,61 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+smtpserver:
+    id: 1
+    name: smtpserver
+    value: localhost
+    description: The SMTP server to deliver mail through.
+    priority: 1
+smtpport:
+    id: 2
+    name: smtpport
+    value: 25
+    description: The port to connect to on the SMTP server.
+    priority: 1
+mysmtpname:
+    id: 3
+    name: mysmtpname
+    value: localhost
+    description: The value to give to the SMTP server upon connecting (with the SMTP HELO command)
+    priority: 2
+default_welcome_admin_message_id:
+    id: 4
+    name: default_welcome_admin_message_id
+    value: 1
+    description: The ID of the default message to use to welcome a new subscriber to the mailing list.
+    priority: 3
+default_confirmed_admin_message_id:
+    id: 5
+    name: default_confirmed_admin_message_id
+    value: 2
+    description: The ID of the default message to use to let a new subscriber know that his subscription has been confirmed.
+    priority: 3
+default_farewell_admin_message_id:
+    id: 6
+    name: default_farewell_admin_message_id
+    value: 3
+    description: The ID of the default message to use to say farewell to a departing subscriber.
+    priority: 3
+address_separator:
+    id: 7
+    name: address_separator
+    value: "-"
+    description: The character used to separate the bounces and request suffix from the list email address.
+    priority: 5
+bounce_suffix:
+    id: 8
+    name: bounce_suffix
+    value: "bounces"
+    description: What suffix to append to a mailing list address to catch bounces with
+    priority: 4
+request_suffix:
+    id: 9
+    name: request_suffix
+    value: "request"
+    description: The suffix to append to a mailing list address to send messages to with subscription and unsubscription requests
+    priority: 4
+new_user_mailinglist_class:
+    id: 10
+    name: new_user_mailinglist_class
+    value: 1
+    description: The mailing list class of the "forwarded mail" mailing list created when a new user is created.
+    priority: 3

data/test/functional/mailservice_controller_test.rb

@@ -8,7 +8,7 @@ class MailserviceController; def rescue_action(e) raise e end; end
 class MailserviceControllerTest < Test::Unit::TestCase
     fixtures :domains, :users, :mailinglists, :admin_messages,
         :mailinglist_classes, :confirmationcodes, :addresses,
-        :addresses_mailinglists
+        :addresses_mailinglists, :sys_configs
 
     def setup
         @controller = MailserviceController.new

data/test/functional/sugoi_admin_controller_test.rb

@@ -22,6 +22,10 @@ def stuff_ask(*responses)
 end
 
 class SugoiAdminControllerTest < Test::Unit::TestCase
+    fixtures :domains, :users, :mailinglists, :admin_messages,
+        :mailinglist_classes, :confirmationcodes, :addresses,
+        :addresses_mailinglists, :sys_configs
+
     def setup
         @controller = SugoiAdminController.new
         # @request    = ActionController::TestRequest.new
@@ -81,8 +85,8 @@ class SugoiAdminControllerTest < Test::Unit::TestCase
 
     def test_create_user_normally
         assert_nothing_raised do
-            invoke "create_user", "test.domain", "newuser", "newuser@foo.test", 
-                   "New User"
+            invoke "create_user", "test.domain", "newuser", 
+                "newuser@foo.test", "New User"
         end
         assert_equal [ "create_user: User \"newuser@test.domain\" created successfully" ],
             assigns["messages"]
@@ -186,48 +190,48 @@ class SugoiAdminControllerTest < Test::Unit::TestCase
         assert assigns["mailinglist_classes"]
     end
 
-    def test_create_mailing_list_wrong_class
+    def test_create_list_wrong_class
         assert_nothing_raised do
-            invoke "create_mailing_list", 100, "newmailinglist", "test.domain",
-                "testuser", "New Mailing List" 
+            invoke "create_list", "newmailinglist", "test.domain",
+                "testuser", "New Mailing List", 100
         end
         assert assigns["error"]
-        assert_equal "create_mailing_list: Invalid mailing list class: 100", 
+        assert_equal "create_list: Invalid mailing list class: 100", 
             assigns["error"]
         assert_nil Mailinglist.find_by_address("newmailinglist@test.domain")
     end
 
-    def test_create_mailing_list_wrong_domain
+    def test_create_list_wrong_domain
         assert_nothing_raised do
-            invoke "create_mailing_list", 2, "newmailinglist", 
+            invoke "create_list", "newmailinglist", 
                 "nonexistent.domain", "testuser", "New Mailing List"
         end
         assert assigns["error"]
-        assert_equal "create_mailing_list: Domain \"nonexistent.domain\" not found.", 
+        assert_equal "create_list: Domain \"nonexistent.domain\" not found.", 
             assigns["error"]
         assert_nil Mailinglist.find_by_address("newmailinglist@test.domain")
     end
 
     def test_create_Mailing_list_wrong_user
         assert_nothing_raised do
-            invoke "create_mailing_list", 2, "newmailinglist",
+            invoke "create_list", "newmailinglist",
                 "test.domain", "nonexistentuser", "New Mailing List"
         end
 
         assert assigns["error"]
-        assert_equal "create_mailing_list: User \"nonexistentuser\" not found in domain \"test.domain\".",
+        assert_equal "create_list: User \"nonexistentuser\" not found in domain \"test.domain\".",
             assigns["error"]
         assert_nil Mailinglist.find_by_address("newmailinglist@test.domain")
     end
 
-    def test_create_mailing_list_normal
+    def test_create_list_normal
         assert_nothing_raised do
-            invoke "create_mailing_list", 2, "newmailinglist", "test.domain", 
+            invoke "create_list", "newmailinglist", "test.domain", 
                 "testuser"
         end
 
         assert assigns["messages"]
-        assert_equal ["create_mailing_list: Mailing list \"newmailinglist@test.domain\" created successfully."], 
+        assert_equal ["create_list: Mailing list \"newmailinglist@test.domain\" created successfully."], 
             assigns["messages"]
         assert Mailinglist.find_by_address("newmailinglist@test.domain")
     end
@@ -253,7 +257,7 @@ class SugoiAdminControllerTest < Test::Unit::TestCase
         end
         assert_nil assigns["messages"]
         assert assigns["error"]
-        assert_equal "subscribe: Mailing list \"nonexistent@test.domain\" does not exist!", assigns["error"]
+        assert_equal "subscribe: Mailing list \"nonexistent@test.domain\" not found.", assigns["error"]
     end
 
     def test_unsubscribe_address_from_mailing_list

data/test/unit/address_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class AddressTest < Test::Unit::TestCase
     fixtures :mailinglists, :users, :addresses_mailinglists, :addresses,
-        :domains
+        :domains, :sys_configs
 
     def test_parse_1
         assert_equal [ 'address1@foo.test', 'Address One'],

data/test/unit/mailinglist_test.rb

@@ -4,7 +4,8 @@ require 'net-smtp-stub'
 
 class MailinglistTest < Test::Unit::TestCase
     fixtures :mailinglists, :addresses_mailinglists, :addresses,
-        :confirmationcodes, :users, :admin_messages, :domains, :messages
+        :confirmationcodes, :users, :admin_messages, :domains, :messages,
+        :proxy_links
 
     def setup
         @ml=Mailinglist.find 1

data/test/unit/sys_config_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class SysConfigTest < Test::Unit::TestCase
+  fixtures :sys_configs
+
+  def setup
+      @testconfig = @loaded_fixtures["sys_configs"]
+  end
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+
+  def test_param_not_found
+      assert_raises ActiveRecord::RecordNotFound do
+          SysConfig.nosuchparam
+      end
+  end
+
+  def test_fixture_retrieval
+      assert_equal @testconfig["smtpserver"]["value"], SysConfig.smtpserver
+      assert_equal @testconfig["smtpport"]["value"],
+          SysConfig.smtpport
+  end
+
+  def test_set_new_simple_param
+      assert_equal 42, SysConfig.test1=42
+      assert_equal 42, SysConfig.test1
+
+      assert_equal "test", SysConfig.test2="test"
+      assert_equal "test", SysConfig.test2
+  end
+
+  def test_old_activerecord_functionality
+      assert_nothing_raised do
+          param = SysConfig.find_by_name "smtpserver"
+          assert_equal @testconfig["smtpserver"]["value"], param.value
+      end
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: sugoi-mail
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-12-28 00:00:00 +09:00
+  version: 0.0.2
+date: 2007-01-04 00:00:00 +09:00
 summary: Powerful mailing list manager.
 require_paths: 
 - .
@@ -99,6 +99,7 @@ files:
 - app/controllers/address_controller.rb
 - app/controllers/application.rb
 - app/controllers/domain_controller.rb
+- app/models/sys_config.rb
 - app/models/mailinglist_class.rb
 - app/models/domain.rb
 - app/models/message.rb
@@ -126,13 +127,13 @@ files:
 - app/views/sugoi_admin/subscribe.rhtml
 - app/views/sugoi_admin/list_addresses.rhtml
 - app/views/sugoi_admin/list_domains.rhtml
-- app/views/sugoi_admin/create_mailing_list.rhtml
 - app/views/sugoi_admin/unsubscribe.rhtml
 - app/views/sugoi_admin/list_mailinglist_classes.rhtml
 - app/views/sugoi_admin/list_mailinglists.rhtml
 - app/views/sugoi_admin/list_users.rhtml
 - app/views/sugoi_admin/create_user.rhtml
 - app/views/sugoi_admin/create_domain.rhtml
+- app/views/sugoi_admin/create_list.rhtml
 - app/views/layouts/scaffold.rhtml
 - app/views/layouts/address.rhtml
 - app/views/address/new.rhtml
@@ -190,6 +191,7 @@ files:
 - db/migrate/015_add_messages_to_mailinglists.rb
 - db/migrate/014_create_admin_messages.rb
 - db/migrate/010_add_domain_to_users.rb
+- db/migrate/026_create_sys_configs.rb
 - db/migrate/022_add_virtual_to_users.rb
 - db/migrate/007_create_messages.rb
 - db/migrate/013_add_description_to_mailinglists.rb
@@ -216,9 +218,11 @@ files:
 - test/unit/mailinglist_class_test.rb
 - test/unit/mailinglist_test.rb
 - test/unit/message_test.rb
+- test/unit/sys_config_test.rb
 - test/unit/address_test.rb
 - test/unit/confirmationcode_test.rb
 - test/unit/domain_test.rb
+- test/fixtures/sys_configs.yml
 - test/fixtures/confirmationcodes.yml
 - test/fixtures/addresses_mailinglists.yml
 - test/fixtures/messages.yml