es_query_builder 2.0.0 → 2.0.1

data/lib/queries/range_query_builder.rb

@@ -0,0 +1,153 @@
+# Matches documents with fields that have terms within a certain range.
+require_relative 'query_builder'
+module Queries
+  class RangeQueryBuilder < QueryBuilder
+
+    NAME = "range"
+
+=begin
+    params:
+      @gt: Greater-than
+      @gte: Greater-than or equal to
+      @lt: Less-than
+      @lte: Less-than or equal to
+      @format: Formatted dates will be parsed using the format specified on the date field by default, 
+               but it can be overridden by passing the format parameter to the range query
+      @time_zone: Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself 
+                  (if the format accepts it), or it can be specified as the time_zone parameter
+
+      @relation: range queries can be used on fields of type range, allowing to match a range specified in the query with a range field value in the document.
+                 The relation parameter controls how these two ranges are matched:
+                  WITHIN
+                    Matches documents who’s range field is entirely within the query’s range.
+                  CONTAINS
+                    Matches documents who’s range field entirely contains the query’s range.
+                  INTERSECTS
+                    Matches documents who’s range field intersects the query’s range. This is the default value when querying range fields.
+    
+    Date math and rounding
+      When using date math to round dates to the nearest day, month, hour, etc, the rounded dates depend on whether the ends of the ranges 
+      are inclusive or exclusive.Rounding up moves to the last millisecond of the rounding scope, and rounding down to the first millisecond 
+      of the rounding scope. For example:
+        gt
+          Greater than the date rounded up: 2014-11-18||/M becomes 2014-11-30T23:59:59.999, ie excluding the entire month.
+        gte
+          Greater than or equal to the date rounded down: 2014-11-18||/M becomes 2014-11-01, ie including the entire month.
+        lt
+          Less than the date rounded down: 2014-11-18||/M becomes 2014-11-01, ie excluding the entire month.
+        lte
+          Less than or equal to the date rounded up: 2014-11-18||/M becomes 2014-11-30T23:59:59.999, ie including the entire month.
+=end
+
+    def initialize field_name:
+      @field_name = field_name
+      @gt= nil
+      @gte= nil
+      @lt= nil
+      @lte= nil
+      @format= nil
+      @time_zone = nil
+      @relation= nil
+    end
+
+    def query
+      query = {}
+      range_query = {}
+      field_options = self.common_query
+      field_options[:gt] = @gt if @gt.present?
+      field_options[:gte] = @gte if @gte.present?
+      field_options[:lt] = @lt if @lt.present?
+      field_options[:lte] = @lte if @lte.present?
+      field_options[:format] = @format if @format.present?
+      field_options[:time_zone] = @time_zone if @time_zone.present?
+      field_options[:relation] = @relation if @relation.present?
+      range_query[@field_name.intern] = field_options
+      query[name.intern] = range_query
+      return query
+    end
+
+  # returns field_name
+    def field_name_expr
+      return @field_name
+    end
+
+  ########## Greater Than ##########
+  # returns gt
+    def gt_expr
+      return @gt
+    end
+  # sets gt
+    def gt value
+      @gt = value
+      return self
+    end
+
+  ########## Greater Than Or Equal To ##########
+  # returns gte
+    def gte_expr
+      return @gte
+    end
+  # sets gte
+    def gte value
+      @gte = value
+      return self
+    end
+
+  ########## Less Than ##########
+  # return lt
+    def lt_expr
+      return @lt
+    end
+  # sets lt
+    def lt value
+      @lt = value
+      return self
+    end
+
+  ########## Less Than Or Equal To ##########
+  # returns lte
+    def lte_expr
+      return @lte
+    end
+  # sets lte
+    def lte value
+      @lte = value
+      return self
+    end
+
+  ########## Format ##########
+  # returns format
+    def format_expr
+      return @format
+    end
+  # sets format
+    def format value
+      @format = value
+      return self
+    end
+
+  ########## Time Zone ##########
+  # returns time_zone
+    def time_zone_expr
+      return @time_zone
+    end
+  # sets time_zone
+    def time_zone value
+      @time_zone = value
+      return self
+    end
+
+  ########## RANGE RELATION ##########
+  # returns relation
+    def relation_expr
+      return @relation
+    end
+  # sets relation, input: ShapeRelation object
+    def relation shape_relation
+      @relation = shape_relation.relation
+      return self
+    end
+
+  end
+end
+

