gossip 0.3.0

data/History.txt

@@ -0,0 +1,9 @@
+Version 0.3.0
+  * Version from _Everyday Scripting with Ruby_ renamed from Watchdog to 
+    to Gossip and made into a Gem.
+  * Generalized so that watchdog is only one example of the more general
+    library.
+  * Can now spread gossip to Campfire. (Idea taken from snitch.rubyforge.org, 	
+	John Nunemaker.)
+  * Can now spread gossip to Trac.
+  * Can now spread gossip to Twitter (credit again to John Nunemaker).

data/LICENSE.txt

@@ -0,0 +1,34 @@
+This software is Copyright (C) 2007 by Brian Marick <marick@exampler.com>. It is licensed according to "the Ruby license". Specifically:
+
+You can redistribute it and/or modify it under either the terms of the GNU General Public License, version 2, <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html> or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) make other distribution arrangements with the author.
+
+  3. You may modify and include part of the software into any other
+     software (possibly commercial).  
+
+  4. Text or files supplied as input to or produced as output from 
+     the software do not automatically fall under the copyright of the
+     software, but belong to whomever generated them, and may be sold
+     commercially, and may be aggregated with this software.
+
+  5. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/Manifest.txt

@@ -0,0 +1,62 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+examples/all-config-file-choices.yml
+lib/gossip.rb
+lib/gossip/command.rb
+lib/gossip/cronies/campfire.rb
+lib/gossip/cronies/jabber.rb
+lib/gossip/cronies/smtp.rb
+lib/gossip/cronies/stdout.rb
+lib/gossip/cronies/trac.rb
+lib/gossip/cronies/twitter.rb
+lib/gossip/crony.rb
+lib/gossip/multi-exceptions.rb
+lib/gossip/preteen.rb
+lib/gossip/site-config.rb
+lib/gossip/social-universe.rb
+lib/gossip/version.rb
+pages/classes.html
+pages/cronies.html
+pages/css/LICENSE.txt
+pages/css/Thumbs.db
+pages/css/bg2.gif
+pages/css/gossip5-header-flip.jpg
+pages/css/left.gif
+pages/css/left_on.gif
+pages/css/main.css
+pages/css/right.gif
+pages/css/right_on.gif
+pages/css/tvline.gif
+pages/images/campfire.png
+pages/images/classes.png
+pages/images/deployment.png
+pages/images/jabber-big.png
+pages/images/jabber.png
+pages/images/trac-bigger.png
+pages/images/trac-detail.png
+pages/images/twitter.png
+pages/index.html
+pages/installation.html
+pages/scripts.html
+pages/src/classes.graffle
+pages/starting-to-use.html
+pages/writing-new-scripts.html
+scripts/fanout
+scripts/svntell
+scripts/watchdog
+setup.rb
+test/script/fanout-slowtests.rb
+test/script/svntell-slowtests.rb
+test/script/util.rb
+test/script/watchdog-slowtests.rb
+test/unit/command-crony-interaction-tests.rb
+test/unit/command-tests.rb
+test/unit/crony-tests.rb
+test/unit/multi-exception-tests.rb
+test/unit/preteen-tests.rb
+test/util/bff.rb
+test/util/doghouse.rb
+test/util/silly-little-test-program.rb

data/README.txt

