onstomp 1.0.0pre1

data/onstomp.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "onstomp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "onstomp"
+  s.version     = OnStomp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ian D. Eccles"]
+  s.email       = ["ian.eccles@gmail.com"]
+  s.homepage    = "http://github.com/meadvillerb/onstomp"
+  s.summary     = %q{Client for message queues implementing the Stomp protocol interface.}
+  s.description = %q{Client library for message passing with brokers that support the Stomp protocol.}
+
+  s.rubyforge_project = "onstomp-core"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.required_ruby_version = '>= 1.8.7'
+  s.has_rdoc = 'yard'
+  s.add_development_dependency('rspec', '~> 2.4.0')
+  s.add_development_dependency('simplecov', '>= 0.3.0')
+  s.add_development_dependency('yard', '>= 0.6.0')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('bluecloth')
+end

data/spec/onstomp/client_spec.rb

@@ -0,0 +1,265 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+module OnStomp
+  describe Client do
+    let(:client_uri) { "stomp:///" }
+    let(:client_options) { Hash.new }
+    let(:client) {
+      Client.new client_uri, client_options
+    }
+    let(:processor) {
+      mock('processor')
+    }
+    let(:processor_class) {
+      mock('processor class', :new => processor)
+    }
+    let(:connection) {
+      mock('connection')
+    }
+    let(:frame) {
+      mock('frame')
+    }
+    let(:headers) {
+      mock('headers')
+    }
+    
+    let(:frame_method_interface) { client }
+    it_should_behave_like "frame method interfaces"
+    
+    describe "configuration" do
+      it "should provide some defaults" do
+        client.versions.should == ['1.0', '1.1']
+        client.host.should == 'localhost'
+        client.login.should == ''
+        client.passcode.should == ''
+        client.heartbeats.should == [0, 0]
+        client.processor.should == OnStomp::Components::ThreadedProcessor
+      end
+      it "should be configurable by options" do
+        client_options[:versions] = ['1.1']
+        client_options[:heartbeats] = [90, 110]
+        client_options[:host] = 'my broker host'
+        client_options[:login] = 'my login'
+        client_options[:passcode] = 'sup3r s3cr3t'
+        client_options[:processor] = processor_class
+        client_options[:ssl] = { :cert_path => '/path/to/certs' }
+        client.versions.should == ['1.1']
+        client.heartbeats.should == [90, 110]
+        client.host.should == 'my broker host'
+        client.login.should == 'my login'
+        client.passcode.should == 'sup3r s3cr3t'
+        client.processor.should == processor_class
+        client.ssl.should == { :cert_path => '/path/to/certs' }
+      end
+      it "should be configurable by query" do
+        client_uri << '?versions=1.0'
+        client_uri << '&heartbeats=80&heartbeats=210'
+        client_uri << '&host=query%20host'
+        client_uri << '&login=query%20login'
+        client_uri << '&passcode=qu3ry%20s3cr3t'
+        client_uri << '&processor=OnStomp::Connections'
+        client.versions.should == ['1.0']
+        client.heartbeats.should == [80, 210]
+        client.host.should == 'query host'
+        client.login.should == 'query login'
+        client.passcode.should == 'qu3ry s3cr3t'
+        client.processor.should == OnStomp::Connections
+      end
+      it "should be configurable through parts of the URI" do
+        client_uri.replace("stomp://uzer:s3cr3t@host.domain.tld")
+        client.host.should == 'host.domain.tld'
+        client.login.should == 'uzer'
+        client.passcode.should == 's3cr3t'
+      end
+      it "should prefer option hash over query over uri attributes" do
+        client_uri.replace("stomp://uzer:s3cr3t@host.domain.tld?host=query%20host&passcode=qu3ry%20s3cr3t&login=query%20login")
+        client_options[:login] = 'my login'
+        client.host.should == 'query host'
+        client.login.should == 'my login'
+        client.passcode.should == 'qu3ry s3cr3t'
+      end
+    end
+    
+    describe ".initialize" do
+      it "should initialize from a string uri" do
+        uri = Client.new('stomp://host.domain.tld:10101').uri
+        uri.should be_a_kind_of(::URI)
+        uri.host.should == 'host.domain.tld'
+        uri.port.should == 10101
+        uri.scheme.should == 'stomp'
+      end
+      it "should initialize with a URI uri" do
+        uri = ::URI.parse('stomp://host.domain.tld:10101')
+        Client.new(uri).uri.should == uri
+      end
+    end
+    
+    describe ".connect" do
+      let(:pending_events) {
+        mock('pending events')
+      }
+      before(:each) do
+        client.stub(:processor => processor_class)
+      end
+      it "should create a connection and start the processor" do
+        OnStomp::Connections.should_receive(:connect).with(client, headers,
+          { :'accept-version' => '1.1', :host => 'my host',
+            :'heart-beat' => '30,110', :login => 'my login',
+            :passcode => 's3cr3t' }, pending_events).and_return(connection)
+        processor.should_receive(:start)
+        client.stub(:pending_connection_events => pending_events)
+        client.versions = '1.1'
+        client.host = 'my host'
+        client.login = 'my login'
+        client.passcode = 's3cr3t'
+        client.heartbeats = [30,110]
+        client.connect(headers)
+        client.connection.should == connection
+      end
+    end
+    
+    describe ".disconnect_with_flush" do
+      before(:each) do
+        client.stub(:processor => processor_class)
+      end
+      it "should call disconnect_without_flush and join the processor" do
+        processor.should_receive(:join)
+        client.should_receive(:disconnect_without_flush).with(headers).and_return(frame)
+        client.disconnect_with_flush(headers).should == frame
+      end
+    end
+    
+    describe ".connected?" do
+      it "should not be connected if there is no connect" do
+        client.should_not be_connected
+      end
+      it "should not be connected if the connection is not connected" do
+        client.stub(:connection => connection)
+        connection.stub(:connected? => false)
+        client.should_not be_connected
+      end
+      it "should be connected if the connection exists and is connected" do
+        client.stub(:connection => connection)
+        connection.stub(:connected? => true)
+        client.should be_connected
+      end
+    end
+    
+    describe ".close" do
+      before(:each) do
+        client.stub(:connection => connection)
+      end
+      it "should close the connection and clear all receipts and subscriptions" do
+        client.should_receive(:clear_receipts)
+        client.should_receive(:clear_subscriptions)
+        connection.should_receive(:close)
+        client.__send__ :close
+      end
+    end
+    
+    describe ".close!" do
+      before(:each) do
+        client.stub(:processor => processor_class)
+      end
+      it "should call close and stop the processor" do
+        client.should_receive(:close)
+        processor.should_receive(:stop)
+        client.close!
+      end
+    end
+    
+    describe ".transmit" do
+      let(:callbacks) {
+        { :subscribe => 'subscribe', :receipt => 'receipt' }
+      }
+      before(:each) do
+        client.stub(:connection => connection)
+      end
+      it "should register any callbacks, trigger events, write and return the frame" do
+        client.should_receive(:trigger_before_transmitting).with(frame)
+        client.should_receive(:add_subscription).with(frame, 'subscribe')
+        client.should_receive(:add_receipt).with(frame, 'receipt')
+        connection.should_receive(:write_frame_nonblock).with(frame)
+        client.transmit(frame, callbacks).should == frame
+      end
+    end
+    
+    describe ".dispatch_transmitted" do
+      it "should trigger the after transmitting event" do
+        client.should_receive(:trigger_after_transmitting).with(frame)
+        client.dispatch_transmitted(frame)
+      end
+    end
+    
+    describe ".dispatch_received" do
+      it "should trigger the before and after receiving events" do
+        client.should_receive(:trigger_before_receiving).with(frame)
+        client.should_receive(:trigger_after_receiving).with(frame)
+        client.dispatch_received(frame)
+      end
+    end
+    
+    describe "on_disconnect" do
+      it "should call close if there is no receipt header on the frame" do
+        client.should_receive(:close)
+        client.trigger_after_receiving OnStomp::Components::Frame.new('DISCONNECT')
+      end
+      it "should not call close if a receipt header is present" do
+        client.should_not_receive(:close)
+        client.trigger_after_receiving OnStomp::Components::Frame.new('DISCONNECT', :receipt => 'r-1234')
+      end
+    end
+    
+    describe ".versions" do
+      it "should select only those versions that are supported" do
+        client.versions = ['1.9', '1.1', '2.5', '1.0', '82']
+        client.versions.should == ['1.0', '1.1']
+      end
+      it "should raise an unsupported protocol version error if no versions are viable" do
+        lambda {
+          client.versions = ['1.3', '8.x']
+        }.should raise_error(OnStomp::UnsupportedProtocolVersionError)
+      end
+    end
+    
+    describe ".heartbeats" do
+      it "should convert values to non-negative integers" do
+        client.heartbeats = ['-9100', '31313']
+        client.heartbeats.should == [0, 31313]
+      end
+    end
+    
+    describe ".processor" do
+      it "should convert the processor to a class/module" do
+        client.processor = '::Module'
+        client.processor.should == Module
+      end
+      it "should use the NilProcessor if set to nil" do
+        client.processor = nil
+        client.processor.should == OnStomp::Components::NilProcessor
+      end
+    end
+    
+    describe ".login" do
+      it "should convert to a string" do
+        client.login = 314.3
+        client.login.should == '314.3'
+      end
+    end
+    
+    describe ".passcode" do
+      it "should convert to a string" do
+        client.passcode = 42
+        client.passcode.should == '42'
+      end
+    end
+    
+    describe ".host" do
+      it "should convert to a string" do
+        client.host = :hostname
+        client.host.should == 'hostname'
+      end
+    end
+  end
+end

