thrift 0.22.0 → 0.23.0

data/lib/thrift/protocol/base_protocol.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
@@ -6,16 +6,16 @@
 # 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.
-# 
+#
 
 # this require is to make generated struct definitions happy
 require 'set'
@@ -33,7 +33,7 @@ module Thrift
 
     attr_reader :type
 
-    def initialize(type=UNKNOWN, message=nil)
+    def initialize(type = UNKNOWN, message = nil)
       super(message)
       @type = type
     end
@@ -116,7 +116,7 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Writes a Thrift String. In Ruby 1.9+, the String passed will be transcoded to UTF-8.
+    # Writes a Thrift String. The String passed will be transcoded to UTF-8.
     #
     # str - The String to write.
     #
@@ -127,7 +127,7 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Writes a Thrift Binary (Thrift String with no encoding). In Ruby 1.9+, the String passed
+    # Writes a Thrift Binary (Thrift String with no encoding). The String passed
     # will forced into BINARY encoding.
     #
     # buf - The String to write.
@@ -137,6 +137,15 @@ module Thrift
       raise NotImplementedError
     end
 
+    # Writes a UUID as 16 bytes.
+    #
+    # uuid - The UUID string to write (e.g. "550e8400-e29b-41d4-a716-446655440000").
+    #
+    # Returns nothing.
+    def write_uuid(uuid)
+      raise NotImplementedError
+    end
+
     def read_message_begin
       raise NotImplementedError
     end
@@ -197,14 +206,14 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Reads a Thrift String. In Ruby 1.9+, all Strings will be returned with an Encoding of UTF-8.
+    # Reads a Thrift String. All Strings will be returned with an Encoding of UTF-8.
     #
     # Returns a String.
     def read_string
       raise NotImplementedError
     end
 
-    # Reads a Thrift Binary (Thrift String without encoding). In Ruby 1.9+, all Strings will be returned
+    # Reads a Thrift Binary (Thrift String without encoding). All Strings will be returned
     # with an Encoding of BINARY.
     #
     # Returns a String.
@@ -212,6 +221,13 @@ module Thrift
       raise NotImplementedError
     end
 
+    # Reads a UUID as 16 bytes and returns it as a string.
+    #
+    # Returns a String (e.g. "550e8400-e29b-41d4-a716-446655440000").
+    def read_uuid
+      raise NotImplementedError
+    end
+
     # Writes a field based on the field information, field ID and value.
     #
     # field_info - A Hash containing the definition of the field:
@@ -251,9 +267,9 @@ module Thrift
     #
     # Returns nothing.
     def write_type(field_info, value)
-      # if field_info is a Fixnum, assume it is a Thrift::Types constant
+      # if field_info is a Integer, assume it is a Thrift::Types constant
       # convert it into a field_info Hash for backwards compatibility
-      if field_info.is_a? Fixnum
+      if field_info.is_a? Integer
         field_info = {:type => field_info}
       end
 
@@ -276,6 +292,8 @@ module Thrift
         else
           write_string(value)
         end
+      when Types::UUID
+        write_uuid(value)
       when Types::STRUCT
         value.write(self)
       else
@@ -291,9 +309,9 @@ module Thrift
     #
     # Returns the value read; object type varies based on field_info[:type].
     def read_type(field_info)
-      # if field_info is a Fixnum, assume it is a Thrift::Types constant
+      # if field_info is a Integer, assume it is a Thrift::Types constant
       # convert it into a field_info Hash for backwards compatibility
-      if field_info.is_a? Fixnum
+      if field_info.is_a? Integer
         field_info = {:type => field_info}
       end
 
@@ -316,6 +334,8 @@ module Thrift
         else
           read_string
         end
+      when Types::UUID
+        read_uuid
       else
         raise NotImplementedError
       end
@@ -337,6 +357,8 @@ module Thrift
         read_double
       when Types::STRING
         read_string
+      when Types::UUID
+        read_uuid
       when Types::STRUCT
         read_struct_begin
         while true
@@ -369,7 +391,7 @@ module Thrift
         raise ProtocolException.new(ProtocolException::INVALID_DATA, 'Invalid data')
       end
     end
-    
+
     def to_s
       "#{trans.to_s}"
     end
@@ -379,7 +401,7 @@ module Thrift
     def get_protocol(trans)
       raise NotImplementedError
     end
-    
+
     def to_s
       "base"
     end

data/lib/thrift/protocol/binary_protocol.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
@@ -6,26 +6,26 @@
 # 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.
-# 
+#
 
 module Thrift
   class BinaryProtocol < BaseProtocol
     VERSION_MASK = 0xffff0000
     VERSION_1 = 0x80010000
     TYPE_MASK = 0x000000ff
-    
+
     attr_reader :strict_read, :strict_write
 
-    def initialize(trans, strict_read=true, strict_write=true)
+    def initialize(trans, strict_read = true, strict_write = true)
       super(trans)
       @strict_read = strict_read
       @strict_write = strict_write
