mojodna-switchboard 0.0.1

data/lib/switchboard/core.rb

@@ -0,0 +1,324 @@
+require 'rubygems'
+begin
+  require 'xmpp4r'
+rescue LoadError => e
+  gem = e.message.split("--").last.strip
+  puts "The #{gem} gem is required."
+end
+
+# allow local library modifications/additions to be loaded
+$: << File.join(File.dirname(__FILE__))
+
+require 'switchboard/instance_exec'
+require 'xmpp4r/roster'
+
+
+module Switchboard
+  class Core
+    include Timeout
+
+    attr_reader :client, :jacks, :roster, :settings
+
+    def initialize(settings = Switchboard::Settings.new, spin = true, &block)
+      # register a handler for SIGINTs
+      trap(:INT) do
+        # exit on a second ^C
+        trap(:INT) do
+          exit
+        end
+
+        @deferreds.each do |name, deferred|
+          puts "Killing #{name}" if debug?
+          deferred.kill
+        end
+
+        shutdown!
+      end
+
+      @settings = settings
+      @loop = spin
+      @shutdown = false
+      @deferreds = {}
+      @main = block if block_given?
+
+      # TODO jid may already have a resource, so account for that
+      @client = Jabber::Client.new([settings["jid"], settings["resource"]] * "/")
+    end
+
+    # Turn the hydrant on.
+    def run!
+      startup
+
+      if @main
+        instance_eval(&@main)
+      elsif loop?
+        sleep 5 while !shutdown?
+      end
+
+      shutdown
+    end
+
+    # TODO don't start threads yet; wait until all startup hooks have been run
+    def defer(callback_name, timeout = 30, &block)
+      puts "Deferring to #{callback_name}..." if debug?
+      @deferreds[callback_name.to_sym] = Thread.new do
+
+        begin
+
+          timeout(timeout) do
+            results = instance_eval(&block)
+            send(callback_name.to_sym, results)
+          end
+
+          puts "Done with #{callback_name}." if debug?
+          # TODO make this thread-safe
+          @deferreds.delete(callback_name.to_sym)
+
+        rescue Timeout::Error
+          puts "Deferred method timed out."
+        rescue
+          puts "An error occurred while running a deferred: #{$!}"
+          puts $!.backtrace * "\n"
+          puts "Initiating shutdown..."
+          @shutdown = true
+        end
+      end
+    end
+
+    # Connect a jack to the switchboard
+    def plug!(*jacks)
+      @jacks ||= []
+      jacks.each do |jack|
+        puts "Connecting jack: #{jack}" if debug?
+        @jacks << jack
+        jack.connect(self)
+      end
+    end
+
+    # Register a hook to run when the Jabber::Client encounters an exception.
+    def on_exception(&block)
+      register_hook(:exception, &block)
+    end
+
+    # Register a hook to run when iq stanzas are received.
+    def on_iq(&block)
+      register_hook(:iq, &block)
+    end
+
+    # Register a hook to run when message stanzas are received.
+    def on_message(&block)
+      register_hook(:message, &block)
+    end
+
+    # Register a hook to run when presence stanzas are received.
+    def on_presence(&block)
+      register_hook(:presence, &block)
+    end
+
+    def on_roster_presence(&block)
+      register_hook(:roster_presence, &block)
+    end
+
+    def on_roster_query(&block)
+      register_hook(:roster_query, &block)
+    end
+
+    def on_roster_subscription(&block)
+      register_hook(:roster_subscription, &block)
+    end
+
+    def on_roster_subscription_request(&block)
+      register_hook(:roster_subscription_request, &block)
+    end
+
+    def on_roster_loaded(&block)
+      register_hook(:roster_loaded, &block)
+    end
+
+    def on_roster_update(&block)
+      register_hook(:roster_update, &block)
+    end
+
+    # Register a startup hook.
+    # Hooks will be given 5 seconds to complete before moving on.
+    def on_startup(&block)
+      register_hook(:startup, &block)
+    end
+
+    # Register a shutdown hook.
+    # Hooks will be given 5 seconds to complete before moving on.
+    def on_shutdown(&block)
+      register_hook(:shutdown, &block)
+    end
+
+  protected
+
+    def connect!
+      client.connect
+      client.auth(settings["password"])
+      @roster = Jabber::Roster::Helper.new(client)
+    end
+
+    def connected?
+      @connected
+    end
+
+    def debug?
+      settings["debug"]
+    end
+
+    def disconnect
+      presence(:unavailable)
+      client.close
+    end
+
+    def register_hook(name, &block)
+      @hooks ||= {}
+      @hooks[name.to_sym] ||= []
+
+      puts "Registering #{name} hook" if debug?
+      @hooks[name.to_sym] << block
+    end
+
+    def on(name, *args)
+      @hooks ||= {}
+      @hooks[name.to_sym] ||= []
+      @hooks[name.to_sym].each do |hook|
+        execute_hook(hook, *args)
+      end
+    end
+
+    def execute_hook(hook, *args)
+      timeout(1) do
+        instance_exec(*args, &hook)
+      end
+    rescue Timeout::Error
+      puts "Hook timed out, consider deferring it."
+    rescue
+      puts "An error occurred while running the hook; shutting down..."
+      puts $!
+      puts $!.backtrace * "\n"
+      shutdown
+      raise
+    end
+
+    def loop?
+      @loop
+    end
+
+    def presence(status = nil, to = nil)
+      presence = Jabber::Presence.new(nil, status)
+      presence.to = to
+      client.send(presence)
+    end
+
+    def register_default_callbacks
+      client.on_exception do |e, stream, where|
+        on(:exception, e, stream, where)
+
+        case where
+        when :something
+        else
+          puts "Caught #{e.inspect} on #{stream} at #{where}.  You might want to consider handling this."
+          raise e
+        end
+      end
+
+      client.add_presence_callback do |presence|
+        on(:presence, presence)
+      end
+
+      client.add_message_callback do |message|
+        on(:message, message)
+      end
+
+      client.add_iq_callback do |iq|
+        on(:iq, iq)
+      end
+    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 startup
+      begin
+        timeout(30) do
+          connect!
+          @connected = true
+
+          register_default_callbacks
+          register_roster_callbacks
+
+          # tell others that we're online
+          presence
+
+          # wait for the roster to load
+          roster.wait_for_roster
+        end
+      rescue Timeout::Error
+        puts "Startup took too long.  Shutting down."
+        shutdown(false)
+        exit 1
+      end
+
+      # roster has now been loaded
+      on(:roster_loaded)
+
+      puts "Core startup completed." if debug?
+
+      # run startup hooks
+      on(:startup)
+
+      puts "=> Switchboard started."
+    end
+
+    def shutdown!
+      puts "Shutdown initiated."
+      @shutdown = true
+    end
+
+    def shutdown(run_hooks = true)
+      while (pending = @deferreds.select { |k,d| d.alive? }.length) > 0
+        puts "Waiting for #{pending} thread(s) to finish" if debug?
+        sleep 1
+      end
+
+      # run shutdown hooks
+      on(:shutdown) if run_hooks
+
+      puts "Shutting down..." if debug?
+      disconnect if connected?
+    end
+
+    def shutdown?
+      @shutdown
+    end
+  end
+end

