blather 0.6.1 → 0.6.2

data/.travis.yml

@@ -1,11 +1,13 @@
 rvm:
-  - 1.9.2
-  - rbx
-  - rbx-2.0
-  - jruby
   - 1.8.7
   - ree
-  - ruby-head
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - jruby
 
 branches:
   only:

data/CHANGELOG

@@ -1,5 +1,12 @@
 develop
 
+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
 

data/lib/blather.rb

@@ -43,6 +43,7 @@
   blather/stanza/disco/disco_items
   blather/stanza/disco/capabilities
   blather/stanza/message
+  blather/stanza/message/muc_user
   blather/stanza/presence
   blather/stanza/presence/c
   blather/stanza/presence/status

data/lib/blather/stanza/message.rb

@@ -180,6 +180,10 @@ class Stanza
         klass = class_from_registration(e.element_name, ns)
       end
 
+      if klass == Blather::Stanza::Presence::MUCUser
+        klass = Blather::Stanza::Message::MUCUser
+      end
+
       if klass && klass != self && ![Blather::Stanza::X, Blather::Stanza::Iq].include?(klass)
         klass.import(node)
       else

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

@@ -0,0 +1,117 @@
+require 'blather/stanza/muc/muc_user_base'
+
+module Blather
+class Stanza
+class Message
+
+  class MUCUser < Message
+    include Blather::Stanza::MUC::MUCUserBase
+
+    def self.new(to = nil, body = nil, type = :normal)
+      super
+    end
+
+    def invite?
+      !!find_invite_node
+    end
+
+    def invite_decline?
+      !!find_decline_node
+    end
+
+    def invite
+      if invite = find_invite_node
+        Invite.new invite
+      else
+        muc_user << (invite = Invite.new nil, nil, nil, self.document)
+        invite
+      end
+    end
+
+    def find_invite_node
+      muc_user.find_first 'ns:invite', :ns => self.class.registered_ns
+    end
+
+    def decline
+      if decline = find_decline_node
+        Decline.new decline
+      else
+        muc_user << (decline = Decline.new nil, nil, nil, self.document)
+        decline
+      end
+    end
+
+    def find_decline_node
+      muc_user.find_first 'ns:decline', :ns => self.class.registered_ns
+    end
+
+    class InviteBase < XMPPNode
+      def self.new(element_name, to = nil, from = nil, reason = nil, document = nil)
+        new_node = super element_name, document
+
+        case to
+        when self
+          to.document ||= document
+          return to
+        when Nokogiri::XML::Node
+          new_node.inherit to
+        when Hash
+          new_node.to = to[:to]
+          new_node.from = to[:from]
+          new_node.reason = to[:reason]
+        else
+          new_node.to = to
+          new_node.from = from
+          new_node.reason = reason
+        end
+        new_node
+      end
+
+      def to
+        read_attr :to
+      end
+
+      def to=(val)
+        write_attr :to, val
+      end
+
+      def from
+        read_attr :from
+      end
+
+      def from=(val)
+        write_attr :from, val
+      end
+
+      def reason
+        reason_node.content.strip
+      end
+
+      def reason=(val)
+        reason_node.content = val
+      end
+
+      def reason_node
+        unless reason = find_first('ns:reason', :ns => MUCUser.registered_ns)
+          self << (reason = XMPPNode.new('reason', self.document))
+        end
+        reason
+      end
+    end
+
+    class Invite < InviteBase
+      def self.new(*args)
+        new_node = super :invite, *args
+      end
+    end
+
+    class Decline < InviteBase
+      def self.new(*args)
+        new_node = super :decline, *args
+      end
+    end
+  end # MUC
+
+end # Presence
+end # Stanza
+end # Blather

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

