RubyGems - gossip - Versions diffs - 0.3.0 - Mend

gossip 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (63) hide show

data/History.txt +9 -0
data/LICENSE.txt +34 -0
data/Manifest.txt +62 -0
data/README.txt +6 -0
data/Rakefile +137 -0
data/examples/all-config-file-choices.yml +36 -0
data/lib/gossip.rb +32 -0
data/lib/gossip/command.rb +122 -0
data/lib/gossip/cronies/campfire.rb +72 -0
data/lib/gossip/cronies/jabber.rb +66 -0
data/lib/gossip/cronies/smtp.rb +121 -0
data/lib/gossip/cronies/stdout.rb +24 -0
data/lib/gossip/cronies/trac.rb +82 -0
data/lib/gossip/cronies/twitter.rb +50 -0
data/lib/gossip/crony.rb +102 -0
data/lib/gossip/multi-exceptions.rb +47 -0
data/lib/gossip/preteen.rb +86 -0
data/lib/gossip/site-config.rb +94 -0
data/lib/gossip/social-universe.rb +18 -0
data/lib/gossip/version.rb +8 -0
data/pages/classes.html +58 -0
data/pages/cronies.html +256 -0
data/pages/css/LICENSE.txt +1 -0
data/pages/css/Thumbs.db +0 -0
data/pages/css/bg2.gif +0 -0
data/pages/css/gossip5-header-flip.jpg +0 -0
data/pages/css/left.gif +0 -0
data/pages/css/left_on.gif +0 -0
data/pages/css/main.css +242 -0
data/pages/css/right.gif +0 -0
data/pages/css/right_on.gif +0 -0
data/pages/css/tvline.gif +0 -0
data/pages/images/campfire.png +0 -0
data/pages/images/classes.png +0 -0
data/pages/images/deployment.png +0 -0
data/pages/images/jabber-big.png +0 -0
data/pages/images/jabber.png +0 -0
data/pages/images/trac-bigger.png +0 -0
data/pages/images/trac-detail.png +0 -0
data/pages/images/twitter.png +0 -0
data/pages/index.html +45 -0
data/pages/installation.html +95 -0
data/pages/scripts.html +166 -0
data/pages/src/classes.graffle +0 -0
data/pages/starting-to-use.html +200 -0
data/pages/writing-new-scripts.html +38 -0
data/scripts/fanout +64 -0
data/scripts/svntell +71 -0
data/scripts/watchdog +86 -0
data/setup.rb +1585 -0
data/test/script/fanout-slowtests.rb +40 -0
data/test/script/svntell-slowtests.rb +40 -0
data/test/script/util.rb +22 -0
data/test/script/watchdog-slowtests.rb +56 -0
data/test/unit/command-crony-interaction-tests.rb +116 -0
data/test/unit/command-tests.rb +119 -0
data/test/unit/crony-tests.rb +46 -0
data/test/unit/multi-exception-tests.rb +70 -0
data/test/unit/preteen-tests.rb +81 -0
data/test/util/bff.rb +45 -0
data/test/util/doghouse.rb +42 -0
data/test/util/silly-little-test-program.rb +6 -0
metadata +181 -0

data/pages/src/classes.graffle ADDED

Binary file

data/pages/starting-to-use.html ADDED

