blather 0.4.11 → 0.4.12

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

@@ -41,7 +41,7 @@ class Iq
       self.action = :execute unless self.action
       self
     end
-    
+
     # Overrides the parent method to ensure the reply has no action
     #
     # @return [self]
@@ -315,14 +315,7 @@ class Iq
 
     # Returns the command's x:data form child
     def form
-      if found_x = command.find_first('ns:x', :ns => X.registered_ns)
-        x = X.new found_x
-        found_x.remove
-      else
-        x = X.new
-      end
-      self.command << x
-      x
+      X.find_or_create self
     end
   end #Command
 

data/lib/blather/stanza/message.rb

@@ -172,7 +172,7 @@ class Stanza
         klass = class_from_registration(e.element_name, ns)
       end
 
-      if klass && klass != self
+      if klass && klass != self && klass != Blather::Stanza::X
         klass.import(node)
       else
         new(node[:type]).inherit(node)
@@ -326,7 +326,12 @@ class Stanza
       set_content_for :thread, thread
       find_first('thread')[:parent] = parent
     end
+
+    # Returns the message's x:data form child
+    def form
+      X.find_or_create self
+    end
   end
 
 end
-end
+end

data/lib/blather/stanza/pubsub.rb

@@ -65,8 +65,6 @@ class Stanza
   # This fragment is found in many places throughout the pubsub spec
   # This is a convenience class to attach methods to the node
   class PubSubItem < XMPPNode
-    ATOM_NS = 'http://www.w3.org/2005/Atom'.freeze
-
     # Create a new PubSubItem
     #
     # @param [String, nil] id the id of the stanza
@@ -96,32 +94,22 @@ class Stanza
 
     # Get the item's payload
     #
-    # To get the XML representation use #entry
-    #
-    # @return [String, nil]
+    # @return [String, XMPPNode, nil]
     def payload
-      self.entry.content.empty? ? nil : content
+      children.empty? ? nil : children.to_s
     end
 
     # Set the item's payload
     #
-    # @param [String, nil] payload the payload
+    # @param [String, XMPPNode, nil] payload the payload
     def payload=(payload)
-      self.entry.content = payload
-    end
-
-    # Get or create the entry node
-    #
-    # @return [Blather::XMPPNode]
-    def entry
-      e = find_first('ns:entry', :ns => ATOM_NS) ||
-          find_first('entry', :ns => ATOM_NS)
-
-      unless e
-        self << (e = XMPPNode.new('entry', self.document))
-        e.namespace = ATOM_NS
+      children.map &:remove
+      return unless payload
+      if payload.is_a?(String)
+        self.content = payload
+      else
+        self << payload
       end
-      e
     end
   end  # PubSubItem
 

data/lib/blather/stanza/x.rb

@@ -33,6 +33,17 @@ class Stanza
       new_node
     end
 
+    def self.find_or_create(parent)
+      if found_x = parent.find_first('//ns:x', :ns => self.registered_ns)
+        x = self.new found_x
+        found_x.remove
+      else
+        x = self.new
+      end
+      parent << x
+      x
+    end
+
     # The Form's type
     # @return [Symbol]
     def type
@@ -148,8 +159,8 @@ class Stanza
       # @overload new(opts = {})
       #   Creates a new Field using a hash of options
       #   @param [Hash] opts a hash of options
-      #   @option opts [:boolean, :fixed, :hidden, :"jid-multi", :"jid-single", :"list-multi", :"list-single", :"text-multi", :"text-private", :"text-single"] :type the type of the field
       #   @option opts [String] :var the variable for the field
+      #   @option opts [:boolean, :fixed, :hidden, :"jid-multi", :"jid-single", :"list-multi", :"list-single", :"text-multi", :"text-private", :"text-single"] :type the type of the field
       #   @option opts [String] :label the label for the field
       #   @option [String, nil] :value the value for the field
       #   @option [String, nil] :description the description for the field
@@ -158,31 +169,31 @@ class Stanza
       #   These are passed directly to X::Field::Option.new
       # @overload new(type, var = nil, label = nil)
       #   Create a new Field by name
-      #   @param [:boolean, :fixed, :hidden, :"jid-multi", :"jid-single", :"list-multi", :"list-single", :"text-multi", :"text-private", :"text-single"] type the type of the field
       #   @param [String, nil] var the variable for the field
+      #   @param [:boolean, :fixed, :hidden, :"jid-multi", :"jid-single", :"list-multi", :"list-single", :"text-multi", :"text-private", :"text-single"] type the type of the field
       #   @param [String, nil] label the label for the field
       #   @param [String, nil] value the value for the field
       #   @param [String, nil] description the description for the field
       #   @param [true, false, nil] required the required flag for the field
       #   @param [Array<Array, X::Field::Option>, nil] options a list of field options.
       #   These are passed directly to X::Field::Option.new
