ionic-team · alexgerardojacinto · Jan 9, 2025 · Jan 7, 2025 · Jan 7, 2025 · Jan 7, 2025
diff --git a/.github/workflows/publish-android.yml b/.github/workflows/publish-android.yml
@@ -0,0 +1,39 @@
+name: Publish Native Android Library
+
+#on: workflow_dispatch
+on:
+  workflow_dispatch:
+  push:
+    branches: [ feat/RMET-3975/setup-pipelines ]
+
+jobs:
+  publish-android:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+      - name: Grant execute permission for publishing script
+        run: chmod +x ./scripts/publish-android.sh
+      - name: Make local props
+        run: |
+          cat << EOF > "local.properties"
+          ossrhUsername=${{ secrets.ANDROID_OSSRH_USERNAME }}
+          ossrhPassword=${{ secrets.ANDROID_OSSRH_PASSWORD }}
+          sonatypeStagingProfileId=${{ secrets.ANDROID_SONATYPE_STAGING_PROFILE_ID }}
+          signing.keyId=${{ secrets.ANDROID_SIGNING_KEY_ID }}
+          signing.password=${{ secrets.ANDROID_SIGNING_PASSWORD }}
+          signing.key=${{ secrets.ANDROID_SIGNING_KEY }}
+          EOF
+          echo "local.properties file has been created successfully."
+      - name: Run publish script
+        working-directory: ./scripts
+        run: ./publish-android.sh
diff --git a/.github/workflows/github_actions.yml → .github/workflows/run-unit-tests.yml b/.github/workflows/github_actions.yml → .github/workflows/run-unit-tests.yml
@@ -1,4 +1,4 @@
-name: GitHub Actions
+name: Run Unit Tests
 
 on:
   workflow_dispatch:
@@ -31,11 +31,12 @@ jobs:
     - name: Code Coverage
       run: bundle exec fastlane coverage
 
-    - name: Setup sonarqube
-      uses: warchant/setup-sonar-scanner@v8
+    # Commenting Sonarqube steps for now, until we are able to configure Sonarqube in Ionic repos
+    #- name: Setup sonarqube
+    #  uses: warchant/setup-sonar-scanner@v8
 
-    - name: Send to Sonarcloud
-      run: bundle exec fastlane sonarqube
-      env: 
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+    #- name: Send to Sonarcloud
+    #  run: bundle exec fastlane sonarqube
+    #  env: 
+    #    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    #    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+
+### 2025-01-08
+- Feat: Add workflows to run unit tests and release the library in Maven repo.
+
+### 2025-01-07
+- Feat: Add implementation for whole library, including `getCurrentPosition`, `watchPosition`, and `clearWatch`.
+- Chore: Create repository.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 OutSystems
+Copyright (c) 2025 Ionic
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,3 +1,78 @@
-# OSGeolocationLib-Android
+# OSGeolocationLib
 
-The `OSGeolocationLib-Android` is a library built using `Kotlin`.
+The `OSGeolocationLib-Android` is a library built using `Kotlin` that provides geolocation features for Android applications.
+
+The `OSGLOCController` class provides the main features of the Library, which are:
+- obtaining the location/position of the device a single time;
+- adding a watch to obtain periodic location updates;
+- clearing/removing a previously added watch, turning off location updates.
+
+
+## Index
+
+- [Motivation](#motivation)
+- [Usage](#usage)
+- [Methods](#methods)
+    - [Obtain the current location of the device](#obtain-the-current-location-of-the-device)
+    - [Add a watch for periodic location updates](#add-a-watch-for-periodic-location-updates)
+    - [Clear a watch that was added previously](#clear-a-watch-that-was-added-previously)
+
+## Motivation
+
+This library is used by the Geolocation Plugin for [OutSystems' Cordova Plugin](https://github.com/ionic-team/cordova-outsystems-geolocation) and [Ionic's Capacitor Plugin](https://github.com/ionic-team/outsystems-geolocation).
+
+## Usage
+
+In your app-level gradle file, import the `OSGeolocationLib` library like so:
+
+    dependencies {
+    	implementation("com.capacitorjs:osgeolocation-android:1.0.0")
+	}
+
+
+## Methods
+
+As mentioned before, the library offers the `OSGLOCController` class that provides the following methods to interact with:
+
+### Obtain the current location of the device
+
+```kotlin
+suspend fun getCurrentPosition(
+    activity: Activity, 
+    options: OSGLOCLocationOptions
+): Result<OSGLOCLocationResult>
+```
+
+The method is composed of the following input parameters:
+- **activity**: the `Activity` from the app using the library to use when obtaining the location.
+- **options**: `OSGLOCLocationOptions` with the options with which to make the location request with (e.g. timeout).
+
+The method returns a `Result` containing either an object of type `OSGLOCLocationResult`, which includes the geolocation data (e.g. latitide, longitude), or an exception that should be handled by the caller app.
+
+### Add a watch for periodic location updates
+
+```kotlin
+fun addWatch(
+    activity: Activity,
+    options: OSGLOCLocationOptions,
+    watchId: String
+): Flow<Result<List<OSGLOCLocationResult>>>
+```
+
+The method is composed of the following input parameters:
+- **activity**: the `Activity` from the app using the library to use when obtaining the location updates.
+- **options**: `OSGLOCLocationOptions` with the options with which to make the location updates request with (e.g. timeout).
+- **watchId**: a unique id identifying the watch to add, so that it can be removed later.
+
+The method returns a Flow in which the location updates will be emitted to.
+
+### Clear a watch that was added previously
+
+```kotlin
+fun clearWatch(id: String): Boolean
+```
+
+The method is composed of the following input parameters:
+- **id**: the `watchId` identigying the watch to remove.
+
+The method returns a Boolean indicating if the watch was cleared or not (in case the watch isn't found).
diff --git a/build.gradle b/build.gradle
@@ -44,7 +44,7 @@ android {
     compileSdk 35
 
     defaultConfig {
-        minSdk 26
+        minSdk 23
         targetSdk 35
         versionCode 1
         versionName "1.0"

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
diff --git a/docs/LICENSE b/docs/LICENSE
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/assets/createRepositoryButton.png b/docs/assets/createRepositoryButton.png
diff --git a/docs/assets/repositoryNameExample.png b/docs/assets/repositoryNameExample.png
diff --git a/docs/assets/useThisTemplateButton.png b/docs/assets/useThisTemplateButton.png
diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md
diff --git a/scripts/publish-android.sh b/scripts/publish-android.sh
@@ -5,7 +5,7 @@ LOG_OUTPUT=./tmp/publish-android.txt
 THE_VERSION=`sed -n 's/.*<version>\(.*\)<\/version>.*/\1/p' ../pom.xml`
 
 # Get latest io.ionic:portals XML version info
-PUBLISHED_URL="https://repo1.maven.org/maven2/com/capacitorjs/geolocationlib-android/maven-metadata.xml"
+PUBLISHED_URL="https://repo1.maven.org/maven2/io/ionic/libs/osgeolocation-android/maven-metadata.xml"
 PUBLISHED_DATA=$(curl -s $PUBLISHED_URL)
 PUBLISHED_VERSION="$(perl -ne 'print and last if s/.*<latest>(.*)<\/latest>.*/\1/;' <<< $PUBLISHED_DATA)"
 
@@ -20,8 +20,10 @@ else
     export SHOULD_PUBLISH=true
 
     printf %"s\n" "Attempting to build and publish version $THE_VERSION"
-    "$ANDROID_PATH"/gradlew clean build publishReleasePublicationToSonatypeRepository closeAndReleaseSonatypeStagingRepository --no-daemon --max-workers 1 -b "$ANDROID_PATH"/build.gradle -Pandroid.useAndroidX=true > $LOG_OUTPUT 2>&1
-    # "$ANDROID_PATH"/gradlew clean build publishReleasePublicationToSonatypeRepository --no-daemon --max-workers 1 -b "$ANDROID_PATH"/build.gradle -Pandroid.useAndroidX=true > $LOG_OUTPUT 2>&1
+    # Publish a release to the Maven repo
+    # "$ANDROID_PATH"/gradlew clean build publishReleasePublicationToSonatypeRepository closeAndReleaseSonatypeStagingRepository --no-daemon --max-workers 1 -b "$ANDROID_PATH"/build.gradle -Pandroid.useAndroidX=true > $LOG_OUTPUT 2>&1
+    # Stage a version
+    "$ANDROID_PATH"/gradlew clean build publishReleasePublicationToSonatypeRepository --no-daemon --max-workers 1 -b "$ANDROID_PATH"/build.gradle -Pandroid.useAndroidX=true > $LOG_OUTPUT 2>&1
 
     echo $RESULT
 

diff --git a/scripts/publish-module.gradle b/scripts/publish-module.gradle
@@ -5,29 +5,24 @@ def LIB_VERSION = System.getenv('THE_VERSION')
 
 task androidSourcesJar(type: Jar) {
     archiveClassifier.set('sources')
-    //if (project.plugins.findPlugin("com.android.library")) {
-        from android.sourceSets.main.java.srcDirs
-        from android.sourceSets.main.kotlin.srcDirs
-    //} else {
-    //    from sourceSets.main.java.srcDirs
-    //    from sourceSets.main.kotlin.srcDirs
-    //}
+    from android.sourceSets.main.java.srcDirs
+    from android.sourceSets.main.kotlin.srcDirs
 }
 
 artifacts {
     archives androidSourcesJar
 }
 
-group = 'com.capacitorjs'
+group = 'io.ionic.libs'
 version = LIB_VERSION
 
 afterEvaluate {
     publishing {
         publications {
             release(MavenPublication) {
                 // Coordinates
-                groupId 'com.capacitorjs'
-                artifactId 'osgeolocationlib-android'
+                groupId 'io.ionic.libs'
+                artifactId 'osgeolocation-android'
                 version LIB_VERSION
 
                 // Two artifacts, the `aar` (or `jar`) and the sources
@@ -41,13 +36,13 @@ afterEvaluate {
 
                 // POM Data
                 pom {
-                    name = 'geolocationlib-android'
+                    name = 'osgeolocation-android'
                     description = 'Geolocation Android Lib'
-                    url = 'https://github.com/ionic-team/outsystems-geolocation/packages/android-lib'
+                    url = 'https://github.com/ionic-team/OSGeolocationLib-Android'
                     licenses {
                         license {
                             name = 'License'
-                            url = 'https://github.com/ionic-team/outsystems-geolocation/blob/main/packages/android-lib/LICENSE'
+                            url = 'https://github.com/ionic-team/OSGeolocationLib-Android/blob/main/docs/LICENSE'
                         }
                     }
                     developers {
@@ -59,9 +54,9 @@ afterEvaluate {
 
                     // Version Control Info
                     scm {
-                        connection = 'scm:git:github.com:ionic-team/outsystems-geolocation.git'
-                        developerConnection = 'scm:git:ssh://github.com:ionic-team/outsystems-geolocation.git'
-                        url = 'https://github.com/ionic-team/outsystems-geolocation/tree/main'
+                        connection = 'scm:git:github.com:ionic-team/OSGeolocationLib-Android.git'
+                        developerConnection = 'scm:git:ssh://github.com:ionic-team/OSGeolocationLib-Android.git'
+                        url = 'https://github.com/ionic-team/OSGeolocationLib-Android/tree/main'
                     }
                 }
             }

diff --git a/scripts/publish-root.gradle b/scripts/publish-root.gradle
@@ -33,5 +33,5 @@ nexusPublishing {
             snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
         }
     }
-    repositoryDescription = 'OSGeolocation Lib v' + System.getenv('THE_VERSION')
+    repositoryDescription = 'OSGeolocation Android Lib v' + System.getenv('THE_VERSION')
 }