puggernaut 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+coverage
+log/*
+pkg
+tmp

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010
+
+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.md

@@ -0,0 +1,93 @@
+Puggernaut
+==========
+
+Simple server push implementation using eventmachine and long polling.
+
+![Puggernaut](/winton/puggernaut/raw/master/puggernaut.png)
+
+Requirements
+------------
+
+<pre>
+gem install puggernaut
+</pre>
+
+How it works
+------------
+
+Puggernaut consists of three pieces:
+
+* TCP client to send push messages
+* TCP server to receive push messages
+* HTTP server to deliver long poll requests
+
+Start it up
+-----------
+
+Run the <code>puggernaut</code> binary with optional port numbers:
+
+<pre>
+puggernaut &lt;http port&gt; &lt;tcp port&gt;
+</pre>
+
+The default HTTP and TCP ports are 8000 and 8001, respectively.
+
+Set up proxy pass
+-----------------
+
+You will need to set up a URL on your public facing web server that points to the Puggernaut HTTP server.
+
+If you do not see your web server below, [Google](http://google.com) is your friend.
+
+### Apache
+
+*http.conf*
+
+<pre>
+ProxyPass /long_poll http://localhost:8000/
+ProxyPassReverse /long_poll http://localhost:8000/
+</pre>
+
+### Nginx
+
+*nginx.conf*
+
+<pre>
+location /long_poll {
+  proxy_pass http://localhost:8000/;
+}
+</pre>
+
+Send push messages
+------------------
+
+<pre>
+require 'puggernaut'
+
+client = Puggernaut::Client.new("localhost:8001", "localhost:9001")
+client.push :channel => "message"
+client.push :channel => [ "message 1", "message 2" ], :channel_2 => "message"
+</pre>
+
+The <code>Client.new</code> initializer accepts any number of TCP server addresses.
+
+Receive push messages
+---------------------
+
+Include [puggernaut.js](/winton/puggernaut/public/puggernaut.js) into to your HTML page.
+
+Javascript client example:
+
+<pre>
+Puggernaut.path = '/long_poll';
+
+Puggernaut
+  .watch('channel', function(e, message) {
+    // do something with message
+  })
+  .watch('channel_2', function(e, message) {
+    // do something with message
+  });
+
+Puggernaut.unwatch('channel');
+</pre>

data/Rakefile

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/lib/puggernaut/gems'
+
+Puggernaut::Gems.activate %w(rake rspec)
+
+require 'rake'
+require 'spec/rake/spectask'
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path('../puggernaut.gemspec', __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+if defined?(Spec::Rake::SpecTask)
+  desc "Run specs"
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = %w(-fs --color)
+    t.warning = true
+  end
+  task :spec
+  task :default => :spec
+end
+
+desc "Build gem(s)"
+task :gem do
+  old_gemset = ENV['GEMSET']
+  root = File.expand_path('../', __FILE__)
+  pkg = "#{root}/pkg"
+  system "rm -Rf #{pkg}"
+  Puggernaut::Gems.gemset_names.each do |gemset|
+    ENV['GEMSET'] = gemset.to_s
+    system "cd #{root} && gem build puggernaut.gemspec"
+    system "mkdir -p #{pkg} && mv *.gem pkg"
+  end
+  ENV['GEMSET'] = old_gemset
+end
+
+namespace :gem do
+  desc "Install gem(s)"
+  task :install do
+    Rake::Task['gem'].invoke
+    Dir["#{File.dirname(__FILE__)}/pkg/*.gem"].each do |pkg|
+      system "gem install #{pkg} --no-ri --no-rdoc"
+    end
+  end
+  
+  desc "Push gem(s)"
+  task :push do
+    Rake::Task['gem'].invoke
+    Dir["#{File.dirname(__FILE__)}/pkg/*.gem"].each do |pkg|
+      system "gem push #{pkg}"
+    end
+  end
+end
+
+namespace :gems do
+  desc "Install gem dependencies (DEV=0 DOCS=0 GEMSPEC=default SUDO=0)"
+  task :install do
+    dev = ENV['DEV'] == '1'
+    docs = ENV['DOCS'] == '1' ? '' : '--no-ri --no-rdoc'
+    gemset = ENV['GEMSET']
+    sudo = ENV['SUDO'] == '1' ? 'sudo' : ''
+    
+    Puggernaut::Gems.gemset = gemset if gemset
+    
+    if dev
+      gems = Puggernaut::Gems.gemspec.development_dependencies
+    else
+      gems = Puggernaut::Gems.gemspec.dependencies
+    end
+    
+    gems.each do |name|
+      name = name.to_s
+      version = Puggernaut::Gems.versions[name]
+      if Gem.source_index.find_name(name, version).empty?
+        version = version ? "-v #{version}" : ''
+        system "#{sudo} gem install #{name} #{version} #{docs}"
+      else
+        puts "already installed: #{name} #{version}"
+      end
+    end
+  end
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/bin/puggernaut

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/puggernaut")
+
+Puggernaut::Server.new(*ARGV)

data/config.ru

@@ -0,0 +1,3 @@
+require "#{File.dirname(__FILE__)}/lib/puggernaut/spec_server"
+
+run SpecServer

data/config/gemsets.yml

@@ -0,0 +1,5 @@
+puggernaut:
+  eventmachine: ~>0.12.10
+  rake: >=0.8.7
+  rspec: ~>1.0
+  sinatra: ~>1.1.0

data/config/gemspec.yml

@@ -0,0 +1,11 @@
+name: puggernaut
+version: 0.1.0
+authors:
+  - Winton Welsh
+email: mail@wintoni.us
+homepage: http://github.com/winton/puggernaut
+summary: Simple server push implementation using eventmachine and long polling
+description: Simple server push implementation using eventmachine and long polling
+dependencies:
+  - eventmachine
+development_dependencies: null

data/lib/puggernaut.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/puggernaut/gems'
+
+Puggernaut::Gems.activate %w(eventmachine)
+
+require 'eventmachine'
+
+$:.unshift File.dirname(__FILE__)
+
+require 'puggernaut/logger'
+require 'puggernaut/client'
+require 'puggernaut/server'
+
+module Puggernaut
+end

data/lib/puggernaut/client.rb

@@ -0,0 +1,66 @@
+require "#{File.dirname(__FILE__)}/logger"
+require 'socket'
+
+module Puggernaut
+  class Client
+    
+    include Logger
+    
+    attr_accessor :connections
+    
+    def initialize(*servers)
+      @connections = {}
+      @retry = []
+      @servers = servers.collect { |s| s.split(':') }
+    end
+    
+    def close
+      @connections.each do |host_port, connection|
+        connection.close
+        logger.info "Client#close - #{host_port}"
+      end
+    end
+    
+    def push(messages)
+      messages = messages.collect do |channel, message|
+        if message.is_a?(::Array)
+          message.collect { |m| "#{channel}|#{m}" }.join("\n")
+        else
+          "#{channel}|#{message}"
+        end
+      end
+      unless messages.empty?
+        @servers.each do |(host, port)|
+          send host, port, messages.join("\n")
+        end
+      end
+    end
+    
+    private
+    
+    def send(host, port, data, try_retry=true)
+      try if try_retry
+      begin
+        host_port = "#{host}:#{port}"
+        logger.info "Client#send - #{host_port} - #{data}"
+        connection = @connections[host_port] ||= TCPSocket.open(host, port)
+        connection.print(data)
+        response = connection.gets
+        raise 'not ok' if !response || !response.include?('OK')
+      rescue Exception => e
+        logger.info "Client#send - Exception - #{e.message} - #{host_port} - #{data}"
+        @retry << [ host, port, data ]
+        @retry.shift if @retry.length > 10
+      end
+      try if try_retry
+    end
+    
+    def try
+      @retry.length.times do
+        host, port, data = @retry.shift
+        @connections.delete("#{host}:#{port}")
+        send host, port, data, false
+      end
+    end
+  end
+end

data/lib/puggernaut/gems.rb

@@ -0,0 +1,154 @@
+unless defined?(Puggernaut::Gems)
+  
+  require 'yaml'
+  
+  module Puggernaut
+    module Gems
+      class <<self
+        
+        attr_accessor :config
+        attr_reader :gemset, :gemsets, :versions
+        
+        class SimpleStruct
+          attr_reader :hash
+          
+          def initialize(hash)
+            @hash = hash
+            @hash.each do |key, value|
+              self.class.send(:define_method, key) { @hash[key] }
+              self.class.send(:define_method, "#{key}=") { |v| @hash[key] = v }
+            end
+          end
+        end
+        
+        Gems.config = SimpleStruct.new(
+          :gemsets => [ "#{File.expand_path('../../../', __FILE__)}/config/gemsets.yml" ],
+          :gemspec => "#{File.expand_path('../../../', __FILE__)}/config/gemspec.yml",
+          :warn => true
+        )
+        
+        def activate(*gems)
+          begin
+            require 'rubygems' unless defined?(::Gem)
+          rescue LoadError
+            puts "rubygems library could not be required" if @config.warn
+          end
+          
+          self.gemset ||= gemset_from_loaded_specs
+          
+          gems.flatten.collect(&:to_sym).each do |name|
+            version = @versions[name]
+            vendor = File.expand_path("../../../vendor/#{name}/lib", __FILE__)
+            if File.exists?(vendor)
+              $:.unshift vendor
+            elsif defined?(gem)
+              gem name.to_s, version
+            else
+              puts "#{name} #{"(#{version})" if version} failed to activate" if @config.warn
+            end
+          end
+        end
+        
+        def dependencies
+          dependency_filter(@gemspec.dependencies, @gemset)
+        end
+        
+        def development_dependencies
+          dependency_filter(@gemspec.development_dependencies, @gemset)
+        end
+        
+        def gemset=(gemset)
+          if gemset
+            @gemset = gemset.to_sym
+        
+            @gemsets = @config.gemsets.reverse.collect { |config|
+              if config.is_a?(::String)
+                YAML::load(File.read(config)) rescue {}
+              elsif config.is_a?(::Hash)
+                config
+              end
+            }.inject({}) do |hash, config|
+              deep_merge(hash, symbolize_keys(config))
+            end
+            
+            @versions = (@gemsets[gemspec.name.to_sym] || {}).inject({}) do |hash, (key, value)|
+              if !value.is_a?(::Hash) && value
+                hash[key] = value
+              elsif key == @gemset
+                (value || {}).each { |k, v| hash[k] = v }
+              end
+              hash
+            end
+          else
+            @gemset = nil
+            @gemsets = nil
+            @versions = nil
+          end
+        end
+        
+        def gemset_names
+          (
+            [ :default ] +
+            @gemsets[gemspec.name.to_sym].inject([]) { |array, (key, value)|
+              array.push(key) if value.is_a?(::Hash) || value.nil?
+              array
+            }
+          ).uniq
+        end
+        
+        def gemspec(reload=false)
+          if @gemspec && !reload
+            @gemspec
+          else
+            data = YAML::load(File.read(@config.gemspec)) rescue {}
+            @gemspec = SimpleStruct.new(data)
+          end
+        end
+      
+        private
+      
+        def deep_merge(first, second)
+          merger = lambda do |key, v1, v2|
+            Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2
+          end
+          first.merge(second, &merger)
+        end
+        
+        def dependency_filter(dependencies, match)
+          (dependencies || []).inject([]) { |array, value|
+            if value.is_a?(::Hash)
+              array += value[match.to_s] if value[match.to_s]
+            else
+              array << value
+            end
+            array
+          }.uniq.collect(&:to_sym)
+        end
+        
+        def gemset_from_loaded_specs
+          if defined?(Gem)
+            Gem.loaded_specs.each do |name, spec|
+              if name == gemspec.name
+                return :default
+              elsif name[0..gemspec.name.length] == "#{gemspec.name}-"
+                return name[gemspec.name.length+1..-1].to_sym
+              end
+            end
+            :default
+          else
+            :none
+          end
+        end
+      
+        def symbolize_keys(hash)
+          return {} unless hash.is_a?(::Hash)
+          hash.inject({}) do |options, (key, value)|
+            value = symbolize_keys(value) if value.is_a?(::Hash)
+            options[(key.to_sym rescue key) || key] = value
+            options
+          end
+        end
+      end
+    end
+  end
+end