Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sya-ri/gofile.kt

Kotlin wrapper for the Gofile.io API
https://github.com/sya-ri/gofile.kt

gofile gofile-api kotlin kotlin-multiplatform kotlin-multiplatform-library ktor ktor-client

Last synced: 3 months ago
JSON representation

Kotlin wrapper for the Gofile.io API

Host: GitHub
URL: https://github.com/sya-ri/gofile.kt
Owner: sya-ri
License: apache-2.0
Created: 2022-07-25T10:57:43.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-06-10T16:06:06.000Z (8 months ago)
Last Synced: 2024-06-10T18:49:08.330Z (8 months ago)
Topics: gofile, gofile-api, kotlin, kotlin-multiplatform, kotlin-multiplatform-library, ktor, ktor-client
Language: Kotlin
Homepage:
Size: 1.83 MB
Stars: 5
Watchers: 2
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

  Gofile.kt





[![Kotlin](https://img.shields.io/badge/kotlin-1.9.20-blue.svg?logo=kotlin)](http://kotlinlang.org)

[![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)

[![Maven Central](https://img.shields.io/maven-central/v/dev.s7a/gofile)](https://search.maven.org/artifact/dev.s7a/gofile)

[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://gh.s7a.dev/Gofile.kt)

[![Build status](https://img.shields.io/github/actions/workflow/status/sya-ri/Gofile.kt/build.yml?branch=master&label=Test&logo=github)](.github/workflows/build.yml)

A kotlin wrapper for the [Gofile.io](https://gofile.io) API.



## Features

- Support multiplatform.

  - [x] JVM

  - [x] JS

  - [x] Native

    - Android

      - [ ] androidNativeX86 (yet)

      - [ ] androidNativeX64 (yet)

      - [ ] androidNativeArm32 (yet)

      - [ ] androidNativeArm64 (yet)

    - Linux

      - [x] linuxArm64

      - [x] linuxX64

      - [x] mingwX64

    - MacOS

      - [x] macosArm64

      - [x] macosX64

    - iOS

      - [x] iosArm64

      - [x] iosSimulatorArm64

      - [x] iosX64

    - tvOS

      - [x] tvosArm64

      - [x] tvosSimulatorArm64

      - [x] tvosX64

    - watchOS

      - [x] watchosArm32

      - [x] watchosArm64

      - [x] watchosSimulatorArm64

      - [ ] watchosDeviceArm64 (yet)

      - [x] watchosX64

- Supports all endpoints. (API Version: 2023-04-20)

  - [x] getServer

  - [x] uploadFile

  - [x] getContent

  - [x] createFolder

  - [x] setOption

  - [x] copyContent

  - [x] deleteContent

  - [x] getAccountDetails

- Support all account tiers.

  - [x] Guest (without token)

  - [x] Standard

  - [x] Donor

- Error handling using [Result](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/).

- Asynchronous with [Ktor](https://ktor.io).

## Installation

### Add dependency

You also need to add Ktor client engine.

#### build.gradle.kts

```kt

repositories {

    mavenCentral()

}

dependencies {

    implementation("dev.s7a:gofile:1.1.0")

    // See also: https://ktor.io/docs/http-client-engines.html

    // implementation("io.ktor:ktor-client-???:$ktor_version")

}

```

#### build.gradle

```groovy

repositories {

    mavenCentral()

}

dependencies {

    implementation "dev.s7a:gofile:1.1.0"

    // See also: https://ktor.io/docs/http-client-engines.html

    // implementation "io.ktor:ktor-client-???:$ktor_version"

}

```

### Main.kt

```kt

import dev.s7a.gofile.GofileClient

fun main() {

    val client = GofileClient() // Automatically find the engine

    // client.uploadFile(), etc...

}

```

## Documentation

- [API Document](https://gh.s7a.dev/Gofile.kt)

- [Examples](examples)

- [CONTRIBUTING.md](CONTRIBUTING.md)