blather 0.2.1 → 0.2.2

data/LICENSE

@@ -1,3 +1,5 @@
+Blather
+
 Copyright (c) 2008 Jeff Smick
  
 Permission is hereby granted, free of charge, to any person obtaining

data/README.rdoc

@@ -14,8 +14,6 @@ GitHub:: https://github.com/sprsquish/blather
 
 RubyForge:: http://rubyforge.org/projects/squishtech/
 
-Lighthouse:: http://squishtech.lighthouseapp.com/projects/20652-blather
-
 == Author
 
 Jeff Smick <sprsquish@gmail.com>
@@ -32,47 +30,74 @@ See the /examples directory for more advanced examples.
 
 This will auto-accept any subscription requests and echo back any chat messages.
 
-  %w[rubygems blather].each { |r| require r }
+  require 'rubygems'
+  require 'blather/client'
 
   setup 'echo@jabber.local', 'echo'
 
   # Auto approve subscription requests
-  handle :subscription do |s|
-    write(s.approve!) if s.request?
+  subscription :request? do |s|
+    write s.approve!
   end
 
   # Echo back what was said
-  handle :message do |m|
-    write(m.reply) if m.chat? && m.body
+  message :chat?, :body do |m|
+    write m.reply
   end
-  
+
+== Handlers
+
+Setup handlers by calling their names as methods.
+
+  # Will only be called for messages where #chat? responds positively
+  # and #body == 'exit'
+  message :chat?, :body => 'exit'
+
+=== Handler Guards
+
+Guards act like AND statements. Each condition must be met if the handler is to be used.
+
+  # Equivalent to saying (stanza.chat? && stanza.body)
+  message :chat?, :body
+
+There are 5 different types of guards:
+
+  # Symbol
+  #   Checks for a non-false reply to calling the symbol on the stanza
+  #   Equivalent to stanza.chat?
+  message :chat?
+
+  # Hash with any value (:body => 'exit')
+  #   Calls the key on the stanza and checks for equality
+  #   Equivalent to stanza.body == 'exit'
+  message :body => 'exit'
+
+  # Hash with regular expression (:body => /exit/)
+  #   Calls the key on the stanza and checks for a match
+  #   Equivalent to stanza.body.match /exit/
+  message :body => /exit/
+
+  # Proc
+  #   Calls the proc passing in the stanza
+  #   Checks that the ID is modulo 3
+  message proc { |m| m.id % 3 == 0 }
+
+  # Array
+  #   Use arrays with the previous types effectively turns the guard into
+  #   an OR statement.
+  #   Equivalent to stanza.body == 'foo' || stanza.body == 'baz'
+  message [{:body => 'foo'}, {:body => 'baz'}]
+
 = TODO
 
 * Cleanup API
