radamanthus-skates 0.3.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 julien
+
+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/README.rdoc

@@ -0,0 +1,113 @@
+= Skates
+
+== DESCRIPTION:
+
+Skates is a framework to build XMPP Applications in Ruby. The framework uses EventMachine to handle network connections.
+
+This framework can use both an XMPP Component (XEP-0114) and an XMPP Client (and XMPP Servers should come soon). However, we strongly discourage any production application using a regular client.
+
+== FEATURES/PROBLEMS:
+
+Please link "report/request here.":http://github.com/julien51/skates/issues
+
+The current version is a good candidate for version 0.1. We will probably not add any important features before that release, but we need some help with the tests and documentation.
+
+== ROADMAP :
+
+- Implement the ServerConnection for S2S
+- Implement templates for disco-info... and common XEPs
+- Delete route priorities? And rely on the order only? (As Rails does)
+- Review doc
+- Write tests
+- Evangelize!
+
+You can help with at least one of these points, don't turn your back on Skates!
+
+== DOCUMENTATION :
+
+You can find it on our "Rubyforge page":http://skates.rubyforge.org/
+Feel free to fork the "github":http://github.com/julien51/skates/tree/master repo and add some documentation if you think anything is missing. 
+
+__You can't be a bad coder, a bad tester and a bad documenter at the same time ;)__
+
+== SYNOPSIS :
+
+You can build applications directly with Skates, or you can use the Skates::ClientConnection and Skates::ComponentConnection to create simple apps, but you will then have to handle stanza routing and creation yourself. You can also use these classes in external gems.
+
+=== To create an Application with Skates: 
+
+1. Install the gem
+2. The app contains a generator that will "build" a scaffold for your application. 
+    
+    $> skates application __myapp__
+
+3. Use the generator or write your own controllers : 
+
+    $> skates controller __messages__ __echo__:__10__:__//stream:message[@type='chat']/body__,__subscribed__:__0__:__//stream:presence[@type='subscribe']__
+
+This will generate a __MessagesController__ class with 2 methods : __echo__ and __subscribed__. 
+ - "echo" will be called when the component receives message stanzas of type 'chat', 
+ - "subscribed" will be called for presence stanzas of type 'subscribe'. 
+10 and 0 are the priority : useful when a stanza matches 2 XPath.  
+
+Each of these actions will be called with stanza objects. You have to define your own objects in __stanzas/echo.rb__ and __stanzas/subscribed.rb__
+By implementing them, you can choose which elements and attributes you want to have access to. These attributes will be populated upon instantiation of the Stanza objects.
+
+This will also generate 2 'views' used to build your responses stanzas. 
+
+And finally, this will write 2 routes in the config/routes.rb 
+
+4. Customize your controllers, stanzas and views!
+
+5. Make sure that the XMPP settings are correct in config/config.yaml. 
+
+6. And finally start the component :
+    
+    script/component
+
+7. We running in production, you may run the script/component too, but with something like runit to deamonize the process.
+
+=== To use the Connection Classes only (Client or Component), you can just call the following :
+
+Skates::ClientConnection.connect(params, handler) 
+or,
+Skates::ComponentConnection.connect(params, handler) 
+
+where params is a hash for all the necessary information to connect, and handler is an object that will receive the callbacks. Right now 3 callbacks are supported:
+
+on_connected(connection), on_disconnected and on_stanza(stanza)
+
+== ADDITIONAL INFORMATION : 
+
+Feel free to pull, branch, improve and commit the {code|specs|tests|docs} : we will merge it if it's a step ahead!
+
+Skates's edge versions are located at Github : http://github.com/julien51/skates/tree/master
+
+== REQUIREMENTS :
+
+Gems : Eventmachine, nokogiri, YAML, log4r, templater
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Julien Genestoux http://notifixio.us
+
+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,142 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "skates"
+    gem.summary = %Q{Skates is a framework to create EventMachine based XMPP External Components in Ruby.}
+    gem.email = "julien.genestoux@gmail.com"
+    gem.homepage = "http://github.com/julien51/skates"
+    gem.authors = ["julien Genestoux"]
+
+    gem.add_dependency('eventmachine', ">= 0.12.10")
+    gem.add_dependency('log4r')
+    gem.add_dependency('nokogiri', "= 1.4.2")
+    gem.add_dependency('utf8cleaner')
+    gem.requirements = ["eventmachine", "yaml", "fileutils", "log4r", "nokogiri", "optparse", "digest/sha1", "base64", "resolv", "utf8cleaner"]
+    gem.executables = "skates"
+    gem.files = [ "bin/skates", 
+                  "lib/skates.rb", 
+                  "lib/skates/ext/array.rb", 
+                  "lib/skates/base/controller.rb", 
+                  "lib/skates/base/view.rb", 
+                  "lib/skates/base/stanza.rb", 
+                  "lib/skates/client_connection.rb", 
+                  "lib/skates/component_connection.rb", 
+                  "lib/skates/router/dsl.rb", 
+                  "lib/skates/router.rb", 
+                  "lib/skates/runner.rb", 
+                  "lib/skates/generator.rb", 
+                  "lib/skates/xmpp_connection.rb", 
+                  "lib/skates/xmpp_parser.rb", 
+                  "LICENSE", 
+                  "Rakefile", 
+                  "README.rdoc", 
+                  "templates/skates/app/controllers/controller.rb", 
+                  "templates/skates/app/views/view.rb", 
+                  "templates/skates/app/stanzas/stanza.rb", 
+                  "templates/skates/config/boot.rb", 
+                  "templates/skates/config/config.yaml", 
+                  "templates/skates/config/dependencies.rb", 
+                  "templates/skates/config/routes.rb", 
+                  "templates/skates/script/component",
+                  "templates/skates/log/test.log",
+                  "templates/skates/log/development.log",
+                  "templates/skates/log/production.log",
+                  "templates/skates/tmp/pids/README"
+                  ]
+    gem.rubyforge_project = 'skates'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Skates : a framework to create EventMachine based XMPP External Components in Ruby.'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--line-numbers'
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    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
+
+begin
+  require 'spec/rake/spectask'
+  desc "Run all Spec"
+  Spec::Rake::SpecTask.new('spec') do |spec|
+    spec.spec_files = FileList['spec/**/*.rb']
+    spec.verbose = true
+    spec.warning = false
+    spec.rcov = true
+  end
+rescue LoadError
+  task :spec do
+    abort "Rspec is not available. In order to run rspec, you must: sudo gem install rspec"
+  end
+end
+
+begin
+  require 'spec/rake/verify_rcov'
+
+  RCov::VerifyTask.new(:verify_rcov => 'spec') do |t|
+    t.threshold = 100.0
+    t.index_html = 'coverage/index.html'
+  end
+rescue LoadError
+  task :spec do
+    abort "Rcov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+# These are Rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/skates"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
+
+task :install => :build
+
+task :default => :test

