https://github.com/javiersegoviacordoba/network-either-kmp

https://github.com/javiersegoviacordoba/network-either-kmp

arrow arrow-kt functional-programming hacktoberfest kotlin kotlin-multiplatform ktor ktor-client multiplatform multiplatform-kotlin-library retrofit retrofit2

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/javiersegoviacordoba/network-either-kmp
• Owner: JavierSegoviaCordoba
• Created: 2020-12-19T16:06:03.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-10T22:17:22.000Z (7 months ago)
• Last Synced: 2024-10-11T10:16:44.278Z (7 months ago)
• Topics: arrow, arrow-kt, functional-programming, hacktoberfest, kotlin, kotlin-multiplatform, ktor, ktor-client, multiplatform, multiplatform-kotlin-library, retrofit, retrofit2
• Language: Kotlin
• Homepage: https://network-either-kmp.javiersc.com
• Size: 9.98 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![Kotlin version](https://img.shields.io/badge/kotlin-2.0.21-blueviolet?logo=kotlin&logoColor=white)

[![MavenCentral](https://img.shields.io/maven-central/v/com.javiersc.network/network-either?label=MavenCentral)](https://repo1.maven.org/maven2/com/javiersc/network/network-either/)

[![Snapshot](https://img.shields.io/nexus/s/com.javiersc.network/network-either?server=https%3A%2F%2Foss.sonatype.org%2F&label=Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/com/javiersc/network/network-either/)

[![Build](https://img.shields.io/github/actions/workflow/status/JavierSegoviaCordoba/network-either-kmp/build-kotlin.yaml?label=Build&logo=GitHub)](https://github.com/JavierSegoviaCordoba/network-either-kmp/tree/main)

[![Coverage](https://img.shields.io/sonar/coverage/com.javiersc.network:network-either?label=Coverage&logo=SonarCloud&logoColor=white&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/dashboard?id=com.javiersc.network:network-either)

[![Quality](https://img.shields.io/sonar/quality_gate/com.javiersc.network:network-either?label=Quality&logo=SonarCloud&logoColor=white&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/dashboard?id=com.javiersc.network:network-either)

[![Tech debt](https://img.shields.io/sonar/tech_debt/com.javiersc.network:network-either?label=Tech%20debt&logo=SonarCloud&logoColor=white&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/dashboard?id=com.javiersc.network:network-either)

# Network Either

## Ktor

### Usage

```kotlin

val client: HttpClient = HttpClient(MockEngine) {

    install(NetworkEitherPlugin)

    install(ContentNegotiation) {

        json(defaultJson)

    }

}

@Serializable

data class DogDTO(val id: Int, val name: String, val age: Int)

@Serializable

data class ErrorDTO(val message: String)

val response: NetworkEither = client.get("dog").body()

response.fold(

    failure = { ... },

    success = { ... },

)

```

Check all available functions in the [

`NetworkEither` class](subprojects/network-either/common/main/kotlin/com/javiersc/network/either/NetworkEither.kt).

Check [the tests](subprojects/network-either/common/test/kotlin/com/javiersc/network/either/KtorTest.kt)

for more examples.

## Retrofit

### Usage

```kotlin

val retrofit =

    Retrofit

        .Builder()

        .baseUrl("org.example.com")

        .addCallAdapterFactory(NetworkEitherCallAdapterFactory())

        .build()

interface DogService {

    @GET("dog")

    suspend fun getDog(): NetworkEither

}

val service: DogService = retrofit.create()

val response: NetworkEither = service.getDog()

response.fold(

    failure = { ... },

    success = { ... },

)

```

Check [the tests](subprojects/network-either/jvm/test/kotlin/com/javiersc/network/either/RetrofitTest.kt)

for more examples.

## Docs

All docs are available on the [`network-either-kmp` website](https://network-either-kmp.javiersc.com)

## Download from MavenCentral

- NetworkEither, pretty printing logger and ResourceEither mappers

```kotlin

implementation("com.javiersc.network:network-either:$version")

```