@@ -36,7 +36,7 @@ module Thrift
     end
 
     def write_message_begin(name, type, seqid)
-      # this is necessary because we added (needed) bounds checking to 
+      # this is necessary because we added (needed) bounds checking to
       # write_i32, and 0x80010000 is too big for that.
       if strict_write
         write_i16(VERSION_1 >> 16)
@@ -82,20 +82,24 @@ module Thrift
     end
 
     def write_byte(byte)
+      raise 'nil argument not allowed!' if byte.nil?
       raise RangeError if byte < -2**31 || byte >= 2**32
       trans.write([byte].pack('c'))
     end
 
     def write_i16(i16)
+      raise 'nil argument not allowed!' if i16.nil?
       trans.write([i16].pack('n'))
     end
 
     def write_i32(i32)
+      raise 'nil argument not allowed!' if i32.nil?
       raise RangeError if i32 < -2**31 || i32 >= 2**31
       trans.write([i32].pack('N'))
     end
 
     def write_i64(i64)
+      raise 'nil argument not allowed!' if i64.nil?
       raise RangeError if i64 < -2**63 || i64 >= 2**64
       hi = i64 >> 32
       lo = i64 & 0xffffffff
@@ -103,19 +107,27 @@ module Thrift
     end
 
     def write_double(dub)
+      raise 'nil argument not allowed!' if dub.nil?
       trans.write([dub].pack('G'))
     end
 
     def write_string(str)
+      raise 'nil argument not allowed!' if str.nil?
       buf = Bytes.convert_to_utf8_byte_buffer(str)
       write_binary(buf)
     end
 
     def write_binary(buf)
+      raise 'nil argument not allowed!' if buf.nil?
       write_i32(buf.bytesize)
       trans.write(buf)
     end
 
+    def write_uuid(uuid)
+      UUID.validate_uuid!(uuid)
+      trans.write(UUID.uuid_bytes(uuid))
+    end
+
     def read_message_begin
       version = read_i32
       if version < 0
@@ -226,7 +238,11 @@ module Thrift
       size = read_i32
       trans.read_all(size)
     end
-    
+
+    def read_uuid
+      UUID.uuid_from_bytes(trans.read_all(16))
+    end
+
     def to_s
       "binary(#{super.to_s})"
     end
@@ -236,7 +252,7 @@ module Thrift
     def get_protocol(trans)
       return Thrift::BinaryProtocol.new(trans)
     end
-    
+
     def to_s
       "binary"
     end

data/lib/thrift/protocol/binary_protocol_accelerated.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
@@ -6,20 +6,20 @@
 # 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.
-# 
+#
 
 =begin
 The only change required for a transport to support BinaryProtocolAccelerated is to implement 2 methods:
-  * borrow(size), which takes an optional argument and returns atleast _size_ bytes from the transport, 
+  * borrow(size), which takes an optional argument and returns atleast _size_ bytes from the transport,
                   or the default buffer size if no argument is given
   * consume!(size), which removes size bytes from the front of the buffer
 

data/lib/thrift/protocol/compact_protocol.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
@@ -6,16 +6,16 @@
 # 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.
-# 
+#
 
 module Thrift
   class CompactProtocol < BaseProtocol
@@ -27,11 +27,11 @@ module Thrift
     TYPE_BITS = 0x07
     TYPE_SHIFT_AMOUNT = 5
 
-    TSTOP = ["", Types::STOP, 0]
+    TSTOP = [nil, Types::STOP, 0]
 
-    # 
+    #
     # All of the on-wire type codes.
-    # 
+    #
     class CompactTypes
       BOOLEAN_TRUE   = 0x01
       BOOLEAN_FALSE  = 0x02
@@ -45,11 +45,12 @@ module Thrift
       SET            = 0x0A
       MAP            = 0x0B
       STRUCT         = 0x0C
-      
+      UUID           = 0x0D
+
       def self.is_bool_type?(b)
         (b & 0x0f) == BOOLEAN_TRUE || (b & 0x0f) == BOOLEAN_FALSE
       end
-      
+
       COMPACT_TO_TTYPE = {
         Types::STOP   => Types::STOP,
         BOOLEAN_FALSE => Types::BOOL,
@@ -63,7 +64,8 @@ module Thrift
         LIST          => Types::LIST,
         SET           => Types::SET,
         MAP           => Types::MAP,
-        STRUCT        => Types::STRUCT
+        STRUCT        => Types::STRUCT,
+        UUID          => Types::UUID
       }
 
       TTYPE_TO_COMPACT = {
@@ -78,15 +80,16 @@ module Thrift
         Types::LIST           => LIST,
         Types::SET            => SET,
         Types::MAP            => MAP,
-        Types::STRUCT         => STRUCT
+        Types::STRUCT         => STRUCT,
+        Types::UUID           => UUID
       }
-      
+
       def self.get_ttype(compact_type)
         val = COMPACT_TO_TTYPE[compact_type & 0x0f]
         raise "don't know what type: #{compact_type & 0x0f}" unless val
         val
       end