-      def self.new(type, var = nil, label = nil, value = nil, description = nil, required = false, options = [])
+      def self.new(var, type = nil, label = nil, value = nil, description = nil, required = false, options = [])
         new_node = super :field
 
-        case type
+        case var
         when Nokogiri::XML::Node
-          new_node.inherit type
+          new_node.inherit var
         when Hash
-          new_node.type = type[:type]
-          new_node.var = type[:var]
-          new_node.label = type[:label]
-          new_node.value = type[:value]
-          new_node.desc = type[:description]
-          new_node.required = type[:required]
-          new_node.options = type[:options]
+          new_node.var = var[:var]
+          new_node.type = var[:type]
+          new_node.label = var[:label]
+          new_node.value = var[:value]
+          new_node.desc = var[:description]
+          new_node.required = var[:required]
+          new_node.options = var[:options]
         else
-          new_node.type = type
           new_node.var = var
+          new_node.type = type
           new_node.label = label
           new_node.value = value
           new_node.desc = description
@@ -384,4 +395,4 @@ class Stanza
   end # X
 
 end #Stanza
-end
+end

data/spec/blather/stanza/message_spec.rb

@@ -1,21 +1,27 @@
 require File.join(File.dirname(__FILE__), *%w[.. .. spec_helper])
 
+def message_xml
+  <<-XML
+    <message
+        to='romeo@example.net'
+        from='juliet@example.com/balcony'
+        type='chat'
+        xml:lang='en'>
+      <body>Wherefore art thou, Romeo?</body>
+      <x xmlns='jabber:x:data' type='form'>
+        <field var='field-name' type='text-single' label='description' />
+      </x>
+    </message>
+  XML
+end
+
 describe Blather::Stanza::Message do
   it 'registers itself' do
     Blather::XMPPNode.class_from_registration(:message, nil).must_equal Blather::Stanza::Message
   end
 
   it 'must be importable' do
-    doc = parse_stanza <<-XML
-      <message
-          to='romeo@example.net'
-          from='juliet@example.com/balcony'
-          type='chat'
-          xml:lang='en'>
-        <body>Wherefore art thou, Romeo?</body>
-      </message>
-    XML
-    Blather::XMPPNode.import(doc.root).must_be_instance_of Blather::Stanza::Message
+    Blather::XMPPNode.import(parse_stanza(message_xml).root).must_be_instance_of Blather::Stanza::Message
   end
 
   it 'provides "attr_accessor" for body' do
@@ -129,4 +135,15 @@ describe Blather::Stanza::Message do
     msg.xhtml = xhtml
     msg.xhtml.must_equal(xhtml)
   end
+
+  it 'makes a form child available' do
+    n = Blather::XMPPNode.import(parse_stanza(message_xml).root)
+    n.form.fields.size.must_equal 1
+    n.form.fields.map { |f| f.class }.uniq.must_equal [Blather::Stanza::X::Field]
+    n.form.must_be_instance_of Blather::Stanza::X
+
+    r = Blather::Stanza::Message.new
+    r.form.type = :form
+    r.form.type.must_equal :form
+  end
 end

data/spec/blather/stanza/pubsub_spec.rb

@@ -59,9 +59,4 @@ describe Blather::Stanza::PubSub::PubSubItem do
     item.payload = nil
     item.payload.must_be_nil
   end
-
-  it 'must have an entry child to item' do
-    item = Blather::Stanza::PubSub::Items::PubSubItem.new 'foo', 'payload'
-    item.find_first('ns:entry', :ns => 'http://www.w3.org/2005/Atom').wont_be_nil
-  end
 end

data/spec/blather/stanza/x_spec.rb

@@ -94,8 +94,8 @@ describe Blather::Stanza::X do
       {:label => 'label1', :type => 'text-single', :var => 'var1'},
     ]
 
-    control = [ Blather::Stanza::X::Field.new(*%w[text-single var label]),
-                Blather::Stanza::X::Field.new(*%w[text-single var1 label1])]
+    control = [ Blather::Stanza::X::Field.new(*%w[var text-single label]),
+                Blather::Stanza::X::Field.new(*%w[var1 text-single label1])]
 
     di = Blather::Stanza::X.new nil, fields
     di.fields.size.must_equal 2
@@ -103,8 +103,8 @@ describe Blather::Stanza::X do
   end
 
   it 'takes a list of Field objects as fields' do
-    control = [ Blather::Stanza::X::Field.new(*%w[text-single var label1]),
-                Blather::Stanza::X::Field.new(*%w[text-single var1 label1])]
+    control = [ Blather::Stanza::X::Field.new(*%w[var text-single label1]),
+                Blather::Stanza::X::Field.new(*%w[var1 text-single label1])]
 
     di = Blather::Stanza::X.new nil, control
     di.fields.size.must_equal 2