data/lib/queries/term_query_builder.rb

@@ -0,0 +1,44 @@
+=begin
+  Returns documents that contain an exact term in a provided field.
+  You can use the term query to find documents based on a precise value such as a price, a product ID, or a username.
+=end
+require_relative 'query_builder'
+module Queries
+  class TermQueryBuilder < QueryBuilder
+
+    NAME = "term"
+
+=begin
+    @params: 
+      field_name: name of the field in the document which is being queried
+      value: is being matched to the data in that field.
+=end
+    def initialize field_name:, value: nil
+      @field_name = field_name
+      @value = value
+    end
+
+    def query
+      query = {}
+      term_query = {}
+      field_options = self.common_query
+      field_options[:value] = @value
+      term_query[@field_name.intern] = field_options
+      query[name.intern] = term_query
+      return query
+    end
+
+  ########## FIELD NAME ##########
+  # returns field_name
+    def field_name_expr
+      return @field_name
+    end
+
+  ########## FIELD VALUE ##########
+  # returns value
+    def value_expr
+      return @value
+    end
+
+  end
+end

data/lib/queries/terms_query_builder.rb

@@ -0,0 +1,54 @@
+=begin
+  Returns documents that contain one or more exact terms in a provided field.
+  The terms query is the same as the term query, except you can search for multiple values.
+=end
+require_relative 'query_builder'
+module Queries
+  class TermsQueryBuilder < QueryBuilder
+
+    NAME = "terms"
+    
+=begin 
+    @params: 
+      field_name: name of the field in the document which is being queried
+      values: values which are matched to the data in that field can be:
+                Data Set: 
+                  Directly matched to the data in the given field.
+                Terms Lookup:
+                  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.
+=end
+    def initialize field_name:, values: []
+      @field_name = field_name
+      if values.is_a?(Misc::TermsLookup)
+        @terms_lookup = values
+      else
+        @values = values.is_a?(Array) ? values : values.split(',')
+      end
+    end
+
+    def query
+      query = {}
+      terms_query = self.common_query
+      terms_query[@field_name.intern] = @values if @values.present?
+      terms_query[@field_name.intern] = @terms_lookup.settings if @terms_lookup.present?
+      query[name.intern] = terms_query
+      return query
+    end
+
+  ########## FIELD NAME ##########
+  # returns field_name
+    def field_name_expr
+      return @field_name
+    end
+
+  ########## FIELD VALUE ##########
+  # returns value
+    def values_expr
+      return @terms_lookup || @values
+    end
+
+  end
+end

data/lib/sort/abstract_sort_builder.rb

@@ -0,0 +1,15 @@
+module Sort  
+  module AbstractSortBuilder
+
+    def doEquals​? sort
+      # Checks if given sort object is same as this sort object
+      return self.query == sort.query
+    end
+
+    def name
+      self.class::NAME.to_s
+    end
+
+  end
+end
+

data/lib/sort/field_sort_builder.rb

@@ -0,0 +1,70 @@
+# A sort builder to sort based on a document field.
+require_relative 'sort_builder'
+module Sort
+  class FieldSortBuilder < SortBuilder
+
+    NAME = "field_sort"
+
+    def initialize field_name:
+      @field_name = field_name
+    end
+
+    def query
+      query = {}
+      field_query = self.common_query
+      field_query[:mode] = @sort_mode if @sort_mode.present?
+      field_query[:missing] = @missing if @missing.present?
+      field_query[:unmapped_type] = @unmapped_type if @unmapped_type.present?
+      field_query[:nested] = @nested_sort.query[:nested] if @nested_sort.present?
+      query[@field_name.intern] = field_query
+      return query
+    end
+
+  # returns field_name
+    def field_name_expr
+      return @field_name
+    end
+
+  # returns nested_sort
+    def nested_sort_expr
+      return @nested_sort
+    end
+  # sets nested_sort
+    def nested_sort nested_sort
+      raise ArgumentError.new("pass a nested query object") if nested_sort.name != "nested"
+      @nested_sort = nested_sort
+      return self
+    end
+
+  # returns missing
+    def missing_expr
+      return @missing
+    end
+  # sets missing
+    def missing missing
+      @missing = missing.is_a?(Missing) ? missing.missing : missing
+      return self
+    end
+
+  # returns sort_mode
+    def sort_mode_expr
+      return @sort_mode
+    end
+  # sets sort_mode
+    def sort_mode sort_mode
+      @sort_mode = sort_mode.sort_mode
+      return self
+    end
+
+  # returns unmapped_type
+    def unmapped_type_expr
+      return  @unmapped_type
+    end
+  # sets unmapped_type
+    def unmapped_type unmapped_type
+      @unmapped_type = unmapped_type
+      return self
+    end
+
+  end
+end

