elasticsearch-model 6.1.1 → 7.1.1

data/lib/elasticsearch/model.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 require 'hashie/mash'
 
 require 'active_support/core_ext/module/delegation'
@@ -72,9 +89,10 @@ module Elasticsearch
 
     # Adds the `Elasticsearch::Model` functionality to the including class.
     #
-    # * Creates the `__elasticsearch__` class and instance methods, pointing to the proxy object
-    # * Includes the necessary modules in the proxy classes
-    # * Sets up delegation for crucial methods such as `search`, etc.
+    # * Creates the `__elasticsearch__` class and instance method. These methods return a proxy object with
+    #   other common methods defined on them.
+    # * The module includes other modules with further functionality.
+    # * Sets up delegation for common methods such as `import` and `search`.
     #
     # @example Include the module in the `Article` model definition
     #
@@ -91,44 +109,16 @@ module Elasticsearch
       base.class_eval do
         include Elasticsearch::Model::Proxy
 
-        Elasticsearch::Model::Proxy::ClassMethodsProxy.class_eval do
-          include Elasticsearch::Model::Client::ClassMethods
-          include Elasticsearch::Model::Naming::ClassMethods
-          include Elasticsearch::Model::Indexing::ClassMethods
-          include Elasticsearch::Model::Searching::ClassMethods
-        end
-
-        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval do
-          include Elasticsearch::Model::Client::InstanceMethods
-          include Elasticsearch::Model::Naming::InstanceMethods
-          include Elasticsearch::Model::Indexing::InstanceMethods
-          include Elasticsearch::Model::Serializing::InstanceMethods
-        end
-
-        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval <<-CODE, __FILE__, __LINE__ + 1
-          def as_indexed_json(options={})
-            target.respond_to?(:as_indexed_json) ? target.__send__(:as_indexed_json, options) : super
-          end
-        CODE
-
-        # Delegate important methods to the `__elasticsearch__` proxy, unless they are defined already
-        #
+        # Delegate common methods to the `__elasticsearch__` ClassMethodsProxy, unless they are defined already
         class << self
           METHODS.each do |method|
             delegate method, to: :__elasticsearch__ unless self.public_instance_methods.include?(method)
           end
         end
-
-        # Mix the importing module into the proxy
-        #
-        self.__elasticsearch__.class_eval do
-          include Elasticsearch::Model::Importing::ClassMethods
-          include Adapter.from_class(base).importing_mixin
-        end
-
-        # Add to the registry if it's a class (and not in intermediate module)
-        Registry.add(base) if base.is_a?(Class)
       end
+
+      # Add to the model to the registry if it's a class (and not in intermediate module)
+      Registry.add(base) if base.is_a?(Class)
     end
 
     module ClassMethods
@@ -182,36 +172,11 @@ module Elasticsearch
         Response::Response.new(models, request)
       end
 
-      # Check if inheritance is enabled
-      #
-      # @note Inheritance is disabled by default.
-      #
-      def inheritance_enabled
-        @settings[:inheritance_enabled] ||= false
-      end
-
-      # Enable inheritance of index_name and document_type
-      #
-      # @example Enable inheritance
-      #
-      #     Elasticsearch::Model.inheritance_enabled = true
-      #
-      def inheritance_enabled=(inheritance_enabled)
-        warn STI_DEPRECATION_WARNING if inheritance_enabled
-        @settings[:inheritance_enabled] = inheritance_enabled
-      end
-
       # Access the module settings
       #
       def settings
         @settings ||= {}
       end
-
-      private
-
-      STI_DEPRECATION_WARNING = "DEPRECATION WARNING: Support for Single Table Inheritance (STI) is deprecated " +
-        "and will be removed in version 7.0.0.\nPlease save different model documents in separate indices and refer " +
-        "to the Elasticsearch documentation for more information.".freeze
     end
     extend ClassMethods
 

data/lib/elasticsearch/model/adapter.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 

data/lib/elasticsearch/model/adapters/active_record.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
     module Adapter

data/lib/elasticsearch/model/adapters/default.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
     module Adapter

data/lib/elasticsearch/model/adapters/mongoid.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
     module Adapter

data/lib/elasticsearch/model/adapters/multiple.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
     module Adapter
@@ -58,8 +75,8 @@ module Elasticsearch
                 klass.where(klass.primary_key => ids)
               when Elasticsearch::Model::Adapter::Mongoid.equal?(adapter)
                 klass.where(:id.in => ids)