@@ -0,0 +1,53 @@
+module Blather
+class Stanza
+class MUC
+
+  module MUCUserBase
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.register :muc_user, :x, "http://jabber.org/protocol/muc#user"
+    end
+
+    module ClassMethods
+      def new(*args)
+        super.tap { |e| e.muc_user }
+      end
+    end
+
+    def inherit(node)
+      muc_user.remove
+      super
+      self
+    end
+
+    def password
+      find_password_node && password_node.content
+    end
+
+    def password=(var)
+      password_node.content = var
+    end
+
+    def muc_user
+      unless muc_user = find_first('ns:x', :ns => self.class.registered_ns)
+        self << (muc_user = XMPPNode.new('x', self.document))
+        muc_user.namespace = self.class.registered_ns
+      end
+      muc_user
+    end
+
+    def password_node
+      unless pw = find_password_node
+        muc_user << (pw = XMPPNode.new('password', self.document))
+      end
+      pw
+    end
+
+    def find_password_node
+      muc_user.find_first 'ns:password', :ns => self.class.registered_ns
+    end
+  end # MUCUserBase
+
+end # MUC
+end # Stanza
+end # Blather

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

@@ -11,6 +11,12 @@ class Presence
       new_node
     end
 
+    def inherit(node)
+      muc.remove
+      super
+      self
+    end
+
     def muc
       unless muc = find_first('ns:x', :ns => self.class.registered_ns)
         self << (muc = XMPPNode.new('x', self.document))

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

@@ -1,9 +1,11 @@
+require 'blather/stanza/muc/muc_user_base'
+
 module Blather
 class Stanza
 class Presence
 
   class MUCUser < Status
-    register :muc_user, :x, "http://jabber.org/protocol/muc#user"
+    include Blather::Stanza::MUC::MUCUserBase
 
     def affiliation
       item.affiliation
@@ -40,29 +42,20 @@ class Presence
       end
     end
 
-    private
-      def muc_user
-        unless muc_user = find_first('ns:x', :ns => self.class.registered_ns)
-          self << (muc_user = XMPPNode.new('x', self.document))
-          muc_user.namespace = self.class.registered_ns
-        end
-        muc_user
-      end
-
-      def item
-        if item = muc_user.find_first('ns:item', :ns => self.class.registered_ns)
-          Item.new item
-        else
-          muc_user << (item = Item.new nil, nil, nil, self.document)
-          item
-        end
+    def item
+      if item = muc_user.find_first('ns:item', :ns => self.class.registered_ns)
+        Item.new item
+      else
+        muc_user << (item = Item.new nil, nil, nil, self.document)
+        item
       end
+    end
 
-      def status
-        muc_user.find('ns:status', :ns => self.class.registered_ns).map do |status|
-          Status.new status
-        end
+    def status
+      muc_user.find('ns:status', :ns => self.class.registered_ns).map do |status|
+        Status.new status
       end
+    end
 
     class Item < XMPPNode
       def self.new(affiliation = nil, role = nil, jid = nil, document = nil)

data/lib/blather/version.rb

