blather 0.5.2 → 0.5.3

data/CHANGELOG

@@ -1,3 +1,6 @@
+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
 

data/lib/blather.rb

@@ -28,10 +28,11 @@
 
   blather/stanza
   blather/stanza/iq
-  blather/stanza/iq/query
   blather/stanza/iq/command
-  blather/stanza/iq/roster
   blather/stanza/iq/ibb
+  blather/stanza/iq/ping
+  blather/stanza/iq/query
+  blather/stanza/iq/roster
   blather/stanza/iq/s5b
   blather/stanza/iq/si
   blather/stanza/iq/vcard

data/lib/blather/client/client.rb

@@ -226,6 +226,10 @@ module Blather
       #   write StanzaError.new(iq, 'service-unavailable', :cancel).to_node
       # end
 
+      register_handler :ping, :type => :get do |ping|
+        write ping.reply
+      end
+
       register_handler :status do |status|
         roster[status.from].status = status if roster[status.from]
         nil

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

@@ -0,0 +1,50 @@
+module Blather
+class Stanza
+class Iq
+
+  # # Ping Stanza
+  #
+  # [XEP-0199: XMPP Ping](http://xmpp.org/extensions/xep-0199.html)
+  #
+  # This is a base class for any Ping based Iq stanzas.
+  #
+  # @handler :ping
+  class Ping < Iq
+    # @private
+    register :ping, :ping, 'urn:xmpp:ping'
+
+    # Overrides the parent method to ensure a ping node is created
+    #
+    # @see Blather::Stanza::Iq.new
+    def self.new(type = :get, to = nil, id = nil)
+      node = super
+      node.ping
+      node
+    end
+
+    # Overrides the parent method to ensure the current ping node is destroyed
+    #
+    # @see Blather::Stanza::Iq#inherit
+    def inherit(node)
+      ping.remove
+      super
+    end
+
+    # Ping node accessor
+    # If a ping node exists it will be returned.
+    # Otherwise a new node will be created and returned
+    #
+    # @return [Balather::XMPPNode]
+    def ping
+      p = find_first 'ns:ping', :ns => self.class.registered_ns
+
+      unless p
+        (self << (p = XMPPNode.new('ping', self.document)))
+        p.namespace = self.class.registered_ns
+      end
+      p
+    end
+  end
+end
+end
+end

data/lib/blather/version.rb

@@ -1,4 +1,4 @@
 module Blather
   # Blather version number
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

data/spec/blather/client/client_spec.rb

@@ -291,6 +291,13 @@ describe 'Blather::Client default handlers' do
   #   @client.receive_data get
   # end
 
+  it 'responds to s2c pings with a pong' do
+    ping = Blather::Stanza::Iq::Ping.new :get
+    pong = ping.reply
+    @client.expects(:write).with { |n| n.to_s.must_equal pong.to_s }
+    @client.receive_data ping
+  end
+
   it 'handles status changes by updating the roster if the status is from a Blather::JID in the roster' do
     jid = 'friend@jabber.local'
     status = Blather::Stanza::Presence::Status.new :away

data/spec/blather/stanza/iq/ping_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+def ping_xml
+<<-XML
+<iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='s2c1' type='get'>
+  <ping xmlns='urn:xmpp:ping'/>
+</iq>
+XML
+end
+
+describe Blather::Stanza::Iq::Ping do
+  it 'registers itself' do
+    Blather::XMPPNode.class_from_registration(:ping, 'urn:xmpp:ping').must_equal Blather::Stanza::Iq::Ping
+  end
+
+  it 'can be imported' do
+    doc = parse_stanza ping_xml
+    node = Blather::XMPPNode.import(doc.root)
+    node.must_be_instance_of Blather::Stanza::Iq::Ping
+  end
+
+  it 'ensures a ping node is present on create' do
+    iq = Blather::Stanza::Iq::Ping.new
+    iq.xpath('ns:ping', :ns => 'urn:xmpp:ping').wont_be_empty
+  end
+
+  it 'ensures a ping node exists when calling #ping' do
+    iq = Blather::Stanza::Iq::Ping.new
+    iq.ping.remove
+    iq.xpath('ns:ping', :ns => 'urn:xmpp:ping').must_be_empty
+
+    iq.ping.wont_be_nil
+    iq.xpath('ns:ping', :ns => 'urn:xmpp:ping').wont_be_empty
+  end
+
+  it 'responds with an empty IQ' do
+    ping = Blather::Stanza::Iq::Ping.new :get, 'one@example.com', 'abc123'
+    ping.from = 'two@example.com'
+    ping.reply.must_equal Blather::Stanza::Iq.new(:result, 'two@example.com', 'abc123')
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: blather
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 5
-  - 2
-  version: 0.5.2
+  - 3
+  version: 0.5.3
 platform: ruby
 authors: 
 - Jeff Smick
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-09 00:00:00 +01:00
+date: 2011-06-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 35
         segments: 
         - 0
         - 12
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 4
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
         - 0
@@ -74,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 1
         - 7
@@ -90,7 +85,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 3
         - 0
@@ -106,7 +100,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 1
         - 7
@@ -122,7 +115,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 35
         segments: 
         - 0
         - 9
@@ -138,7 +130,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
@@ -154,7 +145,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 41
         segments: 
         - 0
         - 9
@@ -170,7 +160,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 0
         - 6
@@ -186,7 +175,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 2
         - 1
@@ -202,7 +190,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -261,6 +248,7 @@ files:
 - lib/blather/stanza/iq.rb
 - lib/blather/stanza/iq/command.rb
 - lib/blather/stanza/iq/ibb.rb
+- lib/blather/stanza/iq/ping.rb
 - lib/blather/stanza/iq/query.rb
 - lib/blather/stanza/iq/roster.rb
 - lib/blather/stanza/iq/s5b.rb
@@ -313,6 +301,7 @@ files:
 - spec/blather/stanza/discos/disco_items_spec.rb
 - spec/blather/stanza/iq/command_spec.rb
 - spec/blather/stanza/iq/ibb_spec.rb
+- spec/blather/stanza/iq/ping_spec.rb
 - spec/blather/stanza/iq/query_spec.rb
 - spec/blather/stanza/iq/roster_spec.rb
 - spec/blather/stanza/iq/s5b_spec.rb
@@ -363,7 +352,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -372,14 +360,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simpler XMPP built for speed
@@ -399,6 +386,7 @@ test_files:
 - spec/blather/stanza/discos/disco_items_spec.rb
 - spec/blather/stanza/iq/command_spec.rb
 - spec/blather/stanza/iq/ibb_spec.rb
+- spec/blather/stanza/iq/ping_spec.rb
 - spec/blather/stanza/iq/query_spec.rb
 - spec/blather/stanza/iq/roster_spec.rb
 - spec/blather/stanza/iq/s5b_spec.rb