oss_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b717d6502f67f75077aaaac92a194f00e0fe617
+  data.tar.gz: 12c35c15e835a2a2a4673baa9cef0bbd552ebb04
+SHA512:
+  metadata.gz: 0f06c34432c9f7f89c157edb279c627597c3d57952ec455ab260e709b8c273de6fa8634d9ab0318d1b7f30ce5c46cf92aab114fe08ebda9363aae8022a28f11e
+  data.tar.gz: 20b734f21cd01f4e7a7b0e9e37642093a036fb299ef2fe85b00aba208d4b4cce34c663a351cffa375eb554efd93b9d3ade35ba57ddcb709fa593fce7a2d93f97

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Mac
+.DS_Store
+
+# Eclipse project
+.buildpath
+.project
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oss_rb.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+  gem "rspec"
+  gem "guard"
+  gem "guard-bundler"
+  gem "guard-rack"
+  gem 'pry'
+  gem 'net-http-spy'
+end
+
+group :test do
+  gem "rspec"
+  gem "rack-test"
+  gem "rspec-core"
+  gem "rspec-expectations"
+  gem "rspec-mocks"
+  gem 'net-http-spy'
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    oss_rb (0.0.1)
+      activesupport
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.10)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    ffi (1.3.1)
+    formatador (0.2.4)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rack (1.3.1)
+      ffi (~> 1.3.1)
+      guard (~> 1.1)
+      libnotify (~> 0.1.3)
+      rb-inotify (>= 0.5.1)
+      spoon (~> 0.0.1)
+    i18n (0.6.4)
+    libnotify (0.1.4)
+      ffi (>= 0.6.2)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.1)
+    mime-types (1.23)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    net-http-spy (0.2.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.2)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    slop (3.4.5)
+    spoon (0.0.4)
+      ffi
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  guard
+  guard-bundler
+  guard-rack
+  net-http-spy
+  oss_rb!
+  pry
+  rack-test
+  rake
+  rspec
+  rspec-core
+  rspec-expectations
+  rspec-mocks

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2013  Ori Pekelman <ori@pekelman.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# oss_rb
+
+
+A very initial Ruby Client for OpenSearchServer http://www.open-search-server.com
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oss_rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oss_rb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  # do not run integration tests, doesn't work on TravisCI
+  spec.pattern = FileList['spec/*/*_spec.rb']
+end
+
+desc "vendorize oss_rb lib"
+task :vendorize do
+  sh "gem unpack oss_rb -v 0.0.1 --target vendor/private_gems"
+end
+
+task :default => :spec

data/docs/retours_api.txt

@@ -0,0 +1,11 @@
+curl -X PUT "http://localhost:8080/indexname.json" -d
+{                                                                                                                         \n
+  docs: [                                                                                                                 \n
+  id:1,                                                                                                                   \n
+  title: "Open Search Server",                                                                                            \n
+  url: "http://www.open-search-server.com",                                                                               \n
+  users : ["emmanuel_keller","philcube"]                                                                                  \n
+  ]                                                                                                                       \n
+  }
+  
+curl "http://localhost:8080/indexname?q=ma%20requête"

data/docs/retours_schema_api.txt

@@ -0,0 +1,21 @@
+Creating an index?:
+POST http://localhost:8080/schema/index1
+id,doc
+
+Maybe if I post a document on a non existing index I should create the Index, if not:
+
+404 Not Found
+{ 
+   message:" The database index1 does not exist yet. You can create it by POST http://localhost:8080/schema/index1"
+}
+
+http://localhost:8080/schema?cmd=createindex&index.name=index1&index.template=WEB_CRAWLER
+ 
+List all the available index:
+http://localhost:8080/schema?cmd=indexlist
+ 
+Deleting an index :
+http://localhost:8080/schema?cmd=deleteindex&index.name=index1&index.delete.name=index1
+ 
+Setting/Creating a schema field:
+http://localhost:8080/oss1.3/schema?cmd=setField&field.name=titleNew&field.analyzer=StandardAnalyzer&use=index1&field.stored=YES&field.indexed=YES&term.termVector=NO

data/examples/index.rb

@@ -0,0 +1,18 @@
+require_relative '../lib/oss_rb'
+require 'securerandom'
+index = Oss::Index.new("test_oss_rb")
+index.delete!
+indexes = index.create('EMPTY_INDEX')
+puts index.list
+
+(1..15).each do |i|
+  id = SecureRandom.uuid
+  doc = Oss::Document.new 
+  doc.add_field("user", "jane#{i}")
+  doc.add_field("user", "john#{i}")
+  doc.add_field("url", "http://myserver.com/#{id}")
+  index.add_document(doc)
+end
+
+index.index!
+puts index.search("http*")

