switchboard 0.1.0

data/lib/switchboard/ext/delegate.rb

@@ -0,0 +1,21 @@
+class Module
+  # Modified version from ActiveSupport to support :with (for additional arguments)
+  def delegate(*methods)
+    options = methods.pop
+    unless options.is_a?(Hash) && to = options[:to]
+      raise ArgumentError, "Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, :to => :greeter)."
+    end
+
+    prefix = options[:prefix] && "#{options[:prefix] == true ? to : options[:prefix]}_"
+    with = options[:with] || []
+
+    methods.each do |method|
+      module_eval(<<-EOS, "(__DELEGATION__)", 1)
+        def #{prefix}#{method}(*args, &block)
+          args += [#{with * ", "}]
+          #{to}.__send__(#{method.inspect}, *args, &block)
+        end
+      EOS
+    end
+  end
+end

data/lib/switchboard/ext/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/helpers/oauth_pubsub.rb

@@ -0,0 +1,44 @@
+begin
+  require 'oauth'
+rescue LoadError => e
+  lib = e.message.split("--").last.strip
+  puts "#{lib} is required."
+  exit 1
+end
+
+require 'oauth/version'
+if OAuth::VERSION < "0.3.1.4"
+  puts "The OAuth library must be at least version 0.3.1.4."
+  exit 1
+end
+
+require 'switchboard/helpers/pubsub'
+require 'oauth/consumer'
+require 'oauth/request_proxy/mock_request'
+require 'xmpp4r/pubsub'
+require 'xmpp4r/pubsub/helper/oauth_service_helper'
+
+module Switchboard
+  module Helpers
+    module OAuthPubSubHelper
+      include PubSubHelper
+
+      attr_reader :oauth_consumer, :oauth_token
+
+      delegate :create_node, :create_collection_node, :delete_node,
+        :delete_item_from, :get_config_from, :get_options_from, :get_items_from,
+        :publish_item_to, :publish_item_with_id_to, :purge_items_from,
+        :set_config_for, :subscribe_to, :unsubscribe_from,
+        :to   => :pubsub
+
+      def subscriptions(node = nil)
+        if node
+          # TODO this needs to be implemented in OAuthServiceHelper
+          pubsub.get_subscriptions_from(node)
+        else
+          pubsub.get_subscriptions_from_all_nodes
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/helpers/pubsub.rb

@@ -0,0 +1,28 @@
+require 'xmpp4r/pubsub'
+# TODO this is broken in XMPP4R 0.4.0
+# require 'xmpp4r/pubsub/helper/nodebrowser'
+
+module Switchboard
+  module Helpers
+    module PubSubHelper
+      attr_reader :pubsub
+
+      delegate :create_node, :create_collection_node, :delete_node,
+        :delete_item_from, :get_config_from, :get_options_from, :get_items_from,
+        :publish_item_to, :publish_item_with_id_to, :purge_items_from,
+        :set_config_for, :subscribe_to, :unsubscribe_from,
+        :to => :pubsub
+
+      Switchboard::Core.hook(:pubsub_event)
+
+      def subscriptions(node = nil)
+        # NOTE: node-specific subscriptions do not appear to work in ejabberd 2.0.2
+        if node
+          pubsub.get_subscriptions_from(node)
+        else
+          pubsub.get_subscriptions_from_all_nodes
+        end
+      end
+    end
+  end
+end

data/lib/switchboard/jacks.rb

@@ -0,0 +1,7 @@
+require 'jacks/auto_accept'
+require 'jacks/debug'
+require 'jacks/echo'
+require 'jacks/notify'
+require 'jacks/oauth_pubsub'
+require 'jacks/pubsub'
+require 'jacks/roster_debug'

data/lib/switchboard/jacks/auto_accept.rb

@@ -0,0 +1,16 @@
+class AutoAcceptJack
+  def self.connect(switchboard, settings)
+    # 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, settings)
+    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/echo.rb

@@ -0,0 +1,7 @@
+class EchoJack
+  def self.connect(switchboard, settings)
+    switchboard.on_message do |message|
+      stream.send(message.answer)
+    end
+  end
+end

data/lib/switchboard/jacks/notify.rb

@@ -0,0 +1,15 @@
+class NotifyJack
+  def self.connect(switchboard, settings)
+    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,23 @@
+class OAuthPubSubJack
+  def self.connect(switchboard, settings)
+    require 'switchboard/helpers/oauth_pubsub'
+
+    # TODO generalize this pattern for required settings
+    unless settings["pubsub.server"]
+      puts "A pubsub server must be specified."
+      return false
+    end
+
+    switchboard.extend(Switchboard::Helpers::OAuthPubSubHelper)
+
+    switchboard.on_startup do
+      @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"])
+
+      @pubsub = Jabber::PubSub::OAuthServiceHelper.new(client, settings["pubsub.server"], @oauth_consumer, @oauth_token)
+      @pubsub.add_event_callback do |event|
+        on(:pubsub_event, event)
+      end
+    end
+  end
+end

data/lib/switchboard/jacks/pubsub.rb

@@ -0,0 +1,21 @@
+require 'switchboard/helpers/pubsub'
+
+class PubSubJack
+  def self.connect(switchboard, settings)
+    # TODO generalize this pattern for required settings
+    unless settings["pubsub.server"]
+      puts "A pubsub server must be specified."
+      return false
+    end
+
+    switchboard.extend(Switchboard::Helpers::PubSubHelper)
+
+    switchboard.on_startup do
+      @pubsub = Jabber::PubSub::ServiceHelper.new(client, settings["pubsub.server"])
+
+      @pubsub.add_event_callback do |event|
+        on(:pubsub_event, event)
+      end
+    end
+  end
+end

data/lib/switchboard/jacks/roster_debug.rb

@@ -0,0 +1,23 @@
+class RosterDebugJack
+  def self.connect(switchboard, settings)
+    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/settings.rb

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

data/lib/switchboard/switchboard.rb

@@ -0,0 +1,12 @@
+begin
+  require 'oauth'
+rescue LoadError
+end
+
+require 'switchboard/core'
+require 'switchboard/client'
+require 'switchboard/component'
+require 'switchboard/jacks'
+require 'switchboard/settings'
+require 'switchboard/version'
+

data/lib/switchboard/version.rb

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

data/switchboard.gemspec

@@ -0,0 +1,15 @@
+# this file is automatically generated
+Gem::Specification.new do |s|
+  s.name = "switchboard"
+  s.version = "0.1.0"
+  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/switchboard", "examples/echo_bot.rb", "History.txt", "lib/switchboard/client.rb", "lib/switchboard/colors.rb", "lib/switchboard/commands/command.rb", "lib/switchboard/commands/config/config.rb", "lib/switchboard/commands/config.rb", "lib/switchboard/commands/default.rb", "lib/switchboard/commands/disco/disco.rb", "lib/switchboard/commands/disco/info.rb", "lib/switchboard/commands/disco/items.rb", "lib/switchboard/commands/disco.rb", "lib/switchboard/commands/grep.rb", "lib/switchboard/commands/help/help.rb", "lib/switchboard/commands/help.rb", "lib/switchboard/commands/last/last.rb", "lib/switchboard/commands/last.rb", "lib/switchboard/commands/pep/location.rb", "lib/switchboard/commands/pep/pep.rb", "lib/switchboard/commands/pep/tune.rb", "lib/switchboard/commands/pep.rb", "lib/switchboard/commands/pubsub/affiliations.rb", "lib/switchboard/commands/pubsub/config.rb", "lib/switchboard/commands/pubsub/create.rb", "lib/switchboard/commands/pubsub/delete.rb", "lib/switchboard/commands/pubsub/info.rb", "lib/switchboard/commands/pubsub/items.rb", "lib/switchboard/commands/pubsub/listen.rb", "lib/switchboard/commands/pubsub/nodes.rb", "lib/switchboard/commands/pubsub/options.rb", "lib/switchboard/commands/pubsub/publish.rb", "lib/switchboard/commands/pubsub/pubsub.rb", "lib/switchboard/commands/pubsub/purge.rb", "lib/switchboard/commands/pubsub/retract.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/register.rb", "lib/switchboard/commands/roster/add.rb", "lib/switchboard/commands/roster/list.rb", "lib/switchboard/commands/roster/online.rb", "lib/switchboard/commands/roster/remove.rb", "lib/switchboard/commands/roster/roster.rb", "lib/switchboard/commands/roster.rb", "lib/switchboard/commands/unregister.rb", "lib/switchboard/commands.rb", "lib/switchboard/component.rb", "lib/switchboard/core.rb", "lib/switchboard/ext/delegate.rb", "lib/switchboard/ext/instance_exec.rb", "lib/switchboard/helpers/oauth_pubsub.rb", "lib/switchboard/helpers/pubsub.rb", "lib/switchboard/jacks/auto_accept.rb", "lib/switchboard/jacks/debug.rb", "lib/switchboard/jacks/echo.rb", "lib/switchboard/jacks/notify.rb", "lib/switchboard/jacks/oauth_pubsub.rb", "lib/switchboard/jacks/pubsub.rb", "lib/switchboard/jacks/roster_debug.rb", "lib/switchboard/jacks.rb", "lib/switchboard/settings.rb", "lib/switchboard/switchboard.rb", "lib/switchboard/version.rb", "lib/switchboard.rb", "Rakefile", "README.markdown", "switchboard.gemspec"]
+  s.executables = ["switchboard"]
+  s.require_paths = ["lib"]
+
+  s.add_dependency("xmpp4r", ">=", "0.5")
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: switchboard
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Seth Fitzsimmons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+description: A toolkit for assembling XMPP clients and interacting with XMPP servers.
+email: 
+- seth@mojodna.net
+executables: 
+- switchboard
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/switchboard
+- examples/echo_bot.rb
+- History.txt
+- lib/switchboard/client.rb
+- lib/switchboard/colors.rb
+- lib/switchboard/commands/command.rb
+- lib/switchboard/commands/config/config.rb
+- lib/switchboard/commands/config.rb
+- lib/switchboard/commands/default.rb
+- lib/switchboard/commands/disco/disco.rb
+- lib/switchboard/commands/disco/info.rb
+- lib/switchboard/commands/disco/items.rb
+- lib/switchboard/commands/disco.rb
+- lib/switchboard/commands/grep.rb
+- lib/switchboard/commands/help/help.rb
+- lib/switchboard/commands/help.rb
+- lib/switchboard/commands/last/last.rb
+- lib/switchboard/commands/last.rb
+- lib/switchboard/commands/pep/location.rb
+- lib/switchboard/commands/pep/pep.rb
+- lib/switchboard/commands/pep/tune.rb
+- lib/switchboard/commands/pep.rb
+- lib/switchboard/commands/pubsub/affiliations.rb
+- lib/switchboard/commands/pubsub/config.rb
+- lib/switchboard/commands/pubsub/create.rb
+- lib/switchboard/commands/pubsub/delete.rb
+- lib/switchboard/commands/pubsub/info.rb
+- lib/switchboard/commands/pubsub/items.rb
+- lib/switchboard/commands/pubsub/listen.rb
+- lib/switchboard/commands/pubsub/nodes.rb
+- lib/switchboard/commands/pubsub/options.rb
+- lib/switchboard/commands/pubsub/publish.rb
+- lib/switchboard/commands/pubsub/pubsub.rb
+- lib/switchboard/commands/pubsub/purge.rb
+- lib/switchboard/commands/pubsub/retract.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/register.rb
+- lib/switchboard/commands/roster/add.rb
+- lib/switchboard/commands/roster/list.rb
+- lib/switchboard/commands/roster/online.rb
+- lib/switchboard/commands/roster/remove.rb
+- lib/switchboard/commands/roster/roster.rb
+- lib/switchboard/commands/roster.rb
+- lib/switchboard/commands/unregister.rb
+- lib/switchboard/commands.rb
+- lib/switchboard/component.rb
+- lib/switchboard/core.rb
+- lib/switchboard/ext/delegate.rb
+- lib/switchboard/ext/instance_exec.rb
+- lib/switchboard/helpers/oauth_pubsub.rb
+- lib/switchboard/helpers/pubsub.rb
+- lib/switchboard/jacks/auto_accept.rb
+- lib/switchboard/jacks/debug.rb
+- lib/switchboard/jacks/echo.rb
+- lib/switchboard/jacks/notify.rb
+- lib/switchboard/jacks/oauth_pubsub.rb
+- lib/switchboard/jacks/pubsub.rb
+- lib/switchboard/jacks/roster_debug.rb
+- lib/switchboard/jacks.rb
+- lib/switchboard/settings.rb
+- lib/switchboard/switchboard.rb
+- lib/switchboard/version.rb
+- lib/switchboard.rb
+- Rakefile
+- README.markdown
+- switchboard.gemspec
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: XMPP toolkit.
+test_files: []
+