qpid_proton 0.17.0 → 0.18.0

data/lib/core/url.rb

@@ -28,11 +28,13 @@ module Qpid::Proton
     attr_reader :port
     attr_reader :path
 
+    # Parse a string, return a new URL
+    # @param url [#to_s] the URL string
     def initialize(url = nil, options = {})
       options[:defaults] = true
 
       if url
-        @url = Cproton.pn_url_parse(url)
+        @url = Cproton.pn_url_parse(url.to_s)
         if @url.nil?
           raise ::ArgumentError.new("invalid url: #{url}")
         end
@@ -71,7 +73,5 @@ module Qpid::Proton
       @host = @host || "0.0.0.0"
       @port = @port || 5672
     end
-
   end
-
 end

data/lib/handler/acking.rb

@@ -58,7 +58,7 @@ module Qpid::Proton::Handler
     # is specified.
     #
     # @param delivery [Qpid::Proton::Delivery] The delivery.
-    # @param state [Fixnum] The delivery state.
+    # @param state [Integer] The delivery state.
     #
     def settle(delivery, state = nil)
       delivery.update(state) unless state.nil?

data/lib/handler/endpoint_state_handler.rb

@@ -119,7 +119,7 @@ module Qpid::Proton::Handler
     end
 
     def on_connection_opened(event)
-      Qpid::Proton::Event.dispatch(@delegate, :on_session_opened, event) if !@delegate.nil?
+      Qpid::Proton::Event.dispatch(@delegate, :on_connection_opened, event) if !@delegate.nil?
     end
 
     def on_session_opened(event)

data/lib/handler/messaging_handler.rb

@@ -21,15 +21,13 @@ module Qpid::Proton::Handler
 
   # A general purpose handler that simplifies processing events.
   #
-  # @example
-  #
   class MessagingHandler < Qpid::Proton::BaseHandler
 
     attr_reader :handlers
 
     # Creates a new instance.
     #
-    # @param [Fixnum] prefetch
+    # @param [Integer] prefetch
     # @param [Boolean] auto_accept
     # @param [Boolean] auto_settle
     # @param [Boolean] peer_close_is_error

data/lib/messenger/messenger.rb

@@ -18,7 +18,7 @@
 #
 
 module Qpid::Proton::Messenger
-
+  #
   # The +Messenger+ class defines a high level interface for
   # sending and receiving Messages. Every Messenger contains
   # a single logical queue of incoming messages and a single
@@ -37,7 +37,7 @@ module Qpid::Proton::Messenger
   #
   # The put method copies its Message to the outgoing queue, and may
   # send queued messages if it can do so without blocking.  The send
-  # method blocks until it has sent the requested number of messages,
+  # method blocks until it has sent the requested number of 
   # or until a timeout interrupts the attempt.
   #
   # Similarly, the recv method receives messages into the incoming
@@ -694,7 +694,7 @@ module Qpid::Proton::Messenger
     end
 
     def valid_window?(window)
-      !window.nil? && [Float, Fixnum].include?(window.class)
+      !window.nil? && window.is_a?(Numeric)
     end
 
   end

data/lib/reactor/connector.rb

@@ -21,16 +21,24 @@ module Qpid::Proton::Reactor
 
   class Connector < Qpid::Proton::BaseHandler
 
-    attr_accessor :address
-    attr_accessor :reconnect
-    attr_accessor :ssl_domain
+    def initialize(connection, url, opts)
+      @connection, @opts = connection, opts
+      @urls = URLs.new(url) if url
+      opts.each do |k,v|
+        case k
+        when :url, :urls, :address
+          @urls = URLs.new(v) unless @urls
+        when :reconnect
+          @reconnect = v
+        end
+      end
+      raise ::ArgumentError.new("no url for connect") unless @urls
 
-    def initialize(connection)
-      @connection = connection
-      @address = nil
-      @heartbeat = nil
-      @reconnect = nil
-      @ssl_domain = nil
+      # TODO aconway 2017-08-17: review reconnect configuration and defaults
+      @reconnect = Backoff.new() unless @reconnect
+      @ssl_domain = SessionPerConnection.new # TODO seems this should be configurable
+      @connection.overrides = self
+      @connection.open
     end
 
     def on_connection_local_open(event)
@@ -38,10 +46,7 @@ module Qpid::Proton::Reactor
     end
 
     def on_connection_remote_open(event)
-      if !@reconnect.nil?
-        @reconnect.reset
-        @transport = nil
-      end
+      @reconnect.reset if @reconnect
     end
 
     def on_transport_tail_closed(event)
@@ -73,26 +78,38 @@ module Qpid::Proton::Reactor
     end
 
     def connect(connection)
-      url = @address.next
+      url = @urls.next
+      transport = Qpid::Proton::Transport.new
+      @opts.each do |k,v|
+        case k
+        when :user
+          connection.user = v
+        when :password
+          connection.password = v
+        when :heartbeat
+          transport.idle_timeout = v.to_i
+        when :idle_timeout
+          transport.idle_timeout = v.(v*1000).to_i
+        when :sasl_enabled
+          transport.sasl if v
+        when :sasl_allow_insecure_mechs
+          transport.sasl.allow_insecure_mechs = v
+        when :sasl_allowed_mechs, :sasl_mechanisms
+          transport.sasl.allowed_mechs = v
+        end
+      end
+
+      # TODO aconway 2017-08-11: hostname setting is incorrect, reactor only
       connection.hostname = "#{url.host}:#{url.port}"
