c3s 0.3.2 → 0.3.3

data/Manifest

@@ -13,21 +13,4 @@ lib/pubsub/node.rb
 lib/pubsub/nodetracker.rb
 lib/pubsub/publisher.rb
 lib/pubsub/subscriber.rb
-pkg/c3s-0.3.2.gem
-pkg/c3s-0.3.2.tar.gz
-pkg/c3s-0.3.2/Manifest
-pkg/c3s-0.3.2/README.rdoc
-pkg/c3s-0.3.2/Rakefile
-pkg/c3s-0.3.2/c3s
-pkg/c3s-0.3.2/c3s.gemspec
-pkg/c3s-0.3.2/lib/c3s.rb
-pkg/c3s-0.3.2/lib/c3s_logger.rb
-pkg/c3s-0.3.2/lib/component.rb
-pkg/c3s-0.3.2/lib/component_connection.rb
-pkg/c3s-0.3.2/lib/configreader.rb
-pkg/c3s-0.3.2/lib/databaseadapter.rb
-pkg/c3s-0.3.2/lib/model.rb
-pkg/c3s-0.3.2/lib/pubsub/node.rb
-pkg/c3s-0.3.2/lib/pubsub/nodetracker.rb
-pkg/c3s-0.3.2/lib/pubsub/publisher.rb
-pkg/c3s-0.3.2/lib/pubsub/subscriber.rb
+lib/republisher.rb

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('c3s', '0.3.2') do |p|
+Echoe.new('c3s', '0.3.3') do |p|
   p.description    = "C3s library gem."
   p.url            = "http://github.com/rikas/c3s"
   p.author         = "Ricardo Otero"

data/c3s.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{c3s}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ricardo Otero"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-03-03}
   s.description = %q{C3s library gem.}
   s.email = %q{oterosantos@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/c3s.rb", "lib/c3s_logger.rb", "lib/component.rb", "lib/component_connection.rb", "lib/configreader.rb", "lib/databaseadapter.rb", "lib/model.rb", "lib/pubsub/node.rb", "lib/pubsub/nodetracker.rb", "lib/pubsub/publisher.rb", "lib/pubsub/subscriber.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "c3s", "lib/c3s.rb", "lib/c3s_logger.rb", "lib/component.rb", "lib/component_connection.rb", "lib/configreader.rb", "lib/databaseadapter.rb", "lib/model.rb", "lib/pubsub/node.rb", "lib/pubsub/nodetracker.rb", "lib/pubsub/publisher.rb", "lib/pubsub/subscriber.rb", "c3s.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/c3s.rb", "lib/c3s_logger.rb", "lib/component.rb", "lib/component_connection.rb", "lib/configreader.rb", "lib/databaseadapter.rb", "lib/model.rb", "lib/pubsub/node.rb", "lib/pubsub/nodetracker.rb", "lib/pubsub/publisher.rb", "lib/pubsub/subscriber.rb", "lib/republisher.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "c3s", "lib/c3s.rb", "lib/c3s_logger.rb", "lib/component.rb", "lib/component_connection.rb", "lib/configreader.rb", "lib/databaseadapter.rb", "lib/model.rb", "lib/pubsub/node.rb", "lib/pubsub/nodetracker.rb", "lib/pubsub/publisher.rb", "lib/pubsub/subscriber.rb", "lib/republisher.rb", "c3s.gemspec"]
   s.homepage = %q{http://github.com/rikas/c3s}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "C3s", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{c3s}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{C3s library gem.}
 
   if s.respond_to? :specification_version then

data/lib/c3s.rb

@@ -18,8 +18,16 @@ require 'configreader'
 require 'databaseadapter'
 require 'c3s_logger'
 
+begin
+  require 'xmpp4r'
+rescue Exception => e
+  puts "Fatal Error: #{e}"
+  puts "Please install xmpp4r gem with 'sudo gem install xmpp4r'"
+  exit
+end
+
 module C3s
-  VERSION = "0.2.9"
+  VERSION = "0.3.3"
   
   def self.included(base)
     base.extend ClassMethods

data/lib/component.rb

@@ -1,15 +1,7 @@
 require 'thread'
-begin
-  require 'xmpp4r'
-rescue Exception => e
-  puts "Fatal Error: #{e}"
-  puts "Please install xmpp4r gem with 'sudo gem install xmpp4r'"
-  exit
-end
 require 'xmpp4r/discovery'
 require 'xmpp4r/pubsub/helper/nodebrowser'
 require 'pubsub/publisher'
-require 'pubsub/subscriber'
 require 'pubsub/node'
 
 module C3s
@@ -55,7 +47,7 @@ module C3s
     # to use.
     def start
       super
-
+      
       Thread.abort_on_exception = true
 
       add_iq_callback do |iq|
@@ -130,18 +122,23 @@ module C3s
       end
 
       changed = true
-      @object = self.model.find_by_jid(data[:jid]) || self.model.new
+      object = self.model.find_by_jid(data[:jid]) || self.model.new
 
       $LOG.info "Saving #{config['name']} context for #{data[:jid]} #{data.inspect}"
-      @object.update_attributes(data)
-      changed = @object.changed?
-      @object.save!
-
-      publish(iq, stanza, changed) if @object.errors.count == 0
+      object.update_attributes(data)
+      changed = object.changed?
+      object.save!
+      
+      if object.errors.count == 0
+        $LOG.info "Publishing data to node #{config['name']}:#{iq.from.to_s}"
+        c3snode = C3s::Node.new("#{config['name']}:#{iq.from.to_s}")
+        publish(c3snode, stanza, changed)
+        send_ok(iq)
+      end
 
     rescue Exception => e
       $LOG.error("#{e.inspect} #{e.backtrace.join("\n")}")
-      send_error(iq, ['bad-request', @object.errors.full_messages.first])
+      send_error(iq, ['bad-request', object.errors.full_messages.first])
     end
     
     ##
@@ -181,33 +178,17 @@ module C3s
     
     ##
     # Publishes information to pubsub server
-    # iq:: the setter iq
-    # data:: what to publish
-    # changed:: the data is different from last set operation?
-    def publish(iq, data, changed)
-      jid = (iq.is_a?(Jabber::Iq)) ? iq.from.to_s : iq
+    # c3snode:: [C3s::Node] the pubsub node
+    # data:: [String] what to publish
+    # changed:: [Boolean] the data is different from last set operation?
+    def publish(c3snode, data, changed)
       if changed
         pub = Publisher.new(self, config['pubsub'])
-        pub.create_nodes("#{config['name']}:#{jid}")
-        pub.publish(jid, data)
+        pub.create_tree(c3snode)
+        pub.publish(c3snode, data)
       end
       
-      send_ok(iq) if iq.is_a?(Jabber::Iq)
-    end
-    
-    def get_subscriptions
-      @pubsub = Jabber::PubSub::ServiceHelper.new(self, config['pubsub'])
-      subs = @pubsub.get_subscriptions_from_all_nodes
-      puts "SUBSCRIPTIONS: #{subs.inspect}"
-      subs
-    end
-
-    def unsubscribe_all
-      subscriptions = get_subscriptions
-      return if !@pubsub
-      subscriptions.each do |sub|
-        @pubsub.unsubscribe_from(sub.node, sub.subid)
-      end
+      #send_ok(iq) if iq.is_a?(Jabber::Iq)
     end
     
     ##

data/lib/component_connection.rb

@@ -2,8 +2,8 @@ module C3s
   class ComponentConnection    
     def initialize(componentclass, options={})
       @no_db = options[:no_db]
-      if !componentclass.superclass.eql?(C3s::Component)
-        puts "ERROR: #{componentclass} is not a valid C3s::Component!"
+      if !componentclass.superclass.eql?(C3s::Component) and !componentclass.superclass.eql?(C3s::Republisher)
+        puts "ERROR: #{componentclass} is not a valid C3s::Component (seems to be a #{componentclass.superclass})"
         exit
       end
       
@@ -16,7 +16,7 @@ module C3s
       @client_config.merge!('jid' => @client_config['name']+"."+@server_config['url'])
       @db_config = reader.section('db') if !@no_db
       
-      puts "Creating new location component with jid '#{@client_config['jid']}'..."
+      puts "Creating new component with jid '#{@client_config['jid']}'..."
       @component = componentclass.new(@server_config.merge(@client_config))
     end
     
@@ -49,17 +49,17 @@ module C3s
         exit
       rescue Exception => e
         puts "ERROR: Couldn't connect to server!"
+        puts "#{e.inspect} #{e.backtrace.join("\n")}"
         $LOG.error "Couldn't connect to server!"
         exit
       end
       puts "External component #{@client_config['jid']} connected successfully."
       
-      # TODO - never used?!
+      # TODO - use this to do something useful?
       @component.on_exception do |e, component, where|
-        $LOG.error "**************FATAL ERROR"
-        $LOG.error e.message
+        $LOG.error "************** FATAL ERROR"
         $LOG.error e.backtrace.join("\n")
-        exit
+        #exit
       end
       
       puts "Starting messaging loop..."

data/lib/model.rb

@@ -46,13 +46,11 @@ module C3sModel
   ##
   # Returns the first element for the model xml
   def first_element(options={})
-    if options[:parent]
-      first = options[:parent]
-    else
-      name = self._class_name
-      name = name.pluralize if options[:plural]
-      first = REXML::Element.new(name)
-    end
+    return options[:parent] if options[:parent]
+    
+    name = self._class_name
+    name = name.pluralize if options[:plural]
+    REXML::Element.new(name)
   end
   
   ##

data/lib/pubsub/node.rb

@@ -13,11 +13,11 @@ module C3s
       @provider = provider
       
       if @jid.nil? and @provider
-        @provider, @node, @domain, @resource = @provider.to_s.scan(PATTERN).first
-        @jid = Jabber::JID.new(@node, @domain, @resource)
+        @provider, node, domain, resource = @provider.to_s.scan(PATTERN).first
+        @jid = Jabber::JID.new(node, domain, resource)
       end
       
-      @provider.downcase! if @provider
+      @jid.resource = "default" if !resource and @jid
     end
     
     ##
@@ -38,6 +38,12 @@ module C3s
       @jid.resource
     end
     
+    ##
+    # Sets the resource for the node jid
+    def resource=(res)
+      @jid.resource = res.to_s
+    end
+    
     ##
     # Checks if a node is a leaf node on c3s pubsub
     def leaf?

data/lib/pubsub/nodetracker.rb

@@ -6,18 +6,25 @@ module C3s
     
     ##
     # Adds a node to the existing nodes
-    # node::[String] the node name
+    # node:: [String] the node name
     def self.add_node(node)
       @@existing_nodes << node
     end
     
     ##
     # Checks if a node already exists on node list
-    # node::[String] the node name
+    # node:: [String] the node name
     def self.include?(node)
       @@existing_nodes.include?(node)
     end
     
+    ##
+    # Removes a node from the node list
+    # node:: [String] the node name
+    def self.remove_node(node)
+      @@existing_nodes.delete(node)
+    end
+    
     ##
     # Returns the existing nodes
     def self.nodes

data/lib/pubsub/publisher.rb

@@ -1,5 +1,6 @@
 require 'xmpp4r/pubsub'
 require 'pubsub/nodetracker'
+require 'pubsub/node'
 
 module C3s
   class Publisher 
@@ -15,23 +16,16 @@ module C3s
     
     ##
     # Creates the collection node(s) and leaf node if needed
-    # nodetree:: [String] node tree (eg: location:user@jabber.com/resource)
-    def create_nodes(nodetree)
-      nodes = nodetree.split(":")
-      
-      # build array like this one:
-      # ['location', 'user@jabber.com', 'user@jabber.com/resource']
-      nodes.insert(1, nodes.last.split("/").first)
-      
-      collection = nodes.shift # collection (eg: location)
-      subcollection = "#{collection}:#{nodes.shift}" # subcollection (eg: location:user@jabber.com)
-      leaf = "#{collection}:#{nodes.shift}" # leaf node name (eg: location:user@jabber.com/resource)
-      leaf << "/default" unless leaf.match(/.*\/.*/)
+    # c3snode:: [C3s::Node] c3s pubsub node (eg: location:user@jabber.com/resource)
+    def create_tree(c3snode)
+      provider = c3snode.provider # provider (eg: location)
+      collection = "#{provider}:#{c3snode.jid.bare.to_s}" # collection (eg: location:user@jabber.com)
+      leaf = c3snode.to_s # leaf (eg: location:user@jabber.com/default)
       
       # create nodes
-      create_node(collection, {:collection => true})
-      create_node(subcollection, {:father => collection, :collection => true})
-      create_node(leaf, {:father => subcollection, :collection => false})
+      create_node(provider, {:collection => true})
+      create_node(collection, {:father => provider, :collection => true})
+      create_node(leaf, {:father => collection, :collection => false})
     end
     
     ##
@@ -58,6 +52,14 @@ module C3s
       grant_owner_to_admin(node)
     end
     
+    ##
+    # Deletes a pubsub node
+    # nodename:: [String] the node name
+    # TODO: i should delete all leaf nodes inside a collection node!
+    def delete_node(nodename)
+      @pubsub.delete_node(nodename)
+    end
+    
     ##
     # Creates the collection node if needed
     # name:: [String] collection node name
@@ -90,13 +92,10 @@ module C3s
     # Publishes content to the leaf node
     # node:: [String] the node to plublish to
     # content:: [REXML::Element] content xml to publish into node
-    def publish(node, content)
+    def publish(c3snode, content)
       item = Jabber::PubSub::Item.new
       item.add(content)
-      
-      node << "/default" unless node.match(/.*\/.*/)
-      node = [@client.config['name'], node].join(":")
-      @pubsub.publish_item_to(node, item)
+      @pubsub.publish_item_to(c3snode.to_s, item)
     end
 
     ##
@@ -107,8 +106,6 @@ module C3s
       return true if NodeTracker.include?(name)
       nodebrowser = Jabber::PubSub::NodeBrowser.new(@client)
       nodebrowser.get_info(@service, name)
-      # TODO this could be used instead
-      # nodebrowser.nodes(@client.jid).include?(name)
       NodeTracker.add_node(name)
       true
     rescue Jabber::ServerError => error

data/lib/pubsub/subscriber.rb

@@ -17,12 +17,12 @@ module C3s
     ##
     # Subscribes to collection node.
     # nodename:: [String] the node name
-    def subscribe_collection(nodename)
+    def subscribe_collection(nodename, options={})
       return if !is_collection?(nodename)
       subscription = @pubsub.subscribe_to(nodename)
       options = {
-        'pubsub#subscription_type' => 'items',
-        'pubsub#subscription_depth' => 'all'
+        'pubsub#subscription_type' => options[:subscription_type] || 'items',
+        'pubsub#subscription_depth' => options[:subscription_depth] || 'all'
       }
       @pubsub.set_options_for(nodename, @client.jid, options, subscription.subid)
     end
@@ -30,8 +30,9 @@ module C3s
     ##
     # Unsubscribe node
     # nodename:: [String] the node name
-    def unsubscribe_from(nodename)
-      @pubsub.unsubscribe_from(nodename)
+    # subid:: [String] the subscription ID
+    def unsubscribe_from(nodename, subid)
+      @pubsub.unsubscribe_from(nodename, subid)
     end
     
     ##
@@ -48,5 +49,35 @@ module C3s
     def get_last_item(nodename)
       @pubsub.get_items_from(nodename, 1)
     end
+    
+    ##
+    # Returns all the subscriptions
+    def get_subscriptions
+      @pubsub.get_subscriptions_from_all_nodes
+    end
+    
+    ##
+    # Unsubscribes all subscribed nodes
+    def unsubscribe_all
+      get_subscriptions().each do |sub|
+        unsubscribe_from(sub.node, sub.subid)
+      end
+    end
+    
+    ##
+    # TODO - THIS NEEDED A @disco OBJECT.. AND I DON'T REMEMBER
+    # THE CLASS OF THE OBJECT
+    # Gets the leaf nodes for a given provider node. If the provider
+    # node is 'location' then the leaf nodes will be in the form
+    # 'location:person@domain.com/resource'
+    def get_leaf_nodes(firstnode, jid)
+      return if firstnode.nil? or @disco.nil?
+      firstnode.items.each do |item|
+        node = @disco.get_items_for(config['pubsub'], item.node)
+        c3snode = C3s::Node.new(item.node)
+        @items << item if c3snode.leaf? and jid==c3snode.jid
+        get_leaf_nodes(node, jid) unless node.items.size<1 or item.node.nil?
+      end
+    end
   end
 end

data/lib/republisher.rb

@@ -0,0 +1,83 @@
+require 'component'
+require 'pubsub/subscriber'
+
+module C3s
+  class Republisher < C3s::Component
+    ##
+    # Starts the component and sets the subscribing nodes.
+    # subscribing_nodes:: [String or Array] the subscribing node(s)
+    def start(subscribing_nodes)
+      @subscribing_nodes = subscribing_nodes.to_a
+      @subscriber = C3s::Subscriber.new(self, config['pubsub'])
+      super()
+    end
+    
+    ##
+    # Block the set iqs because this provider doesn't receive iq's
+    # directly to set the information.
+    def handle_iq(iq)
+      if iq.type == :set
+        puts "WARNING: IQ of type 'set' received from #{iq.from}!"
+        $LOG.warn("IQ of type 'set' received from #{iq.from}")
+        send_error(iq, ['unexpected-request', nil])
+        return
+      end
+      super
+    end
+    
+    ##
+    # Handles messages. This can be subscribe or unsubscribe messages
+    # and pubsub events (most likely).
+    def handle_msg(msg)
+      puts "----------------- MESSAGE -------------------"
+      puts "#{msg.inspect}"
+      puts "----------------- MESSAGE -------------------"
+      if msg.body.eql?("sub")
+        @subscribing_nodes.each { |node| @subscriber.subscribe_collection(node) }
+      elsif msg.body.eql?("unsub")
+        @subscriber.unsubscribe_all
+      else
+        event = msg.first_element("event")
+        if event.kind_of?(Jabber::PubSub::Event)
+          event.each_element("//item/") do |item|
+            $LOG.debug("Received item from pubsub")
+            begin
+              c3snode = C3s::Node.new(item.attributes['node'])
+              next unless c3snode
+              $LOG.debug("Node built: #{c3snode.to_s}")
+              c3snode.provider = config['name'] # TODO - assuming that provider_name.eql?(pubsub_root_node)
+              $LOG.debug("Call republish() from child")
+              
+              
+              Thread.abort_on_exception = true
+              t = Thread.new do
+                republish(c3snode, item)
+              end
+              t.join
+            rescue Exception => e
+              $LOG.error "Error on published item: #{e}"
+            end
+          end
+        end
+      end
+    rescue Exception => e
+      $LOG.error "Error on handle_msg(): #{e.inspect} #{e.backtrace.join("\n")}"
+    end
+    
+    ##
+    # Builds an object information based on pubsub item content. Each
+    # field of the published item is maped to an object attribute.
+    # klass:: [Class] the object class
+    # item:: [REXML::Element] the published item
+    def build_object(klass, item)
+      return nil if item.nil?
+      @object = klass.new
+      klass.attributes.each do |att|
+        @object.send("#{att}=", item.first_element(att).text)
+      end
+      @object
+    rescue Exception => e
+      $LOG.error "Error on build_object(): #{e.inspect} #{e.backtrace.join("\n")}"
+    end
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: c3s
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Ricardo Otero
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 +00:00
+date: 2010-03-03 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +37,7 @@ extra_rdoc_files:
 - lib/pubsub/nodetracker.rb
 - lib/pubsub/publisher.rb
 - lib/pubsub/subscriber.rb
+- lib/republisher.rb
 files: 
 - Manifest
 - README.rdoc
@@ -48,6 +54,7 @@ files:
 - lib/pubsub/nodetracker.rb
 - lib/pubsub/publisher.rb
 - lib/pubsub/subscriber.rb
+- lib/republisher.rb
 - c3s.gemspec
 has_rdoc: true
 homepage: http://github.com/rikas/c3s
@@ -67,18 +74,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: c3s
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: C3s library gem.