Implement Geo Shape Query

.travis.yml

@@ -26,6 +26,7 @@ before_install:
 - docker-compose up -d
 - go get -u github.com/google/go-cmp/cmp
 - go get -u github.com/fortytw2/leaktest
+- go get -u github.com/stretchr/testify/require
 - go get . ./aws/... ./config/... ./trace/... ./uritemplates/...
 - while ! nc -z localhost 9200; do sleep 1; done
 - while ! nc -z localhost 9210; do sleep 1; done

README.md

@@ -334,7 +334,7 @@ The cat APIs are not implemented as of now. We think they are better suited for
   - [x] Has Parent Query
   - [x] Parent Id Query
 - Geo queries
-  - [ ] GeoShape Query
+  - [x] GeoShape Query
   - [x] Geo Bounding Box Query
   - [x] Geo Distance Query
   - [x] Geo Polygon Query

geo/circle.go

@@ -0,0 +1,37 @@
+package geo
+
+import (
+	"encoding/json"
+)
+
+// Circle specified by a center point and radius with units,
+// which default to meters.
+type Circle struct {
+	Type        string    `json:"type"`
+	Radius      string    `json:"radius"`
+	Coordinates []float64 `json:"coordinates"`
+}
+
+// NewCircle creates and initializes a new Circle.
+func NewCircle(radius string, coordinates []float64) *Circle {
+	return &Circle{
+		Type:        TypeCircle,
+		Radius:      radius,
+		Coordinates: coordinates,
+	}
+}
+
+// UnmarshalJSON decodes the circle data into a GeoJSON geometry.
+func (m *Circle) UnmarshalJSON(data []byte) error {
+	raw := &rawGeometry{}
+	if err := json.Unmarshal(data, raw); err != nil {
+		return err
+	}
+	return m.decode(raw)
+}
+
+func (m *Circle) decode(raw *rawGeometry) error {
+	m.Type = raw.Type
+	m.Radius = raw.Radius
+	return json.Unmarshal(raw.Coordinates, &m.Coordinates)
+}

geo/envelope.go

@@ -0,0 +1,32 @@
+package geo
+
+import "encoding/json"
+
+// Envelope consists of coordinates for upper left and lower right points of the shape
+// to represent a bounding rectangle.
+type Envelope struct {
+	Type        string      `json:"type"`
+	Coordinates [][]float64 `json:"coordinates"`
+}
+
+// NewEnvelope creates and initializes a new Rectangle.
+func NewEnvelope(coordinates [][]float64) *Envelope {
+	return &Envelope{
+		Type:        TypeEnvelope,
+		Coordinates: coordinates,
+	}
+}
+
+// UnmarshalJSON decodes the envelope data into a GeoJSON geometry.
+func (m *Envelope) UnmarshalJSON(data []byte) error {
+	raw := &rawGeometry{}
+	if err := json.Unmarshal(data, raw); err != nil {
+		return err
+	}
+	return m.decode(raw)
+}
+
+func (m *Envelope) decode(raw *rawGeometry) error {
+	m.Type = raw.Type
+	return json.Unmarshal(raw.Coordinates, &m.Coordinates)
+}

geo/exampledata_test.go

@@ -0,0 +1,156 @@
+package geo
+
+// Examples from RFC7946
+// https://tools.ietf.org/html/rfc7946
+
+var point = []byte(`
+{
+  "type":"point",
+  "coordinates":[100.0, 0.0]
+}
+`)
+
+var multiPoint = []byte(`
+{
+  "type":"multipoint",
+  "coordinates":[
+    [100.0, 0.0],
+    [101.0, 1.0]
+  ]
+}
+`)
+
+var lineString = []byte(`
+{
+  "type":"linestring",
+  "coordinates":[
+    [100.0, 0.0],
+    [101.0, 1.0]
+  ]
+}
+`)
+
+var multiLineString = []byte(`
+
+{
+  "type":"multilinestring",
+  "coordinates":[
+    [
+      [100.0, 0.0],
+      [101.0, 1.0]
+    ],
+    [
+      [102.0, 2.0],
+      [103.0, 3.0]
+    ]
+  ]
+}
+`)
+
+var polygon = []byte(`
+{
+  "type":"polygon",
+  "coordinates":[
+    [
+      [100.0, 0.0],
+      [101.0, 0.0],
+      [101.0, 1.0],
+      [100.0, 1.0],
+      [100.0, 0.0]
+    ]
+  ]
+}
+`)
+
+var polygonWithHoles = []byte(`
+{
+  "type":"polygon",
+  "coordinates":[
+    [
+      [100.0, 0.0],
+      [101.0, 0.0],
+      [101.0, 1.0],
+      [100.0, 1.0],
+      [100.0, 0.0]
+    ],
+    [
+      [100.2, 0.2],
+      [100.8, 0.2],
+      [100.8, 0.8],
+      [100.2, 0.8],
+      [100.2, 0.2]
+    ]
+  ]
+}
+
+`)
+
+var multiPolygon = []byte(`
+{
+  "type":"multipolygon",
+  "coordinates":[
+    [
+      [
+        [102.0, 2.0],
+        [103.0, 2.0],
+        [103.0, 3.0],
+        [102.0, 3.0],
+        [102.0, 2.0]
+      ]
+    ],
+    [
+      [
+        [100.0, 0.0],
+        [101.0, 0.0],
+        [101.0, 1.0],
+        [100.0, 1.0],
+        [100.0, 0.0]
+      ],
+      [
+        [100.2, 0.2],
+        [100.8, 0.2],
+        [100.8, 0.8],
+        [100.2, 0.8],
+        [100.2, 0.2]
+      ]
+    ]
+  ]
+}
+`)
+
+var geometryCollection = []byte(`
+{
+  "type":"geometrycollection",
+  "geometries":[
+    {
+      "type":"point",
+      "coordinates":[100.0, 0.0]
+    },
+    {
+      "type":"linestring",
+      "coordinates":[
+        [101.0, 0.0],
+        [102.0, 1.0]
+      ]
+    }
+  ]
+}
+`)
+
+var envelope = []byte(`
+{
+  "type":"envelope",
+  "coordinates":[
+	[100.0, 1.0],
+	[101.0, 0.0]
+  ]
+}
+`)
+
+var circle = []byte(`
+{
+  "type":"circle",
+  "radius":"25m",
+  "coordinates":[-109.874838, 44.439550]
+}
+`)

geo/geometry.go

@@ -0,0 +1,29 @@
+package geo
+
+import (
+	"encoding/json"
+)
+
+// The geometry types supported by Elasticsearch.
+//
+// For more details, see:
+// https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html#spatial-strategy
+const (
+	TypePoint              = "point"
+	TypeMultiPoint         = "multipoint"
+	TypeLineString         = "linestring"
+	TypeMultiLineString    = "multilinestring"
+	TypePolygon            = "polygon"
+	TypeMultiPolygon       = "multipolygon"
+	TypeGeometryCollection = "geometrycollection"
+	TypeEnvelope           = "envelope"
+	TypeCircle             = "circle"
+)
+
+// rawGeometry holds generic data used to unmarshal GeoJSON information.
+type rawGeometry struct {
+	Type        string          `json:"type"`
+	Coordinates json.RawMessage `json:"coordinates"`
+	Geometries  []rawGeometry   `json:"geometries"`
+	Radius      string          `json:"radius,omitempty"`
+}