jubjub 0.0.6 → 0.0.7

data/README.mdown

@@ -181,11 +181,57 @@ Examples
     u.pubsub.destroy('old_node', 'pubsub.jabber.ru', 'new_new')
     => true
     
+Dealing with errors
+===================
+
+Every returned object from every action is really a Jubjub::Response::Proxy, which delegates to the Jubjub::Response and if the method doesn't exist there to the actual result. As Jubjub::Response only has a few methods it will usually just behaves like the actual result (say a Jubjub::Pubsub::Item). However, you can check what has really happened like so:
+
+    # Attempt to destroy a node that does not exist
+    u.pubsub.destroy('made up')
+    => false
+    
+    # False tells us destroy didn't succeed in this case, but it's not terribly helpful
+    # So we can use methods provided by the Jubjub::Response as well
+    
+    response = u.pubsub.destroy('made up')
+    response.success?
+    => false
+    
+    response.stanza.to_s
+    => "<?xml version=\"1.0\"?>\n<iq type=\"error\" id=\"blather0011\" from=\"pubsub.theo-template.local\" to=\"theozaurus@theo-template.local/42607076141308656900975361\" lang=\"en\">\n  <pubsub xmlns=\"http://jabber.org/protocol/pubsub#owner\">\n    <delete node=\"made up\"/>\n  </pubsub>\n<error code=\"404\" type=\"cancel\"><item-not-found xmlns=\"urn:ietf:params:xml:ns:xmpp-stanzas\"/></error></iq>\n" 
+    
+    # We can get the real result with no proxy sat in front
+    response.result
+    => false
+    response.result.success?
+    NoMethodError: undefined method `success?' for false:FalseClass
+    	from (irb):14
+    
+    # We can also get an enhanced error object, Jubjub::Response::Error
+    response.error
+    => #<Jubjub::Response::Error:0x101ef51f8 @stanza=#<Nokogiri::XML::Element:0x80f7a7bc name="error" attributes=[#<Nokogiri::XML::Attr:0x80f7a654 name="code" value="404">, #<Nokogiri::XML::Attr:0x80f7a640 name="type" value="cancel">] children=[#<Nokogiri::XML::Element:0x80f7a03c name="item-not-found" namespace=#<Nokogiri::XML::Namespace:0x80f79fb0 href="urn:ietf:params:xml:ns:xmpp-stanzas">>]>> 
+    
+    response.error.stanza.to_s
+    => "<error code=\"404\" type=\"cancel\">\n  <item-not-found xmlns=\"urn:ietf:params:xml:ns:xmpp-stanzas\"/>\n</error>"
+    
+    response.error.condition
+    => 'item-not-found'
+    
+    response.error.type
+    => 'cancel'
+    
+    # If there is any error text this can also be extracted
+    response.error.text
+    => 'Item not found'
+    
+    
+The error `type` and error `condition` are the important factors. The `type` is defined in the [RFC 6121](http://xmpp.org/rfcs/rfc6120.html#stanzas-error-syntax), and helps decide whether the action should be attempted again. The `condition` provides a bit more detail, and will always be part of the [urn:ietf:params:xml:ns:xmpp-stanzas namespace](http://xmpp.org/schemas/stanzaerror.xsd).
+
 TODO
 ====
 
- - Error handling
  - MUC user role and affiliation control
+ - Better exception handling
  - Service discovery
  - Operations that are not IQ based, such as rosters and two way messaging
  - Other backends (for servers that are evented)

data/lib/jubjub/connection/xmpp_gateway/muc.rb

@@ -46,14 +46,10 @@ module Jubjub
           
           presence full_jid
           
-          success = write(
-            # Open room
-            request.to_xml
-          ).xpath(
-            # Check for valid response
-            '//iq[@type="result"]'
-          ).any?
-          Jubjub::Muc.new room_jid, nil, @connection if success
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            success = stanza.xpath( '/iq[@type="result"]' ).any?
+            Jubjub::Muc.new room_jid, nil, @connection if success
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0045.html#createroom-reserved
@@ -212,16 +208,14 @@ module Jubjub
           end
           
           presence full_jid
-          response = write(
-            # Request room configuration
-            request.to_xml
-          ).xpath(
-            # Get fields
-            "//iq[@type='result']/muc_owner:query/x_data:x[@type='form']",
-            namespaces
-          )
           
-          Jubjub::Muc::Configuration.new response if response
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            config = stanza.xpath(
+              "/iq[@type='result']/muc_owner:query/x_data:x[@type='form']",
+              namespaces
+            )
+            Jubjub::Muc::Configuration.new config if config
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0045.html#destroyroom
@@ -250,13 +244,9 @@ module Jubjub
             }
           end
           
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Check for valid response
-            '//iq[@type="result"]'
-          ).any?
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath( '/iq[@type="result"]' ).any?
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0045.html#disco-rooms
@@ -289,18 +279,16 @@ module Jubjub
               xml.query_('xmlns' => 'http://jabber.org/protocol/disco#items')
             }
           end
-          
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]/disco_items:query/disco_items:item',
-            namespaces
-          ).map{|item| 
-            # Convert to Jubjub object
-            Jubjub::Muc.new item.attr('jid'), item.attr('name'), @connection
-          }
+                    
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath(
+              '/iq[@type="result"]/disco_items:query/disco_items:item',
+              namespaces
+            ).map{|item|
+              # Convert to Jubjub object
+              Jubjub::Muc.new item.attr('jid'), item.attr('name'), @connection
+            }
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0045.html#exit

data/lib/jubjub/connection/xmpp_gateway/pubsub.rb

@@ -40,19 +40,17 @@ module Jubjub
               xml.query_('xmlns' => namespaces['disco_items'])
             }
           end
-          
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]/disco_items:query/disco_items:item',
-            namespaces
-          ).map{|item|
-            jid  = item.attr('jid')
-            node = item.attr('node')
-            Jubjub::Pubsub.new jid, node, @connection
-          }
+                    
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath(
+              '/iq[@type="result"]/disco_items:query/disco_items:item',
+              namespaces
+            ).map{|item|
+              jid  = item.attr('jid')
+              node = item.attr('node')
+              Jubjub::Pubsub.new jid, node, @connection
+            }
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#owner-create-and-configure
@@ -93,14 +91,13 @@ module Jubjub
             }
           end
           
-          success = write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]'
-          ).any?
-          Jubjub::Pubsub.new jid, node, @connection if success
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            success = stanza.xpath(
+              # Pull out required parts
+              '/iq[@type="result"]'
+            ).any?
+            Jubjub::Pubsub.new jid, node, @connection if success
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#owner-configure
@@ -144,16 +141,14 @@ module Jubjub
             }
           end
           
-          response = write(
-            # Request default node configuration
-            request.to_xml
-          ).xpath(
-            # Get fields
-            "//iq[@type='result']/pubsub_owner:pubsub/pubsub_owner:default/x_data:x[@type='form']",
-            namespaces
-          )
-          
-          Jubjub::Pubsub::Configuration.new response if response
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            config = stanza.xpath(
+              # Pull out required parts
+              "/iq[@type='result']/pubsub_owner:pubsub/pubsub_owner:default/x_data:x[@type='form']",
+              namespaces
+            )
+            Jubjub::Pubsub::Configuration.new config if config
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#owner-delete
@@ -183,13 +178,9 @@ module Jubjub
             }
           end
           
-          success = write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]'
-          ).any?
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath( '/iq[@type="result"]' ).any?
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#owner-purge
@@ -215,13 +206,9 @@ module Jubjub
             }
           end
           
-          success = write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]'
-          ).any?
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath( '/iq[@type="result"]' ).any?
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#subscriber-subscribe
@@ -257,21 +244,19 @@ module Jubjub
               }
             }
           end
-          
-          result = write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]/pubsub:pubsub/pubsub:subscription',
-            namespaces
-          )
-          if result.any?
-            subscriber   = Jubjub::Jid.new(result.first.attr('jid'))
-            subid        = result.first.attr('subid') 
-            subscription = result.first.attr('subscription')
-            Jubjub::Pubsub::Subscription.new jid, node, subscriber, subid, subscription, @connection
-          end
+                    
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            result = stanza.xpath(
+              '/iq[@type="result"]/pubsub:pubsub/pubsub:subscription',
+              namespaces
+            )
+            if result.any?
+              subscriber   = Jubjub::Jid.new(result.first.attr('jid'))
+              subid        = result.first.attr('subid') 
+              subscription = result.first.attr('subscription')
+              Jubjub::Pubsub::Subscription.new jid, node, subscriber, subid, subscription, @connection
+            end
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#subscriber-unsubscribe
@@ -303,13 +288,9 @@ module Jubjub
             }
           end
           
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]'
-          ).any?
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath( '/iq[@type="result"]' ).any?
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#publisher-publish
@@ -357,19 +338,17 @@ module Jubjub
             }
           end
           
-          result = write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]/pubsub:pubsub/pubsub:publish/pubsub:item',
-            namespaces
-          )
-          if result.any?
-            item_id = result.first.attr('id')
-            data = request.doc.xpath("//pubsub:item/*", namespaces).to_s
-            Jubjub::Pubsub::Item.new jid, node, item_id, data, @connection
-          end
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            result = stanza.xpath(
+              '/iq[@type="result"]/pubsub:pubsub/pubsub:publish/pubsub:item',
+              namespaces
+            )
+            if result.any?
+              item_id = result.first.attr('id')
+              data = request.doc.xpath("//pubsub:item/*", namespaces).to_s
+              Jubjub::Pubsub::Item.new jid, node, item_id, data, @connection
+            end
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#publisher-delete
@@ -400,10 +379,9 @@ module Jubjub
             }
           end
           
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath('//iq[@type="result"]').any?
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath( '/iq[@type="result"]' ).any?
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#subscriber-retrieve
@@ -449,19 +427,17 @@ module Jubjub
               }
             }
           end
-          
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]/pubsub:pubsub/pubsub:items/pubsub:item',
-            namespaces
-          ).map{|item|
-            item_id = item.attr('id')
-            data = item.xpath('./*').to_xml
-            Jubjub::Pubsub::Item.new jid, node, item_id, data, @connection
-          }
+                    
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath(
+              '/iq[@type="result"]/pubsub:pubsub/pubsub:items/pubsub:item',
+              namespaces
+            ).map{|item|
+              item_id = item.attr('id')
+              data = item.xpath('./*').to_xml
+              Jubjub::Pubsub::Item.new jid, node, item_id, data, @connection
+            }
+          }.proxy_result
         end
         
         
@@ -496,18 +472,16 @@ module Jubjub
             }
           end
           
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]/pubsub_owner:pubsub/pubsub_owner:affiliations/pubsub_owner:affiliation',
-            namespaces
-          ).map{|affiliation|
-            jid = Jubjub::Jid.new affiliation.attr('jid')
-            affiliation = affiliation.attr('affiliation')
-            Jubjub::Pubsub::Affiliation.new pubsub_jid, pubsub_node, jid, affiliation, @connection
-          }
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath(
+              '/iq[@type="result"]/pubsub_owner:pubsub/pubsub_owner:affiliations/pubsub_owner:affiliation',
+              namespaces
+            ).map{|item|
+              jid = Jubjub::Jid.new item.attr('jid')
+              affiliation = item.attr('affiliation')
+              Jubjub::Pubsub::Affiliation.new pubsub_jid, pubsub_node, jid, affiliation, @connection
+            }
+          }.proxy_result
         end
         
         # http://xmpp.org/extensions/xep-0060.html#owner-affiliations-modify
@@ -541,13 +515,9 @@ module Jubjub
             }
           end
           
-          write(
-            # Generate stanza
-            request.to_xml
-          ).xpath(
-            # Pull out required parts
-            '//iq[@type="result"]'
-          ).any?
+          Jubjub::Response.new( write request.to_xml ){|stanza|
+            stanza.xpath( '/iq[@type="result"]' ).any?
+          }.proxy_result
         end
         
       private

data/lib/jubjub/response/error.rb

@@ -0,0 +1,33 @@
+module Jubjub
+  class Response
+    class Error
+
+      attr_reader :stanza
+
+      def initialize(xml)
+        @stanza = xml
+      end
+    
+      def condition
+        @condition ||= begin
+          condition = @stanza.xpath('//error/ietf:*','ietf' => 'urn:ietf:params:xml:ns:xmpp-stanzas').first
+          condition.name if condition
+        end
+      end
+      
+      def type
+        @error_type ||= stanza.xpath('//error').first.attr('type')
+      end
+      
+      def text(language=nil)        
+        if language
+          xpath = "//error/text[@xml:lang='#{language}']"
+        else
+          xpath = "//error/text"
+        end
+        stanza.xpath(xpath).text
+      end
+    
+    end
+  end
+end

data/lib/jubjub/response/proxy.rb

@@ -0,0 +1,44 @@
+module Jubjub
+  class Response
+    class Proxy
+
+      # Turn proxy class into a 'BasicObject'
+      instance_methods.each do |m|
+        undef_method(m) if m.to_s !~ /(?:^__|^nil?$|^send$|^object_id$|^should$)/
+      end
+      
+      attr_reader :proxy_primary, :proxy_secondary
+      
+      def initialize(primary, secondary, primary_method)
+        @proxy_primary = primary
+        @proxy_secondary = secondary
+        @primary_method = primary_method
+      end
+      
+      # We really want to show the secondary object
+      # as the primary is just a thin layer on top
+      def inspect
+        proxy_secondary.inspect
+      end
+      
+      # Used to give away this is really a proxy
+      def proxy_class
+        Jubjub::Response::Proxy
+      end
+      
+    private
+
+      def method_missing(name, *args, &block)
+        # If the method exists on the primary use that
+        # unless it's the method name called to create the proxy from the primary, or is a standard object method
+        if name.to_s != @primary_method && (proxy_primary.public_methods - Object.public_methods).include?( name.to_s )
+          proxy_primary.send(name, *args, &block)
+        else
+        # Else use a method on the secondary
+          proxy_secondary.send(name, *args, &block)
+        end
+      end
+      
+    end
+  end
+end

data/lib/jubjub/response/response.rb

@@ -0,0 +1,33 @@
+module Jubjub
+  
+  class Response
+    
+    attr_reader :stanza, :result
+    
+    def initialize(xml,&block)
+      @stanza = xml
+      
+      @result = nil
+      @result = yield stanza if block_given?
+    end
+    
+    def proxy_result
+      # Allows some syntax sugar. We can chain from the result, 
+      # but still get access to the response via the proxy
+      @proxy_result ||= Proxy.new self, result, 'proxy_result'
+    end
+    
+    def success?
+      @success ||= stanza.xpath('/iq[@type="result"]|/iq[@type="set"]|/iq[@type="get"]').any?
+    end
+    
+    def error
+      @errors ||= begin
+        s = stanza.at_xpath('/iq[@type="error"]/error')
+        Error.new s if s
+      end
+    end
+    
+  end
+  
+end

data/lib/jubjub/response.rb

@@ -0,0 +1,3 @@
+require "jubjub/response/response"
+require "jubjub/response/proxy"
+require "jubjub/response/error"

data/lib/jubjub/user.rb

@@ -1,4 +1,5 @@
 require 'jubjub/errors'
+require 'jubjub/response'
 require 'jubjub/jid'
 require 'jubjub/connection/xmpp_gateway'
 require 'jubjub/pubsub'

data/spec/connection/xmpp_gateway_muc_spec.rb

@@ -14,7 +14,7 @@ describe Jubjub::Connection::XmppGateway do
       
       it "return a Jubjub::Muc" do
         @room = @connection.muc.create( Jubjub::Jid.new 'room@conference.theo-template.local/nick' )
-        @room.should be_a_kind_of Jubjub::Muc
+        @room.should be_a_kind_of_response_proxied Jubjub::Muc
         @room.jid.should == Jubjub::Jid.new( 'room@conference.theo-template.local' )
       end
       
@@ -32,7 +32,7 @@ describe Jubjub::Connection::XmppGateway do
         @config = Jubjub::Muc::Configuration.new("allow_query_users" => { :type => "boolean", :value => "1", :label => "Allow users to query other users" })
         
         @room = @connection.muc.create( Jubjub::Jid.new( 'room@conference.theo-template.local/nick' ), @config )
-        @room.should be_a_kind_of Jubjub::Muc
+        @room.should be_a_kind_of_response_proxied Jubjub::Muc
         @room.jid.should == Jubjub::Jid.new( 'room@conference.theo-template.local' )
       end
       
@@ -104,7 +104,7 @@ describe Jubjub::Connection::XmppGateway do
       
       it "return an array of Jubjub::Muc" do
         list = @connection.muc.list( Jubjub::Jid.new 'conference.theo-template.local' )
-        list.should be_a_kind_of Array
+        list.should be_a_kind_of_response_proxied Array
         
         list.size.should eql(2)
         list[0].should be_a_kind_of Jubjub::Muc

data/spec/connection/xmpp_gateway_pubsub_spec.rb

@@ -15,7 +15,7 @@ describe Jubjub::Connection::XmppGateway do
       it "return a Jubjub::Pubsub" do
         @pubsub = @connection.pubsub.create 'pubsub.theo-template.local', 'node_1'
         
-        @pubsub.should be_a_kind_of Jubjub::Pubsub
+        @pubsub.should be_a_kind_of_response_proxied Jubjub::Pubsub
         @pubsub.jid.should == Jubjub::Jid.new('pubsub.theo-template.local')
         @pubsub.node.should == 'node_1'
       end
@@ -82,7 +82,7 @@ describe Jubjub::Connection::XmppGateway do
         
         config = @connection.pubsub.default_configuration 'pubsub.theo-template.local'
         
-        config.should be_a_kind_of Jubjub::Pubsub::Configuration
+        config.should be_a_kind_of_response_proxied Jubjub::Pubsub::Configuration
         config.should == Jubjub::Pubsub::Configuration.new( expected_config ) 
       end
     end
@@ -130,7 +130,7 @@ describe Jubjub::Connection::XmppGateway do
       
       it "return an array of Jubjub::Muc" do
         list = @connection.pubsub.list 'pubsub.theo-template.local'
-        list.should be_a_kind_of Array
+        list.should be_a_kind_of_response_proxied Array
         
         list.size.should eql(2)
         list[0].should be_a_kind_of Jubjub::Pubsub
@@ -173,7 +173,7 @@ describe Jubjub::Connection::XmppGateway do
       it "return a Jubjub::Pubsub::Subscription" do
         @subscription = @connection.pubsub.subscribe( 'pubsub.theo-template.local', 'node_1' )
         
-        @subscription.should be_a_kind_of Jubjub::Pubsub::Subscription
+        @subscription.should be_a_kind_of_response_proxied Jubjub::Pubsub::Subscription
         @subscription.jid.should == Jubjub::Jid.new('pubsub.theo-template.local')
         @subscription.node.should == 'node_1'
         @subscription.subscriber.should == @jid
@@ -239,7 +239,7 @@ describe Jubjub::Connection::XmppGateway do
         
         it "should return a Jubjub::Pubsub::Item" do
           i = @connection.pubsub.publish 'pubsub.theo-template.local', 'node_1', Jubjub::DataForm.new, '123'
-          i.should be_a_kind_of Jubjub::Pubsub::Item
+          i.should be_a_kind_of_response_proxied Jubjub::Pubsub::Item
           i.item_id.should == '123'
           i.data.should == "<x xmlns=\"jabber:x:data\" type=\"submit\"/>"
         end
@@ -252,7 +252,7 @@ describe Jubjub::Connection::XmppGateway do
         it "should return a Jubjub::Pubsub::Item" do
           item = "<x xmlns=\"jabber:x:data\" type=\"submit\"><field var=\"foo\"><value>true</value></field></x>"
           i = @connection.pubsub.publish 'pubsub.theo-template.local', 'node_1', item
-          i.should be_a_kind_of Jubjub::Pubsub::Item
+          i.should be_a_kind_of_response_proxied Jubjub::Pubsub::Item
           i.item_id.should be_a_kind_of String
           i.data.should == "<x xmlns=\"jabber:x:data\" type=\"submit\">\n  <field var=\"foo\">\n    <value>true</value>\n  </field>\n</x>"
         end
@@ -264,7 +264,7 @@ describe Jubjub::Connection::XmppGateway do
         
         it "should return a Jubjub::Pubsub::Item" do
           i = @connection.pubsub.publish 'pubsub.theo-template.local', 'node_1', Jubjub::DataForm.new({ :foo => {:type => "boolean", :value => true }})
-          i.should be_a_kind_of Jubjub::Pubsub::Item
+          i.should be_a_kind_of_response_proxied Jubjub::Pubsub::Item
           i.item_id.should be_a_kind_of String
           i.data.should == "<x xmlns=\"jabber:x:data\" type=\"submit\">\n  <field var=\"foo\">\n    <value>true</value>\n  </field>\n</x>"
         end
@@ -292,7 +292,7 @@ describe Jubjub::Connection::XmppGateway do
       end
       
       it "should return false when not successful" do
-        @connection.pubsub.retract( 'pubsub.theo-template.local', 'node_pubsub_retract', "wibble" ).should be_false        
+        @connection.pubsub.retract( 'pubsub.theo-template.local', 'node_pubsub_retract', "wibble" ).should equal(false)        
       end
       
       after do

data/spec/models/response_error_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Jubjub::Response::Error do
+  
+  describe 'creating' do
+    
+    it 'should take a stanza' do
+      xml = Nokogiri::XML::Document.parse "<error type='cancel'><feature-not-implemented xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/></error>"
+      
+      response = Jubjub::Response::Error.new xml
+      
+      response.stanza.should == xml
+    end
+        
+  end
+  
+  describe 'instance method' do
+    
+    describe 'condition' do
+      it 'should return a "urn:ietf:params:xml:ns:xmpp-stanzas" error condition' do
+        xml = Nokogiri::XML::Document.parse "<error><bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'></error>"
+        Jubjub::Response::Error.new( xml ).condition.should == "bad-request"
+      end
+         
+      it 'should return nil if unknown' do
+        xml = Nokogiri::XML::Document.parse "<error><text>Something went wrong</text><error/>"
+        Jubjub::Response::Error.new( xml ).condition.should equal(nil)
+      end  
+    end
+    
+    describe 'type' do
+      it 'should return nil if no error type available' do
+        xml = Nokogiri::XML::Document.parse "<error/>"
+        Jubjub::Response::Error.new( xml ).type.should equal(nil)
+      end
+      
+      it 'should return value errors present' do
+        xml = Nokogiri::XML::Document.parse "<error type='cancel'/>"
+        Jubjub::Response::Error.new( xml ).type.should == 'cancel'
+      end
+    end
+    
+    describe 'text' do
+      it 'should return empty string if no text is available' do 
+        xml = Nokogiri::XML::Document.parse "<error type='cancel'/>"
+        Jubjub::Response::Error.new( xml ).text.should == ""
+      end
+      
+      it 'should return the text if available' do
+        xml = Nokogiri::XML::Document.parse "<error type='cancel'><text>Hello!</text></error>"
+        Jubjub::Response::Error.new( xml ).text.should == "Hello!"
+      end
+      
+      it 'should return all text if available if multiple locales available' do
+        xml = Nokogiri::XML::Document.parse "<error type='cancel'><text xml:lang='en'>Hello!</text><text xml:lang='fr'>Bonjour!</text></error>"
+        Jubjub::Response::Error.new( xml ).text.should == "Hello!Bonjour!"
+      end
+      
+      it 'should return the text in the correct locale if language specified' do
+        xml = Nokogiri::XML::Document.parse "<error type='cancel'><text xml:lang='en'>Hello!</text><text xml:lang='fr'>Bonjour!</text></error>"
+        Jubjub::Response::Error.new( xml ).text('fr').should == "Bonjour!"
+        Jubjub::Response::Error.new( xml ).text('en').should == "Hello!"
+      end
+    end    
+  end
+
+  
+end

data/spec/models/response_proxy_spec.rb

@@ -0,0 +1,143 @@
+describe Jubjub::Response::Proxy do
+  
+  describe "creating" do
+    
+    it "should require proxy_primary, proxy_secondary and public_method" do
+      primary = "String"
+      secondary = ["Array"]
+      
+      p = Jubjub::Response::Proxy.new primary, secondary, "to_s"
+
+      p.proxy_primary.should equal(primary)
+      p.proxy_secondary.should equal(secondary)
+    end
+    
+  end
+  
+  describe "proxied methods" do
+    
+    before do
+      @primary_class = Class.new do
+        def abc() end
+        def efg() end
+        def xyz() end
+      end
+      
+      @secondary_class = Class.new do
+        def abc() end # Same as primary
+        def efg() end # Same as primary
+        def cba() end # Does not exist on primary
+      end
+      
+      @primary = @primary_class.new
+      @secondary = @secondary_class.new
+    end
+    
+    subject { Jubjub::Response::Proxy.new @primary, @secondary, 'efg' }
+    
+    describe "that exist on proxy_primary" do
+      
+      it "should not defer the primary_method" do
+        @primary.should_receive(:efg).never
+        
+        subject.efg
+      end
+      
+      it "should not defer methods that belong to Object.public_methods" do
+        @primary.should_receive(:class).never
+        
+        subject.class
+      end
+      
+      it "should defer to the proxy_primary" do
+        @primary.should_receive(:abc)
+        
+        subject.abc
+      end
+      
+    end
+    
+    describe "that don't defer to proxy_primary" do
+      
+      it "should defer to proxy_secondary" do
+        @secondary.should_receive(:cba)
+        
+        subject.cba
+      end
+      
+      it "should defer Object.public_methods to proxy_secondary" do
+        @secondary.should_receive(:class)
+        
+        subject.class
+      end
+      
+      it "should defer to proxy_secondary if primary_method" do
+        @secondary.should_receive(:efg)
+        
+        subject.efg
+      end
+      
+      it "should blow up if it doesn't exist on proxy_secondary either" do
+        expect {
+          subject.explode
+        }.to raise_error(NoMethodError,"undefined method `explode' for #{@secondary.inspect}")
+      end
+      
+    end
+    
+  end
+  
+  describe "instance method" do
+    
+    describe "inspect" do
+    
+      it "should really inspect proxy_secondary" do
+        # The proxy_primary is just a thin layer over the top of the proxy_secondary
+        # So make sure inspect shows us the proxy_secondary
+        primary = "String"
+        secondary = ["Array"]
+
+        p = Jubjub::Response::Proxy.new primary, secondary, "to_s"
+        
+        p.inspect.should == secondary.inspect
+      end
+      
+    end
+    
+    describe "proxy_primary" do
+      
+      it "should return the proxy_primary object" do
+        primary = "p"
+        
+        proxy = Jubjub::Response::Proxy.new primary, "s", "to_s"
+        
+        proxy.proxy_primary.should equal(primary)
+      end
+      
+    end
+    
+    describe "proxy_secondary" do
+      
+      it "should return the proxy_secondary object" do
+        secondary = "p"
+        
+        proxy = Jubjub::Response::Proxy.new "p", secondary, "to_s"
+        
+        proxy.proxy_secondary.should equal(secondary)
+      end
+      
+    end
+    
+    describe "proxy_class" do
+      
+      it "should return Jubjub::Response::Proxy" do
+        p = Jubjub::Response::Proxy.new "p", "s", "to_s"
+        
+        p.proxy_class.should equal(Jubjub::Response::Proxy)
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/models/response_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Jubjub::Response do
+  
+  describe 'creating' do
+    
+    it 'should take a stanza' do
+      stanza = xml_fixture 'dataform_1'
+      
+      response = Jubjub::Response.new stanza
+      
+      response.stanza.should == stanza
+      response.result.should == nil
+    end
+    
+    it 'should take a block to define result' do
+      stanza = xml_fixture 'dataform_1'
+      
+      namespaces = {
+        'commands' => 'http://jabber.org/protocol/commands',
+        'x_data' => 'jabber:x:data'
+      }
+      
+      response = Jubjub::Response.new( stanza ) do |s|
+        s.xpath(
+          "//iq[@type='result']/commands:command/x_data:x[@type='form']/x_data:instructions",
+          namespaces
+        ).text
+      end
+      
+      response.result.should == 'Fill out this form to configure your new bot!'
+    end
+    
+  end
+  
+  describe 'instance method' do
+    
+    describe 'result' do
+      
+      before { @stanza = xml_fixture 'dataform_1' }
+      
+      it 'should return result of block used in initialization if specified' do        
+        Jubjub::Response.new( @stanza ){ "Result" }.result.should == "Result"
+      end
+      
+      it 'should return nil if no block provided' do
+        Jubjub::Response.new( @stanza ).result.should == nil
+      end
+      
+    end
+    
+    describe 'proxy_result' do
+      
+      before { @stanza = xml_fixture 'dataform_1' }
+      
+      it 'should return proxy of result' do
+        result = "Result"
+        Jubjub::Response.new( @stanza ){ result }.proxy_result.should be_a_kind_of_response_proxied result.class
+      end
+      
+    end
+    
+    describe 'success?' do
+      it 'should return true when stanza is iq[@type="get"]' do
+        xml = Nokogiri::XML::Document.parse "<iq type='get'/>"
+        Jubjub::Response.new( xml ).success?.should equal(true)
+      end
+      
+      it 'should return true when stanza is iq[@type="result"]' do
+        xml = Nokogiri::XML::Document.parse "<iq type='result'/>"
+        Jubjub::Response.new( xml ).success?.should equal(true)
+      end
+      
+      it 'should return true when stanza is iq[@type="set"]' do
+        xml = Nokogiri::XML::Document.parse "<iq type='set'/>"
+        Jubjub::Response.new( xml ).success?.should equal(true)
+      end
+      
+      it 'should return false when stanza is iq[@type="error"]' do
+        xml = Nokogiri::XML::Document.parse "<iq type='error'/>"
+        Jubjub::Response.new( xml ).success?.should equal(false)
+      end
+      
+      it 'should not look at child iq elements' do
+        xml = Nokogiri::XML::Document.parse "<totally><wrong><iq type='result'/></wrong></totally>"
+        Jubjub::Response.new( xml ).success?.should equal(false)
+      end
+      
+      it 'should return false when stanza is nonsensical' do
+        xml = Nokogiri::XML::Document.parse "<presence/>"
+        Jubjub::Response.new( xml ).success?.should equal(false)
+      end
+    end
+    
+    describe 'error' do
+      
+      it 'should return Jubjub::Response:Error object if error present' do
+        xml = Nokogiri::XML::Document.parse "<iq type='error'><error><policy-violation xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'></error></iq>"
+        r = Jubjub::Response.new( xml )
+        r.error.should be_a Jubjub::Response::Error
+        r.error.condition.should == "policy-violation"
+      end
+      
+      it 'should return nil if error is not present' do
+        xml = Nokogiri::XML::Document.parse "<iq type='set'/>"
+        Jubjub::Response.new( xml ).error.should be_nil
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/support/matchers.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :be_a_kind_of_response_proxied do |secondary_class| 
+  match do |proxy|
+    proxy.proxy_class == Jubjub::Response::Proxy && 
+    proxy.proxy_primary.class == Jubjub::Response && 
+    proxy.proxy_secondary.class == secondary_class
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jubjub
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Theo Cushion
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +01:00
+date: 2011-06-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -119,6 +119,10 @@ files:
 - lib/jubjub/pubsub/pubsub.rb
 - lib/jubjub/pubsub/subscription.rb
 - lib/jubjub/pubsub.rb
+- lib/jubjub/response/error.rb
+- lib/jubjub/response/proxy.rb
+- lib/jubjub/response/response.rb
+- lib/jubjub/response.rb
 - lib/jubjub/user.rb
 - lib/jubjub.rb
 - LICENSE
@@ -162,8 +166,12 @@ files:
 - spec/models/pubsub_item_spec.rb
 - spec/models/pubsub_spec.rb
 - spec/models/pubsub_subscription_spec.rb
+- spec/models/response_error_spec.rb
+- spec/models/response_proxy_spec.rb
+- spec/models/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
+- spec/support/matchers.rb
 - spec/support/shared_examples.rb
 - .rspec
 - .infinity_test
@@ -243,8 +251,12 @@ test_files:
 - spec/models/pubsub_item_spec.rb
 - spec/models/pubsub_spec.rb
 - spec/models/pubsub_subscription_spec.rb
+- spec/models/response_error_spec.rb
+- spec/models/response_proxy_spec.rb
+- spec/models/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
+- spec/support/matchers.rb
 - spec/support/shared_examples.rb
 - .rspec
 - .infinity_test