blather 0.6.2 → 0.7.0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/.travis.yml

@@ -1,15 +1,8 @@
 rvm:
-  - 1.8.7
-  - ree
   - 1.9.2
   - 1.9.3
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
-  - jruby
-
-branches:
-  only:
-    - master
-    - develop
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,230 @@
+# develop
+
+# v0.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
+  * Bugfix(benlangfeld): MUC user presence and messages now have separate handler names
+  * Feature(benlangfeld): Stanzas may now be imported from a string using `XMPPNode.parse`
+  * Bugfix(benlangfeld): All `Blather::Stanza::Presence::C` attributes are now accessible on importing
+  * 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
+  * 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
+  * Bugfix(benlangfeld): Ensure MUC presence nodes (joining) have a form element on creation
+
+# v0.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
+
+# v0.5.12
+  * Bugfix(benlangfeld): Allow specifying the connection timeout in DSL setup
+
+# v0.5.11
+  * Feature(benlangfeld): Allow specifying a connection timeout
+    * Raise Blather::Stream::ConnectionTimeout if timeout is exceeded
+    * Default to 180 seconds
+
+# v0.5.10
+  * Feature(juandebravo): Allow configuring the wire log level
+  * Bugfix(benlangfeld): Checking connection status before the stream is established
+
+# v0.5.9
+  * Bugfix(benlangfeld): Failed connections now raise a Blather::Stream::ConnectionFailed exception
+  * Bugfix(crohr): Blather now supports EventMachine 1.0
+
+# v0.5.8
+  * Bugfix(benlangfeld): JIDs now maintain case, but still compare case insensitively
+  * Bugfix(jmazzi): Development dependencies now resolve correctly on JRuby and Rubinius
+
+# v0.5.7
+  * Bugfix(benlangfeld): Don't install BlueCloth as a development dependency when on JRuby
+
+# v0.5.6
+  * Changes from 0.5.5, this time without a bug when using the namespaced DSL approach
+
+# v0.5.5 (yanked)
+  * Bugfix(benlangfeld/kibs): ActiveSupport was overriding the presence DSL method
+  * Feature(fyafighter): Adds SSL peer verification to TLS
+
+# v0.5.4
+  * Bugfix(fyafighter): Regression related to earlier refactoring: https://github.com/sprsquish/blather/issues/53
+  * Feature(fyafighter): Make it much easier to allow private network addresses
+  * Bugfix(benlangfeld): Fix the Nokogiri dependency to the 1.4.x series, due to a bug in 1.5.x
+  * Bugfix(zlu): Replace class_inheritable_attribute with class_attribute because it is deprecated in ActiveSupport 3.1
+
+# v0.5.3
+  * Feature(benlangfeld): Add XMPP Ping (XEP-0199) support
+
+# v0.5.2
+  * Bugfix(benlangfeld): Remove specs for the Nokogiri extensions which were moved out
+
+# v0.5.1 - yanked
+  * Feature(benlangfeld): Abstract out Nokogiri extensions and helpers into new Niceogiri gem for better sharing
+  * Documentation(benlangfeld)
+
+# v0.5.0
+  * Feature(radsaq): Add a #connected? method on Blather::Client
+  * Feature(benlangfeld)[API change]: Allow the removal of child nodes from an IQ reply
+  * Bugfix(zlu): Use rubygems properly in examples
+  * Bugfix(benlangfeld): Remove code borrowed from ActiveSupport and instead depend on it to avoid version conflicts
+  * Documentation(sprsquish)
+
+# v0.4.16
+  * Feature(benlangfeld): switch from jeweler to bundler
+  * Feature(benlangfeld): add cap support (XEP-0115)
+  * Bugfix(sprsquish): Better equality checking
+  * Bugfix(sprsquish): Fix #to_proc
+  * Bugfix(mironov): Skip private IPs by default
+
+# v0.4.15
+  * Feature(mironov): Implement XEP-0054: vcard-temp
+  * Feature(benlangfeld): Basic support for PubSub subscription notifications as PubSub events
+  * Feature(mironov): Ability to clear handlers
+  * Feature(mironov): Implement incoming file transfers (XEP-0096, XEP-0065, XEP-0047)
+  * Bugfix(mironov): Fix for importing messages with chat states
+  * Bugfix(mironov): Added Symbol#to_proc method to work on ruby 1.8.6
+  * Bugfix(mironov): Fix roster items .status method to return highest priority presence
+  * Bugfix(mironov): Remove old unavailable presences while adding new one
+  * Bugfix(mironov): Use Nokogiri::XML::ParseOptions::NOENT to prevent double-encoding of entities
+  * Bugfix(benlangfeld): Disco Info Identities should have an xml:lang attribute
+  * Bugfix(mironov): Fix lookup path for ruby 1.9
+  * Bugfix(mironov): stanza_error.to_node must set type of the error
+  * Bugfix(mironov): Allow message to have iq child
+  * Bugfix(mironov): Find xhtml body in messages sent from iChat 5.0.3
+
+# v0.4.14
+  * Tests: get specs fully passing on rubinius
+  * Feature(mironov): Implement XEP-0085 Chat State Notifications
+  * Bugfix(mironov): send stanzas unformatted
+  * Bugfix(mironov): Message#xhtml uses inner_html so tags aren't escaped
+  * Bugfix(mironov): Message#xhtml= now works with multiple root nodes
+
+# v0.4.13
+  * Bugfix: Place form child of command inside command element
+
+# v0.4.12
+  * API Change: Switch order of var and type arguments to X::Field.new since var is always required but type is not
+  * API Change: PubSub payloads can be strings or nodes and can be set nil. PubSub#payload will always return a string
+  * Feature: Add forms to Message stanzas
+
+# v0.4.11
+  * Bugfix: command nodes where generating the wrong xml
+  * Bugfix: x nodes where generating the wrong xml
+  * Feature: ability to set identities and features on disco info nodes
+  * Feature: ability to set items on disco item nodes
+
+# v0.4.10
+  * no change
+
+# v0.4.9
+  * Feature: XEP-0004 x:data (benlangfeld)
+  * Feature: XEP-0050 Ad-Hoc commands (benlangfeld)
+  * Minor bugfixes for the specs
+
+# v0.4.8
+  * Feature: add xhtml getter/setter to Message stanza
+  * Bugfix: heirarchy -> hierarchy spelling mistake
+  * Hella documentation
+
+# v0.4.7
+  * Update to work with Nokogiri 1.4.0
+
+# v0.4.6
+  * Bugfix: prioritize authentication mechanisms
+
+# v0.4.5
+  * Bugfix: Change DSL#write to DSL#write_to_stream. Previous way was messing with YAML
+
+# v0.4.4
+  * Add "disconnected" handler type to handle connection termination
+  * Bugfix: Fix error with pubsub using the wrong client connection
+
+# v0.4.3
+  * Bugfix: status stanza with a blank state will be considered :available (GH-23)
+  * Bugfix: ensure regexp guards try to match against a string (GH-24)
+  * Stream creation is now evented. The stream object will be sent to #post_init
+  * Parser debugging disabled by default
+  * Update parser to work with Nokogiri 1.3.2
+  * Bugfix: discover helper now calls the correct method on client
+  * Bugfix: ensure XMPPNode#inherit properly sets namespaces on inherited nodes
+  * Bugfix: xpath guards with namespaces work properly (GH-25)
+
+# v0.4.2
+  * Fix -D option to actually put Blather in debug mode
+  * Stanzas over a client connection will either have the full JID or no JID
+  * Regexp guards can be anything that implements #last_match (Regexp or Oniguruma)
+  * Add "halt" and "pass" to allow handlers to either halt the handler chain or pass to the next handler
+  * Fix default status handler so it doesn't eat the stanza
+  * Add before and after filters. Filters, like handlers, can have guards.
+
+# v0.4.1
+  * Bugfix in roster: trying to call the wrong method on client
+
+# v0.4.0
+  * Switch from LibXML-Ruby to Nokogiri
+  * Update test suite to run on Ruby 1.9
+  * Add "<<" style writer to the DSL to provide for chaining outbound writes
+  * SRV lookup support
+  * Add XPath type of handler guard
+  * PubSub support
+
+# v0.3.4
+  * Remove unneeded functions from the push parser.
+  * Create a ParseWarning error that doesn't kill the stream.
+  * When a parse error comes in the reply should let the other side know it screwed up before dying.
+  * Add the LibXML::XML::Error node to the ParseError/ParseWarning objects.
+
+# v0.3.3
+  * Fix the load error related to not pushing Blather's dir into the load path
+
+# v0.3.2
+  * Switch the push parser from chunking to streaming.
+  * Don't push Blather's dir into the load paths
+
+# v0.3.1
+  * Small changes to the DSL due to handler collisions:
+    "status" -> "set_status"
+    "roster" -> "my_roster"
+  * Small changes to the Blather::Client API to keep it feeling more like EM's API:
+    #stream_started -> #post_init
+    #call -> #receive_data
+    #stop -> #close
+    #stopped -> #unbind
+  * Refactored some of the code internal to Blather::Client
+  * Added command line option handler to default use method (see README)
+  * require libxml-ruby >=1.1.2 (1.1.3 has an inconsistent malloc err on OS X 10.5)
+  * complete specs
+  * add single process ping-pong example
+
+# v0.3.0
+  * Remove autotest discover.rb (created all sorts of conflicts)
+  * Added Hash with Array guard
+  * Added a hirrarchy printer to examples directory
+  * Moved Disco to be in the Stanza namespace (staves off deeply namespaced classes)
+  * Namespaced the DSL methods to Blather::DSL. These can be included in any object you like now. "require 'blather/client'" will still include them directly in Kernel to keep the simple one-file dsl
+  * Stopped doing one class per error type. This created a giant hierarchy tree that was just unnecessary. The error name is now #name. Errors can be matched with a combination of handler and guard.
+  * Fixed XML namespaces. Previous versions weren't actually adding the node to the namespace making xpath queries inconsistent at best.
+  * Added support for anonymous authentication by providing a blank node on the jid ("@[host]")
+
+# v0.2.3
+  * Go back to using the master branch for gems (stupid mistake)
+
+# v0.2.2
+  * Switch to Jeweler.
+  * Move from custom libxml to just a custom push parser
+  * Add guards to handlers
+
+# v0.2.1 Upgrade to libxml 0.9.7
+
+# v0.2 Overhaul the DSL to look more like Sinatra
+
+# v0.1 Initial release (birth!)