data/spec/onstomp/components/frame_headers_spec.rb

@@ -0,0 +1,163 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+module OnStomp::Components
+  describe FrameHeaders do
+    let(:headers) {
+      FrameHeaders.new
+    }
+    let(:enumerator_module) {
+      RUBY_VERSION >= '1.9' ? Enumerator : Enumerable::Enumerator
+    }
+    
+    describe ".initialize" do
+      it "should create an empty set of headers" do
+        FrameHeaders.new.names.should == []
+      end
+      it "should create headers initialized by a hash" do
+        head = FrameHeaders.new({:one => 'one', 'two' => 2})
+        head[:one].should == 'one'
+        head[:two].should == '2'
+      end
+    end
+    
+    describe ".merge!" do
+      it "should overwrite existing headers and create new ones" do
+        headers[:header1] = 'some value'
+        headers['header2'] = 43
+        headers.merge!( :header2 => 'new value', 'header3' => 'new header')
+        headers.should have_headers(:header1 => 'some value', :header2 => 'new value', :header3 => 'new header')
+      end
+    end
+    
+    describe ".reverse_merge!" do
+      it "should not overwrite existing headers but create new ones" do
+        headers[:header1] = 'some value'
+        headers['header2'] = 43
+        headers.reverse_merge!( :header2 => 'new value', 'header3' => 'new header')
+        headers.should have_headers(:header1 => 'some value', :header2 => '43', :header3 => 'new header')
+      end
+    end
+    
+    describe ".set? / .present?" do
+      it "should be false if the header is not set" do
+        headers.set?(:any_old_thing).should be_false
+        headers.present?(:any_old_thing).should be_false
+      end
+      it "should be set? but not present? when set to nil" do
+        headers[:nil_valued] = nil
+        headers.set?(:nil_valued).should be_true
+        headers.present?(:nil_valued).should be_false
+      end
+      it "should be set? but not present? when set to empty string" do
+        headers[:empty_valued] = ''
+        headers.set?(:empty_valued).should be_true
+        headers.present?(:empty_valued).should be_false
+      end
+      it "should be set? and present? when set to a non-empty value" do
+        headers[:nonempty_valued] = 31011
+        headers.set?(:nonempty_valued).should be_true
+        headers.present?(:nonempty_valued).should be_true
+      end
+    end
+    
+    describe ".append / .all_values" do
+      it "should create a new header name if one did not exist" do
+        headers.set?(:appended).should be_false
+        headers.append('appended', 'value 1')
+        headers.set?(:appended).should be_true
+        headers.all_values(:appended).should == ['value 1']
+      end
+      it "should append to existing values" do
+        headers[:appended1] = 'me'
+        headers.append('appended1', 'me too!')
+        headers.append('appended2', 'me also?')
+        headers.append(:appended2, 'why not')
+        headers.all_values(:appended1).should == ['me', 'me too!']
+        headers.all_values('appended2').should == ['me also?', 'why not']
+      end
+    end
+    
+    describe ".delete" do
+      it "should return nil if the header has not been set" do
+        headers.delete(:whatever).should be_nil
+      end
+      it "should return all values as an array and remove the set header" do
+        headers['todelete'] = 5
+        headers.append(:todelete, 510)
+        headers.delete(:todelete).should == ['5', '510']
+        headers.set?(:todelete).should be_false
+      end
+    end
+    
+    describe "hash-like access .[] and .[]=" do
+      it "should be accessible via strings or symbols" do
+        headers['indifferent'] = 'sweet'
+        headers[:indifferent].should == 'sweet'
+        headers['indifferent'].should == 'sweet'
+      end
+      
+      it "should return nil if the header isn't set" do
+        headers[:what_of_it?].should be_nil
+        headers['what_of_it?'].should be_nil
+      end
+      
+      it "should return the principle (first assigned) value" do
+        headers.append('appended', 'first value')
+        headers.append(:'appended', 'second value')
+        headers.append('appended', 'last value')
+        headers[:appended].should == 'first value'
+      end
+      
+      it "should convert the assigned value to a string" do
+        headers['conversion'] = 310831
+        headers[:conversion].should == '310831'
+        headers[:convert_nil] = nil
+        headers['convert_nil'].should == ''
+      end
+    end
+    
+    describe ".to_hash" do
+      it "should convert itself to a hash of header names and their principle values" do
+        headers[:lonely_me] = true
+        headers.append('appended', 'first value')
+        headers.append(:'appended', 'second value')
+        headers.append('appended', 'last value')
+        headers.to_hash.should == { :lonely_me => 'true', :appended => 'first value' }
+      end
+    end
+    
+    describe ".each" do
+      it "should be a kind of enumerable" do
+        headers.should be_a_kind_of(Enumerable)
+      end
+      
+      it "should yield an enumerator if called without a block" do
+        headers.each.should be_a_kind_of(enumerator_module)
+      end
+      
+      it "should yield header names and values as pairs of strings" do
+        yielded = []
+        headers[:named1] = 'value 1'
+        headers[:named2] = 'value 2'
+        headers.each { |pair| yielded << pair }
+        yielded.should == [ ['named1', 'value 1'], ['named2', 'value 2'] ]
+      end
+      
+      it "should yield repeated headers within the pairs" do
+        yielded = []
+        headers[:named1] = 'value 1'
+        headers[:named2] = 'value 2'
+        headers[:named3] = 'value 3'
+        headers.append('named2', 'yet another')
+        headers.append('named1', 'why not one more?')
+        headers.each { |k, v| yielded << [k, v] }
+        yielded.should == [
+          ['named1', 'value 1'], ['named1', 'why not one more?'],
+          ['named2', 'value 2'], ['named2', 'yet another'],
+          ['named3', 'value 3']
+        ]
+      end
+    end
+  end
+end

