blather 0.7.0 → 0.7.1

data/CHANGELOG.md

@@ -1,6 +1,13 @@
-# develop
+# [develop](https://github.com/sprsquish/blather/compare/master...develop)
 
-# v0.7.0
+# [v0.7.1](https://github.com/sprsquish/blather/compare/v0.7.0...v0.7.1) - [2012-04-29](https://rubygems.org/gems/blather/versions/0.7.1)
+  * Documentation updates
+  * Bugfix(benlangfeld): Relax Nokogiri dependency to allow 1.5
+  * Bugfix(benlangfeld): Fix some nokogiri 1.5 related bugs on JRuby (some remain)
+  * Bugfix(benlangfeld): Set namespaces correctly on some tricky nodes
+  * Bugfix(benlangfeld): Ensure all presence sub-types trigger the correct handlers
+
+# [v0.7.0](https://github.com/sprsquish/blather/compare/v0.6.2...v0.7.0) - [2012-03-15](https://rubygems.org/gems/blather/versions/0.7.0)
   * Change(benlangfeld): Drop Ruby 1.8.7 compatability
   * Change(bklang): Remove the wire log, which duplicated the parsed logging
   * Feature(benlangfeld): Stanza handlers are now executed outside of the EM reactor, so it is not blocked on stanza processing
@@ -10,34 +17,34 @@
   * Bugfix(benlangfeld): Presence stanzas are now composed on import, including all children
   * Bugfix(mtrudel): JIDs in roster item stanzas are now stripped of resources
 
-# v0.6.2
-  * Feature(benlangfeld): Add password support to MUCUser
-  * Feature(benlangfeld): Add support for invitation elements to MUCUser messages
+# [v0.6.2](https://github.com/sprsquish/blather/compare/v0.6.1...v0.6.2) - [2012-02-28](https://rubygems.org/gems/blather/versions/0.6.2)
+  * Feature(benlangfeld): Add password support to `MUCUser`
+  * Feature(benlangfeld): Add support for invitation elements to `MUCUser` messages
   * Feature(benlangfeld): Add support for MUC invite declines
   * Bugfix(benlangfeld): Don't implicitly create an invite node when checking invite status
   * Bugfix(benlangfeld): Ensure that form nodes are not duplicated on muc/muc_user presence stanzas
 
-# v0.6.1
+# [v0.6.1](https://github.com/sprsquish/blather/compare/v0.6.0...v0.6.1) - [2012-02-25](https://rubygems.org/gems/blather/versions/0.6.1)
   * Bugfix(benlangfeld): Ensure MUC presence nodes (joining) have a form element on creation
 
-# v0.6.0
+# [v0.6.0](https://github.com/sprsquish/blather/compare/v0.5.12...v0.6.0) - [2012-02-24](https://rubygems.org/gems/blather/versions/0.6.0)
   * Feature(benlangfeld): Very basic MUC and delayed message support
   * Bugfix(theozaurus): Disable connection timeout timer if client deliberately disconnects
-  * Bugfix(mtrudel): Fix Roster#each to return roster_items as per documentation
+  * Bugfix(mtrudel): Fix `Roster#each` to return roster_items as per documentation
 
-# v0.5.12
+# [v0.5.12](https://github.com/sprsquish/blather/compare/v0.5.11...v0.5.12) - [2012-01-06](https://rubygems.org/gems/blather/versions/0.5.12)
   * Bugfix(benlangfeld): Allow specifying the connection timeout in DSL setup
 
-# v0.5.11
+# [v0.5.11](https://github.com/sprsquish/blather/compare/v0.5.10...v0.5.11) - [2012-01-06](https://rubygems.org/gems/blather/versions/0.5.11)
   * Feature(benlangfeld): Allow specifying a connection timeout
-    * Raise Blather::Stream::ConnectionTimeout if timeout is exceeded
+    * Raise `Blather::Stream::ConnectionTimeout` if timeout is exceeded
     * Default to 180 seconds
 
