blather 0.4.16 → 0.5.0

data/CHANGELOG

@@ -1,9 +1,16 @@
+v0.5.0
+  Feature(radsaq): Add a #connected? method on Blather::Client
+  Feature(benlangfeld)[API change]: Allow the removal of child nodes from an IQ reply
+  Bugfix(zlu): Use rubygems properly in examples
+  Bugfix(benlangfeld): Remove code borrowed from ActiveSupport and instead depend on it to avoid version conflicts
+  Documentation(sprsquish)
+
 v0.4.16
-	Feature(benlangfeld): switch from jeweler to bundler
-	Feature(benlangfeld): add cap support (XEP-0115)
-	Bugfix(sprsquish): Better equality checking
-	Bugfix(sprsquish): Fix #to_proc
-	Bugfix(mironov): Skip private IPs by default
+  Feature(benlangfeld): switch from jeweler to bundler
+  Feature(benlangfeld): add cap support (XEP-0115)
+  Bugfix(sprsquish): Better equality checking
+  Bugfix(sprsquish): Fix #to_proc
+  Bugfix(mironov): Skip private IPs by default
 
 v0.4.15
   Feature(mironov): Implement XEP-0054: vcard-temp

data/README.md

@@ -1,4 +1,4 @@
-# Blather
+# Blather [ ![Build status](http://travis-ci.org/sprsquish/blather.png) ](http://travis-ci.org/sprsquish/blather)
 
 XMPP DSL (and more) for Ruby written on EventMachine and Nokogiri.
 

data/Rakefile

@@ -23,10 +23,8 @@ require 'yard'
 YARD::Tags::Library.define_tag 'Blather handler', :handler, :with_name
 YARD::Templates::Engine.register_template_path 'yard/templates'
 
-YARD::Rake::YardocTask.new do |t|
+YARD::Rake::YardocTask.new(:doc) do |t|
   t.options = ['--no-private', '-m', 'markdown', '-o', './doc/public/yard']
 end
 
-desc 'Generate documentation'
-task :doc => :yard
 task :default => :test

data/blather.gemspec