data/spec/onstomp/components/frame_spec.rb

@@ -0,0 +1,144 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+module OnStomp::Components
+  describe Frame do
+    let(:frame) {
+      Frame.new
+    }
+    
+    describe ".initialize" do
+      it "should create a frame with no command" do
+        Frame.new.should have_command(nil)
+      end
+      it "should create a frame with the supplied command" do
+        Frame.new('MANIAC').should have_command('MANIAC')
+      end
+      it "should create a rame with the supplied command and headers" do
+        Frame.new('MANIAC',
+          {:mansion => true, 'edit' => 'meteor'}
+        ).should be_an_onstomp_frame('MANIAC',
+          {:mansion => 'true', :edit => 'meteor'}, nil)
+      end
+      it "should create a rame with the supplied command, headers and body" do
+        Frame.new('MANIAC',
+          {:mansion => true, 'edit' => 'meteor'}, 'Bitcrusher'
+        ).should be_an_onstomp_frame('MANIAC',
+          {:mansion => 'true', :edit => 'meteor'}, 'Bitcrusher')
+      end
+    end
+    
+    describe "hash-like access .[] and .[]=" do
+      it "should assign a header in a hash-like style" do
+        frame[:maniac] = 'mansion'
+        frame.headers[:maniac].should == 'mansion'
+      end
+      it "should retrieve a header in a hash-like style" do
+        frame.headers[:maniac] = 'mansion'
+        frame[:maniac].should == 'mansion'
+      end
+    end
+    
+    describe ".content_length" do
+      it "should convert a content-length header to an integer else return nil" do
+        frame[:'content-length'] = '510'
+        frame.content_length.should == 510
+        frame[:'content-length'] = nil
+        frame.content_length.should be_nil
+      end
+    end
+    
+    describe ".content_type" do
+      it "should return an array of nils if no content-type header is set" do
+        frame.content_type.should == [nil, nil, nil]
+      end
+      it "should return an array of nils if the content-type header is not in the standard form" do
+        frame[:'content-type'] = ";charset=UTF-8 text/plain"
+        frame.content_type.should == [nil, nil, nil]
+      end
+      it "should parse a type and subtype" do
+        frame[:'content-type'] = 'text/plain; param1=value; param2=value;param3=4'
+        frame.content_type.should == ['text', 'plain', nil]
+      end
+      it "should parse a type, subtype and charset" do
+        frame[:'content-type'] = 'application-foo/many.pants&shirts; param1=value;charset=UTF-8; param2=value;param3=4'
+        frame.content_type.should == ['application-foo', 'many.pants&shirts', 'UTF-8']
+      end
+    end
+    
+    describe ".header?" do
+      it "should be false if the header is not set" do
+        frame.header?(:blather).should be_false
+      end
+      it "should be false if the header is nil" do
+        frame[:blather] = nil
+        frame.header?(:blather).should be_false
+      end
+      it "should be false if the header is empty" do
+        frame[:blather] = ''
+        frame.header?(:blather).should be_false
+      end
+      it "should be true if the header is set and non-empty" do
+        frame[:blather] = ' '
+        frame.header?(:blather).should be_true
+      end
+    end
+    
+    describe ".all_headers?" do
+      it "should be false if any header is not set" do
+        frame[:blather1] = 'test-set'
+        frame[:blather2] = 'test-set'
+        frame.all_headers?(:blather1, :blather2, :blather3).should be_false
+      end
+      it "should be false if any header is nil" do
+        frame[:blather1] = 'test-set'
+        frame[:blather2] = 'test-set'
+        frame[:blather3] = nil
+        frame.headers?(:blather1, :blather2, :blather3).should be_false
+      end
+      it "should be false if any header is empty" do
+        frame[:blather1] = 'test-set'
+        frame[:blather2] = ''
+        frame[:blather3] = 'test-set'
+        frame.headers?(:blather1, :blather2, :blather3).should be_false
+      end
+      it "should be true if all headers are set and non-empty" do
+        frame[:blather1] = 'three'
+        frame[:blather2] = ' '
+        frame[:blather3] = 'test-set'
+        frame.all_headers?(:blather1, :blather2, :blather3).should be_true
+      end
+    end
+    
+    describe ".heart_beat" do
+      it "should return [0,0] if no heart-beat header is set" do
+        frame.heart_beat.should == [0,0]
+      end
+      it "should parse a heart-beat header and return an array of integers" do
+        frame[:'heart-beat'] = '310,91'
+        frame.heart_beat.should == [310, 91]
+      end
+      it "should return only non-negative values" do
+        frame[:'heart-beat'] = '-310,-91'
+        frame.heart_beat.should == [0, 0]
+        frame[:'heart-beat'] = '-310,91'
+        frame.heart_beat.should == [0, 91]
+        frame[:'heart-beat'] = '310,-91'
+        frame.heart_beat.should == [310, 0]
+      end
+    end
+    
+    describe ".force_content_length" do
+      it "should not assign a content-length header if there is no body" do
+        frame.force_content_length
+        frame.headers.set?(:'content-length').should be_false
+      end
+      
+      it "should set a content-length header to the byte-size of the body" do
+        frame.body = 'this is a tëst'
+        frame.force_content_length
+        frame[:'content-length'].should == '15'
+      end
+    end
+  end
+end

