groonga-client 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67e208675166b5145f2f6aac4d0bc0354741be56
-  data.tar.gz: 1cb1905f24e1e1da9e89854adb2c7d0005896ec8
+  metadata.gz: 106f3f7e0eb62f2b556ff7ad0b93f235146f7f71
+  data.tar.gz: ed8cd8b6dc4d4fee6c6d364e68c0ce0d2db42269
 SHA512:
-  metadata.gz: 1f30907804cd22d7ad8ea20a096386cc8711e790a1679393280c74f267a3d96776b68529f5ab0d304ac6a681684841e20d3f959fcf248a096867a9d0946721fe
-  data.tar.gz: 36717b424a2160a875f457dd74a4f16d5d7e2025cf633241975b6afd35ec1d5bfea583949635967579dd715e3f5605239e0ca4b5a59d1c4e5e6c3e96ade699b4
+  metadata.gz: 4fac8ba9aa91b9bd477464f72276375fe48faefc62ad344a4ef3c8d667ff2664dc0a5ad114b09652d5ab9acba122cd8a5ff7ef31e66630b3c5bf59d2561977d9
+  data.tar.gz: 8c7080561b18c48447b7090a44bba4fcb5828cc8c15a837a6f7991e49b3a1cdc38dcde55d7cf68f6f4ab7164a20de30827dfc6a0691f5e3e0c15dc905dc2620a

data/README.md

@@ -6,13 +6,12 @@ groonga-client
 
 ## Description
 
-Groonga-client is a client for groonga (http://groonga.org/)
-implemented with pure ruby.
+Groonga-client is a client for Groonga (http://groonga.org/)
+implemented with pure Ruby. You can use it without Groonga.
 
 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.
+as the protocol using a client.
 
 ## Install
 
@@ -20,27 +19,86 @@ package.
 
 ## Usage
 
-TODO: use commands with parameters for examples
-(e.g. table_create, load, select)
+Grooga-client handles protocol transparently, so there is only one
+difference between HTTP and GQTP examples. It's `:protocol` parameter
+value of `Groonga::Client.open`. It's `:http` for HTTP and `:gqtp` for
+GQTP.
 
-### GQTP
+### HTTP
+
+Here is a sample to get list of tables via HTTP protocol.
 
-    Groonga::Client.open(:host => host, :port => port, :protocol => :gqtp) do |client|
+    require "groonga/client"
+
+    host = "127.0.0.1"
+    protocol = :http
+    Groonga::Client.open(:host => host, :protocol => protocol) do |client|
       tables = client.table_list
       tables.each do |table|
         table.name
       end
     end
 
-### HTTP
+### GQTP
 
-    Groonga::Client.open(:host => host, :port => port, :protocol => :http) do |client|
+Here is a sample to get list of tables via GQTP protocol.
+
+    require "groonga/client"
+
+    host = "127.0.0.1"
+    protocol = :gqtp
+    Groonga::Client.open(:host => host, :protocol => protocol) do |client|
       tables = client.table_list
       tables.each do |table|
         table.name
       end
     end
 
+### Typical example
+
+Here is a typical example to learn usage of groonga-client. In this
+example, it creates `User` table and `login_name` column. Then it
+loads sample data and selects a person which contains `bob` as a key.
+
+    require "groonga/client"
+
+    host = "127.0.0.1"
+    protocol = :http
+    Groonga::Client.open(:host => host, :protocol => protocol) do |client|
+      client.table_create(:name => "User",
+                          :flags => "TABLE_PAT_KEY",
+                          :key_type => "ShortText")
+      client.column_create(:table => "User",
+                           :name => "login_name",
+                           :flags => "COLUMN_SCALAR",
+                           :type => "ShortText")
+      values = [
+        {
+          "_key" => "bob",
+          "login_name" => "Bob"
+        },
+        {
+          "_key" => "tim",
+          "login_name" => "Tim"
+        },
+        {
+          "_key" => "jessie",
+          "login_name" => "Jessie"
+        },
+      ]
+      client.load(:table => "User",
+                  :values => values.to_json)
+      response = client.select(:table => "User", :query => "_key:bob")
+      if response.success?
+        puts response.n_hits
+        response.records.each do |record|
+          puts record["login_name"]
+        end
+      else
+        puts response.error_message
+      end
+    end
+
 ## Dependencies
 
 * Ruby

data/doc/text/news.md

@@ -1,5 +1,15 @@
 # NEWS
 
+## 0.2.8 - 2016-10-05
+
+### Improvements
+
+  * Added more documents.
+
+### Fixes
+
+  * `Groonga::Client#select`: Accepted string as parameter key again.
+
 ## 0.2.7 - 2016-08-19
 
 ### Improvements

data/lib/groonga/client.rb

@@ -178,7 +178,7 @@ module Groonga
 
     def method_missing(name, *args, **kwargs, &block)
       if groonga_command_name?(name)
-        execute(name, *args, **kwargs, &block)
+        execute(name, *args, &block)
       else
         super
       end

data/lib/groonga/client/version.rb

@@ -16,6 +16,6 @@
 
 module Groonga
   class Client
-    VERSION = "0.2.7"
+    VERSION = "0.2.8"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groonga-client
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Haruka Yoshihara
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gqtp
@@ -155,8 +155,7 @@ dependencies:
 description: |
   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.
+  as the protocol using a client.
 email:
 - yshr04hrk@gmail.com
 - kou@clear-code.com
@@ -253,26 +252,26 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Groonga-client is a client for groonga (http://groonga.org/) implemented
-  with pure ruby.
+summary: Groonga-client is a client for Groonga (http://groonga.org/) implemented
+  with pure Ruby. You can use it without Groonga.
 test_files:
-- test/test-client.rb
 - test/test-script-syntax.rb
-- test/test-command.rb
-- test/protocol/test-gqtp.rb
 - test/protocol/test-http.rb
-- test/run-test.rb
-- test/response/test-base.rb
-- test/response/test-column-list.rb
-- test/response/helper.rb
-- test/response/test-error.rb
-- test/response/test-table-list.rb
-- test/response/test-status.rb
+- test/protocol/test-gqtp.rb
 - test/response/test-schema.rb
+- test/response/test-error.rb
+- test/response/test-table-remove.rb
 - test/response/test-select-command-version3.rb
+- test/response/test-table-list.rb
+- test/response/test-column-list.rb
+- test/response/helper.rb
+- test/response/test-base.rb
 - test/response/test-select-command-version1.rb
+- test/response/test-status.rb
 - test/response/test-table-create.rb
-- test/response/test-table-remove.rb
-- test/results/test-column-list.rb
 - test/results/test-table-list.rb
+- test/results/test-column-list.rb
+- test/test-command.rb
+- test/run-test.rb
+- test/test-client.rb
 has_rdoc: