es_query_builder 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f513758e289382abfa9120298c7d174e7978f41
-  data.tar.gz: 526d810b1e34728d83a4d1661695fcded2172c1a
+  metadata.gz: 3d7ba397b283a7a351ac4454d01d263c4bc77edf
+  data.tar.gz: 37d5c3e4ade5419ddeba118ed89aefa42c794807
 SHA512:
-  metadata.gz: 7eb026b02677a5013e58358e4f5c3f4dc50db925ab01faab431d5d873eda3a808c275fb907839e347062b724f6799aca5b07961a3c8b0aed58ad50466b2a70c8
-  data.tar.gz: a1a2b0f640c393660cd10b72f8ab4e188c4c37b31cc8bfee64aa33ae09a974006f7a4502a24413d7e2990ca870d0fa1ea5ccc46a4d0a62b7b0df8025f1988500
+  metadata.gz: 582ff1bcca907120ff94dd1f789120ceceb3d566f528f54501b138005c899cee4b885dde85d3bfb4dc7fe037743fbd5244bba6061421dcd1025f8c732602cdf6
+  data.tar.gz: 2878a3bd5a238c58d63f9a6d11ab72af3e7283a86700d27d5483dbba46f637d6d35911f1100847806c93f5db99fabed384f2b39107273bb3523734a32ba48d54

data/lib/constants.rb

@@ -1,4 +1,5 @@
 module Constants
   MAX_BULK_INDEX_SIZE = 2000
   FUNCTION_SCORE_METHODS = %w(multiply sum avg first max min)
+  RADIUS_OF_EARTH = 6378.1
 end

data/lib/misc/geo_bounding_box_point.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Misc
+  # Point Class
+  class GeoBoundingBoxPoint
+    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, radius: nil, latlng: nil, geo_hash: nil)
+      if lat.present? && lng.present?
+        @lat = lat.to_f
+        @lng = lng.to_f
+        @radius = radius.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
+        get_bounding_box_point
+      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
+
+    def get_coordinates
+      radius_of_earth = Constants::RADIUS_OF_EARTH
+      pi = Math::PI
+      deg_to_rad =  pi/180
+      lat_in_rad = @lat * deg_to_rad
+      lon_in_rad = @lng * deg_to_rad
+      delta_rad = @radius/radius_of_earth
+      ne_coordinates = {
+          latitude: (lat_in_rad + delta_rad)/ deg_to_rad,
+          longitude: (lon_in_rad + delta_rad)/ deg_to_rad
+      }
+      sw_coordinates = {
+          latitude: (lat_in_rad - delta_rad)/ deg_to_rad,
+          longitude: (lon_in_rad - delta_rad)/ deg_to_rad
+      }
+      nw_coordinates = {
+          latitude: (lat_in_rad - delta_rad)/ deg_to_rad,
+          longitude: (lon_in_rad + delta_rad)/ deg_to_rad
+      }
+      se_coordinates = {
+          latitude: (lat_in_rad + delta_rad)/ deg_to_rad,
+          longitude: (lon_in_rad - delta_rad)/ deg_to_rad
+      }
+      {ne_coordinates: ne_coordinates, sw_coordinates: sw_coordinates, nw_coordinates: nw_coordinates, se_coordinates: se_coordinates}
+    end
+
+    def get_bounding_box_point
+      direction_coordinates = get_coordinates
+      ne_lat_lng, sw_lat_lng =  direction_coordinates[:ne_coordinates], direction_coordinates[:sw_coordinates]
+      {
+        top_right: {lat: ne_lat_lng[:latitude].to_f,
+                   lon: ne_lat_lng[:longitude].to_f},
+        bottom_left: {lat: sw_lat_lng[:latitude].to_f,
+                     lon: sw_lat_lng[:longitude].to_f}
+      }
+    end
+
+  end
+end
+

data/lib/queries/geo_bounding_box_query_builder.rb

@@ -0,0 +1,123 @@
+# Filters documents that include only hits that exists within a specific distance from a geo point.
+require_relative 'query_builder'
+module Queries
+  class GeoBoundingBoxQueryBuilder < QueryBuilder
+
+    NAME = 'geo_bounding_box'
+    DEFAULT_DISTANCE_UNIT = ::Enums::DistanceUnits.meters
+
+=begin
+    @params:
+      field_name: geo_point field in the document which is matched with the given query
+      point: center point for this query
+      distance: The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches.
+      distance_unit: The distance can be specified in various units. See Distance Units.
+      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)
+      writable_name: Optional name field to identify the query
+      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).
+      ignore_unmapped: When set to true the ignore_unmapped option will ignore an unmapped field and will not match any documents for this query.
+                       When set to false (the default value) the query will throw an exception if the field is not mapped.
+=end
+
+    def initialize field_name:
+      @field_name = field_name
+      @point = nil
+      @distance = nil
+      @distance_unit = DEFAULT_DISTANCE_UNIT.distance_unit
+      @writable_name = nil
+      @validation_method = nil
+      @ignore_unmapped = nil
+    end
+
+    def query
+      query = {}
+      geo_query = self.common_query
+      geo_query[@field_name] = @point.settings
+      geo_query[:writable_name] = @writable_name
+      geo_query[:validation_method] = @validation_method
+      geo_query[:ignore_unmapped] = @ignore_unmapped
+      query[name.intern] = geo_query
+      return query
+    end
+
+    # Returns point
+    def point_expr
+      return @point
+    end
+
+    # Sets point
+    def point point
+      @point = point
+      return self
+    end
+
+    # Returns field_name
+    def field_name_expr
+      return @field_name
+    end
+
+    # Returns distance
+    def distance_expr
+      return @distance
+    end
+
+    # Returns distance_unit
+    def distance_unit_expr
+      return @distance_unit
+    end
+
+    # Sets distance and distance_unit
+    def distance distance, distance_unit= nil
+      @distance = distance
+      @distance_unit = distance_unit.distance_unit if distance_unit.present?
+      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 writable_name
+    def writable_name_expr
+      return @writable_name
+    end
+
+    # Sets writable_name
+    def writable_name writable_name
+      @writable_name = writable_name
+      return self
+    end
+
+    # Returns validation_method
+    def validation_method_expr
+      return @validation_method
+    end
+
+    # Sets validation_method
+    def validation_method validation_method
+      @validation_method = validation_method.validation_method
+      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
+
+  end
+end

data/lib/query_builders.rb

@@ -102,4 +102,13 @@ class QueryBuilders
   def self.match_all_query
     Queries::MatchAllQueryBuilder.new
   end
+
+  # @params [String] field_name
+  #   field on which exists query to be performed
+  # @return [Queries::GeoDistanceQueryBuilder]
+  #   geo_bounding_box_query_builder object
+  def self.geo_bounding_box_query(*args)
+    Queries::GeoBoundingBoxQueryBuilder.new(*args)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: es_query_builder
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Mohib Yousuf
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,6 +129,7 @@ files:
 - lib/function_scores/weighted_score_function_builder.rb
 - lib/indexer.rb
 - lib/misc/bucket_order.rb
+- lib/misc/geo_bounding_box_point.rb
 - lib/misc/geo_point.rb
 - lib/misc/range.rb
 - lib/misc/script.rb
@@ -141,6 +142,7 @@ files:
 - lib/queries/dis_max_query_builder.rb
 - lib/queries/exists_query_builder.rb
 - lib/queries/function_score_query_builder.rb
+- lib/queries/geo_bounding_box_query_builder.rb
 - lib/queries/geo_distance_query_builder.rb
 - lib/queries/match_all_query_builder.rb
 - lib/queries/match_query_builder.rb