Align SDK with noebs and release v26.3.0

Author: adonese

.github/workflows/gradle.yml

@@ -10,6 +10,7 @@ name: Java CI with Gradle
 on:
   push:
     branches: [ "master" ]
+    tags: [ "v*" ]
   pull_request:
     branches: [ "master" ]
 
@@ -34,17 +35,11 @@ jobs:
       with:
         arguments: build -x test
 
-    - name: Set short git commit SHA
-      id: vars
-      run: echo "short_sha=$(git rev-parse --short ${{ github.sha }})" >> "$GITHUB_OUTPUT"
-
-        
-    # The USERNAME and TOKEN need to correspond to the credentials environment variables used in
-    # the publishing section of your build.gradle
     - name: Publish to GitHub Packages
+      if: startsWith(github.ref, 'refs/tags/v')
       uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
       with:
-        arguments: publish -Pversion=${{ steps.vars.outputs.short_sha }}
+        arguments: publish
       env:
         USERNAME: ${{ github.actor }}
         TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -112,7 +112,12 @@ import com.tuti.api.TutiApiClient
 import com.tuti.api.wallet.v1.EnsureWalletRequest
 
 val client = TutiApiClient(noebsServer = "http://localhost:8000/")
-client.authToken = "Bearer <jwt>" // if your deployment requires auth
+client.authToken = "Bearer <jwt>" // required for /wallet routes on current noebs
+client.defaultHeaders = mapOf(
+    // Optional: needed when your deployment relies on extra headers such as tenant or admin key.
+    "X-Tenant-ID" to "tenant_1",
+    // "X-Admin-Key" to "<admin-key>",
+)
 
 client.wallet.ensureWallet(
     EnsureWalletRequest(
@@ -145,27 +150,30 @@ val ws = client.openChatSocket(object : WebSocketListener() {
 ```
 
 # Deployment notes
-
-We will still be sticking to jitpack, at least for the public builds. However, we are using github package (using gradle repository). 
-
-## noebs sdk versioning
-
-We are using CalVer, it is very convenient as it shows actual progress against time. Seems more concrete than say semver. Jitpack relies on git tags, so the easiest way is to always tag your commits following CalVer semantics (vYY.MM.versionNumber)
-
-## how to deploy noebs to Github Packages
-
-- Update the version number manually in `gradle.properties` version to reflect the new CalVer changes
-- In `lib/build.gradle`, update the username and password with the appropriate Github issues keys (note the password is a a personal access token, and not your password)
-
-```groovy   
-repositories {
-        maven {
-            name = "GitHubPackages"
-            url = uri("https://maven.pkg.github.com/tutipay/java-sdk")
-            credentials {
-                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
-                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
-            }
+
+Public tagged releases are exposed through JitPack, and the same tagged version is published to GitHub Packages by GitHub Actions.
+
+## noebs sdk versioning
+
+We are using CalVer (`YY.MM.patch`). JitPack relies on git tags, so releases should be tagged as `vYY.MM.patch`.
+
+## how to deploy noebs to Github Packages
+
+- Update `gradle.properties` to the next CalVer release.
+- Run `./gradlew test`.
+- Commit the release, tag it as `v<version>`, and push `master` plus the tag.
+- GitHub Actions publishes `noebs:lib:<version>` to GitHub Packages when the tag is pushed.
+- For local manual publishing, use your GitHub username plus a personal access token with package write access.
+
+```groovy
+repositories {
+        maven {
+            name = "GitHubPackages"
+            url = uri("https://maven.pkg.github.com/noebs/sdk")
+            credentials {
+                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
+                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
+            }
         }
     }
 ```
@@ -176,13 +184,13 @@ repositories {
 
 - Update your `build.gradle` files to include github package
 
-```groovy
-        maven {
-            url = uri("https://maven.pkg.github.com/tutipay/java-sdk")
-            credentials {
-                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
-                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
-            }
-        }
-```
-- add to your app's gradle file the implementation, which is `implementation 'noebs:lib:-latest-version'`
+```groovy
+        maven {
+            url = uri("https://maven.pkg.github.com/noebs/sdk")
+            credentials {
+                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
+                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
+            }
+        }
+```
+- add to your app's gradle file the implementation, which is `implementation 'noebs:lib:<version>'`

gradle.properties

@@ -1,2 +1,2 @@
 group=noebs
-version=26.2.1
+version=26.3.0

lib/src/main/java/com/tuti/api/TutiApiClient.kt

@@ -66,6 +66,7 @@ class TutiApiClient(
 
     var isSingleThreaded = false
     @Volatile var authToken: String = ""
+    @Volatile var defaultHeaders: Map<String, String> = emptyMap()
     var ipinUsername: String = ""
     var ipinPassword: String = ""
     var ebsKey: String = "MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANx4gKYSMv3CrWWsxdPfxDxFvl+Is/0kc1dvMI1yNWDXI3AgdI4127KMUOv7gmwZ6SnRsHX/KAM0IPRe0+Sa0vMCAwEAAQ=="
@@ -102,6 +103,22 @@ class TutiApiClient(
         return request
     }
 
+    private fun normalizeLegacyAuthRequest(
+        credentials: SignInRequest?,
+    ): com.tuti.model.SignInRequest? {
+        if (credentials == null) {
+            return null
+        }
+        return com.tuti.model.SignInRequest(
+            password = credentials.password,
+            otp = credentials.otp,
+            mobile = credentials.mobile.ifBlank { credentials.username },
+            auth = credentials.oldToken,
+            signature = credentials.signature,
+            message = credentials.message,
+        )
+    }
+
     @Deprecated(
         message = "Replace with SignIn with new kotlin classes instead.",
         replaceWith = ReplaceWith("SignIn")
@@ -114,7 +131,7 @@ class TutiApiClient(
         sendRequest(
             RequestMethods.POST,
             consumerURL + Operations.SIGN_IN,
-            credentials,
+            normalizeLegacyAuthRequest(credentials),
             onResponse,
             onError
         )
@@ -309,7 +326,7 @@ class TutiApiClient(
         sendRequest(
             RequestMethods.POST,
             consumerURL + Operations.SINGLE_SIGN_IN,
-            credentials,
+            normalizeLegacyAuthRequest(credentials),
             onResponse,
             onError
         )
@@ -355,7 +372,7 @@ class TutiApiClient(
         sendRequest(
             RequestMethods.POST,
             consumerURL + Operations.GENERATE_LOGIN_OTP_INSECURE,
-            credentials,
+            normalizeLegacyAuthRequest(credentials),
             onResponse,
             onError
         )
@@ -406,7 +423,7 @@ class TutiApiClient(
         sendRequest(
             RequestMethods.POST,
             consumerURL + Operations.REFRESH_TOKEN,
-            credentials,
+            normalizeLegacyAuthRequest(credentials),
             onResponse,
             onError
         )
@@ -1045,14 +1062,9 @@ class TutiApiClient(
 
 
     /**
-     * billInfo gets a bill from EBS using a pre-stored data, only send applicable bill fields
-     * plus the type of transaction
-     *
-     * @param billInfo
-     * @param onResponse
-     * @param onError
+     * Calls the legacy `/consumer/bills` helper, where the server injects its configured inquiry PAN/IPIN.
      */
-    fun billInquiry(
+    fun getBills(
         billInfo: BillInfo,
         onResponse: (TutiResponse) -> Unit,
         onError: (TutiResponse?, Exception?) -> Unit,
@@ -1066,6 +1078,39 @@ class TutiApiClient(
         )
     }
 
+    /**
+     * Retained for compatibility. This overload maps to `/consumer/bills`.
+     * Use [getBills] for this flow, or [billInquiry] with [EBSRequest] for `/consumer/bill_inquiry`.
+     */
+    @Deprecated(
+        message = "This overload calls /consumer/bills. Use getBills(BillInfo, ...) or billInquiry(EBSRequest, ...).",
+        replaceWith = ReplaceWith("getBills(billInfo, onResponse, onError)")
+    )
+    fun billInquiry(
+        billInfo: BillInfo,
+        onResponse: (TutiResponse) -> Unit,
+        onError: (TutiResponse?, Exception?) -> Unit,
+    ): Call {
+        return getBills(billInfo, onResponse, onError)
+    }
+
+    /**
+     * Direct bill inquiry against `/consumer/bill_inquiry` using an explicit EBS-style request.
+     */
+    fun billInquiry(
+        request: EBSRequest,
+        onResponse: (TutiResponse) -> Unit,
+        onError: (TutiResponse?, Exception?) -> Unit,
+    ): Call {
+        return sendRequest(
+            RequestMethods.POST,
+            consumerURL + Operations.BILL_INQUIRY,
+            request,
+            onResponse,
+            onError,
+        )
+    }
+
     fun cardTransfer(
         card: Card,
         ipin: String,
@@ -1684,6 +1729,10 @@ class TutiApiClient(
         if (token.isNotBlank()) {
             requestBuilder.header("Authorization", token)
         }
+        val headerSnapshot = defaultHeaders
+        headerSnapshot.forEach { (key, value) ->
+            requestBuilder.header(key, value)
+        }
         return okHttpClient.newWebSocket(requestBuilder.build(), listener)
     }
 
@@ -1713,6 +1762,10 @@ class TutiApiClient(
             requestBuilder.header("Authorization", tokenSnapshot)
         }
         requestBuilder.header("Accept", "application/json")
+        val defaultHeaderSnapshot = defaultHeaders
+        defaultHeaderSnapshot.forEach { (key, value) ->
+            requestBuilder.header(key, value)
+        }
 
         // add additional headers set by the user
         headers?.forEach { (key, value) ->

lib/src/main/java/com/tuti/api/authentication/SignInResponse.kt

@@ -1,10 +1,16 @@
-package com.tuti.api.authentication
-
-import kotlinx.serialization.SerialName
-
-@kotlinx.serialization.Serializable
-data class SignInResponse (
-    @SerialName("authorization")
-    val authorizationJWT: String = "",
-    val user: User = User()
-)
+package com.tuti.api.authentication
+
+import kotlinx.serialization.SerialName
+
+@kotlinx.serialization.Serializable
+data class SignInResponse (
+    @SerialName("authorization")
+    val authorizationJWT: String = "",
+    val user: User = User(),
+    val message: String = "",
+    val status: String = "",
+    val result: String = "",
+    val code: String = "",
+    @SerialName("pubkey")
+    val publicKey: String = "",
+)

lib/src/main/java/com/tuti/api/authentication/SignUpRequest.kt

@@ -3,18 +3,18 @@ package com.tuti.api.authentication
 import kotlinx.serialization.SerialName
 
 @kotlinx.serialization.Serializable
-data class SignUpRequest (
-    val username: String? = null,
-    val password: String? = null,
-
-    @SerialName("firebase_token")
-    val firebaseVerificationID: String? = null,
-
-    @SerialName("public_key")
-    val userPubKey: String? = null,
-
-    @SerialName("device_id")
-    val deviceId: String? = null,
+data class SignUpRequest (
+    val username: String? = null,
+    val password: String? = null,
+
+    @SerialName("firebase_token")
+    val firebaseVerificationID: String? = null,
+
+    @SerialName("user_pubkey")
+    val userPubKey: String? = null,
+
+    @SerialName("device_id")
+    val deviceId: String? = null,
     val fullname: String? = null,
     val birthday: String? = null,
     val email: String? = null,
@@ -24,4 +24,4 @@ data class SignUpRequest (
 
     @SerialName("is_merchant")
     val isMerchant: Boolean = false
-)
+)

lib/src/main/java/com/tuti/api/authentication/SignUpResponse.kt

@@ -1,9 +1,12 @@
-package com.tuti.api.authentication
-
-import kotlinx.serialization.SerialName
-
-@kotlinx.serialization.Serializable
-data class SignUpResponse (
-    @SerialName("details")
-    var user: User = User()
-)
+package com.tuti.api.authentication
+
+import kotlinx.serialization.SerialName
+
+@kotlinx.serialization.Serializable
+data class SignUpResponse (
+    @SerialName("details")
+    var user: User = User(),
+    val result: String = "",
+    val message: String = "",
+    val code: String = "",
+)

lib/src/main/java/com/tuti/api/authentication/User.kt

@@ -1,21 +1,25 @@
-package com.tuti.api.authentication
-
-import kotlinx.serialization.SerialName
-
-@kotlinx.serialization.Serializable
-data class User(
-        val id: Int = 0,
-        val createdAt: String = "",
-        val updateAt: String = "",
-        val deletedAt: String = "",
-        val username: String = "",
-        val fullname: String = "",
-        val birthday: String = "",
+package com.tuti.api.authentication
+
+import kotlinx.serialization.SerialName
+
+@kotlinx.serialization.Serializable
+data class User(
+        @SerialName("ID")
+        val id: Int = 0,
+        @SerialName("CreatedAt")
+        val createdAt: String = "",
+        @SerialName("UpdatedAt")
+        val updateAt: String = "",
+        @SerialName("DeletedAt")
+        val deletedAt: String = "",
+        val username: String = "",
+        val fullname: String = "",
+        val birthday: String = "",
 
         @SerialName("mobile")
         val mobileNumber: String = "",
         val email: String = "",
 
         @SerialName("is_merchant")
         val isMerchant: Boolean = false,
-)
+)