qpid_proton 0.8 → 0.9.0

data/ext/cproton/extconf.rb

@@ -19,6 +19,10 @@
 
 require 'mkmf'
 
+# set the ruby version compiler flag
+runtime_version = RUBY_VERSION.gsub(/\./,'')[0,2]
+$CFLAGS << " -DRUBY#{runtime_version}"
+
 dir_config("qpid-proton")
 
 REQUIRED_LIBRARIES = [
@@ -33,7 +37,6 @@ REQUIRED_HEADERS = [
                     "proton/engine.h",
                     "proton/message.h",
                     "proton/sasl.h",
-                    "proton/driver.h",
                     "proton/messenger.h"
                    ]
 

data/lib/qpid_proton.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,20 +15,24 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
 require "cproton"
 require "date"
 
+if RUBY_VERSION < "1.9"
+require "kconv"
+end
+
 require "qpid_proton/version"
 require "qpid_proton/described"
+require "qpid_proton/strings"
 require "qpid_proton/mapping"
 require "qpid_proton/array"
 require "qpid_proton/hash"
 require "qpid_proton/exceptions"
 require "qpid_proton/exception_handling"
 require "qpid_proton/filters"
-require "qpid_proton/message_format"
 require "qpid_proton/data"
 require "qpid_proton/message"
 require "qpid_proton/subscription"

data/lib/qpid_proton/array.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,16 +15,16 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
 #--
 # Patch the Array class to provide methods for adding its contents
 # to a Qpid::Proton::Data instance.
 #++
 
-module Qpid
+module Qpid # :nodoc:
 
-  module Proton
+  module Proton # :nodoc:
 
     # Holds the information for an AMQP Array compound type.
     #
@@ -54,7 +54,7 @@ module Qpid
 
 end
 
-class Array
+class Array # :nodoc:
 
   # Used to declare an array as an AMQP array.
   #

data/lib/qpid_proton/data.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,13 +15,11 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
-
-require 'cproton'
+#++
 
-module Qpid
+module Qpid # :nodoc:
 
-  module Proton
+  module Proton # :nodoc:
 
     # +DataError+ is raised when an error occurs while encoding
     # or decoding data.
@@ -725,7 +723,7 @@ module Qpid
       # If the current node is binary, returns its value. Otherwise, it returns
       # an empty string ("").
       def binary
-        Cproton.pn_data_get_binary(@data)
+        Qpid::Proton::BinaryString.new(Cproton.pn_data_get_binary(@data))
       end
 
       # Puts a unicode string value.
@@ -742,7 +740,7 @@ module Qpid
       # If the current node is a string, returns its value. Otherwise, it
       # returns an empty string ("").
       def string
-        Cproton.pn_data_get_string(@data)
+        Qpid::Proton::UTFString.new(Cproton.pn_data_get_string(@data))
       end
 
       # Puts a symbolic value.

data/lib/qpid_proton/described.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,7 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
 module Qpid # :nodoc:
 

data/lib/qpid_proton/exception_handling.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,16 +15,59 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
-module Qpid
+module Qpid # :nodoc:
 
-  module Proton
+  module Proton # :nodoc:
 
     # Provides mixin functionality for dealing with exception conditions.
     #
     module ExceptionHandling
 
+      def self.included(base)
+        base.extend(self)
+
+        unless defined? base.to_be_wrapped
+          class << base
+            @@to_be_wrapped = []
+          end
+        end
+
+        define_method :method_added do |name|
+          if (!@@to_be_wrapped.nil?) && (@@to_be_wrapped.include? name)
+            @@to_be_wrapped.delete name
+            create_exception_handler_wrapper(name)
+          end
+        end
+      end
+
+      def can_raise_exception(method_names)
+        # coerce the names to be an array
+        Array(method_names).each do |method_name|
+          # if the method doesn't already exist then queue this aliasing
+          unless self.method_defined? method_name
+            @@to_be_wrapped ||= []
+            @@to_be_wrapped << method_name
+          else
+            create_exception_handler_wrapper(method_name)
+          end
+        end
+      end
+
+      def create_exception_handler_wrapper(method_name)
+        original_method_name = method_name.to_s
+        wrapped_method_name = "_excwrap_#{original_method_name}"
+        alias_method wrapped_method_name, original_method_name
+        define_method original_method_name do |*args, &block|
+          # need to get a reference to the method object itself since
+          # calls to Class.send interfere with Messenger.send
+          method = self.method(wrapped_method_name.to_sym)
+          rc = method.call(*args, &block)
+          check_for_error(rc)
+        end
+      end
+
       # Raises an Proton-specific error if a return code is non-zero.
       #
       # Expects the class to provide an +error+ method.
@@ -32,7 +75,7 @@ module Qpid
 
         raise ::ArgumentError.new("Invalid error code: #{code}") if code.nil?
 
-	return code if code > 0
+        return code if code > 0
 
         case(code)
 
@@ -54,6 +97,9 @@ module Qpid
         when Qpid::Proton::Error::ARGUMENT
           raise Qpid::Proton::ArgumentError.new(self.error)
 
+        when Qpid::Proton::Error::STATE
+          raise Qpid::Proton::StateError.new(self.error)
+
         when Qpid::Proton::Error::TIMEOUT
           raise Qpid::Proton::TimeoutError.new(self.error)
 

data/lib/qpid_proton/exceptions.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,11 +15,11 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
-module Qpid
+module Qpid # :nodoc:
 
-  module Proton
+  module Proton # :nodoc:
 
     module Error
 
@@ -61,6 +61,12 @@ module Qpid
     class ArgumentError < ProtonError
     end
 
+    # Represents that the client has got into an unexpected state during
+    # messaging.
+    #
+    class StateError < ProtonError
+    end
+
     # Represents a timeout during messaging.
     #
     class TimeoutError < ProtonError

data/lib/qpid_proton/filters.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,11 +15,11 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
-module Qpid
+module Qpid # :nodoc:
 
-  module Proton
+  module Proton # :nodoc:
 
     module Filters
 

data/lib/qpid_proton/hash.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,14 +15,14 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
 #--
 # Patch the Hash class to provide methods for adding its contents
 # to a Qpid::Proton::Data instance.
 #++
 
-class Hash
+class Hash # :nodoc:
 
   # Places the contents of the hash into the specified data object.
   #

data/lib/qpid_proton/mapping.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,7 +15,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
 module Qpid # :nodoc:
 
@@ -106,11 +106,35 @@ module Qpid # :nodoc:
     DECIMAL128 = Mapping.new(Cproton::PN_DECIMAL128, "decimal128")
     UUID       = Mapping.new(Cproton::PN_UUID, "uuid")
     BINARY     = Mapping.new(Cproton::PN_BINARY, "binary")
-    STRING     = Mapping.new(Cproton::PN_STRING, "string", [String, Symbol])
+    STRING     = Mapping.new(Cproton::PN_STRING, "string", [String, Symbol,
+                                                           UTFString,
+                                                           BinaryString])
 
-    class << STRING
+    class << STRING # :nodoc:
       def put(data, value)
-        data.string = value.to_s
+        # if we have a symbol then convert it to a string
+        value = value.to_s if value.is_a?(Symbol)
+
+        isutf = false
+
+        if value.is_a?(Qpid::Proton::UTFString)
+          isutf = true
+        else
+          # For Ruby 1.8 we will just treat all strings as binary.
+          # For Ruby 1.9+ we can check the encoding first to see what it is
+          if RUBY_VERSION >= "1.9"
+            # If the string is ASCII-8BIT then treat is as binary. Otherwise,
+            # try to convert it to UTF-8 and, if successful, send as that.
+            if value.encoding != Encoding::ASCII_8BIT &&
+                value.encode(Encoding::UTF_8).valid_encoding?
+              isutf = true
+            end
+          end
+        end
+
+        data.string = value if isutf
+        data.binary = value if !isutf
+
       end
     end
 
@@ -120,12 +144,16 @@ module Qpid # :nodoc:
     LIST       = Mapping.new(Cproton::PN_LIST, "list", [::Array], "get_array")
     MAP        = Mapping.new(Cproton::PN_MAP, "map", [::Hash], "get_map")
 
-    class << MAP
-      def put(data, map)
+    class << MAP # :nodoc:
+      def put(data, map, options = {})
         data.put_map
         data.enter
         map.each_pair do |key, value|
-          Mapping.for_class(key.class).put(data, key)
+          if options[:keys] == :SYMBOL
+            SYMBOL.put(data, key)
+          else
+            Mapping.for_class(key.class).put(data, key)
+          end
 
           if value.nil?
             data.null

data/lib/qpid_proton/message.rb

@@ -1,4 +1,4 @@
-#
+#--
 # 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
@@ -15,16 +15,32 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-#
+#++
 
-module Qpid
+module Qpid # :nodoc:
 
-  module Proton
+  module Proton # :nodoc:
 
     # A Message represents an addressable quantity of data.
     #
+    # ==== Message Body
+    #
+    # The message body can be set using the #body= method. The message will
+    # then attempt to determine how exactly to encode the content.
+    #
     # ==== Examples
     #
+    # To create a message for sending:
+    #
+    #   # send a simple text message
+    #   msg = Qpid::Proton::Message.new
+    #   msg.body = "STATE: update"
+    #
+    #   # send a binary chunk of data
+    #   data = File.binread("/home/qpid/binfile.tar.gz")
+    #   msg = Qpid::Proton::Message.new
+    #   msg.body = Qpid::Proton::BinaryString.new(data)
+    #
     class Message
 
       # Decodes a message from supplied AMQP data and returns the number
@@ -94,7 +110,7 @@ module Qpid
         annts.clear
         if !@annotations.nil?
           mapping = Qpid::Proton::Mapping.for_class(@annotations.class)
-          mapping.put(annts, @annotations)
+          mapping.put(annts, @annotations, :keys => :SYMBOL)
         end
         body = Qpid::Proton::Data.new(Cproton::pn_message_body(@impl))
         body.clear
@@ -372,6 +388,8 @@ module Qpid
       #
       # See MessageFormat for more details on formats.
       #
+      # *Warning:* This method has been deprecated.
+      #
       # ==== Options
       #
       # * format - the format
@@ -383,6 +401,12 @@ module Qpid
 
       # Returns the message format
       #
+      # *Warning:* This method has been deprecated.
+      #
+      # ==== Note
+      #
+      # This method is now deprecated.
+      #
       def format
         Qpid::Proton::MessageFormat.by_value(Cproton.pn_message_get_format(@impl))
       end
@@ -403,22 +427,6 @@ module Qpid
         Cproton.pn_message_get_content_type(@impl)
       end
 
-      # Sets the message content.
-      #
-      # ==== Options
-      #
-      # * content - the content
-      #
-      def content=(content)
-        Cproton.pn_message_load(@impl, content)
-      end
-
-      # Returns the message content.
-      #
-      def content
-        Cproton.pn_message_save(@impl, 1024)[1]
-      end
-
       # Sets the content encoding type.
       #
       # ==== Options
@@ -601,7 +609,7 @@ module Qpid
 
       def check(err) # :nodoc:
         if err < 0
-          raise DataError, "[#{err}]: #{Cproton.pn_message_error(@data)}"
+          raise DataError, "[#{err}]: #{Cproton.pn_message_error(@impl)}"
         else
           return err
         end