gossip 0.3.0

data/lib/gossip/cronies/campfire.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-16.
+#  Copyright (c) 2007. All rights reserved.
+
+
+require 'tinder'
+require 'gossip/crony'
+
+
+module Gossip
+  
+  # CampfireCrony adds a notice to a Campfire (http://www.campfirenow.com)
+  # chat room.
+  class CampfireCrony < Crony
+
+    def name; "campfire"; end
+    def symbol; :campfire; end
+
+    def command_line_description
+        ["-c", "--campfire",
+         "Control display to Campfire chat room.",
+         "Defaults to #{is_bff_by_default?}."]
+    end
+    
+    def add_configuration_choices(builder)
+      builder.add_choice(:campfire_login,
+                         :default => checked(:default_login)) { | command_line |
+        command_line.uses_option("--campfire-login LOGIN", 
+                                 "Your Campfire login, an email address",
+                                 df(:default_login)
+                                 )
+      }
+      
+      builder.add_choice(:campfire_password,
+                         :default => checked(:default_password)) { | command_line |
+        command_line.uses_option("--campfire-password PASSWORD", 
+                                 "Your Campfire password.",
+                                 df(:default_password)
+                                 )
+      }
+      
+      builder.add_choice(:campfire_subdomain,
+                         :default => checked(:default_subdomain)) { | command_line |
+        command_line.uses_option("--campfire-subdomain NAME", 
+                                 "Your Campfire subdomain.",
+                                 "(As in 'subdomain.campfire.com')",
+                                 df(:default_subdomain)
+                                 )
+      }
+      
+      builder.add_choice(:campfire_room,
+                         :default => checked(:default_room)) { | command_line |
+        command_line.uses_option("--campfire-room NAME", 
+                                 "A campfire room to receive the message.",
+                                 df(:default_room)
+                                 )
+      }
+      
+    end
+
+    def hear(scandal, details)
+      connection = Tinder::Campfire.new(@user_choices[:campfire_subdomain])
+      connection.login(@user_choices[:campfire_login], @user_choices[:campfire_password])
+      raise StandardError, "Login to Campfire failed." unless connection.logged_in?
+      room = connection.find_room_by_name(@user_choices[:campfire_room])
+      room.paste([scandal, details].join("\n"))
+      connection.logout
+    end
+
+  end
+end

data/lib/gossip/cronies/jabber.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'xmpp4r'
+require 'gossip/crony'
+
+module Gossip
+  class JabberCrony < Crony
+    include Jabber
+
+    def name; "jabber"; end
+    def symbol; :jabber; end
+
+    def command_line_description
+        ['-j', "--jabber",
+         "Control IM notification.",
+         "Defaults to #{is_bff_by_default?}."]
+    end
+
+    def add_configuration_choices(builder)
+      builder.add_choice(:jabber_to,
+                         :default => checked(:default_to),
+                         :type => [:string]) { | command_line |
+        command_line.uses_option("--jabber-to RECIPIENTS",
+                                 "Recipients of Jabber instant messages.",
+                                 "This can be a comma-separated list.",
+                                 df(:default_to)
+                                 )
+      }
+
+      builder.add_choice(:jabber_account,
+                         :default => checked(:default_account)) { | command_line |
+        command_line.uses_option("--jabber-account SENDER", 
+                                 "Your Jabber account.",
+                                 "Note that this includes the Jabber server.",
+                                 df(:default_account)
+                                 )
+      }
+
+      builder.add_choice(:jabber_password,
+                         :default => checked(:default_password)) { | command_line |
+        command_line.uses_option("--jabber-password PASSWORD", 
+                                 "Your Jabber password.",
+                                 df(:default_password)
+                                 )
+      }
+    end
+    
+    def hear(scandal, details)
+      my_jid = JID.new(@user_choices[:jabber_account])
+      cl = Client.new(my_jid, false)
+      cl.connect
+      cl.auth(@user_choices[:jabber_password])
+      details = [scandal, details].join("\n")
+      @user_choices[:jabber_to].each do | recipient | 
+        m = Message::new(recipient, details).
+          set_type(:normal).set_id('1').set_subject(scandal)
+        cl.send(m)
+      end
+      cl.close
+    end
+
+  end
+end

