oss_rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b717d6502f67f75077aaaac92a194f00e0fe617
-  data.tar.gz: 12c35c15e835a2a2a4673baa9cef0bbd552ebb04
+  metadata.gz: 44e31bb9abb8bfdefd8df1b447a0916377be69f1
+  data.tar.gz: d006e029fa82add99b9fb828be1f412b45f9f6a1
 SHA512:
-  metadata.gz: 0f06c34432c9f7f89c157edb279c627597c3d57952ec455ab260e709b8c273de6fa8634d9ab0318d1b7f30ce5c46cf92aab114fe08ebda9363aae8022a28f11e
-  data.tar.gz: 20b734f21cd01f4e7a7b0e9e37642093a036fb299ef2fe85b00aba208d4b4cce34c663a351cffa375eb554efd93b9d3ade35ba57ddcb709fa593fce7a2d93f97
+  metadata.gz: 274130699bfb6caec39bd1cf11ffa2eb30f8cbdcfa827ddb072a9779057f00b731585e3120b740f5f0a9c3b18f5a26e180799ff928e315eef8dacf0d1022dfe3
+  data.tar.gz: 63054303ba6c27f74d9bcc0557228155dd49866e2338d55be95416e750f85989191ba3cdff898b0404fdf71e7adb27ef5d60c2c9ee99ba0ac6696137cdf85883

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oss_rb (0.0.1)
+    oss_rb (0.1.0)
       activesupport
       rest-client
 
@@ -14,7 +14,7 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    atomic (1.1.10)
+    atomic (1.1.13)
     coderay (1.0.9)
     diff-lcs (1.2.4)
     ffi (1.3.1)
@@ -34,7 +34,7 @@ GEM
       libnotify (~> 0.1.3)
       rb-inotify (>= 0.5.1)
       spoon (~> 0.0.1)
-    i18n (0.6.4)
+    i18n (0.6.5)
     libnotify (0.1.4)
       ffi (>= 0.6.2)
     listen (1.2.2)
@@ -43,9 +43,9 @@ GEM
       rb-kqueue (>= 0.2)
     lumberjack (1.0.4)
     method_source (0.8.1)
-    mime-types (1.23)
+    mime-types (1.25)
     minitest (4.7.5)
-    multi_json (1.7.7)
+    multi_json (1.7.9)
     net-http-spy (0.2.1)
     pry (0.9.12.2)
       coderay (~> 1.0.5)

data/README.md

@@ -1,8 +1,11 @@
 # oss_rb
 
+A Ruby Client for OpenSearchServer
 
-A very initial Ruby Client for OpenSearchServer http://www.open-search-server.com
+## Requirement
 
+A running OpenSearchServer instance (>= v1.5)
+http://www.open-search-server.com
 
 ## Installation
 
@@ -20,7 +23,90 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Obtain a client instance
+```ruby
+index = Oss::Index.new('my_index', 'http://localhost:8080')
+```
+
+Create an index
+```ruby
+index.create 'EMPTY_INDEX'
+```
+
+Create some fields
+```ruby
+index.set_field({'name' => 'id', 'indexed' => 'YES'})
+index.set_field(
+	{	'name' => 'name',
+		'analyzer' => 'StandardAnalyzer',
+		'stored' => 'YES',
+		'indexed' => 'YES'
+	}
+)
+```
+
+Set the default field, and the primary key
+```ruby
+index.set_field_default_unique('name', 'id')
+```
+
+Put a document in the index
+```ruby
+doc = Oss::Document.new
+doc.fields << Oss::Field.new('id', "1")
+doc.fields << Oss::Field.new('name', "john smith")
+index.documents << doc
+index.index!
+```
+
+Ok, time to make a search
+```ruby
+result = index.search_field(
+	{	'query' => 'john',
+		'searchFields' => [ {'field' => 'name', 'phrase'=>true, 'boost' => 1.0} ],
+		'start' => 0,
+		'rows' => 10,
+		'returnedFields' => ['id', 'name']
+ 	}
+)
+```
+
+It is possible to store a search template
+```ruby
+index.search_store_template_field('fieldsearch',
+	{	'query' => 'john',
+		'searchFields' => [ {'field' => 'name', 'phrase'=>true, 'boost' => 1.0} ],
+		'start' => 0,
+		'rows' => 10,
+		'returnedFields' => ['id', 'name']
+	}
+)
+```
+     
+Use the stored search template to make a search
+```ruby
+result = index.search_template_field('fieldsearch', {'query' => 'john2'})
+```
+
+Deleting a search template
+```ruby
+index.search_template_delete('fieldsearch')
+```
+
+You may remove documents by value or by query
+```ruby
+index.delete_document_by_value('id', 1)
+index.delete_document_by_query('name:john')
+```
+Or remove field
+```ruby
+index.delete_field('name')
+```
+
+And finally here is how to delete the index
+```ruby
+index.delete!
+```
 
 ## Contributing
 

