droonga-client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8451550565af3065d58578612f6a93f66346a5d2
-  data.tar.gz: 24a9b4f1bd9d8a055ac12d100a324590fb527ca9
+  metadata.gz: 8624d5def9e15c15e068add4c8f60f007fcb6d21
+  data.tar.gz: 5ae5c17b038077337bf1653de18243c39afe7250
 SHA512:
-  metadata.gz: 5b5ec6bfd26accbe56311256ef64fe349cbcad404fdf659da43c5d19558277abe21c342e621e95d81e94560abd56d6e0c49b1c8ce402bbd6e0509401da7d823f
-  data.tar.gz: a83b71c182458ae873ad27913defd1f67172a04a302f7ec67d977ccd6acd48f3f8307bab72b2054e7c330a65ba705c6d65ad2bf15c0045975d57111df8398803
+  metadata.gz: 3cf44081bdd4f97c0cab49adbd8d64be5270465608f291dcc492441eae82d6eb522aa694e790dfedad7d6db46b77a04ed1c75e5df75771e7ab918a47b9b482c4
+  data.tar.gz: a7e2fd87920b468f14beb8169fef80490351d0cbf8e151cedce15f74fdb50dddff724739215a56027afc035d028175c2b5f639a9d778a4be748369b659c33c31

data/doc/text/news.md

@@ -1,5 +1,14 @@
 # News
 