+      connection.user = url.username if url.username && !url.username.empty?
+      connection.password = url.password if url.password && !url.password.empty?
 
-      transport = Qpid::Proton::Transport.new
       transport.bind(connection)
-      if !@heartbeat.nil?
-        transport.idle_timeout = @heartbeat
-      elsif (url.scheme == "amqps") && !@ssl_domain.nil?
+
+      if (url.scheme == "amqps") && @ssl_domain
         @ssl = Qpid::Proton::SSL.new(transport, @ssl_domain)
-        @ss.peer_hostname = url.host
-      elsif !url.username.nil?
-        sasl = transport.sasl
-        if url.username == "anonymous"
-          sasl.mechanisms("ANONYMOUS")
-        else
-          sasl.plain(url.username, url.password)
-        end
+        @ssl.peer_hostname = url.host
       end
     end
-
   end
-
 end

data/lib/reactor/container.rb

@@ -19,7 +19,7 @@
 
 module Qpid::Proton::Reactor
 
-  # @private
+  private
   class InternalTransactionHandler < Qpid::Proton::Handler::OutgoingMessageHandler
 
     def initialize
@@ -35,7 +35,7 @@ module Qpid::Proton::Reactor
 
   end
 
-
+  public
   # A representation of the AMQP concept of a container which, loosely
   # speaking, is something that establishes links to or from another
   # container on which messages are transferred.
@@ -43,9 +43,6 @@ module Qpid::Proton::Reactor
   # This is an extension to the Reactor classthat adds convenience methods
   # for creating instances of Qpid::Proton::Connection, Qpid::Proton::Sender
   # and Qpid::Proton::Receiver.
-  #
-  # @example
-  #
   class Container < Reactor
 
     include Qpid::Proton::Util::Reactor
@@ -74,42 +71,45 @@ module Qpid::Proton::Reactor
       end
     end
 
-    # Initiates the establishment of an AMQP connection.
+    # Initiate an AMQP connection.
     #
-    # @param options [Hash] A hash of named arguments.
+    # @param url [String] Connect to URL host:port, using user:password@ if present
+    # @param opts [Hash] Named options
+    #   For backwards compatibility, can be called with a single parameter opts.
     #
-    def connect(options = {})
-      conn = self.connection(options[:handler])
-      conn.container = self.container_id || generate_uuid
-      connector = Connector.new(conn)
-      conn.overrides = connector
-      if !options[:url].nil?
-        connector.address = URLs.new([options[:url]])
-      elsif !options[:urls].nil?
-        connector.address = URLs.new(options[:urls])
-      elsif !options[:address].nil?
-        connector.address = URLs.new([Qpid::Proton::URL.new(options[:address])])
-      else
-        raise ::ArgumentError.new("either :url or :urls or :address required")
-      end
-
-      connector.heartbeat = options[:heartbeat] if !options[:heartbeat].nil?
-      if !options[:reconnect].nil?
-        connector.reconnect = options[:reconnect]
-      else
-        connector.reconnect = Backoff.new()
+    # @option opts [String] :url Connect to URL host:port using user:password@ if present.
+    # @option opts [String] :user user name for authentication if not given by URL
+    # @option opts [String] :password password for authentication if not given by URL
+    # @option opts [Numeric] :idle_timeout seconds before closing an idle connection,
+    #   can be a fractional value.
+    # @option opts [Boolean] :sasl_enabled Enable or disable SASL.
+    # @option opts [Boolean] :sasl_allow_insecure_mechs Allow mechanisms that disclose clear text
+    #   passwords, even over an insecure connection. By default, such mechanisms are only allowed
+    #   when SSL is enabled.
+    # @option opts [String] :sasl_allowed_mechs the allowed SASL mechanisms for use on the connection.
+    #
+    # @option opts [String] :address *deprecated* use the :url option
+    # @option opts [Numeric] :heartbeat milliseconds before closing an idle connection.
+    #   *deprecated* use :idle_timeout => heartbeat/1000 
+    #
+    # @return [Connection] the new connection
+    #
+    def connect(url, opts = {})
+      # Backwards compatible with old connect(options)
+      if url.is_a? Hash and opts.empty?
+        opts = url
+        url = nil
       end
-
-      connector.ssl_domain = SessionPerConnection.new # TODO seems this should be configurable
-
-      conn.open
-
+      conn = self.connection(opts[:handler])
+      conn.container = self.container_id || generate_uuid
+      connector = Connector.new(conn, url, opts)
       return conn
     end
 
+    private
     def _session(context)
       if context.is_a?(Qpid::Proton::URL)
-        return self._session(self.connect(:url => context))
+        return _session(self.connect(:url => context))
       elsif context.is_a?(Qpid::Proton::Session)
         return context
       elsif context.is_a?(Qpid::Proton::Connection)
