stomper 0.3.0

data/AUTHORS

@@ -0,0 +1,21 @@
+Stomper authors:
+Ian D. Eccles
+
+
+Stomper was initially a fork of the Stomp Ruby Gem.  Though it
+no longer has a compatible interface with the Stomp gem, and shares
+no common code with it, the Stomp contributors are listed below in
+recognition of their influence on Stomper.  Note: these authors have
+not contributed to the Stomper project, nor are they in any way responsible
+for this project.  Please do not contact them with questions regarding Stomper.
+
+The following people have contributed to Stomp (ordered by commits):
+
+Brian McCaliister
+Glenn Rempe <glenn@rempe.us>
+jstrachan 
+Marius Mathiesen <marius.mathiesen@gmail.com>
+Johan S√∏rensen <johan@johansorensen.com>
+kookster
+Tony Garnock-Jones <tonyg@lshift.net>
+chirino

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.2 2009-11-20
+
+* Officially moved to "stomper" library.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,68 @@
+=README
+
+Stomper is a library for connecting to and interacting with a message queue
+service that supports the {Stomp protocol}[http://stomp.codehaus.org/Protocol].
+Characteristics that distinguish it from other libraries, such the
+{stomp gem}[http://github.com/js/stomp], are:
+
+* Transaction blocks with {transaction blocks}[link:classes/Stomper/Client.html#M000066]
+* Playing nice with Apache ActiveMQ by being able to {disable automatic content-length generation}[link:classes/Stomper/Frames/ClientFrame.html#M000014]
+* A receiver thread that can be bypassed by something else! (whatever that means)
+
+== Example Usage
+
+    client = Stomper::Client.new("stomp://my_username:s3cr3tz@localhost:61613")
+    # Clients must be explicitly started to automatically receive incoming
+    # messages.
+    client.start
+
+    client.subscribe("/queue/hello") do |msg|
+      puts msg.body
+    end
+
+    # Send a simple message
+    client.send("/queue/hello", "hello world!")
+
+    # Send a message within a transaction.  This usage is new to stomper
+    # however, one can manually manage transactions as well.
+    client.transaction do |t|
+      t.send("/queue/hello", "a transactioned message")
+    end
+
+    # If the block provided to #transaction accepts a single parameter,
+    # the client yields the Transaction object to the block, otherwise
+    # the block is instance_eval'd within the Transaction object.
+    client.transaction do
+      send("/queue/hello", "a message you will never receive")
+      # Nested transactions, failures percolate up to parent transactions.
+      transaction do
+        send("/queue/hello", "because I am about to fail!")
+        raise "by forcing an error in a nested transaction"
+      end
+    end
+
+    # Later ...
+    client.stop
+    client.close
+
+== To-Do
+* Provide the `pipe` method on Stomper::Client
+* Allow SSL verification if requested (option :verify_ssl?)
+* Re-evaluate how to handle a 'reliable' connection.
+
+== License
+
+Stomper is released under the Apache License 2.0
+
+== Pointless Backstory
+
+Stomper began its life as a mere fork of the {Stomp}[http://github.com/js/stomp]
+gem.  However, as changes were made and desires grew, the fork began breaking
+API compatibility with the original gem, and thus Stomper was conceived.
+
+== Other Stuff
+
+Primary Author:: Ian D. Eccles
+Source Repository:: http://github.com/iande/stomper
+Current Version:: 0.2.0
+Last Updated:: 2009-12-11

data/lib/stomper.rb

@@ -0,0 +1,15 @@
+require 'uri'
+require 'io/wait'
+require 'socket'
+require 'thread'
+require 'monitor'
+require 'openssl'
+require 'stomper/frames'
+require 'stomper/connection'
+require 'stomper/transaction'
+require 'stomper/subscription'
+require 'stomper/subscriptions'
+require 'stomper/client'
+
+module Stomper
+end

data/lib/stomper/client.rb

@@ -0,0 +1,300 @@
+module Stomper
+  # A high-level representation of a connection to a Stomp message broker.
+  # Instances of Client can be shared safely between threads, all mutating
+  # methods should be properly synchronized.  Interactions with the stomp
+  # message broker through instances of Client are generally simpler than
+  # doing so through instances of Connection.  Client instances do not require
+  # the use of Stomper::Frames::ClientFrame objects to transmit and receive
+  # information, instead relying on specific method calls to do so.
+  #
+  # === Example Usage
+  #   client = Stomper::Client.new("stomp://localhost:61613")
+  #   client.start
+  #
+  #   client.subscribe("/queue/target1") do |msg|
+  #     puts "Received Message: #{msg.body}"
+  #   end
+  #
+  #   client.send("/queue/target1", "this is a test")
+  #   client.send("/queue/target1", "this persists", { :persistent => true })
+  #
+  #   client.transaction do |t1|
+  #     t1.send("/queue/target1", "this will never be seen")
+  #     raise "Forced Exception"
+  #   end
+  #
+  #   client.unsubscribe("/queue/target1")
+  #
+  #   client.stop
+  #   client.close
+  #
+  class Client
+    attr_reader :connection, :subscriptions
+
+    # Creates a new Client instance that will connect to the stomp broker
+    # designated by the +uri+ parameter.  Additionally, +options+ may be
+    # specified as a hash, and are passed along to the underlying connection.
+    # For details on the format of +uri+ and the acceptable +options+, see
+    # Stomper::Connection.
+    def initialize(uri, options={})
+      # At this time we only bother with the BasicConnection.  We will need
+      # to write the ReliableConnection class to handle the particulars of reconnecting
+      # on a socket error.
+      #if options.has_key?(:max_retries) || options.delete(:reliable) { false }
+        #@connection = ReliableConnection.new(uri, options)
+      #else
+        @connection = Connection.new(uri, options)
+      #end
+      @subscriptions = Subscriptions.new
+      @send_lock = Mutex.new
+      @receive_lock = Mutex.new
+      @run_thread = nil
+      @receiving = false
+      @receiver_lock = Mutex.new
+    end
+
+    # Sends a string message specified by +body+ to the appropriate stomp
+    # broker destination given by +destination+.  Additional headers for the
+    # message may be specified by the +headers+ hash where the key is the header
+    # property and the value is the corresponding property's value.  The
+    # keys of +headers+ may be symbols or strings.
+    #
+    # Examples:
+    #
+    #   client.send("/topic/whatever", "hello world")
+    #
+    #   client.send("/queue/some/destination", "hello world", { :persistent => true })
+    #
+    def send(destination, body, headers={})
+      transmit_frame(Stomper::Frames::Send.new(destination, body, headers))
+    end
+
+    # Acknowledge to the stomp broker that a given message was received.
+    # The +id_or_frame+ parameter may be either the message-id header of
+    # the received message, or an actual instance of Stomper::Frames::Message.
+    # Additional headers may be specified through the +headers+ hash.
+    #
+    # Examples:
+    #
+    #   client.ack(received_message)
+    #
+    #   client.ack("message-0001-00451-003031")
+    #
+    def ack(id_or_frame, headers={})
+      transmit_frame(Stomper::Frames::Ack.ack_for(id_or_frame, headers))
+    end
+
+    # Tells the stomp broker to commit a transaction named by the
+    # supplied +transaction_id+ parameter.  When used in conjunction with
+    # +begin+, and +abort+, a means for manually handling transactional
+    # message passing is provided.
+    #
+    # See Also: transaction
+    def commit(transaction_id)
+      transmit_frame(Stomper::Frames::Commit.new(transaction_id))
+    end
+
+    # Tells the stomp broker to abort a transaction named by the
+    # supplied +transaction_id+ parameter.  When used in conjunction with
+    # +begin+, and +commit+, a means for manually handling transactional
+    # message passing is provided.
+    #
+    # See Also: transaction
+    def abort(transaction_id)
+      transmit_frame(Stomper::Frames::Abort.new(transaction_id))
+    end
+
+    # Tells the stomp broker to begin a transaction named by the
+    # supplied +transaction_id+ parameter.  When used in conjunction with
+    # +commit+, and +abort+, a means for manually handling transactional
+    # message passing is provided.
+    #
+    # See also: transaction
+    def begin(transaction_id)
+      transmit_frame(Stomper::Frames::Begin.new(transaction_id))
+    end
+
+    # Creates a new Stomper::Transaction object and evaluates
+    # the supplied +block+ within a transactional context.  If
+    # the block executes successfully, the transaction is committed,
+    # otherwise it is aborted.  This method is meant to provide a less
+    # tedious approach to transactional messaging than the +begin+,
+    # +abort+ and +commit+ methods.
+    #
+    # See also: begin, commit, abort, Stomper::Transaction
+    def transaction(transaction_id=nil, &block)
+      begin
+        Stomper::Transaction.new(self, transaction_id, &block)
+      rescue Stomper::TransactionAborted
+        nil
+      end
+      self
+    end
+
+    # Subscribes to the specified +destination+, passing along
+    # the optional +headers+ inside the subscription frame.  When a message
+    # is received for this subscription, the supplied +block+ is
+    # called with the received message as its argument.
+    #
+    # Examples:
+    #
+    #   client.subscribe("/queue/test")  { |msg| puts "Got message: #{msg.body}" }
+    #
+    #   client.subscribe("/queue/test", :ack => 'client', 'id' => 'subscription-001') do |msg|
+    #     puts "Got message: #{msg.body}"
+    #   end
+    #
+    #   client.subscribe("/queue/test", :selector => 'cost > 5') do |msg|
+    #     puts "Got message: #{msg.body}"
+    #   end
+    #
+    # See also: unsubscribe, Stomper::Subscription
+    def subscribe(destination, headers={}, &block)
+      unless destination.is_a?(Subscription)
+        destination = Subscription.new(headers.merge(:destination => destination), &block)
+      end
+      @subscriptions << destination
+      transmit_frame(destination.to_subscribe)
+      self
+    end
+
+    # Unsubscribes from the specified +destination+.  The +destination+
+    # parameter may be either a string, such as "/queue/test", or Stomper::Subscription
+    # object.  If the optional +sub_id+ is supplied, the client will unsubscribe
+    # from the subscription with an id matching +sub_id+, regardless if the
+    # +destination+ parameter matches that of the registered subscription.  For
+    # this reason, it is vital that subscription ids, if manually specified, be
+    # unique.
+    #
+    # Examples:
+    #
+    #   client.unsubscribe("/queue/test")
+    #   # unsubscribes from all "naive" subscriptions for "/queue/test"
+    #
+    #   client.unsubscribe("/queue/does/not/matter", "sub-0013012031")
+    #   # unsubscribes from all subscriptions with id of "sub-0013012031"
+    #
+    #   client.unsubscribe(some_subscription)
+    #
+    # See also: subscribe, Stomper::Subscription
+    def unsubscribe(destination, sub_id=nil)
+      @subscriptions.remove(destination, sub_id).each do |unsub|
+        transmit_frame(unsub.to_unsubscribe)
+      end
+      self
+    end
+
+    # Starts the receiver for a Client instance.  This method
+    # must be manually invoked in order to receive frames sent
+    # by the stomp broker.  Be aware that a Client object's
+    # receiver runs in its own separate thread, and so may
+    # incur some performance penalties depending upon which
+    # Ruby environment this library is used with.  The receiver
+    # thread may be stopped by calling the +stop+ instance method.
+    #
+    # See also: stop, receiving?
+    def start
+      @connection.connect unless connected?
+      return self if receiving?
+      @receiver_lock.synchronize do
+        if @run_thread.nil?
+          @receiving = true
+          @run_thread = Thread.new do
+            while receiving?
+              #begin
+                receive
+              #rescue => err
+                #puts "Exception Caught: #{err.to_s}"
+                #break
+              #end
+            end
+          end
+        end
+      end
+      self
+    end
+
+    # Stops the receiver for a Client instance.  The methodology
+    # employed to stop the thread should be safe (it does not
+    # make use of Thread.kill)  It is also safe to +start+ and
+    # +stop+ the receiver thread multiple times, doing so does not
+    # interrupt the connection to the stomp broker under normal
+    # circumstances.  In the interest in proper performance, it is
+    # recommend that +stop+ be called when a Client instance is
+    # no longer needed (assuming the instance's receiver thread was
+    # started, of course.)
+    #
+    # See also: start, receiving?
+    def stop
+      return self unless receiving?
+      @receiver_lock.synchronize do
+        if receiving?
+          @receiving = false
+          @run_thread.join
+          @run_thread = nil
+        end
+      end
+      self
+    end
+
+    # Returns true if the receiver thread has been started
+    # by use of the +start+ command.  Otherwise, returns false.
+    #
+    # See also: start, stop
+    def receiving?
+      @receiving
+    end
+
+    # Receives the next available frame from the stomp broker, if
+    # one is available.  This method is regularly invoked by the
+    # receiver thread if it is created by the +start+ method; however,
+    # it may also be invoked manually if so desired, allowing one to
+    # by-pass the threaded implementation of receiving found in using
+    # +start+ and +stop+.  If the received frame is an instance of
+    # Stomper::Frames::Message, this method will invoke any subscriptions
+    # that are responsible for the message.
+    #
+    # Note: this method does not block under normal operation, as such
+    # +nil+ may be returned if there are no frames available from the
+    # stomp broker.
+    #
+    # See also: Stomper::Subscription
+    def receive
+      msg = @receive_lock.synchronize { @connection.receive }
+      @subscriptions.perform(msg) if msg.is_a?(Stomper::Frames::Message)
+      msg
+    end
+
+    # Toying with an idea, probably a very bad one!
+    def each # :nodoc:
+      while connected?
+        yield receive
+      end
+    end
+
+    # Returns true if the client is connected, false otherwise.
+    def connected?
+      @connection.connected?
+    end
+
+    # Disconnects from the stomp broker politely by first transmitting
+    # a Stomper::Frames::Disconnect frame to the broker.
+    def disconnect
+      @connection.disconnect
+    end
+
+    alias close disconnect
+
+    protected
+    # We need to synchronize frame tranmissions to one at a time.
+    # My suspicion is that write/puts socket methods are not atomic, so if a message
+    # is started then interrupted and a new message is attempted, it will
+    # result in either a broken connection or an inconsistent state of our
+    # system.
+    def transmit_frame(frame)
+      @send_lock.synchronize do
+        @connection.transmit(frame)
+      end
+    end
+  end
+end