gqtp 1.0.0

data/lib/gqtp/parser.rb

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gqtp/error"
+require "gqtp/header"
+
+module GQTP
+  class ParseError < Error
+  end
+
+  class Parser
+    class << self
+      def parse(data, &block)
+        if block_given?
+          event_parse(data, &block)
+        else
+          stand_alone_parse(data)
+        end
+      end
+
+      private
+      def event_parse(data)
+        parser = new
+
+        parser.on_header do |header|
+          yield(:on_header, header)
+        end
+        parser.on_body do |chunk|
+          yield(:on_body, chunk)
+        end
+        parser.on_complete do
+          yield(:on_complete)
+        end
+
+        consume_data(parser, data)
+      end
+
+      def stand_alone_parse(data)
+        received_header = nil
+        body = "".force_encoding("ASCII-8BIT")
+        completed = false
+
+        parser = new
+        parser.on_header do |header|
+          received_header = header
+        end
+        parser.on_body do |chunk|
+          body << chunk
+        end
+        parser.on_complete do
+          completed = true
+        end
+
+        consume_data(parser, data)
+        raise ParseError, "not completed: <#{data.inspect}>" unless completed
+
+        [received_header, body]
+      end
+
+      def consume_data(parser, data)
+        if data.respond_to?(:each)
+          data.each do |chunk|
+            parser << chunk
+          end
+        else
+          parser << data
+        end
+      end
+    end
+
+    attr_reader :header
+    def initialize
+      reset
+      initialize_hooks
+    end
+
+    def <<(chunk)
+      if @header.nil?
+        parse_header(chunk)
+      else
+        parse_body(chunk)
+      end
+      self
+    end
+
+    # @overload on_header(header)
+    # @overload on_header {|header| }
+    def on_header(*arguments, &block)
+      if block_given?
+        @on_header_hook = block
+      else
+        @on_header_hook.call(*arguments) if @on_header_hook
+      end
+    end
+
+    # @overload on_body(chunk)
+    # @overload on_body {|chunk| }
+    def on_body(*arguments, &block)
+      if block_given?
+        @on_body_hook = block
+      else
+        @on_body_hook.call(*arguments) if @on_body_hook
+      end
+    end
+
+    # @overload on_complete
+    # @overload on_complete { }
+    def on_complete(&block)
+      if block_given?
+        @on_complete_hook = block
+      else
+        @on_complete_hook.call if @on_complete_hook
+      end
+    end
+
+    private
+    def reset
+      @buffer = "".force_encoding("ASCII-8BIT")
+      @header = nil
+      @body_size = 0
+    end
+
+    def initialize_hooks
+      @on_header_hook = nil
+      @on_body_hook = nil
+      @on_complete_hook = nil
+    end
+
+    def parse_header(chunk)
+      @buffer << chunk
+      return if @buffer.bytesize < Header.size
+      @header = Header.parse(@buffer)
+      on_header(@header)
+      buffer = @buffer
+      @buffer = nil
+      if buffer.bytesize > Header.size
+        parse_body(buffer[Header.size..-1])
+      end
+    end
+
+    def parse_body(chunk)
+      @body_size += chunk.bytesize
+      if @body_size < @header.size
+        on_body(chunk)
+      elsif @body_size == @header.size
+        on_body(chunk)
+        on_complete
+        reset
+      else
+        rest_body_size = @header.size - (@body_size - chunk.bytesize)
+        on_body(chunk[0, rest_body_size])
+        on_complete
+        reset
+        self << chunk[rest_body_size..-1]
+      end
+    end
+  end
+end

