switchboard 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2009-07-08
+
+* Initial RubyForge release (Seth)

data/README.markdown

@@ -0,0 +1,59 @@
+# Switchboard 
+
+Switchboard is both a toolkit for assembling XMPP clients as well as a set of
+command-line tools for interacting with XMPP servers.
+
+## Getting Started
+
+Install it:
+
+    $ sudo gem install mojodna-switchboard -s http://gems.github.com
+
+Install optional dependencies for additional functionality.
+
+OAuth PubSub support:
+
+    $ sudo gem install oauth
+
+User Location (XEP-0080) support via Fire Eagle:
+
+    $ sudo gem install mojodna-fire-hydrant -s http://gems.github.com
+
+_Note: you will need to set up a PubSub subscription to your location via Fire
+Eagle for this to work._
+
+User Tune (XEP-0118) support via iTunes (on Mac OS X):
+
+    $ sudo gem install rb-appscript
+
+Configure it:
+
+    $ switchboard config jid jid@example.com
+    $ switchboard config password pa55word
+
+_Settings will be stored in `$HOME/.switchboardrc`_
+
+Run it:
+
+    $ switchboard <command> <args>
+    $ switchboard roster list
+    $ switchboard roster add fireeagle.com
+    $ ...
+
+Subscribe to a node using OAuth, overriding default settings:
+
+    $ switchboard --jid subscriber@example.com --password pa55word \
+        pubsub --oauth \
+        --oauth-consumer-key <consumer key> \
+        --oauth-consumer-secret <consumer secret> \
+        --oauth-token <token> \
+        --oauth-token-secret <token secret> \
+        --server fireeagle.com \
+        --node "/api/0.1/user/<token>" \
+        subscribe
+
+Publish iTunes' current track using User Tune (XEP-0118):
+
+    $ switchboard --resource switchtunes pep tune
+
+_You can do this using a JID that is already online._

data/Rakefile

@@ -0,0 +1,30 @@
+require File.join("lib", "switchboard", "version")
+
+desc "Generate the gemspec"
+task :gemspec do
+  gemspec =<<-EOF
+# this file is automatically generated
+Gem::Specification.new do |s|
+  s.name = "switchboard"
+  s.version = "#{Switchboard::VERSION * "."}"
+  s.summary = "XMPP toolkit."
+  s.description = "A toolkit for assembling XMPP clients and interacting with XMPP servers."
+  s.authors = ["Seth Fitzsimmons"]
+  s.email = ["seth@mojodna.net"]
+
+  s.files = #{Dir.glob("**/*").select { |f| File.file?(f) }.inspect}
+  s.executables = ["switchboard"]
+  s.require_paths = ["lib"]
+
+  s.add_dependency("xmpp4r", ">=", "0.5")
+end
+  EOF
+
+  open("switchboard.gemspec", "w") do |f|
+    f << gemspec
+  end
+
+  puts "gemspec successfully created."
+end
+
+task :default => :gemspec

data/bin/switchboard

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'switchboard'
+require 'switchboard/commands'
+require 'optparse'
+
+ARGV.clone.options do |opts|
+  # opts.banner = "Usage: example.rb [options]"
+
+  command = Switchboard::Commands::Default
+  command.options(opts)
+
+  cmd = []
+  argv = []
+
+  # force optparse into being a command parser
+  opts.order! do |arg|
+    cmd << arg
+
+    if c = Switchboard::COMMANDS[cmd * "_"]
+      command = c
+      command.options(opts)
+    elsif c = Switchboard::COMMANDS["_" + cmd * "_"]
+      command = c
+    else
+      # unrecognized, unclaimed argument; keep as ARGV
+      argv << arg
+    end
+  end
+
+  # correct ARGV to match unrecognized, unclaimed arguments
+  ARGV.reject! { |v| !argv.include?(v) }
+
+  command
+end.run!

data/examples/echo_bot.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby -rubygems
+
+require 'switchboard'
+
+switchboard = Switchboard::Client.new
+switchboard.plug!(AutoAcceptJack, EchoJack, NotifyJack)
+switchboard.run!

data/lib/switchboard.rb

@@ -0,0 +1 @@
+require 'switchboard/switchboard'

data/lib/switchboard/client.rb