@@ -1,4 +1,4 @@
 module Blather
   # Blather version number
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/spec/blather/stanza/message/muc_user_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+def muc_invite_xml
+  <<-XML
+  <message
+        from='coven@chat.shakespeare.lit'
+        id='nzd143v8'
+        to='hecate@shakespeare.lit'>
+      <x xmlns='http://jabber.org/protocol/muc#user'>
+        <invite to='hecate@shakespeare.lit' from='crone1@shakespeare.lit/desktop'>
+          <reason>
+            Hey Hecate, this is the place for all good witches!
+          </reason>
+        </invite>
+        <password>foobar</password>
+      </x>
+    </message>
+  XML
+end
+
+def muc_decline_xml
+  <<-XML
+    <message
+        from='hecate@shakespeare.lit/broom'
+        id='jk2vs61v'
+        to='coven@chat.shakespeare.lit'>
+      <x xmlns='http://jabber.org/protocol/muc#user'>
+        <decline to='crone1@shakespeare.lit' from='hecate@shakespeare.lit'>
+          <reason>
+            Sorry, I'm too busy right now.
+          </reason>
+        </decline>
+      </x>
+    </message>
+  XML
+end
+
+describe 'Blather::Stanza::Message::MUCUser' do
+  it 'ensures a form node is present on create' do
+    c = Blather::Stanza::Message::MUCUser.new
+    c.xpath('ns:x', :ns => Blather::Stanza::Message::MUCUser.registered_ns).wont_be_empty
+  end
+
+  it 'ensures a form node exists when calling #muc' do
+    c = Blather::Stanza::Message::MUCUser.new
+    c.remove_children :x
+    c.xpath('ns:x', :ns => Blather::Stanza::Message::MUCUser.registered_ns).must_be_empty
+
+    c.muc_user.wont_be_nil
+    c.xpath('ns:x', :ns => Blather::Stanza::Message::MUCUser.registered_ns).wont_be_empty
+  end
+
+  it 'ensures the message type is :normal' do
+    m = Blather::Stanza::Message::MUCUser.new
+    m.normal?.must_equal true
+  end
+
+  it "must be able to set the password" do
+    muc_user = Blather::Stanza::Message::MUCUser.new
+    muc_user.password.must_equal nil
+    muc_user.password = 'barbaz'
+    muc_user.password.must_equal 'barbaz'
+    muc_user.password = 'hello_world'
+    muc_user.password.must_equal 'hello_world'
+  end
+
+  it "should not be an #invite?" do
+    muc_user = Blather::Stanza::Message::MUCUser.new
+    muc_user.invite?.must_equal false
+  end
+
+  describe "with an invite element" do
+    it "should be an #invite?" do
+      muc_user = Blather::XMPPNode.import(parse_stanza(muc_invite_xml).root)
+      muc_user.invite?.must_equal true
+    end
+
+    it "should know the invite attributes properly" do
+      muc_user = Blather::XMPPNode.import(parse_stanza(muc_invite_xml).root)
+      muc_user.must_be_instance_of Blather::Stanza::Message::MUCUser
+      invite = muc_user.invite
+      invite.to.must_equal 'hecate@shakespeare.lit'
+      invite.from.must_equal 'crone1@shakespeare.lit/desktop'
+      invite.reason.must_equal 'Hey Hecate, this is the place for all good witches!'
+      muc_user.password.must_equal 'foobar'
+    end
+
+    it "must be able to set the to jid" do
+      muc_user = Blather::Stanza::Message::MUCUser.new
+      invite = muc_user.invite
+      invite.to.must_equal nil
+      invite.to = 'foo@bar.com'
+      invite.to.must_equal 'foo@bar.com'
+    end
+
+    it "must be able to set the from jid" do
+      muc_user = Blather::Stanza::Message::MUCUser.new
+      invite = muc_user.invite
+      invite.from.must_equal nil
+      invite.from = 'foo@bar.com'
+      invite.from.must_equal 'foo@bar.com'
+    end
+
+    it "must be able to set the reason" do
+      muc_user = Blather::Stanza::Message::MUCUser.new
+      invite = muc_user.invite
+      invite.reason.must_equal ''
+      invite.reason = 'Please join'
+      invite.reason.must_equal 'Please join'
+    end
+  end
+
+  describe "with a decline element" do
+    it "should be an #invite_decline?" do
+      muc_user = Blather::XMPPNode.import(parse_stanza(muc_decline_xml).root)
+      muc_user.must_be_instance_of Blather::Stanza::Message::MUCUser
+      muc_user.invite_decline?.must_equal true
+    end
+
+    it "should know the decline attributes properly" do
+      muc_user = Blather::XMPPNode.import(parse_stanza(muc_decline_xml).root)
+      decline = muc_user.decline
+      decline.to.must_equal 'crone1@shakespeare.lit'
+      decline.from.must_equal 'hecate@shakespeare.lit'
+      decline.reason.must_equal "Sorry, I'm too busy right now."
+    end
+
+    it "must be able to set the to jid" do
+      muc_user = Blather::Stanza::Message::MUCUser.new
+      decline = muc_user.decline
+      decline.to.must_equal nil
+      decline.to = 'foo@bar.com'
+      decline.to.must_equal 'foo@bar.com'
+    end
+
+    it "must be able to set the from jid" do
+      muc_user = Blather::Stanza::Message::MUCUser.new
+      decline = muc_user.decline
+      decline.from.must_equal nil
+      decline.from = 'foo@bar.com'
+      decline.from.must_equal 'foo@bar.com'
+    end
+
+    it "must be able to set the reason" do
+      muc_user = Blather::Stanza::Message::MUCUser.new
+      decline = muc_user.decline
+      decline.reason.must_equal ''
+      decline.reason = 'Please join'
+      decline.reason.must_equal 'Please join'
+    end
+  end
+end