data/lib/gqtp/proxy.rb

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gqtp/server"
+
+module GQTP
+  class Proxy
+    attr_accessor :listen_address, :listen_port
+    attr_accessor :upstream_address, :upstream_port
+    def initialize(options={})
+      @options = options.dup
+      @listen_address = @options[:listen_address] || "0.0.0.0"
+      @listen_port = @options[:listen_port] || 10041
+      @upstream_address = @options[:upstream_address] || "127.0.0.1"
+      @upstream_port = @options[:upstream_port] || 10041
+      @connection = @options[:connection] || :thread
+      @server = Server.new(:address => @listen_address,
+                           :port => @listen_port,
+                           :connection => @connection)
+    end
+
+    def run
+      @server.on_connect do |client|
+        create_connection
+      end
+      @server.on_request do |request, client, connection|
+        connection.write(request.header.pack, request.body) do
+          read_header_request = connection.read(Header.size) do |header|
+            response_header = Header.parse(header)
+            read_body_request = connection.read(response_header.size) do |body|
+              client.write(header, body) do
+              end
+            end
+          end
+        end
+      end
+      @server.run
+    end
+
+    def shutdown
+      @server.shutdown
+    end
+
+    private
+    def create_connection
+      begin
+        require "gqtp/connection/#{@connection}"
+      rescue LoadError
+        raise "unknown connection: <#{@connection.inspect}>"
+      end
+
+      require "gqtp/connection/#{@connection}"
+      module_name = @connection.to_s.capitalize
+      connection_module = GQTP::Connection::const_get(module_name)
+      connection_module::Client.new(:address => @upstream_address,
+                                    :port => @upstream_port)
+    end
+  end
+end

data/lib/gqtp/server.rb

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gqtp/header"
+
+module GQTP
+  class Server
+    attr_accessor :address, :port
+    def initialize(options={})
+      @options = options.dup
+      @options[:address] ||= "0.0.0.0"
+      @options[:port] ||= 10041
+      @on_request = nil
+      @on_connect = nil
+    end
+
+    def run
+      @connection = create_connection
+      @connection.run do |client|
+        process_request(client, on_connect(client))
+      end
+    end
+
+    def shutdown
+      @connection.shutdown
+    end
+
+    def on_connect(*arguments, &block)
+      if block_given?
+        @on_connect = block
+      else
+        client, = arguments
+        if @on_connect
+          @on_connect.call(client)
+        else
+          nil
+        end
+      end
+    end
+
+    def on_request(*arguments, &block)
+      if block_given?
+        @on_request = block
+      else
+        request, client, connect_info = arguments
+        @on_request.call(request, client, connect_info)
+      end
+    end
+
+    private
+    def create_connection
+      connection = @options[:connection] || :thread
+
+      begin
+        require "gqtp/connection/#{connection}"
+      rescue LoadError
+        raise "unknown connection: <#{connection.inspect}>"
+      end
+
+      module_name = connection.to_s.capitalize
+      connection_module = GQTP::Connection::const_get(module_name)
+      connection_module::Server.new(@options)
+    end
+
+    def process_request(client, connect_info)
+      read_header_request = client.read(Header.size) do |header|
+        request_header = Header.parse(header)
+        read_body_request = client.read(request_header.size) do |body|
+          request = Request.new(request_header, body)
+          on_request(request, client, connect_info)
+          process_request(client, connect_info)
+        end
+      end
+    end
+
+    class Request
+      attr_reader :header, :body
+      def initialize(header, body)
+        @header = header
+        @body = body
+      end
+    end
+  end
+end

data/lib/gqtp/version.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module GQTP
+  VERSION = "1.0.0"
+end

data/lib/gqtp.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gqtp/version"
+require "gqtp/client"
+require "gqtp/server"
+require "gqtp/proxy"

data/test/run-test.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+$VERBOSE = true
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+
+$LOAD_PATH.unshift(lib_dir)
+
+require "test-unit"
+require "test/unit/notify"
+
+Thread.abort_on_exception = true
+
+exit Test::Unit::AutoRunner.run(true, test_dir)

data/test/test-client.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "socket"
+
+require "gqtp/client"
+
+class ClientTest < Test::Unit::TestCase
+  def setup
+    @address = "127.0.0.1"
+    @server = TCPServer.new(@address, 0)
+    @port = @server.addr[1]
+
+    @request_body = nil
+    @response_body = nil
+    @thread = Thread.new do
+      client = @server.accept
+      @server.close
+
+      header = GQTP::Header.parse(client.read(GQTP::Header.size))
+      @request_body = client.read(header.size)
+
+      response_header = GQTP::Header.new
+      response_header.size = @response_body.bytesize
+      client.write(response_header.pack)
+      client.write(@response_body)
+      client.close
+    end
+  end
+
+  def teardown
+    @thread.kill
+  end
+
+  def test_sync
+    @response_body = "[false]"
+    client = GQTP::Client.new(:address => @address, :port => @port)
+    client.send("status")
+    header, body = client.read
+    assert_equal(["status",      @response_body.bytesize, @response_body],
+                 [@request_body, header.size,             body])
+  end
+
+  def test_async
+    @response_body = "[false]"
+    client = GQTP::Client.new(:address => @address, :port => @port)
+    request = client.send("status") do |header, body|
+      assert_equal(["status",      @response_body.bytesize, @response_body],
+                   [@request_body, header.size,             body])
+    end
+    request.wait
+  end
+end

