es_query_builder 2.0.0 → 2.0.1

data/lib/enums/zero_terms_query.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for zer terms query.
+  # If the analyzer used removes all tokens in a query like a stop filter does,
+  # the default behavior is to match no documents at all.
+  # In order to change that the zero_terms_query option can be used,
+  # which accepts none (default) and all which corresponds to a match_all query.
+  class ZeroTermsQuery
+    # @!visibility protected
+    attr_reader :zero_term
+    # @!visibility protected
+    ZERO_TERMS_QUERY = { all: 'all', none: 'none' }.freeze
+
+    # @!visibility protected
+    ZERO_TERMS_QUERY.each do |zero_term_query, es_value|
+      define_singleton_method(zero_term_query) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method all
+    # @return [ValidationMethods] ValidationMethods object
+    #   corresponding to elasticsearch option of 'all'
+
+    # @!scope class
+    # @!method none
+    # @return [ValidationMethods] ValidationMethods object
+    #   corresponding to elasticsearch option of 'none'
+
+    # @!visibility protected
+    def initialize(zero_term)
+      @zero_term = zero_term
+    end
+  end
+end

data/lib/function_scores/random_score_function_builder.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'score_function_builder'
+module FunctionScores
+  # A function that computes a random score for the matched documents
+  #     Query Components:
+  #       seed: Seed value based on which the random number will be generated
+  #       field: Field value based on which the random number will be generated
+  class RandomScoreFunctionBuilder < ScoreFunctionBuilder
+    # @!visibility protected
+    NAME = 'random_score'
+
+    # @return [Hash] serailized json query for the object
+    def function
+      function = {}
+      rs_query = super
+      rs_query[:field] = @field if field.present?
+      rs_query[:seed] = @seed if seed.present?
+      function[name.intern] = rs_query
+      function
+    end
+
+    # @!visibility protected
+    # Returns the seed value.
+    def seed_expr
+      @seed
+    end
+
+    # @params [Numeric] Seed Value
+    # Sets the seed value.
+    # @return [RandomScoreFunctionBuilder]
+    # modified self
+    def seed(value)
+      @seed = value
+      self
+    end
+
+    # @!visibility protected
+    # Returns the field value.
+    def field_expr
+      @field
+    end
+
+    # @params [String] field name
+    # Sets the field value.
+    # @return [RandomScoreFunctionBuilder]
+    # modified self
+    def field(value)
+      @field = value
+      self
+    end
+  end
+end

data/lib/function_scores/score_function_builder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FunctionScores
+  # Base class for function score builder classes
+  class ScoreFunctionBuilder
+    include AttributesReader
+
+    # @return [Hash] serialized json query for the object
+    def function
+      {}
+    end
+
+    # Elasticsearch key for the score function class.
+    # @return [String] es key for the score function class
+    def name
+      self.class::NAME
+    end
+  end
+end

data/lib/function_scores/script_score_function_builder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'score_function_builder'
+module FunctionScores
+  # A function that uses a script to compute or influence the
+  # score of documents that match with the inner query or filter.
+  class ScriptScoreFunctionBuilder < ScoreFunctionBuilder
+    # @!visibility protected
+    NAME = 'script_score'
+
+    # @params [Misc::Script] script script object for the function
+    def initialize(script:)
+      @script = script
+    end
+
+    # @return [Hash] serialized json query for the object
+    def function
+      function = {}
+      ss_query = super
+      ss_query[:script] = @script.settings
+      function[name.intern] = ss_query
+      function
+    end
+
+    # @!visibility protected
+    def script_expr
+      @script
+    end
+  end
+end

data/lib/function_scores/weighted_score_function_builder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'score_function_builder'
+module FunctionScores
+  # A query that multiplies the weight to the score.
+  class WeightedScoreFunctionBuilder < ScoreFunctionBuilder
+    # @!visibility protected
+    NAME = 'weight'
+    # @!visibility protected
+    DEFAULT_WEIGHT = 1
+
+    def initialize
+      @weight = DEFAULT_WEIGHT
+    end
+
+    # @return [Hash] serialized json query for the object
+    def function
+      function = {}
+      function[name.intern] = @weight
+      function
+    end
+
+    # Returns the weight value
+    # @!visibility protected
+    def weight_expr
+      @weight
+    end
+
+    # @params [Numeric] value weight for the weighted function
+    # Sets the weight value.
+    # @returns [WeightedScoreFunctionBuilder]
+    #   modified self
+    def weight(value)
+      @weight = value
+      self
+    end
+  end
+end

data/lib/misc/bucket_order.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Misc
+  # Aggregations::Buckets ordering strategy.
+  class BucketOrder
+    include AttributesReader
+
+    # @param [String|Symbol] field
+    # @param [Enums::SortOrders] order : Enums::SortOrders.(desc|asc),
+    #   defaults to Enums::SortOrders.desc
+    def initialize(field:, order: Enums::SortOrders.desc)
+      @field = field.intern
+      @order = order
+    end
+
+    # return [Hash]
+    def settings
+      {@field => @order.sort_order}
+    end
+
+    # @return [String]
+    # @!visibility protected
+    def field_expr
+      @field.to_s
+    end
+
+    # @return [Enums::SortOrders]
+    # @!visibility protected
+    def order_expr
+      @order
+    end
+  end
+end

