qpid_messaging 0.16.0

data/features/step_definitions/sender_steps.rb

@@ -0,0 +1,34 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+Given /^the message "([^"]*)" is sent$/ do |content|
+  @sender.send Qpid::Messaging::Message.new :content => "#{content}"
+end
+
+Then /^sending the message "([^"]*)" should raise an error$/ do |content|
+  lambda {
+    steps %Q{
+      Then sending the message "#{content}" succeeds
+    }
+  }.should raise_error
+end
+
+Then /^sending the message "([^"]*)" succeeds$/ do |content|
+  @sender.send Qpid::Messaging::Message.new :content => "#{content}"
+end

data/features/step_definitions/session_steps.rb

@@ -0,0 +1,99 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+Given /^a closed session/ do
+  steps %Q{
+    Given an open connection
+    Then creating a session works
+  }
+  @connection.close
+end
+
+Then /^creating a sender with "([^"]*)" raises an exception$/ do |address|
+  lambda {
+    steps %Q{
+      @sender = @session.create_sender "#{address}"
+    }
+  }.should raise_error
+end
+
+Then /^creating a receiver with "([^"]*)" raises an exception$/ do |address|
+  lambda {
+    steps %Q{
+      @sender = @session.create_sender "#{address}"
+    }
+  }.should raise_error
+end
+
+Given /^an open session with a closed connection$/ do
+  steps %Q{
+    Given an open connection
+    Then creating a session works
+  }
+  @session.connection.close
+end
+
+Given /^an open session$/ do
+  steps %Q{
+    Given an open connection
+    Then creating a session works
+  }
+end
+
+Given /^the session is closed$/ do
+  @session.close
+end
+
+Then /^creating a sender with "([^"]*)" succeeds$/ do |address|
+  @sender = @session.create_sender "#{address}"
+  @sender.should_not be_nil
+end
+
+Then /^creating a sender with an Address succeeds$/ do
+  @sender = @session.create_receiver @address
+  @sender.should_not be_nil
+end
+
+Then /^creating a receiver for a nonexistent queue raises an exception$/ do
+  lambda {
+    steps %Q{
+      Then creating a receiver with "queue-#{Time.new.to_i}" succeeds
+    }
+  }.should raise_error
+end
+
+Then /^creating a receiver with "([^"]*)" succeeds$/ do |address|
+  @receiver = @session.create_receiver "#{address}"
+  @receiver.should_not be_nil
+end
+
+Then /^creating a receiver with an Address succeeds$/ do
+  @receiver = @session.create_receiver @address
+  @receiver.should_not be_nil
+end
+
+Then /^closing the session does not raise an error$/ do
+  lambda {
+    @session.close
+  }.should_not raise_error
+end
+
+Then /^the connection for the session is in the (open|closed) state$/ do |state|
+  @session.connection.open?.should == false if state == "closed"
+end

data/features/support/env.rb

@@ -0,0 +1,22 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../../lib")
+
+require 'qpid_messaging'

data/lib/qpid_messaging.rb

@@ -0,0 +1,30 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+require 'qpid_messaging/version'
+require 'qpid_messaging/errors'
+require 'qpid_messaging/duration'
+require 'qpid_messaging/address'
+require 'qpid_messaging/encoding'
+require 'qpid_messaging/message'
+require 'qpid_messaging/sender'
+require 'qpid_messaging/receiver'
+require 'qpid_messaging/session'
+require 'qpid_messaging/connection'
+

data/lib/qpid_messaging/address.rb

