thrift 0.9.0 → 0.9.1

data/lib/thrift.rb

@@ -62,5 +62,6 @@ require 'thrift/server/nonblocking_server'
 require 'thrift/server/simple_server'
 require 'thrift/server/threaded_server'
 require 'thrift/server/thread_pool_server'
+require 'thrift/server/thin_http_server'
 
 require 'thrift/thrift_native'

data/lib/thrift/exceptions.rb

@@ -37,6 +37,9 @@ module Thrift
     MISSING_RESULT = 5
     INTERNAL_ERROR = 6
     PROTOCOL_ERROR = 7
+    INVALID_TRANSFORM = 8
+    INVALID_PROTOCOL = 9
+    UNSUPPORTED_CLIENT_TYPE = 10
 
     attr_reader :type
 

data/lib/thrift/protocol/base_protocol.rb

@@ -125,6 +125,16 @@ module Thrift
       raise NotImplementedError
     end
 
+    # Writes a Thrift Binary (Thrift String with no encoding). In Ruby 1.9+, the String passed
+    # will forced into BINARY encoding.
+    #
+    # buf - The String to write.
+    #
+    # Returns nothing.
+    def write_binary(buf)
+      raise NotImplementedError
+    end
+
     def read_message_begin
       raise NotImplementedError
     end
@@ -185,21 +195,67 @@ module Thrift
       raise NotImplementedError
     end
 
-    # Reads a Thrift String. In Ruby 1.9+, all String will be returned with an Encoding of UTF-8.
+    # Reads a Thrift String. In Ruby 1.9+, all Strings will be returned with an Encoding of UTF-8.
     #
     # Returns a String.
     def read_string
       raise NotImplementedError
     end
 
-    def write_field(name, type, fid, value)
-      write_field_begin(name, type, fid)
-      write_type(type, value)
+    # Reads a Thrift Binary (Thrift String without encoding). In Ruby 1.9+, all Strings will be returned
+    # with an Encoding of BINARY.
+    #
+    # Returns a String.
+    def read_binary
+      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:
+    #              :name   - The name of the field.
+    #              :type   - The type of the field, which must be a Thrift::Types constant.
+    #              :binary - A Boolean flag that indicates if Thrift::Types::STRING is a binary string (string without encoding).
+    # fid        - The ID of the field.
+    # value      - The field's value to write; object type varies based on :type.
+    #
+    # Returns nothing.
+    def write_field(*args)
+      if args.size == 3
+        # handles the documented method signature - write_field(field_info, fid, value)
+        field_info = args[0]
+        fid = args[1]
+        value = args[2]
+      elsif args.size == 4
+        # handles the deprecated method signature - write_field(name, type, fid, value)
+        field_info = {:name => args[0], :type => args[1]}
+        fid = args[2]
+        value = args[3]
+      else
+        raise ArgumentError, "wrong number of arguments (#{args.size} for 3)"
+      end
+
+      write_field_begin(field_info[:name], field_info[:type], fid)
+      write_type(field_info, value)
       write_field_end
     end
 
-    def write_type(type, value)
-      case type
+    # Writes a field value based on the field information.
+    #
+    # field_info - A Hash containing the definition of the field:
+    #              :type   - The Thrift::Types constant that determines how the value is written.
+    #              :binary - A Boolean flag that indicates if Thrift::Types::STRING is a binary string (string without encoding).
+    # value      - The field's value to write; object type varies based on field_info[:type].
+    #
+    # Returns nothing.
+    def write_type(field_info, value)
+      # if field_info is a Fixnum, assume it is a Thrift::Types constant
+      # convert it into a field_info Hash for backwards compatibility
+      if field_info.is_a? Fixnum
+        field_info = {:type => field_info}
+      end
+
+      case field_info[:type]
       when Types::BOOL
         write_bool(value)
       when Types::BYTE
@@ -213,7 +269,11 @@ module Thrift
       when Types::I64
         write_i64(value)
       when Types::STRING
-        write_string(value)
+        if field_info[:binary]
+          write_binary(value)
+        else
+          write_string(value)
+        end
       when Types::STRUCT
         value.write(self)
       else
@@ -221,8 +281,21 @@ module Thrift
       end
     end
 
-    def read_type(type)
-      case type
+    # Reads a field value based on the field information.
+    #
+    # field_info - A Hash containing the pertinent data to write:
+    #              :type   - The Thrift::Types constant that determines how the value is written.
+    #              :binary - A flag that indicates if Thrift::Types::STRING is a binary string (string without encoding).
+    #
+    # 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
+      # convert it into a field_info Hash for backwards compatibility
+      if field_info.is_a? Fixnum
+        field_info = {:type => field_info}
+      end
+
+      case field_info[:type]
       when Types::BOOL
         read_bool
       when Types::BYTE