-# v0.5.10
+# [v0.5.10](https://github.com/sprsquish/blather/compare/v0.5.9...v0.5.10) - [2011-12-02](https://rubygems.org/gems/blather/versions/0.5.10)
   * Feature(juandebravo): Allow configuring the wire log level
   * Bugfix(benlangfeld): Checking connection status before the stream is established
 
-# v0.5.9
+# [v0.5.9](https://github.com/sprsquish/blather/compare/v0.5.8...v0.5.9) - [2011-11-24](https://rubygems.org/gems/blather/versions/0.5.9)
   * Bugfix(benlangfeld): Failed connections now raise a Blather::Stream::ConnectionFailed exception
   * Bugfix(crohr): Blather now supports EventMachine 1.0
 

data/README.md

@@ -1,6 +1,6 @@
 # Blather [ ![Build status](http://travis-ci.org/sprsquish/blather.png) ](http://travis-ci.org/sprsquish/blather)
 
-XMPP DSL (and more) for Ruby written on EventMachine and Nokogiri.
+XMPP DSL (and more) for Ruby written on [EventMachine](http://rubyeventmachine.com/) and [Nokogiri](http://nokogiri.org/).
 
 ## Features
 
@@ -10,9 +10,9 @@ XMPP DSL (and more) for Ruby written on EventMachine and Nokogiri.
 
 ## Project Pages
 
-* [Docs](http://blather.squishtech.com)
 * [GitHub](https://github.com/sprsquish/blather)
 * [Gemcutter](http://gemcutter.org/gems/blather)
+* [API Documentation](http://rdoc.info/gems/blather/file/README.md)
 * [Google Group](http://groups.google.com/group/xmpp-blather)
 
 # Usage
@@ -23,99 +23,138 @@ XMPP DSL (and more) for Ruby written on EventMachine and Nokogiri.
 
 ## Example
 
-See the examples directory for more advanced examples.
+Blather comes with a DSL that makes writing XMPP bots quick and easy. See the examples directory for more advanced examples.
 
-This will auto-accept any subscription requests and echo back any chat messages.
+```ruby
+require 'rubygems'
+require 'blather/client'
 
-    require 'rubygems'
-    require 'blather/client'
+setup 'echo@jabber.local', 'echo'
 
-    setup 'echo@jabber.local', 'echo'
+# Auto approve subscription requests
+subscription :request? do |s|
+  write_to_stream s.approve!
+end
 
-    # 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
+# 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.
+Handlers let Blather know how you'd like each type of stanza to be well.. handled. Each type of stanza has an associated handler which is part of a handler hierarchy. In the example above we're handling message and subscription stanzas.
+
+XMPP is built on top of three main stanza types (presence, message, and iq). All other stanzas are built on these three base types. This creates a natural hierarchy of handlers. For example a subscription stanza is a type of presence stanza and can be processed by a subscription handler or a presence handler. Likewise, a PubSub::Items stanza has its own identifier :pubsub_items but it's also a :pubsub_node, :iq and :staza. Any or each of these could be used to handle the PubSub::Items stanza. If you've done any DOM programming you'll be familiar with this.
+
+Incoming stanzas will be handled by the first handler found. Unlike the DOM this will stop the handling bubble unless the handler returns false.
+
+The entire handler hierarchy can be seen below.
+
+### Example
+
+Here we have a presence handler and a subscription handler. When this script receives a subscription stanza the subscription handler will be notified first. If that handler doesn't know what to do it can return false and let the stanza bubble up to the presence handler.
+
+```ruby
+# Handle all presence stanzas
+presence do |stanza|
+  # do stuff
+end
+
+# Handle all subscription stanzas
+subscription do |stanza|
+  # do stuff
+end
+```
 
-    # Will only be called for messages where #chat? responds positively
-    # and #body == 'exit'
-    message :chat?, :body => 'exit'
+Additionally, handlers may be 'guarded'. That is, they may have conditions set declaratively, against which the stanza must match in order to trigger the handler.
+
+```ruby
+# 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 }
+```ruby
+# 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
+Guards are a concept borrowed from Erlang. They help to better compartmentalize handlers.
+
+There are a number of guard types and one bit of special syntax. 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
+```ruby
+# 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'
+```ruby
+# 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?
+#   It also passes two arguments into the handler block: the stanza and the result
+#   of the xpath query.
+iq '/iq/ns:pubsub', :ns => 'pubsub:namespace' do |stanza, xpath_result|
+  # stanza will be the original stanza
+  # xpath_result will be the pubsub node in the stanza
+end
+```
 
 ### Filters
 
@@ -123,37 +162,241 @@ 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:
+```ruby
+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" }
+```
+
+### Handlers Hierarchy
+
+```
+stanza
+|- iq
+|  |- pubsub_node
+|  |  |- pubsub_affiliations
+|  |  |- pubsub_create
+|  |  |- pubsub_items
+|  |  |- pubsub_publish
+|  |  |- pubsub_retract
+|  |  |- pubsub_subscribe
+|  |  |- pubsub_subscription
+|  |  |- pubsub_subscriptions
+|  |  `- pubsub_unsubscribe
+|  |- pubsub_owner
+|  |  |- pubsub_delete
+|  |  `- pubsub_purge
+|  `- query
+|     |- disco_info
+|     |- disco_items
+|     `- roster
+|- message
+|  `- pubsub_event
+`- presence
+   |- status
+   `- subscription
+
+error
+|- argument_error
+|- parse_error
+|- sasl_error
+|- sasl_unknown_mechanism
+|- stanza_error
+|- stream_error
+|- tls_failure
+`- unknown_response_error
+```
+
+## On the Command Line
 
 Default usage is:
 
-    [blather_script] [options] node@domain.com/resource password [host] [port]
+```
+[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
+```
+-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
+```
 
-## Health warning:
+## Health warning
 
 Some parts of Blather will allow you to do stupid things that don't conform to XMPP
 spec. You should exercise caution and read the relevant specifications (indicated in
 the preamble to most relevant classes).
 
+## Spec compliance
+
+Blather provides support in one way or another for many XMPP specifications. Below is a list of specifications and the status of support for them in Blather. This list *may not be correct*. If the list indicates a lack of support for a specification you wish to use, you are encouraged to check that this is correct. Likewise, if you find an overstatement of Blather's spec compliance, please point this out. Also note that even without built-in support for a specification, you can still manually construct and parse stanzas alongside use of Blather's built-in helpers.
+
+Specification | Support | Notes
+------------- | ------- | -----
+RFC 6120      | Full    |
+RFC 6121      | Full    |
+RFC 6122      | Full    |
+XEP-0001      | N/A     |
+XEP-0002      | N/A     |
+XEP-0004      | Partial |
+XEP-0009      | None    |
+XEP-0012      | None    |
+XEP-0013      | None    |
+XEP-0016      | None    |
+XEP-0019      | N/A     |
+XEP-0020      | Partial |
+XEP-0027      | None    |
+XEP-0030      | Partial |
+XEP-0033      | None    |
+XEP-0045      | Partial |
+XEP-0047      | None    |
+XEP-0048      | None    |
+XEP-0049      | None    |
+XEP-0050      | Partial |
+XEP-0053      | None    |
+XEP-0054      | None    |
+XEP-0055      | None    |
+XEP-0059      | None    |
+XEP-0060      | Partial |
+XEP-0065      | None    |
+XEP-0066      | None    |
+XEP-0068      | None    |
+XEP-0070      | None    |
+XEP-0071      | Partial |
+XEP-0072      | None    |
+XEP-0076      | None    |
+XEP-0077      | None    |
+XEP-0079      | None    |
+XEP-0080      | None    |
+XEP-0082      | None    |
+XEP-0083      | None    |
+XEP-0084      | None    |
+XEP-0085      | Partial |
+XEP-0092      | None    |
+XEP-0095      | Partial |
+XEP-0096      | Partial |
+XEP-0100      | None    |
+XEP-0106      | None    |
+XEP-0107      | None    |
+XEP-0108      | None    |
+XEP-0114      | None    |
+XEP-0115      | Partial |
+XEP-0118      | None    |
+XEP-0122      | None    |
+XEP-0124      | None    |
+XEP-0126      | None    |
+XEP-0127      | None    |
+XEP-0128      | None    |
+XEP-0130      | None    |
+XEP-0131      | None    |
+XEP-0132      | None    |
+XEP-0133      | None    |
+XEP-0134      | None    |
+XEP-0136      | None    |
+XEP-0137      | None    |
+XEP-0138      | None    |
+XEP-0141      | None    |
+XEP-0143      | None    |
+XEP-0144      | N/A     |
+XEP-0145      | None    |
+XEP-0146      | None    |
+XEP-0147      | None    |
+XEP-0148      | None    |
+XEP-0149      | None    |
+XEP-0153      | None    |
+XEP-0155      | None    |
+XEP-0156      | None    |
+XEP-0157      | None    |
+XEP-0158      | None    |
+XEP-0160      | None    |
+XEP-0163      | Partial |
+XEP-0166      | None    |
+XEP-0167      | None    |
+XEP-0169      | None    |
+XEP-0170      | None    |
+XEP-0171      | None    |
+XEP-0172      | None    |
+XEP-0174      | None    |
+XEP-0175      | None    |
+XEP-0176      | None    |
+XEP-0177      | None    |
+XEP-0178      | None    |
+XEP-0182      | N/A     |
+XEP-0183      | None    |
+XEP-0184      | None    |
+XEP-0185      | None    |
+XEP-0191      | None    |
+XEP-0198      | None    |
+XEP-0199      | Partial |
+XEP-0201      | None    |
+XEP-0202      | None    |
+XEP-0203      | Partial |
+XEP-0205      | None    |
+XEP-0206      | None    |
+XEP-0207      | None    |
+XEP-0220      | None    |
+XEP-0221      | None    |
+XEP-0222      | None    |
+XEP-0223      | None    |
+XEP-0224      | None    |
+XEP-0227      | None    |
+XEP-0229      | None    |
+XEP-0231      | None    |
+XEP-0233      | None    |
+XEP-0234      | None    |
+XEP-0239      | None    |
+XEP-0242      | None    |
+XEP-0243      | None    |
+XEP-0245      | None    |
+XEP-0249      | None    |
+XEP-0256      | None    |
+XEP-0258      | None    |
+XEP-0260      | None    |
+XEP-0261      | None    |
+XEP-0262      | None    |
+XEP-0263      | None    |
+XEP-0266      | None    |
+XEP-0267      | None    |
+XEP-0270      | None    |
+XEP-0273      | None    |
+XEP-0277      | None    |
+XEP-0278      | None    |
+XEP-0280      | None    |
+XEP-0288      | None    |
+XEP-0292      | None    |
+XEP-0293      | None    |
+XEP-0294      | None    |
+XEP-0295      | None    |
+XEP-0296      | None    |
+XEP-0297      | None    |
+XEP-0298      | None    |
+XEP-0299      | None    |
+XEP-0300      | None    |
+XEP-0301      | None    |
+XEP-0302      | None    |
+XEP-0303      | None    |
+XEP-0304      | None    |
+XEP-0305      | None    |
+XEP-0306      | None    |
+XEP-0307      | None    |
+XEP-0308      | None    |
+XEP-0309      | None    |
+XEP-0310      | None    |
+XEP-0311      | None    |
+XEP-0312      | None    |
+
+
 # Contributions
 
 All contributions are welcome, even encouraged. However, contributions must be
@@ -167,4 +410,4 @@ than a change set made directly on master.
 
 # Copyright
 
-Copyright (c) 2011 Jeff Smick. See LICENSE for details.
+Copyright (c) 2012 Jeff Smick. See LICENSE for details.

data/blather.gemspec

@@ -34,8 +34,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = %w{LICENSE README.md}
 
   s.add_dependency "eventmachine", [">= 0.12.6"]
-  s.add_dependency "nokogiri", ["~> 1.4.0"]
-  s.add_dependency "niceogiri", ["~> 1.0.0"]
+  s.add_dependency "nokogiri", ["~> 1.4"]
+  s.add_dependency "niceogiri", ["~> 1.0"]
   s.add_dependency "activesupport", [">= 3.0.7"]
   s.add_dependency "girl_friday"
 

data/lib/blather/errors/stream_error.rb

@@ -50,7 +50,8 @@ class StreamError < BlatherError
   #
   # @return [Blather::XMPPNode]
   def to_node
-    node = XMPPNode.new('stream:error')
+    node = XMPPNode.new('error')
+    node.namespace = {'stream' => Blather::Stream::STREAM_NS}
 
     node << (err = XMPPNode.new(@name, node.document))
     err.namespace = 'urn:ietf:params:xml:ns:xmpp-streams'

data/lib/blather/roster_item.rb

@@ -113,11 +113,11 @@ module Blather
     #
     # @return [Blather::Stanza::Iq::Roster]
     def to_stanza(type = nil)
-      r = Stanza::Iq::Roster.new type
-      n = Stanza::Iq::Roster::RosterItem.new jid, name, subscription, ask
-      r.query << n
-      n.groups = groups
-      r
+      Stanza::Iq::Roster.new type, to_node
+    end
+
+    def to_node
+      Stanza::Iq::Roster::RosterItem.new jid, name, subscription, ask, groups
     end
 
     # Compare two RosterItems by their JID

data/lib/blather/stanza.rb

@@ -13,6 +13,7 @@ module Blather
     @@handler_list = []
 
     class_attribute :handler_hierarchy
+    attr_writer :handler_hierarchy
 
     # Registers a callback onto the callback stack
     #
@@ -30,6 +31,15 @@ module Blather
       super name, ns
     end
 
+    def initialize(*args)
+      super
+      @handler_hierarchy = []
+    end
+
+    def handler_hierarchy
+      @handler_hierarchy + self.class.handler_hierarchy
+    end
+
     # The handler stack for the current stanza class
     #
     # @return [Array<Symbol>]

data/lib/blather/stanza/iq/roster.rb

@@ -48,6 +48,8 @@ class Iq
     # This is a convenience class to attach methods to the node
     class RosterItem < XMPPNode
 
+      register :item, Roster.registered_ns
+
       # Create a new RosterItem
       # @overload new(XML::Node)
       #   Create a RosterItem by inheriting a node
@@ -61,6 +63,7 @@ class Iq
       #   the RosterItem must be one of
       #   Blather::RosterItem::VALID_SUBSCRIPTION_TYPES
       #   @option opts [:subscribe, nil] :ask the ask value of the RosterItem
+      #   @option opts [Array<#to_s>] :groups the group names the RosterItem is a member of
       # @overload new(jid = nil, name = nil, subscription = nil, ask = nil)
       #   @param [Blather::JID, String, nil] jid the JID of the item
       #   @param [String, nil] name the alias to give the JID
@@ -68,7 +71,8 @@ class Iq
       #   RosterItem must be one of
       #   Blather::RosterItem::VALID_SUBSCRIPTION_TYPES
       #   @param [:subscribe, nil] ask the ask value of the RosterItem
-      def self.new(jid = nil, name = nil, subscription = nil, ask = nil)
+      #   @param [Array<#to_s>] groups the group names the RosterItem is a member of
+      def self.new(jid = nil, name = nil, subscription = nil, ask = nil, groups = nil)
         new_node = super :item
 
         case jid
@@ -79,11 +83,13 @@ class Iq
           new_node.name = jid[:name]
           new_node.subscription = jid[:subscription]
           new_node.ask = jid[:ask]
+          new_node.groups = jid[:groups]
         else
           new_node.jid = jid
           new_node.name = name
           new_node.subscription = subscription
           new_node.ask = ask
+          new_node.groups = groups
         end
         new_node
       end

data/lib/blather/stanza/pubsub/create.rb

@@ -39,7 +39,7 @@ class PubSub
 
     # Get or create the actual create node on the stanza
     #
-    # @return [Balther::XMPPNode]
+    # @return [Blather::XMPPNode]
     def create_node
       unless create_node = pubsub.find_first('ns:create', :ns => self.class.registered_ns)
         self.pubsub << (create_node = XMPPNode.new('create', self.document))

data/lib/blather/stanza/x.rb

@@ -300,10 +300,10 @@ class Stanza
       #
       # @param [true, false]
       def required?
-        if self.namespace
-          !self.find_first('ns:required', :ns => self.namespace.href).nil?
+        !!if self.namespace
+          self.find_first 'ns:required', :ns => self.namespace.href
         else
-          !self.find_first('required').nil?
+          self.find_first 'required'
         end
       end
 
@@ -311,8 +311,10 @@ class Stanza
       #
       # @param [true, false] required the field's required flag
       def required=(required)
-        self.remove_children(:required) unless required
-        self << XMPPNode.new(:required) if required
+        return self.remove_children(:required) unless required
+
+        self << (r = XMPPNode.new(:required))
+        r.namespace = self.namespace
       end
 
       # Extract list of option objects
@@ -331,7 +333,7 @@ class Stanza
       def options=(options)
         remove_children :option
         if options
-          [options].flatten.each { |o| self << Option.new(o) }
+          Array(options).each { |o| self << Option.new(o) }
         end
       end
 

data/lib/blather/stream.rb

@@ -69,7 +69,7 @@ module Blather
     # to use the domain on the JID
     # @param [Fixnum, nil] port the port to connect on. Default is the XMPP
     # default of 5222
-    # @param [String, nil] certs the trusted cert store in pem format to verify 
+    # @param [String, nil] certs the trusted cert store in pem format to verify
     # communication with the server is trusted.
     # @param [Fixnum, nil] connect_timeout the number of seconds for which to wait for a successful connection
     def self.start(client, jid, pass, host = nil, port = nil, certs_directory = nil, connect_timeout = nil)
@@ -126,7 +126,7 @@ module Blather
     # @param [#to_xml, #to_s] stanza the stanza to send over the wire
     def send(stanza)
       data = stanza.respond_to?(:to_xml) ? stanza.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML) : stanza.to_s
-      Blather.log "SENDING: (#{caller[1]}) #{data}"
+      Blather.log "SENDING: (#{caller[1]}) #{stanza}"
       send_data data
     end
 
@@ -168,15 +168,15 @@ module Blather
       send "<stream:error><xml-not-well-formed xmlns='#{StreamError::STREAM_ERR_NS}'/></stream:error>"
       stop
     end
-    
-    # Called by EM to verify the peer certificate. If a certificate store directory 
+
+    # Called by EM to verify the peer certificate. If a certificate store directory
     # has not been configured don't worry about peer verification. At least it is encrypted
     # We Log the certificate so that you can add it to the trusted store easily if desired
     # @private
     def ssl_verify_peer(pem)
       # EM is supposed to close the connection when this returns false,
       # but it only does that for inbound connections, not when we
-      # make a connection to another server. 
+      # make a connection to another server.
       Blather.log "Checking SSL cert: #{pem}"
       return true if !@@store
       @@store.trusted?(pem).tap do |trusted|

data/lib/blather/version.rb

@@ -1,3 +1,3 @@
 module Blather
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/lib/blather/xmpp_node.rb

@@ -77,6 +77,8 @@ module Blather
         decorator.decorator_modules.each do |mod|
           extend mod
         end
+
+        @handler_hierarchy.unshift decorator.handler_hierarchy.first
       end
       self
     end

data/spec/blather/stanza/presence_spec.rb

@@ -45,24 +45,28 @@ describe Blather::Stanza::Presence do
     s = Blather::Stanza::Presence.parse string
     s.should be_kind_of Blather::Stanza::Presence::C::InstanceMethods
     s.node.should == 'http://www.chatopus.com'
+    s.handler_hierarchy.should include(:c)
   end
 
   it 'creates a Status object when importing a node with type == nil' do
     s = Blather::Stanza::Presence.parse('<presence/>')
     s.should be_kind_of Blather::Stanza::Presence::Status::InstanceMethods
     s.state.should == :available
+    s.handler_hierarchy.should include(Blather::Stanza::Presence::Status.registered_name.to_sym)
   end
 
   it 'creates a Status object when importing a node with type == "unavailable"' do
     s = Blather::Stanza::Presence.parse('<presence type="unavailable"/>')
     s.should be_kind_of Blather::Stanza::Presence::Status::InstanceMethods
     s.state.should == :unavailable
+    s.handler_hierarchy.should include(Blather::Stanza::Presence::Status.registered_name.to_sym)
   end
 
   it 'creates a Subscription object when importing a node with type == "subscribe"' do
     s = Blather::Stanza::Presence.parse('<presence type="subscribe"/>')
     s.should be_kind_of Blather::Stanza::Presence::Subscription::InstanceMethods
     s.type.should == :subscribe
+    s.handler_hierarchy.should include(Blather::Stanza::Presence::Subscription.registered_name.to_sym)
   end
 
   it 'creates a MUC object when importing a node with a form in the MUC namespace' do
@@ -90,6 +94,7 @@ describe Blather::Stanza::Presence do
     s = Blather::Stanza::Presence.parse string
     s.should be_kind_of Blather::Stanza::Presence
     s.type.should == :foo
+    s.handler_hierarchy.should include(Blather::Stanza::Presence.registered_name.to_sym)
   end
 
   it 'behaves like a C, a Status, and a MUCUser when all types of children are present' do
@@ -114,5 +119,7 @@ describe Blather::Stanza::Presence do
     s.state.should == :chat
     s.node.should == 'http://www.chatopus.com'
     s.role.should == :participant
+    s.handler_hierarchy.should include(Blather::Stanza::Presence::C.registered_name.to_sym)
+    s.handler_hierarchy.should include(Blather::Stanza::Presence::Status.registered_name.to_sym)
   end
 end

data/spec/blather/stanza/x_spec.rb

@@ -137,6 +137,10 @@ describe Blather::Stanza::X do
 end
 
 describe Blather::Stanza::X::Field do
+  subject { Blather::Stanza::X::Field.new nil }
+
+  its(:namespace) { subject.href.should be == 'jabber:x:data' }
+
   it 'will auto-inherit nodes' do
     n = parse_stanza "<field type='text-single' var='music' label='Music from the time of Shakespeare' />"
     i = Blather::Stanza::X::Field.new n.root
@@ -193,13 +197,10 @@ describe Blather::Stanza::X::Field do
     n.value.should == 'book2'
   end
 
-  # Option child elements
-  it 'allows adding of options' do
+  it 'allows setting options' do
     di = Blather::Stanza::X::Field.new nil
     di.options.size.should == 0
-    di.options += [{:label => 'Person', :value => 'person'}]
-    di.options.size.should == 1
-    di.options += [Blather::Stanza::X::Field::Option.new(*%w[person1 Person1])]
+    di.options = [{:label => 'Person', :value => 'person'}, Blather::Stanza::X::Field::Option.new(*%w[person1 Person1])]
     di.options.size.should == 2
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blather
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2160912760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,32 +21,47 @@ dependencies:
         version: 0.12.6
   type: :runtime
   prerelease: false
-  version_requirements: *2160912760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.6
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2160912200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2160912200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2160911680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160911680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2160911180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2160911180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
 - !ruby/object:Gem::Dependency
   name: girl_friday
-  requirement: &2160910780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160910780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160910100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2160910100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160830340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160830340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160829420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +133,15 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *2160829420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2160828500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +149,15 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *2160828500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2160828100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +165,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160828100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2160827480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +181,15 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *2160827480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2160826940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +197,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160826940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An XMPP DSL for Ruby written on top of EventMachine and Nokogiri
 email: sprsquish@gmail.com
 executables: []
@@ -314,7 +374,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4263563827557354673
+      hash: 4196042577194384774
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -323,10 +383,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4263563827557354673
+      hash: 4196042577194384774
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Simpler XMPP built for speed