@@ -0,0 +1,92 @@
+module Switchboard
+  class Client < Core
+    attr_reader :client, :roster
+
+    def initialize(settings = Switchboard::Settings.new, spin = true)
+      super(settings, spin)
+
+      # TODO jid may already have a resource, so account for that
+      @client = Jabber::Client.new([settings["jid"], settings["resource"]] * "/")
+
+      on_stream_connected do
+        register_roster_callbacks
+
+        # tell others that we're online
+        presence
+
+        defer :roster_loaded do
+          # wait for the roster to load
+          roster.wait_for_roster
+
+          # roster has now been loaded
+          on(:roster_loaded)
+        end
+      end
+    end
+
+    hook \
+      :roster_presence, :roster_query, :roster_subscription,
+      :roster_subscription_request, :roster_loaded, :roster_update
+
+  protected
+
+    def auth!
+      client.auth(settings["password"])
+      @roster = Jabber::Roster::Helper.new(client)
+    rescue Jabber::ClientAuthenticationFailure => e
+      puts "Could not authenticate as #{settings["jid"]}"
+      shutdown(false)
+      exit 1
+    end
+
+    def connect!
+      client.connect
+      auth!
+    end
+
+    def disconnect!
+      presence(:unavailable)
+      super
+    end
+
+    def presence(status = nil, to = nil)
+      presence = Jabber::Presence.new(nil, status)
+      presence.to = to
+      client.send(presence)
+    end
+
+    def register_roster_callbacks
+      # presence from someone on my roster
+      roster.add_presence_callback do |item, old_presence, new_presence|
+        on(:roster_presence, item, old_presence, new_presence)
+      end
+
+      # roster query completed (rarely used)
+      roster.add_query_callback do |query|
+        on(:roster_query, query)
+      end
+
+      # roster subscription
+      roster.add_subscription_callback do |item, presence|
+        # confirmation that we were able to subscribe to someone else
+        on(:roster_subscription, item, presence)
+      end
+
+      roster.add_subscription_request_callback do |item, presence|
+        # someone wants to subscribe to me!
+        on(:roster_subscription_request, item, presence)
+      end
+
+      # roster was updated (rarely used)
+      roster.add_update_callback do |old_item, new_item|
+        # roster has been updated; don't care
+        # puts "update: #{old_item.inspect}, #{new_item.inspect}"
+        on(:roster_update, old_item, new_item)
+      end
+    end
+
+    def stream
+      client
+    end
+  end
+end

data/lib/switchboard/colors.rb

@@ -0,0 +1,10 @@
+class String
+  def red; colorize(self, "\e[1m\e[31m"); end
+  def green; colorize(self, "\e[1m\e[32m"); end
+  def dark_green; colorize(self, "\e[32m"); end
+  def yellow; colorize(self, "\e[1m\e[33m"); end
+  def blue; colorize(self, "\e[1m\e[34m"); end
+  def dark_blue; colorize(self, "\e[34m"); end
+  def purple; colorize(self, "\e[1m\e[35m"); end
+  def colorize(text, color_code)  "#{color_code}#{text}\e[0m" end
+end

data/lib/switchboard/commands.rb

@@ -0,0 +1,12 @@
+require 'switchboard/commands/command'
+require 'switchboard/commands/config'
+require 'switchboard/commands/default'
+require 'switchboard/commands/disco'
+require 'switchboard/commands/grep'
+require 'switchboard/commands/help'
+require 'switchboard/commands/last'
+require 'switchboard/commands/pep'
+require 'switchboard/commands/pubsub'
+require 'switchboard/commands/register'
+require 'switchboard/commands/roster'
+require 'switchboard/commands/unregister'

data/lib/switchboard/commands/command.rb

