xmpp4r 0.3.2 → 0.4

data/data/doc/xmpp4r/examples/basic/send_vcard.rb

@@ -22,9 +22,9 @@ if ARGV.length < 2
 end
 
 # Do the client stuff...
-myJID = JID::new(ARGV.shift)
+myJID = JID.new(ARGV.shift)
 myPassword = ARGV.shift
-cl = Client::new(myJID)
+cl = Client.new(myJID)
 cl.connect
 cl.auth(myPassword)
 
@@ -35,7 +35,7 @@ begin
   puts "Retrieving vCard information for #{cl.jid.strip}"
   vcard = vcard_helper.get
 
-  
+
   # Inspect the command line for vCard fields to be changed
   ARGV.each { |arg|
     arg.scan(/^(.+?)=(.*)$/) { |field,text|
@@ -65,4 +65,3 @@ rescue Exception => e
 end
 
 cl.close
-

data/data/doc/xmpp4r/examples/basic/tune_client.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/roster'
+require 'xmpp4r/discovery'
+require 'xmpp4r/caps'
+require 'xmpp4r/tune'
+
+
+#
+# Echo tunes received via XEP-0118 User Tune notifications
+#
+# See Jabber::UserTune::Helper for the gory details
+#
+
+if ARGV.length != 3
+  puts "Usage: ruby tune_client.rb <jid> <pw> <tune-playing-jid>"
+  exit 1
+end
+
+jid = ARGV[0]
+pw = ARGV[1]
+dj_jid = ARGV[2]
+
+#Jabber::debug=true
+cl = Jabber::Client.new(Jabber::JID.new(jid))
+cl.connect
+cl.auth(pw)
+
+# PEP (XEP-0163 says we need:
+# - a 'both' subscription to the dj
+# - told the server that we support the '...tune+notify' feature
+# before we can receive events
+roster = Jabber::Roster::Helper.new(cl)
+roster.add_subscription_request_callback(0, nil) do |item,pres|
+  roster.accept_subscription(pres.from)
+end
+
+caps = Jabber::Caps::Helper.new(cl,
+  [Jabber::Discovery::Identity.new('client', nil, 'pc')],
+  [Jabber::Discovery::Feature.new('http://jabber.org/protocol/tune+notify')]
+)
+
+t = Jabber::UserTune::Helper.new(cl, dj_jid)
+t.add_usertune_callback do |tune|
+  puts "from:#{dj_jid} tune:#{tune.artist} plays #{tune.title}"
+end
+
+p = Jabber::Presence.new()
+p.type = :subscribe
+p.to = dj_jid
+cl.send p
+
+Thread.stop

data/data/doc/xmpp4r/examples/basic/tune_server.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+$:.unshift '../../../../../lib'
+
+require 'xmpp4r'
+require 'xmpp4r/roster'
+require 'xmpp4r/tune'
+require 'rbosa'
+
+#
+# Send XEP-0118 User Tune events...
+#
+# See Jabber::UserTune::Helper for the gory details...
+#
+# NB needs rbosa library to access iTunes - only on MacOSX
+#
+
+if ARGV.length != 2:
+  puts "Usage: ruby tune_server.rb <jid> <pw>"
+  exit 1
+end
+
+jid=ARGV[0]
+pw=ARGV[1]
+
+Jabber::debug=true
+
+cl = Jabber::Client.new(jid)
+cl.connect
+cl.auth(pw)
+
+# Following XEP-0163 PEP we need to
+# ensure we have a 'both' subscription to the Tune client
+roster = Jabber::Roster::Helper.new(cl)
+roster.add_subscription_request_callback do |item,pres|
+  roster.accept_subscription(pres.from)
+
+  reply = pres.answer
+  reply.type = :subscribe
+  cl.send(reply)
+end
+
+cl.send(Jabber::Presence.new.set_show(:chat))
+
+t=Jabber::UserTune::Helper.new(cl, nil)
+
+itunes=OSA.app('iTunes')
+
+loop do
+  track = itunes.current_track
+
+  if track
+    puts "Now playing: #{track.name} by #{track.artist}"
+    t.now_playing(Jabber::UserTune::Tune.new(track.artist, track.name))
+  end
+
+  sleep 5
+end

data/data/doc/xmpp4r/examples/basic/versionbot.rb

@@ -23,7 +23,7 @@ end
 
 jid = Jabber::JID.new(ARGV[0])
 
-cl = Jabber::Client.new(jid, false)
+cl = Jabber::Client.new(jid)
 cl.connect
 cl.auth(ARGV[1])
 

data/lib/xmpp4r.rb

@@ -30,7 +30,7 @@
 #
 # This is not only useful for stanzas but all other XML processing, too:
 # * <tt><x/></tt> children elements of <tt><message/></tt> and <tt><presence/></tt> are converted to Jabber::X
-# * <tt><error/></tt> children elements of all three stanzas are converted to Jabber::Error
+# * <tt><error/></tt> children elements of all three stanzas are converted to Jabber::ErrorResponse
 # * <tt><query/></tt> children elements of <tt><iq/></tt> are converted to Jabber::IqQuery
 # * <tt><vCard/></tt> children elements of <tt><iq/></tt> are converted to Jabber::IqVcard
 #
@@ -63,7 +63,7 @@
 #
 # Because it is built in an extensible way, it might be hard for newcomers to
 # understand where to look at documentation for a specific method. For example,
-# Client heritates from Connection, which itself heritates from Stream.
+# Client inherits from Connection, which itself inherits from Stream.
 #
 # A newcomer should have a look at the <tt>Jabber::Client</tt> and
 # <tt>Jabber::Component</tt> classes, and their parent classes
@@ -73,7 +73,7 @@
 #
 # ==Non-basic features
 #
-# <tt>require 'xmpp4r'</tt> does only include basic functionality as
+# <tt>require 'xmpp4r'</tt> only includes basic functionality for
 # Connections, Authentication, Stream processing, Callbacks, Stanza handling
 # and Debugging to keep the library's footprint small.
 #
@@ -100,7 +100,7 @@
 #
 # Helpers are intended to give more simplistic interfaces to various tasks
 # of Jabber clients at the cost of flexibility. But you won't need that
-# order of flexibility for the most things.
+# level of flexibility in most cases.
 #
 # * Jabber::Roster::Helper: <tt>require 'xmpp4r/roster'</tt>
 # * Jabber::MUC::MUCBrowser, Jabber::MUC::MUCClient, Jabber::MUC::SimpleMUCClient: <tt>require 'xmpp4r/muc'</tt>

data/lib/xmpp4r/base64.rb

@@ -0,0 +1,32 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
+begin
+  require 'base64'
+rescue LoadError
+  ##
+  # Ruby 1.9 has dropped the Base64 module,
+  # this is a replacement
+  #
+  # We could replace all call by Array#pack('m')
+  # and String#unpack('m'), but this module
+  # improves readability.
+  module Base64
+    ##
+    # Encode a String
+    # data:: [String] Binary
+    # result:: [String] Binary in Base64
+    def self.encode64(data)
+      [data].pack('m')
+    end
+
+    ##
+    # Decode a Base64-encoded String
+    # data64:: [String] Binary in Base64
+    # result:: [String] Binary
+    def self.decode64(data64)
+      data64.unpack('m').first
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/filetransfer.rb

@@ -101,7 +101,7 @@ module Jabber
             length = @length - @bytes_read  # Truncate it!
           end
         end
-        
+
         buf = @file.read(length)
         @bytes_read += buf.size if buf
         buf
@@ -213,7 +213,7 @@ module Jabber
         else
           eanswer = iq.answer(false)
           eanswer.type = :error
-          eanswer.add(Error.new('bad-request')).type = :cancel
+          eanswer.add(ErrorResponse.new('bad-request')).type = :cancel
           eanswer.error.add(REXML::Element.new('no-valid-streams')).add_namespace('http://jabber.org/protocol/si')
           @stream.send(eanswer)
 
@@ -228,7 +228,7 @@ module Jabber
       def decline(iq)
         answer = iq.answer(false)
         answer.type = :error
-        error = answer.add(Error.new('forbidden', 'Offer declined'))
+        error = answer.add(ErrorResponse.new('forbidden', 'Offer declined'))
         error.type = :cancel
         @stream.send(answer)
       end
@@ -241,7 +241,7 @@ module Jabber
       # The result is a stream which you can configure, or nil
       # if the peer responded with an invalid stream-method.
       #
-      # May raise an ErrorException
+      # May raise an ServerError
       # jid:: [JID] to send the file to
       # source:: File-transfer source, implementing the FileSource interface
       # desc:: [String] or [nil] Optional file description
@@ -259,7 +259,7 @@ module Jabber
           offered_methods[Bytestreams::IBB::NS_IBB] = nil
         end
 
-        iq = Iq::new(:set, jid)
+        iq = Iq.new(:set, jid)
         iq.from = from
         si = iq.add(Bytestreams::IqSi.new(session_id, Bytestreams::PROFILE_FILETRANSFER, source.mime))
 
@@ -278,10 +278,10 @@ module Jabber
         begin
           stream_method = nil
           response = nil
-          @stream.send_with_id(iq) { |r|
+          @stream.send_with_id(iq) do |r|
             response = r
             si = response.first_element('si')
-            if response.type == :result and si and si.feature and si.feature.x
+            if si and si.feature and si.feature.x
               stream_method = si.feature.x.field('stream-method').values.first
 
               if si.file and si.file.range
@@ -293,9 +293,8 @@ module Jabber
                 end
               end
             end
-            true
-          }
-        rescue ErrorException => e
+          end
+        rescue ServerError => e
           if e.error.code == 403  # Declined
             return false
           else
@@ -310,7 +309,7 @@ module Jabber
         else  # Target responded with a stream_method we didn't offer
           eanswer = response.answer
           eanswer.type = :error
-          eanswer.add Error::new('bad-request')
+          eanswer.add ErrorResponse.new('bad-request')
           @stream.send(eanswer)
           nil
         end

data/lib/xmpp4r/bytestreams/helper/ibb/base.rb

@@ -2,7 +2,7 @@
 # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
 # Website::http://home.gna.org/xmpp4r/
 
-require 'base64'
+require 'xmpp4r/base64'
 
 module Jabber
   module Bytestreams
@@ -124,7 +124,7 @@ module Jabber
       # Close the stream
       #
       # Waits for acknowledge from peer,
-      # may throw ErrorException
+      # may throw ServerError
       def close
         if active?
           flush
@@ -135,9 +135,7 @@ module Jabber
           close.add_namespace IBB::NS_IBB
           close.attributes['sid'] = @session_id
 
-          @stream.send_with_id(iq) { |answer|
-            answer.type == :result
-          }
+          @stream.send_with_id(iq)
         end
       end
 
@@ -151,12 +149,12 @@ module Jabber
           msg = Message.new
           msg.from = @my_jid
           msg.to = @peer_jid
-          
+
           data = msg.add REXML::Element.new('data')
           data.add_namespace NS_IBB
           data.attributes['sid'] = @session_id
           data.attributes['seq'] = @seq_send.to_s
-          data.text = Base64::encode64 databuf
+          data.text = Base64::encode64(databuf)
 
           # TODO: Implement AMP correctly
           amp = msg.add REXML::Element.new('amp')
@@ -169,7 +167,7 @@ module Jabber
           match_resource.attributes['condition'] = 'match-resource'
           match_resource.attributes['value'] = 'exact'
           match_resource.attributes['action'] = 'error'
-   
+
           @stream.send(msg)
 
           @seq_send += 1

data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb

@@ -14,21 +14,18 @@ module Jabber
       # Open the stream to the peer,
       # waits for successful result
       #
-      # May throw ErrorException
+      # May throw ServerError
       def open
         iq = Iq.new(:set, @peer_jid)
         open = iq.add REXML::Element.new('open')
         open.add_namespace IBB::NS_IBB
         open.attributes['sid'] = @session_id
-        open.attributes['block-size'] = @block_size
+        open.attributes['block-size'] = @block_size.to_s
 
-        @stream.send_with_id(iq) { |answer|
-          answer.type == :result
-        }
+        @stream.send_with_id(iq)
 
         activate
       end
     end
   end
 end
-

data/lib/xmpp4r/bytestreams/helper/ibb/target.rb

@@ -45,4 +45,3 @@ module Jabber
     end
   end
 end
-

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb

@@ -26,7 +26,7 @@ module Jabber
       #
       # default: nil, use the OS' default timeout
       attr_accessor :connect_timeout
-      
+
       def initialize(stream, session_id, initiator_jid, target_jid)
         @stream = stream
         @session_id = session_id
@@ -95,19 +95,16 @@ module Jabber
       def self.query_streamhost(stream, streamhost, my_jid=nil)
         res = nil
 
-        iq = Iq::new(:get, streamhost)
+        iq = Iq.new(:get, streamhost)
         iq.from = my_jid
         iq.add(IqQueryBytestreams.new)
         stream.send_with_id(iq) { |reply|
-          if reply.type == :result
-            reply.query.each_element { |e|
-              if e.kind_of?(StreamHost)
-                e.jid = reply.from  # Help misconfigured proxys
-                res = e
-              end
-            }
-          end
-          true
+          reply.query.each_element { |e|
+            if e.kind_of?(StreamHost)
+              e.jid = reply.from  # Help misconfigured proxys
+              res = e
+            end
+          }
         }
 
         if res and res.jid and res.host and res.port

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb

@@ -40,7 +40,7 @@ module Jabber
       # wait for an answer and
       # connect to the host the target chose.
       def open
-        iq1 = Iq::new(:set, @target_jid)
+        iq1 = Iq.new(:set, @target_jid)
         iq1.from = @initiator_jid
         bs = iq1.add IqQueryBytestreams.new(@session_id)
         @streamhosts.each { |se|
@@ -49,12 +49,11 @@ module Jabber
 
         peer_used = nil
         @stream.send_with_id(iq1) { |response|
-          if response.type == :result and response.query.kind_of?(IqQueryBytestreams)
+          if response.query.kind_of?(IqQueryBytestreams)
             peer_used = response.query.streamhost_used
             raise "No streamhost-used" unless peer_used
             raise "Invalid streamhost-used" unless peer_used.jid
           end
-          true
         }
 
         @streamhost_used = nil
@@ -77,11 +76,9 @@ module Jabber
             @streamhost_cbs.process(@streamhost_used, :failure, e)
             raise e
           end
-          iq2 = Iq::new(:set, @streamhost_used.jid)
+          iq2 = Iq.new(:set, @streamhost_used.jid)
           iq2.add(IqQueryBytestreams.new(@session_id)).activate = @target_jid.to_s
-          @stream.send_with_id(iq2) { |reply|
-            reply.type == :result
-          }
+          @stream.send_with_id(iq2)
         end
       end
     end