Merge pull request #12 from Contargo/addres-query

Add API for searching addresses via query

Author: sandra-thieme

.mvn/wrapper/maven-wrapper.properties

@@ -1 +1 @@
-distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.3.9/apache-maven-3.3.9-bin.zip
+distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.2/apache-maven-3.5.2-bin.zip

src/main/java/net/contargo/iris/address/api/AddressApiController.java

@@ -39,6 +39,8 @@
 
 import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
 
+import static org.springframework.web.bind.annotation.RequestMethod.GET;
+
 import static java.util.Collections.singletonList;
 
 
@@ -49,12 +51,14 @@
  * @author  Aljona Murygina - murygina@synyx.de
  * @author  Arnold Franke - franke@synyx.de
  * @author  Tobias Schneider - schneider@synyx.de
+ * @author  Sandra Thieme - thieme@synyx.de
+ * @author  Ben Antony - antony@synyx.de
  */
 @Controller
 @Api(description = "API for querying addresses.", value = "")
 public class AddressApiController {
 
-    public static final String METHOD_ADDRESS_BY_GEOLOCATION = "addressByGeolocation";
+    private static final String METHOD_ADDRESS_BY_GEOLOCATION = "addressByGeolocation";
     private static final Logger LOG = getLogger(MethodHandles.lookup().lookupClass());
 
     private final AddressDtoService addressDtoService;
@@ -188,4 +192,16 @@ public List<AddressDto> addressesWherePlaceIsIn(
 
         return addressDtoService.getAddressesWherePlaceIsIn(placeId);
     }
+
+
+    @ApiOperation(
+        value = "Returns a list of matching addresses.",
+        notes = "Can be static addresses or nominatim resolved addresses."
+    )
+    @ModelAttribute("addresses")
+    @RequestMapping(value = "/addresses", method = GET, params = { "query" })
+    public List<AddressDto> getAddresses(@RequestParam("query") String query) {
+
+        return addressDtoService.getAddressesByQuery(query);
+    }
 }

src/main/java/net/contargo/iris/address/dto/AddressDtoService.java

@@ -46,8 +46,8 @@ public interface AddressDtoService {
 
     /**
      * Resolves an address (described by the given parameters) to a {@link java.util.List} of
-     * {@link net.contargo.iris.address.Address} objects with the attributes name, latitude and longitude. Uses multiple
-     * fallback strategies to find addresses if not all parameters are provided
+     * {@link net.contargo.iris.address.Address} objects with the attributes name, latitude and longitude. Uses
+     * multiple fallback strategies to find addresses if not all parameters are provided
      *
      * @param  addressDetails  The parameters describing the addresses we are looking for
      *
@@ -58,8 +58,8 @@ public interface AddressDtoService {
 
     /**
      * Resolves an address (described by the given parameters) to a {@link java.util.List} of
-     * {@link net.contargo.iris.address.Address} objects with the attributes name, latitude and longitude. Uses multiple
-     * fallback strategies to find addresses if not all parameters are provided
+     * {@link net.contargo.iris.address.Address} objects with the attributes name, latitude and longitude. Uses
+     * multiple fallback strategies to find addresses if not all parameters are provided
      *
      * @param  addressDetails  The parameters describing the addresses we are looking for
      *
@@ -86,4 +86,14 @@ public interface AddressDtoService {
      * @return  the {@link AddressDto} with the given hashKey
      */
     AddressDto getAddressesByHashKey(String hashKey);
+
+
+    /**
+     * Returns a list of addresses matching the query.
+     *
+     * @param  query  the address query
+     *
+     * @return  a list of matching addresses
+     */
+    List<AddressDto> getAddressesByQuery(String query);
 }

src/main/java/net/contargo/iris/address/dto/AddressDtoServiceImpl.java

@@ -8,9 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
-import java.util.stream.Collectors;
 
 import static java.util.Collections.singletonList;
