c3s 0.2.0

data/Manifest

@@ -0,0 +1,12 @@
+Manifest
+README.rdoc
+Rakefile
+c3s.gemspec
+lib/c3s.rb
+lib/c3s_logger.rb
+lib/component.rb
+lib/component_connection.rb
+lib/configreader.rb
+lib/databaseadapter.rb
+lib/nodetracker.rb
+lib/publisher.rb

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('c3s', '0.2.0') do |p|
+  p.description    = "C3s library gem."
+  p.url            = "http://github.com/rikas/c3s"
+  p.author         = "Ricardo Otero"
+  p.email          = "oterosantos@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/c3s.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{c3s}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ricardo Otero"]
+  s.date = %q{2009-11-30}
+  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/nodetracker.rb", "lib/publisher.rb"]
+  s.files = ["README.rdoc", "Rakefile", "c3s.gemspec", "lib/c3s.rb", "lib/c3s_logger.rb", "lib/component.rb", "lib/component_connection.rb", "lib/configreader.rb", "lib/databaseadapter.rb", "lib/nodetracker.rb", "lib/publisher.rb", "Manifest"]
+  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.summary = %q{C3s library gem.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/c3s.rb

@@ -0,0 +1,17 @@
+require 'component_connection'
+require 'component'
+require 'configreader'
+require 'databaseadapter'
+require 'c3s_logger'
+
+module C3s  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  def ensure_unique(name)
+    begin
+      self[name] = yield
+    end while self.class.exists?(name => self[name])
+  end
+end

data/lib/c3s_logger.rb

@@ -0,0 +1,23 @@
+require 'logger'
+require 'time'
+
+module C3s
+  class C3sLogger
+    attr_accessor :logger    
+    
+    def initialize(log_file)
+      logger = Logger.new(log_file, "weekly")
+      logger.formatter = C3sLogFormatter.new
+      self.logger = logger
+    end
+  end
+end
+
+##
+# Formats log messages
+class C3sLogFormatter < Logger::Formatter
+  def call(severity, time, program_name, message)
+    datetime = time.strftime("%Y-%m-%d %H:%M")
+    "\n#{severity[0..2]} [#{datetime}] #{String(message)}"
+  end
+end

data/lib/component.rb

@@ -0,0 +1,80 @@
+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 'publisher'
+
+module C3s
+  class Component < Jabber::Component
+    ##
+    # Component configuration hash
+    attr_accessor :config
+    
+    ##
+    # Initializes the jabber component
+    #
+    # config:: [Hash] configuration hash
+    def initialize(config)
+      super(config['jid'])
+      self.config = config
+      Jabber::debug = config['debug'].to_s.eql?"true"
+    end
+    
+    ##
+    # Connects component to jabber server
+    #
+    # Throws ClientAuthenticationFailure
+    def connect
+      super(config['url'], config['port'])
+      if is_connected?
+        auth(config['password'])
+      else
+        raise Exception, "Can't connect"
+      end
+    end
+    
+    ##
+    # Starts listening for packets and waits for activity. Also
+    # provides a callback named handle_iq for especific components
+    # to use.
+    def start
+      super()
+
+      Thread.abort_on_exception = true
+
+      add_iq_callback do |iq|
+        t = Thread.new do
+          handle_iq(iq)
+        end
+        t.join
+      end
+    end
+    
+    ##
+    # Sends an error response to a received IQ packet.
+    # iq:: [Jabber::IQ] the received IQ packet
+    # error:: [Array] an array with error type and error message. The error types should be valid.
+    #
+    # Look at XEP-0086 for explanation:
+    # http://www.xmpp.org/extensions/xep-0086.html
+    def send_error(iq, err)
+      reply = iq.answer
+      reply.type = :error
+      error = Jabber::ErrorResponse.new(err.first, err.last)
+      reply.add error
+
+      send(reply) if iq.type != :error
+    end
+  end
+  
+  Signal.trap('INT') do
+    puts "Got termination signal"
+    exit!
+  end
+end

data/lib/component_connection.rb

@@ -0,0 +1,72 @@
+module C3s
+  class ComponentConnection
+    ##
+    # The configuration file
+    CONFIG_FILE = "component.yml"
+    
+    def initialize(componentclass)
+      if !componentclass.superclass.eql?(C3s::Component)
+        puts "ERROR: #{componentclass} is not a valid C3s::Component!"
+        exit
+      end
+      
+      reader = C3s::ConfigReader.new(CONFIG_FILE)
+      puts "Reading configurations from '#{CONFIG_FILE}'..."
+      @server_config = reader.section('server')
+      @client_config = reader.section('client')
+      
+      # a jid parameter is usefull, so lets merge it on client configuration
+      @client_config.merge!('jid' => @client_config['name']+"."+@server_config['url'])
+      @db_config = reader.section('db')
+      
+      puts "Creating new location component with jid '#{@client_config['jid']}'..."
+      @component = componentclass.new(@server_config.merge(@client_config))
+    end
+    
+    def start
+      puts "Connecting to database '#{@db_config['database']}'"
+      begin
+        # activerecord connection
+        DatabaseAdapter.new(@db_config)
+        # raises exception if not connected
+        ActiveRecord::Base.retrieve_connection
+      rescue Exception => e
+        puts "Error: #{e}"
+        exit
+      end
+      connect()
+    end
+    
+    def connect
+      puts "Connecting to #{@server_config['url']} (port #{@server_config['port']})..."
+      
+      begin
+        @component.connect
+      rescue Jabber::ComponentAuthenticationFailure => e
+        puts "Could not authenticate on #{@server_config['url']}: #{e}"
+        exit
+      rescue Errno::ECONNREFUSED => e
+        puts "Connection refused on #{@server_config['url']} (port #{@server_config['port']})"
+        exit
+      rescue Exception => e
+        puts "Error do fim do mundo!"
+        puts e.message
+        exit
+      end
+      puts "External component #{@client_config['jid']} connected successfully."
+      
+      @component.on_exception do |e, component, where|
+        $LOG.error "FATAL ERROR"
+        $LOG.error e.message
+        $LOG.error e.backtrace.join("\n")
+      end
+      
+      puts "Starting messaging loop..."
+      @component.start()
+    end
+    
+    def self.stop
+      puts "Stop aqui!!"
+    end
+  end
+end

data/lib/configreader.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+
+module C3s
+  ##
+  # The configuration sections on a standard component yml file
+  SECTIONS = ['client', 'server', 'db']
+  
+  class ConfigReader
+    ##
+    # Reads the configuration file
+    # file::[String] the configuration file
+    def initialize(file)
+      @config = YAML::load_file(File.join(file))
+      check_config
+    rescue Exception => e
+      fatal_error("Could not find the configuration file '#{file}'")
+    end
+    
+    ##
+    # Returns the client configuration for a given section
+    # section::[String] the section to read (client, server or db)
+    def section(section)
+      if !SECTIONS.include?(section)
+        fatal_error("Trying to read invalid section '#{section}'")
+      end
+      config_hash = {}
+      @config[section].each do |key, val|
+        config_hash.merge!({key.to_s => val.to_s})
+      end
+    end
+    
+    private
+    def check_config
+      SECTIONS.each do |section|
+        if !@config[section]
+          fatal_error("Configuration file must contain a '#{section}' section.")
+        end
+      end
+    end
+    
+    def fatal_error(message)
+      $stderr.puts "Error: #{message}"
+      exit
+    end
+  end
+end

data/lib/databaseadapter.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+
+module C3s
+  class DatabaseAdapter
+    def initialize(config)
+      ActiveRecord::Base.colorize_logging = false
+      ActiveRecord::Base.logger = Logger.new(File.open('logs/database.log', 'a'))
+      
+      ActiveRecord::Base.establish_connection(
+        :adapter  => config['adapter'],
+        :host     => config['host'],
+        :username => config['username'],
+        :password => config['password'],
+        :database => config['database'],
+        :encoding => config['encoding']
+      )
+    end
+  end
+end

data/lib/nodetracker.rb

@@ -0,0 +1,27 @@
+module C3s
+  class NodeTracker
+    ##
+    # The existing nodes that node tracker knows of
+    @@existing_nodes = []
+    
+    ##
+    # Adds a node to the existing nodes
+    # 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
+    def self.include?(node)
+      @@existing_nodes.include?(node)
+    end
+    
+    ##
+    # Returns the existing nodes
+    def self.nodes
+      @@existing_nodes
+    end
+  end
+end

data/lib/publisher.rb

@@ -0,0 +1,80 @@
+require 'xmpp4r/pubsub'
+require 'nodetracker'
+
+module C3s
+  class Publisher 
+    ##
+    # Initializes the publisher
+    # client:: [Jabber::Client] the client publishing
+    # service:: [String] pubsub service name (eg: pubsub.jabber)
+    def initialize(client, service_name)
+      @client = client
+      @service = service_name
+      @pubsub = Jabber::PubSub::ServiceHelper.new(@client, @service)
+    end
+    
+    ##
+    # Creates the collection node(s) and leaf node if needed
+    # nodetree:: [String] node tree (eg: /location/user@jabber.com)
+    def create_nodes(nodetree)
+      nodes = nodetree.split("/")
+      nodes.delete("")
+      
+      # all nodes except the last are assumed as collection nodes
+      last_collection = nil
+      nodes[0..nodes.size-2].each do |name|
+        create_collection_node(name) if !node_exists?(name)
+        last_collection = name
+      end
+      
+      # last node is assumed as a leaf node
+      leaf = nodetree[1..nodetree.size-1] if nodetree[0..0].eql?"/"
+      leaf.gsub!("/", ":")
+      create_leaf_node(leaf, last_collection) if !node_exists?(leaf)
+    end
+    
+    ##
+    # Creates the collection node if needed
+    # name:: [String] collection node name
+    def create_collection_node(name)
+      config = Jabber::PubSub::NodeConfig.new
+      @pubsub.create_collection_node(name, config)
+    end
+    
+    ##
+    # Creates a leaf node to publish if needed
+    # This node must be associated with the collection node
+    # name:: [String] the name of the leaf node
+    # collection:: [String] the collection node that contains the node
+    def create_leaf_node(name, collection)
+      config = Jabber::PubSub::NodeConfig.new
+      config.options = config.options.merge({'pubsub#collection' => collection})
+      @pubsub.create_node(name, config)
+    end
+    
+    ##
+    # 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)
+      item = Jabber::PubSub::Item.new
+      item.add(content)
+      node = [@client.config['name'], node].join(":")
+      @pubsub.publish_item_to(node, item)
+    end
+    
+    ##
+    # Checks for existance of a node with a given name. This
+    # node can be a leaf or a collection
+    # name:: [String] the node name
+    def node_exists?(name)
+      return true if NodeTracker.include?(name)
+      nodebrowser = Jabber::PubSub::NodeBrowser.new(@client)
+      nodebrowser.get_info(@service, name)
+      NodeTracker.add_node(name)
+      true
+    rescue Jabber::ServerError => error
+      return false if error.to_s.include?("item-not-found")
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: c3s
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ricardo Otero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-30 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: C3s library gem.
+email: oterosantos@gmail.com
+executables: []
+
+extensions: []
+
+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/nodetracker.rb
+- lib/publisher.rb
+files: 
+- README.rdoc
+- Rakefile
+- c3s.gemspec
+- lib/c3s.rb
+- lib/c3s_logger.rb
+- lib/component.rb
+- lib/component_connection.rb
+- lib/configreader.rb
+- lib/databaseadapter.rb
+- lib/nodetracker.rb
+- lib/publisher.rb
+- Manifest
+has_rdoc: true
+homepage: http://github.com/rikas/c3s
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- C3s
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: c3s
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: C3s library gem.
+test_files: []
+