data/spec/blather/stanza/message_spec.rb

@@ -275,7 +275,7 @@ describe Blather::Stanza::Message do
       n.delayed?.must_equal true
       n.delay.must_be_instance_of Blather::Stanza::Message::Delay
       n.delay.from.must_equal 'coven@chat.shakespeare.lit'
-      n.delay.stamp.must_equal Time.new(2002, 10, 13, 23, 58, 37, 0)
+      n.delay.stamp.must_equal Time.utc(2002, 10, 13, 23, 58, 37, 0)
       n.delay.description.must_equal "Too slow"
     end
   end

data/spec/blather/stanza/presence/muc_spec.rb

@@ -16,7 +16,9 @@ describe 'Blather::Stanza::Presence::MUC' do
   end
 
   it 'must be importable' do
-    c = Blather::XMPPNode.import(parse_stanza(muc_xml).root).must_be_instance_of Blather::Stanza::Presence::MUC
+    c = Blather::XMPPNode.import(parse_stanza(muc_xml).root)
+    c.must_be_instance_of Blather::Stanza::Presence::MUC
+    c.xpath('ns:x', :ns => Blather::Stanza::Presence::MUC.registered_ns).count.must_equal 1
   end
 
   it 'ensures a form node is present on create' do

data/spec/blather/stanza/presence/muc_user_spec.rb

@@ -11,16 +11,13 @@ def muc_user_xml
               role='participant'/>
         <status code='100'/>
         <status code='110'/>
+        <password>foobar</password>
       </x>
     </presence>
   XML
 end
 
 describe 'Blather::Stanza::Presence::MUCUser' do
-  it 'registers itself' do
-    Blather::XMPPNode.class_from_registration(:x, 'http://jabber.org/protocol/muc#user' ).must_equal Blather::Stanza::Presence::MUCUser
-  end
-
   it 'must be importable' do
     muc_user = Blather::XMPPNode.import(parse_stanza(muc_user_xml).root)
     muc_user.must_be_instance_of Blather::Stanza::Presence::MUCUser
@@ -28,6 +25,21 @@ describe 'Blather::Stanza::Presence::MUCUser' do
     muc_user.jid.must_equal 'hag66@shakespeare.lit/pda'
     muc_user.role.must_equal :participant
     muc_user.status_codes.must_equal [100, 110]
+    muc_user.password.must_equal 'foobar'
+  end
+
+  it 'ensures a form node is present on create' do
+    c = Blather::Stanza::Presence::MUCUser.new
+    c.xpath('ns:x', :ns => Blather::Stanza::Presence::MUCUser.registered_ns).wont_be_empty
+  end
+
+  it 'ensures a form node exists when calling #muc' do
+    c = Blather::Stanza::Presence::MUCUser.new
+    c.remove_children :x
+    c.xpath('ns:x', :ns => Blather::Stanza::Presence::MUCUser.registered_ns).must_be_empty
+
+    c.muc_user.wont_be_nil
+    c.xpath('ns:x', :ns => Blather::Stanza::Presence::MUCUser.registered_ns).wont_be_empty
   end
 
   it "must be able to set the affiliation" do
@@ -59,4 +71,13 @@ describe 'Blather::Stanza::Presence::MUCUser' do
     muc_user.status_codes = [500]
     muc_user.status_codes.must_equal [500]
   end