data/lib/oss_rb/version.rb

@@ -1,3 +1,3 @@
 module Oss
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/oss_rb.rb

@@ -32,14 +32,14 @@ module Oss
     # Create or update the field defined by the given hash
     # http://github.com/jaeksoft/opensearchserver/wiki/Field-create-update
     def set_field(field_params)
-      api_put_json "services/rest/index/#{@name}/field", field_params
+      api_put_json "services/rest/index/#{@name}/field/#{field_params['name']}", field_params
     end
 
     # Set the default field and the unique field
     # http://github.com/jaeksoft/opensearchserver/wiki/Field-set-default-unique
     def set_field_default_unique(default, unique)
       params = { 'unique' => unique, 'default' => default }
-      api_put "services/rest/index/#{@name}/field", '', params
+      api_post "services/rest/index/#{@name}/field", '', params
     end
 
     # Delete the field matching the give name

data/oss_rb.gemspec

@@ -9,10 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ori Pekelman", "Emmanuel Keller"]
   spec.email         = ["ori@pekelman.com", "ekeller@open-search-server.com"]
   spec.description   = %q{OpenSearchServer Ruby Client}
-  spec.summary       = %q{OpenSearchServer Ruby Client}
-  spec.homepage      = "http://www.open-search-server.com/"
+  spec.summary       = %q{A Ruby Client library for OpenSearchServer}
+  spec.homepage      = "https://github.com/jaeksoft/oss_rb/"
   spec.license       = "MIT"
 
+  spec.metadata      = { "Issues" => "https://github.com/jaeksoft/oss_rb/issues" }
+
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/spec/api/api_v1_spec.rb

@@ -4,7 +4,7 @@ describe Oss::Index do
   before(:all) do
     @index_name = "test_oss_rb"
     @index = Oss::Index.new(@index_name, ENV['OSS_RB_URL'], ENV['OSS_RB_LOGIN'], ENV['OSS_RB_KEY'])
-    @index.delete!
+    @index.delete! if @index.list.include? @index_name
   end
 
   describe '#OssIndex(name)' do
@@ -29,16 +29,16 @@ describe Oss::Index do
     it "delete index" do
       index = Oss::Index.new("DELETE_ME", ENV['OSS_RB_URL'], ENV['OSS_RB_LOGIN'], ENV['OSS_RB_KEY'])
       index.create('EMPTY_INDEX')
-      index.list.should include "DELETE_ME"
+      index.list.should(include, "DELETE_ME")
       index.delete!
-      index.list.should_not include "DELETE_ME"
+      index.list.should_not(include, "DELETE_ME")
     end
   end
 
   describe '#create index' do
     it "create index" do
       @index.create('WEB_CRAWLER') unless @index.list.include? @index_name
-      @index.list.should include @index_name
+      @index.list.should(include, @index_name)
     end
   end
 
@@ -77,7 +77,7 @@ describe Oss::Index do
       @index.set_field_default_unique('user', 'id')
 
       (1..15).each do |i|
-        doc = Oss::Document.new()
+        doc = Oss::Document.new
         doc.fields << Oss::Field.new('id', "#{i}")
         doc.fields << Oss::Field.new('user', "john#{i}")
         @index.documents << doc
@@ -95,11 +95,30 @@ describe Oss::Index do
       result['documents'].length.should == 10
 
       @index.search_store_template_pattern('patternsearch', params);
-      result = @index.search_template_pattern('patternsearch', params);
+      result = @index.search_template_pattern('patternsearch', {'query' => 'user:j*'});
       result['numFound'].should == 15
       result['documents'].length.should == 10
 
-      @index.search_template_delete('search');
+      @index.search_template_delete('patternsearch');
+
+      params = {
+        'query' => 'john1',
+        'searchFields' => [ {'field' => 'user', 'phrase'=>true, 'boost' => 1.0} ],
+        'start' => 0,
+        'rows' => 10,
+        "returnedFields" => ['id', 'user']
+      }
+      result= @index.search_field(params);
+      result['numFound'].should == 1
+      result['documents'].length.should == 1
+
+      @index.search_store_template_field('fieldsearch', params);
+      result = @index.search_template_field('fieldsearch', {'query' => 'john2'});
+      result['numFound'].should == 1
+      result['documents'].length.should == 1
+
+      @index.search_template_delete('fieldsearch');
+
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oss_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ori Pekelman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2013-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,10 +89,11 @@ files:
 - oss_rb.gemspec
 - spec/api/api_v1_spec.rb
 - spec/spec_helper.rb
-homepage: http://www.open-search-server.com/
+homepage: https://github.com/jaeksoft/oss_rb/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  Issues: https://github.com/jaeksoft/oss_rb/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -109,10 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.4
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
-summary: OpenSearchServer Ruby Client
+summary: A Ruby Client library for OpenSearchServer
 test_files:
 - spec/api/api_v1_spec.rb
 - spec/spec_helper.rb