-      
+
       def self.get_compact_type(ttype)
         val = TTYPE_TO_COMPACT[ttype]
         raise "don't know what type: #{ttype & 0x0f}" unless val
@@ -107,7 +110,7 @@ module Thrift
     def write_message_begin(name, type, seqid)
       write_byte(PROTOCOL_ID)
       write_byte((VERSION & VERSION_MASK) | ((type << TYPE_SHIFT_AMOUNT) & TYPE_MASK))
-      write_varint32(seqid)
+      write_varint32(message_seqid_to_varint32(seqid))
       write_string(name)
       nil
     end
@@ -132,14 +135,14 @@ module Thrift
       nil
     end
 
-    # 
-    # The workhorse of writeFieldBegin. It has the option of doing a 
-    # 'type override' of the type header. This is used specifically in the 
+    #
+    # The workhorse of writeFieldBegin. It has the option of doing a
+    # 'type override' of the type header. This is used specifically in the
     # boolean field case.
-    # 
-    def write_field_begin_internal(type, id, type_override=nil)
+    #
+    def write_field_begin_internal(type, id, type_override = nil)
       last_id = @last_field.pop
-      
+
       # if there's a type override, use that.
       typeToWrite = type_override || CompactTypes.get_compact_type(type)
 
@@ -220,20 +223,25 @@ module Thrift
       @trans.write(buf)
     end
 
+    def write_uuid(uuid)
+      UUID.validate_uuid!(uuid)
+      trans.write(UUID.uuid_bytes(uuid))
+    end
+
     def read_message_begin
       protocol_id = read_byte()
       if protocol_id != PROTOCOL_ID
         raise ProtocolException.new("Expected protocol id #{PROTOCOL_ID} but got #{protocol_id}")
       end
-      
+
       version_and_type = read_byte()
       version = version_and_type & VERSION_MASK
       if (version != VERSION)
         raise ProtocolException.new("Expected version #{VERSION} but got #{version}");
       end
-      
+
       type = (version_and_type >> TYPE_SHIFT_AMOUNT) & TYPE_BITS
-      seqid = read_varint32()
+      seqid = message_seqid_from_varint32(read_varint32())
       messageName = read_string()
       [messageName, type, seqid]
     end
@@ -276,7 +284,7 @@ module Thrift
 
         # push the new field onto the field stack so we can keep the deltas going.
         @last_field.push(field_id)
-        ["", CompactTypes.get_ttype(type & 0x0f), field_id]
+        [nil, CompactTypes.get_ttype(type & 0x0f), field_id]
       end
     end
 
@@ -345,17 +353,21 @@ module Thrift
       size = read_varint32()
       trans.read_all(size)
     end
-    
+
+    def read_uuid
+      UUID.uuid_from_bytes(trans.read_all(16))
+    end
+
     def to_s
       "compact(#{super.to_s})"
     end
 
     private
-    
-    # 
-    # Abstract method for writing the start of lists and sets. List and sets on 
+
+    #
+    # Abstract method for writing the start of lists and sets. List and sets on
     # the wire differ only by the type indicator.
-    # 
+    #
     def write_collection_begin(elem_type, size)
       if size <= 14
         write_byte(size << 4 | CompactTypes.get_compact_type(elem_type))
@@ -387,7 +399,7 @@ module Thrift
 
     def write_varint64(n)
       while true
-        if (n & EVERYTHING_ELSE_MASK) == 0 #TODO need to find a way to make this into a long...
+        if (n & EVERYTHING_ELSE_MASK) == 0 # TODO need to find a way to make this into a long...
           write_byte(n)
           break
         else
@@ -396,11 +408,11 @@ module Thrift
         end
       end
     end
-    
+
     def read_varint32()
       read_varint64()
     end
-    
+
     def read_varint64()
       shift = 0
       result = 0
@@ -412,30 +424,42 @@ module Thrift
       end
       result
     end
-    
+
     def int_to_zig_zag(n)
       (n << 1) ^ (n >> 31)
     end
-    
+
     def long_to_zig_zag(l)
       # puts "zz encoded #{l} to #{(l << 1) ^ (l >> 63)}"
       (l << 1) ^ (l >> 63)
     end
-    
+
     def zig_zag_to_int(n)
       (n >> 1) ^ -(n & 1)
     end
-    
+
     def zig_zag_to_long(n)
       (n >> 1) ^ -(n & 1)
     end
+
+    def message_seqid_to_varint32(seqid)
+      if seqid < -(2**31) || seqid > (2**31) - 1
+        raise RangeError, "seqid must be a signed int32"
+      end
+
+      seqid < 0 ? seqid + (2**32) : seqid
+    end
+
+    def message_seqid_from_varint32(seqid)
+      seqid > 0x7fffffff ? seqid - (2**32) : seqid
+    end
   end
 
   class CompactProtocolFactory < BaseProtocolFactory
     def get_protocol(trans)
       CompactProtocol.new(trans)
     end
-    
+
     def to_s
       "compact"
     end