data/lib/switchboard/instance_exec.rb

@@ -0,0 +1,16 @@
+module Kernel
+
+ # Like instance_eval but allows parameters to be passed.
+
+  def instance_exec(*args, &block)
+    mname = "__instance_exec_#{Thread.current.object_id.abs}_#{object_id.abs}"
+    Object.class_eval{ define_method(mname, &block) }
+    begin
+      ret = send(mname, *args)
+    ensure
+      Object.class_eval{ undef_method(mname) } rescue nil
+    end
+    ret
+  end
+
+end

data/lib/switchboard/jacks/auto_accept.rb

@@ -0,0 +1,16 @@
+class AutoAcceptJack
+  def self.connect(switchboard)
+    # complain if subscription requests were denied
+    switchboard.on_roster_subscription do |item, subscription|
+      unless subscription.type == :subscribed
+        puts "My subscription request was denied!"
+      end
+    end
+
+    # auto-accept subscription requests
+    switchboard.on_roster_subscription_request do |item, subscription|
+      puts "Accepting subscription from #{subscription.from}"
+      roster.accept_subscription(subscription.from)
+    end
+  end
+end

data/lib/switchboard/jacks/debug.rb

@@ -0,0 +1,17 @@
+require 'switchboard/colors'
+
+class DebugJack
+  def self.connect(switchboard)
+    switchboard.on_presence do |presence|
+      puts "<< #{presence.to_s}".green
+    end
+
+    switchboard.on_message do |message|
+      puts "<< #{message.to_s}".blue
+    end
+
+    switchboard.on_iq do |iq|
+      puts "<< #{iq.to_s}".yellow
+    end
+  end
+end