@@ -0,0 +1,187 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+require 'cqpid'
+
+module Qpid
+
+  module Messaging
+
+    # Address represents an address to which messages can be sent or from
+    # which they can be received.
+    #
+    # An Address can be described using the following pattern:
+    #
+    # <address> [ / <subject> ] ; [ { <key> : <value> , ... } ]
+    #
+    # where *address* is a simple name and *subject* is a subject or subject
+    # pattern.
+    #
+    # The options, enclosed in curly braces, are key:value pairs delimited by
+    # a comma. The values can be nested maps also enclosed in curly braces.
+    # Or they can be lists of values, where they are contained within square
+    # brackets but still comma delimited, such as:
+    #
+    #   [value1,value2,value3]
+    #
+    # The following are the list of supported options:
+    #
+    # [:create]
+    #   Indicates if the address should be created; values are *always*,
+    #   *never*, *sender* or *reciever*.
+    #
+    # [:assert]
+    #   Indicates whether or not to assert any specified node properties;
+    #   values are *always*, *never*, *sender* or *receiver*.
+    #
+    # [:delete]
+    #   Indicates whether or not to delete the addressed node when a sender
+    #   or receiver is cancelled; values are *always*, *never*, *sender* or
+    #   *receiver*.
+    #
+    # [:node]
+    #   A nested map describing properties for the addressed node. Properties
+    #   are *type* (*topic* or *queue*), *durable* (a boolean), *x-declare*
+    #   (a nested map of amqp 0.10-specific options) and *x-bindings*. (nested
+    #   list which specifies a queue, exchange or a binding key and arguments.
+    #
+    # [:link]
+    #   A nested map through which properties of the link can be specified;
+    #   properties are *durable*, *reliability*, *x-declare*, *x-subscribe*
+    #   and *x-bindings*.
+    #
+    # [:mode]
+    #   (*For receivers only*) indicates whether the receiver should consume
+    #   or browse messages; values are *consume* (the default) and *browse*.
+    #
+    class Address
+
+      # Creates a new +Address+ object.
+      #
+      # ==== Options
+      #
+      # * name - The name for the +Address+.
+      # * subject - The subject for the +Address+
+      # * :create - See the class documentation.
+      # * :assert - See the class documentation.
+      # * :delete - See the class documentation.
+      # * :node   - See the class documentation.
+      # * :link   - See the class documentation.
+      # * :mode   - See the class documentation.
+      #
+      # ==== Examples
+      #
+      #   addr = Qpid::Messaging::Address.new "my-queue"
+      #   addr = Qpid::Messaging::Address.new "my-queue", "testing", :create => :always
+      #
+      def initialize(name, subject, options = {}, _type = "", address_impl = nil)
+        @address_impl = address_impl || Cqpid::Address.new(name, subject, convert_options(options), _type)
+      end
+
+      def address_impl # :nodoc:
+        @address_impl
+      end
+
+      # Returns the name for the +Address+.
+      #
+      # ==== Examples
+      #
+      #   puts "The address name is #{addr.name}."
+      #
+      def name; @address_impl.getName; end
+
+      # Sets the name for the +Address+.
+      #
+      # ==== Examples
+      #
+      #   addr.name = "my-new-queue"
+      #
+      def name=(name); @address_impl.setName name; end
+
+      # Returns the subject for the +Address+.
+      #
+      # ==== Examples
+      #
+      #   puts "The subject is #{addr.subject}."
+      #
+      def subject; @address_impl.getSubject; end
+
+      # Sets the subject for the +Address+.
+      #
+      # ==== Examples
+      #
+      #   addr.subject = "testing"
+      #
+      def subject=(subject); @address_impl.setSubject(subject); end
+
+      # Returns the type for the +Address+.
+      #
+      # ==== Examples
+      #
+      #   puts "The address is a #{address.address_type}."
+      #
+      #---
+      # We cannot use "type" since that clashes with the Ruby object.type
+      # identifier.
+      def address_type; @address_impl.getType; end
+
+      # Sets the type for the +Address+.
+      #
+      # The type of the address determines how +Sender+ and +Receiver+ objects
+      # are constructed for it. If no type is specified then it will be
+      # determined by querying the broker.
+      #
+      # ===== Options
+      #
+      # * type - the address type
+      #
+      def address_type=(type); @address_impl.setType(type); end
+
+      # Returns the options.
+      def options; @address_impl.getOptions; end
+
+      # Sets the options for the address.
+      #
+      # *NOTE:* See the class documentation for more details on options.
+      #
+      # ==== Examples
+      #
+      #   addr.options = :create => :always
+      #
+      def options=(options = {}); @address_impl.setOptions(convert_options(options)); end
+
+      def to_s # :nodoc:
+        @address_impl.str
+      end
+
+      private
+
+      def convert_options(options)
+        result = {}
+        options.each_pair {|key, value| result[key.to_s] = value.to_s}
+
+        return result
+      end
+
+    end
+
+  end
+
+end
+

data/lib/qpid_messaging/connection.rb

@@ -0,0 +1,162 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+require 'cqpid'
+
+module Qpid
+
+  module Messaging
+
+    # Establishes a connection to a remote endpoint.
+    class Connection
+
+      attr_reader :options # :nodoc:
+
+      # Creates a connection object, but does not actually connect to
+      # the specified location.
+      #
+      # ==== Options
+      #
+      #   :url - the URL for the broker (def. +"localhost"+)
+      #   :options - connection options (def. +{}+)
+      #
+      # ==== Controlling Reconnect Behavior
+      #
+      # The following connection options can be used to configure
+      # the reconnection behavior for this connection.
+      #
+      # * :username
+      # * :password
+      # * :heartbeat
+      # * :tcp_nodelay
+      # * :sasl_mechanism
+      # * :sasl_service
+      # * :sasl_min_ssf
+      # * :sasl_max_ssf
+      # * :transport
+      # * :reconnect - +true+ or +false+; indicates wehtehr to attempt reconnections
+      # * :reconnect_timeout - the number of seconds to attempt reconnecting
+      # * :reconnect_limit - the number of retries before reporting failure
+      # * :reconnect_interval_min - initial delay, in seconds, before attempting a reconnection
+      # * :reconnect_interval_max - number of seconds to wait before additional reconnect attempts
+      # * :reconnect_interval - shorthand for setting both min and max values
+      # * :reconnect_urls - a list of alternate URLs to use for reconnection attempts
+      #
+      # ==== Examples
+      #
+      #   conn = Qpid::Messaging::Connnection.new
+      #   conn = Qpid::Messaging::Connection.new :url => "amqp:tcp:broker1.domain.com:5672"
+      #   conn = Qpid::Messaging::Connection.new :options => {:username => "login", :password => "password"}
+      #
+      def initialize(opts = {})
+        @url = opts[:url] || "localhost"
+        @options = convert_options(opts[:options] || {})
+        @connection_impl = opts[:impl] || Cqpid::Connection.new(@url, @options)
+      end
+
+      def connection_impl # :nodoc:
+        @connection_impl
+      end
+
+      # Establishes the connection.
+      #
+      # ==== Examples
+      #
+      #   conn.open unless conn.open?
+      #
+      def open
+        @connection_impl.open
+      end
+
+      # Reports whether the connection is open.
+      #
+      # ==== Examples
+      #
+      #   conn.close if conn.open?
+      #
+      def open?; true && !@connection_impl.nil? && @connection_impl.isOpen; end
+
+      # Closes the connection.
+      def close; @connection_impl.close; end
+
+      # Creates a new session.
+      #
+      # ==== Arguments
+      #
+      # * :name - specifies the name for this session
+      # * :transactional - if +true+ then a creates a transaction session (def. +false+)
+      #
+      # ==== Examples
+      #
+      #   session = conn.create_session :name => "session1"
+      #   session = conn.create_session :transaction => true
+      #
+      def create_session(args = {})
+        name = args[:name] || ""
+        if open?
+          if args[:transactional]
+            session = @connection_impl.createTransactionalSession name
+          else
+            session = @connection_impl.createSession name
+          end
+          return Session.new(self, session)
+        else
+          raise RuntimeError.new "No connection available."
+        end
+      end
+
+      # Returns a session for the specified session name.
+      #
+      # ==== Examples
+      #
+      #   begin
+      #     session = conn.session "mysession"
+      #   rescue SessionNameException => error
+      #      puts "No such session."
+      #   end
+      #
+      def session name
+        begin
+          session_impl = @connection_impl.getSession name
+          Qpid::Messaging::Session.new self, session_impl if session_impl
+        rescue
+          raise Qpid::Messaging::SessionNameException.new "No such session: #{name}"
+        end
+      end
+
+      # Returns the username used to authenticate with the connection.
+      def authenticated_username; @connection_impl.getAuthenticatedUsername if open?; end
+
+      private
+
+      def convert_options(options)
+        result = {}
+        unless options.nil? || options.empty?
+          options.each_pair {|key, value| result[key.to_s] = value.to_s}
+        end
+
+        return result
+      end
+
+    end
+
+  end
+
+end
+