Skip to content

Commit af811fa

Browse files
DzmitryFomchynDzmitryFomchyn
authored
Add category IDs properties. Bump dependencies and SDK version name (#327)
* Add category IDs properties. Bump dependencies and SDK version name * Address review comments
1 parent 455f8e3 commit af811fa

File tree

13 files changed

+87
-33
lines changed

13 files changed

+87
-33
lines changed

‎CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Changelog for the Mapbox Search SDK for Android
22

3+
## 2.12.0-beta.1
4+
5+
⚠️ Minor version has been aligned with other Mapbox SDK offerings. Search SDK v2.12.0 is a successor to v2.9.0. Versions 2.10 and 2.11 of the Search SDK do not exist.
6+
7+
### New features
8+
- Added new properties `SearchSuggestion.categoryIds` and `SearchResult.categoryIds` that return canonical POI category IDs.
9+
10+
### Mapbox dependencies
11+
- Search Native SDK `2.12.0-beta.1`
12+
- Common SDK `24.12.0-beta.1`
13+
14+
15+
316
## 2.9.0
417

518
### New features

‎MapboxSearch/base/src/main/java/com/mapbox/search/base/result/BaseSearchResult.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ abstract class BaseSearchResult(
4848
open val categories: List<String>?
4949
get() = rawSearchResult.categories
5050

51+
open val categoryIds: List<String>?
52+
get() = rawSearchResult.categoryIds
53+
5154
open val makiIcon: String?
5255
get() = rawSearchResult.icon
5356

‎MapboxSearch/base/src/main/java/com/mapbox/search/base/result/BaseSearchSuggestion.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ sealed class BaseSearchSuggestion(
4545
open val categories: List<String>?
4646
get() = rawSearchResult.categories
4747

48+
open val categoryIds: List<String>?
49+
get() = rawSearchResult.categoryIds
50+
4851
open val makiIcon: String?
4952
get() = rawSearchResult.icon
5053

‎MapboxSearch/gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ android.enableJetifier=false
2121
kotlin.code.style=official
2222

2323
# SDK version attributes
24-
VERSION_NAME=2.9.0
24+
VERSION_NAME=2.12.0-beta.1
2525

2626
# Artifact attributes
2727
mapboxArtifactUserOrg=mapbox

‎MapboxSearch/gradle/versions.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ ext {
4141

4242
pitest_version = '1.6.7'
4343

44-
mapbox_maps_version = '11.11.0'
44+
mapbox_maps_version = '11.12.0-beta.1'
4545
mapbox_turf_version = '6.15.0'
4646

47-
common_sdk_version = '24.11.0'
47+
common_sdk_version = '24.12.0-beta.1'
4848
mapbox_base_version = '0.8.0'
4949

50-
search_native_version = '2.9.0'
50+
search_native_version = '2.12.0-beta.1'
5151

5252
detekt_version = '1.19.0'
5353

‎MapboxSearch/sdk/api/api-metalava.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1003,6 +1003,7 @@ package com.mapbox.search.result {
10031003
method public com.mapbox.search.result.SearchAddress? getAddress();
10041004
method public com.mapbox.geojson.BoundingBox? getBoundingBox();
10051005
method public java.util.List<java.lang.String>? getCategories();
1006+
method public java.util.List<java.lang.String>? getCategoryIds();
10061007
method public com.mapbox.geojson.Point getCoordinate();
10071008
method public String? getDescriptionText();
10081009
method public Double? getDistanceMeters();
@@ -1024,6 +1025,7 @@ package com.mapbox.search.result {
10241025
property public final com.mapbox.search.result.SearchAddress? address;
10251026
property public final com.mapbox.geojson.BoundingBox? boundingBox;
10261027
property public final java.util.List<java.lang.String>? categories;
1028+
property public final java.util.List<java.lang.String>? categoryIds;
10271029
property public final com.mapbox.geojson.Point coordinate;
10281030
property public final String? descriptionText;
10291031
property public final Double? distanceMeters;
@@ -1063,6 +1065,7 @@ package com.mapbox.search.result {
10631065
@kotlinx.parcelize.Parcelize public final class SearchSuggestion implements android.os.Parcelable {
10641066
method public com.mapbox.search.result.SearchAddress? getAddress();
10651067
method public java.util.List<java.lang.String>? getCategories();
1068+
method public java.util.List<java.lang.String>? getCategoryIds();
10661069
method public com.mapbox.geojson.Point? getCoordinate();
10671070
method public String? getDescriptionText();
10681071
method public Double? getDistanceMeters();
@@ -1082,6 +1085,7 @@ package com.mapbox.search.result {
10821085
method public boolean isBatchResolveSupported();
10831086
property public final com.mapbox.search.result.SearchAddress? address;
10841087
property public final java.util.List<java.lang.String>? categories;
1088+
property public final java.util.List<java.lang.String>? categoryIds;
10851089
property public final com.mapbox.geojson.Point? coordinate;
10861090
property public final String? descriptionText;
10871091
property public final Double? distanceMeters;

‎MapboxSearch/sdk/api/sdk.api

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,6 +1292,7 @@ public final class com/mapbox/search/result/SearchResult : android/os/Parcelable
12921292
public final fun getAddress ()Lcom/mapbox/search/result/SearchAddress;
12931293
public final fun getBoundingBox ()Lcom/mapbox/geojson/BoundingBox;
12941294
public final fun getCategories ()Ljava/util/List;
1295+
public final fun getCategoryIds ()Ljava/util/List;
12951296
public final fun getCoordinate ()Lcom/mapbox/geojson/Point;
12961297
public final fun getDescriptionText ()Ljava/lang/String;
12971298
public final fun getDistanceMeters ()Ljava/lang/Double;
@@ -1344,6 +1345,7 @@ public final class com/mapbox/search/result/SearchSuggestion : android/os/Parcel
13441345
public fun equals (Ljava/lang/Object;)Z
13451346
public final fun getAddress ()Lcom/mapbox/search/result/SearchAddress;
13461347
public final fun getCategories ()Ljava/util/List;
1348+
public final fun getCategoryIds ()Ljava/util/List;
13471349
public final fun getCoordinate ()Lcom/mapbox/geojson/Point;
13481350
public final fun getDescriptionText ()Ljava/lang/String;
13491351
public final fun getDistanceMeters ()Ljava/lang/Double;

‎MapboxSearch/sdk/src/androidTest/java/com/mapbox/search/CategorySearchIntegrationTest.kt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ import org.junit.Assert.assertNotEquals
5454
import org.junit.Assert.assertNotNull
5555
import org.junit.Assert.assertTrue
5656
import org.junit.Before
57+
import org.junit.Ignore
5758
import org.junit.Test
5859
import java.io.IOException
5960
import java.util.Locale
@@ -189,7 +190,8 @@ internal class CategorySearchIntegrationTest : BaseTest() {
189190
names = listOf("Starbucks"),
190191
languages = listOf("def"), // should it be "en"?
191192
categories = listOf("restaurant", "food", "food and drink", "coffee shop", "coffee", "cafe"),
192-
categoryIds = listOf("restaurant", "food", "food_and_drink", "coffee_shop", "coffee", "cafe"),
193+
// TODO should be fixed on Search Native side
194+
// categoryIds = listOf("restaurant", "food", "food_and_drink", "coffee_shop", "coffee", "cafe"),
193195
brand = listOf("Starbucks"),
194196
brandId = "starbucks",
195197
addresses = listOf(
@@ -505,6 +507,7 @@ internal class CategorySearchIntegrationTest : BaseTest() {
505507
}
506508
}
507509

510+
@Ignore("TODO fix on Search Native side")
508511
@Test
509512
fun testConsecutiveRequests() {
510513
mockServer.enqueueMultiple(createSuccessfulResponse("sbs_responses/category/successful_incorrect_response.json"), 2)

‎MapboxSearch/sdk/src/androidTest/java/com/mapbox/search/SearchEngineIntegrationTest.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -708,6 +708,7 @@ internal class SearchEngineIntegrationTest : BaseTest() {
708708
baseRawSearchResult,
709709
TEST_REQUEST_OPTIONS.run {
710710
copy(
711+
endpoint = "retrieve",
711712
options = options,
712713
requestContext = requestContext.copy(
713714
responseUuid = "0a197057-edf0-4447-be63-9badcf7c19be"
@@ -966,6 +967,7 @@ internal class SearchEngineIntegrationTest : BaseTest() {
966967
baseRawSearchResult,
967968
TEST_REQUEST_OPTIONS.run {
968969
copy(
970+
endpoint = "retrieve",
969971
options = options.copy(
970972
types = listOf(QueryType.CATEGORY)
971973
),

‎MapboxSearch/sdk/src/androidTest/java/com/mapbox/search/search_box/CategorySearchIntegrationTest.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ import org.junit.Assert.assertNotEquals
5454
import org.junit.Assert.assertNotNull
5555
import org.junit.Assert.assertTrue
5656
import org.junit.Before
57+
import org.junit.Ignore
5758
import org.junit.Test
5859
import java.io.IOException
5960
import java.util.Locale
@@ -431,6 +432,7 @@ internal class CategorySearchIntegrationTest : BaseTest() {
431432
}
432433
}
433434

435+
@Ignore("TODO fix on Search Native side")
434436
@Test
435437
fun testConsecutiveRequests() {
436438
mockServer.enqueueMultiple(createSuccessfulResponse("search_box_responses/category/successful_incorrect_response.json"), 2)

‎MapboxSearch/sdk/src/androidTest/java/com/mapbox/search/search_box/SearchEngineIntegrationTest.kt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ import com.mapbox.search.common.tests.equalsTo
5252
import com.mapbox.search.record.FavoritesDataProvider
5353
import com.mapbox.search.record.HistoryDataProvider
5454
import com.mapbox.search.record.IndexableRecord
55+
import com.mapbox.search.result.ResultAccuracy
5556
import com.mapbox.search.result.SearchAddress
5657
import com.mapbox.search.result.SearchResult
5758
import com.mapbox.search.result.SearchResultType
@@ -256,6 +257,7 @@ internal class SearchEngineIntegrationTest : BaseTest() {
256257
)
257258
assertEquals(900.0, suggestion.distanceMeters)
258259
assertEquals(listOf("gym", "services"), suggestion.categories)
260+
assertEquals(listOf("fitness_center", "services"), suggestion.categoryIds)
259261
assertEquals("marker", suggestion.makiIcon)
260262
assertEquals(null, suggestion.etaMinutes)
261263
assertEquals(null, suggestion.metadata)
@@ -637,8 +639,7 @@ internal class SearchEngineIntegrationTest : BaseTest() {
637639
"1211 Connecticut Ave NW, Washington, District of Columbia 20036, United States of America",
638640
searchResult.fullAddress
639641
)
640-
// TODO fixme Search Native should parse accuracy
641-
// assertEquals(ResultAccuracy.APPROXIMATE, searchResult.accuracy)
642+
assertEquals(ResultAccuracy.Proximate, searchResult.accuracy)
642643
assertEquals(
643644
SearchAddress(
644645
country = "United States of America",
@@ -667,6 +668,7 @@ internal class SearchEngineIntegrationTest : BaseTest() {
667668
assertEquals(Point.fromLngLat(-77.041093, 38.906197), searchResult.coordinate)
668669
assertEquals("marker", searchResult.makiIcon)
669670
assertEquals(listOf("gym", "services"), searchResult.categories)
671+
assertEquals(listOf("fitness_center", "services"), searchResult.categoryIds)
670672
assertEquals(null, searchResult.etaMinutes)
671673
assertEquals(null, searchResult.indexableRecord)
672674
assertEquals(900.0, searchResult.distanceMeters)

‎MapboxSearch/sdk/src/main/java/com/mapbox/search/result/SearchResult.kt

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,19 @@ public class SearchResult internal constructor(
8484
public val boundingBox: BoundingBox? = base.bbox
8585

8686
/**
87-
* Poi categories. Always empty for non-POI search results.
87+
* POI categories. Always empty for non-POI search results.
8888
* @see types
8989
*/
9090
@IgnoredOnParcel
9191
public val categories: List<String>? = base.categories
9292

93+
/**
94+
* Canonical POI category IDs. Always empty for non-POI suggestions.
95+
* @see types
96+
*/
97+
@IgnoredOnParcel
98+
public val categoryIds: List<String>? = base.categoryIds
99+
93100
/**
94101
* [Maki](https://github.com/mapbox/maki/) icon name for search result.
95102
*/
@@ -177,6 +184,7 @@ public class SearchResult internal constructor(
177184
if (routablePoints != other.routablePoints) return false
178185
if (boundingBox != other.boundingBox) return false
179186
if (categories != other.categories) return false
187+
if (categoryIds != other.categoryIds) return false
180188
if (makiIcon != other.makiIcon) return false
181189
if (coordinate != other.coordinate) return false
182190
if (accuracy != other.accuracy) return false
@@ -199,23 +207,24 @@ public class SearchResult internal constructor(
199207
result = 31 * result + id.hashCode()
200208
result = 31 * result + mapboxId.hashCode()
201209
result = 31 * result + name.hashCode()
202-
result = 31 * result + (matchingName?.hashCode() ?: 0)
203-
result = 31 * result + (descriptionText?.hashCode() ?: 0)
204-
result = 31 * result + (address?.hashCode() ?: 0)
205-
result = 31 * result + (fullAddress?.hashCode() ?: 0)
206-
result = 31 * result + (routablePoints?.hashCode() ?: 0)
207-
result = 31 * result + (boundingBox?.hashCode() ?: 0)
208-
result = 31 * result + (categories?.hashCode() ?: 0)
209-
result = 31 * result + (makiIcon?.hashCode() ?: 0)
210+
result = 31 * result + matchingName.hashCode()
211+
result = 31 * result + descriptionText.hashCode()
212+
result = 31 * result + address.hashCode()
213+
result = 31 * result + fullAddress.hashCode()
214+
result = 31 * result + routablePoints.hashCode()
215+
result = 31 * result + boundingBox.hashCode()
216+
result = 31 * result + categories.hashCode()
217+
result = 31 * result + categoryIds.hashCode()
218+
result = 31 * result + makiIcon.hashCode()
210219
result = 31 * result + coordinate.hashCode()
211-
result = 31 * result + (accuracy?.hashCode() ?: 0)
220+
result = 31 * result + accuracy.hashCode()
212221
result = 31 * result + types.hashCode()
213-
result = 31 * result + (etaMinutes?.hashCode() ?: 0)
214-
result = 31 * result + (metadata?.hashCode() ?: 0)
222+
result = 31 * result + etaMinutes.hashCode()
223+
result = 31 * result + metadata.hashCode()
215224
result = 31 * result + externalIDs.hashCode()
216-
result = 31 * result + (distanceMeters?.hashCode() ?: 0)
225+
result = 31 * result + distanceMeters.hashCode()
217226
result = 31 * result + (serverIndex ?: 0)
218-
result = 31 * result + (indexableRecord?.hashCode() ?: 0)
227+
result = 31 * result + indexableRecord.hashCode()
219228
return result
220229
}
221230

@@ -235,6 +244,7 @@ public class SearchResult internal constructor(
235244
"routablePoints=$routablePoints, " +
236245
"boundingBox=$boundingBox, " +
237246
"categories=$categories, " +
247+
"categoryIds=$categoryIds, " +
238248
"makiIcon=$makiIcon, " +
239249
"coordinate=$coordinate, " +
240250
"accuracy=$accuracy, " +

‎MapboxSearch/sdk/src/main/java/com/mapbox/search/result/SearchSuggestion.kt

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,19 @@ public class SearchSuggestion internal constructor(
112112
public val distanceMeters: Double? = base.distanceMeters
113113

114114
/**
115-
* Poi categories. Always empty for non-POI suggestions.
115+
* POI categories. Always empty for non-POI suggestions.
116116
* @see type
117117
*/
118118
@IgnoredOnParcel
119119
public val categories: List<String>? = base.categories
120120

121+
/**
122+
* Canonical POI category IDs. Always empty for non-POI suggestions.
123+
* @see type
124+
*/
125+
@IgnoredOnParcel
126+
public val categoryIds: List<String>? = base.categoryIds
127+
121128
/**
122129
* [Maki](https://github.com/mapbox/maki/) icon name for search suggestion.
123130
*/
@@ -181,6 +188,7 @@ public class SearchSuggestion internal constructor(
181188
if (requestOptions != other.requestOptions) return false
182189
if (!distanceMeters.safeCompareTo(other.distanceMeters)) return false
183190
if (categories != other.categories) return false
191+
if (categoryIds != other.categoryIds) return false
184192
if (makiIcon != other.makiIcon) return false
185193
if (!etaMinutes.safeCompareTo(other.etaMinutes)) return false
186194
if (metadata != other.metadata) return false
@@ -198,18 +206,19 @@ public class SearchSuggestion internal constructor(
198206
var result = id.hashCode()
199207
result = 31 * result + name.hashCode()
200208
result = 31 * result + namePreferred.hashCode()
201-
result = 31 * result + (coordinate?.hashCode() ?: 0)
202-
result = 31 * result + (routablePoints?.hashCode() ?: 0)
203-
result = 31 * result + (matchingName?.hashCode() ?: 0)
204-
result = 31 * result + (descriptionText?.hashCode() ?: 0)
205-
result = 31 * result + (address?.hashCode() ?: 0)
206-
result = 31 * result + (fullAddress?.hashCode() ?: 0)
209+
result = 31 * result + coordinate.hashCode()
210+
result = 31 * result + routablePoints.hashCode()
211+
result = 31 * result + matchingName.hashCode()
212+
result = 31 * result + descriptionText.hashCode()
213+
result = 31 * result + address.hashCode()
214+
result = 31 * result + fullAddress.hashCode()
207215
result = 31 * result + requestOptions.hashCode()
208-
result = 31 * result + (distanceMeters?.hashCode() ?: 0)
209-
result = 31 * result + (categories?.hashCode() ?: 0)
210-
result = 31 * result + (makiIcon?.hashCode() ?: 0)
211-
result = 31 * result + (etaMinutes?.hashCode() ?: 0)
212-
result = 31 * result + (metadata?.hashCode() ?: 0)
216+
result = 31 * result + distanceMeters.hashCode()
217+
result = 31 * result + categories.hashCode()
218+
result = 31 * result + categoryIds.hashCode()
219+
result = 31 * result + makiIcon.hashCode()
220+
result = 31 * result + etaMinutes.hashCode()
221+
result = 31 * result + metadata.hashCode()
213222
result = 31 * result + externalIDs.hashCode()
214223
result = 31 * result + isBatchResolveSupported.hashCode()
215224
result = 31 * result + (serverIndex ?: 0)
@@ -233,6 +242,7 @@ public class SearchSuggestion internal constructor(
233242
"requestOptions=$requestOptions, " +
234243
"distanceMeters=$distanceMeters, " +
235244
"categories=$categories, " +
245+
"categoryIds=$categoryIds, " +
236246
"makiIcon=$makiIcon, " +
237247
"etaMinutes=$etaMinutes, " +
238248
"metadata=$metadata, " +

0 commit comments

Comments
 (0)