data/test/test-header.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gqtp/parser"
+
+class HeaderTest < Test::Unit::TestCase
+  class EqualTest < self
+    def test_true
+      assert_equal(GQTP::Header.new,
+                   GQTP::Header.new)
+    end
+
+    def test_false
+      header_size_0 = GQTP::Header.new
+      header_size_1 = GQTP::Header.new
+      header_size_1.size = 1
+      assert_not_equal(header_size_0, header_size_1)
+    end
+  end
+
+  class InitializeTest < self
+    def test_hash
+      header = GQTP::Header.new(:size => 29)
+      assert_equal(29, header.size)
+    end
+
+    def test_block
+      header = GQTP::Header.new do |h|
+        h.size = 29
+      end
+      assert_equal(29, header.size)
+    end
+  end
+end

data/test/test-parser.rb

@@ -0,0 +1,131 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "gqtp/parser"
+
+class ParserTest < Test::Unit::TestCase
+  def setup
+    @parser = GQTP::Parser.new
+  end
+
+  def test_on_header
+    received_header = nil
+    @parser.on_header do |header|
+      received_header = header
+    end
+
+    header = GQTP::Header.new
+    packed_header = header.pack
+    @parser << packed_header[0..-2]
+    assert_nil(received_header)
+    @parser << packed_header[-1..-1]
+    assert_equal(header, received_header)
+  end
+
+  def test_on_body
+    received_data = ""
+    @parser.on_body do |chunk|
+      received_data << chunk
+    end
+
+    data = "status"
+    header = GQTP::Header.new
+    header.size = data.bytesize
+
+    @parser << header.pack
+    assert_equal("", received_data)
+
+    @parser << data[0..-2]
+    assert_equal(data[0..-2], received_data)
+
+    @parser << data[-1..-1]
+    assert_equal(data, received_data)
+  end
+
+  def test_on_complete
+    completed = false
+    @parser.on_complete do
+      completed = true
+    end
+
+    data = "status"
+    header = GQTP::Header.new
+    header.size = data.bytesize
+
+    @parser << header.pack << data[0..-2]
+    assert_false(completed)
+
+    @parser << data[-1..-1]
+    assert_true(completed)
+  end
+
+  def test_parse_twice
+    body = "status"
+    header = GQTP::Header.new
+    header.size = body.bytesize
+
+    n_completed = 0
+    @parser.on_complete do
+      n_completed += 1
+    end
+    @parser << ((header.pack + body) * 2)
+    assert_equal(2, n_completed)
+  end
+
+  class ParseTest < self
+    def test_event
+      body = "status"
+      header = GQTP::Header.new
+      header.size = body.bytesize
+
+      events = []
+      GQTP::Parser.parse([header.pack, body]) do |event_type, *arguments|
+        events << [event_type, arguments]
+      end
+      assert_equal([
+                     [:on_header,   [header]],
+                     [:on_body,     [body]],
+                     [:on_complete, []],
+                   ],
+                   events)
+    end
+
+    class StandAloneTest < self
+      def test_success
+        body = "status"
+        header = GQTP::Header.new
+        header.size = body.bytesize
+
+        parsed_header, parsed_body = GQTP::Parser.parse([header.pack, body])
+        assert_equal([       header,        body],
+                     [parsed_header, parsed_body])
+      end
+
+      def test_not_completed
+        header = GQTP::Header.new
+        not_completed_data = header.pack[0..1]
+
+        message = "not completed: <#{not_completed_data.inspect}>"
+        exception = GQTP::ParseError.new(message)
+        assert_raise(exception) do
+          GQTP::Parser.parse(not_completed_data)
+        end
+      end
+    end
+  end
+end