rybalkinsd / kohttp Goto Github PK

• #65 Response ext
• #91 Retry Interceptor
• #89 Upload DSL headers (tests with Amazon S3)
• #81 OkHttp version upgrade

checklist

• regress testing
• attention to client fork feature
• check deprecations
• upgrade readme

Release 0.7.0 brings multiple ways to provide body content type:

1. header { type }
2. body(type) { }
3. body { form { } / json { } }

Todo

1. Need to update tests to check request content type
2. Need a remark in docs for cases when content type is declared with override:

httpPost {
    header { type 1 }
    body(type 2) {
        form { }  // <-- type 3
    }
}

Related to #17 #59

Add support for body { } dsl :

• byte array content
• raw content
• media type select

related #51

This release is a complete rework for async features and coroutines support.

• implement async POST
• rename all async methods according to follow kotlin guidelines
• measure asyncHttpGet() vs async { httpGet() }
• rethink Call.Factory.suspendCall ext
• consider usage of Dispatcher, should we move to IO?
• write a blogpost

I've got an URL https://domain:4567/path passed to a function, and I want to GET this URL with a certain header set (or a cookie, or a body when POSTing, et cetera):

fun download(url: String)
{
  val (myScheme, myHost, myPort, MyPath) = splitMyUrlSomehow(url)

  val response: Response = httpGet {
      scheme = myScheme
      host = myHost
      port = myPort
      path = myPath

      header {
          "some-header" to "hello there"
      }
  }
}

As far as I've figured out, there is no url var which could be used to just pass a URL. And splitting up my URL to pass its components to httpGet in 4 assignments seems rather cumbersome to me. Did I overlook something?

at the moment the only way to pass url to HttpGetContext (Post also) is

host = url.host
port = url.port
path = url.path
scheme = url.protocol

need to provide a clear ability to replace this declaration with

url = url

or

url { ... }

#71 #77 related

Hi guys, this is probably more a question than a bug. Imagine I have this function:

    override fun get(endpoint: String, params: MutableMap<String, Any>?): Response {

        val response = httpGet {
            host = "https://url-for-my-web-service"
            path = endpoint
            param {
                "token" to token
            }
        }
        return  response;
    }

I need to merge the parameters I get from params and the token parameter. However I do not know how to manipulate the param DSL to do that. Is it possible in the current version?

When we create new, for example, httPost we still access the receivers of the outer lambdas:

httpPost {
    host = "1234"
    port = 3333
    path = "/chat/login"
    body {
        form {
            "name" to "33333"
            host = ""
        }
    }
}

Property host will be equal to "" instead "1234"
It can be solved by @DslMarker annotation

Hey. I've noticed that there is a dependency on Jackson. Is it really that necessary to add it to the library just to use it inside of one extension method? Can it be possibly moved to a separate artifact?

Define a DSL as an interface for building URL. Based on okhttp3.HttpUrl.Builder

This is compiling:

body {
  body {}
}

Response is rather verbose, especially accessing body content.

httpXXX { } .use {
        val content = it.body()?.string().asJson()
}

Need to observe other http clients and figure out how dsl approach can serve users for clear response consumption.

Previously EagerResponse was introduced, however it's usage is also rather complex

see OkHttpClient class

Customize your client with newBuilder()

 <p>You can customize a shared OkHttpClient instance with {@link #newBuilder()}. This builds a
 client that shares the same connection pool, thread pools, and configuration. Use the builder
 methods to configure the derived client for a specific purpose.

 <p>This example shows a call with a short 500 millisecond timeout:    {@code

   OkHttpClient eagerClient = client.newBuilder()
       .readTimeout(500, TimeUnit.MILLISECONDS)
       .build();
   Response response = eagerClient.newCall(request).execute();
 }

split into sections:

• string ext
• sync
• async

Retry interceptor should be configurable.

Please check LogInterceptor and SignInterceptor

please check: https://stackoverflow.com/questions/37883418/does-okhttpclient-have-a-max-retry-count

Please check this article https://developer.mozilla.org/ru/docs/Web/HTTP/%D0%97%D0%B0%D0%B3%D0%BE%D0%BB%D0%BE%D0%B2%D0%BA%D0%B8/Retry-After

Configuration 'compile' is obsolete and has been replaced with 'implementation' and 'api'.

The configuration for Gradle throws this. The Documentation is unclear on how to install it and where to add the lines in the build.gradle file.

At the moment we ignore url( ) parameters.

It would be better if we will add them as a primary source of params.

checklist:

• "path/?a=b"
• "path?a=b"
• "path/?a=b&c=&d=123"
• "path?a=b#tag"
• "path?a=xxx&a=&a=yyy

Valid json types include String, Number, Boolean, Null(empty), Object, Array

See the code

Currently Boolean and Null(empty) values are not supported.

Allow Android users to use kohttp

Currently most of tests are using only response code to validate results.
The idea is to read postman-echo documentation and check what exactly do we expect in response body. Most of responses are json with

• cookies
• headers
• etc

need to check all the expectations

There is wonderful Fuel library with very similar syntax and giant amount of improvements. At the moment there is no support for OkHttp but it should be not so hard to implement (just implement Client interface).

So @rybalkinsd maybe it makes sense to just implement OkHttpClient in Fuel library and not to reinvent entire library from scratch?

blogpost: https://www.jianshu.com/p/9566d361a5a8

very guess: client is not customized according to the load

I am sure you have good reasons for. But it took me longer than I am willing to admit to figure out why "okhttp3.Response" could not be resolved.

Could you either:

• change the scope to "compile"
• change the documentation so that new users will recognize that.

Analyse okhttp log interceptor
Figure out how to provide our own with minimal DSL configuration
Try to avoid any dependencies for this case.

From the first view okhttp-logging-interceptor's provides too verbose logs

Problem with gradle.build.kts

for now https://search.maven.org/artifact/io.github.rybalkinsd/kohttp/0.1.0/jar
contains

<dependency>
  <groupId>org.jetbrains.kotlin</groupId>
  <artifactId>kotlin-test-junit</artifactId>
  <version>1.2.60</version>
  <scope>test</scope>
</dependency>

rely on
https://www.slideshare.net/stormpath/rest-jsonapis

Create a prototype for kohttp/js

upgrade to 5.0
change nexus uploadArchive task

3.11.0 --> 3.12.0

Design and implement async get DSL.

Both suspend and async options should be provided.

There are different DSL options
1.

httpGet {
    mode = async
    ...
}

asyncHttpGet {
    ...
}

For more information see how httpGet { } and string extension for asyncHttpGet are implemented

Upload dsl and ext
Url()
Others

Too noisy notification about coverage reduction

checklist:

• remove any gradle plugins if possible
• upgrade gradle version also
• make sure tests are OK

related to #53