compp 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -0,0 +1,66 @@
+= compp
+
+Compp is Comet and XMPP. It will probably remind you of BOSH but is much simpler. It's an easy way to turn any any incoming XMPP messages into a comet stream.
+
+== Usage
+
+=== Install
+
+    sudo gem install compp
+
+=== Start
+
+This will start a the server with a default behavior of putting any message stanza received down to the Comet connection
+    
+    Compp.start(Compp::Default, {:host => '0.0.0.0', :port => 8000})
+    
+You can also customize more your server :
+
+    class MyCompp < Compp::Default
+      ##
+      # This example just 
+      def register_xmpp_handlers(connection)
+        connection.register_handler :message  do |m|
+          status = m.xpath("//message/ps:event/sf:status", {"ps" => "http://jabber.org/protocol/pubsub#event", "sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).first
+          if !status.nil?
+            feed        = status["feed"]
+            http_code   = status.xpath("./sf:http/@code", {"sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).first
+            msg_status  = status.xpath("./sf:http",       {"sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).first.text
+            orbitize("#{feed} => #{http_code} (#{msg_status})")
+          end
+        end
+      end
+    end
+    # Starts the server 
+    Compp.start(MyCompp, {:host => '0.0.0.0', :port => 8000})
+
+Check out example.rb for more.
+
+= Author
+
+Julien (julien@superfeedr.com)
+
+= License
+
+Compp
+
+Copyright (c) 2009 Superfeedr
+ 
+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,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "compp"
+    gem.summary = %Q{A Gem to make Comet-like HTTP connections from XMPP streams}
+    gem.description = %Q{A Gem to make Comet-like HTTP connections from XMPP streams}
+    gem.email = "julien.genestoux@gmail.com"
+    gem.homepage = "http://github.com/julien51/compp"
+    gem.authors = ["julien"]
+    gem.add_dependency "eventmachine_httpserver", ">=0.2.0"
+    gem.add_dependency "blather", ">=0.4.7"
+    # 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' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+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
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "compp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/example.rb

@@ -0,0 +1,35 @@
+require "rubygems"
+require "compp"
+
+## Default
+# Start the HTTP server with the right handler.
+# A user connects and provides his jid:password
+# By default, the 'message' stanzas send to 'jid' will be sent to the Comet connection
+Compp.start(Compp::Default, {:host => '0.0.0.0', :port => 8000})
+
+## Another Example : customization
+# You can write classes that overide the default default behavior open XMPP events.
+# We use Blather's syntax.
+# This Example just show incoming XMPP notifications from Superfeedr (http://superfeedr.com)
+class MyCompp < Compp::Default
+  ##
+  # This example just 
+  def register_xmpp_handlers(connection)
+    connection.register_handler :message  do |m|
+      status = m.xpath("//message/ps:event/sf:status", {"ps" => "http://jabber.org/protocol/pubsub#event", "sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).first
+      if !status.nil?
+        feed        = status["feed"]
+        http_code   = status.xpath("./sf:http/@code", {"sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).first
+        msg_status  = status.xpath("./sf:http",       {"sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).first.text
+        orbitize("#{feed} => #{http_code} (#{msg_status})")
+      end
+    end
+  end
+end
+# Starts the server 
+Compp.start(MyCompp, {:host => '0.0.0.0', :port => 8000})
+
+##
+# A Sprinkler example
+# The HTTP server connects just 1 client and broadcasts the messages to any HTTP comet connection
+Compp.start(Compp::Sprinkler, {:host => '0.0.0.0', :port => 8000, :jid => "jid@server.tld", :password => "password"})

data/lib/compp.rb

@@ -0,0 +1,22 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'eventmachine'
+require 'blather/client/client'
+require 'evma_httpserver'
+require 'base64'
+require 'compp/connection'
+require 'compp/default'
+require 'compp/sprinkler'
+
+module Compp
+  def self.start(klass, options = {})
+    EM.epoll
+    host = options[:host] || "0.0.0.0"
+    port =  Integer(options[:port] || 8989)
+    EM.run {
+      EM.start_server(host, port, klass, options)
+    }
+  end
+end
+

data/lib/compp/connection.rb

@@ -0,0 +1,23 @@
+module Compp
+  class Connection < EM::Connection
+    include EventMachine::HttpServer
+    
+    ## 
+    # Initialize a new Compp:Connection
+    def initialize(opts = {})
+    end
+    
+    ##
+    # Sends obj.to_str on the comet connection!
+    def orbitize(obj)
+      send_data(obj.to_str + "\r\n")
+    end
+    
+    ##
+    # This is called upon new connection by an external client.
+    def process_http_request
+      # Does nothing, this should be overriden if you want more advanced behavior
+    end
+    
+  end
+end

data/lib/compp/default.rb

@@ -0,0 +1,78 @@
+module Compp
+  ## 
+  # This is the default Compp::Connection.
+  # For each GET request it receives, it extract the credentails from the headers, and connects an XMPP client.
+  # The user can define its own xmpp handlers by subclassing this class.
+  class Default < Compp::Connection
+    
+    attr_accessor :http_headers
+    
+    ##
+    # Helping tool to extract jid and password from headers
+    def extract_jid_and_password_from_headers
+      jid, password = nil, nil
+      begin
+        headers = Hash[@http_headers.split("\000").map() {|h| h.split(": ")}]
+        if headers["Authorization"] 
+          auth = headers["Authorization"].split(" ")
+          if auth[0] == "Basic"
+            jid, password = Base64.decode64(auth[1]).split(":")
+          end
+        end
+      rescue
+        # Something was wring, w dont care
+      end
+      [jid, password]
+    end
+
+    ##
+    # This is the default behavior. 
+    # When a user sends an HTTP request, the headers are parsed
+    # We connect an Blather Client using these headers
+    # Upon stanzas, we call on_stanza
+    def process_http_request
+      jid, password = extract_jid_and_password_from_headers()
+      if jid.nil?
+        send_401
+      else
+        client = Blather::Client.setup(jid, password)
+        client.register_handler(:ready) { 
+          orbitize("HTTP/1.0 200 OK")
+          orbitize("Content-Type: text/xml")
+          orbitize("Connection: close\r\n")
+          orbitize( "<?xml version='1.0' encoding='utf-8' ?>")
+        }
+        register_xmpp_handlers(client) # This function should probably be overriden
+        client.connect
+      end
+    end
+
+    ##
+    # Helping tool that sends a 401
+    def send_401
+      resp = EventMachine::DelegatedHttpResponse.new( self )
+      resp.status = 401
+      resp.content = "Please, authenticate with with jid:password\n\n"
+      resp.send_response
+    end
+    
+    ##
+    # Helping tool that sends a 403
+    def send_403
+      resp = EventMachine::DelegatedHttpResponse.new( self )
+      resp.status = 403
+      resp.content = "Couldn't authenticate XMPP user\n\n"
+      resp.send_response
+    end
+    
+    ##
+    # This should be overiden!
+    # If, not, we assume the user just wants to puts the XML content of the message received to the HTTP connection
+    def register_xmpp_handlers(client)
+      client.register_handler(:message) do |m|
+        orbitize(m.to_xml)
+      end
+    end
+    
+  end
+end

data/lib/compp/sprinkler.rb

@@ -0,0 +1,43 @@
+module Compp
+  ## 
+  # This is the default Compp::Connection.
+  # For each GET request it receives, it extract the credentails from the headers, and connects an XMPP client.
+  # The user can define its own xmpp handlers by subclassing this class.
+  class Sprinkler < Compp::Connection
+    
+    @@xmpp_client = nil
+    @@channel = nil
+    
+    ## 
+    # Initialize a new Compp:Connection
+    def initialize(opts = {})
+      if !@@xmpp_client
+        # Right, we need to connect the xmpp client now
+        @@xmpp_client = Blather::Client.setup(opts[:jid], opts[:password])
+        @@channel = EM::Channel.new
+        @@xmpp_client.register_handler(:message) do |m|
+          @@channel.push(m.to_xml)
+        end
+        @@xmpp_client.connect
+      end
+      @@channel.subscribe{ |msg| 
+        orbitize(msg)
+      }
+    end
+    
+    ##
+    # Called when a user send an HTTP request.
+    def process_http_request
+      orbitize("HTTP/1.0 200 OK")+
+      orbitize("Content-Type: text/xml")
+      orbitize("Connection: close\r\n")
+      orbitize( "<?xml version='1.0' encoding='utf-8' ?>")
+    end
+    
+    ##
+    # In this case, where we broadcast, this does nothing... and is never called anyway!
+    def register_xmpp_handlers(client) 
+    end 
+    
+  end
+end

data/spec/compp/connection_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Compp::Connection do
+  it "should be a  EventMachine::HttpServer" do
+    c = Compp::Connection.new("")
+    c.should be_a(Compp::Connection)
+  end
+  
+  describe "orbitize" do
+    it "should send the data's to_s and add \r\n" do
+      c = Compp::Connection.new("")
+      data = "data"
+      c.should_receive(:send_data).with("#{data}\r\n")
+      c.orbitize(data)
+    end
+  end
+end

data/spec/compp/default_spec.rb

@@ -0,0 +1,169 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Compp::Default do
+
+  describe "send_401" do
+    before(:each) do
+      @c = Compp::Default.new({})
+      @mock_response = mock(EventMachine::DelegatedHttpResponse, :status= => true, :content= => true, :send_response => true)
+      EventMachine::DelegatedHttpResponse.stub!(:new).and_return(@mock_response)
+    end
+    
+    it "should create a new response" do
+      EventMachine::DelegatedHttpResponse.should_receive(:new).with(@c).and_return(@mock_response)
+      @c.send_401
+    end
+    
+    describe "response" do
+      it "should have a 401 status" do
+        @mock_response.should_receive(:status=).with(401)
+        @c.send_401
+      end
+      
+      it "should have the right error message" do
+        @mock_response.should_receive(:content=).with("Please, authenticate with with jid:password\n\n")
+        @c.send_401
+      end
+      
+    end
+    it "should send this response" do
+      @mock_response.should_receive(:send_response)
+      @c.send_401
+    end
+  end
+
+  describe "send_403" do
+    before(:each) do
+      @c = Compp::Default.new({})
+      @mock_response = mock(EventMachine::DelegatedHttpResponse, :status= => true, :content= => true, :send_response => true)
+      EventMachine::DelegatedHttpResponse.stub!(:new).and_return(@mock_response)
+    end
+    
+    it "should create a new response" do
+      EventMachine::DelegatedHttpResponse.should_receive(:new).with(@c).and_return(@mock_response)
+      @c.send_403
+    end
+    
+    describe "response" do
+      it "should have a 401 status" do
+        @mock_response.should_receive(:status=).with(403)
+        @c.send_403
+      end
+      
+      it "should have the right error message" do
+        @mock_response.should_receive(:content=).with("Couldn't authenticate XMPP user\n\n")
+        @c.send_403
+      end
+      
+    end
+    it "should send this response" do
+      @mock_response.should_receive(:send_response)
+      @c.send_403
+    end
+  end
+  
+  describe "register_xmpp_handlers" do
+    before(:each) do
+      @c = Compp::Default.new({})
+      @client = mock(Blather::Client)
+      @data = mock(Nokogiri::XML::Node, :to_xml => "cool")
+      @client.stub!(:register_handler).with(:message).and_yield(@data)
+      @c.stub(:orbitize)
+    end
+    
+    it 'should resgister a handler on message' do
+      @client.should_receive(:register_handler).with(:message).and_yield(@data)
+      @c.register_xmpp_handlers(@client)
+    end
+    
+    it "should call to_xml on the data" do
+      @data.should_receive(:to_xml)
+      @c.register_xmpp_handlers(@client)
+    end
+    
+    it "should orbitize any message received" do
+      @c.should_receive(:orbitize).with(@data.to_xml)
+      @c.register_xmpp_handlers(@client)
+    end
+  end
+  
+  
+  describe "process_http_request" do
+    before(:each) do
+      @c = Compp::Default.new({})
+      @c.stub!(:extract_jid_and_password_from_headers)
+      @c.stub!(:send_401)
+    end    
+    
+    it "should extract the jid and password" do
+      @c.should_receive(:extract_jid_and_password_from_headers)
+      @c.process_http_request
+    end
+    
+    it "should call send_401 if no jid and password were extracted" do
+      @c.stub!(:extract_jid_and_password_from_headers)
+      @c.should_receive(:send_401)
+      @c.process_http_request
+    end
+    
+    context 'when a jid password was exatcrted' do
+      
+      before(:each) do
+        @jid = "julien@superfeedr.com"
+        @password = "password"
+        @mock_xmpp_client = mock(Blather::Client, :register_handler => true, :connect => true)
+        @c.stub!(:extract_jid_and_password_from_headers).and_return([@jid, @password])
+        Blather::Client.stub!(:setup).and_return(@mock_xmpp_client)
+        @mock_xmpp_client.stub!(:register_handler).with(:ready).and_yield()
+        @c.stub!(:orbitize)
+      end
+      
+      it "should create a new xmpp client" do
+        Blather::Client.should_receive(:setup).with(@jid, @password).and_return(@mock_xmpp_client)
+        @c.process_http_request
+      end
+      
+      it "should register a handler on ready" do
+        @mock_xmpp_client.should_receive(:register_handler).with(:ready).and_yield()
+        @c.process_http_request
+      end
+      
+      it "should orbitize the http headers when ready" do
+        @c.should_receive(:orbitize).with("HTTP/1.0 200 OK")
+        @c.should_receive(:orbitize).with("Content-Type: text/xml")
+        @c.should_receive(:orbitize).with("Connection: close\r\n")
+        @c.should_receive(:orbitize).with("<?xml version='1.0' encoding='utf-8' ?>")
+        @c.process_http_request
+      end
+      
+      it "should call register_xmpp_handlers" do
+        @c.should_receive(:register_xmpp_handlers).with(@mock_xmpp_client)
+        @c.process_http_request
+      end
+      
+      it "should connect the client" do
+        @mock_xmpp_client.should_receive(:connect)
+        @c.process_http_request
+      end
+    end
+  end
+  
+  describe "extract_jid_and_password_from_headers" do
+    
+    before(:each) do
+      @c = Compp::Default.new({})
+    end
+    
+    it "should extract the Auth headers" do
+      @c.http_headers = "Authorization: Basic anVsaWVuOnBhc3N3b3Jk\000User-Agent: curl/7.19.6 (i386-apple-darwin10.0.0) libcurl/7.19.6 zlib/1.2.3\000Host: 0.0.0.0:8000\000Accept: */*\000\000"
+      @c.extract_jid_and_password_from_headers.should == ["julien", "password"]
+    end
+    
+    it "should return nil, nil if no Auth header was found" do
+      @c.http_headers = "User-Agent: curl/7.19.6 (i386-apple-darwin10.0.0) libcurl/7.19.6 zlib/1.2.3\000Host: 0.0.0.0:8000\000Accept: */*\000\000"
+      @c.extract_jid_and_password_from_headers.should == [nil, nil]
+    end
+    
+  end
+  
+end

data/spec/compp/sprinkler_spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe Compp::Sprinkler do
+end

data/spec/compp_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Compp do
+  describe "start" do
+    before(:each) do
+      EM.stub!(:epoll)
+      EM.stub!(:run).and_yield()
+      EM.stub!(:start_server)
+    end
+    
+    it "should use epoll" do
+      EM.should_receive(:epoll)
+      Compp.start(Class.new)
+    end
+    
+    it "should start EM" do
+      EM.should_receive(:run)
+      Compp.start(Class.new)
+    end
+    
+    it "should start a server with the host, port, klass and options specified" do
+      options =  {:port => 123, :host => "localhost"}
+      handler = Class.new
+      EM.should_receive(:start_server).with(options[:host], options[:port],handler , options)
+      Compp.start(handler, options)
+    end
+  end 
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--color

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../lib/compp"

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: compp
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- julien
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine_httpserver
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: blather
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.7
+    version: 
+description: A Gem to make Comet-like HTTP connections from XMPP streams
+email: julien.genestoux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- example.rb
+- lib/compp.rb
+- lib/compp/connection.rb
+- lib/compp/default.rb
+- lib/compp/sprinkler.rb
+- spec/compp/connection_spec.rb
+- spec/compp/default_spec.rb
+- spec/compp/sprinkler_spec.rb
+- spec/compp_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/julien51/compp
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Gem to make Comet-like HTTP connections from XMPP streams
+test_files: 
+- spec/compp/connection_spec.rb
+- spec/compp/default_spec.rb
+- spec/compp/sprinkler_spec.rb
+- spec/compp_spec.rb
+- spec/spec_helper.rb