@@ -0,0 +1,85 @@
+module Switchboard
+  COMMANDS = {}
+
+  def self.commands(command = nil)
+    if command
+      COMMANDS.select { |k,v| k =~ /^#{command.to_command_name("_")}_/ }
+    else
+      COMMANDS.reject { |k,v| k =~ /_/ }
+    end
+  end
+
+  def self.hide_command(command)
+    COMMANDS["_#{command.to_command_name("_")}"] = unregister_command(command)
+  end
+
+  def self.register_command(command)
+    COMMANDS[command.to_command_name("_")] = command
+  end
+
+  def self.unregister_command(command)
+    COMMANDS.delete(command.to_command_name("_"))
+  end
+
+
+  module Commands
+  end
+
+  class Command
+    def self.description(description = nil)
+      @description = description if description
+      @description
+    end
+
+    def self.help
+      "No help is available for this command (#{self.to_command_name})."
+    end
+
+    # TODO consider accepting a block in subclasses
+    def self.options(opts)
+      @options = opts
+      @options.banner = "Usage: #{opts.program_name} [options] #{self.to_command_name} [options] [args]"
+      @options
+    end
+
+    def self.run!
+      puts self.options(OptionParser.new).help
+      commands = Switchboard.commands(self)
+
+      if commands.any?
+        puts
+        puts "Available commands:"
+        commands.each do |name, command|
+          puts "   #{command.to_command.ljust(15)}#{command.description}"
+          command.options(OptionParser.new).summarize do |line|
+            puts " " * 16 + line
+          end
+        end
+        puts
+        puts "See '#{@options.program_name} help COMMAND' for more information on a specific command."
+      end
+    end
+
+    def self.to_command
+      self.name.gsub("Switchboard::Commands::", "").split("::").last.downcase
+    end
+
+    def self.to_command_name(delimiter = " ")
+      self.name.gsub("Switchboard::Commands::", "").split("::").map { |c| c.downcase } * delimiter
+    end
+
+  private
+
+    def self.hide!
+      Switchboard.hide_command(self)
+    end
+
+    def self.inherited(klass)
+      Switchboard.register_command(klass) if klass.name =~ /^Switchboard::Commands/
+    end
+
+    def self.unregister!
+      Switchboard.unregister_command(self)
+    end
+  end
+end

data/lib/switchboard/commands/config.rb

@@ -0,0 +1 @@
+require 'switchboard/commands/config/config'

data/lib/switchboard/commands/config/config.rb

@@ -0,0 +1,20 @@
+module Switchboard
+  module Commands
+    class Config < Switchboard::Command
+      description "Get and set global options"
+
+      def self.run!
+        settings = Switchboard::Settings.new
+        if ARGV.empty?
+          super
+        elsif ARGV.length == 1
+          puts settings.get(ARGV.shift)
+        elsif ARGV.length == 2
+          settings.set!(ARGV.shift, ARGV.shift)
+        else
+          puts "error: More than one value for the key #{ARGV.shift}: #{ARGV * " "}"
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/default.rb

@@ -0,0 +1,40 @@
+module Switchboard
+  module Commands
+    class Default < Switchboard::Command
+      unregister!
+
+      def self.options(opts)
+        super(opts)
+
+        opts.banner = "Usage: #{opts.program_name} [options] COMMAND [options] [args]"
+
+        # opts.on("-d", "--daemon", "Make server run as a daemon.") { OPTIONS[:detach] = true }
+        opts.on("-j", "--jid=jid", String, "Specifies the JID to use.") { |v| OPTIONS["jid"] = v }
+        opts.on("-r", "--resource=resource", String, "Specifies the resource to use.") { |v| OPTIONS["resource"] = v }
+        opts.on("-p", "--password=password", String, "Specifies the password to use.") { |v| OPTIONS["password"] = v }
+        # opts.on("-p", "--pidfile=path", String,
+        #         "Specifies a pidfile to use.") { |v| OPTIONS[:pidfile] = v }
+        # opts.on("-v", "--[no-]verbose", "Run verbosely") { |v| OPTIONS[:verbose] = v }
+
+        opts.separator ""
+
+        opts.on_tail("-h", "--help", "Show this help message.") { puts opts; exit }
+        opts.on_tail("--version", "Show version") { puts "switchboard version #{Switchboard::VERSION * "."}"; exit }
+      end
+
+      def self.run!
+        puts self.options(OptionParser.new).help
+        puts
+        puts "Available commands:"
+        Switchboard.commands.each do |name, command|
+          puts "   #{command.to_command.ljust(15)}#{command.description}"
+          command.options(OptionParser.new).summarize do |line|
+            puts " " * 16 + line
+          end
+        end
+        puts
+        puts "See '#{@options.program_name} help COMMAND' for more information on a specific command."
+      end
+    end
+  end
+end

data/lib/switchboard/commands/disco.rb

@@ -0,0 +1,3 @@
+require 'switchboard/commands/disco/disco'
+require 'switchboard/commands/disco/items'
+require 'switchboard/commands/disco/info'

data/lib/switchboard/commands/disco/disco.rb

@@ -0,0 +1,13 @@
+module Switchboard
+  module Commands
+    class Disco < Switchboard::Command
+      description "Service discovery"
+
+      def self.options(opts)
+        super(opts)
+        opts.on("--node=node", String, "Specifies the node to query.") { |v| OPTIONS["disco.node"] = v }
+        opts.on("--target=target", String, "Specifies the target to query.") { |v| OPTIONS["disco.target"] = v }
+      end
+    end
+  end
+end

data/lib/switchboard/commands/disco/info.rb

@@ -0,0 +1,39 @@
+require 'xmpp4r/discovery'
+
+module Switchboard
+  module Commands
+    class Disco
+      class Info < Switchboard::Command
+        description "Basic service discovery"
+
+        def self.run!
+          switchboard = Switchboard::Client.new do
+            helper = Jabber::Discovery::Helper.new(client)
+            resp = helper.get_info_for(settings["disco.target"], settings["disco.node"])
+
+            if resp.identities.any? || resp.features.any?
+              puts "Discovery Info for #{settings["disco.target"]}#{settings["disco.node"] ? " (#{settings["disco.node"]})" : ""}"
+
+              if resp.identities.any?
+                puts "Identities:"
+                resp.identities.each do |identity|
+                  puts "  #{identity.category}/#{identity.type}: #{identity.iname ? identity.iname : "n/a"}"
+                end
+                puts
+              end
+
+              puts "Features:" if resp.features.any?
+              resp.features.each do |feature|
+                puts "  #{feature}"
+              end
+            else
+              puts "No information was discoverable for #{settings["disco.target"]}"
+            end
+          end
+
+          switchboard.run!
+        end
+      end
+    end
+  end
+end