codebasepk / requestsj

Inspired by Python's Requests

RequestsJ

Requests Java (Android, really)

DISCLAIMER: INSPIRED BY BUT NOT ASSOCIATED WITH https://github.com/psf/requests

Getting started

The build is hosted on jcenter so you could just add the line:

implementation 'pk.codebase.requests:requests:0.6'

Usage

The API is written for simplicity, below examples provide a peak into it.

GET

HttpRequest request = new HttpRequest();
request.setOnResponseListener(new HttpRequest.OnResponseListener() {
    @Override
    public void onResponse(HttpResponse response) {
        if (response.code == HttpResponse.HTTP_OK) {
            System.out.println(response.toJSONObject());
        }
    }
});
request.setOnErrorListener(new HttpRequest.OnErrorListener() {
    @Override
    public void onError(HttpError error) {
        // There was an error, deal with it
    }
});
request.get("https://httpbin.org/get");

POST

HttpRequest request = new HttpRequest();
request.setOnResponseListener(new HttpRequest.OnResponseListener() {
    @Override
    public void onResponse(HttpResponse response) {
        if (response.code == HttpResponse.HTTP_OK) {
            System.out.println(response.toJSONObject());
        }
    }
});
request.setOnErrorListener(new HttpRequest.OnErrorListener() {
    @Override
    public void onError(HttpError error) {
        // There was an error, deal with it
    }
});

JSONObject json;
try {
    json = new JSONObject();
    json.put("foo", "bar");
    json.put("jane", "doe");
} catch (JSONException ignore) {
    return;
}
request.post("https://httpbin.org/post", json);

PUT, PATCH and DELETE

These methods are also supported and expected the same set of parameters as POST. The convenience methods are request.put(); request.patch(); request.delete();

Custom Headers

Headers can be sent using the HttpHeaders class.

HttpHeaders headers = new HttpHeaders("Authorization", "Token sasdasdai2sadas")
request.get("https://httpbin.org/get", headers);

FormData

FormData data = new FormData();
data.put("foo", "bar");
data.put("file2", new File("/sdcard/image.png"));
request.post("https://httpbin.org/post", data);

requestsj's Issues

Optionally support URI for uploading a file.

Path is not easily accessible in android now, need to make another method that will take a Uri of the file and upload it.

Publish to maven central as jcenter is deprecated

Implement Proxy Support

Should support both SOCKS5 and HTTP proxy.

Add CompletableFuture based API option

We should support Java8' CompletableFuture. In Android it's only available on API level 24+. It will enable us to provide an alternate to the current callbacks approach.

NB: An issue for providing CompletableFuture for older versions of Android exists with upstream https://issuetracker.google.com/issues/153794291. With Android Studio 4.0 the new desugar support was improved and we may eventually see the upstream embrace it.