mailmanager 1.0.17 → 1.0.18

data/Changelog

@@ -1,4 +1,9 @@
-Current version is 1.0.17
+Current version is 1.0.18
+
+changes since 1.0.17
+- added host_name getter/setter for lists
+- cleaned & DRY'd up the lib class a bit
+- cleaned up the lib spec helper method names
 
 changes since 1.0.16
 - removed rubygems-test since it doesn't work yet (says it can't find bundler)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailmanager (1.0.17)
+    mailmanager (1.0.18)
       json (~> 1.4.6)
       open4 (~> 1.0.1)
 

data/features/list_metadata.feature

@@ -29,3 +29,9 @@ Feature: List metadata
     And I set its subject_prefix to "[Foo List] "
     When I ask for its subject_prefix
     Then I should get "[Foo List] "
+
+  Scenario: Getting & setting the host name
+    Given I have a list named "foo"
+    And I set its host_name to "groups.foo.org"
+    When I ask for its host_name
+    Then I should get "groups.foo.org"

data/lib/mailmanager/lib.rb

@@ -59,153 +59,131 @@ module MailManager
       parse_output(cmd, out)
     end
 
+    def inject(list, message, queue=nil)
+      cmd = :inject
+      params = {:listname => list.name, :stdin => message}
+      params[:queue] = queue unless queue.nil?
+      command(cmd, params)
+    end
+
     def list_address(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :getListAddress)
-      parse_json_output(out)
+      withlist_command(:getListAddress, list)
     end
 
     def regular_members(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :getRegularMemberKeys)
-      parse_json_output(out)
+      withlist_command(:getRegularMemberKeys, list)
     end
 
     def digest_members(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :getDigestMemberKeys)
-      parse_json_output(out)
+      withlist_command(:getDigestMemberKeys, list)
     end
 
     def add_member(list, member)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :AddMember, :arg => member)
-      parse_json_output(out)
+      withlist_command(:AddMember, list, member)
     end
 
     def approved_add_member(list, member)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :ApprovedAddMember,
-                    :arg => member)
-      parse_json_output(out)
+      withlist_command(:ApprovedAddMember, list, member)
     end
 
     def delete_member(list, email)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :DeleteMember,
-                    :arg => email)
-      parse_json_output(out)
+      withlist_command(:DeleteMember, list, email)
     end
 
     def approved_delete_member(list, email)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :ApprovedDeleteMember,
-                    :arg => email)
-      parse_json_output(out)
+      withlist_command(:ApprovedDeleteMember, list, email)
     end
 
     def moderators(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :moderator)
-      parse_json_output(out)
+      withlist_command(:moderator, list)
     end
 
     def add_moderator(list, email)
       if moderators(list)['return'].include?(email)
         raise ModeratorAlreadyExistsError, "#{email} is already a moderator of #{list.name}"
       end
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => 'moderator.append',
-                    :arg => email)
-      parse_json_output(out)
+      withlist_command('moderator.append', list, email)
     end
 
     def delete_moderator(list, email)
       unless moderators(list)['return'].include?(email)
         raise ModeratorNotFoundError, "#{email} is not a moderator of #{list.name}"
       end
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => 'moderator.remove',
-                    :arg => email)
-      parse_json_output(out)
+      withlist_command('moderator.remove', list, email)
     end
 
-    def inject(list, message, queue=nil)
-      cmd = :inject
-      params = {:listname => list.name, :stdin => message}
-      params[:queue] = queue unless queue.nil?
-      command(cmd, params)
-    end
-
-    # TODO: DRY this up!
-
     def web_page_url(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => 'web_page_url')
-      parse_json_output(out)
+      withlist_command('web_page_url', list)
     end
 
     def request_email(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :GetRequestEmail)
-      parse_json_output(out)
+      withlist_command(:GetRequestEmail, list)
     end
 
     def description(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :description)
-      parse_json_output(out)
+      withlist_command(:description, list)
     end
 
-    def subject_prefix(list)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :subject_prefix)
-      parse_json_output(out)
+    def set_description(list, desc)
+      withlist_command(:description, list, desc)
     end
 