@@ -236,7 +309,11 @@ module Thrift
       when Types::I64
         read_i64
       when Types::STRING
-        read_string
+        if field_info[:binary]
+          read_binary
+        else
+          read_string
+        end
       else
         raise NotImplementedError
       end

data/lib/thrift/protocol/binary_protocol.rb

@@ -107,9 +107,13 @@ module Thrift
     end
 
     def write_string(str)
-      str = Bytes.convert_to_utf8_byte_buffer(str)
-      write_i32(str.length)
-      trans.write(str)
+      buf = Bytes.convert_to_utf8_byte_buffer(str)
+      write_binary(buf)
+    end
+
+    def write_binary(buf)
+      write_i32(buf.bytesize)
+      trans.write(buf)
     end
 
     def read_message_begin
@@ -214,11 +218,15 @@ module Thrift
     end
 
     def read_string
-      size = read_i32
-      buffer = trans.read_all(size)
+      buffer = read_binary
       Bytes.convert_to_string(buffer)
     end
 
+    def read_binary
+      size = read_i32
+      trans.read_all(size)
+    end
+
   end
 
   class BinaryProtocolFactory < BaseProtocolFactory

data/lib/thrift/protocol/compact_protocol.rb

@@ -210,9 +210,13 @@ module Thrift
     end
 
     def write_string(str)
-      str = Bytes.convert_to_utf8_byte_buffer(str)
-      write_varint32(str.length)
-      @trans.write(str)
+      buf = Bytes.convert_to_utf8_byte_buffer(str)
+      write_binary(buf)
+    end
+
+    def write_binary(buf)
+      write_varint32(buf.bytesize)
+      @trans.write(buf)
     end
 
     def read_message_begin
@@ -332,12 +336,15 @@ module Thrift
     end
 
     def read_string
-      size = read_varint32()
-      buffer = trans.read_all(size)
+      buffer = read_binary
       Bytes.convert_to_string(buffer)
     end
-    
-    
+
+    def read_binary
+      size = read_varint32()
+      trans.read_all(size)
+    end
+
     private
     
     # 

data/lib/thrift/protocol/json_protocol.rb

@@ -18,21 +18,6 @@
 # under the License.
 # 
 
-@@kJSONObjectStart = '{'
-@@kJSONObjectEnd = '}'
-@@kJSONArrayStart = '['
-@@kJSONArrayEnd = ']'
-@@kJSONNewline = '\n'
-@@kJSONElemSeparator = ','
-@@kJSONPairSeparator = ':'
-@@kJSONBackslash = '\\'
-@@kJSONStringDelimiter = '"'
-
-@@kThriftVersion1 = 1
-
-@@kThriftNan = "NaN"
-@@kThriftInfinity = "Infinity"
-@@kThriftNegativeInfinity = "-Infinity"
 
 module Thrift
   class LookaheadReader
@@ -66,6 +51,7 @@ module Thrift
   # implementations
   #
   class JSONContext
+    @@kJSONElemSeparator = ','
     #
     # Write context data to the trans. Default is to do nothing.
     #
@@ -89,6 +75,8 @@ module Thrift
 
   # Context class for object member key-value pairs
   class JSONPairContext < JSONContext
+    @@kJSONPairSeparator = ':'
+
     def initialize
       @first = true
       @colon = true
@@ -146,6 +134,21 @@ module Thrift
   end
 
   class JsonProtocol < BaseProtocol
+
+    @@kJSONObjectStart = '{'
+    @@kJSONObjectEnd = '}'
+    @@kJSONArrayStart = '['
+    @@kJSONArrayEnd = ']'
+    @@kJSONNewline = '\n'
+    @@kJSONBackslash = '\\'
+    @@kJSONStringDelimiter = '"'
+
+    @@kThriftVersion1 = 1
+
+    @@kThriftNan = "NaN"
+    @@kThriftInfinity = "Infinity"
+    @@kThriftNegativeInfinity = "-Infinity"
+
     def initialize(trans)
       super(trans)
       @context = JSONContext.new
@@ -717,6 +720,7 @@ module Thrift
 
     def read_set_begin
       read_json_array_start
+      [get_type_id_for_type_name(read_json_string), read_json_integer]
     end
 
     def read_set_end

data/lib/thrift/server/mongrel_http_server.rb

@@ -20,6 +20,7 @@
 require 'mongrel'
 
 ## Sticks a service on a URL, using mongrel to do the HTTP work
