mojodna-switchboard 0.0.1

data/README.markdown

@@ -0,0 +1,31 @@
+# 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:
+
+    $ gem install mojodna-switchboard -s http://gems.github.com
+
+Configure it:
+
+    $ switchboard config jid jid@example.com
+    $ switchboard config password pa55word
+    $ switchboard config oauth.consumer_key asdf
+    $ switchboard config oauth.consumer_secret qwerty
+    $ switchboard config oauth.token asdf
+    $ switchboard config oauth.token_secret qwerty
+    $ switchboard config oauth.general_token asdf
+    $ switchboard config oauth.general_token_secret qwerty
+    $ switchboard config pubsub.server fireeagle.com
+
+_Settings will be stored in `$HOME/.switchboardrc`_
+
+Run it:
+
+    $ switchboard <command> <args>
+    $ switchboard roster list
+    $ switchboard roster add fireeagle.com
+    $ ...

data/bin/switchboard

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require 'switchboard'
+require 'optparse'
+
+command = 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
+
+command.run!

data/examples/election_results.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require 'fire_hydrant'
+require 'rexml/document'
+require 'open-uri'
+
+hydrant = FireHydrant.new(YAML.load(File.read("fire_hydrant.yml"))) do
+  old_votes = load_results
+
+  while(!shutdown?) do
+    # load the results feed
+    votes = load_results
+    diff = nil
+
+    # loop through and compare it to the old results
+    votes.each do |state, cand|
+      cand.each do |c, val|
+        unless old_votes[state][c] == val
+          diff ||= "Electoral results changed"
+          diff << "\n#{state} - #{c}: #{old_votes[state][c].inspect} => #{val.inspect}"
+        end
+      end
+    end
+
+    if diff
+      puts diff
+      broadcast(diff)
+    end
+
+    # set this as old_votes
+    old_votes = votes
+
+    # wait 5 minutes
+    puts "-----"
+    sleep 300
+  end
+end
+
+hydrant.jack!(AutoAcceptJack, NotifyJack)
+
+def hydrant.load_results(url = "http://d.yimg.com/b/data/us/news/xml/elections/2008a/pres.xml")
+  doc = REXML::Document.new(open(url))
+  nodes = doc.elements.collect("//state") { |node| [node.attributes["name"].downcase, node.elements.collect("cand") { |cand| [cand.attributes["name"].downcase, cand.attributes["PopPct"].to_f, cand.attributes["PopVote"].to_i] }] }
+
+  votes = {}
+  nodes.each do |state, results|
+    votes[state] = {}
+    results.each do |cand, pct, vote|
+      votes[state][cand] = [pct, vote]
+    end
+  end
+
+  votes
+end
+
+def hydrant.broadcast(msg)
+  roster.items.each do |jid, item|
+    client.send(Jabber::Message.new(jid, msg))
+  end
+end
+
+hydrant.run!

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/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/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/config.rb

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

data/lib/switchboard/commands/default.rb

