/retrofit-dsl

Retrofit in DSL styles for Kotliner 🌐

Primary LanguageKotlinMIT LicenseMIT

Retrofit-DSL

Build Status jitpack ktlint

Retrofit itself is great but it not design for Kotlin. This small plug-in library will make Retrofit look great on your .kt.

Usage

With Retrofit-DSL our code will look like below.

 var service = retrofitFor<MessagingService> { //this: Retrofit.Builder
     baseUrl(server.url(""))
     addConverterFactory(GsonConverterFactory.create())
 }
 service.getMessage().enqueue {
     always {
        //when response return or failure
     }
     onSuccess { //this: Response<T>
        println(body())
     }
     onError { //this: Response<T>
        println(errorBody<Message>()) //call when response not in 4xx-5xx
     }
     onRedirect { //this: Response<T>
        //3xx
     }
     onClientError { //this: Response<T>
        //4xx
     }
     onServerError { //this: Response<T>
        //5xx
     }
     onFailure { //it: Throwable
        it.printStackTrace()
     }
     finally {
       //Always call afterward
     }
 }

Isn't it good?

Lazy

But If you wanna use more lazy form, Try this below.

  service.getMessage().then { message ->
      println(message)
  }.catch { res, t ->
      res?.let { doSomething(it) } // res return when request not successful
      t?.let { alert(it) } //throwable return on failure
  }.finally {
    dialog.dismiss() //Always call afterward
  }

catch() and finally() are optional

Download

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation "com.squareup.retrofit2:retrofit:$retrofit_version"
    ...
    implementation "com.github.piruin:retrofit-dsl:$retrofit_dsl_version" //Change to latest version
}

License

Copyright (c) 2018 Piruin Panichphol

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.