+* Add lambda callback ability to Iq stanzas
 * Better Documentation
 * Service Discovery (XEP-0030: http://xmpp.org/extensions/xep-0030.html)
 * PubSub (XEP-0060: http://xmpp.org/extensions/xep-0060.html)
-* ?? (suggestions)
+* More examples (Re-write XMPP4R examples into Blather)
 
 = License
 
-Copyright (c) 2008 Jeff Smick
- 
-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.
+Please see LICENSE
+The LibXML-Ruby license can be found in its directory

data/Rakefile

@@ -1,17 +1,98 @@
-require 'echoe'
-require 'hanna/rdoctask'
+require 'rubygems'
+require 'rake'
 
-Echoe.new('blather') do |p|
-  p.author = 'Jeff Smick'
-  p.email = 'sprsquish@gmail.com'
-  p.url = 'http://github.com/sprsquish/blather/tree/master'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'blather'
+    gem.description = gem.summary = 'An evented XMPP library written on EventMachine and libxml-ruby'
 
-  p.project = 'squishtech'
-  p.summary = 'An evented XMPP library written on EventMachine and libxml-ruby'
+    gem.email = 'sprsquish@gmail.com'
+    gem.homepage = 'http://github.com/sprsquish/blather'
+    gem.authors = ['Jeff Smick']
 
-  p.runtime_dependencies = ['eventmachine', 'libxml-ruby >=0.9.7']
-  p.rdoc_options += %w[-S -T hanna --main README.rdoc --exclude autotest]
+    gem.rubyforge_project = 'squishtech'
 
-  p.test_pattern = 'spec/**/*_spec.rb'
-  p.rcov_options = ['--exclude \/Library\/Ruby\/Gems,spec\/', '--xrefs']
-end
+    gem.extensions = %w[ext/extconf.rb]
+
+    gem.add_dependency 'eventmachine', '>= 0.12.6'
+    gem.add_dependency 'libxml-ruby', '>= 1.1.3'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'spec'
+    test.pattern = 'spec/**/*_spec.rb'
+    test.rcov_opts += ['--exclude \/Library\/Ruby\/Gems,spec\/', '--xrefs']
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+begin
+  require 'hanna/rdoctask'
+
+  Rake::RDocTask.new do |rdoc|
+    if File.exist?('VERSION.yml')
+      config = YAML.load(File.read('VERSION.yml'))
+      version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+    else
+      version = ""
+    end
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "blather #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.options += %w[-S -T hanna --main README.rdoc --exclude autotest --exclude vendor]
+  end
+rescue LoadError
+  task :rdoc do
+    abort "Hanna is not available. In order to use the Hanna, you must: sudo gem install mislav-hanna"
+  end
+end
+
+desc 'Build extensions'
+task :build => :extensions
+task :extension => :build
+
+ext = Config::CONFIG["DLEXT"]
+task :extensions => ["ext/push_parser.#{ext}"]
+file "ext/push_parser.#{ext}" =>
+  ["Makefile"] + FileList["ext/*.{c,h}"].to_a do |t|
+  Dir.chdir("ext") { sh "make" }
+end
+
+namespace :extensions do
+  desc 'Clean extensions'
+  task :clean do
+    Dir.chdir("ext") do
+      sh "rm -f Makefile"
+      sh "rm -f *.{o,so,bundle,log}"
+    end
+  end
+end
+
+file "Makefile" => %w[ext/extconf.rb] do
+  command = ["ruby"] + $:.map{|dir| "-I#{File.expand_path dir}"} + ["extconf.rb"]
+  Dir.chdir("ext") { sh(*command) }
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 2

data/examples/drb_client.rb

@@ -1,7 +1,5 @@
-%w[rubygems lib/blather drb/drb].each { |r| require r }
+%w[rubygems lib/blather/client drb/drb].each { |r| require r }
 
 setup 'drb_client@jabber.local', 'drb_client'
 
-handle :ready do
-  DRb.start_service 'druby://localhost:99843', self
-end
+when_ready { DRb.start_service 'druby://localhost:99843', self }

data/examples/echo.rb

@@ -1,13 +1,18 @@
-%w[rubygems lib/blather].each { |r| require r }
+#!/usr/bin/env ruby
 
-setup 'echo@jabber.local', 'echo'
+require 'blather/client'
 
-# Auto approve subscription requests
-handle :subscription do |s|
-  write(s.approve!) if s.request?
+when_ready { puts "Connected ! send messages to #{jid.stripped}." }
+
+subscription :request? do |s|
+  write s.approve!
+end
+
+message :chat?, :body => 'exit' do |m|
+  say m.from, 'Exiting ...'
+  shutdown
 end
 
-# Echo back what was said
-handle :message do |m|
-  write(m.reply) if m.chat? && m.body
+message :chat?, :body do |m|
+  say m.from, "You sent: #{m.body}"
 end

data/examples/pubsub/cli.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'blather/client'
+
+#ls
+#cd
+#cat
+#Blather::LOG.level = Logger::DEBUG
+module CliHandler
+  include EM::Protocols::LineText2
+
+  def ls(node)
+    pubsub.node(parse_dir(node)) do |result|
+      cur = node.split('/')
+      puts
+      puts result.items.map { |i| (i.node.split('/') - cur).join('/') }.join("\n")
+      start_line
+    end
+  end
+
+  def cd(node)
+    @node = parse_dir(node)
+    start_line
+  end
+
+  def cat(item)
+  end
+
+  def connect(who)
+    @who = who
+    puts "connected to '#{who}'"
+  end
+
+  def exit(_)
+    EM.stop
+  end
+
+  def initialize
+    $stdout.sync = true
+    @node = ''
+    @who = ''
+    start_line
+  end
+
+  def start_line
+    puts "\n/#{@node}> "
+  end
+
+  def receive_line(line)
+    return unless line =~ /(connect|exit|ls|cd|cat)\s?(.*)/i
+    __send__ $1, $2
+  end
+
+  def parse_dir(list)
+    return '' if list == '/'
+    cur = @node.split('/')
+    list.split('/').each { |dir| dir == '..' ? cur.pop : (cur << dir) }
+    cur * '/'
+  end
+end
+
+setup 'echo@jabber.local', 'echo'
+pubsub_host 'pubsub.jabber.local'
+when_ready { EM.open_keyboard CliHandler }

data/examples/pubsub/ping_pong.rb

@@ -0,0 +1,18 @@
+setup 'ping-pong@jabber.local', 'ping-pong'
+
+pubsub.host = 'pubsub.jabber.local'
+
+pubsub_event :node => 'ping' do |node|
+  pubsub.publish 'pong', node.payload
+end
+
+pubsub_event :node => 'pong' do |node|
+  x = node.payload.to_i
+  if x > 0
+    pubsub.publish 'ping', (x - 1)
+  else
+    shutdown
+  end
+end
+
+when_ready { pubsub.publish 'ping', 3 }

data/examples/pubsub/pubsub_dsl.rb

@@ -0,0 +1,52 @@
+# Get affiliations
+pubsub.affiliations do |aff|
+  aff == {
+    :member     => [],
+    :none       => [],
+    :outcast    => [],
+    :owner      => [],
+    :publisher  => []
+  }
+end
+
+# Get subscriptions
+pubsub.subscriptions do |sub|
+  sub == {
+    :none         => [],
+    :pending      => [],
+    :subscribed   => [],
+    :unconfigured => []
+  }
+end
+
+# Get nodes
+pubsub.nodes(path = nil) do |nodes|
+  nodes == [
+    DiscoItems::Item
+      .jid
+      .node
+      .name
+  ]
+end
+
+# Get node
+pubsub.node(path = nil) do |node|
+  node = Node
+    .attributes = {
+      [form data fields]
+    }
+    .type = '(leaf|collection)'
+    .feature = ''
+    .items(ids = [], :max => nil) { |list_of_items| }
+end
+
+# Get node items
+pubsub.items(path = '' | ids = [], max = nil) do |node_items|
+  node_items = [
+    Item
+      .jid
+      .id
+      .name
+      .payload
+  ]
+end

data/examples/pubsub_client.rb

@@ -0,0 +1,39 @@
+# For subscribers
+  pubsub.nodes [path]
+  pubsub.node('path')
+  pubsub.node('path').subscribe
+  pubsub.node('path').affiliation
+# For owners
+  pubsub.node('path').affiliations
+  pubsub.node('path').delete!
+  pubsub.node('path').purge!
+  pubsub.node('path').options
+  pubsub.node('path').defaults
+  pubsub.node('path').configure {}
+
+pubsub.affiliations
+
+pubsub.create 'node'
+
+pubsub.publish 'node', 'content'
+pubsub.delete 'node', 'item_id'
+
+pubsub.subscriptions
+pubsub.subscribe 'node'
+pubsub.unsubscribe 'node'
+
+# For subscribers
+  pubsub.subscriptions 'node'
+  pubsub.subscription 'node', [sub_id]
+  pubsub.subscription('node', [sub_id]).unsubscribe!
+  pubsub.subscription('node', [sub_id]).options
+  pubsub.subscription('node', [sub_id]).configure 'node', {}
+# For owners
+  pubsub.subscriptions.pending
+  pubsub.subscription('sub_id').delete!
+  
+
+Node::Collection
+  nodes
+Node::Leaf
+  items