mongoid-elasticsearch 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 227f98096d3f8725368150c8a275001d4b308fe8
-  data.tar.gz: 5385ffd8dd90ca8397731a1ab73f0f63cda66a59
+  metadata.gz: 817468060649097bdc9d2087961b3c1e48a3f3bf
+  data.tar.gz: 11a922cfb895f5d0876148f98f69582ed267209a
 SHA512:
-  metadata.gz: 86ae14cde369b32a520d6502af4a33b717f357c22cc7eaaf4c5cf2d585c93371dd38522588f447360f3ee3463b89da9264cebcea41531fe892de953793c7564a
-  data.tar.gz: 696b7ba51d63adf247a37b5cd633985b2303a5914c838c0509f003197346d94eabc5933dd7ac64560610637aa5e1ba6ef1f834d775686dcc04e53a8f3d8b3641
+  metadata.gz: 8108f386fc0005c154d79cc7cf0b9e91d40545295880240781e62b9ec6a58f81e08d73fdfa7eabeaf19e6ed7418e7406f3971deee9d3b08c3bf9b655b4c4b972
+  data.tar.gz: 6c2cd84050776f09459cddb15c11526c13a55ed6f1719dba9183e869eed87f9e283de44c490ce9fcab9a3380e24585c5a572dd4272c4d7d19e08067dbea6cecc

data/.travis.yml

@@ -10,10 +10,16 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  # mongoid 4 has problems
-  #- rbx-19mode
+  - ruby-head
 
 gemfile:
   - Gemfile
   - gemfiles/mongoid-4.0.gemfile
+  - gemfiles/es-git.gemfile
+  - gemfiles/es-0.4.0.gemfile
+  - gemfiles/es-0.4.1.gemfile
 
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    

data/README.md

@@ -29,11 +29,12 @@ This gem is very simple and does not try hide any part of the ES REST api, it
   a model instance, ES 0.90.3 new completion suggester, etc (new features coming
   soon)
 
-## Why use it (alternatives list):
+## Alternatives list:
 
-- [(re)Tire](https://github.com/karmi/retire) - retired
-- [RubberBand](https://github.com/grantr/rubberband) - EOL
-- [Elasticsearch gem](https://github.com/elasticsearch/elasticsearch-ruby) - too low-level and complex
+- [Elasticsearch gem](https://github.com/elasticsearch/elasticsearch-ruby) - low-level and hard for simple use-cases
+- [(re)Tire](https://github.com/karmi/retire)
+- [RubberBand](https://github.com/grantr/rubberband) - EOL, no Mongoid
+- [Mebla](https://github.com/cousine/mebla) - long dead
 
 ## Installation
 
@@ -60,7 +61,7 @@ Or install it yourself as:
     end
 
     Post.es.search 'test text' # shortcut for Post.es.search({q: 'test text'})
-    result = Post.es.search query: {...}, facets: {...} etc
+    result = Post.es.search body: {query: {...}, facets: {...}} etc
     result.raw_response
     result.results # by default returns an Enumerable with Post instances exactly
                    # like they were loaded from MongoDB
@@ -77,26 +78,50 @@ Or install it yourself as:
     response = Mongoid::Elasticsearch.search 'test'
 
 
+search syntax docs: http://rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions#search-instance_method
+
 more docs: http://rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions
 
 ES docs: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/index.html
 
 ### Advanced:
 
+prefix all app's index names:
+
+    Mongoid::Elasticsearch.prefix = 'my_app'
+
+default options for Elasticsearch::Client.new (url etc)
+ 
+    Mongoid::Elasticsearch.client_options = {hosts: ['localhost']}
+
+index definition options and custom model serialization:
+
     include Mongoid::Elasticsearch
-    # define index_options (raw elasticsearch index definition
-    # 
-    elasticsearch! index_name: 'mongoid_es_news', prefix_name: false, index_options: {}, index_mappings: {
-      name: {
-        type: 'multi_field',
-        fields: {
-          name:     {type: 'string', analyzer: 'snowball'},
-          raw:      {type: 'string', index: :not_analyzed},
-          suggest:  {type: 'completion'} 
-        }
+    elasticsearch!({
+      # index name (prefix is added)
+      index_name: 'mongoid_es_news',
+      
+      # don't use global name prefix
+      prefix_name: false,
+      
+      # elasticsearch index definition
+      index_options: {},
+
+      # or only mappings with empty options
+      index_mappings: {
+        name: {
+          type: 'multi_field',
+          fields: {
+            name:     {type: 'string', analyzer: 'snowball'},
+            raw:      {type: 'string', index: :not_analyzed},
+            suggest:  {type: 'completion'} 
+          }
+        },
+        tags: {type: 'string', include_in_all: false}
       },
-      tags: {type: 'string', include_in_all: false}
-    }, wrapper: :load
+      wrapper: :load
+    })
+    
     # customize what gets sent to elasticsearch:
     def as_indexed_json
       # id field is properly added automatically
@@ -106,6 +131,15 @@ ES docs: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/i
       }
     end
     
+[Mapping definition docs](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-core-types.html)    
+    
+### Possible wrappers for results:
+
+- :hash - raw hash from ES
+- :mash - [Hashie::Mash](https://github.com/intridea/hashie#mash) (gem '[hashie](https://github.com/intridea/hashie)' must be added to gemfile)
+- :load - load each found model by ID from database
+- :model - create a model instance from data stored in elasticsearch
+
 See more examples in specs.
     
 ## Contributing

data/gemfiles/es-0.4.0.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "mongoid", github: "mongoid/mongoid", branch: "master"
+gem 'elasticsearch', '0.4.0'
+
+gemspec path: "../"

data/gemfiles/es-0.4.1.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "mongoid", github: "mongoid/mongoid", branch: "master"
+gem 'elasticsearch', '0.4.1'
+
+gemspec path: "../"

data/gemfiles/es-git.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "mongoid", github: "mongoid/mongoid", branch: "master"
+gem 'elasticsearch', github: 'elasticsearch/elasticsearch-ruby', branch: "master"
+
+gemspec path: "../"

data/lib/mongoid/elasticsearch/es.rb

@@ -29,27 +29,29 @@ module Mongoid
         query[:size] = ( per_page.to_i ) if per_page
         query[:from] = ( page.to_i <= 1 ? 0 : (per_page.to_i * (page.to_i-1)) ) if page && per_page
 
-        Response.new(client, query.merge(type_options(true)), false, klass, klass.es_wrapper, options)
+        options[:wrapper] ||= klass.es_wrapper
+
+        Response.new(client, query.merge(type_options), false, klass, options)
       end
 
-      def options_for(obj, escape = false)
-        {id: obj.id.to_s}.merge type_options(escape)
+      def all(options = {})
+        search({body: {query: {match_all: {}}}}, options)
       end
 
-      def type_options(escape = false)
-        {index: index.name, type: escape ? Utils.escape(index.type) : index.type}
+      def options_for(obj)
+        {id: obj.id.to_s}.merge type_options
       end
 
-      def index_item(obj)
-        client.index({body: obj.as_indexed_json}.merge(options_for(obj, true)))
+      def type_options
+        {index: index.name, type: index.type}
       end
 
-      def remove_item(obj)
-        client.delete(options_for(obj, true).merge(ignore: 404))
+      def index_item(obj)
+        client.index({body: obj.as_indexed_json}.merge(options_for(obj)))
       end
 
-      def all(options = {})
-        search({match_all: {}}, options)
+      def remove_item(obj)
+        client.delete(options_for(obj).merge(ignore: 404))
       end
 
       def completion_supported?

data/lib/mongoid/elasticsearch/index.rb

@@ -14,7 +14,7 @@ module Mongoid
       end
 
       def type
-        klass.model_name.collection
+        klass.model_name.collection.singularize
       end
 
       def options

data/lib/mongoid/elasticsearch/response.rb

@@ -11,12 +11,12 @@ module Mongoid
       attr_reader :time, :total, :options, :facets, :max
       attr_reader :response
 
-      def initialize(client, query, multi, model, wrapper, options)
+      def initialize(client, query, multi, model, options)
         @client  = client
         @query   = query
         @multi   = multi
         @model   = model
-        @wrapper = wrapper
+        @wrapper = options[:wrapper]
         @options = options
       end
 
@@ -44,7 +44,7 @@ module Mongoid
       end
 
       def hits
-        @hits ||= raw_response['hits']['hits'].map { |d| d.update '_type' => Utils.unescape(d['_type']) }
+        @hits ||= raw_response['hits']['hits']
       end
 
       def results
@@ -59,7 +59,8 @@ module Mongoid
             end
           when :mash
             hits.map do |h|
-              m = Hashie::Mash.new(h)
+              s = h.delete('_source')
+              m = Hashie::Mash.new(h.merge(s))
               m.id = BSON::ObjectId.from_string(h['_id'])
               m._id = m.id
               m

data/lib/mongoid/elasticsearch/slash_monkeypatch.rb

@@ -7,7 +7,7 @@ module Elasticsearch
     module Utils
       alias_method :__pathify_without_slashes, :__pathify
       def __pathify(*segments)
-        __pathify_without_slashes(*segments).gsub('%252F', '%2F')
+        __pathify_without_slashes(*segments.map { |s| s.gsub('/', '%2F')}).gsub('%252F', '%2F')
       end
     end
   end

data/lib/mongoid/elasticsearch/utils.rb

@@ -4,16 +4,6 @@ require 'uri'
 module Mongoid
   module Elasticsearch
     module Utils
-
-      def escape(s)
-        URI.encode_www_form_component(s.to_s)
-      end
-
-      def unescape(s)
-        s = s.to_s.respond_to?(:force_encoding) ? s.to_s.force_encoding(Encoding::UTF_8) : s.to_s
-        URI.decode_www_form_component(s)
-      end
-
       def clean(s)
         s.to_s.gsub(/\W+/, ' ').gsub(/ +/, '').strip
       end

data/lib/mongoid/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Elasticsearch
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/mongoid/elasticsearch.rb

@@ -9,7 +9,10 @@ require 'mongoid/elasticsearch/callbacks'
 require 'mongoid/elasticsearch/index'
 require 'mongoid/elasticsearch/indexing'
 require 'mongoid/elasticsearch/response'
-require 'mongoid/elasticsearch/slash_monkeypatch'
+
+if Elasticsearch::VERSION < '0.4.1'
+  require 'mongoid/elasticsearch/slash_monkeypatch'
+end
 
 module Mongoid
   module Elasticsearch
@@ -81,7 +84,7 @@ module Mongoid
     end
 
     # search multiple models
-    def self.search(query, options = {}, wrapper = :model)
+    def self.search(query, options = {})
       if query.is_a?(String)
         query = {q: Utils.clean(query)}
       end
@@ -98,9 +101,10 @@ module Mongoid
       query[:size] = ( per_page.to_i ) if per_page
       query[:from] = ( page.to_i <= 1 ? 0 : (per_page.to_i * (page.to_i-1)) ) if page && per_page
 
+      options[:wrapper] ||= :model
 
       client = ::Elasticsearch::Client.new Mongoid::Elasticsearch.client_options
-      Response.new(client, query, true, nil, wrapper, options)
+      Response.new(client, query, true, nil, options)
     end
   end
 end

data/mongoid-elasticsearch.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "kaminari"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "hashie"
 end

data/spec/mongoid_elasticsearch_spec.rb

@@ -4,7 +4,7 @@ describe Article do
   it 'properly uses options' do
     Article.es_index_name.should eq 'mongoid_es_news'
     Article.es.index.name.should eq 'mongoid_es_news'
-    Article.es.index.type.should eq 'articles'
+    Article.es.index.type.should eq 'article'
     Article.es_wrapper.should eq :load
     Article.es_client_options.should eq({})
   end
@@ -210,13 +210,20 @@ describe "Multisearch" do
     response.to_a.map(&:class).map(&:name).uniq.sort.should eq ['Article', 'Namespaced::Model', 'Post']
     response.select { |r| r.class == Article && r.id == @article_1.id }.first.should_not be_nil
   end
+
+  it '#multi_with_load' do
+    response = Mongoid::Elasticsearch.search 'test', wrapper: :load
+    response.length.should eq 4
+    response.to_a.map(&:class).map(&:name).uniq.sort.should eq ['Article', 'Namespaced::Model', 'Post']
+    response.select { |r| r.class == Article && r.id == @article_1.id }.first.should_not be_nil
+  end
 end
 
 describe Namespaced::Model do
   it 'properly uses options' do
     Namespaced::Model.es_index_name.should eq 'mongoid_es_test_namespaced_models'
     Namespaced::Model.es.index.name.should eq 'mongoid_es_test_namespaced_models'
-    Namespaced::Model.es.index.type.should eq 'namespaced/models'
+    Namespaced::Model.es.index.type.should eq 'namespaced/model'
     Namespaced::Model.es_wrapper.should eq :model
     Namespaced::Model.es_client_options.should eq({})
   end
@@ -265,28 +272,45 @@ describe Namespaced::Model do
 
   context 'pagination' do
     before :each do
+      Namespaced::Model.es.index.reset
       @articles = []
       20.times { @articles << Namespaced::Model.create!(name: 'test') }
+      @a1 = Namespaced::Model.create!(name: 'irrelevant')
+      @a2 = Namespaced::Model.create!(name: 'unmatched')
       Namespaced::Model.es.index.refresh
     end
 
+    it '#search ignores irrelevant' do
+      Namespaced::Model.es.search('irrelevant').to_a.size.should eq 1
+      Namespaced::Model.es.search('test').to_a.size.should eq 20
+    end
+
+    it '#search dynamic wrapper' do
+      Namespaced::Model.es.search('test', wrapper: :hash).map(&:class).map(&:name).uniq.should eq ['Hash']
+      Namespaced::Model.es.search('test', wrapper: :mash).map(&:class).map(&:name).uniq.should eq ['Hashie::Mash']
+      Namespaced::Model.es.search('test', wrapper: :mash).first.name.should eq 'test'
+    end
+
     it '#search' do
       Namespaced::Model.es.search('test', per_page: 10, page: 2).to_a.size.should eq 10
       Namespaced::Model.es.search('test', per_page: 30, page: 2).to_a.size.should eq 0
       Namespaced::Model.es.search('test', per_page: 2, page: 2).to_a.size.should eq 2
+      Namespaced::Model.es.search(body: {query: {query_string: {query: 'test'}}}).to_a.length.should eq 20
     end
 
     it '#all' do
       result = Namespaced::Model.es.all(per_page: 7, page: 3)
-      result.num_pages.should eq 3
-      result.to_a.size.should eq 6
+      result.num_pages.should eq 4
+      result.to_a.size.should eq 7
       p1 = Namespaced::Model.es.all(per_page: 7, page: 1).to_a
       p2 = Namespaced::Model.es.all(per_page: 7, page: 2).to_a
+      p4 = Namespaced::Model.es.all(per_page: 7, page: 4).to_a
       p1.length.should eq 7
       p2.length.should eq 7
-      all = (result.to_a + p1 + p2).map(&:id).map(&:to_s).sort
-      all.length.should eq 20
-      all.should eq @articles.map(&:id).map(&:to_s).sort
+      p4.length.should eq 1
+      all = (p1 + p2 + result.to_a + p4).map(&:id).map(&:to_s).sort
+      all.length.should eq 22
+      all.should eq (@articles + [@a1, @a2]).map(&:id).map(&:to_s).sort
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
+require 'simplecov'
 require 'coveralls'
-Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
@@ -9,6 +15,7 @@ MODELS = File.join(File.dirname(__FILE__), "models")
 require "rubygems"
 require "rspec"
 require "mongoid"
+require "hashie"
 require "database_cleaner"
 
 require "mongoid-elasticsearch"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - glebtv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -128,6 +128,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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'
 description: Simple and easy integration of mongoid with the new elasticsearch gem
 email:
 - glebtv@gmail.com
@@ -145,6 +159,9 @@ files:
 - MIT-LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/es-0.4.0.gemfile
+- gemfiles/es-0.4.1.gemfile
+- gemfiles/es-git.gemfile
 - gemfiles/mongoid-4.0.gemfile
 - lib/mongoid-elasticsearch.rb
 - lib/mongoid/elasticsearch.rb