data/spec/onstomp/components/nil_processor_spec.rb

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+module OnStomp::Components
+  describe NilProcessor do
+    let(:client) { mock('client') }
+    let(:processor) { NilProcessor.new client }
+    
+    describe ".start" do
+      it "should return itself" do
+        processor.start.should == processor
+      end
+    end
+    describe ".stop" do
+      it "should return itself" do
+        processor.stop.should == processor
+      end
+    end
+    describe ".join" do
+      it "should return itself" do
+        processor.join.should == processor
+      end
+    end
+    describe ".running?" do
+      it "should never be running" do
+        processor.running?.should be_false
+        processor.start
+        processor.running?.should be_false
+      end
+    end
+  end
+end

data/spec/onstomp/components/scopes/header_scope_spec.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+module OnStomp::Components::Scopes
+  describe HeaderScope do
+    let(:client) {
+      OnStomp::Client.new("stomp:///")
+    }
+    let(:headers) {
+      { :header1 => 'value 1', 'header2' => 'value 2'}
+    }
+    let(:scope) {
+      HeaderScope.new headers, client
+    }
+    
+    let(:frame_method_interface) { scope }
+    it_should_behave_like "frame method interfaces"
+    
+    describe ".transmit" do
+      it "should add all its headers to a frame, unless that header name is set" do
+        client.stub(:transmit).and_return { |f,_| f }
+        frame = scope.transmit OnStomp::Components::Frame.new('COMMAND', {:header2 => 'my value'})
+        frame.should have_headers(:header1 => 'value 1', :header2 => 'my value')
+      end
+    end
+  end
+end