blather 0.4.15 → 0.4.16

data/lib/blather/client/dsl.rb

@@ -252,6 +252,22 @@ module Blather
       client.write stanza
     end
 
+    def set_caps(node, identities, features)
+      client.caps.node = node
+      client.caps.identities = identities
+      client.caps.features = features
+    end
+
+    def send_caps
+      client.register_handler :disco_info, :type => :get, :node => client.caps.node do |s|
+        r = client.caps.dup
+        r.to = s.from
+        r.id = s.id
+        client.write r
+      end
+      client.write client.caps.c
+    end
+
     # Generate a method for every stanza handler that exists.
     Blather::Stanza.handler_list.each do |handler_name|
       module_eval <<-METHOD, __FILE__, __LINE__

data/lib/blather/core_ext/active_support.rb

@@ -36,7 +36,7 @@ end
 
 class Symbol  # @private
   def duplicable?; false; end
-  def to_proc; proc { |obj, *args| obj.send(self, *args) }; end
+  def to_proc; Proc.new { |*args| args.shift.__send__(self, *args) }; end
 end
 
 class Numeric  # @private

data/lib/blather/core_ext/ipaddr.rb

@@ -0,0 +1,19 @@
+class IPAddr
+  PrivateRanges = [
+    IPAddr.new("10.0.0.0/8"),
+    IPAddr.new("172.16.0.0/12"),
+    IPAddr.new("192.168.0.0/16")
+  ]
+
+  def private?
+    return false unless self.ipv4?
+    PrivateRanges.each do |ipr|
+      return true if ipr.include?(self)
+    end
+    return false
+  end
+
+  def public?
+    !private?
+  end
+end

data/lib/blather/file_transfer/s5b.rb

@@ -7,10 +7,17 @@ module Blather
       # Set this to false if you don't want to fallback to In-Band Bytestreams
       attr_accessor :allow_ibb_fallback
 
+      # Set this to true if the buddies of your bot will be in the same local network
+      #
+      # Usually IM clients advertise all network addresses which they can determine.
+      # Skipping the local ones can save time if your bot is not in the same local network as it's buddies
+      attr_accessor :allow_private_ips
+
       def initialize(stream, iq)
         @stream = stream
         @iq = iq
         @allow_ibb_fallback = true
+        @allow_private_ips = false
       end
 
       # Accept an incoming file-transfer
@@ -19,6 +26,7 @@ module Blather
       # @param [Array] params the params to be passed into the handler
       def accept(handler, *params)
         @streamhosts = @iq.streamhosts
+        @streamhosts.delete_if {|s| begin IPAddr.new(s.host).private? rescue false end } unless @allow_private_ips
         @socket_address = Digest::SHA1.hexdigest("#{@iq.sid}#{@iq.from}#{@iq.to}")
 
         @handler = handler

data/lib/blather/roster_item.rb

@@ -122,8 +122,11 @@ module Blather
       self.jid.to_s <=> o.jid.to_s
     end
 
-    def eql?(o)
-      o.is_a?(RosterItem) &&
+    # Compare two RosterItem objects by name, type and category
+    # @param [RosterItem] o the Identity object to compare against
+    # @return [true, false]
+    def eql?(o, *fields)
+      o.is_a?(self.class) &&
       o.jid == self.jid &&
       o.groups == self.groups
     end

data/lib/blather/stanza/disco.rb

@@ -19,6 +19,13 @@ class Stanza
     def node=(node)
       query[:node] = node
     end
+
+    # Compare two Disco objects by name, type and category
+    # @param [Disco] o the Identity object to compare against
+    # @return [true, false]
+    def eql?(o, *fields)
+      super o, *(fields + [:node])
+    end
   end
 
 end # Stanza

data/lib/blather/stanza/disco/disco_info.rb

@@ -59,6 +59,13 @@ class Stanza
       end
     end
 
+    # Compare two DiscoInfo objects by name, type and category
+    # @param [DiscoInfo] o the Identity object to compare against
+    # @return [true, false]
+    def eql?(o, *fields)
+      super o, *(fields + [:identities, :features])
+    end
+
     class Identity < XMPPNode
       # Create a new DiscoInfo Identity
       # @overload new(node)
@@ -146,17 +153,9 @@ class Stanza
       # Compare two Identity objects by name, type and category
       # @param [DiscoInfo::Identity] o the Identity object to compare against
       # @return [true, false]
-      def eql?(o)
-        unless o.is_a?(self.class)
-          raise "Cannot compare #{self.class} with #{o.class}"
-        end
-
-        o.name == self.name &&
-        o.type == self.type &&
-        o.category == self.category &&
-        o.xml_lang == self.xml_lang
+      def eql?(o, *fields)
+        super o, *(fields + [:name, :type, :category, :xml_lang])
       end
-      alias_method :==, :eql?
     end # Identity
 
     class Feature < XMPPNode
@@ -191,17 +190,12 @@ class Stanza
         write_attr :var, var
       end
 
-      # Compare two Feature objects by var
-      # @param [DiscoInfo::Feature] o the Feature object to compare against
+      # Compare two DiscoInfo::Feature objects by name, type and category
+      # @param [DiscoInfo::Feature] o the Identity object to compare against
       # @return [true, false]