data/bin/skates

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+ 
+require 'rubygems'
+require 'templater'
+require 'skates'
+require 'skates/generator'
+
+Skates::Generator.run_cli(Dir.pwd, 'skates_app', "0.1", ARGV)

data/lib/skates.rb

@@ -0,0 +1,154 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'eventmachine'
+require 'log4r'
+require 'nokogiri'
+require 'yaml'
+require 'fileutils'
+require 'digest/sha1'
+require 'base64'
+require 'resolv'
+require 'cgi'
+require 'utf8cleaner'
+require 'pathname'
+
+require 'skates/ext/array.rb'
+require 'skates/xmpp_connection'
+require 'skates/xmpp_parser'
+require 'skates/component_connection'
+require 'skates/client_connection'
+require 'skates/router'
+require 'skates/runner'
+require 'skates/base/controller'
+require 'skates/base/view'
+require 'skates/base/stanza'
+
+# Skates is a XMPP Component Framework based on EventMachine. It uses the Nokogiri GEM, which is a Ruby wrapper for Libxml2.
+# It implements the MVC paradigm.
+# You can create your own application by running :
+#   $> skates app_name
+# This will generate some folders and files for your application. Please see README.rdoc for further instructions
+
+module Skates
+  
+  @@config_file = nil
+  
+  def self.environment=(_env)
+    @@env = _env
+  end
+
+  def self.environment
+    unless self.class_variable_defined?("@@env")
+      @@env = "development"
+    end
+    @@env
+  end
+  
+  ##
+  # Sets up the router
+  def self.router=(router)
+    @@router = router
+  end
+  
+  ##
+  # Retruns the router
+  def self.router
+    unless self.class_variable_defined?("@@router")
+      @@router = nil
+    end
+    @@router
+  end
+  
+  ##
+  # Caches the view files to improve performance.  
+  def self.cache_views
+    @@views= {}
+    Dir.glob('app/views/*/*').each do |f|
+      @@views[f] = File.read(f)
+    end        
+  end
+  
+  def self.views
+    unless self.class_variable_defined?("@@views")
+      @@views= {}
+    end
+    @@views
+  end
+
+  ##
+  # Returns a shared logger for this component.
+  def self.logger
+    unless self.class_variable_defined?("@@logger")
+      reopen_logs
+    end
+    @@logger
+  end
+  
+  ##
+  # Returns the log directory 
+  def self.log_dir
+    unless self.class_variable_defined?("@@log_dir")
+      @@log_dir = "log"
+    end
+    @@log_dir
+  end
+  
+  def self.log_dir=(log_dir)
+    @@log_dir = log_dir
+    reopen_logs
+  end
+  
+  ##
+  # Re-opens the logs
+  # In "development" environment, the log will be on stdout
+  def self.reopen_logs
+    # Open a new logger
+    logger = Log4r::Logger.new("") 
+    logger.add(Log4r::Outputter.stdout) if Skates.environment == "development"
+    log_file = Log4r::RollingFileOutputter.new("#{Skates.environment}", :filename => "#{Skates.log_dir}/#{Skates.environment}.log", :trunc => false)
+    case Skates.environment
+    when "production"
+      log_file.formatter = Log4r::PatternFormatter.new(:pattern => "%d (#{Process.pid}) [%l] :: %m #{Skates.router.nil? ? "" : (Skates.router.connection.nil? ? "" : "(" + Skates.router.connection.jid + ")") }", :date_pattern => "%d/%m %H:%M")      
+    when "development"
+      log_file.formatter = Log4r::PatternFormatter.new(:pattern => "%d (#{Process.pid}) [%l] :: %m #{Skates.router.nil? ? "" : (Skates.router.connection.nil? ? "" : "(" + Skates.router.connection.jid + ")") }", :date_pattern => "%d/%m %H:%M")      
+    else
+      log_file.formatter = Log4r::PatternFormatter.new(:pattern => "%d (#{Process.pid}) [%l] :: %m #{Skates.router.nil? ? "" : (Skates.router.connection.nil? ? "" : "(" + Skates.router.connection.jid + ")") }", :date_pattern => "%d/%m %H:%M")      
+    end
+    logger.add(log_file)
+    # Set up the variable.
+    @@logger = logger
+  end
+
+  ##
+  # Set the configuration file for this component.
+  def self.config_file=(file)
+    @@config_file = file
+  end
+
+  ##
+  # Return the configuration file for this component.
+  def self.config_file
+    @@config_file
+  end
+
+  ##
+  # Set the configuration for this component.
+  def self.config=(conf)
+    @@config = conf
+  end
+
+  ##
+  # Return the configuration for this component.
+  def self.config
+    @@config
+  end
+  
+  ##
+  # Decodes XML special characters.
+  def self.decode_xml(str)
+    CGI.unescapeHTML(str)
+  end
+  
+end
+

