stompserver_ng 1.0.6

data/bin/stompserver_ng

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'etc'
+require 'yaml'
+require 'daemons/daemonize'
+require 'stomp_server_ng'
+require 'optparse'
+require 'logger'
+
+$STOMP_SERVER = true
+
+$HTTP_ENABLE = false
+if $HTTP_ENABLE
+  require 'mongrel'
+  require 'stomp_server/protocols/http'
+end
+#
+# Use epoll if available.
+#
+EventMachine::epoll
+#
+# Run.
+#
+EventMachine::run do
+
+  ## Get the configuration and initialize the stomp engine
+  config = StompServer::Configurator.new
+  stomp = StompServer::Run.new(config.opts)
+  stomp.start
+
+  log = Logger.new(STDOUT)
+  log.level = Logger::DEBUG
+
+  # Might want to uncomment this if you are sending large files
+  #EventMachine::add_periodic_timer 10, proc {GC.start}
+  
+  log.debug "Client authorization enabled" if config.opts[:auth]
+
+  ## Start protocol handlers
+
+  log.debug "Stomp protocol handler starting on #{config.opts[:host]} port #{config.opts[:port]}"
+  EventMachine.start_server(config.opts[:host], 
+      config.opts[:port], 
+      StompServer::Protocols::Stomp, 
+        stomp.auth_required,    # *args: arg[0] 
+        stomp.queue_manager,    # *args: arg[1] 
+        stomp.topic_manager,    # *args: arg[2] 
+        stomp.stompauth,        # *args: arg[3] 
+        config.opts             # Options hash
+      )
+
+  # TODO: any http testing and protocol handler changes required.
+  if $HTTP_ENABLE
+    log.debug "Http protocol handler starting on #{config.opts[:host]} port 8080"
+    EventMachine.start_server(config.opts[:host], 8080, StompServer::Protocols::Http) {|s| s.instance_eval {
+        @@auth_required=stomp.auth_required
+        @@queue_manager=stomp.queue_manager
+        @@topic_manager=stomp.topic_manager
+        @@stompauth = stomp.stompauth
+      }
+    }
+  end
+end

data/client/README.txt

@@ -0,0 +1 @@
+Samples of how to use the ruby stomp client with stompserver

data/client/both.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'stomp'
+client = Stomp::Client.open "login", "passcode", "localhost", 61613
+
+client.subscribe("/queue/client2", {
+              "persistent" => true,
+              "ack" => 'client',
+              "client-id" => "rubyClient",
+        } ) do |message|
+  puts "Got Reply: #{message.headers['message-id']} - #{message.body} on #{message.headers['destination']}"
+end
+
+for i in 1..5 do
+   m = "Go Sox #{i}!"
+   puts m
+   client.send("/queue/client2", m, {
+    "persistent" => true,
+    "priority" => 4,
+    "reply-to" => "/queue/client2",
+    }
+  )
+end
+
+gets
+client.close

data/client/consume.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'stomp'
+client = Stomp::Client.open "login", "passcode", "localhost", 61613
+
+client.subscribe("/queue/test", {
+                "persistent" => true,
+                "client-id" => "rubyClient",
+        } ) do |message|
+  puts "Got Reply: ID=#{message.headers['message-id']} BODY=#{message.body} on #{message.headers['destination']}"
+end
+
+
+gets
+client.close

data/client/send.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'stomp'
+client = Stomp::Client.open "login", "passcode", "localhost", 61613
+
+# sending 5 messages at once
+for i in 1..5 do
+   m = "Go Sox #{i}!"
+   puts m
+   client.send("/queue/test", m, {
+    "persistent" => true,
+    "client-id" => "Client1",
+    "reply-to" => "/queue/test",
+    }
+  )
+end
+
+client.close

data/config/stompserver_ng.conf

@@ -0,0 +1,11 @@
+---
+:daemon: false
+:working_dir: /tmp/stompserver
+:storage: .queue
+:queue: file
+:auth: false
+:debug: false
+:group:
+:user:
+:host: 127.0.0.1
+:port: 61613

data/etc/19xcompat/notes.txt