@@ -114,11 +114,11 @@ describe Blather::Stanza::X do
   it 'takes a mix of hashes and field objects as fields' do
     fields = [
       {:label => 'label', :type => 'text-single', :var => 'var'},
-      Blather::Stanza::X::Field.new(*%w[text-single var1 label1]),
+      Blather::Stanza::X::Field.new(*%w[var1 text-single label1]),
     ]
 
-    control = [ Blather::Stanza::X::Field.new(*%w[text-single var label]),
-                Blather::Stanza::X::Field.new(*%w[text-single var1 label1])]
+    control = [ Blather::Stanza::X::Field.new(*%w[var text-single label]),
+                Blather::Stanza::X::Field.new(*%w[var1 text-single label1])]
 
     di = Blather::Stanza::X.new nil, fields
     di.fields.size.must_equal 2
@@ -130,7 +130,7 @@ describe Blather::Stanza::X do
     di.fields.size.must_equal 0
     di.fields = [{:label => 'label', :type => 'text-single', :var => 'var', :required => true}]
     di.fields.size.must_equal 1
-    di.fields += [Blather::Stanza::X::Field.new(*%w[text-single var1 label1])]
+    di.fields += [Blather::Stanza::X::Field.new(*%w[var1 text-single label1])]
     di.fields.size.must_equal 2
   end
 
@@ -146,28 +146,28 @@ describe Blather::Stanza::X::Field do
   end
 
   it 'has a type attribute' do
-    n = Blather::Stanza::X::Field.new 'text-single'
+    n = Blather::Stanza::X::Field.new 'var', 'text-single'
     n.type.must_equal 'text-single'
     n.type = 'hidden'
     n.type.must_equal 'hidden'
   end
 
   it 'has a var attribute' do
-    n = Blather::Stanza::X::Field.new 'text-single', 'name'
+    n = Blather::Stanza::X::Field.new 'name', 'text-single'
     n.var.must_equal 'name'
     n.var = 'email'
     n.var.must_equal 'email'
   end
 
   it 'has a label attribute' do
-    n = Blather::Stanza::X::Field.new 'text-single', 'subject', 'Music from the time of Shakespeare'
+    n = Blather::Stanza::X::Field.new 'subject', 'text-single', 'Music from the time of Shakespeare'
     n.label.must_equal 'Music from the time of Shakespeare'
     n.label = 'Books by and about Shakespeare'
     n.label.must_equal 'Books by and about Shakespeare'
   end
 
   it 'has a desc attribute' do
-    n = Blather::Stanza::X::Field.new 'text-single', 'subject', 'Music from the time of Shakespeare'
+    n = Blather::Stanza::X::Field.new 'subject', 'text-single', 'Music from the time of Shakespeare'
     n.desc.must_equal nil
     n.desc = 'Books by and about Shakespeare'
     n.desc.must_equal 'Books by and about Shakespeare'
@@ -176,7 +176,7 @@ describe Blather::Stanza::X::Field do
   end
 
   it 'has a required? attribute' do
-    n = Blather::Stanza::X::Field.new 'text-single', 'subject', 'Music from the time of Shakespeare'
+    n = Blather::Stanza::X::Field.new 'subject', 'text-single', 'Music from the time of Shakespeare'
     n.required?.must_equal false
     n.required = true
     n.required?.must_equal true
@@ -185,7 +185,7 @@ describe Blather::Stanza::X::Field do
   end
 
   it 'has a value attribute' do
-    n = Blather::Stanza::X::Field.new 'text-single', 'subject', 'Music from the time of Shakespeare'
+    n = Blather::Stanza::X::Field.new 'subject', 'text-single', 'Music from the time of Shakespeare'
     n.value.must_equal nil
     n.value = 'book1'
     n.value.must_equal 'book1'
@@ -204,14 +204,14 @@ describe Blather::Stanza::X::Field do
   end
 
   it 'raises an error when compared against a non X::Field' do
-    a = Blather::Stanza::X::Field.new('hidden', 'secret_message')
+    a = Blather::Stanza::X::Field.new('secret_message', 'hidden')
     lambda { a == 'test' }.must_raise RuntimeError
   end
 
   it 'can determine equality' do
-    a = Blather::Stanza::X::Field.new('text-single', 'subject')
-    a.must_equal Blather::Stanza::X::Field.new('text-single', 'subject')
-    a.wont_equal Blather::Stanza::X::Field.new('text-single', 'subject1')
+    a = Blather::Stanza::X::Field.new('subject', 'text-single')
+    a.must_equal Blather::Stanza::X::Field.new('subject', 'text-single')
+    a.wont_equal Blather::Stanza::X::Field.new('subject1', 'text-single')
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: blather
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 4
-  - 11
-  version: 0.4.11
+  - 12
+  version: 0.4.12
 platform: ruby
 authors: 
 - Jeff Smick
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 -07:00
+date: 2010-08-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency