elasticated 2.5.5 → 3.0.0

data/lib/elasticated/aggregations/subaggregated.rb

@@ -20,7 +20,7 @@ module Elasticated
     end
 
     def parse_subaggregations(response)
-      if compact and _subaggregations.one?
+      if compact and _subaggregations.count == 1
         single_subaggregation = _subaggregations.first
         single_subaggregation.parse(response[single_subaggregation.name.to_s])
       else

data/lib/elasticated/boolean_clause.rb

@@ -1,7 +1,8 @@
 module Elasticated
   class BooleanClause
 
-    include Clonable
+    include Mixins::Clonable
+    include Mixins::Inspectionable
 
     attr_accessor :conditions
 
@@ -11,8 +12,8 @@ module Elasticated
 
     # delimiters
 
-    def accept_visitor(visitor)
-      visitor.visit_boolean_clause(self)
+    def fill_delimiter(field_delimiter)
+      conditions.each{ |condition| condition.fill_delimiter field_delimiter }
     end
 
     # conditions

data/lib/elasticated/bulk_actions/create_action.rb

@@ -0,0 +1,14 @@
+module Elasticated
+  module BulkActions
+    class CreateAction < IndexAction
+
+      protected
+
+      # override
+      def command_name
+        :create
+      end
+
+    end
+  end
+end

data/lib/elasticated/bulk_actions/delete_action.rb

@@ -0,0 +1,30 @@
+module Elasticated
+  module BulkActions
+    class DeleteAction < StandardAction
+
+      attr_accessor :document_id, :params
+
+      def initialize(repository, document_id, params={})
+        super repository
+        self.document_id = document_id
+        self.params = params
+      end
+
+      def build
+        original_params = Helpers.hash_deep_dup params
+        # preparations
+        prepared_params = repository.params_for_ids [document_id], original_params
+        # verifications
+        prepared_params[:index] || raise("A target index should be specified in a delete")
+        prepared_params[:type] || raise("A target type should be specified in a delete")
+        # the final command
+        prepared_params[:_index] = prepared_params.delete :index
+        prepared_params[:_type] = prepared_params.delete :type
+        prepared_params[:_id] = document_id
+        command = { delete: prepared_params }
+        [command]
+      end
+
+    end
+  end
+end

data/lib/elasticated/bulk_actions/index_action.rb

@@ -0,0 +1,35 @@
+module Elasticated
+  module BulkActions
+    class IndexAction < StandardAction
+
+      attr_accessor :document, :params
+
+      def initialize(repository, document, params={})
+        super repository
+        self.document = document
+        self.params = params
+      end
+
+      def build
+        original_params = Helpers.hash_deep_dup params
+        # preparations
+        prepared_document = repository.prepare_document document
+        prepared_params = repository.params_for_document document, original_params
+        # the final command
+        prepared_params[:_index] = prepared_params.delete(:index) || prepared_document.index || raise("An index name is required for a document indexation")
+        prepared_params[:_type] = prepared_params.delete(:type) || prepared_document.type || raise("A type name is required for a document indexation")
+        prepared_params[:_id] = prepared_params.delete(:id) || prepared_document.id
+        command = { command_name => prepared_params }
+        prepared_source = prepared_document.source
+        [command, prepared_source]
+      end
+
+      protected
+
+      def command_name
+        :index
+      end
+
+    end
+  end
+end

data/lib/elasticated/bulk_actions/standard_action.rb

@@ -0,0 +1,22 @@
+module Elasticated
+  module BulkActions
+    class StandardAction
+
+      # abstract class
+      # child must implement 'build()' => Hash
+
+      attr_accessor :repository
+
+      def initialize(repository)
+        self.repository = repository
+      end
+
+      # def build
+      #   command = build_command
+      #   body = build_body
+      #   [command, body]
+      # end
+
+    end
+  end
+end

data/lib/elasticated/bulk_actions/update_action.rb

@@ -0,0 +1,44 @@
+module Elasticated
+  module BulkActions
+    class UpdateAction < StandardAction
+
+      attr_accessor :document_id, :params
+
+      def initialize(repository, document_id, params={})
+        super repository
+        self.document_id = document_id
+        self.params = params
+      end
+
+      def build
+        original_params = Helpers.hash_deep_dup params
+        # verifications
+        source = original_params.delete(:source) || raise("No body specified for partial update")
+        # preparations
+        prepared_source = repository.prepare_source Helpers.hash_deep_dup source
+        prepared_params = repository.params_for_source source, original_params
+        # more verifications
+        prepared_params[:index] || raise("A target index should be specified in a partial update")
+        prepared_params[:type] || raise("A target type should be specified in a partial update")
+        # the final command
+        prepared_params[:_index] = prepared_params.delete :index
+        prepared_params[:_type] = prepared_params.delete :type
+        prepared_params[:_id] = document_id
+        command = { command_name => prepared_params }
+        body = build_body_from prepared_source
+        [command, body]
+      end
+
+      protected
+
+      def command_name
+        :update
+      end
+
+      def build_body_from(prepared_source)
+        { doc: prepared_source }
+      end
+
+    end
+  end
+end

data/lib/elasticated/bulk_actions/upsert_action.rb

@@ -0,0 +1,14 @@
+module Elasticated
+  module BulkActions
+    class UpsertAction < UpdateAction
+
+      protected
+
+      # override
+      def build_body_from(prepared_source)
+        { doc: prepared_source, doc_as_upsert: true }
+      end
+
+    end
+  end
+end

data/lib/elasticated/bulk_request.rb

@@ -0,0 +1,58 @@
+module Elasticated
+  class BulkRequest
+
+    def self.build_over(repository, &block)
+      request = new repository
+      request.evaluate block
+      request
+    end
+
+    include Mixins::Inspectionable
+    include Mixins::BlockEvaluation
+
+    attr_accessor :repository, :actions
+    attr_accessor :errors, :items
+
+    def initialize(repository)
+      self.repository = repository
+      self.actions = Array.new
+    end
+
+    def add(action)
+      actions << action
+    end
+
+    def build
+      actions.map(&:build).flatten
+    end
+
+    def to_text
+      build.map(&:to_json)*"\n"
+    end
+
+    def get_action_class(action_name)
+      return nil unless action_name.to_s.end_with? '_document'
+      camel_case_name = Helpers.string_to_camel_case action_name.to_s.gsub /\_document$/, ''
+      self.class.const_get("::Elasticated::BulkActions::#{camel_case_name}Action") rescue nil
+    end
+
+    def method_missing(method_name, *args, &block)
+      action_class = get_action_class method_name
+      if action_class
+        action = action_class.new(repository, *args, &block)
+        add action
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private=false)
+      get_action_class(name) || super
+    end
+
+    def parse(result)
+      Response.parse result
+    end
+
+  end
+end

data/lib/elasticated/bulk_request/response.rb

@@ -0,0 +1,32 @@
+module Elasticated
+  class BulkRequest
+    class Response
+
+      include Mixins::Inspectionable
+
+      def self.parse(elasticsearch_response)
+        response = new
+        response.took = elasticsearch_response['took']
+        response.errors = elasticsearch_response['errors']
+        response.items = elasticsearch_response['items'].map do |elasticsearch_item|
+          ResponseItem.parse elasticsearch_item
+        end
+        response
+      end
+
+      attr_accessor :took, :errors, :items
+
+      def errors?
+        !!errors
+      end
+      alias_method :error?, :errors?
+
+      def text_for_inspect
+        text = (items.count == 1) ? "#{items.count} item" : "#{items.count} items"
+        text = errors? ? "#{text}, with errors" : "#{text}, no errors"
+        text
+      end
+
+    end
+  end
+end

data/lib/elasticated/bulk_request/response_item.rb

