yong-stropheruby 0.0.6 → 0.1.0

data/Manifest.txt

@@ -4,6 +4,7 @@ Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
+examples/xmpp_client.rb
 ext/md5.c
 ext/parser.c
 ext/util.c

data/README.rdoc

@@ -1,143 +1,22 @@
-= strophe_ruby
+== OVERVIEW
 
-http://stropheruby.rubyforge.org
+Stropheruby is a ruby bindings for Strophe, a C library for writing XMPP clients.
 
-== DESCRIPTION:
+This is a fork of flamontagne's stropheruby (http://github.com/flamontagne/stropheruby/tree/master) with the following improvements:
 
-Ruby bindings for Strophe 'http://code.stanziq.com/strophe/', a C library for 
-writing XMPP clients. If all you need is a simple XMPP bot that
-react to message and presence notifications, you might be better off
-with XMPPBot, which is an implementation I wrote on top of StropheRuby.
+* A patched version of libstrophe (trunk) is included. So there is no extra library to install. 
+* (libstrophe) Fixed a timeout issue on Mac OSX: http://groups.google.com/group/strophe-dev/browse_thread/thread/ef4cb19785020fb6
+* (libstrophe) Fixed basic auth: http://groups.google.com/group/strophe-dev/browse_thread/thread/b770f72c83d1a0b9
+* (libstrophe) Changed xmpp_run_once's return code so that the application can tell if an error or timeout occurs
+* (stropheruby) Added send_raw_string method
+* (stropheruby) Detect login failure
+* (stropheruby) Fix resource leak
 
-IMPORTANT : This gem is quite experimental currently... it is not ready 
-for production!
+== INSTALLATION
 
-Strophe 'http://code.stanziq.com/strophe/' is a robust and well written 
-C library that allows the developer to implement XMPP clients.
+sudo gem sources -a http://gems.github.com
+sudo gem install yong-stropheruby
 
-I wanted to be able to use the power of this library with the ruby 
-syntax. I didn't use SWIG to generate the bindings for 2 reasons :
+== EXAMPLE
 