-              else
-                klass.find(ids)
+            else
+              klass.find(ids)
             end
           end
 
@@ -91,13 +108,21 @@ module Elasticsearch
           def __type_for_hit(hit)
             @@__types ||= {}
 
-            @@__types[ "#{hit[:_index]}::#{hit[:_type]}" ] ||= begin
+            key = "#{hit[:_index]}::#{hit[:_type]}" if hit[:_type] && hit[:_type] != '_doc'
+            key = hit[:_index] unless key
+
+            @@__types[key] ||= begin
               Registry.all.detect do |model|
-                model.index_name == hit[:_index] && model.document_type == hit[:_type]
+                (model.index_name == hit[:_index] && __no_type?(hit)) ||
+                    (model.index_name == hit[:_index] && model.document_type == hit[:_type])
               end
             end
           end
 
+          def __no_type?(hit)
+            hit[:_type].nil? || hit[:_type] == '_doc'
+          end
+
           # Returns the adapter registered for a particular `klass` or `nil` if not available
           #
           # @api private

data/lib/elasticsearch/model/callbacks.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 

data/lib/elasticsearch/model/client.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 

data/lib/elasticsearch/model/ext/active_record.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # Prevent `MyModel.inspect` failing with `ActiveRecord::ConnectionNotEstablished`
 # (triggered by elasticsearch-model/lib/elasticsearch/model.rb:79:in `included')
 #

data/lib/elasticsearch/model/hash_wrapper.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 

data/lib/elasticsearch/model/importing.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 module Elasticsearch
   module Model
 
@@ -36,7 +53,29 @@ module Elasticsearch
         #
         # @yield [Hash] Gives the Hash with the Elasticsearch response to the block
         #
-        # @return [Fixnum] Number of errors encountered during importing
+        # @return [Fixnum] default, number of errors encountered during importing
+        # @return [Array<Hash>] if +return+ option is specified to be +"errors"+,
+        #   contains only those failed items in the response +items+ key, e.g.:
+        #
+        #     [
+        #       {
+        #         "index" => {
+        #           "error" => 'FAILED',
+        #           "_index" => "test",
+        #           "_type" => "_doc",
+        #           "_id" => '1',
+        #           "_version" => 1,
+        #           "result" => "foo",
+        #           "_shards" => {
+        #             "total" => 1,
+        #             "successful" => 0,
+        #             "failed" => 1
+        #           },
+        #           "status" => 400
+        #         }
+        #       }
+        #     ]
+        #
         #
         # @example Import all records into the index
         #
@@ -82,20 +121,19 @@ module Elasticsearch
         #
         # @example Update the batch before yielding it
         #
-        #     class Article
-        #       # ...
-        #       def self.enrich(batch)
-        #         batch.each do |item|
-        #           item.metadata = MyAPI.get_metadata(item.id)
-        #         end
-        #         batch
-        #       end
-        #     end
+        #    class Article
+        #      # ...
+        #      def self.enrich(batch)
+        #        batch.each do |item|
+        #          item.metadata = MyAPI.get_metadata(item.id)
+        #        end
+        #        batch
+        #      end
+        #    end
         #
         #    Article.import preprocess: :enrich
         #
-        # @example Return an array of error elements instead of the number of errors, eg.
-        #          to try importing these records again
+        # @example Return an array of error elements instead of the number of errors, e.g. to try importing these records again
         #
         #    Article.import return: 'errors'
         #
@@ -105,6 +143,7 @@ module Elasticsearch
           target_index = options.delete(:index)     || index_name
           target_type  = options.delete(:type)      || document_type
           transform    = options.delete(:transform) || __transform
+          pipeline     = options.delete(:pipeline)
           return_value = options.delete(:return)    || 'count'
 
           unless transform.respond_to?(:call)
@@ -120,10 +159,15 @@ module Elasticsearch
           end
 
           __find_in_batches(options) do |batch|
-            response = client.bulk \
-                         index:   target_index,
-                         type:    target_type,
-                         body:    __batch_to_bulk(batch, transform)
+            params = {
+              index: target_index,
+              type:  target_type,
+              body:  __batch_to_bulk(batch, transform)
+            }
+
+            params[:pipeline] = pipeline if pipeline
+
+            response = client.bulk params
 
             yield response if block_given?