mailmanager 1.0.10 → 1.0.11

data/.gitignore

@@ -0,0 +1,4 @@
+*.pyc
+pkg/mailmanager-*.gem
+html/*
+doc/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+ruby_string="ruby-1.9.2-p136"
+gemset_name="mailmanager"
+
+if rvm list strings | grep -q "${ruby_string}" ; then
+  
+  # Load or create the specified environment
+  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
+      \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
+  else
+    rvm --create "${ruby_string}@${gemset_name}"
+  fi
+
+  # Ensure that Bundler is installed; install it if not
+  if ! command -v bundle ; then
+    echo "Installing bundler... "
+    gem install bundler
+  fi
+
+  # Run bundler but reduce excess noise
+  echo "Checking your bundle... "
+  bundle | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'
+
+else
+  
+  # Notify user to install the requested interpreter before proceeding
+  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into this directory."
+
+fi

data/Changelog

@@ -1,4 +1,9 @@
-Current version is 1.0.8
+Current version is 1.0.11
+
+changes since 1.0.8
+- added more list metadata methods (see API docs)
+- cleaned up test suite & added more tests
+- cleaned up bundler and gemspec dependencies
 
 changes since 1.0.7
 - added documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    mailmanager (1.0.11)
+      json (~> 1.4.6)
+      open4 (~> 1.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    open4 (1.0.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.4.2)
+  mailmanager!
+  rspec (~> 2.4.0)
+  ruby-debug19

data/Rakefile

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'mailmanager/version'
+require 'rake'
+require 'rake/rdoctask'
+
+desc "Build gem locally"
+task :build do
+  system "gem build mailmanager.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "mailmanager-#{MailManager::VERSION}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/mailmanager-#{MailManager::VERSION}.gem"
+end
+
+desc "Push gem to gems.dnc.org"
+task :inabox => :build do
+  system "gem inabox pkg/mailmanager-#{MailManager::VERSION}.gem"
+end
+
+desc "Push gem to rubygems.org"
+task :release => :build do
+  system "gem push pkg/mailmanager-#{MailManager::VERSION}.gem"
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "lib/mailmanager.rb"
+  rd.rdoc_files.include("lib/**/*.rb")
+end

data/lib/mailmanager/lib.rb

@@ -83,7 +83,9 @@ module MailManager
     end
 
     def delete_moderator(list, email)
-      raise "#{email} is not a moderator" unless moderators(list)['return'].include?(email)
+      unless moderators(list)['return'].include?(email)
+        return {'result' => 'not_a_moderator'}
+      end
       cmd = :withlist
       out = command(cmd, :name => list.name, :wlcmd => 'moderator.remove',
                     :arg => email)
@@ -103,6 +105,18 @@ module MailManager
       parse_json_output(out)
     end
 
+    def request_email(list)
+      cmd = :withlist
+      out = command(cmd, :name => list.name, :wlcmd => :GetRequestEmail)
+      parse_json_output(out)
+    end
+
+    def description(list)
+      cmd = :withlist
+      out = command(cmd, :name => list.name, :wlcmd => :description)
+      parse_json_output(out)
+    end
+
     def command(cmd, opts = {})
       mailman_cmd = "#{mailmanager.root}/bin/#{cmd.to_s} "
       # delete opts as we handle them explicitly
@@ -157,12 +171,15 @@ module MailManager
       [output, process]
     end
 
-    def escape(s)
-      # no idea what this does, stole it from the ruby-git gem
+    def self.escape(s)
       escaped = s.to_s.gsub('\'', '\'\\\'\'')
       %Q{"#{escaped}"}
     end
 
+    def escape(s)
+      self.class.escape(s)
+    end
+
     def parse_output(mailman_cmd, output)
       case mailman_cmd
       when :newlist

data/lib/mailmanager/list.rb

@@ -84,14 +84,15 @@ module MailManager
       result['return']
     end
 
