stompserver_ng 1.0.6

data/History.txt

@@ -0,0 +1,159 @@
+== 1.0.6 / 21 Apr 2011
+
+* Change tests to use 'publish' not 'send'
+* Fix broken tests under Ruby 1.9.1p180
+* Handle subscriptions when 'id' header is specified
+
+== 1.0.5 / 14 Mar 2011
+
+* Correct exception during unsubscribe
+* Replace 'hoe' with 'jeweler'
+
+== 1.0.4 / 24 Dec 2010
+
+* Use EM::epoll if available
+* Refactor, remove unused methods
+* Refactor, move recognizer and monitor to separate files
+* Use hanna style docs only if hanna is present
+* Smoke tested under Ruby 1.9.2p80 (2010-12-02 revision 30049) [i686-linux]
+
+== 1.0.3 / 01 Jun 2010
+
+* Add tested support for activerecord message stores with examples.
+* Limit log message size for 'large' messages.
+* Clarify some documentation.
+* Add more publish / receive tests, remove duplicate tests.
+* Update manifest with new file names.
+* Update gemspec with new file names.
+
+== 1.0.2 / 14 May 2010
+
+* Continue to fix incompatabilities uncovered with gem rename.
+* Add session IDs to all log messages.
+* Remove some duplicate tests.
+
+== 1.0.1 / 25 Apr 2010
+
+* Ensure stompserver_ng and the older stompserver gems can coexist.
+
+== 1.0.0 / 24 Apr 2010
+
+* Rename the ruby gem.
+* Start new versioning methodology.
+
+== 0.9.9.2010.01.15.00 / 15 Jan 2010
+
+* Refactor and correct tests.
+* Correct lead sequence of config files.
+* Fix send receipt sequencing bug
+* Fix exceptions with no config file command line overide
+* Fix problems with sysvinit script
+* Change some messages to warn level
+
+== 0.9.9.2010.01.08.00 / 08 Jan 2010
+
+* Override server and/or port from tests.
+* Fix one more 1.9 compatability issue during shutdown.
+* Fix counts reported by monitor with ack => client.
+
+== 0.9.9.2010.01.02.00 / 02 Jan 2010
+
+* Fix server crashes when no ACK received.
+* Tests for same.
+* Handle SIGTERM.
+
+== 0.9.9.2010.01.01.00 / 01 Jan 2010
+
+* 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.
+
+== 0.9.9.2009.12.27.00 / 27 Dec 2009
+
+* Add session ID management
+* Refactor stomp protocol class code
+
+== 0.9.9.2009.12.25.00 / 25 Dec 2009
+
+* Consolidate start messaging to a single class
+* Log all runtime values
+* Eliminate r19 subdirectory artifacts 
+* Remove -d / --debug as the default for the test server
+* Remove references to $DEBUG in the protocol handler
+
+== 0.9.9.2009.12.21.00 / 21 Dec 2009
+
+* Fix 1.9.0 compatability issues
+* Event machine dependency is 0.12.0
+* Fix mismatches between command line and configuration file parameters
+
+== 0.9.9.2009121900 / 19 Dec 2009
+
+* Ruby 1.9 compatability
+* Use standard ruby logger instead of puts
+
+== 0.9.9 / 31 Jan 2008
+
+* Fix for non-memory backends with empty queues
+* Fix for queue monitoring
+* Use atomic checkpoint, write to a new file and then rename it into
+  place to avoid incomplete qinfo files being written
+* add configuration parameter for checkpoint time for better performance
+  with large queues
+
+== 0.9.8 / 16 Aug 2007
+
+* Several storage backends instead of Madeleine (allow tradeoffs between
+  robustness with ActiveRecord and speed with memory with intermediary
+  solutions based on file or dbm storages).
+* Better load distribution between clients acknowledging messages after
+  processing them.
+* Monitoring support through a dedicated queue.
+
+== 0.9.5 / 18 Oct 2006
+
+* Removed eventmachine dependency in the gem
+  you still need eventmachine, but you can choose between
+  eventmachine and eventmachine-win32, not sure how to put 
+  that in the gem.
+  
+  Also made another minor fix to the stompserver binary.
+
+== 0.9.4 / 17 Oct 2006
+
+* Cleanup (wow I was tired last night)
+  * Tested under Linux, added require 'rubygems' 
+  * Fixed stompserver binary - it now works and takes a few simple command args
+  * Fixed up minor (tesly) test syntax issues
+
+== 0.9.3 / 16 Oct 2006
+
+* Last one tonight I promise
+  * Fixed incorrect gem requirement version on eventmachine
+  * Fixed stompserver cmd added by gem
+
+== 0.9.2 / 16 Oct 2006
+
+* More Queue issues resolved
+  * Added more unit tests
+  * All tests pass
+  * Queue processing done in one large batch, this may change
+
+== 0.9.1 / 16 Oct 2006
+
+* Stepping along
+  * Fixed release issues
+  * Fixed queue logic error (failed to detect offlines)
+
+== 0.9.0 / 16 Oct 2006
+
+* Initialial Beta Release
+  * Seems to work
+  * Passes numerous test cases
+  * Journals using madeleine
+  * Needs documentaion
+  * Needs to command line processing
+  * Needs service/daemon options4
+