data/lib/switchboard/jacks/notify.rb

@@ -0,0 +1,15 @@
+class NotifyJack
+  def self.connect(switchboard)
+    switchboard.on_roster_loaded do
+      roster.items.each do |jid, item|
+        presence(nil, jid)
+      end
+    end
+
+    switchboard.on_shutdown do
+      roster.items.each do |jid, item|
+        presence(:unavailable, jid)
+      end
+    end
+  end
+end

data/lib/switchboard/jacks/oauth_pubsub.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+begin
+  require 'oauth'
+rescue LoadError => e
+  gem = e.message.split("--").last.strip
+  puts "The #{gem} gem is required."
+end
+
+require 'oauth/consumer'
+require 'oauth/request_proxy/mock_request'
+require 'xmpp4r/pubsub'
+require 'xmpp4r/pubsub/helper/oauth_service_helper'
+
+class OAuthPubSubJack
+  def self.connect(switchboard)
+    switchboard.on_startup do
+      @pubsub = Jabber::PubSub::OAuthServiceHelper.new(client, settings["pubsub.server"])
+
+      @oauth_consumer = OAuth::Consumer.new(settings["oauth.consumer_key"], settings["oauth.consumer_secret"])
+      @oauth_token = OAuth::Token.new(settings["oauth.token"], settings["oauth.token_secret"])
+      # this is Fire Eagle-specific
+      @general_token = OAuth::Token.new(settings["oauth.general_token"], settings["oauth.general_token_secret"])
+
+      @pubsub.add_event_callback do |event|
+        on(:pubsub_event, event)
+      end
+    end
+
+    # TODO add the ability to define accessors
+    def switchboard.general_token
+      @general_token
+    end
+
+    def switchboard.oauth_consumer
+      @oauth_consumer
+    end
+
+    def switchboard.oauth_token
+      @oauth_token
+    end
+
+    def switchboard.pubsub
+      @pubsub
+    end
+
+    def switchboard.on_pubsub_event(&block)
+      register_hook(:pubsub_event, &block)
+    end
+  end
+end

data/lib/switchboard/jacks/roster_debug.rb

@@ -0,0 +1,23 @@
+class RosterDebugJack
+  def self.connect(switchboard)
+    switchboard.on_roster_presence do |item, old_presence, new_presence|
+      puts "[presence] << #{item.inspect}: #{old_presence.to_s}, #{new_presence.to_s}"
+    end
+
+    switchboard.on_roster_query do |query|
+      puts "[roster query] << #{query.to_s}"
+    end
+
+    switchboard.on_roster_subscription do |item, subscription|
+      puts "[subscription] << #{item.inspect}: #{subscription.to_s}"
+    end
+
+    switchboard.on_roster_subscription_request do |item, subscription|
+      puts "[subscription request] << #{item.inspect}: #{subscription.to_s}"
+    end
+
+    switchboard.on_roster_update do |old_item, new_item|
+      puts "[update] #{old_item.inspect}, #{new_item.inspect}"
+    end
+  end
+end

data/lib/switchboard/jacks.rb

@@ -0,0 +1,5 @@
+require 'jacks/auto_accept'
+require 'jacks/notify'
+require 'jacks/roster_debug'
+require 'jacks/debug'
+require 'jacks/oauth_pubsub'

data/lib/switchboard/oauth/request_proxy/mock_request.rb

