Giter Club home page Giter Club logo

gotrue-kt's Introduction

Kotlin Client for GoTrue

Warning This repository is archived. Use supabase-kt instead to use Supabase in your Kotlin projects.

Kotlin JVM client for Netlify's GoTrue API.

Comes with DTOs for the responses to enable type-safe access.

Java CI with Gradle Gradle Package Bintray

Installation

Maven

<dependency>
    <groupId>io.supabase</groupId>
    <artifactId>gotrue-kt</artifactId>
    <version>{version}</version>
    <type>pom</type>
</dependency>

Gradle

implementation 'io.supabase:gotrue-kt:{version}'

Usage

val goTrueClient = GoTrueClient.defaultGoTrueClient(
    url = "<base-url>",
    headers = mapOf("Authorization" to "foo", "apiKey" to "bar")
)

try {
    goTrueClient.invite("[email protected]")

    val updatedUser = goTrueClient.updateUser(
        accessToken = "eyJ...", // read from request header
        data = mapOf(
                "admin" = true
        )
    )

    println(updatedUser.updatedAt)
} catch (exc: GoTrueHttpException) {
    // Exception is thrown on bad status (anything above 300)
    println("Oops, status: ${exc.status}, body:\n${exc.httpBody}")
}

You can also customize the DTO for example if you turn off email verification

data class CustomGoTrueUserResponse(
    val accessToken: String,
    val tokenType: String,
    val refreshToken: String,
    val user: User
)

data class User(
    val id: UUID,
    val email: String,
    val phone: String

)

GoTrueClient.customApacheJacksonGoTrueClient<CustomGoTrueUserResponse, GoTrueTokenResponse>(
    url = "<base-url>",
    headers = mapOf("Authorization" to "foo", "apiKey" to "bar")
)

If you are using supabase, the base URL will be https://<your-project-id>.supabase.co/auth/v1

HTTP / (De)-Serialization

The Apache Http-Client (5.x) is used for executing HTTP calls, Jackson is used to convert responses to DTOs.

If you want to change that, you need to implement the GoTrueHttpClient and the GoTrueJsonConverter interface.

See GoTrueHttpClientApache and GoTrueJsonConverterJackson.

GoTrueClient.goTrueClient<GoTrueUserResponse,GoTrueTokenResponse>(
    goTrueHttpClient = { customHttpClient() },
    goTrueJsonConverter = customConverter()
)

gotrue-kt's People

Contributors

dshukertjr avatar kevcodez avatar tschuehly avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

gotrue-kt's Issues

Crash when calling `signUpWithEmail()`

Hi!

I'm using this library in an Android app, but when I try to sign up a new user, the app crashes due to the signUpWithEmail() function.

Here's the log:

2021-11-27 13:04:44.792 24469-24469/dev.horus.personalcrm E/AndroidRuntime: FATAL EXCEPTION: main
    Process: dev.horus.personalcrm, PID: 24469
    com.fasterxml.jackson.module.kotlin.MissingKotlinParameterException: Instantiation of [simple type, class io.supabase.gotrue.types.GoTrueUserResponse] value failed for JSON property id due to missing (therefore NULL) value for creator parameter id which is a non-nullable type
        at [Source: (String)"{"access_token":"[OMITED_TOKEN]","token_type":"bearer","expires_in":3600,"refresh_token":"[OMITED_TOKEN]","user":{"id":"4cb"[truncated 406 chars]; line: 1, column: 906] (through reference chain: io.supabase.gotrue.types.GoTrueUserResponse["id"])
        at com.fasterxml.jackson.module.kotlin.KotlinValueInstantiator.createFromObjectWith(KotlinValueInstantiator.kt:116)
        at com.fasterxml.jackson.databind.deser.impl.PropertyBasedCreator.build(PropertyBasedCreator.java:202)
        at com.fasterxml.jackson.databind.deser.BeanDeserializer._deserializeUsingPropertyBased(BeanDeserializer.java:520)
        at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeFromObjectUsingNonDefault(BeanDeserializerBase.java:1390)
        at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserializeFromObject(BeanDeserializer.java:362)
        at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:195)
        at com.fasterxml.jackson.databind.deser.DefaultDeserializationContext.readRootValue(DefaultDeserializationContext.java:322)
        at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4593)
        at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3548)
        at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3516)
        at io.supabase.gotrue.json.GoTrueJsonConverterJackson.deserialize(GoTrueJsonConverterJackson.kt:30)
        at io.supabase.gotrue.GoTrueClient.signUpWithEmail(GoTrueClient.kt:195)
        at dev.horus.personalcrm.LoginActivity$signUp$2.invokeSuspend(LoginActivity.kt:104)
        at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
        at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:106)
        at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
        at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:750)
        at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
        at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)

What I think is the cause
I disabled the Enable email confirmations in Supabase, which led to the API returning something different.

signUpWithEmail() expects to return this:

data class GoTrueUserResponse(
        val id: String,
        val email: String,
        val confirmationSentAt: OffsetDateTime,
        val createdAt: OffsetDateTime,
        val updatedAt: OffsetDateTime
)

But as I disabled the email confirmations, the API returns a different payload, and it fails when deserializing it. I think we should also allow for that function to return this data class:

data class GoTrueTokenResponse(
        val accessToken: String,
        val tokenType: String,
        val expiresIn: Long,
        val refreshToken: String
)

Compatibility with android

So far this library was build to work for Kotlin backend applications.

Being able to use this library in Android allows app developers using Kotlin to use this lib as well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.