rocket-server 0.0.1

data/lib/rocket/server/helpers.rb

@@ -0,0 +1,22 @@
+module Rocket
+  module Server
+    module Helpers
+      
+      include Rocket::Helpers
+      
+      # Proxy to Rocket's configured logger. 
+      def log
+        Rocket::Server.logger
+      end
+      
+      %w[ info debug warn error fatal ].each do |level|
+        define_method("log_#{level}") do |*args|
+          message = args.shift
+          message = self.class::LOG_MESSAGES[message] if message.is_a?(Symbol)
+          log.send(level, message % args)
+        end
+      end
+      
+    end # Helpers
+  end # Server
+end # Rocket

data/lib/rocket/server/misc.rb

@@ -0,0 +1,17 @@
+module Rocket
+  module Server
+    module Misc
+    
+      # Generates example config file for Rocket server. 
+      def self.generate_config_file(fname)
+        File.open(fname, "w+") do |f| 
+          f.write(File.read(File.expand_path("../templates/config.yml.tpl", __FILE__))) 
+        end
+      rescue => e
+        puts e.to_s
+        exit 1
+      end
+      
+    end # Misc
+  end # Server
+end # Rocket

data/lib/rocket/server/runner.rb

@@ -0,0 +1,78 @@
+require 'daemons'
+
+module Rocket
+  module Server
+    class Runner
+
+      include Helpers
+      include Daemonize
+      
+      LOG_MESSAGES = {
+        :starting_server => "Server is listening at %s:%s (CTRL+C to stop)",
+        :stopping_server => "Stopping Rocket server..."
+      }
+      
+      attr_reader :options
+      attr_reader :host
+      attr_reader :port
+      attr_reader :pidfile
+      attr_reader :daemon
+      
+      def initialize(options={})
+        @options = options.dup
+        @host    = @options[:host] || 'localhost'
+        @port    = @options[:port] || 9772
+        @pidfile = @options.delete(:pid) || "/var/run/rocket/server.pid"
+        @daemon  = @options.delete(:daemon)
+        
+        # Remove unnecessary options. 
+        @options.reject!{|k,v| [:verbose, :quiet, :log, :apps, :plugins].include?(k) }
+      end
+    
+      def start!(&block)
+        if daemon
+          daemonize!(&block)
+        else
+          EM.epoll
+          EM.run do
+            trap("TERM") { stop! }
+            trap("INT")  { stop! }
+            
+            log_info(:starting_server, host, port.to_s)
+            EM::start_server(host, port, Connection, options, &block)
+          end
+        end
+      end
+      
+      def stop!
+        log_info(:stopping_server)
+        EM.stop
+      end
+      
+      def kill!
+        if File.exists?(pidfile)
+          pid = File.read(pidfile).chomp.to_i
+          FileUtils.rm pidfile
+          Process.kill(9, pid)
+          pid
+        end
+      rescue => e
+        # nothing to show
+      end
+      
+      def daemonize!(&block)
+        daemonize
+        start!(&block)
+      end
+      
+      def save_pid
+        FileUtils.mkdir_p(File.dirname(pidfile))
+        File.open(pidfile, "w+"){|f| f.write("#{Process.pid}\n")}
+      rescue => e
+        puts e.to_s
+        exit 1
+      end
+    
+    end # Runner
+  end # Server
+end # Rocket

data/lib/rocket/server/session.rb

@@ -0,0 +1,58 @@
+module Rocket
+  module Server
+    class Session
+    
+      attr_reader :subscriptions
+      attr_reader :app
+      
+      def initialize(app_id)
+        @app = Rocket::Server::App.find(app_id)
+        @subscriptions = {}
+      end
+      
+      # Returns id of current application. 
+      def app_id
+        @app.id
+      end
+      
+      # Returns +true+ when current session is authenticated with secret key.
+      def authenticated?
+        !!@authenticated
+      end
+      
+      # Authenticate current session with your secret key. 
+      def authenticate!(secret)
+        @authenticated = (app.secret == secret)
+      end
+      
+      # Subscribes specified channel by given connected client. 
+      #
+      #   subscribe("my-awesome-channel", connection) # => subscription ID
+      #
+      def subscribe(channel, connection)
+        sid = Channel[app_id => channel].subscribe {|msg| connection.send(msg) }
+        subscriptions[channel => connection.signature] = sid
+        sid
+      end
+      
+      # Unsubscribes specified channel for given client.
+      #
+      #   unsubscribe("my-awesome-channel", connection)
+      #
+      def unsubscribe(channel, connection)
+        if sid = subscriptions.delete(channel => connection.signature)
+          Channel[app_id => channel].unsubscribe(sid)
+        end
+      end
+      
+      # Close current session and kill all active subscriptions.
+      def close
+        subscriptions.keys.each do |id| 
+          channel, sig = id.to_a.flatten
+          Channel[app_id => channel].unsubscribe(subscriptions.delete(channel => sig))
+        end
+      end
+      
+    end # Session
+  end # Server
+end # Rocket

