groonga-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 486d7005cfe3c244166bdc9227958043b53115ed
+  data.tar.gz: 08cf812cc95984efa717aa75319ccc2cb1521386
+SHA512:
+  metadata.gz: f9222918a4338736caa918355a77c964a74e0b0a6c861942d3c2314d6e189ac869c6200d751a5be3afe2a267e21aa40689594696a5095ecd558f61708a71cd4e
+  data.tar.gz: 299134381bc0235bba588869339d748c034025f306b50e49bd148246a97c79d9814cdad1a41a5d30ddd6adc35640dbca5090a6cf0300c6b793be3f1815bd5281

data/.yardopts

@@ -0,0 +1,4 @@
+--output-dir doc/reference/en
+lib/**/*.rb
+-
+doc/text/**/*

data/Gemfile

@@ -0,0 +1,21 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@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
+
+source "https://rubygems.org/"
+
+gemspec

data/README.md

@@ -0,0 +1,66 @@
+# README
+
+## Name
+
+groonga-client
+
+## Description
+
+Groonga-client is a client for groonga (http://groonga.org/)
+implemented with pure ruby.
+
+Groonga-client gem supports HTTP or
+[GQTP (Groonga Query Transfer Protocol)](http://groonga.org/docs/spec/gqtp.html)
+as the protocol using a client. You can use it without groonga
+package.
+
+## Install
+
+    % gem install groonga-client
+
+## Usage
+
+TODO: use commands with parameters for examples
+(e.g. table_create, load, select)
+
+### GQTP
+
+  Groonga::Client.open(:host => host, :port => port, :protocol => :gqtp) do |client|
+    tables = client.table_list
+    tables.each do |table|
+      table.name
+    end
+  end
+
+### HTTP
+
+  Groonga::Client.open(:host => host, :port => port, :protocol => :http) do |client|
+    tables = client.table_list
+    tables.each do |table|
+      table.name
+    end
+  end
+
+## Dependencies
+
+* Ruby 1.9.3
+
+## Mailing list
+
+* English: [groonga-talk@lists.sourceforge.net](https://lists.sourceforge.net/lists/listinfo/groonga-talk)
+* Japanese: [groonga-dev@lists.sourceforge.jp](http://lists.sourceforge.jp/mailman/listinfo/groonga-dev)
+
+## Thanks
+
+* ...
+
+## Authors
+
+* Haruka Yoshihara \<yoshihara@clear-code.com\>
+
+## License
+
+LGPLv2.1 or later. See doc/text/lgpl-2.1.txt for details.
+
+(Kouhei Sutou has a right to change the license including contributed
+patches.)

data/Rakefile

@@ -0,0 +1,44 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@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
+
+task :default => :test
+
+require "rubygems"
+require "bundler/gem_helper"
+require "packnga"
+
+base_dir = File.join(File.dirname(__FILE__))
+
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+
+helper.install
+spec = helper.gemspec
+
+Packnga::DocumentTask.new(spec) do
+end
+
+Packnga::ReleaseTask.new(spec) do
+end
+
+desc "Run tests"
+task :test do
+  ruby("test/run-test.rb")
+end

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# NEWS
+
+## 0.0.1 - 2013-06-27
+
+Initial release!!!

data/groonga-client.gemspec

@@ -0,0 +1,58 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@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
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+require "groonga/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "groonga-client"
+  spec.version = Groonga::Client::VERSION
+  spec.homepage = "https://github.com/ranguba/groonga-client"
+  spec.authors = ["Haruka Yoshihara", "Kouhei Sutou", "Kosuke Asami"]
+  spec.email = ["yshr04hrk@gmail.com", "kou@clear-code.com", "tfortress58@gmail.com"]
+
+  readme = File.read("README.md")
+  readme.force_encoding("UTF-8") if readme.respond_to?(:force_encoding)
+  entries = readme.split(/^\#\#\s(.*)$/)
+  clean_white_space.call(entries[entries.index("Description") + 1])
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "LGPLv2.1 or later"
+  spec.files = ["README.md", "Rakefile", "Gemfile", "#{spec.name}.gemspec"]
+  spec.files += [".yardopts"]
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("doc/text/*")
+  spec.test_files += Dir.glob("test/**/*")
+  # Dir.chdir("bin") do
+  #   spec.executables = Dir.glob("*")
+  # end
+
+  spec.add_runtime_dependency("gqtp")
+  spec.add_runtime_dependency("groonga-command", ">= 1.0.1")
+
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("test-unit")
+  spec.add_development_dependency("test-unit-notify")
+  spec.add_development_dependency("packnga")
+  spec.add_development_dependency("redcarpet")
+end

data/lib/groonga/client.rb

@@ -0,0 +1,165 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@clear-code.com>
+# Copyright (C) 2013  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 "groonga/client/command"
+require "groonga/client/protocol/gqtp"
+require "groonga/client/protocol/http"
+
+module Groonga
+  class Client
+    class << self
+      def open(options={}, &block)
+        client = new(options)
+        if block_given?
+          yield(client)
+          client.close
+        else
+          client
+        end
+      end
+    end
+
+    attr_reader :protocol
+    attr_reader :connection
+
+    def initialize(options)
+      @protocol = options.delete(:protocol) || :gqtp
+
+      @connection = nil
+      if @protocol == :gqtp
+        @connection = Groonga::Client::Protocol::GQTP.new(options)
+      else
+        @connection = Groonga::Client::Protocol::HTTP.new(options)
+      end
+    end
+
+    def close
+    end
+
+    def cache_limit(parameters)
+      execute_command("cache_limit", parameters)
+    end
+
+    def check(parameters)
+      execute_command("check", parameters)
+    end
+
+    def clearlock(parameters={})
+      execute_command("clearlock", parameters)
+    end
+
+    def column_create(parameters)
+      execute_command("column_create", parameters)
+    end
+
+    def column_list(parameters)
+      execute_command("column_list", parameters)
+    end
+
+    def column_remove(parameters)
+      execute_command("column_remove", parameters)
+    end
+
+    def column_rename(parameters)
+      execute_command("column_rename", parameters)
+    end
+
+    def defrag(parameters={})
+      execute_command("defrag", parameters)
+    end
+
+    def delete(parameters)
+      execute_command("delete", parameters)
+    end
+
+    def dump(parameters={})
+      execute_command("dump", parameters)
+    end
+
+    def load(parameters)
+      execute_command("load", parameters)
+    end
+
+    def log_level(parameters)
+      execute_command("log_level", parameters)
+    end
+
+    def log_put(parameters)
+      execute_command("log_put", parameters)
+    end
+
+    def log_reopen(parameters={})
+      execute_command("log_reopen", parameters)
+    end
+
+    def quit(parameters={})
+      execute_command("quit", parameters)
+    end
+
+    def register(parameters)
+      execute_command("register", parameters)
+    end
+
+    def select(parameters)
+    end
+
+    def shutdown(parameters={})
+    end
+
+    def status(parameters={})
+      execute_command("status", parameters)
+    end
+
+    def table_create(parameters)
+    end
+
+    def table_list(parameters={})
+      execute_command("table_list", parameters)
+    end
+
+    def table_remove(parameters)
+    end
+
+    def table_rename(parameters)
+    end
+
+    def truncate(parameters)
+    end
+
+    def execute(command, &block)
+      Client::Command.new(command).execute(@connection, &block)
+    end
+
+    private
+    def execute_command(command_name, parameters={})
+      parameters = normalize_parameters(parameters)
+      command_class = Groonga::Command.find(command_name)
+      command = command_class.new(command_name, parameters)
+      execute(command)
+    end
+
+    def normalize_parameters(parameters)
+      normalized_parameters = {}
+      parameters.each do |key, value|
+        normalized_parameters[key] = value.to_s
+      end
+      normalized_parameters
+    end
+  end
+end

data/lib/groonga/client/command.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@clear-code.com>
+# Copyright (C) 2013  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 "groonga/command"
+require "groonga/client/response"
+
+module Groonga
+  class Client
+    class Command
+      def initialize(command)
+        @command = command
+      end
+
+      def execute(connection)
+        async = block_given?
+
+        response = nil
+        request = connection.send(@command) do |raw_response|
+          response_class = Groonga::Client::Response.find(@command.name)
+          response = response_class.parse(raw_response, @command.output_type)
+          yield(response) if async
+        end
+
+        if async
+          request
+        else
+          request.wait
+          response
+        end
+      end
+    end
+  end
+end

data/lib/groonga/client/protocol/gqtp.rb

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2013  Haruka Yoshihara <yoshihara@clear-code.com>
+# Copyright (C) 2013  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 "erb"
+
+require "gqtp"
+require "json"
+
+module Groonga
+  class Client
+    module Protocol
+      class GQTP
+        def initialize(options)
+          @client = ::GQTP::Client.new(options)
+        end
+
+        def send(command)
+          formatted_command = command.to_command_format
+          raw_response = RawResponse.new(command)
+          @client.send(formatted_command) do |header, body|
+            raw_response.header = header
+            raw_response.body = body
+            response = raw_response.to_groonga_command_compatible_response
+            yield(response)
+          end
+        end
+
+        class RawResponse
+          include ERB::Util
+
+          attr_accessor :header
+          attr_accessor :body
+          def initialize(command)
+            @start_time = Time.now.to_f
+            @command = command
+            @header = nil
+            @body = nil
+          end
+
+          def to_groonga_command_compatible_response
+            case @command.output_type
+            when :json
+              convert_for_json
+            when :xml
+              convert_for_xml
+            when :none
+              @body
+            end
+          end
+
+          private
+          def convert_for_json
+            elapsed_time = Time.now.to_f - @start_time
+            header = [
+              @header.status,
+              @start_time,
+              elapsed_time,
+            ]
+            header_in_json = JSON.generate(header)
+            "[#{header_in_json},#{@body}]"
+          end
+
+          def convert_for_xml
+            code = @header.status
+            up = @start_time.to_f
+            elapsed = Time.now.to_f - @start_time.to_f
+            <<-XML
+<RESULT CODE="#{h(code)}" UP="#{h(up)}" ELAPSED="#{h(elapsed)}">
+#{@body}
+</RESULT>
+            XML
+          end
+        end
+      end
+    end
+  end
+end