data/Manifest.txt

@@ -0,0 +1,71 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+STATUS
+bin/stompserver_ng
+client/README.txt
+client/both.rb
+client/consume.rb
+client/send.rb
+config/stompserver_ng.conf
+etc/19xcompat/notes.txt
+etc/arutils/README-activerecord.txt
+etc/arutils/cre_mysql.rb
+etc/arutils/cre_postgres.rb
+etc/arutils/cre_sqlite3.rb
+etc/arutils/mysql_boot.sql
+etc/arutils/postgres_boot.sql
+etc/database.mysql.yml
+etc/database.postgres.yml
+etc/passwd.example
+etc/ppqinfo.rb
+etc/runserver.sh
+etc/stompserver_ng
+etc/stompserver_ng.conf
+lib/stomp_server_ng.rb
+lib/stomp_server_ng/protocols/http.rb
+lib/stomp_server_ng/protocols/stomp.rb
+lib/stomp_server_ng/qmonitor.rb
+lib/stomp_server_ng/queue.rb
+lib/stomp_server_ng/queue/activerecord_queue.rb
+lib/stomp_server_ng/queue/ar_message.rb
+lib/stomp_server_ng/queue/ar_reconnect.rb
+lib/stomp_server_ng/queue/dbm_queue.rb
+lib/stomp_server_ng/queue/file_queue.rb
+lib/stomp_server_ng/queue/memory_queue.rb
+lib/stomp_server_ng/queue_manager.rb
+lib/stomp_server_ng/stomp_auth.rb
+lib/stomp_server_ng/stomp_frame.rb
+lib/stomp_server_ng/stomp_frame_recognizer.rb
+lib/stomp_server_ng/stomp_id.rb
+lib/stomp_server_ng/stomp_user.rb
+lib/stomp_server_ng/test_server.rb
+lib/stomp_server_ng/topic_manager.rb
+setup.rb
+stompserver_ng.gemspec
+test/devserver/props.yaml
+test/devserver/runserver.sh
+test/devserver/stompserver_ng.dbm.conf
+test/devserver/stompserver_ng.file.conf
+test/devserver/stompserver_ng.memory.conf
+test/noserver/mocklogger.rb
+test/noserver/test_queue_manager.rb
+test/noserver/test_stomp_frame.rb
+test/noserver/test_topic_manager.rb
+test/noserver/ts_all_no_server.rb
+test/props.yaml
+test/runalltests.sh
+test/runtest.sh
+test/test_0000_base.rb
+test/test_0001_conn.rb
+test/test_0002_conn_sr.rb
+test/test_0006_client.rb
+test/test_0011_send_recv.rb
+test/test_0015_ack_conn.rb
+test/test_0017_ack_client.rb
+test/test_0019_ack_no_ack.rb
+test/test_0022_ack_noack_conn.rb
+test/test_0030_subscr_id.rb
+test/test_0040_receipt_conn.rb
+test/ts_all_server.rb

data/README.txt

@@ -0,0 +1,172 @@
+== DESCRIPTION:
+
+Stomp messaging server with file/dbm/memory/activerecord based FIFO
+queues, queue monitoring, and basic authentication.
+
+== SYNOPSYS:
+
+Handles basic message queue processing
+
+== REQUIREMENTS:
+
+* EventMachine
+
+== FEATURES/PROBLEMS:
+
+=== Several queue storage backends
+
+Handles basic message queue processing using memory, file, or dbm
+based queues. Messages are sent and consumed in FIFO order (unless a
+client error happens, this should be corrected in the future). Topics
+are memory-only storage.  You can select activerecord, file or dbm
+storage and the queues will use that, but topics will only be stored
+in memory.
+
+memory queues are of course the fastest ones but shouldn't be used if
+you want to ensure all messages are delivered.
+
+dbm queues will use berkeleydb if available, otherwise dbm or gdbm
+depending on the platform. sdbm does not work well with marshalled
+data. Note that these queues have not been tested in this release.
+
+For the file based storage, each frame is stored in a single file. The
+first 8 bytes contains the header length, the next 8 bytes contains
+the body length, then the headers are stored as a marshalled object
+followed by the body stored as a string. This storage is currently
+inefficient because queues are stored separately from messages, which
+forces a double write for data safety reasons on each message stored.
+
+The activerecord based storage expects to find a database.yml file in
+the configuration directory. It should be the most robust backend, but
+the slowest one. The database must have an ar_messages table which can
+be created with the following code (you are responsible to do so):
+
+  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
+
+You can read the frames with this model:
+
+  class ArMessage < ActiveRecord::Base
+    serialize :frame
+  end
+
+The ar_message implementation will certainly change in the future.
+
+This is meant to be easily readable by a Rails application (which
+could handle the ar_messages table creation with a migration).
+
+=== Limitations
+
+Stompserver not support any server to server messaging (although you could
+write a client to do this).
+
+=== Monitoring
+
+Queues can be monitored via the monitor queue (this will probably not
+be supported this way in the future to avoid polluting the queue
+namespace). If you subscribe to /queue/monitor, you will receive a
+status message every 5 seconds that displays each queue, it's size,
+frames enqueued, and frames dequeued. Stats are sent in the same
+format of stomp headers, so they are easy to parse. Following is an
+example of a status message containing stats for 2 queues:
+
+Queue: /queue/client2
+size: 0
+dequeued: 400
+enqueued: 400
+
+Queue: /queue/test
+size: 50
+dequeued: 250
+enqueued: 300
+
+=== Access control
+
+Basic client authorization is also supported.  If the -a flag is
+passed to stompserver_ng on startup, and a .passwd file exists in the run
+directory, then clients will be required to provide a valid login and
+passcode.  See passwd.example for the password file format.
+
+=== Misc
+
+Whenever you stop the server, any queues with no messages will be
+removed, and the stats for that queue will be reset.  If the queue has
+any messages remaining then the stats will be saved and available on
+the next restart.
+
+== INSTALL:
+
+* gem install stompserver_ng
+
+stompserver_ng will create a log, etc, and storage directory on startup
+in your current working directory, the value passed to as
+--working_dir parameter, or if using a config file it will
+use what you specified for working_dir.  The configuration file is a
+yaml file and can be specified on the command line with -C
+<configfile>. A sample is provided in config/stompserver.conf.
+
+Command line options will override options set in the yaml config
+file.
+
+To use the memory queue run as follows:
+  stompserver_ng -p 61613 -b 0.0.0.0
+
+To use the file or dbm queue storage, use the -q switch and specificy
+either file or dbm.  The file and dbm queues also take a storage
+directory specified with -s.  .stompserver is the default directory if
+-s is not used.
+  stompserver_ng -p 61613 -b 0.0.0.0 -q file -s .stompfile
+Or
+  stompserver_ng -p 61613 -b 0.0.0.0 -q dbm -s .stompbdb
+
+To specify where the queue is stored on disk, use the -s flag followed
+by a storage directory.  To enable client authorization use -a, for
+debugging use -d.
+  stompserver_ng -p 61613 -b 0.0.0.0 -q file -s .stompserver -a -d
+
+You cannot use the same storage directory for a file and dbm queue,
+they must be kept separate.
+
+To use the activerecord queue storage use -q activerecord:
+  stompserver_ng -p 61613 -b 0.0.0.0 -q activerecord
+It will try to read the etc/database.yml file in the working
+directory. Here's an example of a database.yml for a PostgreSQL
+database named stompserver on the 'dbserver' host usable by
+PostgreSQL's user 'foo' with password 'bar'(see ActiveRecord's
+documentation for the parameters needed by your database):
+
+  adapter: postgresql
+  database: stompserver
+  username: foo
+  password: bar
+  host: dbserver
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2006 Patrick Hurley
+Copyright (c) 2007 Lionel Bouton
+
+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,38 @@
+# -*- ruby -*-
+#
+require 'rubygems'
+$LOAD_PATH << "./lib"
+require 'stomp_server_ng'
+#
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stompserver_ng"
+    gem.version = StompServer::VERSION
+    gem.summary = 'A very light messaging server, next generation'
+    gem.description = 'STOMP Next Generation Ruby server.'
+    gem.homepage = 'http://github.com/gmallard/stompserver_ng'
+    gem.authors = ["Patrick Hurley",
+      "Lionel Bouton",
+      "snacktime",
+      "gyver",
+      "Mike Mangino",
+      "robl",
+      "gmallard" ]
+    gem.email = ["phurley-blocked@rubyforge.org",
+      "lionel-dev@bouton.name",
+      "snacktime@somewhere.com",
+      "gyver@somewhere.com",
+      "mmangino-blocked@rubyforge.org",
+      "robl@monkeyhelper.com",
+      "allard.guy.m@gmail.com" ]
+    #
+    gem.add_dependency "daemons", ">= 1.0.10"
+    gem.add_dependency "eventmachine", ">= 0.12.10"
+    gem.add_dependency "uuid", ">= 2.1.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/STATUS

@@ -0,0 +1,5 @@
+
+- Unit tests are broken, need to override methods that call EM 
+- Added http protocol handler.  No pipelining or anything fancy, just PUT/GET requests which enqueue/dequeue messages from
+  the queue one at a time.  Uses the Mongrel http parser.
+