data/lib/gossip/cronies/smtp.rb

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'net/smtp'
+
+module Gossip
+  
+  # This Crony sends email.
+  class SmtpCrony < Crony
+
+    def name; 'mail'; end
+    def symbol; :mail; end
+    
+    def command_line_description
+      ['-m', "--mail",
+       "Control mail notification.",
+       "Defaults to #{is_bff_by_default?}."]
+    end
+    
+    def add_configuration_choices(builder)
+      builder.add_choice(:mail_to,
+                         :default => checked(:default_to),
+                         :type => [:string]) { | command_line |
+        command_line.uses_option("--mail-to RECIPIENTS",
+                                 "Recipients of mail.",
+                                 "This can be a comma-separated list.",
+                                 df(:default_to)
+                                 )
+      }
+
+      builder.add_choice(:mail_from,
+                         :default => checked(:default_from)) { | command_line |
+        command_line.uses_option("--mail-from SENDER", 
+                                 "The sender of the mail (appears in From line).",
+                                 df(:default_from)
+                                 )
+      }
+
+      builder.add_choice(:mail_server,
+                         :default => checked(:default_smtp_server)) { | command_line |
+        command_line.uses_option("--mail-server HOSTNAME", 
+                                 "SMTP server. #{df(:default_smtp_server)}"
+                                 )
+      }
+
+      builder.add_choice(:mail_port,
+                         :type => :integer,
+                         :default => checked(:default_smtp_port)) { | command_line |
+        command_line.uses_option("--mail-port NUMBER", 
+                                 "Mail port on that server.",
+                                 df(:default_smtp_port)
+                                 )
+      }
+
+      builder.add_choice(:mail_account,
+                         :default => checked(:default_smtp_account)) { | command_line |
+        command_line.uses_option("--mail-account USERNAME", 
+                                 "Your account name on the SMTP server.",
+                                 df(:default_smtp_account)
+                                 )
+      }
+
+      builder.add_choice(:mail_from_domain,
+                         :default => checked(:default_from_domain)) { | command_line |
+        command_line.uses_option("--mail-from-domain HOSTNAME", 
+                                 "The server the mail supposedly comes from.",
+                                 "(Not necessarily the SMTP server.)",
+                                 df(:default_from_domain)
+                                 )
+      }
+
+      builder.add_choice(:mail_password,
+                         :default => checked(:default_smtp_password)) { | command_line |
+        command_line.uses_option("--mail-password HOSTNAME", 
+                                 "Your password on the SMTP server.",
+                                 df(:default_smtp_password)
+                                 )
+      }
+
+      auth_types = ['plain', 'login', 'cram_md5']
+      builder.add_choice(:mail_authentication,
+                         :type => auth_types,
+                         :default => checked(:default_smtp_authentication)) { | command_line |
+        command_line.uses_option("--mail-authentication TYPE",
+                                 "The kind of authentication your SMTP server uses.",
+                                 "One of #{friendly_list('or', auth_types)}.",
+                                 df(:default_smtp_authentication)
+                                 )
+      }
+    end
+    
+    def postprocess_user_choices
+      @user_choices[:mail_authentication] =
+        @user_choices[:mail_authentication].to_sym
+    end
+    
+    def hear(scandal, details)
+      from = @user_choices[:mail_from]
+      to = @user_choices[:mail_to]
+      Net::SMTP.start(@user_choices[:mail_server], @user_choices[:mail_port],
+                      @user_choices[:mail_from_domain],
+                      @user_choices[:mail_account],
+                      @user_choices[:mail_password],
+                      @user_choices[:mail_authentication]) { | smtp |
+        mail = "
+                . From: #{from}
+                . To: #{to.join(', ')}
+                . Subject: [watchdog] #{scandal}
+                .
+                . #{details}
+               ".without_pretty_margin('.')
+        smtp.send_message(mail, from, to)
+      }
+    end
+  end
+
+  
+  
+end