+import static java.util.stream.Collectors.toList;
 
 
 /**
@@ -64,7 +64,7 @@ public List<AddressListDto> getAddressesByDetails(Map<String, String> addressDet
         return addressServiceWrapper.getAddressesByDetails(addressDetails)
             .stream()
             .map(AddressListDto::new)
-            .collect(Collectors.toList());
+            .collect(toList());
     }
 
 
@@ -85,10 +85,7 @@ public List<AddressDto> getAddressesByDetailsPlain(Map<String, String> addressDe
     @Override
     public List<AddressDto> getAddressesWherePlaceIsIn(Long placeId) {
 
-        return addressService.getAddressesWherePlaceIsIn(placeId)
-            .stream()
-            .map(AddressDto::new)
-            .collect(Collectors.toList());
+        return addressService.getAddressesWherePlaceIsIn(placeId).stream().map(AddressDto::new).collect(toList());
     }
 
 
@@ -97,4 +94,11 @@ public AddressDto getAddressesByHashKey(String hashKey) {
 
         return new AddressDto(addressServiceWrapper.getByHashKey(hashKey));
     }
+
+
+    @Override
+    public List<AddressDto> getAddressesByQuery(String query) {
+
+        return addressServiceWrapper.getAddressesByQuery(query).stream().map(AddressDto::new).collect(toList());
+    }
 }

src/main/java/net/contargo/iris/address/nominatim/service/AddressService.java

@@ -14,13 +14,15 @@
  * @author  Sven Mueller - mueller@synyx.de
  * @author  Aljona Murygina - murygina@synyx.de
  * @author  Arnold Franke - franke@synyx.de
+ * @author  Sandra Thieme - thieme@synyx.de
+ * @author  Ben Antony - antony@synyx.de
  */
 public interface AddressService {
 
     /**
      * Resolves an address (described by the given parameters) to a {@link java.util.List} of
-     * {@link net.contargo.iris.address.Address} objects with the attributes name, latitude and longitude. Uses multiple
-     * fallback strategies to find addresses if not all parameters are provided
+     * {@link net.contargo.iris.address.Address} objects with the attributes name, latitude and longitude. Uses
+     * multiple fallback strategies to find addresses if not all parameters are provided
      *
      * @param  addressDetails  @return
      */
@@ -51,4 +53,14 @@ public interface AddressService {
      * @return  The address for the given geolocation.
      */
     Address getAddressByGeolocation(GeoLocation location);
+
+
+    /**
+     * Returns a list of addresses matching the query.
+     *
+     * @param  query  the address query
+     *
+     * @return  a list of matching addresses
+     */
+    List<Address> getAddressesByQuery(String query);
 }

src/main/java/net/contargo/iris/address/nominatim/service/NominatimAddressService.java

@@ -120,6 +120,15 @@ public Address getAddressByGeolocation(GeoLocation geoLocation) {
     }
 
 
+    @Override
+    public List<Address> getAddressesByQuery(String query) {
+
+        String url = nominatimUrlBuilder.buildSearchUrl(query);
+
+        return nominatimResponder.getAddresses(url);
+    }
+
+
     private List<Address> searchSuburbsViaNominatimsDetailPage(Long osmPlaceId, SuburbType suburbType,
         Set<String> suburbGlobalDisplayNames) {
 
@@ -190,7 +199,7 @@ public List<Address> getAddressesByDetails(Map<String, String> addressDetails) {
     }
 
 
-    private String[][] createResolvingStrategies(String postalCode, String city, String country, String name,
+    private static String[][] createResolvingStrategies(String postalCode, String city, String country, String name,
         String internStreet) {
 
         return new String[][] {

src/main/java/net/contargo/iris/address/nominatim/service/NominatimUrlBuilder.java

@@ -174,4 +174,10 @@ String buildUrl(GeoLocation geoLocation) {
 
         return url;
     }
+
+
+    public String buildSearchUrl(String query) {
+
+        return baseUrl + "search/" + query + "?format=json&addressdetails=1";
+    }
 }

src/main/java/net/contargo/iris/address/service/AddressServiceWrapper.java

@@ -5,6 +5,7 @@
 import net.contargo.iris.address.AddressList;
 import net.contargo.iris.address.nominatim.service.AddressService;
 import net.contargo.iris.address.staticsearch.StaticAddress;
+import net.contargo.iris.address.staticsearch.service.StaticAddressNotFoundException;
 import net.contargo.iris.address.staticsearch.service.StaticAddressService;
 import net.contargo.iris.normalizer.NormalizerService;
 
@@ -14,16 +15,19 @@
 import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.regex.Pattern;
 
 import static net.contargo.iris.address.nominatim.service.AddressDetailKey.CITY;
 import static net.contargo.iris.address.nominatim.service.AddressDetailKey.COUNTRY;
 import static net.contargo.iris.address.nominatim.service.AddressDetailKey.POSTAL_CODE;
 import static net.contargo.iris.address.nominatim.service.AddressDetailKey.STREET;
 
 import static java.util.Collections.singletonList;
+import static java.util.stream.Collectors.toList;
 
 
 /**
@@ -36,6 +40,7 @@
 public class AddressServiceWrapper {
 
     private static final Logger LOG = LoggerFactory.getLogger(AddressServiceWrapper.class);
+    private static final Pattern HASHKEY_MATCHER = Pattern.compile("^[A-Z0-9]{5}$");
 
     private final AddressService addressService;
     private final StaticAddressService staticAddressService;
@@ -175,7 +180,7 @@ private List<AddressList> resolveByNominatim(Map<String, String> addressDetails)
     }
 
 
-    private List<AddressList> getSimpleAddressList(List<Address> addresses) {
+    private static List<AddressList> getSimpleAddressList(List<Address> addresses) {
 
         List<AddressList> addressListList = new ArrayList<>();
 
@@ -189,4 +194,35 @@ private List<AddressList> getSimpleAddressList(List<Address> addresses) {
 
         return addressListList;
     }
+
+
+    @SuppressWarnings("squid:S1166")
+    public List<Address> getAddressesByQuery(String query) {
+
+        List<Address> addresses = new ArrayList<>();
+
+        if (HASHKEY_MATCHER.matcher(query).matches()) {
+            try {
+                addresses.add(getByHashKey(query));
+            } catch (StaticAddressNotFoundException e) {
+                // ignoring the exception as the query could be resolved by nominatim
+            }
+        }
+
+        if (addresses.isEmpty()) {
+            addresses.addAll(addressService.getAddressesByQuery(query));
+
+            List<Address> matchingStaticAddresses = addresses.stream()
+                    .map(a ->
+                                staticAddressService.findAddresses(a.getPostcode(), a.getCity(), a.getCountryCode())
+                                .getAddresses())
+                    .flatMap(Collection::stream)
+                    .distinct()
+                    .collect(toList());
+
+            addresses.addAll(matchingStaticAddresses);
+        }
+
+        return addresses;
+    }
 }

src/test/java/net/contargo/iris/address/api/AddressApiControllerMvcUnitTest.java

@@ -58,6 +58,8 @@
  * MVC Unit test of {@link AddressApiController}.
  *
  * @author  Arnold Franke - franke@synyx.de
+ * @author  Sandra Thieme - thieme@synyx.de
+ * @author  Ben Antony - antony@synyx.de
  */
 @RunWith(SpringJUnit4ClassRunner.class)
 @ContextConfiguration(locations = { "classpath:public-api-context.xml" })
@@ -209,4 +211,20 @@ public void testAddressByPlaceId() throws Exception {
             .andExpect(content().contentType("application/json"))
             .andExpect(jsonPath("$.addresses[0].displayName", is("76137 Karlsruhe")));
     }
+
+
+    @Test
+    public void getAddresses() throws Exception {
+
+        Address address = new Address();
+        address.setDisplayName("Gartenstr. 67, Karlsruhe (Südweststadt)");
+
+        when(addressDtoServiceMock.getAddressesByQuery("Gartenstraße 67, Karlsruhe")).thenReturn(singletonList(
+                new AddressDto(address)));
+
+        mockMvc.perform(get("/addresses").param("query", "Gartenstraße 67, Karlsruhe"))
+            .andExpect(status().isOk())
+            .andExpect(jsonPath("$.addresses", hasSize(1)))
+            .andExpect(jsonPath("$.addresses[0].displayName", is("Gartenstr. 67, Karlsruhe (Südweststadt)")));
+    }
 }

src/test/java/net/contargo/iris/address/dto/AddressDtoServiceImplUnitTest.java

@@ -23,6 +23,7 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 
+import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.nullValue;
 
@@ -45,16 +46,17 @@ public class AddressDtoServiceImplUnitTest {
     private static final int OSM_ID = 1;
     private static final GeoLocation GEOLOCATION = new GeoLocation(BigDecimal.ONE, BigDecimal.ONE);
     private static final Long PLACE_ID = 1L;
+
     private final AddressService addressServiceMock = mock(AddressService.class);
     private final AddressServiceWrapper addressServiceWrapperMock = mock(AddressServiceWrapper.class);
     private final AddressDtoServiceImpl sut = new AddressDtoServiceImpl(addressServiceMock, addressServiceWrapperMock);
-    Address address = new Address(BigDecimal.ONE, BigDecimal.ONE);
-    private Map<String, String> addressDetails;
+
+    private final Address address = new Address(BigDecimal.ONE, BigDecimal.ONE);
+    private final Map<String, String> addressDetails = new HashMap<>();
 
     @Before
-    public void setUp() throws Exception {
+    public void setUp() {
 
-        addressDetails = new HashMap<>();
         addressDetails.put(CITY.getKey(), "city");
         addressDetails.put(STREET.getKey(), "street");
         addressDetails.put(POSTAL_CODE.getKey(), "postalcode");
@@ -175,4 +177,19 @@ public void getAddressesByHashKey() {
         AddressDto addressDto = sut.getAddressesByHashKey(hashKey);
         assertThat(addressDto.getDisplayName(), is(displayName));
     }
+
+
+    @Test
+    public void getAddressesByQuery() {
+
+        address.setDisplayName("Gartenstr. 67, Karlsruhe (Südweststadt)");
+
+        when(addressServiceWrapperMock.getAddressesByQuery("Gartenstraße 67, Karlsruhe")).thenReturn(singletonList(
+                address));
+
+        List<AddressDto> addresses = sut.getAddressesByQuery("Gartenstraße 67, Karlsruhe");
+
+        assertThat(addresses, hasSize(1));
+        assertThat(addresses.get(0).getDisplayName(), is("Gartenstr. 67, Karlsruhe (Südweststadt)"));
+    }
 }