mailmanager 1.0.20 → 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ee8afabb8d34fa2483f91bc718955eabb4a2596
+  data.tar.gz: 887655c56bb41103b68d1675d8acbc9ece21df5c
+SHA512:
+  metadata.gz: b9e99831e907f9ae7f6ecc6e5f7670be7dc3ec4608ac420f9014b086af063d7d19f9d3b43b9c4063a10bd2339e17dfa841754b01214b9abc2fbcf42df9e45994
+  data.tar.gz: ec2036e04ed599144adcac319f0f74ea5e3e3540f6fcfeba767b1d2833e7d57ae408ea079619a5486c1dbd06a1b4fb6e8430e7e7d8a0cfc516e7bcfdeed72b7d

data/.gitignore

@@ -5,3 +5,5 @@ doc/*
 results/*
 mailman
 coverage/*
+Gemfile.lock
+.ruby-version

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.1.2"

data/Changelog

@@ -1,4 +1,10 @@
-Current version is 1.0.20
+Current version is 1.1.0
+
+changes since 1.0.20
+- krissi added a find_member method and cleaned up some old cruft
+- removed Cucumber; will re-do acceptance tests in a better way in the future
+- added Travis CI build
+- updated json gem dependency to 1.8.1 for Ruby 2.1.2 support
 
 changes since 1.0.19
 - none, just updated website & other README-type stuff

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org/"
 
 gemspec

data/README.md

@@ -0,0 +1,109 @@
+# MailManager
+
+[![Build Status](https://travis-ci.org/cap10morgan/mailmanager.svg?branch=master)](https://travis-ci.org/cap10morgan/mailmanager)
+
+MailManager is a Ruby wrapper for the GNU Mailman mailing list manager. It exposes
+some administrative functions to Ruby. See the [API docs](http://rubydoc.info/github/cap10morgan/mailmanager/master/frames)
+for details.
+It is licensed under the New BSD License (see the LICENSE file for details).
+
+MailManager has been tested with Mailman 2.1.14. It has NOT been tested with any
+release of Mailman 3 (in alpha as of 1/19/2011). It requires Python 2.4 or higher.
+Note that while Mailman itself requires Python, it can work with older versions. So
+check your Python version before using this.
+
+## Installation
+
+    gem install mailmanager
+
+## Basic Usage
+
+    mm = MailManager.init('/mailman/root')
+    all_lists = mm.lists
+    foo_list = mm.get_list('foo')
+    new_list = mm.create_list(:name => 'newlist', :admin_email => 'me@here.com', :admin_password => 'secret')
+    new_list.add_member('bar@baz.com')
+    new_list.members -> ['bar@baz.com']
+
+## Hacking
+
+Here are the basic steps for adding new features to this gem, if you're a programmer
+type who likes to write code so you can code while you code... sorry.
+
+MailManager's API currently consists of a handful of methods at the top-level
+MailManager::Base class. This is where you'll find create_list and get_list. These
+both return instances of MailManager::List, which is really where the action is.
+
+MailManager::List contains the public Ruby API for interacting with Mailman's lists.
+It exposes the methods and attributes of Mailman's MailList.py class, but makes
+them a bit more Ruby-ish where appropriate. Not every method / attribute is
+exposed, but this is where you come in, dear contributor.
+
+The code that actually talks to Mailman is in lib/mailmanager/lib.rb.
+It runs scripts in Mailman's bin directory. Anything that interacts with an
+existing list uses Mailman's "withlist" script and the listproxy.py file in this
+gem. If you read the docs on withlist that come with Mailman, it should be pretty
+obvious what's going on there. But you don't need to understand all that to expose
+new methods & attributes of MailList.py to MailManager.
+
+Exposing new list properties works something like this:
+* Look at Mailman's code in Mailman/MailList.py and see if the thing you want to
+  expose is a method or an attribute. You'll need to know a little Python, but not
+  much. Basically, a method is a callable thing and an attribute is a simple
+  property of the object. "AddMember" is a method, for example, while "description"
+  is an attribute.
+* If it's a method, just write a simple method in lib/mailmanager/list.rb that
+  calls a method in lib.rb (just like the others do). Then go write the method
+  that you call in lib/mailmanager/lib.rb, using list_address or add_member as an
+  example (depending on whether you're writing a getter or a setter, respectively).
+* All methods that interact with MailList.py instances (i.e. mailing lists) use the
+  withlist command, so just copy that stuff from an existing method.
+* If you're exposing an attribute, then use the moderator methods as a guide.
+  For example, they do their own dupe checking since the MailList.py class will
+  let you set the attribute to whatever you want. Dangerous!
+* If you're writing a setter, you have one more chore to make it work. You need the
+  listproxy.py code to lock the list and then save it after making your requested
+  change. It will do this for you if you do the following:
+    * For a method: Add the name of the MailList.py method to the needs_save dict and
+      have it return True. It should be obvious when you look at the others in there.
+    * For an attribute: Add the name of the attribute to the needs_save_with_arg dict.
+      This one is a bit different because the attr name is the same for gets and sets,
+      but we need to lock and save when it's a set, and we can guess that it's a set
+      when there is an argument passed, and a get when there is no argument. S-M-R-T
+    * For a chain of attrs/methods: Huh? Look at lib.rb#add_moderator for an
+      example. "moderator" is an array attribute of MailList.py, and we want to
+      append a new string to it. So our "command" to listproxy.py is
+      "moderator.append" with the new moderator string as the argument. listproxy is
+      smart enough to untangle that and get the moderator attribute and then call the
+      append method on it with your argument. But, in order to tell it to lock and
+      save the list for us, we must replace that dot in the name with an
+      underscore in the needs_save key. That's why we have "moderator_append=True"
+      in the needs_save dict in listproxy.py. So if you have a chain of attributes
+      and methods to get at the thing you're exposing, just replace the dots with
+      underscores in the needs_save dict key and you'll be all set.
+
+That should get you started hacking on the gem. If you get stuck or are trying to
+do anything more complex, please feel free to e-mail me: cap10morgan@gmail.com.
+
+## Testing
+
+The RSpec suite should run out of the box with the `rake spec` command.
+Feel free to open a GitHub issue if they do not.
+
+## Contributing
+
+* Fork on GitHub
+* Make a new branch
+* Commit your feature addition or bug fix to that branch.
+* Don't mess with Rakefile, version.rb, or Changelog. (If you want to have your own version, that's fine but bump version in its own commit so we can ignore it when we pull.)
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Push your changes to that branch (i.e. not master)
+* Make a pull request
+* Bask in your awesomeness
+
+## Author
+
+* Wes Morgan (cap10morgan on GitHub) <cap10morgan@gmail.com>
+
+Copyright 2011 Democratic National Committee,
+All Rights Reserved.

data/Rakefile

@@ -2,7 +2,7 @@ APP_ROOT = File.expand_path( File.dirname(__FILE__) )
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require 'mailmanager/version'
 require 'rake'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 
 # load all .rake files in the tasks dir
@@ -36,5 +36,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
-desc "Run tests for rubygems-test"
+desc "Run tests for mailmanager"
 task :test => :spec
+
+task :default => :spec

data/lib/mailmanager.rb

@@ -85,6 +85,14 @@ module MailManager
       @lib.list_names
     end
 
+    # Retrieves all lists for one or multiple list members selected by a regexp
+    # Returns something like { "member@example.com" => [ "first_list", "second_list" ] }
+    # Takes a String or a Regexp
+    #
+    def find_member(regex)
+      @lib.find_member(regex)
+    end
+
     # Create a new list. Returns an instance of MailManager::List. Params are:
     # * :name => 'new_list_name'
     # * :admin_email => 'admin@domain.com'

data/lib/mailmanager/lib.rb

@@ -31,6 +31,13 @@ module MailManager
       lists.map { |list| list.name }
     end
 
+    def find_member(regex)
+      raise ArgumentError, "Expected a Python Regular Expression as String" if regex.is_a? Regexp
+      cmd = :find_member
+      out = command(cmd, {:regex => regex})
+      parse_output(cmd, out)
+    end
+
     def create_list(params)
       raise ArgumentError, "Missing :name param" if params[:name].nil?
       list_name = params[:name]
@@ -172,6 +179,9 @@ module MailManager
       when :rmlist
         raise ArgumentError, "Missing :name param" if params[:name].nil?
         mailman_cmd += "#{escape(params.delete(:name))} "
+      when :find_member
+        raise ArgumentError, "Missing :regex param" if params[:regex].nil?
+        mailman_cmd += "#{escape(params.delete(:regex))} "
       when :withlist
         raise ArgumentError, "Missing :name param" if params[:name].nil?
         proxy_path = File.dirname(__FILE__)
@@ -235,6 +245,21 @@ module MailManager
           end
         end
         return_obj = lists
+      when :find_member
+        matches = {}
+        puts "Output from Mailman:\n#{output}" if MailManager.debug
+        last_member = nil
+        output.split("\n").each do |line|
+          if line =~ /^(.+) found in:/
+            puts "Found member #{$1}" if MailManager.debug
+            last_member = $1
+            matches[last_member] = []
+          elsif line =~ /^\s*(.+?)$/
+            puts "Found list #{$1} for member #{last_member}" if MailManager.debug
+            matches[last_member] << $1
+          end
+        end
+        return_obj = matches
       end
       return_obj
     end

data/lib/mailmanager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = '1.0.20'
+  VERSION = '1.1.1'
 end

data/mailmanager.gemspec

@@ -7,6 +7,7 @@ require 'mailmanager/version'
 spec = Gem::Specification.new do |s|
   s.name = 'mailmanager'
   s.version = MailManager::VERSION
+  s.licenses = "BSD-3-Clause"
   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}
@@ -14,20 +15,12 @@ spec = Gem::Specification.new do |s|
   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 = "cap10morgan@gmail.com"
   s.homepage = "http://github.com/cap10morgan/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')
-  s.add_development_dependency('ci_reporter')
-  s.add_development_dependency('cucumber')
-  s.add_development_dependency('simplecov')
-  s.add_development_dependency('simplecov-rcov', '~>0.1.4')
+  s.add_runtime_dependency('json', '~> 1.8')
+  s.add_runtime_dependency('open4', '~> 1.0')
+  s.add_development_dependency('rake', '~> 10.3')
+  s.add_development_dependency('rspec', '~> 2.4')
 end

data/spec/lib/mailmanager/lib_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe MailManager::Lib do
-  let(:mailmanager) { mock(MailManager) }
+  let(:mailmanager) { double(MailManager) }
   let(:subject)     { MailManager::Lib.new }
   let(:fake_root)   { '/foo/bar' }
   let(:python)      { '/usr/bin/env python' }
-  let(:process)     { mock(Process::Status) }
+  let(:process)     { double(Process::Status) }
   let(:list_result) { <<EOF
 3 matching mailing lists found:
         Foo - [no description available]
@@ -25,7 +25,7 @@ EOF
     it "should return all existing lists" do
       subject.stub(:run_command).with("#{python} #{fake_root}/bin/list_lists 2>&1", nil).
         and_return([list_result, process])
-      subject.lists.should have(3).lists
+      expect(subject.lists.size).to eq(3)
     end
   end
 
@@ -68,11 +68,11 @@ EOF
       }
       let(:new_list_return) {
         prefix =<<EOF
-To finish creating your mailing list, you must edit your /etc/aliases (or                           
-equivalent) file by adding the following lines, and possibly running the                            
-`newaliases' program:                                                                               
-                                                                                                    
-## bar mailing list                                                                                 
+To finish creating your mailing list, you must edit your /etc/aliases (or
+equivalent) file by adding the following lines, and possibly running the
+`newaliases' program:
+
+## bar mailing list
 EOF
         prefix+new_aliases.join("\n")
       }
@@ -138,7 +138,7 @@ EOF
   end
 
   context "with populated list" do
-    let(:list) { list = mock(MailManager::List)
+    let(:list) { list = double(MailManager::List)
                  list.stub(:name).and_return('foo')
                  list }
 
@@ -256,6 +256,36 @@ EOF
       end
     end
 
+    describe "#find_member" do
+      context "with string as argument" do
+        it "should ask Mailman for the matching lists" do
+          subject.should_receive(:run_command).
+            with(/python.*find_member.*foo/, nil).and_return([<<-EOF, process])
+foo@example.com found in:
+     list1
+     list2
+     foobar
+foo@example.net found in:
+     list3
+            EOF
+
+          result = subject.find_member('foo@bar.com')
+          result.should be_a(Hash)
+          result.keys.first.should eq('foo@example.com')
+          result.values.first.should eq(['list1', 'list2', 'foobar'])
+          result.values.last.should eq(['list3'])
+        end
+      end
+
+      context "with Regexp as argument" do
+        it "raises an ArgumentError" do
+          lambda {
+            subject.find_member(/^member/)
+          }.should raise_error(ArgumentError, /Python/)
+        end
+      end
+    end
+
     describe "#web_page_url" do
       it "should ask Mailman for the list's web address" do
         test_attr_getter(:web_page_url, "http://bar.com/mailman/listinfo/foo")

data/spec/lib/mailmanager/list_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe MailManager::List do
-  let(:lib)       { mock(MailManager::Lib) }
+  let(:lib)       { double(MailManager::Lib) }
   let(:subject)   { MailManager::List.new('foo') }
 
   before :each do

metadata

@@ -1,139 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: mailmanager
 version: !ruby/object:Gem::Version
-  version: 1.0.20
-  prerelease: 
+  version: 1.1.1
 platform: ruby
 authors:
 - Wes Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-06 00:00:00.000000000Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70116502937460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.6
+        version: '1.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70116502937460
-- !ruby/object:Gem::Dependency
-  name: open4
-  requirement: &70116502936960 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *70116502936960
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70116502936500 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :development
-  prerelease: false
-  version_requirements: *70116502936500
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: ZenTest
-  requirement: &70116502936040 !ruby/object:Gem::Requirement
-    none: false
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.2
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  version_requirements: *70116502936040
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &70116502935660 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70116502935660
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: ci_reporter
-  requirement: &70116502935200 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
-  version_requirements: *70116502935200
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: &70116502934780 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70116502934780
+        version: '10.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &70116502934360 !ruby/object:Gem::Requirement
-    none: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70116502934360
-- !ruby/object:Gem::Dependency
-  name: simplecov-rcov
-  requirement: &70116502933860 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
-  type: :development
-  prerelease: false
-  version_requirements: *70116502933860
+        version: '2.4'
 description: Ruby wrapper library for GNU Mailman's admin functions
 email: cap10morgan@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rvmrc
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Changelog
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - config/cucumber.yml
-- features/create_list.feature
-- features/delete_list.feature
-- features/list_metadata.feature
-- features/moderators.feature
-- features/step_definitions/global_steps.rb
-- features/step_definitions/list_steps.rb
-- features/support/env.rb
 - lib/mailmanager.rb
 - lib/mailmanager/lib.rb
 - lib/mailmanager/list.rb
@@ -147,29 +94,29 @@ files:
 - spec/spec_helper.rb
 - tasks/hudson.rake
 homepage: http://github.com/cap10morgan/mailmanager
-licenses: []
+licenses:
+- BSD-3-Clause
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: GNU Mailman wrapper for Ruby
 test_files:
 - spec/lib/mailmanager/lib_spec.rb

data/.rvmrc

@@ -1,31 +0,0 @@
-#!/usr/bin/env bash
-
-ruby_string="ruby-1.9.2"
-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/Gemfile.lock

@@ -1,66 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mailmanager (1.0.19)
-      json (~> 1.4.6)
-      open4 (~> 1.0.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    ZenTest (4.4.2)
-    archive-tar-minitar (0.5.2)
-    builder (3.0.0)
-    ci_reporter (1.6.4)
-      builder (>= 2.1.2)
-    columnize (0.3.2)
-    cucumber (0.10.0)
-      builder (>= 2.1.2)
-      diff-lcs (~> 1.1.2)
-      gherkin (~> 2.3.2)
-      json (~> 1.4.6)
-      term-ansicolor (~> 1.0.5)
-    diff-lcs (1.1.2)
-    gherkin (2.3.3)
-      json (~> 1.4.6)
-    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)
-    simplecov (0.3.9)
-      simplecov-html (>= 0.3.7)
-    simplecov-html (0.3.9)
-    simplecov-rcov (0.1.4)
-      simplecov
-    term-ansicolor (1.0.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  ZenTest (~> 4.4.2)
-  ci_reporter
-  cucumber
-  mailmanager!
-  rspec (~> 2.4.0)
-  ruby-debug19
-  simplecov
-  simplecov-rcov (~> 0.1.4)

data/README.rdoc

@@ -1,123 +0,0 @@
-= MailManager
-
-Website[http://github.com/cap10morgan/mailmanager]
-
-MailManager is a Ruby wrapper for the GNU Mailman mailing list manager. It exposes
-some administrative functions to Ruby. See the API docs[http://rubydoc.info/github/cap10morgan/mailmanager/master/frames]
-for details.
-It is licensed under the New BSD License (see the LICENSE file for details).
-
-MailManager has been tested with Mailman 2.1.14. It has NOT been tested with any
-release of Mailman 3 (in alpha as of 1/19/2011). It requires Python 2.4 or higher.
-Note that while Mailman itself requires Python, it can work with older versions. So
-check your Python version before using this.
-
-== Installation
-
-  gem install mailmanager
-
-== Basic Usage
-
-  mm = MailManager.init('/mailman/root')
-  all_lists = mm.lists
-  foo_list = mm.get_list('foo')
-  new_list = mm.create_list(:name => 'newlist', :admin_email => 'me@here.com', :admin_password => 'secret')
-  new_list.add_member('bar@baz.com')
-  new_list.members -> ['bar@baz.com']
-
-== Hacking
-
-Here are the basic steps for adding new features to this gem, if you're a programmer
-type who likes to write code so you can code while you code... sorry.
-
-MailManager's API currently consists of a handful of methods at the top-level
-MailManager::Base class. This is where you'll find create_list and get_list. These
-both return instances of MailManager::List, which is really where the action is.
-
-MailManager::List contains the public Ruby API for interacting with Mailman's lists.
-It exposes the methods and attributes of Mailman's MailList.py class, but makes
-them a bit more Ruby-ish where appropriate. Not every method / attribute is
-exposed, but this is where you come in, dear contributor.
-
-The code that actually talks to Mailman is in lib/mailmanager/lib.rb.
-It runs scripts in Mailman's bin directory. Anything that interacts with an
-existing list uses Mailman's "withlist" script and the listproxy.py file in this
-gem. If you read the docs on withlist that come with Mailman, it should be pretty
-obvious what's going on there. But you don't need to understand all that to expose
-new methods & attributes of MailList.py to MailManager.
-
-Exposing new list properties works something like this:
-- Look at Mailman's code in Mailman/MailList.py and see if the thing you want to
-  expose is a method or an attribute. You'll need to know a little Python, but not
-  much. Basically, a method is a callable thing and an attribute is a simple
-  property of the object. "AddMember" is a method, for example, while "description"
-  is an attribute.
-- If it's a method, just write a simple method in lib/mailmanager/list.rb that
-  calls a method in lib.rb (just like the others do). Then go write the method
-  that you call in lib/mailmanager/lib.rb, using list_address or add_member as an
-  example (depending on whether you're writing a getter or a setter, respectively).
-- All methods that interact with MailList.py instances (i.e. mailing lists) use the
-  withlist command, so just copy that stuff from an existing method.
-- If you're exposing an attribute, then use the moderator methods as a guide.
-  For example, they do their own dupe checking since the MailList.py class will
-  let you set the attribute to whatever you want. Dangerous!
-- If you're writing a setter, you have one more chore to make it work. You need the
-  listproxy.py code to lock the list and then save it after making your requested
-  change. It will do this for you if you do the following:
-  - For a method: Add the name of the MailList.py method to the needs_save dict and
-    have it return True. It should be obvious when you look at the others in there.
-  - For an attribute: Add the name of the attribute to the needs_save_with_arg dict.
-    This one is a bit different because the attr name is the same for gets and sets,
-    but we need to lock and save when it's a set, and we can guess that it's a set
-    when there is an argument passed, and a get when there is no argument. S-M-R-T
-  - For a chain of attrs/methods: Huh? Look at lib.rb#add_moderator for an
-    example. "moderator" is an array attribute of MailList.py, and we want to
-    append a new string to it. So our "command" to listproxy.py is
-    "moderator.append" with the new moderator string as the argument. listproxy is
-    smart enough to untangle that and get the moderator attribute and then call the
-    append method on it with your argument. But, in order to tell it to lock and
-    save the list for us, we must replace that dot in the name with an
-    underscore in the needs_save key. That's why we have "moderator_append=True"
-    in the needs_save dict in listproxy.py. So if you have a chain of attributes
-    and methods to get at the thing you're exposing, just replace the dots with
-    underscores in the needs_save dict key and you'll be all set.
-
-That should get you started hacking on the gem. If you get stuck or are trying to
-do anything more complex, please feel free to e-mail me: cap10morgan@gmail.com.
-
-== Testing
-
-The RSpec suite should run out of the box with the 'rake spec' command.
-Feel free to open a GitHub issue if they do not.
-
-You'll need a local working installation of GNU Mailman 2.1.14 (or a later version
-of 2.1.x, probably) to run the Cucumber integration tests. Make a symlink to the
-root directory of your Mailman install in the mailmanager directory. It should be
-named "mailman". So if you are in the top-level mailmanager directory and your
-Mailman installation is in /usr/local/mailman, you would run this command:
-  ln -s /usr/local/mailman mailman
-
-Once that's done, you should be able to just run 'cucumber' in the top-level
-mailmanager directory.
-
-<b>MAKE SURE THIS IS NOT A MAILMAN INSTALLATION YOU CARE ABOUT!</b> The Cucumber test
-suite will start by deleting all mailing lists so it can have a clean slate to
-test with.
-
-== Contributing
-
-- Fork on GitHub
-- Make a new branch
-- Commit your feature addition or bug fix to that branch.
-- Don't mess with Rakefile, version.rb, or Changelog. (If you want to have your own version, that's fine but bump version in its own commit so we can ignore it when we pull.)
-- Add tests for it. This is important so we don't break it in a future version unintentionally.
-- Push your changes to that branch (i.e. not master)
-- Make a pull request
-- Bask in your awesomeness
-
-== Author
-
-- Wes Morgan (cap10morgan on GitHub) <cap10morgan@gmail.com>
-
-Copyright 2011 Democratic National Committee,
-All Rights Reserved.

data/features/create_list.feature

@@ -1,18 +0,0 @@
-Feature: Creating a new list
-  As a developer using MailManager
-  In order to create new mailing lists
-  I want MailManager to offer this feature
-
-  Background:
-    Given MailManager is initialized on "./mailman"
-
-  Scenario: Creating a new list
-    Given no lists exist
-    When I create a new list "foo"
-    Then I should have a list named "foo"
-
-  Scenario: Creating a list with the same name as an existing list
-    Given no lists exist
-    When I create a new list "foo"
-    Then it should raise MailManager::ListNameConflictError when I create a new list "foo"
-    And I should have 1 list

data/features/delete_list.feature

@@ -1,16 +0,0 @@
-Feature: Deleting a list
-  As a developer using MailManager
-  In order to delete lists
-  I want MailManager to offer this feature
-
-  Background:
-    Given MailManager is initialized on "./mailman"
-
-  Scenario: Deleting a list
-    Given I have a list named "foo"
-    When I delete list "foo"
-    Then I should have 0 lists
-
-  Scenario: Deleting a list that doesn't exist
-    Given no lists exist
-    Then it should raise MailManager::ListNotFoundError when I delete list "foo"

data/features/list_metadata.feature

@@ -1,37 +0,0 @@
-Feature: List metadata
-
-  Background:
-    Given MailManager is initialized on "./mailman"
-
-  Scenario: Getting the info URL
-    Given I have a list named "foo"
-    When I ask for its info_url
-    Then I should get a URL
-
-  Scenario: Getting the list address
-    Given I have a list named "foo"
-    When I ask for its address
-    Then I should get an email address
-
-  Scenario: Getting the request email
-    Given I have a list named "foo"
-    When I ask for its request_email
-    Then I should get an email address
-
-  Scenario: Setting & getting the list description
-    Given I have a list named "foo"
-    And I set its description to "foo list of fun"
-    When I ask for its description
-    Then I should get "foo list of fun"
-
-  Scenario: Setting & getting the subject prefix
-    Given I have a list named "foo"
-    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/features/moderators.feature

@@ -1,22 +0,0 @@
-Feature: List moderators administration
-
-  Background:
-    Given MailManager is initialized on "./mailman"
-    Given I have a list named "foo"
-
-  Scenario: Adding a moderator
-    When I add a moderator "me@bar.com"
-    Then I should have 1 moderator
-
-  Scenario: Adding a moderator that already exists
-    Given I add a moderator "me@bar.com"
-    Then it should raise MailManager::ModeratorAlreadyExistsError when I add a moderator "me@bar.com"
-
-  Scenario: Deleting a moderator
-    Given I add a moderator "me@bar.com"
-    When I delete a moderator "me@bar.com"
-    Then I should have 0 moderators
-
-  Scenario: Deleting a moderator that doesn't exist
-    Given I add a moderator "other@bar.com"
-    Then it should raise MailManager::ModeratorNotFoundError when I delete a moderator "me@bar.com"

data/features/step_definitions/global_steps.rb

@@ -1,24 +0,0 @@
-Given /^MailManager is initialized on "([^\"]+)"$/ do |mailman_root|
-  @mailmanager = MailManager.init(mailman_root)
-end
-
-Given /^no lists exist$/ do
-  @mailmanager.list_names.each do |list_name|
-    @mailmanager.delete_list(list_name)
-  end
-end
-
-Then /^it should raise (.+?) when (.+)$/ do |exception,when_step|
-  lambda {
-    When when_step
-  }.should raise_error(eval(exception))
-end
-
-Then /^I should have (\d+) lists?$/ do |num|
-  @mailmanager.should have(num.to_i).lists
-end
-
-Then /^I should have a list named "([^"]*)"$/ do |list_name|
-  @mailmanager.list_names.should include(list_name)
-end
-

data/features/step_definitions/list_steps.rb

@@ -1,47 +0,0 @@
-Given /^I have a list named "([^"]*)"$/ do |list_name|
-  Given %{no lists exist}
-  When %{I create a new list "#{list_name}"}
-end
-
-When /^I create a new list "([^"]*)"$/ do |list_name|
-  @list = @mailmanager.create_list(:name => list_name, :admin_email => 'cuke@foo.org', :admin_password => 'greenisgood')
-end
-
-When /^I delete list "([^"]*)"$/ do |list_name|
-  list = @mailmanager.get_list(list_name)
-  list.delete
-end
-
-When /^I ask for its (.+)$/ do |attr|
-  @attr = @list.send(attr)
-end
-
-Then /^I should get a URL$/ do
-  @attr.should =~ %r{^http://.*/}
-end
-
-Then /^I should get an email address$/ do
-  # super basic email regex
-  @attr.should =~ %r{^[^@]+@[^\.]+\..+}
-end
-
-When /^I add a moderator "([^"]*)"$/ do |mod|
-  @list.add_moderator(mod)
-end
-
-Then /^I should have (\d+) moderators?$/ do |num|
-  @list.should have(num.to_i).moderators
-end
-
-When /^I delete a moderator "([^"]*)"$/ do |mod|
-  @list.delete_moderator(mod)
-end
-
-Given /^I set its (.+?) to "([^"]*)"$/ do |attr,val|
-  @list.send("#{attr}=",val)
-end
-
-Then /^I should get "([^"]*)"$/ do |val|
-  @attr.should == val
-end
-

data/features/support/env.rb

@@ -1,7 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', File.dirname(__FILE__))
-if ENV['COVERAGE_REPORT']
-  $LOAD_PATH.unshift File.expand_path('../../spec', File.dirname(__FILE__))
-  require "mailmanager_simplecov"
-  SimpleCov.start 'mailmanager'
-end
-require "mailmanager"