data/lib/gossip/cronies/stdout.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'gossip/crony'
+
+module Gossip
+  class StdoutCrony < Crony
+    def name; "terminal"; end
+    def symbol; :standard_output; end
+    
+    def command_line_description
+      ["-s", "--standard-output",
+       "Control display to terminal (standard output).",
+       "Defaults to #{is_bff_by_default?}."]
+    end
+    
+    def hear(scandal, details)
+      all = [scandal, details].join($/)
+      puts all.indent_by(2)
+    end
+  end
+end

data/lib/gossip/cronies/trac.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-19.
+#  Copyright (c) 2007. All rights reserved.
+
+
+require 'gossip/crony'
+
+
+module Gossip
+  # Right now, TracCrony is kind of a hack. It uses trac-admin(1) to 
+  # edit a wiki page. If configured to do so, Trac will add wiki changes
+  # into the Timeline. OK, it's more than "kind of" a hack.
+  #
+  # Note that you must be running a command that uses a Trac crony on
+  # the Trac server itself.
+  #
+  # An alternative would be to use Mechanize. This was easier for now.
+  class TracCrony < Crony
+
+    def name; "trac"; end
+    def symbol; :trac; end
+
+    def command_line_description
+        ["-T", "--trac",
+         "Control display to Trac timeline.",
+         "Defaults to #{is_bff_by_default?}."]
+    end
+    
+    def add_configuration_choices(builder)
+      builder.add_choice(:trac_admin_path,
+                         :default => checked(:default_trac_admin_path)) { | command_line |
+        command_line.uses_option("--trac-admin-path PATH", 
+                                 "Absolute pathname to trac-admin(1).",
+                                 df(:default_trac_admin_path)
+                                 )
+      }
+      
+      builder.add_choice(:trac_environment_path,
+                         :default => checked(:default_environment_path)) { | command_line |
+        command_line.uses_option("--trac-environment-path PATH", 
+                                 "Your Trac environment.",
+                                 df(:default_environment_path)
+                                 )
+      }
+      
+      builder.add_choice(:trac_page_name,
+                         :default => checked(:default_page_name)) { | command_line |
+        command_line.uses_option("--trac-page-name PAGE", 
+                                 "A Trac wiki page to receive the message.",
+                                 df(:default_page_name)
+                                 )
+      }
+      
+      builder.add_choice(:trac_content_file,
+                         :default => checked(:default_content_file)) { | command_line |
+        command_line.uses_option("--trac-content-file FILE", 
+                                 "A file to use as the content of the page.",
+                                 df(:default_content_file)
+                                 )
+      }
+      
+    end
+
+    def hear(scandal, details)
+      trac_admin = @user_choices[:trac_admin_path]
+      env = @user_choices[:trac_environment_path]
+      page = @user_choices[:trac_page_name]
+      file = @user_choices[:trac_content_file]
+      current = File.exist?(file) ? File.read(file) : ""
+      File.open(file, "w") do | io |
+        io.puts(scandal)
+        io.puts(details.gsub(/$/, '[[BR]]'))
+        io.puts('---------------')
+        io.puts current
+      end
+      exec = "#{trac_admin} #{env} wiki import #{page} #{file}"
+      `#{exec}`
+    end
+
+  end
+end

data/lib/gossip/cronies/twitter.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-24.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'twitter'
+require 'gossip/crony'
+
+
+module Gossip
+  
+  # TwitterCrony updates Twitter (http://www.twitter.com) status. Note: 
+  # only the text of the scandal is used, not the details.
+  class TwitterCrony < Crony
+
+    def name; "twitter"; end
+    def symbol; :twitter; end
+
+    def command_line_description
+        ["-t", "--twitter",
+         "Control whether Twitter updates are made.",
+         "Defaults to #{is_bff_by_default?}."]
+    end
+    
+    def add_configuration_choices(builder)
+      builder.add_choice(:twitter_login,
+                         :default => checked(:default_login)) { | command_line |
+        command_line.uses_option("--twitter-login LOGIN", 
+                                 "Your Twitter login",
+                                 df(:default_login)
+                                 )
+      }
+      
+      builder.add_choice(:twitter_password,
+                         :default => checked(:default_password)) { | command_line |
+        command_line.uses_option("--twitter-password PASSWORD", 
+                                 "Your Twitter password.",
+                                 df(:default_password)
+                                 )
+      }
+      
+    end
+
+    def hear(scandal, details)
+      twit = Twitter::Base.new(@user_choices[:twitter_login], @user_choices[:twitter_password])
+      twit.update(scandal)
+    end
+
+  end
+end