-1. I wanted to learn how to write a C extension for ruby
-2. I didn't like how SWIG generate gazilions of lines of code
-
-My other project, XMPPBot, is an implementation of Strophe Ruby that 
-allows the ruby developer to write a XMPP bot in a few lines of code.
-
-== CURRENT PROBLEMS:
-
-- Currently no Support for TLS encryption (Coming soon as it's rather important)
-- Cannot terminate the loop with CTRL-C
-- Socket disconnects after being inactive for too long
-- Cannot output log data in a file
-
-
-== EXAMPLE OF USE
-
-require 'strophe_ruby'
-
-def announce_presence
-  stanza = StropheRuby::Stanza.new
-  stanza.name = "presence"
-  @conn.send(stanza)
-end
-
-def register_callbacks
-  #Accept all subscriptions
-  @conn.add_handler("presence") do |pres|
-    if pres.type == "subscribe"
-      #we accept
-      p = StropheRuby::Stanza.new
-      p.name = "presence"
-      p.type = "subscribed"
-      p.set_attribute("to",pres.attribute("from"))
-      @conn.send(p)
-
-      #then it's our turn to send our subscription request
-      p = StropheRuby::Stanza.new
-      p.name = "presence"
-      p.type = "subscribe"
-      p.set_attribute("to",pres.attribute("from"))
-      @conn.send(p)    
-    end
-  end
-  
-  #simple echo for messages
-  @conn.add_handler("message") do |msg|
-  
-    if msg.child_by_name("body")
-      top_stanza = StropheRuby::Stanza.new
-      top_stanza.name="message"
-      top_stanza.type="chat"
-      top_stanza.set_attribute("to", msg.attribute("from"))
-      
-      body_stanza = StropheRuby::Stanza.new
-      body_stanza.name="body"
-      
-      text_stanza = StropheRuby::Stanza.new
-      text_stanza.text = msg.child_by_name("body").text
-      
-      body_stanza.add_child(text_stanza)
-      top_stanza.add_child(body_stanza)
-      @conn.send(top_stanza)
-    end
-  end
-end
-
-
-#Prepare the strophe library
-StropheRuby::EventLoop.prepare
-
-#create the runtime context and specify the logging level (WARN,INFO,ERROR or DEBUG)
-@ctx=StropheRuby::Context.new(StropheRuby::Logging::DEBUG)
-
-#create the connection passing it the context
-@conn=StropheRuby::Connection.new(@ctx)
-
-#set the jid and password
-@conn.jid = 'bot@example.com'
-@conn.password = 'secret'
-
-#Try to connect
-@conn.connect do |status|
-  if status == StropheRuby::ConnectionEvents::CONNECT
-    #We are connected.
-    announce_presence
-    register_callbacks
-  else
-    @conn.disconnect
-  end
-end
-
-
-#Start the event loop
-StropheRuby::EventLoop.run(@ctx)
-
-puts 'Disconnected'
-
-== INSTALL:
-
-gem install strophe_ruby
-
-== LICENSE:
-
-Copyright (c) 2008 François Lamontagne
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+See example.rb

data/Rakefile

@@ -3,7 +3,7 @@ require 'hoe'
 
 EXT = "ext/strophe_ruby.#{Hoe::DLEXT}"
 
-Hoe.new('stropheruby', '0.0.6') do |p|
+Hoe.new('stropheruby', '0.1.0') do |p|
   p.developer('François Lamontagne', 'flamontagne@gmail.com') 
   p.summary = 'strophe_ruby' 
 

data/examples/xmpp_client.rb

@@ -0,0 +1,65 @@
+require 'strophe_ruby'
+
+class XmppClient
+  def query_roster(jid, password)
+    new_connection(jid, password) {
+      current_stage = 1
+      @connection.add_handler("iq") do |iq|
+        case current_stage
+        when 1 
+          @connection.send_raw_string("<iq type='get' id='1238647002'><query xmlns='jabber:iq:roster'/></iq>")
+          current_stage += 1
+        else
+          StropheRuby::EventLoop.stop(@ctx)
+        end
+      end
+    }
+  end
+  
+private
+
+  def new_connection(jid, password)
+    lib = StropheRuby::EventLoop.prepare
+    @ctx = StropheRuby::Context.new(StropheRuby::Logging::DEBUG)
+    @connection = StropheRuby::Connection.new(@ctx)
+    @connection.jid = jid
+    @connection.password = password
+    connected = false
+    @connection.connect do |status|
+      if !connected
+        connected = true
+        if status != StropheRuby::ConnectionEvents::CONNECT
+          #do somthing after login fails
+          raise 'failed to login'
+        else
+          #do something after login
+          yield if block_given?
+        end
+      end
+    end
+
+    run_event_loop_until_timeout_or_stopped_by_callback!
+  end
+ 
+  #run event loop until timeout or 'StropheRuby::EventLoop.stop' is called inside callback
+  def run_event_loop_until_timeout_or_stopped_by_callback!(timeout = 3000)
+    raise 'unexpected state' if (@ctx.loop_status != StropheRuby::EventLoop::LOOP_NOTSTARTED)
+    @ctx.loop_status = StropheRuby::EventLoop::LOOP_RUNNING
+    
+    while @ctx.loop_status == StropheRuby::EventLoop::LOOP_RUNNING
+      #return if the socket is idle for more than timeout (in millisecond)
+      if StropheRuby::EventLoop.run_once(@ctx, timeout) != 0
+        @connection.disconnect
+        return false
+      end
+    end
+
+    @connection.disconnect
+    return true
+  end
+end
+
+if $0 == __FILE__
+  client = XmppClient.new
+  client.query_roster("a1@localhost", 'a1')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yong-stropheruby
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Lamontagne"
@@ -74,6 +74,7 @@ files:
 - test/test_strophe_ruby.rb
 - test/test_strophe_ruby_extn.rb
 - ext/extconf.rb
+- examples/xmpp_client.rb
 has_rdoc: true
 homepage: 
 post_install_message: