sugoi-mail 0.0.5 → 0.1.0

data/INSTALL

@@ -0,0 +1,65 @@
+This is just a quick collection of notes right now, which I shall actually
+structure into a proper install document when I have something vaguely-
+sensible written in the first place.
+
+DEBIAN
+
+First, compile Ruby from source.  This is because Debian's packaging of
+Ruby sucks.  There are pages out there put together by people who have
+carefully amassed every last little package that you need to get a 
+reasonably-complete Ruby installation, but until the Debian guys realize
+that it's _okay_ to have a single package that installs the full core
+Ruby, like they have for Python and Perl, I'll just ignore apt for now.
+
+My recommendation:
+
+# apt-get install libreadline-dev libncurses-dev
+# mkdir /usr/local/src
+# cd /usr/local/src
+# wget http://ftp.ruby-lang.org/pub/ruby/1.8/ruby-1.8.5-p12.tar.gz
+# tar zxvf ruby-1.8.5-p12.tar.gz
+# cd ruby-1.8.5-p12
+# ./configure --prefix=/usr/local && make && make check && make install
+# cd /usr/local/src
+# wget http://rubyforge.org/frs/download.php/11289/rubygems-0.9.0.tgz
+# tar zxvf rubygems-0.9.0.tgz
+# cd rubygems-0.9.0
+# /usr/local/bin/ruby setup.rb config
+# /usr/local/bin/ruby setup.rb install
+
+Wow, I bet I could put that into a shell script!
+
+And then you'll want to install mysql if you're a mysql user.  Of
+course, in Debian, this is easier said than done.  Set up your mysql
+server, which I hope you know how to do.  And then create a user who
+will be allowed to make databases:
+
+mysql> grant all on sugoi.* to sugoi identified by 'sugoi';
+mysql> grant all on sugoi_test.* to sugoi identified by 'sugoi';
+
+Then you'll need to install the Debian mysql client headers so that you
+can install the mysql gem:
+
+# apt-get install libmysqlclient15-dev
+
+The number is subject to change as time goes by, but at the time of
+writing it's 15.
+
+Once you have all that, say:
+
+# gem install -y sugoi-mail
+
+If you leave off the -y, it'll ask if you really want to install every
+single one of the mandatory dependencies.
+
+mysql users will also want to install the mysql gem, and postgresql
+users the postgresql gem.  Let's go with mysql:
+
+# gem install mysql
+
+Once that's done, create a user for sugoi-mail (or just use an account
+you already have) and say:
+
+$ sugoi-mail install sugoi
+
+This should, all being well, set up and start a sugoi-mail installation.

data/app/controllers/sugoi_admin_controller.rb

@@ -2,7 +2,6 @@ class SugoiAdminController < CommandlineController
     model :mailinglist
 
     private
-
     def get_password
         password = ask "Password: " do |q| q.echo = false end
         confirmation = ask "Confirm: " do |q| q.echo = false end
@@ -38,7 +37,7 @@ class SugoiAdminController < CommandlineController
 
     def init
         @alreadythere = []
-        [ MailinglistClass, AdminMessage, SysConfig ].each do |table|
+        [ MailinglistClass, AdminMessage, SysConfig, Help ].each do |table|
             fixture = YAML.load(File.read(File.join(RAILS_ROOT,
                                                     "test",
                                                     "fixtures",
@@ -236,4 +235,12 @@ class SugoiAdminController < CommandlineController
 
         @removed_addresses=@mailinglist.remove_addresses address
     end
+
+    def help(command=nil)
+        if command
+            @help = Help.find_by_facility_and_command self.class.name, command
+        else
+            @help = Help.find_all_by_facility self.class.name
+        end
+    end
 end

data/app/models/help.rb

@@ -0,0 +1,2 @@
+class Help < ActiveRecord::Base
+end

data/app/views/sugoi_admin/_command_description.rhtml

@@ -0,0 +1,9 @@
+Usage:
+    sugoi-admin <%= @help.command %> <%= @help.parameters %>
+
+<%= 
+    formatter = Text::Format.new
+    formatter.columns = ( ENV["COLUMNS"] || 80 ).to_i
+    formatter.text = @help.explanation
+    formatter.format 
+%>

data/app/views/sugoi_admin/_command_list.rhtml

@@ -0,0 +1,5 @@
+Sugoi-admin is the administrative interface to sugoi-mail used to
+bootstrap and configure your sugoi-mail installation.  It has a
+selection of subcommands:
+<% @help.sort_by { |h| h.command }.each do |help| %>
+<%= "%25s %s" % [ help.command, help.summary ] %><% end %>

data/app/views/sugoi_admin/help.rhtml

@@ -0,0 +1,8 @@
+<%=
+    case @help
+    when Array
+        render :partial => 'command_list'
+    else
+        render :partial => 'command_description'
+    end
+%>

data/config/boot.rb

@@ -25,7 +25,7 @@ unless defined?(Rails::Initializer)
       rails_gem = Gem.cache.search('rails', "=#{version}").first
 
       if rails_gem
-        require_gem "rails", "=#{version}"
+        gem "rails", "=#{version}"
         require rails_gem.full_gem_path + '/lib/initializer'
       else
         STDERR.puts %(Cannot find gem for Rails =#{version}:
@@ -35,10 +35,10 @@ unless defined?(Rails::Initializer)
         exit 1
       end
     else
-      require_gem "rails"
+      gem "rails"
       require 'initializer'
     end
   end
 
   Rails::Initializer.run(:set_load_path)
-end
+end

data/db/migrate/027_create_helps.rb

@@ -0,0 +1,19 @@
+# Doesn't calling the class "Helps" make it look just like it was written
+# by a Russian guy or something?  Well, I like the way it looks well enough
+# to let it stand as-is.
+
+class CreateHelps < ActiveRecord::Migration
+    def self.up
+        create_table :helps do |t|
+            t.column :facility, :string
+            t.column :command, :string
+            t.column :parameters, :string
+            t.column :summary, :string
+            t.column :explanation, :text
+        end
+    end
+
+    def self.down
+        drop_table :helps
+    end
+end

data/db/schema.mysql.sql

@@ -39,6 +39,15 @@ CREATE TABLE domains (
   `password` text NOT NULL
 ) ENGINE=InnoDB;
 
+CREATE TABLE helps (
+  `id` int(11) DEFAULT NULL auto_increment PRIMARY KEY,
+  `facility` varchar(255),
+  `command` varchar(255),
+  `parameters` varchar(255),
+  `summary` varchar(255),
+  `explanation` text
+) ENGINE=InnoDB;
+
 CREATE TABLE mailinglist_classes (
   `id` int(11) DEFAULT NULL auto_increment PRIMARY KEY,
   `name` text NOT NULL,
@@ -109,4 +118,4 @@ CREATE TABLE schema_info (
   `version` int(11)
 ) ENGINE=InnoDB;
 
-insert into schema_info (version) values (26);
+insert into schema_info (version) values (27);

data/db/schema.postgresql.sql

@@ -39,6 +39,15 @@ CREATE TABLE domains (
   "password" text NOT NULL
 );
 
+CREATE TABLE helps (
+  "id" serial primary key,
+  "facility" character varying(255),
+  "command" character varying(255),
+  "parameters" character varying(255),
+  "summary" character varying(255),
+  "explanation" text
+);
+
 CREATE TABLE mailinglist_classes (
   "id" serial primary key,
   "name" text NOT NULL,
@@ -109,4 +118,4 @@ CREATE TABLE schema_info (
   "version" integer
 );
 
-insert into schema_info (version) values (26);
+insert into schema_info (version) values (27);

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 => 26) do
+ActiveRecord::Schema.define(:version => 27) do
 
   create_table "addresses", :force => true do |t|
     t.column "address", :text
@@ -32,6 +32,14 @@ ActiveRecord::Schema.define(:version => 26) do
     t.column "password", :text, :null => false
   end
 
+  create_table "helps", :force => true do |t|
+    t.column "facility", :string
+    t.column "command", :string
+    t.column "parameters", :string
+    t.column "summary", :string
+    t.column "explanation", :text
+  end
+
   create_table "mailinglist_classes", :force => true do |t|
     t.column "name", :text, :null => false
     t.column "description", :text

data/db/schema.sqlite.sql

@@ -39,6 +39,15 @@ CREATE TABLE domains (
   "password" text NOT NULL
 );
 
+CREATE TABLE helps (
+  "id" INTEGER PRIMARY KEY NOT NULL,
+  "facility" varchar(255),
+  "command" varchar(255),
+  "parameters" varchar(255),
+  "summary" varchar(255),
+  "explanation" text
+);
+
 CREATE TABLE mailinglist_classes (
   "id" INTEGER PRIMARY KEY NOT NULL,
   "name" text NOT NULL,
@@ -109,4 +118,4 @@ CREATE TABLE schema_info (
   "version" integer
 );
 
-insert into schema_info (version) values (26);
+insert into schema_info (version) values (27);

data/db/schema.sqlserver.sql

@@ -43,6 +43,16 @@ CREATE TABLE domains (
   [password] text NOT NULL
 );
 
+CREATE TABLE helps (
+  [id] int NOT NULL IDENTITY(1,
+  1) PRIMARY KEY,
+  [facility] varchar(255),
+  [command] varchar(255),
+  [parameters] varchar(255),
+  [summary] varchar(255),
+  [explanation] text
+);
+
 CREATE TABLE mailinglist_classes (
   [id] int NOT NULL IDENTITY(1,
   1) PRIMARY KEY,
@@ -119,4 +129,4 @@ CREATE TABLE schema_info (
   [version] int
 );
 
-insert into schema_info (version) values (26);
+insert into schema_info (version) values (27);

data/db/schema_version

@@ -1 +1 @@
-26
+27

data/lib/tasks/release.rake

@@ -1,6 +1,6 @@
 require 'rake/gempackagetask'
 
-PKG_VERSION = "0.0.5"
+PKG_VERSION = "0.1.0"
 PKG_NAME = "sugoi-mail"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 

data/test/fixtures/helps.yml

@@ -0,0 +1,134 @@
+--- 
+help_1: 
+  command: init
+  parameters: 
+  facility: SugoiAdminController
+  explanation: >
+    Sets the initial configuration for a sugoi-mail system.  Once
+    you've run this, you need to create a domain and a user.  If this
+    has already been run, it won't overwrite existing values.
+
+    You shouldn't need to use this at all if you've installed sugoi-mail
+    using the rails-app-installer.
+  id: 1
+  summary: Initializes a sugoi-mail system
+help_2: 
+  command: show_config
+  parameters: "[<configuration variable>]"
+  facility: SugoiAdminController
+  explanation: >
+    Shows the configuration of the sugoi-mail system, or shows the value of a specific configuration variable.
+  id: 2
+  summary: Shows configuration parameter(s)
+help_3: 
+  command: set_config
+  parameters: <configuration variable> <new value>
+  facility: SugoiAdminController
+  explanation: >
+    Sets a configuration variable to a new value.
+  id: 3
+  summary: Sets a configuration parameter
+help_4: 
+  command: list_domains
+  parameters: ""
+  facility: SugoiAdminController
+  explanation: Lists all the domains defined in the sugoi-mail system.
+  id: 4
+  summary: Lists domains
+help_5: 
+  command: list_mailinglists
+  parameters: <domain>
+  facility: SugoiAdminController
+  explanation: >
+    Lists all of the mailing lists that have been created in domain <domain>.
+  id: 5
+  summary: Lists mailing lists in a domain
+help_6: 
+  command: list_addresses
+  parameters: <mailinglist>
+  facility: SugoiAdminController
+  explanation: >
+    Lists all of the addresses that are subscribed to the mailing list whose
+    address is <mailinglist>.
+  id: 6
+  summary: Lists the addresses in a mailing list.
+help_7: 
+  command: create_domain
+  parameters: <domain>
+  facility: SugoiAdminController
+  explanation: >
+    Creates a new domain with the name <domain>.  This will ask for a password
+    for the new domain.
+  id: 7
+  summary: Creates a new domain
+help_8: 
+  command: create_user
+  parameters: <domain> <username>
+  facility: SugoiAdminController
+  explanation: >
+    Creates a new user with the name <username> in the domain <domain>.  This
+    will ask for a password for the new user.
+  id: 8
+  summary: Creates a new user
+help_9: 
+  command: list_users
+  parameters: <domain>
+  facility: SugoiAdminController
+  explanation: Lists the users that have been created in domain <domain>.
+  id: 9
+  summary: Lists the users in a domain.
+help_10: 
+  command: list_mailinglist_classes
+  parameters: ""
+  facility: SugoiAdminController
+  explanation: >
+    Prints out a list of mailing list classes.  A mailing list class defines
+    the behaviour that a mailing list defined within that class will have.
+  id: 10
+  summary: Outputs a list of mailing list classes defined
+help_11: 
+  command: create_list
+  parameters: <mailinglist class> <mailinglist name> <domain name> <user name> [<description>]
+  facility: SugoiAdminController
+  explanation: >
+    Creates a mailing list of class <mailinglist class> (use the
+    list_mailinglist_classes command to see the available mailing list classes)
+    named <mailinglist name> in domain <domain name> owned by the user <user
+    name>.
+  id: 11
+  summary: Create a mailing list
+help_12: 
+  command: subscribe
+  parameters: <mailinglist address> <email address>
+  facility: SugoiAdminController
+  explanation: >
+    Subscribes the address <email address> to the mailing list whose address is
+    <mailinglist address>
+  id: 12
+  summary: Subscribe an address to a mailing list
+help_13: 
+  command: unsubscribe
+  parameters: <mailinglist address> <email address>
+  facility: SugoiAdminController
+  explanation: >
+    Unsubscribes the address <email address> from the mailing list whose
+    address is <mailinglist address>
+  id: 13
+  summary: Unsubscribe an address from a mailing list
+help_14:
+  id: 14
+  command: help
+  parameters: [<command>]
+  facility: SugoiAdminController
+  summary: Explains the sugoi-admin commands
+  explanation: >
+    Gives a list of all the sugoi-admin commands, along with their
+    descriptions, or gives detailed help on a specific command.
+help_15:
+  id: 15
+  command: list_mlclasses
+  parameters: ""
+  facility: SugoiAdminController
+  summary: A shortcut for list_mailinglist_classes
+  explanation: >
+    A shorter, easier-to-type alternative for "list_mailinglist_classes".

data/test/functional/sugoi_admin_controller_test.rb

@@ -24,7 +24,7 @@ end
 class SugoiAdminControllerTest < Test::Unit::TestCase
     fixtures :domains, :users, :mailinglists, :admin_messages,
         :mailinglist_classes, :confirmationcodes, :addresses,
-        :addresses_mailinglists, :sys_configs
+        :addresses_mailinglists, :sys_configs, :helps
 
     def setup
         @controller = SugoiAdminController.new
@@ -339,6 +339,7 @@ class SugoiAdminControllerTest < Test::Unit::TestCase
         MailinglistClass.delete_all
         SysConfig.delete_all
         AdminMessage.delete_all
+        Help.delete_all
 
         assert_nothing_raised do
             invoke "init"
@@ -352,5 +353,33 @@ class SugoiAdminControllerTest < Test::Unit::TestCase
             SysConfig.find_all.length
         assert_equal @loaded_fixtures["admin_messages"].length, 
             AdminMessage.find_all.length
+        assert_equal @loaded_fixtures["helps"].length, 
+            Help.find_all.length
+    end
+
+    def test_init_no_clobber_values
+        SysConfig.smtpserver="www.google.com"
+
+        assert_nothing_raised do
+            invoke "init"
+        end
+
+        assert_equal "www.google.com", SysConfig.smtpserver
+
+        assert_equal @loaded_fixtures["sys_configs"].length +
+            @loaded_fixtures["mailinglist_classes"].length +
+            @loaded_fixtures["admin_messages"].length +
+            @loaded_fixtures["helps"].length, 
+            assigns["alreadythere"].length
+
+    end
+
+    def test_help_by_itself
+        assert_nothing_raised do
+            invoke "help"
+        end
+
+        assert Array === assigns["help"]
+        assert_equal @loaded_fixtures["helps"].length, assigns["help"].length
     end
 end

data/test/unit/help_test.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class HelpTest < Test::Unit::TestCase
+    fixtures :helps
+
+    # Replace this with your real tests.
+    def test_truth
+        assert true
+    end
+
+    def test_help_coverage_sugoi_admin
+        methods = SugoiAdminController.action_methods - "wsdl" - "perform_action"
+        commands = Help.find_all_by_facility("SugoiAdminController").map do 
+            |h| h.command 
+        end
+
+        assert_equal commands, commands.uniq
+        assert_equal methods.sort, commands.sort
+    end
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.1
 specification_version: 1
 name: sugoi-mail
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
-date: 2007-01-15 00:00:00 +09:00
+  version: 0.1.0
+date: 2007-02-01 00:00:00 +09:00
 summary: Powerful mailing list manager.
 require_paths: 
 - .
@@ -42,6 +42,7 @@ files:
 - app
 - script
 - db
+- INSTALL
 - test
 - vendor
 - doc/mailinglist_classes description.txt
@@ -95,7 +96,6 @@ files:
 - app/apis
 - app/controllers/account_controller.rb
 - app/controllers/mailinglist_controller.rb
-- app/controllers/sugoi_admin_help_controller.rb
 - app/controllers/sugoi_admin_controller.rb
 - app/controllers/mailservice_controller.rb
 - app/controllers/commandline_controller.rb
@@ -109,6 +109,7 @@ files:
 - app/models/address.rb
 - app/models/admin_message.rb
 - app/models/mailinglist.rb
+- app/models/help.rb
 - app/models/proxy_link.rb
 - app/models/confirmationcode.rb
 - app/models/user.rb
@@ -127,10 +128,13 @@ files:
 - app/views/mailinglist/list.rhtml
 - app/views/mailinglist/show.rhtml
 - app/views/mailinglist/_form.rhtml
+- app/views/sugoi_admin/_command_description.rhtml
 - app/views/sugoi_admin/subscribe.rhtml
 - app/views/sugoi_admin/list_addresses.rhtml
 - app/views/sugoi_admin/init.rhtml
+- app/views/sugoi_admin/help.rhtml
 - app/views/sugoi_admin/list_domains.rhtml
+- app/views/sugoi_admin/_command_list.rhtml
 - app/views/sugoi_admin/show_config.rhtml
 - app/views/sugoi_admin/unsubscribe.rhtml
 - app/views/sugoi_admin/list_mailinglist_classes.rhtml
@@ -193,6 +197,7 @@ files:
 - db/migrate/016_add_mailinglist_admin_to_users.rb
 - db/migrate/025_add_proxify_to_mailinglist_classes.rb
 - db/migrate/002_create_users.rb
+- db/migrate/027_create_helps.rb
 - db/migrate/004_create_addresses.rb
 - db/migrate/015_add_messages_to_mailinglists.rb
 - db/migrate/014_create_admin_messages.rb
@@ -227,6 +232,7 @@ files:
 - test/unit/sys_config_test.rb
 - test/unit/address_test.rb
 - test/unit/confirmationcode_test.rb
+- test/unit/help_test.rb
 - test/unit/domain_test.rb
 - test/fixtures/sys_configs.yml
 - test/fixtures/confirmationcodes.yml
@@ -238,6 +244,7 @@ files:
 - test/fixtures/mailinglists.yml
 - test/fixtures/mailinglist_classes.yml
 - test/fixtures/domains.yml
+- test/fixtures/helps.yml
 - test/fixtures/users.yml
 - test/functional/sugoi_admin_controller_test.rb
 - test/functional/mailservice_controller_test.rb

data/app/controllers/sugoi_admin_help_controller.rb

@@ -1,51 +0,0 @@
-class SugoiAdminHelpController < CommandlineController
-    def init
-    end
-
-    def show_config
-    end
-
-    def set_config
-    end
-
-    def list_domains
-    end
-    def list_mailinglists
-
-    end
-    def list_addresses
-
-    end
-    def create_domain
-    end
-    
-    def create_user domain_name, username,
-    end
-
-    def list_users domain_name
-    end
-
-    def list_mailinglist_classes
-        usage "list_mailinglist_classes",
-              "Outputs a list of mailing list classes defined"
-    end
-    alias list_mlclasses list_mailinglist_classes
-
-    def list_mailinglist_classes
-    end
-
-    def create_list mailinglist_name,
-        usage "create_mailing_list <mailinglist_class_id> <mailinglist_name> " +
-              "<domain_name> <user_name> [<description>]", 
-              "Creates a mailing list of class <mailinglist_class_id> ("
-              "use list_mailinglist_classes to see the available mailing "+
-              "list classes) named <mailinglist_name> in domain "+ 
-              "<domain_name> owned by the user named <user_name>"
-    end
-
-    def subscribe(mailinglist_address, new_address)
-    end
-
-    def unsubscribe(mailinglist_address, address_to_remove)
-    end
-end