+
+  it "must be able to set the password" do
+    muc_user = Blather::Stanza::Presence::MUCUser.new
+    muc_user.password.must_equal nil
+    muc_user.password = 'barbaz'
+    muc_user.password.must_equal 'barbaz'
+    muc_user.password = 'hello_world'
+    muc_user.password.must_equal 'hello_world'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blather
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000 Z
+date: 2012-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2164385480 !ruby/object:Gem::Requirement
+  requirement: &2156245180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.12.6
   type: :runtime
   prerelease: false
-  version_requirements: *2164385480
+  version_requirements: *2156245180
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2164384740 !ruby/object:Gem::Requirement
+  requirement: &2156244500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164384740
+  version_requirements: *2156244500
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2164384120 !ruby/object:Gem::Requirement
+  requirement: &2156243540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164384120
+  version_requirements: *2156243540
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164383500 !ruby/object:Gem::Requirement
+  requirement: &2156242620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2164383500
+  version_requirements: *2156242620
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2164382640 !ruby/object:Gem::Requirement
+  requirement: &2156241660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.7.1
   type: :development
   prerelease: false
-  version_requirements: *2164382640
+  version_requirements: *2156241660
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2164381420 !ruby/object:Gem::Requirement
+  requirement: &2156240420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *2164381420
+  version_requirements: *2156240420
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2164380680 !ruby/object:Gem::Requirement
+  requirement: &2156239840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2164380680
+  version_requirements: *2156239840
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2164379680 !ruby/object:Gem::Requirement
+  requirement: &2156238560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.9.9
   type: :development
   prerelease: false
-  version_requirements: *2164379680
+  version_requirements: *2156238560
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2164378720 !ruby/object:Gem::Requirement
+  requirement: &2156237900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *2164378720
+  version_requirements: *2156237900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164378200 !ruby/object:Gem::Requirement
+  requirement: &2156237420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164378200
+  version_requirements: *2156237420
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &2164377560 !ruby/object:Gem::Requirement
+  requirement: &2156236560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164377560
+  version_requirements: *2156236560
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2164376360 !ruby/object:Gem::Requirement
+  requirement: &2156235340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164376360
+  version_requirements: *2156235340
 - !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &2164373280 !ruby/object:Gem::Requirement
+  requirement: &2156233800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164373280
+  version_requirements: *2156233800
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &2164372620 !ruby/object:Gem::Requirement
+  requirement: &2156232440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164372620
+  version_requirements: *2156232440
 description: An XMPP DSL for Ruby written on top of EventMachine and Nokogiri
 email: sprsquish@gmail.com
 executables: []
@@ -228,6 +228,8 @@ files:
 - lib/blather/stanza/iq/si.rb
 - lib/blather/stanza/iq/vcard.rb
 - lib/blather/stanza/message.rb
+- lib/blather/stanza/message/muc_user.rb
+- lib/blather/stanza/muc/muc_user_base.rb
 - lib/blather/stanza/presence.rb
 - lib/blather/stanza/presence/c.rb
 - lib/blather/stanza/presence/muc.rb
@@ -283,6 +285,7 @@ files:
 - spec/blather/stanza/iq/si_spec.rb
 - spec/blather/stanza/iq/vcard_spec.rb
 - spec/blather/stanza/iq_spec.rb
+- spec/blather/stanza/message/muc_user_spec.rb
 - spec/blather/stanza/message_spec.rb
 - spec/blather/stanza/presence/c_spec.rb
 - spec/blather/stanza/presence/muc_spec.rb
@@ -365,6 +368,7 @@ test_files:
 - spec/blather/stanza/iq/si_spec.rb
 - spec/blather/stanza/iq/vcard_spec.rb
 - spec/blather/stanza/iq_spec.rb
+- spec/blather/stanza/message/muc_user_spec.rb
 - spec/blather/stanza/message_spec.rb
 - spec/blather/stanza/presence/c_spec.rb
 - spec/blather/stanza/presence/muc_spec.rb