data/lib/rocket/server/templates/config.yml.tpl

@@ -0,0 +1,40 @@
+# On which host and port server should listen for connections. 
+host: localhost
+port: 9772
+
+# Run applicaiton in secured mode (wss).
+#secure: true
+secure: false
+
+# Specify prefered verbosity level.
+#verbose: true # Increase verbosity
+#quiet: true # Decrease verbosity
+verbose: true
+
+# Run web sockets server in debug mode.
+#debug: true
+debug: false
+
+# Run daemonized instance of Rocket server.
+#daemon: true
+daemon: false
+
+# Specify path to server process' PID file. This option works only
+# when server is daemonized.  
+#pid: /var/run/rocket.pid
+
+# Specify path to server's output log. 
+#log: /var/log/rocket.log
+
+# SSL certificates configuration.
+#tls_options:
+#  private_key_file: /home/ssl/private.key
+#  cert_chain_file: /home/ssl/certificate
+
+# Here you can specify all static apps allowed to run on this server. 
+# Apps are kind of namespaces with separated authentication.
+apps:
+  test_app_1: 
+    secret: secretkey1
+  test_app_2:
+    secret: secretkey2

data/lib/rocket/server/version.rb

@@ -0,0 +1,14 @@
+module Rocket
+  module Server
+    module Version # :nodoc:
+      MAJOR  = 0
+      MINOR  = 0
+      TINY   = 1
+      STRING = [MAJOR, MINOR, TINY].join(".")
+    end # Version
+    
+    def self.version # :nodoc:
+      Version::STRING
+    end 
+  end # Server
+end # Rocket