data/lib/gossip/crony.rb

@@ -0,0 +1,102 @@
+#! /opt/local/bin/ruby
+#
+#  Created by Brian Marick on 2007-09-15.
+#  Copyright (c) 2007. All rights reserved.
+
+module Gossip
+  
+  # This is the base class for the different Crony objects that the Preteen
+  # gossips with. A Crony object is something like mail, Twitter, Jabber, or 
+  # anything that can accept a message and do something useful with it.
+  #
+  # To understand Crony, you should first understand GossipCommand and 
+  # Preteen. It's helpful to understand the user-choices gem:
+  # http://http://user-choices.rubyforge.org
+  class Crony
+    
+    # Each Crony will require some information like an account name, a 
+    # password, etc. Those can be specified by the user. If not, these 
+    # values are used. By convention, the keys in the hash begin with 
+    # :default_. So not override initialize; the work is done elsewhere.
+    def initialize(defaults = {})
+      @defaults = defaults
+    end
+    
+    # This does the work of accepting a message and doing something useful
+    # with it. Must be overridden. The _scandal_ is a short description. 
+    # Some types of Crony (such as twitter) pay attention only to it, and 
+    # ignore the _details_.
+    def hear(scandal, details) 
+      subclass_responsibility
+    end
+
+    # This method returns a string identifying the Crony. It is used 
+    # in error messages. Must be overridden.
+    def name
+      subclass_responsibility
+    end
+
+    # This symbol identifies the crony within Ruby code. Must be overridden.
+    def symbol
+      subclass_responsibility
+    end
+
+    # There is a single configuration choice used to include the Crony in the
+    # gossip or exclude her. This method returns an array of strings describing
+    # that option. It should be in the format used by OptionParser (optparse).
+    # Must be overridden.
+    def command_line_description
+      subclass_responsibility
+    end
+
+    # This method describes how the user can control the Crony's behavior
+    # in a config file or on the command-line. This method is called from
+    # UserChoices::Command#add_choices; see its documentation (in the 
+    # user-choices gem). Or look at subclasses for examples.
+    # 
+    # Don't bother overriding this if there are no configuration choices.  
+    def add_configuration_choices(builder)
+    end
+    
+    # This method is called from UserChoices::Command::postprocess_user_choices.
+    # See the documentation for the user-choices gem.
+    def postprocess_user_choices
+    end
+    
+    attr_writer :is_bff_by_default, :user_choices # :nodoc:
+    
+    # By default, will this Crony be told gossip?
+    def is_bff_by_default?; @is_bff_by_default; end
+    
+    # Is this Crony, at this moment, a Best Friend Forever who will be 
+    # told gossip by the Preteen? (is_bff_by_default? is used to find the 
+    # starting value of this boolean.)
+    def is_bff?
+      @user_choices[symbol]
+    end
+
+    def add_bff_choice(builder) # :nodoc:
+      builder.add_choice(self.symbol,
+                         :type => :boolean,
+                         :default => is_bff_by_default?) { | command_line |
+        command_line.uses_switch(*command_line_description)
+      }
+    end
+    
+    def checked(symbol) # :nodoc: 
+      prog1(@defaults[symbol]) do | value | 
+        if value.nil?
+          raise StandardError, 
+                "#{symbol.inspect} is nil for #{name} - likely a typo in a configuration file.\n" +
+                @defaults.inspect
+        end
+      end
+    end
+    
+    def df(symbol) # :nodoc: 
+      "Defaults to #{checked(symbol).inspect}."
+    end
+  end
+  
+end
+