xmppbot 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-05
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+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
+test/test_helper.rb
+test/test_xmppbot.rb

data/PostInstall.txt

@@ -0,0 +1,56 @@
+Example of use :
+
+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
+
+#Once the parsing thread exits, execution resumes here
+puts "Connection terminated"
+
+
+
+
+
+
+For more information on xmppbot, see http://xmppbot.rubyforge.org

data/README.rdoc

@@ -0,0 +1,90 @@
+= xmppbot
+
+== DESCRIPTION:
+
+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:
+
+- 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:
+
+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:
+
+* Compile and install StropheRuby (http://github.com/flamontagne/stropheruby)
+
+== INSTALL:
+
+* For now you can install the GEM in the pkg directory. Remember that you need StropheRuby to use XMPPBot ()
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+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.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+#require File.dirname(__FILE__) + '/lib/xmppbot'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('xmppbot', '0.0.1') do |p|
+  p.developer('François Lamontagne', 'flamontagne@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+   p.extra_deps         = [
+     ['strophe_ruby','>= 0.0.1'],
+   ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/xmppbot/bot.rb

@@ -0,0 +1,147 @@
+############################################################
+# XMPPBot::Bot
+# Really simple implementation of StropheRuby to ease the devleopment process of a XMPP bot
+# Author : Francois Lamontagne
+############################################################
+
+module XMPPBot
+  class Bot
+    attr_accessor :jid, :password, :log_level, :auto_accept_subscriptions      
+    #connect, authenticate and start event loop
+    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|
+        if status == StropheRuby::ConnectionEvents::CONNECT
+          accept_subscriptions if auto_accept_subscriptions
+          keep_alive
+        end
+        yield(status)
+      end
+
+      main_thread = Thread.current      
+    
+      #start the event loop in a separate thread      
+      Thread.new do
+        Thread.current.abort_on_exception = true
+                
+        @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
+        StropheRuby::EventLoop.shutdown
+        main_thread.wakeup
+      end
+    end
+
+    #accept subscription request from the user then send a subscription request to that same user.
+    def accept_subscriptions
+      on_presence_received do |pres|
+        if pres.type == "subscribe"
+          accept_subscription_from(pres.from)          
+          subscribe_to(pres.from)
+        end
+      end
+    end
+
+    def accept_subscription_from(jid)
+      p = Presence.new
+      p.type = "subscribed"
+      p.to=jid.scrap_resource
+      self.send(p)
+    end
+    
+    def subscribe_to(jid)
+      p = Presence.new
+      p.type = "subscribe"
+      p.to = jid.scrap_resource
+      self.send(p)    
+    end
+    
+    def unsubscribe_from(jid)
+      iq = StropheRuby::Stanza.new
+      iq.name="iq"
+      iq.type="set"
+      
+      query = StropheRuby::Stanza.new
+      query.name="query"
+      query.ns="jabber:iq:roster"
+      
+      item = StropheRuby::Stanza.new
+      item.name="item"
+      item.set_attribute("jid",jid.scrap_resource)
+      item.set_attribute("subscription","remove")
+      
+      query.add_child(item)
+      iq.add_child(query)
+      send_stanza(iq)
+    end
+    
+    #Stop the event loop
+    def disconnect
+      StropheRuby::EventLoop.stop(@ctx)
+    end
+    
+    #Send a message or presence object to the stream
+    def send(obj)      
+      if obj.respond_to?(:stanza)        
+        send_stanza(obj.stanza)      
+      else
+        raise("Error: StropheRuby::Stanza object has not been set")
+      end
+    end
+    
+    #You have to call this after a successful connection to notify everyone that you are online.
+    #This is called the "initial presence" (see 5.1.1 at http://xmpp.org/rfcs/rfc3921.html)
+    def announce_presence
+      presence = StropheRuby::Stanza.new
+      presence.name="presence"
+      presence.set_attribute("show", "available")
+      send_stanza(presence)    
+    end
+    
+    #callback for message stanzas. The parameter sent in the code block is the received Message object.    
+    def on_message_received
+      @conn.add_handler("message") do |stanza|
+        yield(Message.new(stanza)) if Message.new(stanza).body
+      end
+    end
+    
+    #callback for presence stanzas. The parameter sent in the code block is the received Presence object.
+    def on_presence_received
+      @conn.add_handler("presence") do |stanza|
+        yield(Presence.new(stanza))
+      end
+    end
+
+    private        
+    #Internal method that send the actual StropheRuby::Stanza object to the stream
+    def send_stanza(stanza)
+      @conn.send(stanza)
+      @last_send=Time.now
+    end
+    
+    #Signals to the xmpp server that we are still connected every X seconds
+    #TODO: Investigate if it really helps keeping the connection alive
+    def keep_alive
+      Thread.new do
+        loop do
+          difference = (@last_send || Time.now) + 90 - Time.now
+          if difference <= 0
+            announce_presence
+            sleep(90)
+          else
+            sleep(difference)
+          end
+        end
+      end
+    end                
+  end
+end

data/lib/xmppbot/message.rb

@@ -0,0 +1,61 @@
+############################################################
+# XMPPBot::Presence
+# Simple wrapper for a StropheRuby::Stanza of type 'presence'
+# Author : Francois Lamontagne
+############################################################
+
+module XMPPBot
+  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
+end

data/lib/xmppbot/other.rb

@@ -0,0 +1,33 @@
+############################################################# 
+# Some other StropheRuby wrappers 
+# Author : Francois Lamontagne
+############################################################
+
+module XMPPBot
+  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
+end
+
+class String
+    def scrap_resource
+	self.match(/[^\/]*/i).to_s
+    end
+    
+    def resource
+	self.match(/\/.*/i).to_s.delete("/")
+    end
+    
+    def node
+	self.match(/[^\@]*/i).to_s
+    end
+end

data/lib/xmppbot/presence.rb

@@ -0,0 +1,52 @@
+############################################################
+# XMPPBot::Presence
+# Simple wrapper for a StropheRuby::Stanza of type 'presence'
+# Author : Francois Lamontagne
+############################################################
+
+module XMPPBot
+  class Presence
+    attr_reader :stanza  
+  
+    def initialize(stanza=nil)
+      if stanza
+        @stanza=stanza
+      else
+        @stanza = StropheRuby::Stanza.new
+        @stanza.name = "presence"
+      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 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
+      res = self.show
+      res ? res : self.type.to_s
+    end
+  end
+end

data/lib/xmppbot.rb

@@ -0,0 +1,11 @@
+$:.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'  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/xmppbot.rb'}"
+puts "Loading xmppbot gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/xmppbot'

data/test/test_xmppbot.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestXmppbot < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: xmppbot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Fran\xC3\xA7ois Lamontagne"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: strophe_ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: "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!"
+email: 
+- flamontagne@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- 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
+- test/test_helper.rb
+- test/test_xmppbot.rb
+has_rdoc: true
+homepage: 
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: xmppbot
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Simple implementation on top of StropheRuby(http://github.com/flamontagne/strophe_ruby/)
+test_files: 
+- test/test_helper.rb
+- test/test_xmppbot.rb