mack-notifier 0.8.1 → 0.8.2

data/lib/gems/xmpp4r-0.4/data/doc/xmpp4r/examples/basic/rosterwatch.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/ruby
+#
+# XMPP4R - XMPP Library for Ruby
+# Copyright (C) 2005 Stephan Maka <stephan@spaceboyz.net>
+# Released under Ruby's license (see the LICENSE file) or GPL, at your option
+#
+#
+# Roster-Watch example
+#
+#
+# Learn how a roster looks like
+#       how presences are received
+#       about subscription requests and answers
+#       what vCards contain
+#
+# It's recommended to insert 'p' commands in this script. :-)
+#
+# This script does:
+#
+# * Listing roster changes
+#
+# * Subscribe to roster items which have a subscription of "none" or "from"
+#   WARNING: Chances are that you don't want that :-)
+#
+# * Requesting vCards for unnamed items in your roster and renaming them
+#   to the <NICKNAME/> or <FN/> field in the vCard
+#
+# * Listing presence changes
+#
+# * Listing subscription and unsubscription requests and answers
+
+$:.unshift '../../../../../lib/'
+
+require 'xmpp4r'
+require 'xmpp4r/roster/helper/roster'
+require 'xmpp4r/vcard/helper/vcard'
+
+# Command line argument checking
+
+if ARGV.size != 2
+  puts("Usage: ./rosterwatch.rb <jid> <password>")
+  exit
+end
+
+# Building up the connection
+
+#Jabber::debug = true
+
+jid = Jabber::JID.new(ARGV[0])
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(ARGV[1])
+
+# The roster instance
+roster = Jabber::Roster::Helper.new(cl)
+
+# Callback to handle updated roster items
+roster.add_update_callback { |olditem,item|
+  if [:from, :none].include?(item.subscription) && item.ask != :subscribe
+    puts("Subscribing to #{item.jid}")
+    item.subscribe
+  end
+
+  # Print the item
+  if olditem.nil?
+    # We didn't knew before:
+    puts("#{item.iname} (#{item.jid}, #{item.subscription}) #{item.groups.join(', ')}")
+  else
+    # Showing whats different:
+    puts("#{olditem.iname} (#{olditem.jid}, #{olditem.subscription}) #{olditem.groups.join(', ')} -> #{item.iname} (#{item.jid}, #{item.subscription}) #{item.groups.join(', ')}")
+  end
+
+  # If the item has no name associated...
+  unless item.iname
+    Thread.new do
+      puts("#{item.jid} has no nickname... getting vCard")
+      begin
+        # ...get a vCard
+        vcard = Jabber::Vcard::Helper.new(cl).get(item.jid.strip)
+
+        unless vcard.nil?
+          # Rename him to vCard's <NICKNAME/> field
+          if vcard['NICKNAME']
+            item.iname = vcard['NICKNAME']
+            puts("Renaming #{item.jid} to #{vcard['NICKNAME']}")
+            item.send
+          # Rename him to vCard's <FN/> field
+          elsif vcard['FN']
+            item.iname = vcard['FN']
+            puts("Renaming #{item.jid} to #{vcard['FN']}")
+            item.send
+          # We've got a lazy one
+          else
+            puts("#{item.jid} provided no details in vCard")
+          end
+        end
+
+      rescue Exception => e
+        # This will be (mostly) thrown by Jabber::Vcard::Helper#get
+        puts("Error getting vCard for #{item.jid}: #{e.to_s}")
+      end
+    end
+  end
+}
+
+# Presence updates:
+roster.add_presence_callback { |item,oldpres,pres|
+  # Can't look for something that just does not exist...
+  if pres.nil?
+    # ...so create it:
+    pres = Jabber::Presence.new
+  end
+  if oldpres.nil?
+    # ...so create it:
+    oldpres = Jabber::Presence.new
+  end
+
+  # Print name and jid:
+  name = "#{pres.from}"
+  if item.iname
+    name = "#{item.iname} (#{pres.from})"
+  end
+  puts(name)
+
+  # Print type changes:
+  unless oldpres.type.nil? && pres.type.nil?
+    puts("  Type: #{oldpres.type.inspect} -> #{pres.type.inspect}")
+  end
+  # Print show changes:
+  unless oldpres.show.nil? && pres.show.nil?
+    puts("  Show:     #{oldpres.show.to_s.inspect} -> #{pres.show.to_s.inspect}")
+  end
+  # Print status changes:
+  unless oldpres.status.nil? && pres.status.nil?
+    puts("  Status:   #{oldpres.status.to_s.inspect} -> #{pres.status.to_s.inspect}")
+  end
+  # Print priority changes:
+  unless oldpres.priority.nil? && pres.priority.nil?
+    puts("  Priority: #{oldpres.priority.inspect} -> #{pres.priority.inspect}")
+  end
+
+  # Note: presences with type='error' will reflect our own show/status/priority
+  # as it is mostly just a reply from a server. This is *not* a bug.
+}
+
+# Subscription requests and responses:
+subscription_callback = lambda { |item,pres|
+  name = pres.from
+  if item != nil && item.iname != nil
+    name = "#{item.iname} (#{pres.from})"
+  end
+  case pres.type
+    when :subscribe then puts("Subscription request from #{name}")
+    when :subscribed then puts("Subscribed to #{name}")
+    when :unsubscribe then puts("Unsubscription request from #{name}")
+    when :unsubscribed then puts("Unsubscribed from #{name}")
+    else raise "The Roster Helper is buggy!!! subscription callback with type=#{pres.type}"
+  end
+}
+roster.add_subscription_callback(0, nil, &subscription_callback)
+roster.add_subscription_request_callback(0, nil, &subscription_callback)
+
+# Send initial presence
+# this is important for receiving presence of subscribed users
+cl.send(Jabber::Presence.new.set_show(:dnd).set_status('Watching my roster change...'))
+
+# Main loop:
+Thread.stop
+
+cl.close

