elastic_searchable 0.7.0 → 0.7.1

data/CONTRIBUTORS.txt

@@ -0,0 +1,6 @@
+Ryan Sonnek - Original Author
+
+
+Complete list of contributors:
+https://github.com/socialcast/elastic_searchable/contributors
+

data/LICENSE.txt

@@ -1,20 +1,22 @@
-Copyright (c) 2011 Ryan Sonnek
+The MIT License
 
-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:
+Copyright (c) 2011 Socialcast, Inc
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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.
 
-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,51 @@
+# elastic_searchable
+
+Integrate the elasticsearch library into Rails.
+
+## Usage
+
+```ruby
+class Blog < ActiveRecord::Base
+  elastic_searchable
+end
+
+results = Blog.search 'foo'
+```
+
+## Features
+
+* fast. fast! FAST! 30% faster than rubberband on average.
+* active record callbacks automatically keep search index up to date as your data changes
+* out of the box background indexing of data using backgrounded.  Don't lock up a foreground process waiting on a background job!
+* integrates with will_paginate library for easy pagination of search results
+
+## Installation
+
+```ruby
+# Bundler Gemfile
+gem 'elastic_searchable'
+```
+
+## Configuration
+
+```ruby
+# config/initializers/elastic_searchable.rb
+# (optional) customize elasticsearch host
+# default is localhost:9200
+ElasticSearchable.base_uri = 'server:9200'
+```
+
+## Contributing
+ 
+* Fork the project
+* Fix the issue
+* Add unit tests
+* Submit pull request on github
+
+See CONTRIBUTORS.txt for list of project contributors
+
+## Copyright
+
+Copyright (c) 2011 Socialcast, Inc. 
+See LICENSE.txt for further details.
+

data/lib/elastic_searchable/active_record_extensions.rb

@@ -7,8 +7,6 @@ require 'elastic_searchable/index'
 
 module ElasticSearchable
   module ActiveRecordExtensions
-    attr_accessor :elastic_options
-
     # Valid options:
     # :index (optional) configure index to store data in.  default to ElasticSearchable.default_index
     # :type (optional) configue type to store data in.  default to model table name
@@ -19,6 +17,7 @@ module ElasticSearchable
     # :json (optional) configure the json document to be indexed (see http://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html#method-i-as_json for available options)
     def elastic_searchable(options = {})
       options.symbolize_keys!
+      cattr_accessor :elastic_options
       self.elastic_options = options.merge(:unless => Array.wrap(options[:unless]).push(&:elasticsearch_offline?))
 
       extend ElasticSearchable::Indexing::ClassMethods

data/lib/elastic_searchable/index.rb

@@ -13,7 +13,7 @@ module ElasticSearchable
       # http://www.elasticsearch.com/docs/elasticsearch/rest_api/admin/indices/put_mapping/
       def update_index_mapping
         if mapping = self.elastic_options[:mapping]
-          ElasticSearchable.request :put, index_type_path('_mapping'), :body => {index_type => mapping}.to_json
+          ElasticSearchable.request :put, index_type_path('_mapping'), :body => {index_type => mapping}
         end
       end
 
@@ -23,7 +23,7 @@ module ElasticSearchable
         options = {}
         options.merge! :settings => self.elastic_options[:index_options] if self.elastic_options[:index_options]
         options.merge! :mappings => {index_type => self.elastic_options[:mapping]} if self.elastic_options[:mapping]
-        ElasticSearchable.request :put, index_path, :body => options.to_json
+        ElasticSearchable.request :put, index_path, :body => options
       end
 
       # explicitly refresh the index, making all operations performed since the last refresh
@@ -77,8 +77,8 @@ module ElasticSearchable
           records.each do |record|
             next unless record.should_index?
             begin
-              doc = record.as_json_for_index.to_json
-              actions << {:index => {'_index' => index_name, '_type' => index_type, '_id' => record.id}}.to_json
+              doc = ElasticSearchable.encode_json(record.as_json_for_index)
+              actions << ElasticSearchable.encode_json({:index => {'_index' => index_name, '_type' => index_type, '_id' => record.id}})
               actions << doc
             rescue => e
               ElasticSearchable.logger.warn "Unable to bulk index record: #{record.inspect} [#{e.message}]"
@@ -112,7 +112,7 @@ module ElasticSearchable
       def reindex(lifecycle = nil)
         query = {}
         query.merge! :percolate => "*" if self.class.elastic_options[:percolate]
-        response = ElasticSearchable.request :put, self.class.index_type_path(self.id), :query => query, :body => self.as_json_for_index.to_json
+        response = ElasticSearchable.request :put, self.class.index_type_path(self.id), :query => query, :body => self.as_json_for_index
 
         self.run_callbacks("after_index_on_#{lifecycle}".to_sym) if lifecycle
         self.run_callbacks(:after_index)
@@ -135,7 +135,7 @@ module ElasticSearchable
       # can be done automatically when indexing using :percolate => true config option
       # http://www.elasticsearch.org/blog/2011/02/08/percolator.html
       def percolate
-        response = ElasticSearchable.request :get, self.class.index_type_path('_percolate'), :body => {:doc => self.as_json_for_index}.to_json
+        response = ElasticSearchable.request :get, self.class.index_type_path('_percolate'), :body => {:doc => self.as_json_for_index}
         response['matches']
       end
 

data/lib/elastic_searchable/queries.rb

@@ -13,11 +13,27 @@ module ElasticSearchable
     def search(query, options = {})
       page = (options.delete(:page) || 1).to_i
       options[:fields] ||= '_id'
-      options[:q] ||= query
       options[:size] ||= per_page_for_search(options)
       options[:from] ||= options[:size] * (page - 1)
+      if query.is_a?(Hash)
+        options[:query] = query
+      else
+        options[:query] = {
+          :query_string => {
+            :query => query,
+            :default_operator => options.delete(:default_operator)
+          }
+        }
+      end
+      query = {}
+      case sort = options.delete(:sort)
+      when Array,Hash
+        options[:sort] = sort
+      when String
+        query[:sort] = sort
+      end
 
-      response = ElasticSearchable.request :get, index_type_path('_search'), :query => options
+      response = ElasticSearchable.request :get, index_type_path('_search'), :query => query, :body => options
       hits = response['hits']
       ids = hits['hits'].collect {|h| h['_id'].to_i }
       results = self.find(ids).sort_by {|result| ids.index(result.id) }

data/lib/elastic_searchable/version.rb

@@ -1,4 +1,4 @@
 module ElasticSearchable
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end
 

data/lib/elastic_searchable.rb

@@ -3,48 +3,38 @@ require 'logger'
 require 'elastic_searchable/active_record_extensions'
 
 module ElasticSearchable
+  DEFAULT_INDEX = 'elastic_searchable'
   include HTTParty
   format :json
   base_uri 'localhost:9200'
-  #debug_output
 
   class ElasticError < StandardError; end
   class << self
-    # setup the default index to use
-    # one index can hold many object 'types'
-    @@default_index = nil
-    def default_index=(index)
-      @@default_index = index
-    end
-    def default_index
-      @@default_index || 'elastic_searchable'
-    end
-
-    @@logger = Logger.new(STDOUT)
-    @@logger.level = Logger::INFO
-    def logger=(logger)
-      @@logger = logger
-    end
-    def logger
-      @@logger
-    end
+    attr_accessor :logger, :default_index, :offline
 
     # execute a block of work without reindexing objects
-    @@offline = false
-    def offline?
-      @@offline
-    end
     def offline(&block)
-      @@offline = true
+      offline = true
       yield
     ensure
-      @@offline = false
+      offline = false
+    end
+    def offline?
+      !!offline
+    end
+    # encapsulate encoding hash into json string
+    # support Yajl encoder if installed
+    def encode_json(options = {})
+      defined?(Yajl) ? Yajl::Encoder.encode(options) : ActiveSupport::JSON.encode(options)
     end
     # perform a request to the elasticsearch server
     # configuration:
     # ElasticSearchable.base_uri 'host:port' controls where to send request to
     # ElasticSearchable.debug_output outputs all http traffic to console
     def request(method, url, options = {})
+      options.merge! :headers => {'Content-Type' => 'application/json'}
+      options.merge! :body => ElasticSearchable.encode_json(options[:body]) if options[:body]
+
       response = self.send(method, url, options)
       logger.debug "elasticsearch request: #{method} #{url} #{"took #{response['took']}ms" if response['took']}"
       validate_response response
@@ -61,3 +51,11 @@ module ElasticSearchable
   end
 end
 
+# configure default logger to standard out with info log level
+ElasticSearchable.logger = Logger.new STDOUT
+ElasticSearchable.logger.level = Logger::INFO
+
+# configure default index to be elastic_searchable
+# one index can hold many object 'types'
+ElasticSearchable.default_index = ElasticSearchable::DEFAULT_INDEX
+

data/test/test_elastic_searchable.rb

@@ -6,10 +6,19 @@ class TestElasticSearchable < Test::Unit::TestCase
   end
   ElasticSearchable.debug_output
 
+  context 'non elastic activerecord class' do
+    class Cat < ActiveRecord::Base
+    end
+    should 'not respond to elastic_options' do
+      assert !Cat.respond_to?(:elastic_options)
+    end
+  end
+
   class Post < ActiveRecord::Base
     elastic_searchable :index_options => {'number_of_replicas' => 0, 'number_of_shards' => 1}
     after_index :indexed
     after_index_on_create :indexed_on_create
+    after_index_on_update :indexed_on_update
     def indexed
       @indexed = true
     end
@@ -22,6 +31,12 @@ class TestElasticSearchable < Test::Unit::TestCase
     def indexed_on_create?
       @indexed_on_create
     end
+    def indexed_on_update
+      @indexed_on_update = true
+    end
+    def indexed_on_update?
+      @indexed_on_update
+    end
   end
   context 'activerecord class with default elastic_searchable config' do
     setup do
@@ -64,6 +79,24 @@ class TestElasticSearchable < Test::Unit::TestCase
     should 'have fired after_index_on_create callback' do
       assert @post.indexed_on_create?
     end
+    should 'not have fired after_index_on_update callback' do
+      assert !@post.indexed_on_update?
+    end
+    context 'Model.update' do
+      setup do
+        @post.title = 'baz'
+        @post.save
+      end
+      should 'have fired after_index callback' do
+        assert @post.indexed?
+      end
+      should 'not have fired after_index_on_create callback' do
+        assert !@post.indexed_on_create?
+      end
+      should 'have fired after_index_on_update callback' do
+        assert @post.indexed_on_update?
+      end
+    end
   end
 
   context 'Model.create within ElasticSearchable.offline block' do
@@ -139,6 +172,28 @@ class TestElasticSearchable < Test::Unit::TestCase
         assert_nil @results.next_page
       end
     end
+    
+    context 'searching for results using a query Hash' do
+      setup do
+        @results = Post.search({
+          :filtered => {
+            :query => {
+              :term => {:title => 'foo'},
+            },
+            :filter => {
+              :or => [
+                {:term => {:body => 'second'}},
+                {:term => {:body => 'third'}}
+              ]
+            }
+          }
+        })
+      end
+      should 'find only the object which ' do
+        assert_does_not_contain @results, @first_post
+        assert_contains @results, @second_post
+      end
+    end
 
     context 'searching for second page using will_paginate params' do
       setup do
@@ -167,6 +222,16 @@ class TestElasticSearchable < Test::Unit::TestCase
         assert_equal @first_post, @results.last
       end
     end
+    
+    context 'advanced sort options' do
+      setup do
+        @results = Post.search 'foo', :sort => [{:id => 'desc'}]
+      end
+      should 'sort results correctly' do
+        assert_equal @second_post, @results.first
+        assert_equal @first_post, @results.last
+      end
+    end
 
     context 'destroying one object' do
       setup do
@@ -273,7 +338,7 @@ class TestElasticSearchable < Test::Unit::TestCase
       ElasticSearchable.default_index = 'my_new_index'
     end
     teardown do
-      ElasticSearchable.default_index = nil
+      ElasticSearchable.default_index = ElasticSearchable::DEFAULT_INDEX
     end
     should 'change default index' do
       assert_equal 'my_new_index', ElasticSearchable.default_index
@@ -296,7 +361,7 @@ class TestElasticSearchable < Test::Unit::TestCase
       end
       context "when index has configured percolation" do
         setup do
-          ElasticSearchable.request :put, '/_percolator/elastic_searchable/myfilter', :body => {:query => {:query_string => {:query => 'foo' }}}.to_json
+          ElasticSearchable.request :put, '/_percolator/elastic_searchable/myfilter', :body => {:query => {:query_string => {:query => 'foo' }}}
           ElasticSearchable.request :post, '/_percolator/_refresh'
         end
         context 'creating an object that matches the percolation' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: elastic_searchable
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 Z
+date: 2011-04-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -197,9 +197,10 @@ extra_rdoc_files: []
 files: 
 - .document
 - .gitignore
+- CONTRIBUTORS.txt
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - elastic_searchable.gemspec
 - lib/elastic_searchable.rb

data/README.rdoc

@@ -1,41 +0,0 @@
-= elastic_searchable
-
-Integrate the elasticsearch library into Rails.
-
-== Usage
-  class Blog < ActiveRecord::Base
-    elastic_searchable
-  end
-
-  results = Blog.search 'foo'
-
-== Features
-
-* fast. fast! FAST! 30% faster than rubberband on average.
-* active record callbacks automatically keep search index up to date as your data changes
-* out of the box background indexing of data using backgrounded.  Don't lock up a foreground process waiting on a background job!
-* integrates with will_paginate library for easy pagination of search results
-
-== Installation
-  #Gemfile
-  gem 'elastic_searchable'
-
-== Configuration
-
-  #config/initializers/elastic_searchable.rb
-  #customize elasticsearch host
-  #defaults to localhost:9200
-  ElasticSearchable.base_uri = 'server:9200'
-
-== Contributing
- 
-* Fork the project
-* Fix the issue
-* Add unit tests
-* Submit pull request on github
-
-== Copyright
-
-Copyright (c) 2011 Ryan Sonnek. See LICENSE.txt for
-further details.
-