@@ -0,0 +1,21 @@
+require 'oauth/request_proxy/base'
+
+module OAuth
+  module RequestProxy
+    class MockRequest < OAuth::RequestProxy::Base
+      proxies Hash
+
+      def parameters
+        @request["parameters"]
+      end
+
+      def method
+        @request["method"]
+      end
+
+      def uri
+        @request["uri"]
+      end
+    end
+  end
+end

data/lib/switchboard/settings.rb

@@ -0,0 +1,32 @@
+module Switchboard
+  class Settings
+    DEFAULT_PATH = File.join(ENV["HOME"], ".switchboardrc")
+
+    def initialize(path = DEFAULT_PATH)
+      @path = path
+
+      if File.exists?(path)
+        @config = YAML.load(File.read(path))
+      end
+
+      @config ||= {}
+    end
+
+    def get(key)
+      Switchboard::Command::OPTIONS[key] || @config[key] || Switchboard::Command::DEFAULT_OPTIONS[key]
+    end
+
+    alias_method :[], :get
+
+    def set!(key, value)
+      @config[key] = value
+      write
+    end
+
+    def write
+      open(@path, "w") do |f|
+        f << @config.to_yaml
+      end
+    end
+  end
+end

data/lib/switchboard/switchboard.rb

@@ -0,0 +1,5 @@
+require 'switchboard/core'
+require 'switchboard/commands'
+require 'switchboard/jacks'
+require 'switchboard/settings'
+require 'switchboard/version'

data/lib/switchboard/version.rb

@@ -0,0 +1,3 @@
+module Switchboard
+  VERSION = [0, 0, 1]
+end

data/lib/switchboard/xmpp4r/pubsub/helper/oauth_service_helper.rb

@@ -0,0 +1,107 @@
+module Jabber
+  module PubSub
+    # PubSub service helper for use with OAuth-authenticated nodes
+    class OAuthServiceHelper < ServiceHelper
+      def initialize(stream, pubsubjid)
+        super(stream, pubsubjid)
+      end
+
+      # override #get_subscriptions_from_all_nodes to add an oauth element
+      def get_subscriptions_from_all_nodes(oauth_consumer, oauth_token)
+        iq = basic_pubsub_query(:get)
+
+        iq.pubsub.add(create_oauth_node(oauth_consumer, oauth_token))
+
+        entities = iq.pubsub.add(REXML::Element.new('subscriptions'))
+        res = nil
+        @stream.send_with_id(iq) { |reply|
+          if reply.pubsub.first_element('subscriptions')
+            res = []
+            reply.pubsub.first_element('subscriptions').each_element('subscription') { |subscription|
+              res << Jabber::PubSub::Subscription.import(subscription)
+            }
+          end
+        }
+
+        res
+      end
+
+      # override #subscribe_to to add an oauth element
+      def subscribe_to(node, oauth_consumer, oauth_token)
+        iq = basic_pubsub_query(:set)
+        sub = REXML::Element.new('subscribe')
+        sub.attributes['node'] = node
+        sub.attributes['jid'] = @stream.jid.strip.to_s
+
+        sub.add(create_oauth_node(oauth_consumer, oauth_token))
+
+        iq.pubsub.add(sub)
+        res = nil
+        @stream.send_with_id(iq) do |reply|
+          pubsubanswer = reply.pubsub
+          if pubsubanswer.first_element('subscription')
+            res = PubSub::Subscription.import(pubsubanswer.first_element('subscription'))
+          end
+        end # @stream.send_with_id(iq)
+        res
+      end
+
+      # override #unsubscribe_from to add an oauth element
+      def unsubscribe_from(node, oauth_consumer, oauth_token, subid=nil)
+        iq = basic_pubsub_query(:set)
+        unsub = PubSub::Unsubscribe.new
+        unsub.node = node
+        unsub.jid = @stream.jid.strip
+
+        unsub.add(create_oauth_node(oauth_consumer, oauth_token))
+
+        iq.pubsub.add(unsub)
+        ret = false
+        @stream.send_with_id(iq) { |reply|
+          ret = reply.kind_of?(Jabber::Iq) and reply.type == :result
+        } # @stream.send_with_id(iq)
+        ret
+      end
+
+    protected
+
+      # add the OAuth sauce (XEP-235)
+      def create_oauth_node(oauth_consumer, oauth_token)
+        require 'oauth/signature/hmac/sha1'
+        require 'cgi'
+
+        request = OAuth::RequestProxy.proxy \
+          "method" => "iq",
+          "uri"    => [@stream.jid.strip.to_s, @pubsubjid.strip.to_s] * "&",
+          "parameters" => {
+            "oauth_consumer_key"     => oauth_consumer.key,
+            "oauth_token"            => oauth_token.token,
+            "oauth_signature_method" => "HMAC-SHA1"
+          }
+
+        signature = OAuth::Signature.sign(request, :consumer => oauth_consumer, :token => oauth_token)
+
+        oauth = REXML::Element.new("oauth")
+        oauth.attributes['xmlns'] = 'urn:xmpp:oauth'
+
+        oauth_consumer_key = REXML::Element.new("oauth_consumer_key")
+        oauth_consumer_key.text = oauth_consumer.key
+        oauth.add(oauth_consumer_key)
+
+        oauth_token_node = REXML::Element.new("oauth_token")
+        oauth_token_node.text = oauth_token.token
+        oauth.add(oauth_token_node)
+
+        oauth_signature_method = REXML::Element.new("oauth_signature_method")
+        oauth_signature_method.text = "HMAC-SHA1"
+        oauth.add(oauth_signature_method)
+
+        oauth_signature = REXML::Element.new("oauth_signature")
+        oauth_signature.text = signature
+        oauth.add(oauth_signature)
+
+        oauth
+      end
+    end
+  end
+end