data/Guardfile

@@ -1,5 +1,5 @@
-guard 'minitest' do
-  watch(%r|^spec/(.*)_spec\.rb|)
-  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
 end

data/README.md

@@ -162,14 +162,8 @@ than a change set made directly on master.
 
 # Author
 
-[Jeff Smick](http://github.com/sprsquish)
-
-### Contributors
-
-* [Nolan Darilek](http://github.com/thewordnerd)
-* [Tim Carey-Smith](http://github.com/halorgium)
-* [Ben Langfeld](http://github.com/benlangfeld)
-* [Anton Mironov](http://github.com/mironov)
+* [Jeff Smick](http://github.com/sprsquish)
+* [Other Contributors](https://github.com/sprsquish/blather/contributors)
 
 # Copyright
 

data/Rakefile

@@ -1,33 +1,20 @@
-require 'rubygems'
-require 'rake'
+# -*- ruby -*-
+ENV['RUBY_FLAGS'] = "-I#{%w(lib ext bin spec).join(File::PATH_SEPARATOR)}"
 
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'bundler/setup'
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'spec'
-  test.pattern = 'spec/**/*_spec.rb'
-  test.verbose = true
-end
+task :default => :spec
+task :test => :spec
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'spec'
-    test.pattern = 'spec/**/*_spec.rb'
-    test.rcov_opts += ['--exclude \/Library\/Ruby,spec\/', '--xrefs']
-    test.verbose = true
-  end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-  require 'yard'
-  YARD::Tags::Library.define_tag 'Blather handler', :handler, :with_name
-  YARD::Templates::Engine.register_template_path 'yard/templates'
+require 'yard'
+YARD::Tags::Library.define_tag 'Blather handler', :handler, :with_name
+YARD::Templates::Engine.register_template_path 'yard/templates'
 
-  YARD::Rake::YardocTask.new(:doc) do |t|
-    t.options = ['--no-private', '-m', 'markdown', '-o', './doc/public/yard']
-  end
-rescue LoadError
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = ['--no-private', '-m', 'markdown', '-o', './doc/public/yard']
 end
-
-task :default => :test

data/blather.gemspec

@@ -35,26 +35,16 @@ Gem::Specification.new do |s|
 
   s.add_dependency "eventmachine", [">= 0.12.6"]
   s.add_dependency "nokogiri", ["~> 1.4.0"]
-  s.add_dependency "niceogiri", [">= 0.1.0"]
+  s.add_dependency "niceogiri", ["~> 1.0.0"]
   s.add_dependency "activesupport", [">= 3.0.7"]
+  s.add_dependency "girl_friday"
 
-  s.add_development_dependency "minitest", ["~> 1.7.1"]
+  s.add_development_dependency "bundler", ["~> 1.0"]
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", ["~> 2.7"]
   s.add_development_dependency "mocha", ["~> 0.9.12"]
-  s.add_development_dependency "bundler", ["~> 1.0.0"]
-  unless rbx?
-    s.add_development_dependency "rcov", ["~> 0.9.9"]
-    s.add_development_dependency "yard", ["~> 0.6.1"]
-  end
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "yard", ["~> 0.6.1"]
   s.add_development_dependency "jruby-openssl", ["~> 0.7.4"] if jruby?
-  s.add_development_dependency "rake"
-  s.add_development_dependency "guard-minitest"
-
-  unless jruby? || rbx?
-    s.add_development_dependency 'bluecloth'
-  end
-
-  if RUBY_PLATFORM =~ /darwin/ && !rbx?
-    s.add_development_dependency 'growl_notify'
-    s.add_development_dependency 'rb-fsevent'
-  end
+  s.add_development_dependency "bluecloth" unless jruby? || rbx?
 end

data/lib/blather.rb

@@ -8,6 +8,7 @@
   digest/sha1
   logger
   openssl
+  girl_friday
 
   active_support/core_ext/class/attribute
   active_support/core_ext/object/blank

data/lib/blather/client/client.rb

@@ -59,6 +59,10 @@ module Blather
       @roster = Roster.new self
       @caps = Stanza::Capabilities.new
 
+      @handler_queue = GirlFriday::WorkQueue.new :handle_stanza, :size => 5 do |stanza|
+        handle_data stanza
+      end
+
       setup_initial_handlers
     end
 
@@ -181,6 +185,10 @@ module Blather
 
     # @private
     def receive_data(stanza)
+      @handler_queue << stanza
+    end
+
+    def handle_data(stanza)
       catch(:halt) do
         run_filters :before, stanza
         handle_stanza stanza

data/lib/blather/roster.rb

@@ -86,6 +86,13 @@ module Blather
       @items.dup
     end
 
+    # Number of items in the roster
+    #
+    # @return [Integer] the number of items in the roster
+    def length
+      @items.length
+    end
+
     # A hash of items keyed by group
     #
     # @return [Hash<group => Array<RosterItem>>]

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

@@ -99,7 +99,7 @@ class Iq
       #
       # @param [Blather::JID, String, nil] jid the new JID
       def jid=(jid)
-        write_attr :jid, jid
+        write_attr :jid, (jid.nil?) ? nil : JID.new(jid).stripped
       end
 
       # Get the item name

data/lib/blather/stanza/message/muc_user.rb

@@ -7,6 +7,8 @@ class Message
   class MUCUser < Message
     include Blather::Stanza::MUC::MUCUserBase
 
+    register :muc_user_message, :x, "http://jabber.org/protocol/muc#user"
+
     def self.new(to = nil, body = nil, type = :normal)
       super
     end

data/lib/blather/stanza/muc/muc_user_base.rb

@@ -3,9 +3,10 @@ class Stanza
 class MUC
 
   module MUCUserBase
+    MUC_USER_NAMESPACE = "http://jabber.org/protocol/muc#user"
+
     def self.included(klass)
       klass.extend ClassMethods
-      klass.register :muc_user, :x, "http://jabber.org/protocol/muc#user"
     end
 
     module ClassMethods
@@ -29,7 +30,7 @@ class MUC
     end
 
     def muc_user
-      unless muc_user = find_first('ns:x', :ns => self.class.registered_ns)
+      unless muc_user = find_first('ns:x', :ns => MUC_USER_NAMESPACE)
         self << (muc_user = XMPPNode.new('x', self.document))
         muc_user.namespace = self.class.registered_ns
       end
@@ -44,7 +45,7 @@ class MUC
     end
 
     def find_password_node
-      muc_user.find_first 'ns:password', :ns => self.class.registered_ns
+      muc_user.find_first 'ns:password', :ns => MUC_USER_NAMESPACE
     end
   end # MUCUserBase