@@ -0,0 +1,223 @@
+#
+# == Ruby 1.9.x Testing Activities Log
+#
+# The reader should absorb this sequentially.  The text is a rough 
+# chronological depiction of events for these activities.
+#
+# === Assumptions
+#
+# * $PH=project_home_directory
+# * Commands are issued from the project home directory
+# * No attempt is made to support 'tesly' functionality
+#
+# === Server Start
+#
+# * Modify $PH/test/runserver.sh as required
+# * ./test/runserver.sh
+#
+# === Verify/Deny Existing Tests Functionality
+#
+# Verify/deny that the existing tests run.  These are:
+#
+# ==== $PH/test/test_queue_manager.rb
+#
+# To execute use one of these commands:
+#
+# * ./test/runtest.sh test/test_queue_manager.rb
+# * ruby -I $(pwd)/lib test/test_queue_manager.rb
+#
+# ==== $PH/test/test_stomp_frame.rb
+#
+# To execute use one of these commands:
+#
+# * ./test/runtest.sh test/test_stomp_frame.rb
+# * ruby -I $(pwd)/lib test/test_stomp_frame.rb
+#
+# ==== $PH/test/test_topic_manager.rb
+#
+# To execute use one of these commands:
+#
+# * ./test/runtest.sh test/test_topic_manager.rb
+# * ruby -I $(pwd)/lib test/test_topic_manager.rb
+#
+# ==== Results
+#
+# Note: first verify that these actually run under 
+# ruby 1.8.7 (2009-06-12 patchlevel 174) [i486-linux].  They do.
+#
+# All three of these tests encountered errors with 
+# ruby 1.9.1p243 (2009-07-16 revision 24175) [i486-linux].
+#
+# * test_queue_manager.rb
+# ** TypeError: can't convert Fixnum into String
+# ** lib/stomp_server/stomp_frame.rb:13:in `include?'
+# * test_stomp_frame.rb
+# ** TypeError: type mismatch: Fixnum given
+# ** lib/stomp_server/stomp_frame.rb:54:in `index'
+# * test_topic_manager.rb
+# ** test_sendmsg(TestTopics):
+# ** ArgumentError: wrong number of arguments (0 for 1)
+#
+# ==== Fixes
+#
+# <b>test_queue_manager</b>
+#
+# * Added logging to the test
+# * Changes to stomp_frame.rb to properly compare single characters or locate single characters in a string.
+#
+# <b>test_stomp_frame</b>
+#
+# * Added logging to the test
+# * Changes to stomp_frame.rb to properly compare single characters or locate single characters in a string.
+#
+# <b>test_topic_manager</b>
+#
+# * Added logging to the test
+# * Remove unused and unrequired method parameter
+#
+# -----
+#
+# During the attempt to add robust logging to the server code, it was 
+# eventaully recognized that:
+#
+# * the existing tests do not even require a stompserver to be running
+# * some experimental but sound logging code then broke even existing tests with ruby 1.8
+#
+# Why the breakage?  Because the existing tests do not use a running server,
+# instead including portions of server code.
+#
+# This leads to the following sections.
+#
+# == Logging Using Standard Ruby 'logger'
+#
+# Initial attempts to implement this across the framework broke horribly.
+# Additionally, even the existing tests failed under ruby 1.8.
+#
+# The initial goal of this phase was to execute the existing tests with:
+#
+# * Initial changes to the framework required for adding logging.
+# * Successful test execution under ruby 1.8.
+#
+# This phase of changes was eventually completed.
+#
+# == Existing Tests and Ruby Version Compatability Summary
+#
+# After the work described briefly above, the existing tests function on:
+#
+# * ruby 1.8.7 (2009-06-12 patchlevel 174) [i486-linux]
+# * ruby 1.9.0 (2008-10-04 revision 19669) [i486-linux]
+# * ruby 1.9.1p243 (2009-07-16 revision 24175) [i486-linux]
+#
+# Again, note that these tests do _not_ use a running stompserver, but
+# use mock objects to drive the testing.
+#
+# == Further Testing
+#
+# This section describes further testing of the stompserver framework.
+#
+# The requirements for running the tests described here are:
+#
+# * a running instance of a stompserver
+# * the server host and port match those specified in <b>props.yaml</b>
+#
+# === Connect and Disconnect Processing
+#
+# Run the following test:
+#
+# * ruby test/test_0001_conn.rb
+#
+# === Connect and Disconnect With Send and Receive
+#
+# Run the following test:
+#
+# * ruby test/test_0002_conn_sr.rb
+#
+# === Stomp Client Creation
+#
+# Run the following test:
+#
+# * ruby test/test_0006_client.rb
+#
+# === Basic Send / Receive Test
+#
+# Run the following test:
+#
+# * ruby test/test_0011_send_recv.rb
+#
+# === Informal Client Testing
+#
+# Informal testing using the code at git://github.com/gmallard/stomp-demo.git
+# indicate that the server basically functions using ruby 1.9.1.
+#
+# == Gem Build
+#
+# The gem build process now works, after fixing the _Rakefile_ properly.
+#
+# The _stompserver.gemspec_ file has been updated to use Hoe::spec rather
+# than Hoe::new, per deprecation warnings.
+#
+# To generate a new gemspec file use:
+#
+# * rake debug_gem > stompserver.gemspec
+#
+# To generate the gem use:
+#
+# * rake gem
+#
+# === Gem Todo List
+#
+# Installs on all local ruby versions is complete, with VERSION
+# 0.9.9.2009.12.21.00.
+#
+# == More Test Information
+#
+# === Tests Which Require a Server
+#
+# * ruby test/ts_all_server.rb
+#
+# === Tests Which No Not Require a Server
+#
+# When running these tests it is <b>important</b> to use the 
+# '-I $(pwd)/lib' ruby parameter.  This insures that local code
+# only will be used for the tests.
+#
+# * ruby -I $(pwd)/lib test/ts_all_no_server.rb
+#
+# == Todo List
+#
+# * More unit tests (in progress)
+# * More documentation (in progress)
+# * Build gem (see above) :DONE
+# * Install gem (see above) :DONE
+# * Full testing using 1.9.0 :DONE
+# * Full regression testing using 1.8.7 :DONE
+# * Everyting with the HTTP protocol handler.
+#
+# == Required Gems
+#
+# Required gems are:
+#
+# * ["daemons", ">= 1.0.10"]
+# * ["eventmachine", ">= 0.12.10"]
+# * ["hoe", ">= 2.3.2"]
+# * ["uuid", ">= 2.1.0"]
+#
+# == Version 0.9.9.2010.01.01.00
+#
+# * Some fixes for 'ack' => 'client' processing.  The first step down this road.
+# * Tests for same.  Tests are intermittently unstable due to previously unseen problems.
+# * Some fixes around session ID cache handling.
+# * Cleaner creation of the .pid file at startup.
+# * Sample sysvinit boot scripts - very primitive.
+#
+# == Version 0.9.9.2010.01.02.00
+#
+# * Fix server crashes when no ACK received.
+# * Tests for same.
+# * Handle SIGTERM.
+#
+# == Future Updates
+#
+# For updates after the previous version see the History.txt file.
+#
+