@@ -0,0 +1,6 @@
+Gossip is a library that provides a consistent interface to "cronies" like Twitter, Campfire, email, and Jabber. It comes with scripts that use that library to do useful things. There is a {more detailed description}[http://gossip.rubyforge.org].
+
+There are nicely-formatted {installation instructions}[http://gossip.rubyforge.org/installation.html].
+
+There is also a {description of the main classes}[http://gossip.rubyforge.org/classes.html] to help you understand Gossip, plus instructions for {writing new scripts}[http://gossip.rubyforge.org/writing-new-scripts.html].
+

data/Rakefile

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-03.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'hoe'
+
+Dir.chdir('lib') do
+  # Hack: This prevents requires of the same file looking 
+  # different in tests and causing annoying warnings.
+  require 'gossip/version'
+end
+
+PROJECT='gossip'
+THIS_RELEASE=Gossip::Version
+
+
+Hoe.new(PROJECT, THIS_RELEASE) do |p|
+  p.rubyforge_name = PROJECT
+  p.changes = "See History.txt"
+  p.author = "Brian Marick"
+  p.description = "Library to broadcast messages to multiple destinations + scripts that use it"
+  p.summary = p.description
+  p.email = "marick@exampler.com"
+  p.extra_deps = [['s4t-utils', '>= 1.0.3'],
+                  ['xmpp4r', '>= 0.3.1'],
+                  ['tinder', '>= 0.1.4'],
+                  ['snitch', '>= 0.1.1'],
+                  ['twitter', '>= 0.2.0'],
+                  ['user-choices', '>= 1.1.4'],
+                 ]
+  p.test_globs = "test/**/*tests.rb"
+  p.rdoc_pattern = %r{README.txt|History.txt|lib/gossip.rb|lib/gossip/.+\.rb}
+  p.url = "http://gossip.rubyforge.org"
+  p.remote_rdoc_dir = 'rdoc'
+end
+
+require 's4t-utils/rake-task-helpers'
+require 's4t-utils/os'
+
+def assert_in(dir, taskname)
+  unless Dir.pwd == dir
+    puts "Run task '#{taskname}' from directory '#{dir}'."
+    exit 1
+  end
+end
+
+def confirmed_step(name, required_dir = nil)
+  assert_in(required_dir, name) if required_dir
+  STDOUT.puts "** #{name} **"
+  STDOUT.puts `rake #{name}`
+  STDOUT.print 'OK? > '
+  exit if STDIN.readline =~ /[nN]/
+end
+
+class HoeLike
+  
+  def pull(key)
+    @keys[key] || raise("Missing key #{key.inspect}")
+  end
+  
+  def initialize(keys)
+    @keys = keys
+    project = pull(:project)
+    this_release = pull(:this_release)
+    login = pull(:login)
+    web_site_root = pull(:web_site_root)
+    export_root = pull(:export_root)
+    
+    root = "svn+ssh://#{login}/var/svn/#{project}"
+    project_exports = "#{export_root}/#{project}"
+    
+    desc "Run fast tests."
+    task 'fast' do
+      S4tUtils.run_particular_tests('test', 'fast')
+    end
+    
+    desc "Run slow tests."
+    task 'slow' do
+      S4tUtils.run_particular_tests('test', 'slow')
+    end
+    
+    desc "Upload all the web pages"
+    task 'upload_pages' do | task |
+      exec = "scp -r #{web_site_root}/* #{login}:/var/www/gforge-projects/#{project}/"
+      puts exec
+      system(exec)
+    end
+
+    desc "Tag release with current version."
+    task 'tag_release' do
+      from = "#{root}/trunk"
+      to = "#{root}/tags/rel-#{this_release}"
+      message = "Release #{this_release}"
+      exec = "svn copy -m '#{message}' #{from} #{to}"
+      puts exec
+      system(exec)
+    end
+    
+    desc "Export to #{project_exports}"
+    task 'export' do 
+      Dir.chdir(export_root) do
+        rm_rf project
+        exec = "svn export #{root}/trunk #{project}"
+        puts exec
+        system exec
+      end
+    end
+    
+
+    desc "Complete release of everything - asks for confirmation after steps"
+    # Because in Ruby 1.8.6, Rake doesn't notice subtask failures, so it
+    # won't stop for us.
+    task 'release_everything' do  
+      confirmed_step 'check_manifest'
+      confirmed_step 'test'
+      confirmed_step 'export'
+      Dir.chdir(project_exports) do
+        puts "Working in #{Dir.pwd}"
+        confirmed_step 'upload_pages', project_exports
+        confirmed_step 'publish_docs', project_exports
+        ENV['VERSION'] = this_release
+        confirmed_step 'release', project_exports
+      end
+      confirmed_step 'tag_release'
+    end
+
+  end
+
+end
+
+HoeLike.new(:project => PROJECT, :this_release => THIS_RELEASE,
+            :login => "marick@rubyforge.org",
+            :web_site_root => 'pages', 
+            :export_root => "#{S4tUtils.find_home}/tmp/exports")
+
+

data/examples/all-config-file-choices.yml

@@ -0,0 +1,36 @@
+# Turn cronies (destinations) on or off.
+
+standard-output: true
+jabber: false
+mail: false
+campfire: false
+trac: false
+twitter: false
+
+# Configurations for each destination. 
+# You can delete or ignore ones you don't plan to use. 
+
+jabber-account: jabber@example.com
+jabber-password: not-the-real-one
+jabber-to: 
+    - brianmarick@example.com
+    
+mail-to: 
+    - marick@example.com
+    - dawn@example.com
+
+mail-from: bmarick@mac.com
+mail-server: smtp.mac.com
+mail-port: 587
+mail-from-domain: localhost.localdomain
+mail-account: bmarick
+mail-password: not-the-real-one
+mail-authentication: login
+
+campfire-login: marick@example.com
+campfire-password: not-the-real-one
+campfire-subdomain: example
+campfire-room: room
+
+twitter-login: twittername
+twitter-password: some password

data/lib/gossip.rb

@@ -0,0 +1,32 @@
+#! /opt/local/bin/ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+
+require 's4t-utils'
+require 'active_support'  # because it includes its own copy of a gem
+                          # that user-choices would otherwise include.
+
+require 'gossip/social-universe'
+require 'gossip/preteen'
+require 'gossip/crony'
+require 'gossip/command'
+require 'gossip/multi-exceptions'
+require 'gossip/version'
+
+# Gossip is a library used to write scripts that collect useful information
+# and send it to various places (like jabber, email, trac, etc.). The 
+# guiding metaphor is of a Preteen who has Cronies. A Crony is someone who
+# might conceivably hear gossip from the Preteen. However, some cronies are
+# Best Friends Forever, and others are (temporarily) not speaking to the 
+# Preteen. Only the former hear the gossip.
+#
+# There's also a whole bunch of people who are not Cronies. We won't speak
+# of them. All we need know of them is that they can never ever receive
+# gossip because they can never ever become a Best Friend Forever.
+#
+# Most of the code in the script will be in a subclass of GossipCommand.
+# The execute method of that command gathers the information and passes
+# it to the Preteen.
+module Gossip
+end

data/lib/gossip/command.rb

@@ -0,0 +1,122 @@
+#! /opt/local/bin/ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'user-choices'
+require 'pp'
+require 'gossip/preteen'
+
+module Gossip
+  
+
+  # THe GossipCommand knows how to set up a Preteen's Crony's. A particular
+  # script should subclass it to add script-specific behavior. See the 
+  # examples, particularly fanout.rb, for details. To understand more about 
+  # GossipCommand, see UserChoices::Command in the user-choices gem.
+  # http://user-choices.rubyforge.org.
+  class GossipCommand < UserChoices::Command
+    include UserChoices
+    
+    attr_accessor :preteen
+    def initialize(preteen)
+      self.preteen = preteen
+      super()
+    end
+    
+    # Text describing the command-line arguments (not the options).
+    # Traditionally looks something like:
+    #    "Usage: ruby #{$0} [options] args..."
+    # Can be a single line or array of lines.
+    # Must be overridden. 
+    def usage; subclass_responsibility; end
+    
+    # Override to name the configuration file specific to this script.
+    def script_config_file; subclass_responsibility; end
+
+    def add_choices(builder)
+      first_set_are_specific_to_script(builder)
+      all_crony_switches_come_next(builder)
+      crony_specific_switches_are_third(builder)
+      helpful_switches_go_last(builder)
+      
+      # Can go anywhere - doesn't appear in help text.
+      add_arglist_choice(builder)
+    end
+    
+    
+    # By default, the command will stuff all arguments into 
+    # a choice named :arglist.
+    def add_arglist_choice(builder)
+      builder.add_choice(:arglist) { | command_line |
+        command_line.uses_arglist
+      }
+    end
+
+    def postprocess_user_choices
+      if @user_choices[:choices]
+        puts "Looking for configuration information in:"
+        puts "  " + File.join(S4tUtils.find_home, script_config_file)
+        puts "  " + File.join(S4tUtils.find_home, gossip_config_file)
+        puts "Choices gathered from all sources:"
+        puts alphabetical_symbol_hash(@user_choices)
+        exit
+      end
+
+      preteen.cronies.each do | crony |
+        crony.user_choices = @user_choices
+        crony.postprocess_user_choices
+      end
+    end
+    
+    def describe_all_but_options
+      [usage,
+      "Site-wide defaults are noted below.",
+      "Override them in the '#{script_config_file}' or '#{gossip_config_file}' files in your home folder."
+      ].flatten
+    end
+    
+    private
+    
+    def first_set_are_specific_to_script(builder)
+      if self.respond_to?(:add_choices_specific_to_script)
+        builder.section_specific_to_script do
+          add_choices_specific_to_script(builder)
+        end
+      end
+    end
+    
+    def all_crony_switches_come_next(builder)
+      builder.section("that determine who hears the gossip") do
+        preteen.cronies.each do | crony |
+          crony.add_bff_choice(builder)
+        end
+      end
+    end
+    
+    def crony_specific_switches_are_third(builder)
+      builder.section("that apply to particular listeners") do
+        preteen.cronies.each do | crony |
+          crony.add_configuration_choices(builder)
+        end
+      end
+    end
+    
+    def helpful_switches_go_last(builder)
+      builder.add_choice(:choices,
+                         :default => false,
+                         :type => :boolean) { | command_line |
+        command_line.uses_switch("--choices",
+                                 "Show all configuration choices.")
+      }
+    end
+    
+    def alphabetical_symbol_hash(hash)
+      key_strings = hash.keys.collect { |k| k.to_s }.sort
+      keys = key_strings.collect { |s| s.to_sym }
+      keys.collect do |key|
+        "  #{key.inspect}=>#{hash[key].inspect}"
+      end
+    end
+  end
+end