#256 - Add examples for Redis Geo API.

redis/example/src/test/java/example/springdata/redis/commands/GeoOperationsTests.java

@@ -0,0 +1,116 @@
+/*
+ * Copyright 2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example.springdata.redis.commands;
+
+import static org.assertj.core.api.Assertions.*;
+
+import example.springdata.redis.test.util.RequiresRedisServer;
+
+import java.util.List;
+
+import org.junit.Before;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.data.geo.Circle;
+import org.springframework.data.geo.Distance;
+import org.springframework.data.geo.GeoResults;
+import org.springframework.data.geo.Point;
+import org.springframework.data.redis.connection.RedisGeoCommands.DistanceUnit;
+import org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation;
+import org.springframework.data.redis.core.GeoOperations;
+import org.springframework.data.redis.core.RedisOperations;
+import org.springframework.test.context.junit4.SpringRunner;
+
+/**
+ * Show usage of redis geo-index operations using Template API provided by {@link GeoOperations}.
+ *
+ * @author Mark Paluch
+ */
+@RunWith(SpringRunner.class)
+@SpringBootApplication
+public class GeoOperationsTests {
+
+	// we only want to run this tests when redis is up an running
+	public static @ClassRule RequiresRedisServer requiresServer = RequiresRedisServer.onLocalhost();
+
+	@Autowired RedisOperations<String, String> operations;
+	GeoOperations<String, String> geoOperations;
+
+	@Before
+	public void before() {
+
+		geoOperations = operations.opsForGeo();
+
+		geoOperations.geoAdd("Sicily", new Point(13.361389, 38.115556), "Arigento");
+		geoOperations.geoAdd("Sicily", new Point(15.087269, 37.502669), "Catania");
+		geoOperations.geoAdd("Sicily", new Point(13.583333, 37.316667), "Palermo");
+	}
+
+	/**
+	 * Look up points using a geo-index member as reference.
+	 */
+	@Test
+	public void geoRadiusByMember() {
+
+		GeoResults<GeoLocation<String>> byDistance = geoOperations.geoRadiusByMember("Sicily", "Palermo",
+				new Distance(100, DistanceUnit.KILOMETERS));
+
+		assertThat(byDistance).hasSize(2).extracting("content.name").contains("Arigento", "Palermo");
+
+		GeoResults<GeoLocation<String>> greaterDistance = geoOperations.geoRadiusByMember("Sicily", "Palermo",
+				new Distance(200, DistanceUnit.KILOMETERS));
+
+		assertThat(greaterDistance).hasSize(3).extracting("content.name").contains("Arigento", "Catania", "Palermo");
+	}
+
+	/**
+	 * Lookup points within a circle around coordinates.
+	 */
+	@Test
+	public void geoRadius() {
+
+		Circle circle = new Circle(new Point(13.583333, 37.316667), //
+				new Distance(100, DistanceUnit.KILOMETERS));
+		GeoResults<GeoLocation<String>> result = geoOperations.geoRadius("Sicily", circle);
+
+		assertThat(result).hasSize(2).extracting("content.name").contains("Arigento", "Palermo");
+	}
+
+	/**
+	 * Calculate the distance between two geo-index members.
+	 */
+	@Test
+	public void geoDistance() {
+
+		Distance distance = geoOperations.geoDist("Sicily", "Catania", "Palermo", DistanceUnit.KILOMETERS);
+
+		assertThat(distance.getValue()).isBetween(130d, 140d);
+	}
+
+	/**
+	 * Return the geo-hash.
+	 */
+	@Test
+	public void geoHash() {
+
+		List<String> geohashes = geoOperations.geoHash("Sicily", "Catania", "Palermo");
+
+		assertThat(geohashes).hasSize(2).contains("sqdtr74hyu0", "sq9sm1716e0");
+	}
+}