data/lib/misc/geo_point.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Misc
+  # Point Class
+  class GeoPoint
+    include AttributesReader
+
+    # @params [Numeric] lat latitude
+    # @params [Numeric] lng longitude
+    # @params [Array|String] latlng
+    #   latitude and longitude as array or string
+    #   Format in [lon, lat] when array, such as [-70,40]
+    #   Format in lat,lon when string, such as '40,-70'
+    # @params [String] geohash point geohash
+    def initialize(lat: nil, lng: nil, latlng: nil, geo_hash: nil)
+      if lat.present? && lng.present?
+        @lat = lat.to_f
+        @lng = lng.to_f
+        @type = :float
+      elsif latlng.present?
+        @latlng = latlng
+        @type = latlng.class.name.downcase.intern
+      elsif geo_hash.present?
+        @geo_hash = geo_hash
+        @type = :geohash
+      else
+        raise 'Provide Point as floating values latitude and longitude
+               or a string or an array or a geohash'
+      end
+    end
+
+    # @return [Hash] serialized json query for object
+    def settings
+      case @type
+      when :float
+        { lat: @lat, lon: @lng }
+      when :array || :string
+        @latlng
+      when :geohash
+        @geohash
+      end
+    end
+
+    # @!visibility protected
+    def lat_expr
+      @lat
+    end
+
+    # @!visibility protected
+    def lng_expr
+      @lng
+    end
+
+    # @!visibility protected
+    def latlng_expr
+      @latlng
+    end
+
+    # @!visibility protected
+    def geo_hash_expr
+      @geo_hash
+    end
+  end
+end

data/lib/misc/range.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Misc
+  # A bucket associated with a specific range
+  class Range
+    include AttributesReader
+
+    # @param [String|Float] from
+    # @param [String|Float] to
+    # @param [String] key
+    def initialize(from: nil, to: nil, key: '')
+      @from = from if from.present?
+      @to = to if to.present?
+      @key = key if key.present?
+    end
+
+    # return [Hash] serialized json query for object
+    def settings
+      settings = {}
+      settings[:key] = @key if @key.present?
+      settings[:from] = @from if @from.present?
+      settings[:to] = @to if @to.present?
+      settings
+    end
+
+    # @return [String|Float]
+    # @!visibility protected
+    def from_expr
+      @from
+    end
+
+    # @return [String|Float]
+    # @!visibility protected
+    def to_expr
+      @to
+    end
+
+    # @return [String]
+    # @!visibility protected
+    def key_expr
+      @key
+    end
+  end
+end

data/lib/misc/script.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Misc
+  # Script represents used-defined input that can be used to compile and
+  # execute a script from the ScriptService based on the ScriptType.
+  class Script
+    include AttributesReader
+
+    # @param [String] id_or_code
+    # @param [Hash] params
+    # @param [Enums::ScriptTypes] type : Enums::ScriptTypes.(inline|stored),
+    #   defaults to Enums::ScriptTypes.inline
+    # @param [String] lang
+    # @param [Hash] options
+    def initialize(id_or_code:, params: {}, type: Enums::ScriptTypes.inline, lang: 'painless', options: {})
+      @id_or_code = id_or_code
+      @params = params
+      @type = type
+      @lang = lang
+      @options = options
+    end
+
+    # return [Hash]
+    def settings
+      settings = {}
+      if @type.script_type == Enums::ScriptTypes.inline.script_type
+        settings[:source] = @id_or_code
+      else
+        settings[:id] = @id_or_code
+      end
+      settings[:lang] = @lang if @lang.present?
+      settings[:params] = @params if @params.present?
+      settings[:options] = @options if @options.present?
+      settings
+    end
+
+    # @return [String]
+    def id_or_code_expr
+      @id_or_code
+    end
+
+    # @return [Hash]
+    def params_expr
+      @params
+    end
+
+    # @return [Enums::ScriptTypes]
+    def type_expr
+      @type
+    end
+
+    # @return [String]
+    def lang_expr
+      @lang
+    end
+
+    # @return [Hash]
+    def options_expr
+      @options
+    end
+  end
+end

data/lib/misc/terms_lookup.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Misc
+  # Terms lookup fetches the field values of an existing document.
+  # Elasticsearch then uses those values as search terms. This can be helpful
+  # when searching for a large set of terms. Because terms lookup fetches values
+  # from a document, the _source mapping field must be enabled to
+  # use terms lookup. The _source field is enabled by default.
+  class TermsLookup
+    include AttributesReader
+
+    # @params [String] index index name
+    # @params [String] id document id
+    # @params [String] path name of the field to fetch values from
+    def initialize(index:, id:, path:)
+      @index = index
+      @id = id
+      @path = path
+    end
+
+    # @return [Hash] serialized json query for the object
+    def settings
+      settings = {}
+      settings[:index] = @index.intern
+      settings[:id] = @id.intern
+      settings[:path] = @path.intern
+      settings
+    end
+
+    # @!visibility protected
+    def index_expr
+      @index
+    end
+
+    # @!visibility protected
+    def id_expr
+      @id
+    end
+
+    # @!visibility protected
+    def path_expr
+      @path
+    end
+  end
+end

data/lib/queries/abstract_query_builder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Queries
+  # General methods for query classes
+  module AbstractQueryBuilder
+    # @params [QueryBuilder] query query object to be matched
+    # Checks if both the query objects are same
+    # @return [Boolean] if both queries are same
+    def do_equals?(query)
+      # Checks if given query object is same as this query object
+      self.query == query.query
+    end
+
+    # @!visibility protected
+    def common_query
+      common_query = {}
+      common_query[:boost] = @boost if @boost.present?
+      common_query
+    end
+
+    def name
+      self.class::NAME.to_s
+    end
+
+    # @!visibility protected
+    def wrap_query
+      query = { query: self.query }
+      query
+    end
+  end
+end