data/lib/oss_rb.rb

@@ -0,0 +1,156 @@
+require 'rest_client'
+require 'active_support/all'
+
+module Oss
+  class Index
+    attr_accessor :documents, :name
+    def initialize(name, host = 'http://localhost:8080', login = nil, key = nil)
+      @name = name
+      @documents = Array.new
+      @host = host
+      @credentials = {:login=>login,:key=>key}
+    end
+
+    # Return the index list
+    # http://github.com/jaeksoft/opensearchserver/wiki/Index-list
+    def list
+      JSON.parse(api_get("services/rest/index"))["indexList"]
+    end
+
+    # Create a new index with the given template name
+    # http://github.com/jaeksoft/opensearchserver/wiki/Index-create
+    def create(template = 'WEB_CRAWLER')
+      api_post "services/rest/index/#{@name}/template/#{template}"
+    end
+
+    # Delete the index
+    # http://github.com/jaeksoft/opensearchserver/wiki/Index-delete
+    def delete!
+      api_delete "services/rest/index/#{@name}"
+    end
+
+    # 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
+    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
+    end
+
+    # Delete the field matching the give name
+    # http://github.com/jaeksoft/opensearchserver/wiki/Field-delete
+    def delete_field(field_name = nil)
+      api_delete "services/rest/index/#{@name}/field/#{field_name}"
+    end
+
+    # Delete the document matching the given field and values
+    # http://github.com/jaeksoft/opensearchserver/wiki/Document-delete
+    def delete_document_by_value(field_name, *values)
+      api_delete "services/rest/index/#{@name}/document/#{field_name}/#{values.join('/')}"
+    end
+
+    # Delete the document matching the given query
+    def delete_document_by_query(query)
+      params = { 'query' => query }
+      api_delete "services/rest/index/#{@name}/document", params
+    end
+
+    # Put document in the index
+    # http://github.com/jaeksoft/opensearchserver/wiki/Document-put-JSON
+    def index!
+      api_put_json "services/rest/index/#{@name}/document", @documents
+      @documents = []
+    end
+
+    # Execute a search (using pattern)
+    def search_pattern( body = nil)
+      JSON.parse(api_post_json("services/rest/index/#{@name}/search/pattern", body))
+    end
+
+    # Execute a search (using field)
+    # http://github.com/jaeksoft/opensearchserver/wiki/Search-field
+    def search_field(body = nil)
+      JSON.parse(api_post_json("services/rest/index/#{@name}/search/field", body))
+    end
+
+    # Execute a search based on an existing template
+    # http://github.com/jaeksoft/opensearchserver/wiki/Search-pattern
+    def search_template_pattern(template,  body = nil)
+      JSON.parse(api_post_json("services/rest/index/#{@name}/search/pattern/#{template}", body))
+    end
+
+    # Execute a search based on an existing template
+    # http://github.com/jaeksoft/opensearchserver/wiki/Search-template-field
+    def search_template_field(template,  body = nil)
+      JSON.parse(api_post_json("services/rest/index/#{@name}/search/field/#{template}", body))
+    end
+
+    # Create/update a search template (pattern search)
+    # http://github.com/jaeksoft/opensearchserver/wiki/Search-template-pattern-set
+    def search_store_template_pattern(template,  body = nil)
+      api_put_json "services/rest/index/#{@name}/search/pattern/#{template}", body
+    end
+
+    # Create/update a search template (field search)
+    # http://github.com/jaeksoft/opensearchserver/wiki/Search-template-field-set
+    def search_store_template_field(template,  body = nil)
+      api_put_json"services/rest/index/#{@name}/search/field/#{template}", body
+    end
+
+    # Delete a search template matching the given name
+    # http://github.com/jaeksoft/opensearchserver/wiki/Search-template-delete
+    def search_template_delete(template)
+      api_delete "services/rest/index/#{@name}/search/template/#{template}"
+    end
+
+    private
+
+    def api_get (method, params={})
+      RestClient.get("#{@host}/#{method}", {:accept => :json, :params => params})
+    end
+
+    def api_post (method, body="", params={})
+      RestClient.post("#{@host}/#{method}", body, {:params => params.merge(@credentials)})
+    end
+
+    def api_post_json (method, body="", params={})
+      RestClient.post("#{@host}/#{method}", body.to_json, {:accept => :json, :content_type => :json, :params => params.merge(@credentials)})
+    end
+
+    def api_put (method, body="", params={})
+      RestClient.put("#{@host}/#{method}", body, {:params => params.merge(@credentials)})
+    end
+
+    def api_put_json (method, body="", params={})
+      RestClient.put("#{@host}/#{method}", body.to_json, {:accept => :json, :content_type => :json, :params => params.merge(@credentials)})
+    end
+
+    def api_delete (method, params={})
+      RestClient.delete("#{@host}/#{method}", {:params => params.merge(@credentials)})
+    end
+
+  end
+
+  class Field
+    attr_accessor :name, :value, :boost
+    def initialize(name, value, boost=1.0)
+      @name = name
+      @value = value
+      @boost =boost
+    end
+  end
+
+  class Document < Field
+    attr_accessor :lang, :fields
+    def initialize(lang ='ENGLISH')
+      @lang = lang
+      @fields = Array.new
+    end
+  end
+
+end

data/lib/oss_rb/version.rb

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

data/oss_rb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oss_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oss_rb"
+  spec.version       = Oss::VERSION
+  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.license       = "MIT"
+
+  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)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'rest-client'
+end

data/spec/api/api_v1_spec.rb

@@ -0,0 +1,126 @@
+require_relative "../spec_helper"
+
+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!
+  end
+
+  describe '#OssIndex(name)' do
+    it "should not work with no index name" do
+      expect { Oss::Index.new() }.to raise_error
+    end
+  end
+
+  describe '#Non existing methods' do
+    it "should not work" do
+      expect {@index.send(:api_get,"plop")}.to raise_error
+    end
+  end
+
+  describe '#OssIndex' do
+    it "fetches the OssIndex client object" do
+      @index.should be_an_instance_of(Oss::Index)
+    end
+  end
+
+  describe '#delete 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.delete!
+      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
+    end
+  end
+
+  describe '#set fields' do
+    it 'set fields' do
+      params = {
+        'name' => 'id',
+        'stored' => 'YES',
+        'indexed' => 'YES'
+      }
+      @index.set_field(params)
+      params = {
+        'name' => 'user',
+        'analyzer' => 'StandardAnalyzer',
+        'stored' => 'YES',
+        'indexed' => 'YES'
+      }
+      @index.set_field(params)
+      @index.set_field_default_unique('user', 'id')
+    end
+  end
+
+  describe '#index docs' do
+    it "create index, set fields, index docs" do
+      @index.set_field( {
+        'name' => 'user',
+        'analyzer' => 'StandardAnalyzer',
+        'stored' => 'YES',
+        'indexed' => 'YES'
+      })
+      @index.set_field( {
+        'name' => 'id',
+        'stored' => 'YES',
+        'indexed' => 'YES'
+      })
+      @index.set_field_default_unique('user', 'id')
+
+      (1..15).each do |i|
+        doc = Oss::Document.new()
+        doc.fields << Oss::Field.new('id', "#{i}")
+        doc.fields << Oss::Field.new('user', "john#{i}")
+        @index.documents << doc
+      end
+
+      @index.index!
+      params = {
+        'query' => 'user:j*',
+        'start' => 0,
+        'rows' => 10,
+        "returnedFields" => ['id', 'user']
+      }
+      result= @index.search_pattern(params);
+      result['numFound'].should == 15
+      result['documents'].length.should == 10
+
+      @index.search_store_template_pattern('patternsearch', params);
+      result = @index.search_template_pattern('patternsearch', params);
+      result['numFound'].should == 15
+      result['documents'].length.should == 10
+
+      @index.search_template_delete('search');
+    end
+  end
+
+  describe '#delete fields' do
+    it 'set fields, delete fields' do
+      @index.delete_field('host')
+      @index.delete_field('subhost')
+    end
+  end
+
+  describe '#delete document by value' do
+    it 'index docs, delete document by value' do
+      @index.delete_document_by_value('id', 1, 2, 3)
+    end
+
+    describe '#delete document by query' do
+      it 'index docs, delete document by query' do
+        @index.delete_document_by_query('user:john4')
+        @index.delete_document_by_query('user:john5')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+ENV["RACK_ENV"] ||= 'test'
+require 'rack/test'
+
+require File.expand_path("../../lib/oss_rb.rb", __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: oss_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ori Pekelman
+- Emmanuel Keller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !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: activesupport
+  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: rest-client
+  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'
+description: OpenSearchServer Ruby Client
+email:
+- ori@pekelman.com
+- ekeller@open-search-server.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/retours_api.txt
+- docs/retours_schema_api.txt
+- examples/index.rb
+- lib/oss_rb.rb
+- lib/oss_rb/version.rb
+- oss_rb.gemspec
+- spec/api/api_v1_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.open-search-server.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.4
+signing_key: 
+specification_version: 4
+summary: OpenSearchServer Ruby Client
+test_files:
+- spec/api/api_v1_spec.rb
+- spec/spec_helper.rb