-    # Adds a new moderator to the list
+    # Adds a new moderator to the list. Returns :already_a_moderator if the
+    # requested new moderator is already a moderator.
     def add_moderator(email)
       result = lib.add_moderator(self, email)
       result['result'].to_sym
     end
 
-    # Deletes a moderator from the list. Will raise an exception if the
-    # moderator doesn't exist yet.
+    # Deletes a moderator from the list. Returns :not_a_moderator if the
+    # requested deletion isn't a moderator.
     def delete_moderator(email)
       result = lib.delete_moderator(self, email)
       result['result'].to_sym
@@ -117,6 +118,16 @@ EOF
       "#{root}listinfo/#{name}"
     end
 
+    def request_email
+      result = lib.request_email(self)
+      result['return']
+    end
+
+    def description
+      result = lib.description(self)
+      result['return']
+    end
+
     private
 
     def add_member_using(method, email, name)

data/lib/mailmanager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = '1.0.10'
+  VERSION = '1.0.11'
 end

data/mailmanager.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'mailmanager/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'mailmanager'
+  s.version = MailManager::VERSION
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
+  s.summary = "GNU Mailman wrapper for Ruby"
+  s.description = %{Ruby wrapper library for GNU Mailman's admin functions}
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files spec`.split("\n")
+  s.require_paths = ['lib']
+  s.has_rdoc = true
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.authors = ["Wes Morgan"]
+  s.email = "MorganW@dnc.org"
+  s.homepage = "http://github.com/dnclabs/mailmanager"
+  s.add_runtime_dependency('json', '~>1.4.6')
+  s.add_runtime_dependency('open4', '~>1.0.1')
+  s.add_development_dependency('rspec', '~>2.4.0')
+  s.add_development_dependency('ZenTest', '~>4.4.2')
+  s.add_development_dependency('ruby-debug19')
+end

data/spec/lib/mailmanager/lib_spec.rb

@@ -92,69 +92,135 @@ EOF
     let(:digest_members)  { ['them@that.net'] }
 
     let(:cmd) { "PYTHONPATH=#{File.expand_path('lib/mailmanager')} " +
+                "/usr/bin/env python " +
                 "#{fake_root}/bin/withlist -q -r listproxy.command \"foo\" " }
 
     describe "#regular_members" do
       it "should ask Mailman for the regular list members" do
-        subject.should_receive(:run_command).
-          with(cmd+"getRegularMemberKeys 2>&1", nil).
-          and_return([JSON.generate(regular_members),process])
-        subject.regular_members(list).should == regular_members
+        test_lib_method(:regular_members, :getRegularMemberKeys, regular_members)
       end
     end
 
     describe "#digest_members" do
       it "should ask Mailman for the digest list members" do
-        subject.should_receive(:run_command).
-          with(cmd+"getDigestMemberKeys 2>&1", nil).
-          and_return([JSON.generate(digest_members),process])
-        subject.digest_members(list).should == digest_members
+        test_lib_method(: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'
-        result = {"result" => "pending_confirmation"}
-        subject.should_receive(:run_command).
-          with(cmd+"AddMember \"#{new_member}\" 2>&1", nil).
-          and_return([JSON.generate(result),process])
-        subject.add_member(list, new_member).should == result
+        test_lib_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'
-        result = {"result" => "success"}
-        subject.should_receive(:run_command).
-          with(cmd+"ApprovedAddMember \"#{new_member}\" 2>&1", nil).
-          and_return([JSON.generate(result),process])
-        subject.approved_add_member(list, new_member).should == result
+        test_lib_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'
-        result = {"result" => "success"}
-        subject.should_receive(:run_command).
-          with(cmd+"DeleteMember \"#{former_member}\" 2>&1", nil).
-          and_return([JSON.generate(result),process])
-        subject.delete_member(list, former_member).should == result
+        test_lib_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'
-        result = {"result" => "success"}
-        subject.should_receive(:run_command).
-          with(cmd+"ApprovedDeleteMember \"#{former_member}\" 2>&1", nil).
-          and_return([JSON.generate(result),process])
-        subject.approved_delete_member(list, former_member).should == result
+        test_lib_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'])
+      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')
+      end
+
+      it "should return 'already_a_moderator' if they already a moderator" do
+        result = {'result' => 'already_a_moderator'}
+        subject.should_receive(:moderators).with(list).and_return({'result' => 'success', 'return' => ['foo@bar.com']})
+        subject.add_moderator(list, 'foo@bar.com').should == result
+      end
+    end
+
+    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')
+      end
+
+      it "should return 'not_a_moderator' if they are not already a moderator" do
+        result = {'result' => 'not_a_moderator'}
+        subject.should_receive(:moderators).with(list).and_return({'result' => 'success', 'return' => ['other@bar.com']})
+        subject.delete_moderator(list, 'foo@bar.com').should == result
+      end
+    end
+
+    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")
+      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")
       end
     end
+
+    describe "#description" do
+      it "should ask Mailman for the list's description" do
+        test_lib_attr(:description, "this is a mailing list")
+      end
+    end
+  end
+
+  def test_lib_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)
+  end
+
+  def test_lib_setter(lib_method, *args)
+    cc_mailman_method = camel_case(lib_method.to_s)
+    test_lib_method(lib_method, cc_mailman_method, nil, *args)
+  end
+
+  def test_lib_attr(lib_attr, return_value)
+    test_lib_method(lib_attr, lib_attr, return_value)
+  end
+
+  def test_lib_method(lib_method, mailman_method, return_value=nil, *args)
+    if return_value.is_a?(Hash)
+      result = return_value
+    else
+      result = {"result" => "success"}
+      result["return"] = return_value unless return_value.nil?
+    end
+    subject.should_receive(:run_command).
+      with(cmd+"#{mailman_method.to_s} #{cmd_args(*args)}2>&1", nil).
+      and_return([JSON.generate(result),process])
+    subject.send(lib_method, list, *args).should == result
   end
 
+  def camel_case(s)
+    s.gsub(/^[a-z]|[\s_]+[a-z]/) { |a| a.upcase }.gsub(/[\s_]/, '')
+  end
+
+  def cmd_args(*args)
+    arg_str = args.map { |a|
+      MailManager::Lib::escape(a)
+    }.join(' ')
+    arg_str += ' ' if arg_str.length > 0
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 10
-  version: 1.0.10
+  - 11
+  version: 1.0.11
 platform: ruby
 authors: 
 - Wes Morgan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-21 00:00:00 -05:00
+date: 2011-01-25 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,34 +47,84 @@ dependencies:
         version: 1.0.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 4
+        - 2
+        version: 4.4.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: Ruby wrapper library for GNU Mailman's admin functions
 email: MorganW@dnc.org
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Changelog
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/mailmanager.rb
 - lib/mailmanager/lib.rb
 - lib/mailmanager/list.rb
-- lib/mailmanager/version.rb
-- lib/mailmanager.rb
 - lib/mailmanager/listproxy.py
+- lib/mailmanager/version.rb
+- mailmanager.gemspec
 - spec/lib/mailmanager/lib_spec.rb
 - spec/lib/mailmanager/list_spec.rb
 - spec/lib/mailmanager_spec.rb
 - spec/spec_helper.rb
-- Changelog
-- LICENSE
-- README.rdoc
 has_rdoc: true
 homepage: http://github.com/dnclabs/mailmanager
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -100,5 +150,8 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: GNU Mailman wrapper for Ruby
-test_files: []
-
+test_files: 
+- spec/lib/mailmanager/lib_spec.rb
+- spec/lib/mailmanager/list_spec.rb
+- spec/lib/mailmanager_spec.rb
+- spec/spec_helper.rb