@@ -123,16 +123,17 @@ module Qpid::Proton::Reactor
       end
     end
 
+    public
     # Initiates the establishment of a link over which messages can be sent.
     #
     # @param context [String, URL] The context.
     # @param opts [Hash] Additional options.
-    # @param opts [String, Qpid::Proton::URL] The target address.
-    # @param opts [String] :source The source address.
-    # @param opts [Boolean] :dynamic
-    # @param opts [Object] :handler
-    # @param opts [Object] :tag_generator The tag generator.
-    # @param opts [Hash] :options Addtional link options
+    # @option opts [String, Qpid::Proton::URL] The target address.
+    # @option opts [String] :source The source address.
+    # @option opts [Boolean] :dynamic
+    # @option opts [Object] :handler
+    # @option opts [Object] :tag_generator The tag generator.
+    # @option opts [Hash] :options Addtional link options
     #
     # @return [Sender] The sender.
     #
@@ -146,7 +147,7 @@ module Qpid::Proton::Reactor
         target = context.path
       end
 
-      session = self._session(context)
+      session = _session(context)
 
       sender = session.sender(opts[:name] ||
                               id(session.connection.container,
@@ -155,7 +156,7 @@ module Qpid::Proton::Reactor
         sender.target.address = target if target
         sender.handler = opts[:handler] if !opts[:handler].nil?
         sender.tag_generator = opts[:tag_generator] if !opts[:tag_gnenerator].nil?
-        self._apply_link_options(opts[:options], sender)
+        _apply_link_options(opts[:options], sender)
         sender.open
         return sender
     end
@@ -192,7 +193,7 @@ module Qpid::Proton::Reactor
         source = context.path
       end
 
-      session = self._session(context)
+      session = _session(context)
 
       receiver = session.receiver(opts[:name] ||
                                   id(session.connection.container,
@@ -201,7 +202,7 @@ module Qpid::Proton::Reactor
       receiver.source.dynamic = true if opts.has_key?(:dynamic) && opts[:dynamic]
       receiver.target.address = opts[:target] if !opts[:target].nil?
       receiver.handler = opts[:handler] if !opts[:handler].nil?
-      self._apply_link_options(opts[:options], receiver)
+      _apply_link_options(opts[:options], receiver)
       receiver.open
       return receiver
     end
@@ -236,10 +237,7 @@ module Qpid::Proton::Reactor
       return acceptor
     end
 
-    def do_work(timeout = nil)
-      self.timeout = timeout unless timeout.nil?
-      self.process
-    end
+    private
 
     def id(container, remote, local)
       if !local.nil? && !remote.nil?

data/lib/reactor/reactor.rb

@@ -89,7 +89,7 @@ module Qpid::Proton::Reactor
 
     # Returns the timeout period.
     #
-    # @return [Fixnum] The timeout period, in seconds.
+    # @return [Integer] The timeout period, in seconds.
     #
     def timeout
       millis_to_timeout(Cproton.pn_reactor_get_timeout(@impl))
@@ -97,7 +97,7 @@ module Qpid::Proton::Reactor
 
     # Sets the timeout period.
     #
-    # @param timeout [Fixnum] The timeout, in seconds.
+    # @param timeout [Integer] The timeout, in seconds.
     #
     def timeout=(timeout)
       Cproton.pn_reactor_set_timeout(@impl, timeout_to_millis(timeout))

data/lib/reactor/urls.rb

@@ -22,7 +22,12 @@ module Qpid::Proton::Reactor
   class URLs
 
     def initialize(values)
-      @values = [values].flatten
+      @values = values
+      if @values.is_a? Enumerable
+        @values = @values.map { |u| Qpid::Proton::URL.new(u) }
+      else
+        @values = [Qpid::Proton::URL.new(values)]
+      end
       @iter = @values.each
     end
 

data/lib/util/condition.rb

@@ -21,6 +21,8 @@ module Qpid::Proton::Util
 
   class Condition
 
+    attr_reader :name, :description, :info
+
     def initialize(name, description = nil, info = nil)
       @name = name
       @description = description

data/lib/util/engine.rb

@@ -25,7 +25,7 @@ module Qpid::Proton::Util
     # Convenience method to receive messages from a delivery.
     #
     # @param delivery [Qpid::Proton::Delivery] The delivery.
-    # @param message [Qpid::Proton::Message] The message to use.
+    # @param msg [Qpid::Proton::Message] The message to use.
     #
     # @return [Qpid::Proton::Message] the message
     #

data/lib/util/swig_helper.rb

@@ -86,7 +86,7 @@ module Qpid::Proton::Util
         proton_method = "#{self::PROTON_METHOD_PREFIX}_#{name}"
         # drop the trailing '?' if this is a property method
         proton_method = proton_method[0..-2] if proton_method.end_with? "?"
-        create_wrapper_method(name, proton_method)
+        create_wrapper_method(name, proton_method, options[:arg])
       end
 
       def proton_writer(name, options = {})

metadata

@@ -1,27 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: qpid_proton
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Darryl L. Pierce
+- Alan Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: |
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby language bindings for the Qpid Proton messaging framework