xmppbot 0.0.1 → 0.0.2

data/Manifest.txt

@@ -3,6 +3,8 @@ Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
+Rakefile.save
+Rakefile.save.1
 lib/xmppbot.rb
 lib/xmppbot/bot.rb
 lib/xmppbot/message.rb

data/README.rdoc

@@ -2,73 +2,78 @@
 
 == 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 :
+This is a simple implementation on top of StropheRuby 'http://github.com/flamontagne/strophe_ruby/'.
+It's for those who want to build 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!
+Warning : StropheRuby is quite 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)
-
+- Only tested under Debian so far
+- Does not work under windows
+- No TLS support for now. It will work once TLS with OpenSSL is working in Strophe 'http://code.stanziq.com/strophe'
+- Exiting the program can cause segmentation errors (not really problematic)
 
 == SYNOPSIS:
 
-How to use it :
-  
 require 'xmppbot'
-def register_callbacks
-  @bot.on_presence_received do |pres|
-    puts "#{pres.from} is now #{pres.to_s}"
+
+class Johnny5 < XMPPBot::Bot  
+  def connect
+    super do |status|
+      if status == XMPPBot::ConnectionEvents::CONNECT
+        announce_presence
+        register_callbacks
+      else
+        disconnect
+      end
+    end  
   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)
+  
+  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=XMPPBot::Bot.new
-@bot.jid="bot@example.com"
-@bot.password="secret"
-@bot.log_level = XMPPBot::Logging::DEBUG
+@bot = Johnny5.new
+@bot.jid = "cripes@jaim.at"
+@bot.password = "cripes"
+@bot.log_level = XMPPBot::Logging::INFO
 @bot.auto_accept_subscriptions = true
 
-@bot.connect do |status|
-  if status == XMPPBot::ConnectionEvents::CONNECT
-    @bot.announce_presence
-    register_callbacks
-  else
-    @bot.disconnect
-  end
-end  
+@bot.connect
 
-== REQUIREMENTS:
+#We pause the execution of the current thread to prevent the program from exiting
+Thread.stop
 
-* Compile and install StropheRuby (http://github.com/flamontagne/stropheruby)
+#Once the parsing thread exits, execution resumes here
+puts "Connection terminated"
 
 == INSTALL:
 
-* For now you can install the GEM in the pkg directory. Remember that you need StropheRuby to use XMPPBot ()
+gem install xmppbot (it will install stropheruby as well)
 
 == LICENSE:
 
-(The MIT License)
-
-Copyright (c) 2008 FIXME full name
+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
@@ -87,4 +92,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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -3,10 +3,10 @@
 
 # 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|
+$hoe = Hoe.new('xmppbot', '0.0.2') 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.post_install_message = File.open(File.dirname(__FILE__) + "/PostInstall.txt").read
   p.rubyforge_name       = p.name # TODO this is default value
    p.extra_deps         = [
      ['strophe_ruby','>= 0.0.1'],

data/Rakefile.save

@@ -0,0 +1,29 @@
+%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/Rakefile.save.1

@@ -0,0 +1,29 @@
+%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 = 
+# 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

@@ -103,7 +103,6 @@ module XMPPBot
     def announce_presence
       presence = StropheRuby::Stanza.new
       presence.name="presence"
-      presence.set_attribute("show", "available")
       send_stanza(presence)    
     end
     

data/lib/xmppbot/message.rb

@@ -39,7 +39,11 @@ module XMPPBot
   
     def body=(str)
       children = self.stanza.children
-  
+      
+      #Strangely enough, sending a "<" character to our stream will terminate it.
+      #I guess expat (the xml parser) should take care of encoding the
+      #special characters to ensure that the xml remains valid... but it doesn't do it.
+      str.gsub!(/[<>]/) {|s| s == "<" ? '&lt;' : '&gt;'}
       if children      
         children.children.text = str
       else  

data/lib/xmppbot/presence.rb

@@ -46,7 +46,7 @@ module XMPPBot
     #subscribe,subscribed,unsubscribe,unsubscribed,probe or error.
     def to_s
       res = self.show
-      res ? res : self.type.to_s
+      res ? res : self.type ? self.type : "available"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xmppbot
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Lamontagne"
@@ -42,7 +42,7 @@ dependencies:
       - !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!"
+description: "This is a simple implementation on top of StropheRuby 'http://github.com/flamontagne/strophe_ruby/'. It's for those who want to build 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 quite experimental at the moment. It is definitely NOT ready for production!"
 email: 
 - flamontagne@gmail.com
 executables: []
@@ -60,6 +60,8 @@ files:
 - PostInstall.txt
 - README.rdoc
 - Rakefile
+- Rakefile.save
+- Rakefile.save.1
 - lib/xmppbot.rb
 - lib/xmppbot/bot.rb
 - lib/xmppbot/message.rb
@@ -72,7 +74,7 @@ files:
 - test/test_xmppbot.rb
 has_rdoc: true
 homepage: 
-post_install_message: PostInstall.txt
+post_install_message: 
 rdoc_options: 
 - --main
 - README.rdoc
@@ -96,7 +98,7 @@ 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/)
+summary: This is a simple implementation on top of StropheRuby 'http://github.com/flamontagne/strophe_ruby/'
 test_files: 
 - test/test_helper.rb
 - test/test_xmppbot.rb