-    def set_description(list, desc)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :description, :arg => desc)
-      parse_json_output(out)
+    def subject_prefix(list)
+      withlist_command(:subject_prefix, list)
     end
 
     def set_subject_prefix(list, sp)
-      cmd = :withlist
-      out = command(cmd, :name => list.name, :wlcmd => :subject_prefix, :arg => sp)
+      withlist_command(:subject_prefix, list, sp)
+    end
+
+    def host_name(list)
+      withlist_command(:host_name, list)
+    end
+
+    def set_host_name(list, host_name)
+      withlist_command(:host_name, list, host_name)
+    end
+
+    private
+
+    def withlist_command(wlcmd, list, *args)
+      params = {:name => list.name, :wlcmd => wlcmd}
+      params[:arg] = args[0] unless args[0].nil?
+      out = command(:withlist, params)
       parse_json_output(out)
     end
 
-    def command(cmd, opts = {})
+    def command(cmd, params = {})
       mailman_cmd = "#{mailmanager.root}/bin/#{cmd.to_s} "
-      # delete opts as we handle them explicitly
+      # delete params as we handle them explicitly
       stdin = nil
-      stdin = opts.delete(:stdin) if opts.respond_to?(:has_key?) && opts.has_key?(:stdin)
+      stdin = params.delete(:stdin) if params.respond_to?(:has_key?) && params.has_key?(:stdin)
       case cmd
       when :newlist
         mailman_cmd += "-q "
-        raise ArgumentError, "Missing :name param" if opts[:name].nil?
-        raise ArgumentError, "Missing :admin_email param" if opts[:admin_email].nil?
-        raise ArgumentError, "Missing :admin_password param" if opts[:admin_password].nil?
+        raise ArgumentError, "Missing :name param" if params[:name].nil?
+        raise ArgumentError, "Missing :admin_email param" if params[:admin_email].nil?
+        raise ArgumentError, "Missing :admin_password param" if params[:admin_password].nil?
         mailman_cmd_suffix = [:name, :admin_email, :admin_password].map { |key|
-          escape(opts.delete(key))
+          escape(params.delete(key))
         }.join(' ')
         mailman_cmd += "#{mailman_cmd_suffix} "
       when :rmlist
-        raise ArgumentError, "Missing :name param" if opts[:name].nil?
-        mailman_cmd += "#{escape(opts.delete(:name))} "
+        raise ArgumentError, "Missing :name param" if params[:name].nil?
+        mailman_cmd += "#{escape(params.delete(:name))} "
       when :withlist
-        raise ArgumentError, "Missing :name param" if opts[:name].nil?
+        raise ArgumentError, "Missing :name param" if params[:name].nil?
         proxy_path = File.dirname(__FILE__)
         mailman_cmd = "PYTHONPATH=#{proxy_path} #{MailManager.python} #{mailman_cmd}"
-        mailman_cmd += "-q -r listproxy.command #{escape(opts.delete(:name))} " +
-                       "#{opts.delete(:wlcmd)} "
-        if !opts[:arg].nil? && opts[:arg].length > 0
-          mailman_cmd += "#{escape(opts.delete(:arg))} "
+        mailman_cmd += "-q -r listproxy.command #{escape(params.delete(:name))} " +
+                       "#{params.delete(:wlcmd)} "
+        if !params[:arg].nil? && params[:arg].length > 0
+          mailman_cmd += "#{escape(params.delete(:arg))} "
         end
       end
 
-      # assume any leftover opts are POSIX-style args
-      mailman_cmd += opts.keys.map { |k| "--#{k}=#{escape(opts[k])}" }.join(' ')
+      # assume any leftover params are POSIX-style args
+      mailman_cmd += params.keys.map { |k| "--#{k}=#{escape(params[k])}" }.join(' ')
       mailman_cmd += ' ' if mailman_cmd[-1,1] != ' '
       mailman_cmd += "2>&1"
       if MailManager.debug

data/lib/mailmanager/list.rb

@@ -158,6 +158,18 @@ EOF
       result['result'].to_sym
     end
 
+    # Returns the list's host name
+    def host_name
+      result = lib.host_name(self)
+      result['return']
+    end
+
+    # Sets the list's host name
+    def host_name=(host_name)
+      result = lib.set_host_name(self, host_name)
+      result['result'].to_sym
+    end
+
     private
 
     def add_member_using(method, email, name)

data/lib/mailmanager/listproxy.py

@@ -47,10 +47,10 @@ def unwindattrs(obj, attrname, *args):
         return unwindattrs(nextobj, nextattrname, *args)
 
 needs_userdesc = dict(AddMember=True, ApprovedAddMember=True)
-needs_save = dict(AddMember=True, ApprovedAddMember=True,
-                  DeleteMember=True, ApprovedDeleteMember=True,
-                  moderator_append=True, moderator_remove=True)
-needs_save_with_arg = dict(description=True, subject_prefix=True)
+needs_save = dict(AddMember=True, ApprovedAddMember=True, DeleteMember=True,
+		              ApprovedDeleteMember=True, moderator_append=True,
+									moderator_remove=True)
+needs_save_with_arg = dict(description=True, subject_prefix=True, host_name=True)
 
 def command(mlist, cmd, *args):
     result = {}

data/lib/mailmanager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = '1.0.17'
+  VERSION = '1.0.18'
 end

data/spec/lib/mailmanager/lib_spec.rb

@@ -150,54 +150,54 @@ EOF
 
     describe "#regular_members" do
       it "should ask Mailman for the regular list members" do
-        test_lib_method(:regular_members, :getRegularMemberKeys, regular_members)
+        test_mailman_cmd(:regular_members, :getRegularMemberKeys, regular_members)
       end
     end
 
     describe "#digest_members" do
       it "should ask Mailman for the digest list members" do
-        test_lib_method(:digest_members, :getDigestMemberKeys, digest_members)
+        test_mailman_cmd(:digest_members, :getDigestMemberKeys, digest_members)
       end
     end
 
     describe "#add_member" do
       it "should ask Mailman to add the member to the list" do
         new_member = 'newb@dnc.org'
-        test_lib_setter(:add_member, new_member)
+        test_method_setter(:add_member, new_member)
       end
     end
 
     describe "#approved_add_member" do
       it "should ask Mailman to add the member to the list" do
         new_member = 'newb@dnc.org'
-        test_lib_setter(:approved_add_member, new_member)
+        test_method_setter(:approved_add_member, new_member)
       end
     end
 
     describe "#delete_member" do
       it "should ask Mailman to delete the member from the list" do
         former_member = 'oldie@ofa.org'
-        test_lib_setter(:delete_member, former_member)
+        test_method_setter(:delete_member, former_member)
       end
     end
 
     describe "#approved_delete_member" do
       it "should ask Mailman to delete the member from the list" do
         former_member = 'oldie@ofa.org'
-        test_lib_setter(:approved_delete_member, former_member)
+        test_method_setter(:approved_delete_member, former_member)
       end
     end
 
     describe "#moderators" do
       it "should ask Mailman for the list's moderators" do
-        test_lib_method(:moderators, :moderator, ['phb@bigcorp.com', 'nhb@smallstartup.com'])
+        test_mailman_cmd(:moderators, :moderator, ['phb@bigcorp.com', 'nhb@smallstartup.com'])
       end
     end
 
     describe "#add_moderator" do
       it "should ask Mailman to add the moderator to the list" do
         subject.should_receive(:moderators).with(list).and_return({'result' => 'success', 'return' => []})
-        test_lib_method(:add_moderator, 'moderator.append', nil, 'foo@bar.com')
+        test_mailman_cmd(:add_moderator, 'moderator.append', nil, 'foo@bar.com')
       end
 
       it "should raise ModeratorAlreadyExistsError if they already a moderator" do
@@ -211,7 +211,7 @@ EOF
     describe "#delete_moderator" do
       it "should ask Mailman to delete the moderator from the list" do
         subject.should_receive(:moderators).with(list).and_return({'result' => 'success', 'return' => ['foo@bar.com']})