data/etc/arutils/README-activerecord.txt

@@ -0,0 +1,78 @@
+
+= Activerecord Notes
+
+== Current Support
+
+Support is provided activerecord messages stores using:
+
+* sqlite3
+* mysql
+* postgresql
+
+== Using An Activerecord Message Store
+
+In order to use activerecord, you _must_ preinitialize:
+
+* a data base
+* a data base user
+* a table named 'ar_messages'
+
+Samples are provided with the stompserver_ng installation.
+
+See:
+
+* this document
+* etc/arutils/mysql_boot.sql
+* etc/arutils/postgres_boot.sql
+* etc/arutils/cre_sqlite3.rb
+* etc/arutils/cre_mysql.rb
+* etc/arutils/cre_postgres.rb
+
+To use either mysql or postgres, you must supply a user coded connection
+definition in a yaml file.  This file has the same format as db definitions
+in Rails projects.
+
+You can specify activerecord use by either:
+
+* the main stompserver_ng configuration file
+* :queue: activerecord
+* command line option when stompserver_ng starts
+* -q activerecord
+* --queuetype=activerecord
+
+== Default Activerecord Environment
+
+If an activerecord message store is specified by configuration, and no
+overriding connection parameters are specified, the default implementation
+is sqlite3. (Note: even in this case, the data base must be predefined and
+initialized.)
+
+The default sqlite3 data base must:
+
+* exist in the runtime 'etc' directory
+* be named 'stompserver_development'
+
+== Overriding Connection Parameters
+
+Override connection parameters in order to use a data base other than
+the default.
+
+You can override activerecord connection parameters by either:
+
+* the main stompserver_ng configuration file
+* :dbyml: some/directory/mydb.yml
+* command line option when stompserver_ng starts
+* -y some/directory/mydb.yml
+* --dbyml=some/directory/mydb.yml
+
+== Activerecord Support
+
+stompserver_ng has been tested with:
+
+* sqlite3
+* mysql
+* postgresql
+
+Support for other database systems used by activerecord is left as an
+exercise for the reader.
+

data/etc/arutils/cre_mysql.rb

@@ -0,0 +1,34 @@
+require 'rubygems' if RUBY_VERSION =~ /1.8/
+require 'active_record'
+#
+# = cre_mysql - create a mysql data base for use by stompserver_ng
+#
+# For now, the db parameters are hard coded.  Change as required.
+#
+db_params = {
+  'adapter' =>  'mysql',
+  'encoding' =>  'utf8',
+  'database' =>  'ssng_dev',
+  'pool' => 5,
+  'username' => 'ssng',
+  'password' => 'xxxxxxxx',
+  'host' => 'localhost',
+  'port' => 3306
+
+}
+#
+# Connect.
+#
+ActiveRecord::Base.establish_connection(db_params)
+puts "mysql Connection complete."
+#
+# Define the ar_messages table.
+#
+ActiveRecord::Schema.define do
+  create_table 'ar_messages' do |t|
+    t.column 'stomp_id', :string, :null => false
+    t.column 'frame', :text, :null => false
+  end
+end
+puts "mysql table create complete."
+