+## 0.1.0: 2013-12-29
+
+### Improvements
+
+  * Added {Droonga::Client.open}.
+  * Added {Droonga::Client#close}.
+  * Supported multiple responses.
+  * Supported asynchronous request.
+
 ## 0.0.1: 2013-11-29
 
 The first release!!!

data/lib/droonga/client/connection/droonga_protocol.rb

@@ -16,6 +16,7 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 require "socket"
+require "thread"
 require "msgpack"
 require "fluent-logger"
 
@@ -23,20 +24,32 @@ module Droonga
   class Client
     module Connection
       class DroongaProtocol
+        class Request
+          def initialize(thread)
+            @thread = thread
+          end
+
+          def wait
+            @thread.join
+          end
+        end
+
         def initialize(options={})
           default_options = {
-            :tag     => "droonga",
-            :host    => "127.0.0.1",
-            :port    => 24224,
-            :timeout => 5
+            :tag             => "droonga",
+            :host            => "127.0.0.1",
+            :port            => 24224,
+            :connect_timeout => 1,
+            :read_timeout    => 0.1,
           }
           options = default_options.merge(options)
           @logger = Fluent::Logger::FluentLogger.new(options.delete(:tag),
                                                      options)
-          @timeout = options[:timeout]
+          @connect_timeout = options[:connect_timeout]
+          @read_timeout = options[:read_timeout]
         end
 
-        def search(body)
+        def search(body, &block)
           envelope = {
             "id"         => Time.now.to_f.to_s,
             "date"       => Time.now,
@@ -44,42 +57,88 @@ module Droonga
             "type"       => "search",
             "body"       => body,
           }
-          send(envelope, :response => :one)
+          execute(envelope, &block)
         end
 
-        # Sends low level request. Normally, you should use other
-        # convenience methods.
+        # Sends a request message and receives one ore more response
+        # messages.
         #
-        # @param envelope [Hash] Request envelope.
-        # @param options [Hash] The options to send request.
-        # @option options :response [nil, :none, :one] (nil) The response type.
-        #   If you specify `nil`, it is treated as `:one`.
-        # @return The response. TODO: WRITE ME
-        def send(envelope, options={})
-          response_type = options[:response] || :one
-          case response_type
-          when :none
-            @logger.post("message", envelope)
-          when :one
-            receiver = Receiver.new
+        # @overload execute(message, options={})
+        #   Executes the request message synchronously.
+        #
+        #   @param message [Hash] Request message.
+        #   @param options [Hash] The options to executes a request.
+        #      TODO: WRITE ME
+        #
+        #   @return [Object] The response. TODO: WRITE ME
+        #
+        # @overload execute(message, options={}, &block)
+        #   Executes the passed request message asynchronously.
+        #
+        #   @param message [Hash] Request message.
+        #   @param options [Hash] The options to executes a request.
+        #      TODO: WRITE ME
+        #   @yield [response]
+        #      The block is called when response is received.
+        #   @yieldparam [Object] response
+        #      The response.
+        #
+        #   @return [Request] The request object.
+        def execute(message, options={}, &block)
+          receiver = Receiver.new
+          message = message.dup
+          message["replyTo"] = "#{receiver.host}:#{receiver.port}/droonga"
+          send(message, options)
+
+          connect_timeout = options[:connect_timeout] || @connect_timeout
+          read_timeout = options[:read_timeout] || @read_timeout
+          receive_options = {
+            :connect_timeout => connect_timeout,
+            :read_timeout    => read_timeout
+          }
+          sync = block.nil?
+          if sync
             begin
-              envelope = envelope.dup
-              envelope["replyTo"] = "#{receiver.host}:#{receiver.port}/droonga"
-              @logger.post("message", envelope)
-              receiver.receive(:timeout => @timeout)
+              receiver.receive(receive_options)
             ensure
               receiver.close
             end
           else
-            raise InvalidResponseType.new(response_type)
+            thread = Thread.new do
+              begin
+                response = receiver.receive(receive_options)
+                yield(response) if response
+              ensure
+                receiver.close
+              end
+            end
+            Request.new(thread)
           end
         end
 
+        # Sends low level request. Normally, you should use other
+        # convenience methods.
+        #
+        # @param envelope [Hash] Request envelope.
+        # @param options [Hash] The options to send request.
+        #   TODO: WRITE ME
+        # @return [void]
+        def send(envelope, options={}, &block)
+          @logger.post("message", envelope)
+        end
+
+        # Close the connection. This connection can't be used anymore.
+        #
+        # @return [void]
+        def close
+          @logger.close
+        end
+
         class Receiver
           def initialize(options={})
             default_options = {
-              :host => "0.0.0.0",
-              :port => 0,
+              :host            => "0.0.0.0",
+              :port            => 0,
             }
             options = default_options.merge(options)
             @socket = TCPServer.new(options[:host], options[:port])
@@ -97,19 +156,38 @@ module Droonga
             @socket.addr[1]
           end
 
+          BUFFER_SIZE = 8192
           def receive(options={})
-            if IO.select([@socket], nil, nil, options[:timeout])
+            responses = []
+            select(@socket, options[:connect_timeout]) do
               client = @socket.accept
-              response = nil
-              unpacker = MessagePack::Unpacker.new(client)
-              unpacker.each do |object|
-                response = object
-                break
+              unpacker = MessagePack::Unpacker.new
+              select(client, options[:read_timeout]) do
+                data = client.read_nonblock(BUFFER_SIZE)
+                unpacker.feed_each(data) do |object|
+                  responses << object
+                end
               end
               client.close
-              response
-            else
-              nil
+            end
+            # TODO: ENABLE ME
+            # if responses.size >= 2
+            #   responses
+            # else
+              responses.first
+            # end
+          end
+
+          private
+          def select(input, timeout)
+            loop do
+              start = Time.now
+              readables, = IO.select([input], nil, nil, timeout)
+              timeout -= (Time.now - start)
+              timeout /= 2.0
+              timeout = 0 if timeout < 0
+              break if readables.nil?
+              yield(timeout)
             end
           end
         end

data/lib/droonga/client/version.rb

@@ -17,6 +17,6 @@
 
 module Droonga
   class Client
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/droonga/client.rb

@@ -21,8 +21,40 @@ require "droonga/client/connection/droonga_protocol"
 
 module Droonga
   class Client
+    class << self
+      # Opens a new connection and yields a {Client} object to use the
+      # connection. The client is closed after the given block is
+      # finished.
+      #
+      # @param (see #initialize)
+      #
+      # @yield [client] Gives the opened client. It is alive while yielding.
+      # @yieldparam client [Client] The opened client.
+      #
+      # @return The return value from the given block.
+      def open(options={})
+        client = new(options)
+        begin
+          yield(client)
+        ensure
+          client.close
+        end
+      end
+    end
+
     attr_reader :connection
 
+    # Creates a new Droonga Engine client.
+    #
+    # @param options [Hash] Options to connect Droonga Engine.
+    # @option options [String] :tag ("droonga") The tag of the request message.
+    # @option options [String] :host ("127.0.0.1")
+    #   The host name or IP address of the Droonga Engine to be connected.
+    # @option options [Integer] :port (24224)
+    #   The port number of the Droonga Engine to be connected.
+    # @option options [Integer] :timeout (5)
+    #   The timeout value for connecting to, writing to and reading
+    #   from Droonga Engine.
     def initialize(options={})
       @connection = Connection::DroongaProtocol.new(options)
     end
@@ -30,5 +62,13 @@ module Droonga
     def search(body)
       @connection.search(body)
     end
+
+    # Close the connection used by the client. You can't send any
+    # request anymore.
+    #
+    # @return [void]
+    def close
+      @connection.close
+    end
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: droonga-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Droonga Project
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
   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'
 - !ruby/object:Gem::Dependency
   name: fluent-logger
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: packnga
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Droonga client for Ruby
@@ -87,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".yardopts"
+- .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,17 +110,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Droonga client for Ruby