-      def eql?(o)
-        unless o.is_a?(self.class)
-          raise "Cannot compare #{self.class} with #{o.class}"
-        end
-
-        o.var == self.var
+      def eql?(o, *fields)
+        super o, *(fields + [:var])
       end
-      alias_method :==, :eql?
     end
   end # Feature
 

data/lib/blather/stanza/disco/disco_items.rb

@@ -121,19 +121,13 @@ class Stanza
         write_attr :name, name
       end
 
-      # Check for equality based on jid, node, and name
-      #
-      # @param [Blather::Stanza::DiscoItems::Item] o the other Item
-      def eql?(o)
-        unless o.is_a?(self.class)
-          raise "Cannot compare #{self.class} with #{o.class}"
-        end
 
-        o.jid == self.jid &&
-        o.node == self.node &&
-        o.name == self.name
+      # Compare two DiscoItems::Item objects by name, type and category
+      # @param [DiscoItems::Item] o the Identity object to compare against
+      # @return [true, false]
+      def eql?(o, *fields)
+        super o, *(fields + [:jid, :node, :name])
       end
-      alias_method :==, :eql?
     end
   end
 

data/lib/blather/stanza/presence.rb

@@ -85,12 +85,22 @@ class Stanza
     # on the type attribute.
     # If neither is found it instantiates a Presence object
     def self.import(node) # :nodoc:
-      klass = case node['type']
-      when nil, 'unavailable' then Status
-      when /subscribe/        then Subscription
-      else self
+      klass = nil
+      node.children.detect do |e|
+        ns = e.namespace ? e.namespace.href : nil
+        klass = class_from_registration(e.element_name, ns)
+      end
+
+      if klass && klass != self
+        klass.import(node)
+      else
+        klass = case node['type']
+          when nil, 'unavailable' then Status
+          when /subscribe/        then Subscription
+          else self
+        end
+        klass.new.inherit(node)
       end
-      klass.new.inherit(node)
     end
 
     # Ensure element_name is "presence" for all subclasses

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

@@ -0,0 +1,103 @@
+module Blather
+class Stanza
+class Presence
+
+  # # Entity Capabilities Stanza
+  #
+  # [XEP-0115 - Entity Capabilities](http://http://xmpp.org/extensions/xep-0115.html)
+  #
+  # Blather handles c nodes through this class. It provides a set of helper methods
+  # to quickly deal with capabilites presence stanzas.
+  #
+  # @handler :c
+  class C < Presence
+    register :c, :c, 'http://jabber.org/protocol/caps'
+
+    VALID_HASH_TYPES = %w[md2 md5 sha-1 sha-224 sha-256 sha-384 sha-512].freeze
+
+    def self.new(node = nil, ver = nil, hash = 'sha-1')
+      new_node = super()
+      new_node.c
+      new_node.hash = hash
+      new_node.node = node
+      new_node.ver = ver
+      new_node
+    end
+
+    def self.import(node)
+      self.new.inherit(node)
+    end
+
+    # @private
+    def inherit(node)
+      inherit_attrs node.attributes
+      self
+    end
+
+    # Get the name of the node
+    #
+    # @return [String, nil]
+    def node
+      c[:node]
+    end
+
+    # Set the name of the node
+    #
+    # @param [String, nil] node the new node name
+    def node=(node)
+      c[:node] = node
+    end
+
+    # Get the name of the hash
+    #
+    # @return [Symbol, nil]
+    def hash
+      c[:hash].to_sym
+    end
+
+    # Set the name of the hash
+    #
+    # @param [String, nil] hash the new hash name
+    def hash=(hash)
+      if hash && !VALID_HASH_TYPES.include?(hash.to_s)
+        raise ArgumentError, "Invalid Hash Type (#{hash}), use: #{VALID_HASH_TYPES*' '}"
+      end
+      c[:hash] = hash
+    end
+
+    # Get the ver
+    #
+    # @return [String, nil]
+    def ver
+      c[:ver]
+    end
+
+    # Set the ver
+    #
+    # @param [String, nil] ver the new ver
+    def ver=(ver)
+      c[:ver] = ver
+    end
+
+    # C node accessor
+    # If a c node exists it will be returned.
+    # Otherwise a new node will be created and returned
+    #
+    # @return [Blather::XMPPNode]
+    def c
+      c = if self.class.registered_ns
+        find_first('ns:c', :ns => self.class.registered_ns)
+      else
+        find_first('c')
+      end
+
+      unless c
+        (self << (c = XMPPNode.new('c', self.document)))
+        c.namespace = self.class.registered_ns
+      end
+      c
+    end
+  end # C
+end #Presence
+end #Stanza
+end

data/lib/blather/stanza/x.rb

@@ -331,11 +331,9 @@ class Stanza
       # Compare two Field objects by type, var and label
       # @param [X::Field] o the Field object to compare against
       # @return [true, false]
