shingara-blather 0.4.8

data/LICENSE

@@ -0,0 +1,22 @@
+Blather
+
+Copyright (c) 2009 Jeff Smick
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,162 @@
+# Blather
+
+XMPP DSL (and more) for Ruby written on EventMachine and Nokogiri.
+
+## Features
+
+* evented architecture
+* uses Nokogiri
+* simplified starting point
+
+## Project Pages
+
+* [Docs](http://blather.squishtech.com)
+* [GitHub](https://github.com/sprsquish/blather)
+* [Gemcutter](http://gemcutter.org/gems/blather)
+* [Google Group](http://groups.google.com/group/xmpp-blather)
+
+# Usage
+
+## Installation
+
+    sudo gem install blather
+
+## Example
+
+See the examples directory for more advanced examples.
+
+This will auto-accept any subscription requests and echo back any chat messages.
+
+    require 'rubygems'
+    require 'blather/client'
+
+    setup 'echo@jabber.local', 'echo'
+
+    # Auto approve subscription requests
+    subscription :request? do |s|
+      write_to_stream s.approve!
+    end
+
+    # Echo back what was said
+    message :chat?, :body do |m|
+      write_to_stream m.reply
+    end
+
+## Handlers
+
+Setup handlers by calling their names as methods.
+
+    # Will only be called for messages where #chat? responds positively
+    # and #body == 'exit'
+    message :chat?, :body => 'exit'
+
+### Non-Stanza Handlers
+
+So far there are two non-stanza related handlers.
+
+    # Called after the connection has been connected. It's good for initializing
+    # your system.
+    # DSL:
+    when_ready {}
+    # Client:
+    client.register_handler(:ready) {}
+
+    # Called after the connection has been terminated. Good for teardown or
+    # automatic reconnection.
+    # DSL:
+    disconnected {}
+    # Client
+    client.register_handler(:disconnected) {}
+    # The following will reconnect every time the connection is lost:
+    disconnected { client.connect }
+
+### Handler Guards
+
+Guards act like AND statements. Each condition must be met if the handler is to
+be used.
+
+    # Equivalent to saying (stanza.chat? && stanza.body)
+    message :chat?, :body
+
+The different types of guards are:
+
+    # Symbol
+    #   Checks for a non-false reply to calling the symbol on the stanza
+    #   Equivalent to stanza.chat?
+    message :chat?
+
+    # Hash with any value (:body => 'exit')
+    #   Calls the key on the stanza and checks for equality
+    #   Equivalent to stanza.body == 'exit'
+    message :body => 'exit'
+
+    # Hash with regular expression (:body => /exit/)
+    #   Calls the key on the stanza and checks for a match
+    #   Equivalent to stanza.body.match /exit/
+    message :body => /exit/
+
+    # Hash with array (:name => [:gone, :forbidden])
+    #   Calls the key on the stanza and check for inclusion in the array
+    #   Equivalent to [:gone, :forbidden].include?(stanza.name)
+    stanza_error :name => [:gone, :fobidden]
+
+    # Proc
+    #   Calls the proc passing in the stanza
+    #   Checks that the ID is modulo 3
+    message proc { |m| m.id % 3 == 0 }
+
+    # Array
+    #   Use arrays with the previous types effectively turns the guard into
+    #   an OR statement.
+    #   Equivalent to stanza.body == 'foo' || stanza.body == 'baz'
+    message [{:body => 'foo'}, {:body => 'baz'}]
+
+    # XPath
+    #   Runs the xpath query on the stanza and checks for results
+    #   This guard type cannot be combined with other guards
+    #   Equivalent to !stanza.find('/iq/ns:pubsub', :ns => 'pubsub:namespace').empty?
+    iq '/iq/ns:pubsub', :ns => 'pubsub:namespace'
+
+### Filters
+
+Blather provides before and after filters that work much the way regular
+handlers work. Filters come in a before and after flavor. They're called in
+order of definition and can be guarded like handlers.
+
+    before { |s| "I'm run before any handler" }
+    before { |s| "I'm run next" }
+
+    before(:message) { |s| "I'm only run in front of message stanzas" }
+    before(nil, :id => 1) { |s| "I'll only be run when the stanza's ID == 1" }
+
+    # ... handlers
+
+    after { |s| "I'm run after everything" }
+
+## On the Command Line:
+
+Default usage is:
+
+    [blather_script] [options] node@domain.com/resource password [host] [port]
+
+Command line options:
+
+    -D, --debug       Run in debug mode (you will see all XMPP communication)
+    -d, --daemonize   Daemonize the process
+        --pid=[PID]   Write the PID to this file
+        --log=[LOG]   Write to the [LOG] file instead of stdout/stderr
+    -h, --help        Show this message
+    -v, --version     Show version
+
+
+# Author
+
+[Jeff Smick](http://github.com/sprsquish)
+
+### Contributors
+
+[Nolan Darilek](http://github.com/thewordnerd)
+
+# Copyright
+
+Copyright (c) 2009 Jeff Smick. See LICENSE for details.

data/examples/echo.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'blather/client'
+
+when_ready { puts "Connected ! send messages to #{jid.stripped}." }
+
+subscription :request? do |s|
+  write_to_stream s.approve!
+end
+
+message :chat?, :body => 'exit' do |m|
+  say m.from, 'Exiting ...'
+  shutdown
+end
+
+message :chat?, :body do |m|
+  say m.from, "You sent: #{m.body}"
+end

data/examples/execute.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'blather/client'
+
+message :chat?, :body => 'exit' do |m|
+  say m.from, 'Exiting ...'
+  shutdown
+end
+
+message :chat?, :body do |m|
+  begin
+    say m.from, eval(m.body)
+  rescue => e
+    say m.from, e.inspect
+  end
+end

data/examples/ping_pong.rb

@@ -0,0 +1,37 @@
+require 'blather/client/dsl'
+$stdout.sync = true
+
+module Ping
+  extend Blather::DSL
+  def self.run; client.run; end
+
+  setup 'echo@jabber.local/ping', 'echo'
+
+  status :from => Blather::JID.new('echo@jabber.local/pong') do |s|
+    puts "serve!"
+    say s.from, 'ping'
+  end
+
+  message :chat?, :body => 'pong' do |m|
+    puts "ping!"
+    say m.from, 'ping'
+  end
+end
+
+module Pong
+  extend Blather::DSL
+  def self.run; client.run; end
+
+  setup 'echo@jabber.local/pong', 'echo'
+  message :chat?, :body => 'ping' do |m|
+    puts "pong!"
+    say m.from, 'pong'
+  end
+end
+
+trap(:INT) { EM.stop }
+trap(:TERM) { EM.stop }
+EM.run do
+  Ping.run
+  Pong.run
+end

data/examples/print_hierarchy.rb

@@ -0,0 +1,76 @@
+require 'blather'
+
+class Object
+  begin
+    ObjectSpace.each_object(Class.new) {}
+
+    # Exclude this class unless it's a subclass of our supers and is defined.
+    # We check defined? in case we find a removed class that has yet to be
+    # garbage collected. This also fails for anonymous classes -- please
+    # submit a patch if you have a workaround.
+    def subclasses_of(*superclasses)
+      subclasses = []
+
+      superclasses.each do |sup|
+        ObjectSpace.each_object(class << sup; self; end) do |k|
+          if k != sup && (k.name.blank? || eval("defined?(::#{k}) && ::#{k}.object_id == k.object_id"))
+            subclasses << k
+          end
+        end
+      end
+
+      subclasses
+    end
+  rescue RuntimeError
+    # JRuby and any implementations which cannot handle the objectspace traversal
+    # above fall back to this implementation
+    def subclasses_of(*superclasses)
+      subclasses = []
+
+      superclasses.each do |sup|
+        ObjectSpace.each_object(Class) do |k|
+          if superclasses.any? { |superclass| k < superclass } &&
+            (k.name.blank? || eval("defined?(::#{k}) && ::#{k}.object_id == k.object_id"))
+            subclasses << k
+          end
+        end
+        subclasses.uniq!
+      end
+      subclasses
+    end
+  end
+end
+
+class Hash
+  def deep_merge(second)
+    # From: http://www.ruby-forum.com/topic/142809
+    # Author: Stefan Rusterholz
+    merger = proc { |key,v1,v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    self.merge(second, &merger)
+  end
+end
+
+handlers = {}
+(Object.subclasses_of(Blather::Stanza) + Object.subclasses_of(Blather::BlatherError)).each do |klass|
+  handlers = handlers.deep_merge klass.handler_hierarchy.inject('klass' => klass.to_s.gsub('Blather::', '')) { |h,k| {k.to_s => h} }
+end
+
+level = 0
+runner = proc do |k,v|
+  next if k == 'klass'
+
+  str = ''
+  if level > 0
+    (level - 1).times { str << '|  ' }
+    str << '|- '
+  end
+
+  puts str+k
+  if Hash === v
+    level += 1
+    v.sort.each &runner
+    level -= 1
+  end
+end
+
+handlers.sort.each &runner

data/examples/rosterprint.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Prints out each roster entry
+
+require 'blather/client'
+
+when_ready do
+  roster.grouped.each do |group, items|
+    puts "#{'*'*3} #{group || 'Ungrouped'} #{'*'*3}"
+    items.each { |item| puts "- #{item.name} (#{item.jid})" }
+    puts
+  end
+  shutdown
+end

data/examples/stream_only.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'blather'
+
+trap(:INT) { EM.stop }
+trap(:TERM) { EM.stop }
+EM.run do
+  Blather::Stream::Client.start(Class.new {
+    attr_accessor :jid
+
+    def post_init(stream, jid = nil)
+      @stream = stream
+      self.jid = jid
+
+      @stream.send_data Blather::Stanza::Presence::Status.new
+      puts "Stream started!"
+    end
+
+    def receive_data(stanza)
+      @stream.send_data stanza.reply!
+    end
+
+    def unbind
+      puts "Stream ended!"
+    end
+  }.new, 'echo@jabber.local', 'echo')
+end

data/examples/xmpp4r/echo.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+
+# This bot will reply to every message it receives. To end the game, send 'exit'
+
+require 'xmpp4r/client'
+include Jabber
+
+# settings
+if ARGV.length != 2
+  puts "Run with ./echo_thread.rb user@server/resource password"
+  exit 1
+end
+myJID = JID.new(ARGV[0])
+myPassword = ARGV[1]
+cl = Client.new(myJID)
+cl.connect
+cl.auth(myPassword)
+cl.send(Presence.new)
+puts "Connected ! send messages to #{myJID.strip.to_s}."
+mainthread = Thread.current
+cl.add_message_callback do |m|
+  if m.type != :error
+    m2 = Message.new(m.from, "You sent: #{m.body}")
+    m2.type = m.type
+    cl.send(m2)
+    if m.body == 'exit'
+      m2 = Message.new(m.from, "Exiting ...")
+      m2.type = m.type
+      cl.send(m2)
+      mainthread.wakeup
+    end
+  end
+end
+Thread.stop
+cl.close