@@ -0,0 +1,39 @@
+module Elasticated
+  class BulkRequest
+    class ResponseItem
+
+      include Mixins::Inspectionable
+
+      def self.parse(partial_response)
+        item = new
+        item.action = partial_response.first.first
+        data = partial_response.first.last
+        item.index = data['_index']
+        item.type = data['_type']
+        item.id = data['_id']
+        item.version = data['_version']
+        item.status = data['status']
+        item.found = data['found']
+        item.error = data['error']
+        item
+      end
+
+      attr_accessor :action, :index, :type, :id, :version, :status, :found, :error
+
+      def error?
+        !!error
+      end
+
+      def completed?
+        !error?
+      end
+
+      def text_for_inspect
+        text = "#{action} #{index}/#{type}/#{id} (status #{status})"
+        text = "#{text}, with error" if error?
+        text
+      end
+
+    end
+  end
+end

data/lib/elasticated/client.rb

@@ -1,6 +1,6 @@
 module Elasticated
   class Client
-    include Configurable
+    include Mixins::Configurable
 
     attr_accessor :transport
 
@@ -41,7 +41,7 @@ module Elasticated
       mapping = opts[:mapping]
       body = Hash.new
       body.merge!(settings: { number_of_shards: shards }) if shards
-      body.merge!(mappings: mapping) if mapping
+      body.merge!(mappings: mapping.to_h) if mapping # both Hash and Mapping::Builder responds to 'to_h'
       args.merge! body: body unless body.empty?
       log.info "Creating index '#{index_name}'"
       transport.indices.create args
@@ -65,6 +65,10 @@ module Elasticated
       log.info "Alias '#{index_alias}' removed from index '#{index_name}'"
     end
 
+    def update_mapping(index_name, type_name, mapping, opts={})
+      transport.indices.put_mapping opts.merge(index: index_name, type: type_name, body: mapping)
+    end
+
     def refresh_index(index_name)
       transport.indices.refresh index: index_name
       log.debug "Index '#{index_name}' refreshed"
@@ -95,11 +99,31 @@ module Elasticated
       transport.scroll opts.merge scroll_id: scroll_id
     end
 
-    def delete(body, opts={})
+    def delete_by_query(body, opts={})
       log_query :delete, body.to_json, opts
       transport.delete_by_query opts.merge body: body
     end
 
+    def get_document(document_id, opts={})
+      log_query :get, document_id, opts
+      transport.get opts.merge id: document_id
+    end
+
+    def get_documents(documents_ids, opts={})
+      log_query :mget, documents_ids, opts
+      transport.mget opts.merge body: { ids: documents_ids }
+    end
+
+    def delete_document(document_id, opts={})
+      log_query :delete, document_id, opts
+      transport.delete opts.merge id: document_id
+    end
+
+    def bulk(bulk_body, opts={})
+      log_query :bulk, bulk_body, opts
+      transport.bulk opts.merge body: bulk_body
+    end
+
     protected
 
     def log_query(query_type, message_body, query_opts={})

data/lib/elasticated/conditions/custom_condition.rb

@@ -2,7 +2,7 @@ module Elasticated
   module Conditions
     class CustomCondition
 
-      include Inspectionable
+      include Mixins::Inspectionable
 
       attr_accessor :body
 
@@ -14,8 +14,8 @@ module Elasticated
         body
       end
 
-      def accept_visitor(visitor)
-        visitor.visit_condition(self)
+      def fill_delimiter(field_delimiter)
+        # nothing to do
       end
 
     end

data/lib/elasticated/conditions/range_condition.rb

@@ -15,8 +15,11 @@ module Elasticated
         { range: { field => body }.merge(opts) }
       end
 
-      def accept_visitor(visitor)
-        visitor.visit_range(self)
+      def fill_delimiter(field_delimiter)
+        minimum_value = body[:gt] || body[:gte]
+        field_delimiter.set_minimum field, minimum_value
+        maximum_value = body[:lt] || body[:lte]
+        field_delimiter.set_maximum field, maximum_value
       end
 
     end

data/lib/elasticated/conditions/script_condition.rb

@@ -2,7 +2,7 @@ module Elasticated
   module Conditions
     class ScriptCondition
 
-      include Inspectionable
+      include Mixins::Inspectionable
 
       attr_accessor :script, :params
 
@@ -17,8 +17,8 @@ module Elasticated
         { script: body }
       end
 
-      def accept_visitor(visitor)
-        visitor.visit_condition(self)
+      def fill_delimiter(field_delimiter)
+        # nothing to do
       end
 
     end