+# <b>DEPRECATED:</b> Please use <tt>Thrift::ThinHTTPServer</tt> instead.
 module Thrift
   class MongrelHTTPServer < BaseServer
     class Handler < Mongrel::HttpHandler
@@ -43,6 +44,7 @@ module Thrift
     end
 
     def initialize(processor, opts={})
+      Kernel.warn "[DEPRECATION WARNING] `Thrift::MongrelHTTPServer` is deprecated.  Please use `Thrift::ThinHTTPServer` instead."
       port = opts[:port] || 80
       ip = opts[:ip] || "0.0.0.0"
       path = opts[:path] || ""

data/lib/thrift/server/thin_http_server.rb

@@ -0,0 +1,91 @@
+#
+# 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 'rack'
+require 'thin'
+
+##
+# Wraps the Thin web server to provide a Thrift server over HTTP.
+module Thrift
+  class ThinHTTPServer < BaseServer
+
+    ##
+    # Accepts a Thrift::Processor
+    # Options include:
+    # * :port
+    # * :ip
+    # * :path
+    # * :protocol_factory
+    def initialize(processor, options={})
+      port = options[:port] || 80
+      ip = options[:ip] || "0.0.0.0"
+      path = options[:path] || "/"
+      protocol_factory = options[:protocol_factory] || BinaryProtocolFactory.new
+      app = RackApplication.for(path, processor, protocol_factory)
+      @server = Thin::Server.new(ip, port, app)
+    end
+
+    ##
+    # Starts the server
+    def serve
+      @server.start
+    end
+
+    class RackApplication
+
+      THRIFT_HEADER = "application/x-thrift"
+
+      def self.for(path, processor, protocol_factory)
+        Rack::Builder.new do
+          use Rack::CommonLogger
+          use Rack::ShowExceptions
+          use Rack::Lint
+          map path do
+            run lambda { |env|
+              request = Rack::Request.new(env)
+              if RackApplication.valid_thrift_request?(request)
+                RackApplication.successful_request(request, processor, protocol_factory)
+              else
+                RackApplication.failed_request
+              end
+            }
+          end
+        end
+      end
+
+      def self.successful_request(rack_request, processor, protocol_factory)
+        response = Rack::Response.new([], 200, {'Content-Type' => THRIFT_HEADER})
+        transport = IOStreamTransport.new rack_request.body, response
+        protocol = protocol_factory.get_protocol transport
+        processor.process protocol, protocol
+        response
+      end
+
+      def self.failed_request
+        Rack::Response.new(['Not Found'], 404, {'Content-Type' => THRIFT_HEADER})
+      end
+
+      def self.valid_thrift_request?(rack_request)
+        rack_request.post? && rack_request.env["CONTENT_TYPE"] == THRIFT_HEADER
+      end
+
+    end
+
+  end
+end

data/lib/thrift/struct.rb

@@ -105,7 +105,7 @@ module Thrift
             write_container(oprot, value, field_info)
             oprot.write_field_end
           else
-            oprot.write_field(name, type, fid, value)
+            oprot.write_field(field_info, fid, value)
           end
         end
       end

data/lib/thrift/struct_union.rb

@@ -101,7 +101,7 @@ module Thrift
         end
         iprot.read_set_end
       else
-        value = iprot.read_type(field[:type])
+        value = iprot.read_type(field)
       end
       value
     end
@@ -110,7 +110,7 @@ module Thrift
       if is_container? field[:type]
         write_container(oprot, value, field)
       else
-        oprot.write_type(field[:type], value)
+        oprot.write_type(field, value)
       end
     end
 

data/lib/thrift/transport/http_client_transport.rb

@@ -20,16 +20,18 @@
 
 require 'net/http'
 require 'net/https'
+require 'openssl'
 require 'uri'
 require 'stringio'
 
 module Thrift
   class HTTPClientTransport < BaseTransport
 
-    def initialize(url)
+    def initialize(url, opts = {})
       @url = URI url
       @headers = {'Content-Type' => 'application/x-thrift'}
       @outbuf = Bytes.empty_byte_buffer
+      @ssl_verify_mode = opts.fetch(:ssl_verify_mode, OpenSSL::SSL::VERIFY_PEER)
     end
 
     def open?; true end
@@ -43,6 +45,7 @@ module Thrift
     def flush
       http = Net::HTTP.new @url.host, @url.port
       http.use_ssl = @url.scheme == 'https'
+      http.verify_mode = @ssl_verify_mode if @url.scheme == 'https'
       resp = http.post(@url.request_uri, @outbuf, @headers)
       data = resp.body
       data = Bytes.force_binary_encoding(data)