https://github.com/h5gq3/urbit_http_api

https://github.com/h5gq3/urbit_http_api

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/h5gq3/urbit_http_api
• Owner: h5gq3
• Created: 2020-11-11T23:56:14.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-04T20:39:49.000Z (over 3 years ago)
• Last Synced: 2024-11-07T11:03:05.341Z (9 days ago)
• Language: Kotlin
• Size: 84 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-urbit - Kotlin

README

        
# Urbit HTTP API

Urbit HTTP API library in Kotlin for connecting to an Urbit instance

[![awesome urbit badge](https://img.shields.io/badge/~-awesome%20urbit-lightgrey)](https://github.com/urbit/awesome-urbit)

## Usage

1. Copy `urbit.kt` in `/src/main/kotlin/urbit.kt` to your Kotlin project

2. Add following dependencies to your project `build.gradle.kts`

```

implementation("com.squareup.okhttp3:okhttp:4.9.0")

implementation("com.squareup.okhttp3:okhttp-sse:4.9.0")

```

3. Import the `Urbit` class in your project with top-level statement `import urbit.http.api.Urbit`

4. Initialize the `Urbit` class. E.g `val zod = Urbit(code, url)`

5. Call methods in your `main` function block. E.g `zod.connect()`

## Example

```

import urbit.http.api.Urbit

val zod = Urbit(code = "lidlut-tabwed-pillex-ridrup", url = "http://localhost:8080")

fun main() {

    zod.connect()

    zod.poke("zod","hood","helm-hi","openinggg airlock")

    zod.subscribe("zod","chat-view","/primary")

    zod.sseInit()

    zod.unsubscribe(2)

    zod.delete()

}

```

Look for more examples at test/urbitclient.kt

## To do

* improve documentation

* write methods for scry, spider | DONE

* handle timeouts better | DONE

* abstract away message boilerplate, let all actions call sendmessage()

* restructure code into Kotlin Multiplatform

* write graph-store interface | DONE

* write other urbit apps interfaces