data/lib/sort/geo_distance_sort_builder.rb

@@ -0,0 +1,120 @@
+# A geo distance based sorting on a geo point like field.
+require_relative 'sort_builder'
+module Sort
+  class GeoDistanceSortBuilder < SortBuilder
+
+    NAME = '_geo_distance'
+
+=begin
+    @params:
+      field_name: The geo point like field the distance based sort operates on.
+      distance_type: How to compute the distance. Can either be arc (default), 
+                     or plane (faster, but inaccurate on long distances and close to the poles).
+      distance_unit: The unit to use when computing sort values. The default is m (meters).
+      nested_sort: Nested path within current object.
+      ignore_unmapped: Indicates if the unmapped field should be treated as a missing value. 
+                       Setting it to true is equivalent to specifying an unmapped_type in the field sort. The default is false (unmapped field cause the search to fail).
+      point: The point to create the range distance facets from.
+      sort_mode: What to do in case a field has several geo points. By default, the shortest distance is taken into account when sorting 
+                 in ascending orderand the longest distance when sorting in descending order. Supported values are min, max, median and avg.
+      validation_method: Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude,
+                         set to COERCE to additionally try and infer correct coordinates (default is STRICT).
+=end
+    
+    def initialize field_name:, point:
+      @field_name = field_name
+      @point = point
+      @distance_type = nil
+      @distance_unit = nil
+      @nested_sort = nil
+      @ignore_unmapped = nil
+      @sort_mode = nil
+      @validation_method = nil
+    end
+
+    def query
+      query = {}
+      go_query = self.common_query
+      go_query[@field_name.to_s.intern] = @point.settings
+      go_query[:distance_type] = @distance_type if @distance_type.present?
+      go_query[:unit] = @distance_unit if @distance_unit.present?
+      go_query[:nested] = @nested_sort.query if @nested_sort.present?
+      go_query[:ignore_unmapped] = @ignore_unmapped if @ignore_unmapped.present?
+      go_query[:sort_mode] = @sort_mode if @sort_mode.present?
+      go_query[:validation_method] = @validation_method if @validation_method.present?
+      query[name.intern] = go_query
+      return query
+    end
+
+  # returns field_name
+    def field_name_expr
+      return @field_name
+    end
+
+  # returns point
+    def point_expr
+      return @point
+    end
+  # sets point
+    def point point
+      @point = point
+      return self
+    end
+
+  # returns distance_type
+    def distance_type_expr
+      return @distance_type
+    end
+  # sets distance_type
+    def distance_type distance_type
+      @distance_type = distance_type.distance_type
+      return self
+    end
+
+  # returns distance_unit
+    def distance_unit_expr
+      return @distance_unit
+    end
+  # sets distance_unit
+    def distance_unit distance_unit
+      @distance_unit = distance_unit.distance_unit
+      return self
+    end
+
+  # returns nested_sort
+    def nested_sort_expr
+      return @nested_sort
+    end
+  # sets nested_sort
+    def nested_sort nested_sort
+      @nested_sort = nested_sort
+      return self
+    end
+
+  # returns ignore_unmapped
+    def ignore_unmapped_expr
+      return @ignore_unmapped
+    end
+  # sets ignore_unmapped
+    def ignore_unmapped ignore_unmapped
+      @ignore_unmapped = ignore_unmapped
+      return self
+    end
+
+  # returns sort_mode
+    def sort_mode_expr
+      return @sort_mode
+    end
+  # sets sort_mode
+    def sort_mode sort_mode
+      @sort_mode = sort_mode.sort_mode
+      return self
+    end
+
+    def validation_method validation_method
+      @validation_method = validation_method.validation_method
+      return self
+    end
+
+  end
+end