@@ -0,0 +1,200 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+<title>Gossip</title>
+<meta http-equiv="Content-Type" content="application/xhtml+xml" />
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+<link rel="stylesheet" type="text/css" media="screen" href="css/main.css" />
+</head>
+<body>
+<div id="pageBody">
+<div id="outer-container">
+<div id="container">
+<div id="header">
+<div id="headerLeft"></div>
+<div id="headerRight"><h1>Gossip</h1><span class="highlight"><h2>tools for telling people things</h2></span></div>
+</div>
+<div id="headerNav">
+<div id="centerNav">
+  <ul>
+    <li><a href="index.html">Home</a></li>
+    <li><a href="installation.html">Installation</a></li>
+    <li id="current"><a href="starting-to-use.html">Using Bundled Scripts</a></li>
+    <li><a href="writing-new-scripts.html">Writing Scripts</a></li>
+    <li><a href="rdoc">RDoc</a></li>
+    <li><a href="http://rubyforge.org/frs/?group_id=4455">Download</a></li>
+  </ul>
+</div>
+</div>
+<div id="content">
+<div id="inlineTOC">
+  <ul>
+    <li><a href="starting-to-use.html">Getting started</a></li>
+    <ul>
+      <li><a href="starting-to-use.html#definitions">Three important words</a></li>
+      <li><a href="starting-to-use.html#config">Your own private configuration</a></li>
+    </ul>
+    <li><a href="cronies.html">All cronies</a></li>
+    <ul>
+      <li><a href="cronies.html#campfire">campfire</a></li>
+      <li><a href="cronies.html#jabber">jabber</a></li>
+      <li><a href="cronies.html#mail">mail</a></li>
+      <li><a href="cronies.html#stdout">standard output</a></li>
+      <li><a href="cronies.html#trac">trac</a></li>
+      <li><a href="cronies.html#twitter">twitter</a></li>
+    </ul>
+    <li><a href="scripts.html">All scripts</a></li>
+    <ul>
+      <li><a href="scripts.html#fanout">fanout: broadcast a message</a></li>
+      <li><a href="scripts.html#watchdog">watchdog: report on a script</a></li>
+      <li><a href="scripts.html#svntell">svntell: Subversion post-commit</a></li>
+    </ul>
+  </ul>
+</div>
+<h2><a name="definitions">Three important words</a></h2>
+<p>
+All of the scripts do two things: they <em>learn</em> a <strong>scandal</strong> and its <strong>details</strong> from somewhere, then they <em>send</em> what they've learned to one or more <strong>cronies</strong>. Decoding the cutesy metaphor:
+</p>
+<ul>
+  <li>
+  <p>
+  A <strong>scandal</strong> is a short piece of text, like the Subject line of an email message.
+  </p>
+  </li>
+  <li>
+  <p>
+  The <strong>details</strong> are, usually, a longer piece of text, like the body of an email message. The distinction is important because some cronies, like Twitter, only get the scandal and not the details.
+  </p>
+  </li>
+  <li>
+  <p>
+  <strong>Cronies</strong> represent a destination for the information. Cronies can be sites like <a href="http://twitter.com">Twitter</a> or <a href="http://www.campfirenow.com">Campfire</a>, or they can be programs like email or <a href="http://jabber.org">Jabber</a>.
+  </p>
+  </li>
+</ul>
+<h2><a name="config">Your own private configuration</a></h2>
+<p>
+Unless someone's already done it for you, there's a little work to do before you can use one of the Gossip scripts. You have to tell them where, by default, their messages should go. You <em>can</em> give all that information on the command line, but you likely don't want to. Instead, you want to put it in a configuration file.
+</p>
+<p>
+The main Gossip configuration file is named <code>.gossip</code> (note the leading period) in your home directory. The home directory is defined as being whatever <a href="http://www.rubygems.org/read/chapter/12">RubyGems thinks
+</a> it is. Entries in the configuration file apply to all Gossip scripts. You can override them with a script-specific configuration file. (You don't have to: you can put even script-specific configuration entries in <code>.gossip</code>.)
+</p>
+<p>Here is a sample configuration file, valid as of this writing. You can find the latest version in <code>examples/all-config-file-choices.yml</code> in the distribution. The file is in <a href="http://www.yaml.org/" title="YAML Ain't Markup Language">YAML</a> format.
+</p>
+<pre>
+	# 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
+				</pre>
+<p>
+With luck, the names alone are enough for you to know what values to use. If not, <a href="cronies.html">look here</a> or ask for command-line help:
+</p>
+<pre>
+	$ scripts/fanout --help
+	Usage: ruby scripts/fanout [options] program args...
+	Site-wide defaults are noted below.
+	Override them in the '.fanoutrc' or '.gossiprc' files in your home folder.
+	Options:
+	        --[no-]choices               Show all configuration choices.
+	    -s, --[no-]standard-output       Control display to terminal (standard output).
+	                                     Defaults to true.
+	    -m, --[no-]mail                  Control mail notification.
+	                                     Defaults to false.
+	    -j, --[no-]jabber                Control IM notification.
+	                                     Defaults to false.
+	    -c, --[no-]campfire              Control display to Campfire chat room.
+	                                     Defaults to false.
+	    -t, --[no-]twitter               Control whether Twitter updates are made.
+	                                     Defaults to false.
+	        --mail-to RECIPIENTS         <strong>Recipients of mail.</strong>
+	                                     This can be a comma-separated list.
+	                                     Defaults to ["listener@example.com"].
+	        --mail-from SENDER           <strong>The sender of the mail (appears in From line).</strong>
+	                                     Defaults to "watchdog@example.com".
+	        --mail-server HOSTNAME       <strong>SMTP server.</strong> Defaults to "example.com".
+	        --mail-port NUMBER           <strong>Mail port on that server.</strong>
+	                                     Defaults to 25.
+	<em>...</em>
+				</pre>
+<p>If you make a typo in the configuration file, Gossip will not complain. So it's useful to use the <code>--choices</code> argument to see that it's gotten the values you want:</p>
+<pre>
+	$ scripts/fanout --choices
+	Looking for configuration information in:
+	  /Users/marick/.fanoutrc
+	  /Users/marick/.gossiprc
+	Choices gathered from all sources:
+	  :arglist=>[]
+	  :campfire=>false
+	  :campfire_login=>"marick@example.com"
+	  :campfire_password=>"not the real one"
+	  :campfire_room=>"room"
+	  :campfire_subdomain=>"example"
+	  :choices=>true
+	  :jabber=>false
+	  :jabber_account=>"something@jabber.com"
+	  :jabber_password=>"not the real one"
+	  :jabber_to=>["brianmarick@jabber.se"]
+	  ...
+</pre>
+<p>
+You can always override the configuration file from the command line.
+</p>
+<p style="text-align: center">
+	<a href="cronies.html">Next</a>: All cronies<br />
+	<a href="scripts.html">After that</a>: All scripts<br />
+</p>
+</div>
+</div>
+</div>
+</body>
+</html>

data/pages/writing-new-scripts.html ADDED

@@ -0,0 +1,38 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+	<head>
+		<title>Gossip</title>
+		<meta http-equiv="Content-Type" content="application/xhtml+xml" />
+		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+		<link rel="stylesheet" type="text/css" media="screen" href="css/main.css" />
+	</head>
+	<body>
+	<div id="pageBody">
+		<div id="outer-container">
+			<div id="container">
+			<div id="header">
+				<div id="headerLeft"></div>
+				<div id="headerRight"><h1>Gossip</h1><span class="highlight"><h2>tools for telling people things</h2></span></div>
+			</div>
+			<div id="headerNav">
+					<div id="centerNav">
+					<ul>
+							<li><a href="index.html">Home</a></li>
+							<li><a href="installation.html">Installation</a></li>
+							<li><a href="starting-to-use.html">Using Bundled Scripts</a></li>
+							<li id="current"><a href="writing-new-scripts.html">Writing Scripts</a></li>
+							<li><a href="rdoc">RDoc</a></li>
+							<li><a href="http://rubyforge.org/frs/?group_id=4455">Download</a></li>
+					</ul>
+					</div>
+			</div>
+			<div id="content">
+				<h2>Writing new scripts</h2>
+				<p>There is nothing here yet. You might find an <a href="classes.html">annotated picture of the important classes helpful</a>.
+			</div>
+		</div>
+	</div>
+	</body>
+</html>

data/scripts/fanout ADDED

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+require 's4t-utils'
+include S4tUtils
+set_script_lib_path(__FILE__)
+require 'gossip'
+include Gossip
+# You may want to replace this. See the installation documentation.
+require 'gossip/site-config'
+class Fanout < GossipCommand
+  def script_config_file; ".fanoutrc"; end
+  def usage
+    ["Usage: ruby #{$0} arg... < details",
+    "The arguments are the scandal to gossip about."]
+  end
+  FANOUT_DEFAULT = true
+  def add_choices_specific_to_script(builder)
+    builder.add_choice(:fanout_details,
+                       :type => :boolean,
+                       :default => FANOUT_DEFAULT) { | command_line |
+      command_line.uses_switch("--details",
+                               "Collect details from standard input?",
+                               "Defaults to #{FANOUT_DEFAULT}.",
+                               "If false, standard input is not read.")
+    }
+  end
+  def postprocess_user_choices
+    super
+    # This is checked here, instead of giving a range to uses_arglist,
+    # so that the actual choices can be printed out with -c without
+    # having to give an argument.
+    if @user_choices.has_key?(:arglist) && @user_choices[:arglist].empty?
+      raise "You need to give some sort of summary on the command line."
+    end
+  end
+  def execute
+    scandal = @user_choices[:arglist].join(' ')
+    details = @user_choices[:fanout_details] ? $stdin.read : ''
+    preteen.tell_bffs(scandal, details)
+  end
+end
+if $0 == __FILE__
+  # You can replace "with" with "without" to get full stack traces.
+  with_pleasant_exceptions do
+    Fanout.new(Preteen.new(CronyMaker, BFFS, ON_THE_OUTS)).execute
+  end
+end

data/scripts/svntell ADDED

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+require 's4t-utils'
+include S4tUtils
+set_script_lib_path(__FILE__)
+require 'gossip'
+include Gossip
+# You may want to replace this. See the installation documentation.
+require 'gossip/site-config'
+BFFS.delete(:trac) # Don't use this to post svn logs - trac does that better already.
+require 'snitch'
+class SvnTell < GossipCommand
+  def script_config_file; ".svntellrc"; end
+  def usage
+    "Usage: ruby #{$0} --repository PATH --revision REV"
+  end
+  def add_choices_specific_to_script(builder)
+    builder.add_choice(:svn_repository) { | command_line |
+      command_line.uses_option("--repository REP",
+                               "Absolute path of subversion repository.")
+    }
+    builder.add_choice(:svn_revision) { | command_line |
+      command_line.uses_option("--revision REV",
+                               "Revision number of interest.")
+    }
+    svnlook_default = "/usr/bin/svnlook"
+    builder.add_choice(:svnlook_path,
+                       :default => svnlook_default) { | command_line |
+      command_line.uses_option("--svnlook-path PATH",
+                               "Absolute path of svnlook(1).",
+                               "Default is #{svnlook_default}.")
+    }
+  end
+  def execute
+    repository = @user_choices[:svn_repository]
+    revision = @user_choices[:svn_revision]
+    svnlook_path = @user_choices[:svnlook_path]
+    user_claims(repository) { "You must choose a repository."}
+    user_claims(revision) { "You must choose a revision."}
+    user_claims(File.exists?(svnlook_path)) {
+      "svnlook path '#{svnlook_path}' does not exist."
+    }
+    svnlook = Snitch::SvnLook.new(repository, revision, svnlook_path)
+    preteen.tell_bffs("Commit by #{svnlook.author}", svnlook.to_s)
+  end
+end
+if $0 == __FILE__
+  # You can replace "with" with "without" to get full stack traces.
+  with_pleasant_exceptions do
+    SvnTell.new(Preteen.new(CronyMaker, BFFS, ON_THE_OUTS)).execute
+  end
+end

data/scripts/watchdog ADDED

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+require 's4t-utils'
+include S4tUtils
+set_script_lib_path(__FILE__)
+require 'gossip'
+include Gossip
+require 'open3'
+# You may want to replace this. See the installation documentation.
+require 'gossip/site-config'
+class Watchdog < GossipCommand
+  def usage
+    "Usage: ruby #{$0} [options] program args..."
+  end
+  def script_config_file; '.watchdogrc'; end
+  def postprocess_user_choices
+    super
+    # This is checked here, instead of giving a range to uses_arglist,
+    # so that the actual choices can be printed out with -c without
+    # having to give an argument.
+    if @user_choices.has_key?(:arglist) && @user_choices[:arglist].empty?
+      raise "No command to run was given."
+    end
+  end
+  def execute
+    scandal = "Program #{self.command_name} finished."
+    duration, details = time {
+      `#{self.command_string} 2>&1`
+    }
+    preteen.tell_bffs(scandal, message(duration, details))
+  end
+  # Only tests should call from outside.
+  def time
+    start = Time.now
+    retval = yield
+    duration = Time.now - start
+    [duration, retval]
+  end
+  def command_string(command_to_watch =
+                       @user_choices[:arglist])
+    command_to_watch.join(' ')
+  end
+  def command_name(command_to_watch = @user_choices[:arglist])
+    progname = if command_to_watch[0] == 'ruby'
+                 command_to_watch[1]
+               else
+                 command_to_watch[0]
+               end
+    File.basename(progname)
+  end
+  def message(duration, text)
+    [
+      "Duration: #{duration} seconds.",
+      "Command: #{command_string}",
+      "Output:",
+      text.indent_by(2),
+    ].join($/)
+  end
+end
+if $0 == __FILE__
+  # You can replace "with" with "without" to get full stack traces.
+  with_pleasant_exceptions do
+    Watchdog.new(Preteen.new(CronyMaker, BFFS, ON_THE_OUTS)).execute
+  end
+end