-      def eql?(o)
-        raise "Cannot compare #{self.class} with #{o.class}" unless o.is_a?(self.class)
-        ![:type, :var, :label, :desc, :required?, :value].detect { |m| o.send(m) != self.send(m) }
+      def eql?(o, *fields)
+        super o, *(fields + [:type, :var, :label, :desc, :required?, :value])
       end
-      alias_method :==, :eql?
 
       class Option < XMPPNode
         register :option, 'jabber:x:data'

data/lib/blather/version.rb

@@ -0,0 +1,3 @@
+module Blather
+  VERSION = '0.4.16'
+end

data/lib/blather/xmpp_node.rb

@@ -213,6 +213,14 @@ module Blather
     def inspect
       self.to_xml
     end
+
+    def eql?(o, *fields)
+      o.is_a?(self.class) && fields.all? { |f| self.__send__(f) == o.__send__(f) }
+    end
+
+    def ==(o)
+      eql?(o)
+    end
   end  # XMPPNode
 
 end  # Blather

data/spec/blather/client/client_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path "../../../spec_helper", __FILE__
+require 'spec_helper'
 require 'blather/client/client'
 
 describe Blather::Client do
@@ -26,6 +26,11 @@ describe Blather::Client do
     @client.status.must_equal :away
   end
 
+  it 'should have a caps handler' do
+    @client.must_respond_to :caps
+    @client.caps.must_be_kind_of Blather::Client::Caps
+  end
+
   it 'can be setup' do
     @client.must_respond_to :setup
     @client.setup('me@me.com', 'pass').must_equal @client
@@ -571,3 +576,84 @@ describe 'Blather::Client guards' do
     lambda { @client.register_handler(:iq, 0) {} }.must_raise RuntimeError
   end
 end
+
+describe 'Blather::Client::Caps' do
+  before do
+    @client = Blather::Client.new
+    @stream = mock()
+    @stream.stubs(:send)
+    @client.post_init @stream, Blather::JID.new('n@d/r')
+    @caps = @client.caps
+  end
+
+  it 'must be of type result' do
+    @caps.must_respond_to :type
+    @caps.type.must_equal :result
+  end
+
+  it 'can have a client node set' do
+    @caps.must_respond_to :node=
+    @caps.node = "somenode"
+  end
+
+  it 'provides a client node reader' do
+    @caps.must_respond_to :node
+    @caps.node = "somenode"
+    @caps.node.must_equal "somenode##{@caps.ver}"
+  end
+
+  it 'can have identities set' do
+    @caps.must_respond_to :identities=
+    @caps.identities = [{:name => "name", :type => "type", :category => "cat"}]
+  end
+
+  it 'provides an identities reader' do
+    @caps.must_respond_to :identities
+    @caps.identities = [{:name => "name", :type => "type", :category => "cat"}]
+    @caps.identities.must_equal [Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => "name", :type => "type", :category => "cat"})]
+  end
+
+  it 'can have features set' do
+    @caps.must_respond_to :features=
+    @caps.features.size.must_equal 0
+    @caps.features = ["feature1"]
+    @caps.features.size.must_equal 1
+    @caps.features += [Blather::Stanza::Iq::DiscoInfo::Feature.new("feature2")]
+    @caps.features.size.must_equal 2
+    @caps.features = nil
+    @caps.features.size.must_equal 0
+  end
+
+  it 'provides a features reader' do
+    @caps.must_respond_to :features
+    @caps.features = %w{feature1 feature2}
+    @caps.features.must_equal [Blather::Stanza::Iq::DiscoInfo::Feature.new("feature1"), Blather::Stanza::Iq::DiscoInfo::Feature.new("feature2")]
+  end
+
+  it 'provides a client ver reader' do
+    @caps.must_respond_to :ver
+    @caps.node = 'http://code.google.com/p/exodus'
+    @caps.identities = [Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => 'Exodus 0.9.1', :type => 'pc', :category => 'client'})]
+    @caps.features = %w{
+                          http://jabber.org/protocol/caps
+                          http://jabber.org/protocol/disco#info
+                          http://jabber.org/protocol/disco#items
+                          http://jabber.org/protocol/muc
+                        }
+    @caps.ver.must_equal 'QgayPKawpkPSDYmwT/WM94uAlu0='
+    @caps.node.must_equal "http://code.google.com/p/exodus#QgayPKawpkPSDYmwT/WM94uAlu0="
+  end
+
+  it 'can construct caps presence correctly' do
+    @caps.must_respond_to :c
+    @caps.node = 'http://code.google.com/p/exodus'
+    @caps.identities = [Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => 'Exodus 0.9.1', :type => 'pc', :category => 'client'})]
+    @caps.features = %w{
+                          http://jabber.org/protocol/caps
+                          http://jabber.org/protocol/disco#info
+                          http://jabber.org/protocol/disco#items
+                          http://jabber.org/protocol/muc
+                        }
+    @caps.c.inspect.must_equal "<presence>\n  <c xmlns=\"http://jabber.org/protocol/caps\" hash=\"sha-1\" node=\"http://code.google.com/p/exodus\" ver=\"QgayPKawpkPSDYmwT/WM94uAlu0=\"/>\n</presence>"
+  end
+end