Merge branch 'feature/gsdk_places' into develop

Author: MrHadiSatrio

app-android-journal3/src/main/kotlin/com/hadisatrio/apps/android/journal3/Journal3Application.kt

@@ -35,6 +35,7 @@ import com.hadisatrio.libs.kotlin.foundation.event.EventSource
 import com.hadisatrio.libs.kotlin.foundation.modal.Modal
 import com.hadisatrio.libs.kotlin.foundation.presentation.Presenter
 import com.hadisatrio.libs.kotlin.geography.Coordinates
+import com.hadisatrio.libs.kotlin.geography.Place
 import com.hadisatrio.libs.kotlin.geography.Places
 import com.hadisatrio.libs.kotlin.geography.Speed
 import com.hadisatrio.libs.kotlin.paraphrase.Paraphraser
@@ -46,6 +47,7 @@ abstract class Journal3Application : Application() {
     abstract val coordinates: Coordinates
     abstract val speed: Speed
     abstract val places: Places
+    abstract val currentPlace: Place
     abstract val moments: EditableMoments
     abstract val notableMoments: Moments
     abstract val reflections: Stories

app-android-journal3/src/main/kotlin/com/hadisatrio/apps/android/journal3/RealJournal3Application.kt

@@ -58,6 +58,8 @@ import com.hadisatrio.libs.android.foundation.os.SystemLog
 import com.hadisatrio.libs.android.foundation.presentation.ExecutorDispatchingPresenter
 import com.hadisatrio.libs.android.geography.AndroidCoordinates
 import com.hadisatrio.libs.android.geography.PermissionAwareCoordinates
+import com.hadisatrio.libs.android.geography.google.GoogleSdkCurrentPlace
+import com.hadisatrio.libs.android.geography.google.GoogleSdkNearbyPlaces
 import com.hadisatrio.libs.android.io.content.ContentResolverSources
 import com.hadisatrio.libs.kotlin.foundation.Decor
 import com.hadisatrio.libs.kotlin.foundation.UseCase
@@ -70,9 +72,9 @@ import com.hadisatrio.libs.kotlin.foundation.modal.Modal
 import com.hadisatrio.libs.kotlin.foundation.presentation.PerfTrackingPresenter
 import com.hadisatrio.libs.kotlin.foundation.presentation.Presenter
 import com.hadisatrio.libs.kotlin.geography.Coordinates
+import com.hadisatrio.libs.kotlin.geography.Place
 import com.hadisatrio.libs.kotlin.geography.Places
 import com.hadisatrio.libs.kotlin.geography.Speed
-import com.hadisatrio.libs.kotlin.geography.google.GoogleNearbyPlaces
 import com.hadisatrio.libs.kotlin.io.SchemeWiseSources
 import com.hadisatrio.libs.kotlin.io.filesystem.FileSystemSources
 import com.hadisatrio.libs.kotlin.paraphrase.OpenAiParaphraser
@@ -97,11 +99,19 @@ class RealJournal3Application : Journal3Application() {
     }
 
     override val places: Places by lazy {
-        GoogleNearbyPlaces(
+        GoogleSdkNearbyPlaces(
             coordinates = coordinates,
             limit = 100,
             apiKey = BuildConfig.KEY_GOOGLE_API,
-            httpClient = HttpClient()
+            application = this
+        )
+    }
+
+    override val currentPlace: Place by lazy {
+        GoogleSdkCurrentPlace(
+            apiKey = BuildConfig.KEY_GOOGLE_API,
+            application = this,
+            clock = clock
         )
     }
 

app-android-journal3/src/main/kotlin/com/hadisatrio/apps/android/journal3/moment/MomentCapturingWork.kt

@@ -39,7 +39,7 @@ class MomentCapturingWork(
         }
         CaptureAMomentUseCase(
             moments = journal3Application.moments,
-            places = journal3Application.places,
+            currentPlace = journal3Application.currentPlace,
             speed = journal3Application.speed,
             coordinates = journal3Application.coordinates,
             clock = journal3Application.clock

app-android-journal3/src/test/kotlin/com/hadisatrio/apps/android/journal3/FakeJournal3Application.kt

@@ -41,10 +41,12 @@ import com.hadisatrio.libs.kotlin.foundation.presentation.Presenter
 import com.hadisatrio.libs.kotlin.foundation.presentation.fake.FakePresenter
 import com.hadisatrio.libs.kotlin.geography.Coordinates
 import com.hadisatrio.libs.kotlin.geography.LiteralCoordinates
+import com.hadisatrio.libs.kotlin.geography.Place
 import com.hadisatrio.libs.kotlin.geography.Places
 import com.hadisatrio.libs.kotlin.geography.SelfPopulatingPlaces
 import com.hadisatrio.libs.kotlin.geography.Speed
 import com.hadisatrio.libs.kotlin.geography.StaticSpeed
+import com.hadisatrio.libs.kotlin.geography.fake.FakePlace
 import com.hadisatrio.libs.kotlin.geography.fake.FakePlaces
 import com.hadisatrio.libs.kotlin.paraphrase.DumbParaphraser
 import com.hadisatrio.libs.kotlin.paraphrase.Paraphraser
@@ -59,6 +61,7 @@ class FakeJournal3Application : Journal3Application() {
     override val coordinates: Coordinates by lazy { LiteralCoordinates("-6.275489,107.050648") }
     override val speed: Speed by lazy { StaticSpeed(5.0) }
     override val places: Places by lazy { SelfPopulatingPlaces(10, FakePlaces()) }
+    override val currentPlace: Place by lazy { FakePlace() }
     override val moments: EditableMoments by lazy { SelfPopulatingMoments(10, FakeMoments()) }
     override val notableMoments: Moments by lazy { NotabilityFilteringMoments(true, moments) }
     override val reflections: Stories by lazy { FakeStories() }

app-kmm-journal3/src/commonMain/kotlin/com/hadisatrio/apps/kotlin/journal3/moment/CaptureAMomentUseCase.kt

@@ -21,14 +21,14 @@ import com.hadisatrio.apps.kotlin.journal3.datetime.LiteralTimestamp
 import com.hadisatrio.apps.kotlin.journal3.moment.cache.CachingMoments
 import com.hadisatrio.libs.kotlin.foundation.UseCase
 import com.hadisatrio.libs.kotlin.geography.Coordinates
-import com.hadisatrio.libs.kotlin.geography.Places
+import com.hadisatrio.libs.kotlin.geography.Place
 import com.hadisatrio.libs.kotlin.geography.Speed
 import kotlinx.datetime.Clock
 import kotlin.time.Duration.Companion.hours
 
 class CaptureAMomentUseCase(
     private val moments: EditableMoments,
-    private val places: Places,
+    private val currentPlace: Place,
     private val coordinates: Coordinates,
     private val speed: Speed,
     private val clock: Clock
@@ -45,7 +45,7 @@ class CaptureAMomentUseCase(
         val last24h = (currentTimestamp - 24.hours)..currentTimestamp
         val todaysMoments = TimeRangedMoments(last24h, cached)
 
-        var place = places.first()
+        var place = currentPlace
         val vicinityMoments = VicinityMoments(place.coordinates, coordinates.accuracyInMeters, cached)
         place = vicinityMoments.firstOrNull()?.place ?: place
 

app-kmm-journal3/src/commonTest/kotlin/com/hadisatrio/apps/kotlin/journal3/moment/CaptureAMomentUseCaseTest.kt

@@ -20,10 +20,8 @@ package com.hadisatrio.apps.kotlin.journal3.moment
 import com.hadisatrio.apps.kotlin.journal3.moment.fake.FakeMoments
 import com.hadisatrio.libs.kotlin.geography.Coordinates
 import com.hadisatrio.libs.kotlin.geography.LiteralCoordinates
-import com.hadisatrio.libs.kotlin.geography.Place
 import com.hadisatrio.libs.kotlin.geography.Speed
 import com.hadisatrio.libs.kotlin.geography.fake.FakePlace
-import com.hadisatrio.libs.kotlin.geography.fake.FakePlaces
 import io.kotest.matchers.booleans.shouldBeFalse
 import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.collections.shouldHaveSize
@@ -42,13 +40,12 @@ class CaptureAMomentUseCaseTest {
     private val moments = FakeMoments()
     private val gambirStation = FakePlace(coordinates = LiteralCoordinates("-6.1765638,106.8299464"))
     private val gambirBusDepot = FakePlace(coordinates = LiteralCoordinates("-6.1766638,106.8300464"))
-    private val places = FakePlaces(gambirStation, gambirBusDepot)
     private val coordinates = mockk<Coordinates>()
     private val speed = mockk<Speed>()
     private val arbitraryInstant = Instant.fromEpochMilliseconds(1735316550)
     private val clock = mockk<Clock>()
 
-    private val useCase = CaptureAMomentUseCase(moments, places, coordinates, speed, clock)
+    private val useCase = CaptureAMomentUseCase(moments, gambirStation, coordinates, speed, clock)
 
     @BeforeTest
     fun `Init mocks`() {
@@ -65,19 +62,14 @@ class CaptureAMomentUseCaseTest {
         val captured = moments.first()
         captured.timestamp.value.shouldBeEqual(arbitraryInstant)
         captured.isNotable.shouldBeFalse()
-        captured.place.id.shouldBeEqual(places.first().id)
+        captured.place.id.shouldBeEqual(gambirStation.id)
     }
 
     @Test
     fun `Prioritizes a known nearby place whilst capturing`() {
-        val placesList = mutableListOf<Place>(gambirStation, gambirBusDepot)
-        val places = FakePlaces(placesList)
-        val useCase = CaptureAMomentUseCase(moments, places, coordinates, speed, clock)
-
-        useCase() // …captures visit to Gambir Station.
-        placesList.removeFirst() // …so that the next execution would pick up the bus depot.
+        CaptureAMomentUseCase(moments, gambirStation, coordinates, speed, clock)()
         every { clock.now() } returns arbitraryInstant + 1.days + 1.seconds
-        useCase() // …attempts to capture the bus depot.
+        CaptureAMomentUseCase(moments, gambirBusDepot, coordinates, speed, clock)()
 
         moments.shouldHaveSize(2)
         moments.distinctBy { it.place.id }.shouldHaveSize(1)
@@ -95,14 +87,8 @@ class CaptureAMomentUseCaseTest {
 
     @Test
     fun `Skips capturing if the place, post correction, is already written for today`() {
-        val placesList = mutableListOf<Place>(gambirStation, gambirBusDepot)
-        val places = FakePlaces(placesList)
-        val useCase = CaptureAMomentUseCase(moments, places, coordinates, speed, clock)
-
-        useCase() // …captures visit to Gambir Station.
-        placesList.removeFirst() // …so that the next execution would pick up the bus depot.
-        // Unlike the previous test case, we don't advance the time.
-        useCase() // …attempts to capture the bus depot.
+        CaptureAMomentUseCase(moments, gambirStation, coordinates, speed, clock)()
+        CaptureAMomentUseCase(moments, gambirBusDepot, coordinates, speed, clock)()
 
         moments.shouldHaveSize(1)
         moments.distinctBy { it.place.id }.shouldHaveSize(1)

gradle/libs.versions.toml

@@ -16,6 +16,8 @@ androidx-test-runner = { module = "androidx.test:runner", version = "1.6.2" }
 
 gms-location = { module = "com.google.android.gms:play-services-location", version = "21.3.0" }
 
+google-places = { module = "com.google.android.libraries.places:places", version = "3.5.0" }
+
 kotlinx-datetime = { module = "org.jetbrains.kotlinx:kotlinx-datetime", version = "0.6.1" }
 kotlinx-json-okio = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json-okio", version = "1.7.3" }
 

lib-kmm-geography/build.gradle.kts

@@ -34,6 +34,7 @@ kotlin {
             dependencies {
                 implementation(libs.assent)
                 implementation(libs.gms.location)
+                implementation(libs.google.places)
             }
         }
         val androidUnitTest by getting {

lib-kmm-geography/src/androidMain/kotlin/com/hadisatrio/libs/android/geography/google/GoogleSdkCurrentPlace.kt

@@ -0,0 +1,96 @@
+/*
+ * Copyright (C) 2022 Hadi Satrio
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.hadisatrio.libs.android.geography.google
+
+import android.Manifest.permission.ACCESS_COARSE_LOCATION
+import android.Manifest.permission.ACCESS_FINE_LOCATION
+import android.annotation.SuppressLint
+import android.app.Application
+import androidx.annotation.RequiresPermission
+import com.benasher44.uuid.Uuid
+import com.google.android.gms.tasks.Tasks
+import com.google.android.libraries.places.api.Places
+import com.google.android.libraries.places.api.net.FindCurrentPlaceRequest
+import com.google.android.libraries.places.api.net.PlacesClient
+import com.hadisatrio.libs.kotlin.geography.Coordinates
+import com.hadisatrio.libs.kotlin.geography.Place
+import kotlinx.datetime.Clock
+import kotlinx.datetime.Instant
+import kotlin.time.Duration.Companion.seconds
+
+@SuppressLint(
+    "MissingPermission"
+    /* We are expecting the client to handle permissions as expressed on the annotated
+     * properties seen in this class. However, as the delegate (from which this requirement
+     * is coming from) is being instantiated lazily, we could not specify the annotation
+     * on the delegate itself. Hence the suppression. */
+)
+class GoogleSdkCurrentPlace(
+    private val client: PlacesClient,
+    private val clock: Clock
+) : Place {
+
+    override val id: Uuid
+        @RequiresPermission(allOf = [ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION])
+        get() = delegate().id
+
+    override val name: String
+        @RequiresPermission(allOf = [ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION])
+        get() = delegate().name
+
+    override val address: String
+        @RequiresPermission(allOf = [ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION])
+        get() = delegate().address
+
+    override val coordinates: Coordinates
+        @RequiresPermission(allOf = [ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION])
+        get() = delegate().coordinates
+
+    private var lastKnownPlace: Place? = null
+    private var lastFetchInstant: Instant? = null
+
+    @Synchronized
+    @RequiresPermission(allOf = [ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION])
+    private fun delegate(): Place {
+        val lastFetchInstant = this.lastFetchInstant
+        val currentInstant = clock.now()
+        val updateRequired = lastFetchInstant == null || currentInstant - lastFetchInstant > 10.seconds
+
+        if (updateRequired) {
+            val request = FindCurrentPlaceRequest.builder(GoogleSdkPlaceFields).build()
+            val response = Tasks.await(client.findCurrentPlace(request))
+            val googlePlace = response.placeLikelihoods.maxBy { it.likelihood }.place
+            this.lastKnownPlace = GoogleSdkPlace(googlePlace)
+            this.lastFetchInstant = clock.now()
+        }
+
+        return this.lastKnownPlace!!
+    }
+
+    constructor(
+        apiKey: String,
+        application: Application,
+        clock: Clock
+    ) : this(
+        application.run {
+            Places.initializeWithNewPlacesApiEnabled(application, apiKey)
+            Places.createClient(application)
+        },
+        clock
+    )
+}