es-elasticity 0.9.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e309966bac2144c3c9cb5f0b224558d4bb025cf3
-  data.tar.gz: 67bbe2abe0812300f3481686ee3a3429c387ae26
+  metadata.gz: 11dddda9376573d12d8d6c0db18342c7a242199a
+  data.tar.gz: 2613b868ae0ca372149fa84724790ade9bbca2a2
 SHA512:
-  metadata.gz: befdfdb3ef94fadc1637ef6597092b9a3165051a22a832341bc9de9b02ee2281d835419fb997390202e4514c11573d67ab6b994a2720afd2cb0c32f847bf7e75
-  data.tar.gz: 8fba3aa740454246d3a1f308adf809b5fc804a5c06e97d6d853c8a93d69897341a2797964583eba64f1dc281a5980251d4025ac73b90757ec82eefd926e5f757
+  metadata.gz: 13a78c3cbe8eb55a911d7b39d1a31e07329e4e3f809fde432ece6a12511db5e40422af47f3508938ec597579aef697a05622dc449670537b45b4ba64ee4b22e3
+  data.tar.gz: bcb01eb45bf67cf5dc2d6c0cfd7bb6ad00fc40167e5068da1e067d6a77f8f7d811b812b7de923fca134eea8ea28510114e9e1e235c9ff61b148a391e30a5f035

data/CHANGELOG

@@ -1,3 +1,16 @@
+v0.11.1
+  - support `action.destructive_requires_name` setting by being explict about which indices to delete
+
+v0.11.0
+  - compatibilty with ES v6
+    - change mappings for 'index' to boolean. "string" type was replaced with "text"
+    - use "successful" from API response ('created' was removed)
+  - stringify keys for :mappings so clients can use symbol keys
+v0.10.0
+	- update remap to removing fields from the mapping that are not explicitly
+	defined.
+v0.9.1
+	- fix search enumerator, missing first result set
 v0.8.3
 	- fix remap method to use the scan api properly.
 v0.8.2

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticity.gemspec
 gemspec
 
-gem "elasticsearch", "5.0.3"
+gem "elasticsearch", "5.0.4"

data/README.md

@@ -80,7 +80,7 @@ class Search::User < Elasticity::Document
   def self.adults
     date = Date.today - 21.years
 
-    # This is the query that will be submited to ES, same format ES would
+    # This is the query that will be submitted to ES, same format ES would
     # expect, translated to a Ruby hash, note the pagination params.
     body = {
       from: 0,
@@ -159,7 +159,7 @@ The search object implements `Enumerable`, so it can be treated as a collection:
 ```ruby
 # Get the search object, which is an instance of `Elasticity::DocumentSearchProxy`.
 # Search is not performed until data is accessed.
-adults = User.adults
+adults = Search::User.adults
 
 # Iterating over the results will trigger the query
 adults.each do |user|
@@ -203,7 +203,7 @@ Using this feature is very easy and very similar to traditional documents. The o
 class Search::User < Elasticity::SegmentedDocument
   configure do |c|
     # Defines how the index will be named, the final name
-    # will depend on the stragy being used.
+    # will depend on the strategy being used.
     c.index_base_name = "users"
 
     # Defines the document type that this class represents.
@@ -227,7 +227,7 @@ class Search::User < Elasticity::SegmentedDocument
   def self.adults
     date = Date.today - 21.years
 
-    # This is the query that will be submited to ES, same format ES would
+    # This is the query that will be submitted to ES, same format ES would
     # expect, translated to a Ruby hash, note the pagination params.
     body = {
       from: 0,
@@ -283,7 +283,7 @@ Strategies define how index creation and index operation happens on the lower le
 
 The single-index strategy is the most straightforward one. It causes one index to be created and any operation will be performed directly on that index. It's very simple but it has the downside of being a lot harder to update existing mapping since you'll have to drop the index and recreate from scratch.
 
-The alias-index strategy is a bit more complex but it allows for seameless hot remapping. It works by creating an index and two aliases pointing to that index. Any operation is performed on the aliases rather than the index, which allows hot swapping due atomic aliases updates.
+The alias-index strategy is a bit more complex but it allows for seamless hot remapping. It works by creating an index and two aliases pointing to that index. Any operation is performed on the aliases rather than the index, which allows hot swapping due atomic aliases updates.
 
 Here is what it looks like:
 
@@ -297,7 +297,7 @@ Here is what it looks like:
 |_____________|
 ```
 
-Everytime a search operation is performed, it is performed against the main alias; when an update operation is performed, it is performed against the update alias; and, when a delete operation is performed, it is performed against the indexes pointed by both aliases.
+Every time a search operation is performed, it is performed against the main alias; when an update operation is performed, it is performed against the update alias; and, when a delete operation is performed, it is performed against the indexes pointed by both aliases.
 
 When the mapping needs to change, a hot remapping can be performed by doing the following:
 
@@ -397,7 +397,7 @@ Search::User.adults.active_records(User.where(active: true))
 ```
 
 ## Upgrading from 0.7.0 to 0.8.0
-The default persistance strategy changed from SingleIndex to AliasIndex in version 0.8.0 Add the following to your Document configuration to maintain the legacy behaviour.
+The default persistence strategy changed from SingleIndex to AliasIndex in version 0.8.0 Add the following to your Document configuration to maintain the legacy behaviour.
 
 ```ruby
   c.strategy = Elasticity::Strategies::SingleIndex

data/lib/elasticity/index_config.rb

@@ -6,7 +6,7 @@ module Elasticity
     ].freeze
     VALIDATABLE_ATTRS = [:index_base_name, :document_type, :strategy].freeze
 
-    attr_accessor *ATTRS
+    attr_accessor(*ATTRS)
 
     def initialize(elasticity_config, defaults = {})
       defaults.each do |k,v|
@@ -30,7 +30,7 @@ module Elasticity
     def definition
       return @definition if defined?(@definition)
       @definition = {
-        settings: merge_settings, mappings: { @document_type => @mapping || {} }
+        settings: merge_settings, mappings: { @document_type => @mapping.nil? ? {} : @mapping.deep_stringify_keys }
       }
       subclasses.each do |doc_type, subclass|
         @definition[:mappings][doc_type] = subclass.constantize.mapping

data/lib/elasticity/search.rb

@@ -164,7 +164,8 @@ module Elasticity
       def enumerator
         Enumerator.new do |y|
           response = search
-
+          # Push the first set of results before requesting the second set
+          y << Search::Results.new(response, @search_definition.body, @mapper)
           loop do
             response = @client.scroll(scroll_id: response["_scroll_id"], scroll: @scroll, body: { scroll_id: response["_scroll_id"] })
             break if response["hits"]["hits"].empty?

data/lib/elasticity/strategies/alias_index.rb

@@ -66,10 +66,17 @@ module Elasticity
             docs = @client.mget(body: { docs: id_docs }, refresh: true)["docs"]
             break if docs.empty?
 
+            # Modify document hashes to match the mapping definition so that legacy fields aren't added
+            defined_mapping_fields = index_def[:mappings][docs.first["_type"]]["properties"].keys
+
             # Move only documents that still exists on the old index, into the new index.
             ops = []
             docs.each do |doc|
-              ops << { index: { _index: new_index, _type: doc["_type"], _id: doc["_id"], data: doc["_source"] } } if doc["found"]
+              if doc["found"]
+                legacy_fields = doc["_source"].keys - defined_mapping_fields
+                legacy_fields.each { |field| doc["_source"].delete(field) }
+                ops << { index: { _index: new_index, _type: doc["_type"], _id: doc["_id"], data: doc["_source"] } }
+              end
             end
 
             @client.bulk(body: ops)
@@ -179,7 +186,9 @@ module Elasticity
       end
 
       def delete
-        @client.index_delete(index: "#{@main_alias}-*")
+        main_indexes.each do |index|
+          @client.index_delete(index: index)
+        end
       end
 
       def delete_if_defined
@@ -195,7 +204,7 @@ module Elasticity
         res = @client.index(index: @update_alias, type: type, id: id, body: attributes)
 
         if id = res["_id"]
-          [id, res["created"]]
+          [id, res["_shards"] && res["_shards"]["successful"].to_i > 0]
         else
           raise IndexError.new(@update_alias, "failed to index document. Response: #{res.inspect}")
         end

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.9.0"
+  VERSION = "0.11.1"
 end

data/spec/functional/persistence_spec.rb

@@ -16,8 +16,8 @@ RSpec.describe "Persistence", elasticsearch: true do
           c.strategy        = Elasticity::Strategies::SingleIndex
 
           c.mapping = {
-            properties: {
-              name: { type: "string", index: "not_analyzed" },
+            "properties" => {
+              name: { type: "text", index: false },
               birthdate: { type: "date" },
             },
           }
@@ -85,7 +85,7 @@ RSpec.describe "Persistence", elasticsearch: true do
         c.index_base_name = "cats_and_dogs"
         c.strategy = Elasticity::Strategies::SingleIndex
         c.document_type  = "cat"
-        c.mapping = { properties: {
+        c.mapping = { "properties" => {
           name: { type: "string", index: "not_analyzed" },
           age: { type: "integer" }
         } }
@@ -103,7 +103,7 @@ RSpec.describe "Persistence", elasticsearch: true do
         c.index_base_name = "cats_and_dogs"
         c.strategy = Elasticity::Strategies::SingleIndex
         c.document_type = "dog"
-        c.mapping = { properties: {
+        c.mapping = { "properties" => {
           name: { type: "string", index: "not_analyzed" },
           age: { type: "integer" },
           hungry: { type: "boolean" }
@@ -148,6 +148,7 @@ RSpec.describe "Persistence", elasticsearch: true do
       results = Animal.search({})
       expect(results.total).to eq 1
       expect(results.map(&:class)).to include(Dog)
+      expect(results.scan_documents.count).to eq(1)
     end
   end
 
@@ -164,7 +165,7 @@ RSpec.describe "Persistence", elasticsearch: true do
           c.strategy        =  Elasticity::Strategies::AliasIndex
 
           c.mapping = {
-            properties: {
+            "properties" => {
               id: { type: "integer" },
               name: { type: "string", index: "not_analyzed" },
               birthdate: { type: "date" },
@@ -242,6 +243,50 @@ RSpec.describe "Persistence", elasticsearch: true do
       expect(results.total).to eq(2010)
     end
 
+    it "does not copy over fields not defined in the mapping" do
+      john = subject.new(_id: 1, id: 1, name: "John", birthdate: "1985-10-31", sort: ['john'])
+      mari = subject.new(_id: 2, id: 2, name: "Mari", birthdate: "1986-09-24", sort: ['mari'])
+
+      john.update
+      mari.update
+
+      subject.flush_index
+      results = subject.search({})
+      expect(results.first.birthdate).to be
+
+      # no birthdate
+      subject = Class.new(Elasticity::Document) do
+        def self.name
+          "SomeClass"
+        end
+
+        configure do |c|
+          c.index_base_name = "users"
+          c.document_type   = "user"
+          c.strategy        =  Elasticity::Strategies::AliasIndex
+
+          c.mapping = {
+            "properties" => {
+              id: { type: "integer" },
+              name: { type: "string", index: "not_analyzed" },
+            },
+          }
+        end
+
+        attr_accessor :id, :name
+
+        def to_document
+          { id: id, name: name }
+        end
+      end
+
+      subject.remap!
+      subject.flush_index
+
+      results = subject.search({})
+      expect(results.first.respond_to?(:birthdate)).to be false
+    end
+
     it "recover from remap interrupts" do
       number_of_docs = 2000
       docs = number_of_docs.times.map do |i|

data/spec/functional/segmented_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe "Segmented indexes", elasticsearch: true do
         c.document_type = "person"
         c.mapping = {
           properties: {
-            name: { type: "string" },
+            name: { type: "text" },
           },
         }
       end
@@ -42,6 +42,7 @@ RSpec.describe "Segmented indexes", elasticsearch: true do
     ensure_index(seg)
 
     rodrigo = seg.new(name: "rodrigo")
+
     id, success = rodrigo.update
     expect(id).to be_kind_of(String)
     expect(success).to be true

data/spec/units/search_spec.rb

@@ -49,12 +49,13 @@ RSpec.describe "Search" do
   end
 
   let :scan_response do
-    { "_scroll_id" => "abc123", "hits" => { "total" => 2 } }
+    { "_scroll_id" => "abc123", "hits" => { "total" => 2, "hits" => [
+      { "_id" => 1, "_source" => { "name" => "foo" } }
+    ]}}
   end
 
   let :scroll_response do
-    { "_scroll_id" => "abc456", "hits" => { "total" => 2, "hits" => [
-      { "_id" => 1, "_source" => { "name" => "foo" } },
+    { "_scroll_id" => "abc456", "hits" => { "total" => 1, "hits" => [
       { "_id" => 2, "_source" => { "name" => "bar" } },
     ]}}
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -260,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: ActiveModel-based library for working with Elasticsearch