@@ -0,0 +1,47 @@
+module Switchboard
+  class Command
+    OPTIONS = {}
+    DEFAULT_OPTIONS = {
+      # :detach  => false,
+      "debug"    => false,
+      "oauth"    => false,
+      "resource" => "switchboard"
+    }
+  end
+  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("-l", "--log=path", String, "Specifies a path to log script output.") { |v| OPTIONS[:log] = 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/help/help.rb

@@ -0,0 +1,15 @@
+module Switchboard
+  module Commands
+    class Help < Switchboard::Command
+      hide!
+
+      def self.run!
+        if ARGV.any?
+          puts Switchboard::COMMANDS[ARGV * "_"].help
+        else
+          Switchboard::Commands::Default.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/help.rb

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

data/lib/switchboard/commands/pubsub/pubsub.rb

@@ -0,0 +1,16 @@
+module Switchboard
+  module Commands
+    class PubSub < Switchboard::Command
+      description "Pubsub node manipulation"
+
+      def self.help
+        "These are the more extensive instructions for using the pubsub command."
+      end
+
+      def self.options(opts)
+        super(opts)
+        # opts.on("--oauth", "Sign requests using OAuth.") { OPTIONS[:oauth] = true }
+      end
+    end
+  end
+end

data/lib/switchboard/commands/pubsub/subscribe.rb

@@ -0,0 +1,35 @@
+module Switchboard
+  module Commands
+    class PubSub
+      class Subscribe < Switchboard::Command
+        description "Subscribe to a pubsub node"
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Core.new do
+            # this executes in the main loop, so it doesn't really matter that this runs in a different thread
+            defer :subscribed do
+              begin
+                pubsub.subscribe_to("/api/0.1/user/#{settings["oauth.token"]}", oauth_consumer, oauth_token)
+              rescue Jabber::ServerError => e
+                puts e
+              end
+            end
+
+            # define here or as hydrant.subscriptions_received
+            def subscribed(subscription)
+              if subscription.subscription == :subscribed
+                puts "Subscribe successful."
+              else
+                puts "Subscribe failed!".red
+              end
+            end
+          end
+
+          switchboard.plug!(OAuthPubSubJack)
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/pubsub/subscriptions.rb

@@ -0,0 +1,32 @@
+module Switchboard
+  module Commands
+    class PubSub
+      class Subscriptions < Switchboard::Command
+        description "List pubsub subscriptions"
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Core.new do
+            # this executes in the main loop, so it doesn't really matter that this runs in a different thread
+            defer :subscriptions_received do
+              begin
+                pubsub.get_subscriptions_from_all_nodes(oauth_consumer, general_token)
+              rescue Jabber::ServerError => e
+                puts e
+              end
+            end
+
+            # define here or as hydrant.subscriptions_received
+            def subscriptions_received(subscriptions)
+              puts "Subscriptions:"
+              puts subscriptions.collect { |subscription| "#{subscription.jid} => #{subscription.node}" } * "\n"
+            end
+          end
+
+          switchboard.plug!(OAuthPubSubJack)
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/pubsub/unsubscribe.rb

@@ -0,0 +1,31 @@
+module Switchboard
+  module Commands
+    class PubSub
+      class Unsubscribe < Switchboard::Command
+        description "Unsubscribe from a pubsub node"
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Core.new do
+            # this executes in the main loop, so it doesn't really matter that this runs in a different thread
+            defer :unsubscribed do
+              begin
+                pubsub.unsubscribe_from("/api/0.1/user/#{settings["oauth.token"]}", oauth_consumer, oauth_token)
+              rescue Jabber::ServerError => e
+                puts e
+              end
+            end
+
+            # define here or as hydrant.subscriptions_received
+            def unsubscribed(successful)
+              puts "Unsubscribe was successful." if successful
+            end
+          end
+
+          switchboard.plug!(OAuthPubSubJack)
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/pubsub.rb

@@ -0,0 +1,4 @@
+require 'switchboard/commands/pubsub/pubsub'
+require 'switchboard/commands/pubsub/subscribe'
+require 'switchboard/commands/pubsub/subscriptions'
+require 'switchboard/commands/pubsub/unsubscribe'

data/lib/switchboard/commands/roster/add.rb

@@ -0,0 +1,26 @@
+module Switchboard
+  module Commands
+    class Roster
+      class Add < Switchboard::Command
+        description "Add a JID to your roster"
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Core.new do
+            # add the server as a contact if it wasn't already added
+            ARGV.each do |jid|
+              if roster.find(jid).empty?
+                puts "Adding #{jid} to my roster..."
+                roster.add(jid, nil, true)
+              end
+            end
+          end
+
+          switchboard.plug!(AutoAcceptJack)
+
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/list.rb

@@ -0,0 +1,24 @@
+module Switchboard
+  module Commands
+    class Roster
+      class List < Switchboard::Command
+        description "List all roster items"
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Core.new do
+            if roster.items.any?
+              puts "#{settings["jid"]}'s roster:"
+              puts roster.items.keys.map { |jid| jid.to_s } * "\n"
+            else
+              puts "#{settings["jid"]}'s roster is empty."
+            end
+          end
+
+          switchboard.plug!(AutoAcceptJack)
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/remove.rb

@@ -0,0 +1,29 @@
+module Switchboard
+  module Commands
+    class Roster
+      class Remove < Switchboard::Command
+        description "Remove a JID from your roster"
+
+        def self.options(opts)
+          super(opts)
+          # opts.on("-l", "--log=path", String, "Specifies a path to log script output.") { |v| OPTIONS[:log] = v }
+        end
+
+        def self.run!
+          # TODO override settings with values from the command line
+          switchboard = Switchboard::Core.new do
+            ARGV.each do |jid|
+              if (items = roster.find(jid)).any?
+                item = items.values.first
+                puts "Removing #{item.jid.to_s} from my roster..."
+                item.remove
+              end
+            end
+          end
+
+          switchboard.run!
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/commands/roster/roster.rb

@@ -0,0 +1,7 @@
+module Switchboard
+  module Commands
+    class Roster < Switchboard::Command
+      description "Roster manipulation"
+    end
+  end
+end

data/lib/switchboard/commands/roster.rb

@@ -0,0 +1,4 @@
+require 'switchboard/commands/roster/roster'
+require 'switchboard/commands/roster/add'
+require 'switchboard/commands/roster/list'
+require 'switchboard/commands/roster/remove'

data/lib/switchboard/commands.rb

@@ -0,0 +1,6 @@
+require 'switchboard/commands/command'
+require 'switchboard/commands/config'
+require 'switchboard/commands/default'
+require 'switchboard/commands/help'
+require 'switchboard/commands/pubsub'
+require 'switchboard/commands/roster'