@@ -21,29 +21,16 @@ Gem::Specification.new do |s|
   s.rdoc_options = %w{--charset=UTF-8}
   s.extra_rdoc_files = %w{LICENSE README.md}
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency("eventmachine", ["~> 0.12.6"])
+  s.add_dependency("nokogiri", [">= 1.4.0"])
+  s.add_dependency("minitest", [">= 1.7.1"])
+  s.add_dependency("activesupport", [">= 3.0.7"])
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, ["~> 0.12.6"])
-      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.4.0"])
-
-      s.add_development_dependency(%q<minitest>, ["~> 1.7.1"])
-      s.add_development_dependency(%q<mocha>, ["~> 0.9.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<rcov>, ["~> 0.9.9"])
-      s.add_development_dependency(%q<yard>, ["~> 0.6.1"])
-      s.add_development_dependency(%q<bluecloth>, ["~> 2.1.0"])
-      s.add_development_dependency(%q<rake>)
-    else
-      s.add_dependency(%q<eventmachine>, [">= 0.12.6"])
-      s.add_dependency(%q<nokogiri>, [">= 1.4.0"])
-      s.add_dependency(%q<minitest>, [">= 1.7.1"])
-    end
-  else
-    s.add_dependency(%q<eventmachine>, [">= 0.12.6"])
-    s.add_dependency(%q<nokogiri>, [">= 1.4.0"])
-    s.add_dependency(%q<minitest>, [">= 1.7.1"])
-  end
+  s.add_development_dependency("minitest", ["~> 1.7.1"])
+  s.add_development_dependency("mocha", ["~> 0.9.12"])
+  s.add_development_dependency("bundler", ["~> 1.0.0"])
+  s.add_development_dependency("rcov", ["~> 0.9.9"])
+  s.add_development_dependency("yard", ["~> 0.6.1"])
+  s.add_development_dependency("bluecloth", ["~> 2.1.0"])
+  s.add_development_dependency("rake")
 end

data/examples/echo.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
 require 'blather/client'
 
 when_ready { puts "Connected ! send messages to #{jid.stripped}." }

data/examples/execute.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
 require 'blather/client'
 
 message :chat?, :body => 'exit' do |m|

data/examples/ping_pong.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'blather/client/dsl'
 $stdout.sync = true
 

data/examples/print_hierarchy.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'blather'
 
 class Object

data/examples/rosterprint.rb

@@ -2,6 +2,7 @@
 
 # Prints out each roster entry
 
+require 'rubygems'
 require 'blather/client'
 
 when_ready do

data/examples/stream_only.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
 require 'blather'
 
 trap(:INT) { EM.stop }

data/examples/xmpp4r/echo.rb

@@ -2,6 +2,7 @@
 
 # This bot will reply to every message it receives. To end the game, send 'exit'
 
+require 'rubygems'
 require 'xmpp4r/client'
 include Jabber
 

data/lib/blather.rb

@@ -8,7 +8,9 @@
   digest/sha1
   logger
 
-  blather/core_ext/active_support
+  active_support/core_ext/class/inheritable_attributes
+  active_support/core_ext/object/blank
+
   blather/core_ext/eventmachine
   blather/core_ext/ipaddr
   blather/core_ext/nokogiri
@@ -37,6 +39,7 @@
   blather/stanza/disco
   blather/stanza/disco/disco_info
   blather/stanza/disco/disco_items
+  blather/stanza/disco/capabilities
   blather/stanza/message
   blather/stanza/presence
   blather/stanza/presence/c
@@ -72,6 +75,7 @@
   blather/stream/features/tls
 ].each { |r| require r }
 
+# The core Blather namespace
 module Blather
   # @private
   @@logger = nil

data/lib/blather/client/client.rb

@@ -57,11 +57,16 @@ module Blather
       @tmp_handlers = {}
       @filters = {:before => [], :after => []}
       @roster = Roster.new self
-      @caps = Caps.new
+      @caps = Stanza::Capabilities.new
 
       setup_initial_handlers
     end
 
+    # Check whether the client is currently connected.
+    def connected?
+      setup? && !@stream.stopped?
+    end
+
     # Get the current status. Taken from the `state` attribute of Status
     def status
       @status.state
@@ -162,17 +167,20 @@ module Blather
       self.stream.close_connection_after_writing
     end
 
-    def post_init(stream, jid = nil)  # @private
+    # @private
+    def post_init(stream, jid = nil)
       @stream = stream
       @jid = JID.new(jid) if jid
       self.jid.node ? client_post_init : ready!
     end
 
-    def unbind  # @private
+    # @private
+    def unbind
       call_handler_for(:disconnected, nil) || (EM.reactor_running? && EM.stop)
     end
 
-    def receive_data(stanza)  # @private
+    # @private
+    def receive_data(stanza)
       catch(:halt) do
         run_filters :before, stanza
         handle_stanza stanza
@@ -180,11 +188,13 @@ module Blather
       end
     end
 
-    def setup?  # @private
+    # @private
+    def setup?
       @setup.is_a? Array
     end
 
-    def setup(jid, password, host = nil, port = nil)  # @private
+    # @private
+    def setup(jid, password, host = nil, port = nil)
       @jid = JID.new(jid)
       @setup = [@jid, password]
       @setup << host if host
@@ -192,21 +202,22 @@ module Blather
       self
     end
 
-  protected
-    def stream  # @private
+    protected
+
+    def stream
       @stream || raise('Stream not ready!')
     end
 
-    def check_handler(type, guards)  # @private
+    def check_handler(type, guards)
       Blather.logger.warn "Handler for type \"#{type}\" will never be called as it's not a registered type" unless current_handlers.include?(type)
       check_guards guards
     end
 
-    def current_handlers  # @private
+    def current_handlers
       [:ready, :disconnected] + Stanza.handler_list + BlatherError.handler_list
     end
 
-    def setup_initial_handlers  # @private
+    def setup_initial_handlers
       register_handler :error do |err|
         raise err
       end
@@ -225,12 +236,12 @@ module Blather
       end
     end
 
-    def ready!  # @private
+    def ready!
       @state = :ready
       call_handler_for :ready, nil
     end
 
-    def client_post_init  # @private
+    def client_post_init
       write_with_handler Stanza::Iq::Roster.new do |node|
         roster.process node
         write @status
@@ -238,14 +249,14 @@ module Blather
       end
     end
 
-    def run_filters(type, stanza)  # @private
+    def run_filters(type, stanza)
       @filters[type].each do |guards, handler, filter|
         next if handler && !stanza.handler_hierarchy.include?(handler)
         catch(:pass) { call_handler filter, guards, stanza }
       end
     end
 
-    def handle_stanza(stanza)  # @private
+    def handle_stanza(stanza)
       if handler = @tmp_handlers.delete(stanza.id)
         handler.call stanza
       else
@@ -255,14 +266,14 @@ module Blather
       end
     end
 
-    def call_handler_for(type, stanza)  # @private
+    def call_handler_for(type, stanza)
       return unless handler = @handlers[type]
       handler.find do |guards, handler|
         catch(:pass) { call_handler handler, guards, stanza }
       end
     end
 
-    def call_handler(handler, guards, stanza)  # @private
+    def call_handler(handler, guards, stanza)
       if guards.first.respond_to?(:to_str)
         result = stanza.find(*guards)
         handler.call(stanza, result) unless result.empty?
@@ -303,7 +314,7 @@ module Blather
       end
     end
 
-    def check_guards(guards)  # @private
+    def check_guards(guards)
       guards.each do |guard|
         case guard
         when Array
@@ -315,142 +326,6 @@ module Blather
         end
       end
     end
-
-    class Caps < Blather::Stanza::DiscoInfo
-      def self.new
-        super :result
-      end
-
-      def ver
-        generate_ver identities, features
-      end
-
-      def node=(node)
-        @bare_node = node
-        super "#{node}##{ver}"
-      end
-
-      def identities=(identities)
-        super identities
-        regenerate_full_node
-      end
-
-      def features=(features)
-        super features
-        regenerate_full_node
-      end
-
-      def c
-        Blather::Stanza::Presence::C.new @bare_node, ver
-      end
-
-      private
-
-      def regenerate_full_node
-        self.node = @bare_node
-      end
-
-      def generate_ver_str(identities, features, forms = [])
-        # 1.  Initialize an empty string S.
-        s = ''
-
-        # 2. Sort the service discovery identities by category and
-        # then by type (if it exists) and then by xml:lang (if it
-        # exists), formatted as CATEGORY '/' [TYPE] '/' [LANG] '/'
-        # [NAME]. Note that each slash is included even if the TYPE,
-        # LANG, or NAME is not included.
-        identities.sort! do |identity1, identity2|
-          cmp_result = nil
-          [:category, :type, :xml_lang, :name].each do |field|
-            value1 = identity1.send(field)
-            value2 = identity2.send(field)
-
-            if value1 != value2
-              cmp_result = value1 <=> value2
-              break
-            end
-          end
-          cmp_result
-        end
-
-        # 3. For each identity, append the 'category/type/lang/name' to
-        # S, followed by the '<' character.
-        s += identities.collect do |identity|
-          [:category, :type, :xml_lang, :name].collect do |field|
-            identity.send(field).to_s
-          end.join('/') + '<'
-        end.join
-
-        # 4. Sort the supported service discovery features.
-        features.sort! { |feature1, feature2| feature1.var <=> feature2.var }
-
-        # 5. For each feature, append the feature to S, followed by the
-        # '<' character.
-        s += features.collect { |feature| feature.var.to_s + '<' }.join
-
-        # 6. If the service discovery information response includes
-        # XEP-0128 data forms, sort the forms by the FORM_TYPE (i.e., by
-        # the XML character data of the <value/> element).
-        forms.sort! do |form1, form2|
-          fform_type1 = form1.field 'FORM_TYPE'
-          fform_type2 = form2.field 'FORM_TYPE'
-          form_type1 = fform_type1 ? fform_type1.values.to_s : nil
-          form_type2 = fform_type2 ? fform_type2.values.to_s : nil
-          form_type1 <=> form_type2
-        end
-
-        # 7. For each extended service discovery information form:
-        forms.each do |form|
-          # 7.1. Append the XML character data of the FORM_TYPE field's
-          # <value/> element, followed by the '<' character.
-          fform_type = form.field 'FORM_TYPE'
-          form_type = fform_type ? fform_type.values.to_s : nil
-          s += "#{form_type}<"
-
-          # 7.2. Sort the fields by the value of the "var" attribute
-          fields = form.fields.sort { |field1, field2| field1.var <=> field2.var }
-
-          # 7.3. For each field:
-          fields.each do |field|
-            # 7.3.1. Append the value of the "var" attribute, followed by
-            # the '<' character.
-            s += "#{field.var}<"
-
-            # 7.3.2. Sort values by the XML character data of the <value/> element
-            # values = field.values.sort { |value1, value2| value1 <=> value2 }
-
-            # 7.3.3. For each <value/> element, append the XML character
-            # data, followed by the '<' character.
-            # s += values.collect { |value| "#{value}<" }.join
-            s += "#{field.value}<"
-          end
-        end
-        s
-      end
-
-      def generate_ver(identities, features, forms = [], hash = 'sha-1')
-        s = generate_ver_str identities, features, forms
-
-        # 9. Compute the verification string by hashing S using the
-        # algorithm specified in the 'hash' attribute (e.g., SHA-1 as
-        # defined in RFC 3174). The hashed data MUST be generated
-        # with binary output and encoded using Base64 as specified in
-        # Section 4 of RFC 4648 (note: the Base64 output MUST NOT
-        # include whitespace and MUST set padding bits to zero).
-
-        # See http://www.iana.org/assignments/hash-function-text-names
-        hash_klass = case hash
-                       when 'md2' then nil
-                       when 'md5' then Digest::MD5
-                       when 'sha-1' then Digest::SHA1
-                       when 'sha-224' then nil
-                       when 'sha-256' then Digest::SHA256
-                       when 'sha-384' then Digest::SHA384
-                       when 'sha-512' then Digest::SHA512
-                     end
-        hash_klass ? [hash_klass::digest(s)].pack('m').strip : nil
-      end
-    end # Caps
   end  # Client
 
 end  # Blather