data/lib/skates/base/controller.rb

@@ -0,0 +1,116 @@
+module Skates
+  module Base
+    
+    ##
+    # Your application's controller should be descendant of this class.
+    class Controller
+      
+      attr_accessor :stanza, :rendered, :action_name # Stanza received by the controller (Nokogiri::XML::Node)
+      
+      ##
+      # Creates a new controller (you should not override this class) and assigns the stanza as well as any other value of the hash to instances named after the keys of the hash.
+      def initialize(stanza = nil)
+        @stanza = stanza
+        @view = nil
+      end
+      
+      ##
+      # Performs the action and calls back the optional block argument : you should not override this function
+      def perform(action)
+        @action_name = action
+        begin
+          self.send(@action_name)
+        rescue
+          Skates.logger.error {
+            "#{$!}:\n#{$!.backtrace.join("\n")}"
+          }
+        end
+        self.render
+      end
+      
+      ##
+      # Returns the list of variables assigned during the action.
+      def assigns
+        vars = Hash.new
+        instance_variables.each do |var|
+          if !["@view", "@action_name", "@block"].include? var
+            vars[var[1..-1]] = instance_variable_get(var)
+          end
+        end
+        vars
+      end
+      
+      ##
+      # Called by default after each action to "build" a XMPP stanza. By default, it will use the /controller_name/action.xml.builder
+      # You can use the following options :
+      #   - :file : render a specific file (can be in a different controller)
+      #   - :action : render another action of the current controller
+      #   - :nothing : doesn't render anything
+      def render(options = {}) 
+        return if @view and !options[:force] # Avoid double rendering, if we have already attached a view
+        
+        if options == {} # default rendering
+          render(:file => default_template_name)
+
+        elsif action_name = options[:action]
+          result = render(:file => default_template_name(action_name.to_s))
+
+        elsif options[:file]
+          file = options[:file]
+          if file =~ /^\// # Render from view root
+            @view = render_for_file(File.join("app", "views", "#{file}.xml.builder"))
+          else
+            @view = render_for_file(view_path(file)) 
+          end
+
+        elsif options[:nothing]
+          @view = Skates::Base::View.new()
+        end
+      end
+      
+      ##
+      # Actually evaluates the view
+      def evaluate
+        @view.evaluate if @view
+      end
+      
+      ##
+      # Render and evaluate a given view
+      def render_and_evaluate(options = {})
+        render(options)
+        evaluate
+      end
+      
+      ##
+      # Renders, evaluate and sends
+      def render_evaluate_and_send(options)
+        response = render_and_evaluate(options)
+        Skates.router.connection.send_xml response 
+      end
+      
+      protected
+      
+      ##
+      # Builds the view path.
+      def view_path(file_name)
+        File.join("app", "views", "#{self.class.name.gsub("Controller","").downcase}", file_name)
+      end
+      
+      ##
+      # Default template name used to build stanzas
+      def default_template_name(action_name = nil)
+        "#{action_name || @action_name}.xml.builder"
+      end
+      
+      ##
+      # Creates the view and "evaluates" it to build the XML for the stanza
+      def render_for_file(file)
+        Skates.logger.info {
+          "RENDERING : #{file}"
+        }
+        Skates::Base::View.new(file, assigns)
+      end
+      
+    end
+  end
+end