data/lib/gems/xmpp4r-0.4/data/doc/xmpp4r/examples/basic/send_vcard.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/ruby
+
+# Demonstration of the Vcard helper class
+#
+# * Retrieves your own vCard
+# * Modify fields given on the command line
+# * Dumps the vCard
+# * Send your vCard to the server
+
+$:.unshift('../../../../../lib')
+
+require 'xmpp4r'
+require 'xmpp4r/vcard/helper/vcard'
+include Jabber
+
+
+# settings
+if ARGV.length < 2
+  puts "Usage:\t./send_vcard.rb <jid> <password> [<field1>=<value1> [... <fieldN>=<valueN>] ]"
+  puts "Example:\t./send_vcard.rb user@server/resource password NICKNAME=User \"FN=A user\""
+  exit 1
+end
+
+# Do the client stuff...
+myJID = JID.new(ARGV.shift)
+myPassword = ARGV.shift
+cl = Client.new(myJID)
+cl.connect
+cl.auth(myPassword)
+
+# The Vcard helper
+vcard_helper = Vcard::Helper.new(cl)
+
+begin
+  puts "Retrieving vCard information for #{cl.jid.strip}"
+  vcard = vcard_helper.get
+
+
+  # Inspect the command line for vCard fields to be changed
+  ARGV.each { |arg|
+    arg.scan(/^(.+?)=(.*)$/) { |field,text|
+      puts "field #{field}: #{vcard[field].inspect} => #{text.inspect}"
+      vcard[field] = text
+    }
+  }
+
+  # Dump the vCard
+  vcard.fields.each { |field|
+    if field.split(/\//).pop == 'BINVAL'
+      puts "#{field}:\tBINVAL"
+    else
+      puts "#{field}:\t#{vcard[field].inspect}"
+    end
+  }
+
+  begin
+    puts "Sending vCard information for #{cl.jid.strip}"
+    vcard_helper.set(vcard)
+  rescue Exception => e
+    puts "Sorry, we stumbled upon the following when sending the vCard of #{cl.jid.strip}: #{e.to_s.inspect}"
+  end
+
+rescue Exception => e
+  puts "Sorry, we stumbled upon the following when requesting the vCard of #{cl.jid.strip}: #{e.to_s.inspect}"
+end
+
+cl.close

data/lib/gems/xmpp4r-0.4/data/doc/xmpp4r/examples/basic/tune_client.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/roster'
+require 'xmpp4r/discovery'
+require 'xmpp4r/caps'
+require 'xmpp4r/tune'
+
+
+#
+# Echo tunes received via XEP-0118 User Tune notifications
+#
+# See Jabber::UserTune::Helper for the gory details
+#
+
+if ARGV.length != 3
+  puts "Usage: ruby tune_client.rb <jid> <pw> <tune-playing-jid>"
+  exit 1
+end
+
+jid = ARGV[0]
+pw = ARGV[1]
+dj_jid = ARGV[2]
+
+#Jabber::debug=true
+cl = Jabber::Client.new(Jabber::JID.new(jid))
+cl.connect
+cl.auth(pw)
+
+# PEP (XEP-0163 says we need:
+# - a 'both' subscription to the dj
+# - told the server that we support the '...tune+notify' feature
+# before we can receive events
+roster = Jabber::Roster::Helper.new(cl)
+roster.add_subscription_request_callback(0, nil) do |item,pres|
+  roster.accept_subscription(pres.from)
+end
+
+caps = Jabber::Caps::Helper.new(cl,
+  [Jabber::Discovery::Identity.new('client', nil, 'pc')],
+  [Jabber::Discovery::Feature.new('http://jabber.org/protocol/tune+notify')]
+)
+
+t = Jabber::UserTune::Helper.new(cl, dj_jid)
+t.add_usertune_callback do |tune|
+  puts "from:#{dj_jid} tune:#{tune.artist} plays #{tune.title}"
+end
+
+p = Jabber::Presence.new()
+p.type = :subscribe
+p.to = dj_jid
+cl.send p
+
+Thread.stop

data/lib/gems/xmpp4r-0.4/data/doc/xmpp4r/examples/basic/tune_server.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/roster'
+require 'xmpp4r/tune'
+require 'rbosa'
+
+#
+# Send XEP-0118 User Tune events...
+#
+# See Jabber::UserTune::Helper for the gory details...
+#
+# NB needs rbosa library to access iTunes - only on MacOSX
+#
+
+if ARGV.length != 2:
+  puts "Usage: ruby tune_server.rb <jid> <pw>"
+  exit 1
+end
+
+jid=ARGV[0]
+pw=ARGV[1]
+
+Jabber::debug=true
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(pw)
+
+# Following XEP-0163 PEP we need to
+# ensure we have a 'both' subscription to the Tune client
+roster = Jabber::Roster::Helper.new(cl)
+roster.add_subscription_request_callback do |item,pres|
+  roster.accept_subscription(pres.from)
+
+  reply = pres.answer
+  reply.type = :subscribe
+  cl.send(reply)
+end
+
+cl.send(Jabber::Presence.new.set_show(:chat))
+
+t=Jabber::UserTune::Helper.new(cl, nil)
+
+itunes=OSA.app('iTunes')
+
+loop do
+  track = itunes.current_track
+
+  if track
+    puts "Now playing: #{track.name} by #{track.artist}"
+    t.now_playing(Jabber::UserTune::Tune.new(track.artist, track.name))
+  end
+
+  sleep 5
+end

data/lib/gems/xmpp4r-0.4/data/doc/xmpp4r/examples/basic/versionbot.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/version/iq/version'
+require 'xmpp4r/version/helper/simpleresponder'
+
+
+# A Hash containing all Version Query answers with their JIDs as keys:
+versions = {}
+
+# Command line argument checking
+
+if ARGV.size != 2
+  puts("Usage: ./versionbot.rb <jid> <password>")
+  exit
+end
+
+# Building up the connection
+
+#Jabber::debug = true
+
+jid = Jabber::JID.new(ARGV[0])
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(ARGV[1])
+
+cl.on_exception { |*a|
+  p a[0].backtrace
+  exit!
+}
+
+# I'm not sure about the portability of 'uname -sr' here ;-)
+# but that's all needed to answer version queries:
+Jabber::Version::SimpleResponder.new(cl, 'xmpp4r Versionbot example', Jabber::XMPP4R_VERSION, IO.popen('uname -sr').readlines.to_s.strip)
+
+
+cl.add_iq_callback { |iq|
+  # Filter for version query results
+  if (iq.type == :result) && iq.query.kind_of?(Jabber::Version::IqQueryVersion)
+    puts "Version query result from #{iq.from}"
+    # Keep track of results per JID
+    versions[iq.from] = iq.query
+    # Print details
+    puts "  Name: #{iq.query.iname.inspect}"
+    puts "  Version: #{iq.query.version.inspect}"
+    puts "  OS: #{iq.query.os.inspect}"
+  end
+}
+
+cl.add_presence_callback { |pres|
+  # Already fingerprinted or offline?
+  unless versions.has_key?(pres.from) || (pres.type == :unavailable) || (pres.type == :error)
+    # Construct a new query
+    iq = Jabber::Iq.new(:get, pres.from)
+    # and ask for the version
+    iq.query = Jabber::Version::IqQueryVersion.new
+    puts "Asking #{iq.to} for his/her/its version"
+    versions[pres.from] = :asking
+    cl.send(iq)
+  end
+}
+
+# Send initial presence
+cl.send(Jabber::Presence.new.set_show(:xa).set_status('I am the evil fingerprinting robot'))
+
+# Main loop:
+loop do
+  cl.process
+  sleep(1)
+end
+
+cl.close

data/lib/gems/xmpp4r-0.4/lib/xmpp4r.rb

@@ -0,0 +1,116 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+#
+# ==Introduction
+#
+# XMPP4R is a XMPP/Jabber library for Ruby. It can be used to build scripts
+# using Jabber, full-featured Jabber clients, and components. It is written
+# with extensibility in mind.
+#
+# ==XML management
+#
+# All the XML parsing is REXML's, and XML stanzas like <message/> (class
+# <tt>Jabber::Message</tt>) or <iq/> (class <tt>Jabber::Iq</tt>) are indirect
+# derivatives from REXML's Element class. This provide a maximum flexibity:
+# the user can access attributes and childs using either the XMPP4R's helpers
+# or directly using REXML's methods.
+#
+# ===Automatic element casting
+#
+# Because there are special classes derived from REXML::Element to ease
+# development on the protocol level, Elements must be cast to them. This is
+# done via REXML::Element.import. This method is also used in import class
+# methods of some Element classes.
+#
+# The first occurance of this feature is in Jabber::Stream::receive:
+# * <tt><message/></tt> stanzas are cast to Jabber::Message class
+# * <tt><presence/></tt> stanzas are cast to Jabber::Presence class
+# * <tt><iq/></tt> stanzas are cast to Jabber::Iq class
+#
+# This is not only useful for stanzas but all other XML processing, too:
+# * <tt><x/></tt> children elements of <tt><message/></tt> and <tt><presence/></tt> are converted to Jabber::X
+# * <tt><error/></tt> children elements of all three stanzas are converted to Jabber::ErrorResponse
+# * <tt><query/></tt> children elements of <tt><iq/></tt> are converted to Jabber::IqQuery
+# * <tt><vCard/></tt> children elements of <tt><iq/></tt> are converted to Jabber::IqVcard
+#
+# The following conversion facilities are only executed if the respective
+# library parts are loaded. See below for more details on Non-basic features.
+# * Jabber::IqQuery elements are converted to Jabber::Roster::IqQueryRoster if their
+#   namespace is 'jabber:iq:roster'
+# * Jabber::IqQuery elements are converted to Jabber::Version::IqQueryVersion if their
+#   namespace is 'jabber:iq:version'
+# * Jabber::IqQuery elements are converted to Jabber::Discovery::IqQueryDiscoInfo if their
+#   namespace is 'http://jabber.org/protocol/disco#info'
+# * Jabber::IqQuery elements are converted to Jabber::Discovery::IqQueryDiscoItems if their
+#   namespace is 'http://jabber.org/protocol/disco#items'
+# * <tt><item/></tt> children elements of Jabber::Roster::IqQueryRoster are converted
+#   to Jabber::Roster::RosterItem
+# * <tt><identity/></tt> children elements of Jabber::IqQueryDiscoInfo are converted
+#   to Jabber::Discovery::DiscoIdentity
+# * <tt><feature/></tt> children elements of Jabber::IqQueryDiscoInfo are converted
+#   to Jabber::Discovery::DiscoFeature
+# * <tt><item/></tt> children elements of Jabber::IqQueryDiscoItems are converted
+#   to Jabber::Discovery::DiscoItem
+#
+# To use this, don't check for:
+# <tt>iq.queryns == 'http://jabber.org/protocol/disco#info'</tt>
+#
+# But instead check for the query's class:
+# <tt>iq.query.kind_of?(Jabber::IqQueryDiscoInfo)</tt>
+#
+# ==Where to begin?
+#
+# Because it is built in an extensible way, it might be hard for newcomers to
+# understand where to look at documentation for a specific method. For example,
+# Client inherits from Connection, which itself inherits from Stream.
+#
+# A newcomer should have a look at the <tt>Jabber::Client</tt> and
+# <tt>Jabber::Component</tt> classes, and their parent classes
+# <tt>Jabber::Connection</tt> and <tt>Jabber::Stream</tt>.  The best way to
+# understand how to use them is probably to look at the examples in the
+# <tt>examples/</tt> dir.
+#
+# ==Non-basic features
+#
+# <tt>require 'xmpp4r'</tt> only includes basic functionality for
+# Connections, Authentication, Stream processing, Callbacks, Stanza handling
+# and Debugging to keep the library's footprint small.
+#
+# There is code for features that aren't required by a *basic* client. These
+# must be additionally included to use them.
+#
+# ===Protocol-level features
+#
+# You're highly advised to read the according RFCs and JEPs if you intend to
+# use them. The benefit will be that you'll understand the protocols and be
+# going to be more efficient when programming with them.
+#
+# * Jabber::Bytestreams, Jabber::FileTransfer: <tt>require 'xmpp4r/bytestreams'</tt>
+# * Jabber::Dataforms: <tt>require 'xmpp4r/dataforms'</tt>
+# * Jabber::Delay: <tt>require 'xmpp4r/delay'</tt>
+# * Jabber::Discovery: <tt>require 'xmpp4r/discovery'</tt>
+# * Jabber::FeatureNegotiation: <tt>require 'xmpp4r/feature_negotiation'</tt>
+# * Jabber::MUC: <tt>require 'xmpp4r/muc'</tt>
+# * Jabber::Roster: <tt>require 'xmpp4r/roster'</tt>
+# * Jabber::Vcard: <tt>require 'xmpp4r/vcard'</tt>
+# * Jabber::Version: <tt>require 'xmpp4r/version'</tt>
+#
+# ===Helpers
+#
+# Helpers are intended to give more simplistic interfaces to various tasks
+# of Jabber clients at the cost of flexibility. But you won't need that
+# level of flexibility in most cases.
+#
+# * Jabber::Roster::Helper: <tt>require 'xmpp4r/roster'</tt>
+# * Jabber::MUC::MUCBrowser, Jabber::MUC::MUCClient, Jabber::MUC::SimpleMUCClient: <tt>require 'xmpp4r/muc'</tt>
+# * Jabber::Version::SimpleResponder, Jabber::Version::Responder: <tt>require 'xmpp4r/version'</tt>
+# * Jabber::Vcard::Helper: <tt>require 'xmpp4r/vcard'</tt>
+# * Jabber::FileTransfer::Helper, Jabber::Bytestreams::SOCKS5BytestreamsServer: <tt>require 'xmpp4r/bytestreams'</tt>
+#
+# ==Debugging
+#
+# Dumping your Jabber stream can be enabled this way:
+#   Jabber::debug = true
+
+require 'xmpp4r/xmpp4r'