data/rocket-server.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rocket-server}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Araneo", "Chris Kowalik"]
+  s.date = %q{2010-11-03}
+  s.description = %q{
+This is a fast web socket server built on awesome EventMachine with em-websockets help. 
+It provides easy to use, event-oriented middleware for your web-socket powered applications.    
+}
+  s.email = %q{chris@nu7hat.ch}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "bin/rocket-server",
+     "etc/testing.yml",
+     "lib/rocket-server.rb",
+     "lib/rocket/server.rb",
+     "lib/rocket/server/app.rb",
+     "lib/rocket/server/channel.rb",
+     "lib/rocket/server/cli.rb",
+     "lib/rocket/server/connection.rb",
+     "lib/rocket/server/helpers.rb",
+     "lib/rocket/server/misc.rb",
+     "lib/rocket/server/runner.rb",
+     "lib/rocket/server/session.rb",
+     "lib/rocket/server/templates/config.yml.tpl",
+     "lib/rocket/server/version.rb",
+     "rocket-server.gemspec",
+     "spec/apps_spec.rb",
+     "spec/channel_spec.rb",
+     "spec/cli_spec.rb",
+     "spec/connection_spec.rb",
+     "spec/helpers_spec.rb",
+     "spec/misc_spec.rb",
+     "spec/runner_spec.rb",
+     "spec/server_spec.rb",
+     "spec/session_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/araneo/rocket}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Fast and extensible web socket server built upon em-websockets.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<optitron>, ["~> 0.2"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.4"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12"])
+      s.add_runtime_dependency(%q<em-websocket>, [">= 0.1.4"])
+      s.add_runtime_dependency(%q<logging>, ["~> 1.4"])
+      s.add_runtime_dependency(%q<daemons>, ["~> 1.1"])
+      s.add_runtime_dependency(%q<konfigurator>, [">= 0.1.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9"])
+    else
+      s.add_dependency(%q<optitron>, ["~> 0.2"])
+      s.add_dependency(%q<json>, ["~> 1.4"])
+      s.add_dependency(%q<eventmachine>, [">= 0.12"])
+      s.add_dependency(%q<em-websocket>, [">= 0.1.4"])
+      s.add_dependency(%q<logging>, ["~> 1.4"])
+      s.add_dependency(%q<daemons>, ["~> 1.1"])
+      s.add_dependency(%q<konfigurator>, [">= 0.1.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_dependency(%q<mocha>, ["~> 0.9"])
+    end
+  else
+    s.add_dependency(%q<optitron>, ["~> 0.2"])
+    s.add_dependency(%q<json>, ["~> 1.4"])
+    s.add_dependency(%q<eventmachine>, [">= 0.12"])
+    s.add_dependency(%q<em-websocket>, [">= 0.1.4"])
+    s.add_dependency(%q<logging>, ["~> 1.4"])
+    s.add_dependency(%q<daemons>, ["~> 1.1"])
+    s.add_dependency(%q<konfigurator>, [">= 0.1.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+    s.add_dependency(%q<mocha>, ["~> 0.9"])
+  end
+end
+

data/spec/apps_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Rocket::Server::App do
+  subject do 
+    Rocket::Server.expects(:apps).returns({"test-app" => {"secret" => "my-secret"}})
+    Rocket::Server::App
+  end
+  
+  describe ".all" do
+    it "should return list of all registered apps" do
+      all = subject.all
+      all.should have(1).item
+      all.first.id.should == "test-app"
+    end
+  end
+  
+  describe ".find" do
+    context "when there is app with given id" do
+      it "should return it" do
+        app = subject.find("test-app")
+        app.should be
+        app.id.should == "test-app"
+      end
+    end
+    
+    context "when there is no app with given id" do
+      it "should raise error" do
+        expect { subject.find("no-such-app") }.to raise_error(Rocket::Server::App::NotFoundError)
+      end
+    end
+  end
+  
+  describe "instance" do
+    subject do
+      Rocket::Server::App.new(@attrs = {"id" => "test", "secret" => "my-secret"})
+    end
+
+    describe "#id" do
+      it "should return app identifier" do
+        subject.id.should == "test"
+      end
+    end
+    
+    describe "#initialize" do
+      it "should set given attributes" do
+        subject.attributes.should == @attrs
+      end
+    end
+    
+    it "should redirect missing methods to attibutes" do
+      subject.secret.should == "my-secret"
+    end
+  end
+end

data/spec/channel_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Rocket::Server::Channel do
+  subject do
+    Rocket::Server::Channel
+  end
+  
+  describe ".[]" do
+    context "when given channel doesn't exist" do
+      it "should create it and return" do
+        subject.channels.replace({})
+        channel = subject["my-app" => "my-channel"]
+        channel.should be_kind_of subject
+        subject.channels[["my-app", "my-channel"]].should == channel
+      end
+    end
+    
+    context "when given channel exists" do
+      it "should return it" do
+        subject["my-second-app" => "my-channel"]
+        subject["my-second-app" => "my-channel"].should == subject.channels[["my-second-app", "my-channel"]]
+      end
+    end
+  end
+  
+  describe ".channels" do
+    it "should keep list of registered channels" do
+      subject.channels.should have(2).items
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Rocket::Server::CLI do
+  subject do
+    Rocket::Server::CLI
+  end
+
+  describe "#start" do
+    it "should properly start server" do
+      out, err = capture_output {
+        mock_server = mock(:start! => true)
+        Rocket::Server.expects(:load_settings).with('test.yml', {
+          :verbose => false, :debug => false, :secure => false, :quiet => false, 
+          :pid => '/var/run/rocket/server.pid', :daemon => false, :host => 'localhost', 
+          :plugins => [], :port => 9772, :help => false
+        }).returns(true)
+        Rocket::Server::Runner.expects(:new).returns(mock_server)
+        subject.dispatch(%w[start -c test.yml])
+      }
+    end
+  end
+  
+  describe "#stop" do
+    context "when proper pidfile given" do
+      it "should kill that process" do
+        out, err = capture_output {
+          mock_server = mock(:kill! => 123)
+          Rocket::Server.expects(:load_settings).with('test.yml', :pid => 'test.pid', :help => false).returns(true)
+          Rocket::Server::Runner.expects(:new).returns(mock_server)
+          subject.dispatch(%w[stop -c test.yml -P test.pid])
+        }
+        out.should == "Rocket server killed (PID: 123)\n"
+      end
+    end
+    
+    context "when invalid pid given" do
+      it "should do nothing" do
+        out, err = capture_output {
+          mock_server = mock(:kill! => false)
+          Rocket::Server.expects(:load_settings).with('test.yml', :pid => 'test.pid', :help => false).returns(true)
+          Rocket::Server::Runner.expects(:new).returns(mock_server)
+          subject.dispatch(%w[stop -c test.yml -P test.pid])
+        }
+        out.should == "No processes were killed!\n"
+      end
+    end
+  end
+  
+  describe "#version" do
+    it "should display current version of Rocket::Server server" do
+      capture_output { subject.dispatch(%w[version]) }
+    end
+  end
+  
+  describe "#configure" do
+    context "when no file name given" do
+      it "should create rocket.yml file in current directory" do
+        capture_output {
+          begin
+            fname = File.join(Dir.pwd, "rocket.yml")
+            subject.dispatch(%w[configure])
+            File.should be_exist(fname)
+          ensure
+            FileUtils.rm_rf(fname)
+          end
+        }
+      end
+    end
+    
+    context "when file name given" do
+      it "should create it" do
+        capture_output {
+          begin
+            fname = File.join(Dir.pwd, "tmp/test.yml")
+            FileUtils.mkdir_p(File.dirname(fname))
+            subject.dispatch(%w[configure tmp/test.yml])
+            File.should be_exist(fname)
+          ensure
+            FileUtils.rm_rf(File.dirname(fname))
+          end
+        }
+      end
+    end
+  end
+end