data/lib/switchboard.rb

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

data/switchboard.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = "switchboard"
+  s.version = "0.0.1"
+  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 = ["bin", "bin/switchboard", "examples/election_results.rb", "github-test.rb", "lib", "lib/switchboard", "lib/switchboard/colors.rb", "lib/switchboard/commands", "lib/switchboard/commands/command.rb", "lib/switchboard/commands/config", "lib/switchboard/commands/config/config.rb", "lib/switchboard/commands/config.rb", "lib/switchboard/commands/default.rb", "lib/switchboard/commands/help", "lib/switchboard/commands/help/help.rb", "lib/switchboard/commands/help.rb", "lib/switchboard/commands/pubsub", "lib/switchboard/commands/pubsub/pubsub.rb", "lib/switchboard/commands/pubsub/subscribe.rb", "lib/switchboard/commands/pubsub/subscriptions.rb", "lib/switchboard/commands/pubsub/unsubscribe.rb", "lib/switchboard/commands/pubsub.rb", "lib/switchboard/commands/roster", "lib/switchboard/commands/roster/add.rb", "lib/switchboard/commands/roster/list.rb", "lib/switchboard/commands/roster/remove.rb", "lib/switchboard/commands/roster/roster.rb", "lib/switchboard/commands/roster.rb", "lib/switchboard/commands.rb", "lib/switchboard/core.rb", "lib/switchboard/instance_exec.rb", "lib/switchboard/jacks", "lib/switchboard/jacks/auto_accept.rb", "lib/switchboard/jacks/debug.rb", "lib/switchboard/jacks/notify.rb", "lib/switchboard/jacks/oauth_pubsub.rb", "lib/switchboard/jacks/roster_debug.rb", "lib/switchboard/jacks.rb", "lib/switchboard/oauth", "lib/switchboard/oauth/request_proxy", "lib/switchboard/oauth/request_proxy/mock_request.rb", "lib/switchboard/settings.rb", "lib/switchboard/switchboard.rb", "lib/switchboard/version.rb", "lib/switchboard/xmpp4r", "lib/switchboard/xmpp4r/pubsub", "lib/switchboard/xmpp4r/pubsub/helper", "lib/switchboard/xmpp4r/pubsub/helper/oauth_service_helper.rb", "lib/switchboard.rb", "README.markdown", "switchboard-0.0.1.gem", "switchboard.gemspec"]
+  s.executables = ["switchboard"]
+  s.require_paths = ["lib"]
+
+  s.add_dependency("xmpp4r")
+end