-        test_lib_method(:delete_moderator, 'moderator.remove', nil, 'foo@bar.com')
+        test_mailman_cmd(:delete_moderator, 'moderator.remove', nil, 'foo@bar.com')
       end
 
       it "should raise ModeratorNotFoundError if they are not already a moderator" do
@@ -224,44 +224,60 @@ EOF
 
     describe "#web_page_url" do
       it "should ask Mailman for the list's web address" do
-        test_lib_attr(:web_page_url, "http://bar.com/mailman/listinfo/foo")
+        test_attr_getter(:web_page_url, "http://bar.com/mailman/listinfo/foo")
       end
     end
 
     describe "#request_email" do
       it "should ask Mailman for the request email address" do
-        test_lib_getter(:request_email, "foo-request@bar.com")
+        test_method_getter(:request_email, "foo-request@bar.com")
       end
     end
 
     describe "#description" do
       it "should ask Mailman for the list's description" do
-        test_lib_attr(:description, "this is a mailing list")
+        test_attr_getter(:description, "this is a mailing list")
       end
     end
 
     describe "#subject_prefix" do
       it "should ask Mailman for the list's subject prefix" do
-        test_lib_attr(:subject_prefix, "[Foo] ")
+        test_attr_getter(:subject_prefix, "[Foo] ")
+      end
+    end
+
+    describe "#host_name" do
+      it "should ask Mailman for the list's host name" do
+        test_attr_getter(:host_name, "groups.foo.org")
+      end
+    end
+
+    describe "#set_host_name" do
+      it "should tell Mailman to set the list's host name" do
+        test_attr_setter(:host_name, 'groups.foo.org')
       end
     end
   end
 
-  def test_lib_getter(lib_method, return_value, *args)
+  def test_method_getter(lib_method, return_value, *args)
     cc_mailman_method = camel_case("get_#{lib_method.to_s}")
-    test_lib_method(lib_method, cc_mailman_method, return_value, *args)
+    test_mailman_cmd(lib_method, cc_mailman_method, return_value, *args)
   end
 
-  def test_lib_setter(lib_method, *args)
+  def test_method_setter(lib_method, *args)
     cc_mailman_method = camel_case(lib_method.to_s)
-    test_lib_method(lib_method, cc_mailman_method, nil, *args)
+    test_mailman_cmd(lib_method, cc_mailman_method, nil, *args)
+  end
+
+  def test_attr_getter(attr, return_value)
+    test_mailman_cmd(attr, attr, return_value)
   end
 
-  def test_lib_attr(lib_attr, return_value)
-    test_lib_method(lib_attr, lib_attr, return_value)
+  def test_attr_setter(attr, *args)
+    test_mailman_cmd("set_#{attr}", attr, nil, *args)
   end
 
-  def test_lib_method(lib_method, mailman_method, return_value=nil, *args)
+  def test_mailman_cmd(lib_method, mailman_method, return_value=nil, *args)
     if return_value.is_a?(Hash)
       result = return_value
     else

data/spec/lib/mailmanager/list_spec.rb

@@ -113,4 +113,24 @@ describe MailManager::List do
       subject.approved_delete_member('foo@bar.baz').should == :success
     end
   end
+
+  context "host_name accessors" do
+    let(:host_name) { 'groups.foo.org' }
+
+    describe "#host_name=" do
+      it "should tell lib to set the host_name" do
+        lib.should_receive(:set_host_name).with(subject, host_name).
+          and_return({'result' => 'success'})
+        subject.host_name = host_name
+      end
+    end
+
+    describe "#host_name" do
+      it "should ask lib for the host_name" do
+        lib.should_receive(:host_name).with(subject).
+          and_return({'result' => 'success', 'return' => host_name})
+        subject.host_name.should == host_name
+      end
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: mailmanager
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.17
+  version: 1.0.18
 platform: ruby
 authors: 
 - Wes Morgan
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -05:00
+date: 2011-02-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency