@@ -4,6 +4,10 @@ PostInstall.txt README.rdoc Rakefile lib/xmppbot.rb +lib/xmppbot/bot.rb +lib/xmppbot/message.rb +lib/xmppbot/other.rb +lib/xmppbot/presence.rb script/console script/destroy script/generate Manifest.txt @@ -1,7 +1,56 @@ +Example of use : -For more information on xmppbot, see http://xmppbot.rubyforge.org +require 'xmppbot' + +class Johnny5 < XMPPBot::Bot + def connect + super do |status| + if status == XMPPBot::ConnectionEvents::CONNECT + announce_presence + register_callbacks + else + disconnect + end + end + end + + def register_callbacks + on_presence_received do |pres| + puts "#{pres.from} is now #{pres.to_s}" unless pres.to_s.strip == +"" + end + + on_message_received do |msg| + if msg.body == "exit" + disconnect + else + stanza=XMPPBot::Message.new + stanza.to=msg.from + stanza.body="You said : #{msg.body}" + send(stanza) + end + end + end +end + +@bot = Johnny5.new +@bot.jid = "cripes@jaim.at" +@bot.password = "cripes" +@bot.log_level = XMPPBot::Logging::INFO +@bot.auto_accept_subscriptions = true + +@bot.connect + +#We pause the execution of the current thread to prevent the program +from exiting +Thread.stop -NOTE: Change this information in PostInstall.txt -You can also delete it if you don't want it. +#Once the parsing thread exits, execution resumes here +puts "Connection terminated" + + + + +For more information on xmppbot, see http://xmppbot.rubyforge.org PostInstall.txt @@ -23,7 +23,6 @@ Warning : StropheRuby is very experimental at the moment. It is definitely NOT r How to use it : require 'xmppbot' - def register_callbacks @bot.on_presence_received do |pres| puts "#{pres.from} is now #{pres.to_s}" README.rdoc @@ -6,8 +6,7 @@ module XMPPBot class Bot - attr_accessor :jid, :password, :log_level, :auto_accept_subscriptions - + attr_accessor :jid, :password, :log_level, :auto_accept_subscriptions #connect, authenticate and start event loop def connect StropheRuby::EventLoop.prepare @@ -30,15 +29,13 @@ module XMPPBot #start the event loop in a separate thread Thread.new do Thread.current.abort_on_exception = true - - #StropheRuby::EventLoop.run(@ctx) - + @ctx.loop_status=1 while @ctx.loop_status == 1 StropheRuby::EventLoop.run_once(@ctx,1) end - #shutdown down strophe and wake up the calling thread + #shutdown down strophe and wake up the calling thread StropheRuby::EventLoop.shutdown main_thread.wakeup end lib/xmppbot/bot.rb @@ -37,8 +37,16 @@ module XMPPBot self.stanza.type=type end + def show + s=self.stanza.child_by_name("show") + s ? s.text : nil + end + + #returns the show (away, dnd, chat,xa). if there is none, returns the type which can be : unavailable + #subscribe,subscribed,unsubscribe,unsubscribed,probe or error. def to_s - self.stanza.child_by_name("show").text rescue "available" + res = self.show + res ? res : self.type.to_s end end end \ No newline at end of file lib/xmppbot/presence.rb pkg/xmppbot-0.0.1.gem pkg/xmppbot-0.0.1.tgz @@ -4,6 +4,10 @@ PostInstall.txt README.rdoc Rakefile lib/xmppbot.rb +lib/xmppbot/bot.rb +lib/xmppbot/message.rb +lib/xmppbot/other.rb +lib/xmppbot/presence.rb script/console script/destroy script/generate pkg/xmppbot-0.0.1/Manifest.txt @@ -1,7 +1,56 @@ +Example of use : -For more information on xmppbot, see http://xmppbot.rubyforge.org +require 'xmppbot' + +class Johnny5 < XMPPBot::Bot + def connect + super do |status| + if status == XMPPBot::ConnectionEvents::CONNECT + announce_presence + register_callbacks + else + disconnect + end + end + end + + def register_callbacks + on_presence_received do |pres| + puts "#{pres.from} is now #{pres.to_s}" unless pres.to_s.strip == +"" + end + + on_message_received do |msg| + if msg.body == "exit" + disconnect + else + stanza=XMPPBot::Message.new + stanza.to=msg.from + stanza.body="You said : #{msg.body}" + send(stanza) + end + end + end +end + +@bot = Johnny5.new +@bot.jid = "cripes@jaim.at" +@bot.password = "cripes" +@bot.log_level = XMPPBot::Logging::INFO +@bot.auto_accept_subscriptions = true + +@bot.connect + +#We pause the execution of the current thread to prevent the program +from exiting +Thread.stop -NOTE: Change this information in PostInstall.txt -You can also delete it if you don't want it. +#Once the parsing thread exits, execution resumes here +puts "Connection terminated" + + + + +For more information on xmppbot, see http://xmppbot.rubyforge.org pkg/xmppbot-0.0.1/PostInstall.txt @@ -1,26 +1,68 @@ = xmppbot -* FIX (url) - == DESCRIPTION: -FIX (describe your package) +Simple implementation on top of StropheRuby(http://github.com/flamontagne/strophe_ruby/). +It's for those who want to build simple xmpp bots quickly. It features only the essential : +- auto accept subscriptions +- callback for received messages +- callback for received presences +- a method to send messages and presences +- That's it + +Warning : StropheRuby is very experimental at the moment. It is definitely NOT ready for production! == FEATURES/PROBLEMS: -* FIX (list of features or problems) +- Only tested under Debian +- No TLS support for now. It will work once TLS with OpenSSL is working in Strophe (http://code.stanziq.com/strophe) + == SYNOPSIS: - FIX (code sample of usage) +How to use it : + +require 'xmppbot' +def register_callbacks + @bot.on_presence_received do |pres| + puts "#{pres.from} is now #{pres.to_s}" + end + + @bot.on_message_received do |msg| + if msg.body == "exit" + @bot.disconnect + else + stanza=XMPPBot::Message.new + stanza.to=msg.from + stanza.body="You said : #{msg.body}" + @bot.send(stanza) + end + end +end + + +@bot=XMPPBot::Bot.new +@bot.jid="bot@example.com" +@bot.password="secret" +@bot.log_level = XMPPBot::Logging::DEBUG +@bot.auto_accept_subscriptions = true + +@bot.connect do |status| + if status == XMPPBot::ConnectionEvents::CONNECT + @bot.announce_presence + register_callbacks + else + @bot.disconnect + end +end == REQUIREMENTS: -* FIX (list of requirements) +* Compile and install StropheRuby (http://github.com/flamontagne/stropheruby) == INSTALL: -* FIX (sudo gem install, anything else) +* For now you can install the GEM in the pkg directory. Remember that you need StropheRuby to use XMPPBot () == LICENSE: @@ -45,4 +87,4 @@ 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. \ No newline at end of file +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. pkg/xmppbot-0.0.1/README.rdoc @@ -2,213 +2,10 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__))) require 'strophe_ruby' +require 'xmppbot/bot' +require 'xmppbot/message' +require 'xmppbot/presence' +require 'xmppbot/other' module XMPPBot -VERSION = '0.0.1' - class Bot - attr_accessor :jid, :password, :log_level, :auto_accept_subscriptions - - def connect - StropheRuby::EventLoop.prepare - @ctx=StropheRuby::Context.new(@log_level) - @conn=StropheRuby::Connection.new(@ctx) - @conn.jid = @jid - @conn.password= @password - @conn.connect do |status| - accept_subscriptions if auto_accept_subscriptions - keep_alive - yield(status) - end - - #FIXME: The following call works perfectly... but when you try stopping the program with CTRL-C, it produces a XMPP event watcher error. - #See the run_once method in strophe/src/event.c for details. For now I do my own control loop and call run_once manually - #Thread.new {EventLoop.run(@ctx)} - - return if @ctx.loop_status != 0 - @ctx.loop_status = 1 - th= Thread.new do - Thread.current.abort_on_exception = true - while (@ctx.loop_status == 1) do - StropheRuby::EventLoop.run_once(@ctx, 1) - end - Thread.main.wakeup - end - end - - def keep_alive - Thread.new do - loop do - difference = (@last_send || Time.now) + 90 - Time.now - if difference <= 0 - self.announce_presence - sleep(90) - else - sleep(difference) - end - end - end - end - - def accept_subscriptions - self.on_presence_received do |pres| - if pres.stanza.type == "subscribe" - stanza = StropheRuby::Stanza.new - stanza.name = "presence" - stanza.type = "subscribed" - stanza.set_attribute("to",pres.stanza.attribute("from")) - self.send_stanza(stanza) - stanza.release - - stanza = StropheRuby::Stanza.new - stanza.name = "presence" - stanza.type = "subscribe" - stanza.set_attribute("to",pres.stanza.attribute("from")) - self.send_stanza(stanza) - stanza.release - end - end - end - - def disconnect - StropheRuby::EventLoop.stop(@ctx) - @conn.release - @ctx.free - StropheRuby::EventLoop.shutdown - end - - def send(obj) - if obj.respond_to?(:stanza) - send_stanza(obj.stanza) - else - raise("native Stanza object has not been set") - end - end - - def send_stanza(stanza) - @conn.send(stanza) - @last_send=Time.now - end - - def announce_presence - presence = StropheRuby::Stanza.new - presence.name="presence" - presence.set_attribute("show", "available") - self.send_stanza(presence) - presence.release - end - - def on_message_received - @conn.add_handler("message") do |stanza| - yield(Message.new(stanza)) if Message.new(stanza).body - end - end - - def on_presence_received - @conn.add_handler("presence") do |stanza| - yield(Presence.new(stanza)) - end - end - end - - class Presence - attr_reader :stanza - - def initialize(stanza=nil) - if stanza - @stanza=stanza - else - @stanza = StropheRuby::Stanza.new - end - end - - def from - self.stanza.attribute("from") - end - - def to - self.stanza.attribute("to") - end - - def to=(to) - self.stanza.set_attribute("to",to) - end - - def type - self.stanza.type - end - - def type=(type) - self.stanza.type=type - end - - def to_s - self.stanza.child_by_name("show").text rescue "available" - end - end - - class Message - attr_reader :stanza - def initialize(stanza=nil) - if stanza - @stanza=stanza - else - @stanza=StropheRuby::Stanza.new - @stanza.name="message" - @stanza.type="chat" - end - end - - def from - self.stanza.attribute("from") rescue nil - end - def from=(value) - self.stanza.set_attribute("from",value.to_s) - end - - def type - self.stanza.type - end - - def type=(type) - self.stanza.type=type - end - - - def body - self.stanza.child_by_name("body").text rescue nil - end - - def body=(str) - children = self.stanza.children - - if children - children.children.text = str - else - body_stanza = StropheRuby::Stanza.new - body_stanza.name="body" - - text_stanza = StropheRuby::Stanza.new - text_stanza.text=str - - body_stanza.add_child(text_stanza) - self.stanza.add_child(body_stanza) - end - end - - def to=(to) - self.stanza.set_attribute("to",to) - end - end - - class ConnectionEvents - CONNECT = StropheRuby::ConnectionEvents::CONNECT - DISCONNECT = StropheRuby::ConnectionEvents::DISCONNECT - FAIL = StropheRuby::ConnectionEvents::FAIL - end - - class Logging - INFO = StropheRuby::Logging::INFO - WARN = StropheRuby::Logging::WARN - ERROR = StropheRuby::Logging::ERROR - DEBUG = StropheRuby::Logging::DEBUG - end + VERSION = '0.0.1' end \ No newline at end of file pkg/xmppbot-0.0.1/lib/xmppbot.rb bc52302b283117b1b7bcc6b9048f880cf948b2bc Frank flamontagne@gmail.com http://github.com/flamontagne/xmppbot/commit/0074558befe70b1f47d7420d5bfd69ee602bed7c 0074558befe70b1f47d7420d5bfd69ee602bed7c 2008-12-12T10:47:32-08:00 2008-12-12T10:47:32-08:00 put example of use in PostInstall eba0475b0ab72db4921a5775982511d64f63b9b5 Frank flamontagne@gmail.com