Rest Client

This project aims to provide a simpler interface for RESTful JSON api calls. It also includes a fake implementation to make testing of client code easier.

Usage

To use the library from a program you will need to add a dependency to your project. In gradle you would do this by adding the following to your build.gradle file:

dependencies {
    compile 'com.github.michaelruocco:rest-client:0.1.5'
}

Basic Usage

You can then create and instance of the SimpleRestClient class to perform RESTful api calls e.g.

RestClient client = new SimpleRestClient();

Response getResponse = client.get("http://localhost:8080/testEndpoint");

Response postResponse = client.post("http://localhost:8080/testEndpoint", "{ json: body }");

Response putResponse = client.put("http://localhost:8080/testEndpoint", "{ json: body }");

Response deleteResponse = client.delete("http://localhost:8080/testEndpoint");

Setting Headers

For each of the calls you can also pass headers if you wish, e.g:

RestClient client = new SimpleRestClient();
Headers headers = new Headers();
headers.set("Custom-Header", "Value");

Response response = client.get("http://localhost:8080/testEndpoint", headers);

If you would rather encapsulate the header name values you can also use some of the default header implementations for common headers such as authorization bearer token and content type:

RestClient client = new SimpleRestClient();
Headers headers = new Headers();
headers.set(new BearerTokenHeader("my-token-value"));
headers.set(new ContentTypeHeader("application/json"));

Response response = client.get("http://localhost:8080/testEndpoint", headers);

These examples all extend BasicHeader, if you want to add others you can extend BasicHeader to create your own header types. If you would rather not maintain these yourself then you can create a pull request and commit them back into the project.

Bypassing / Disabling SSL

For testing purposes it is sometimes preferable to diasble SSL when making http calls if you don't want to have to package up a truststore with projects. To do this you can create an instance of InsecureSimpleHttpClient. It is only recommended that you do this when testing, and never in a production system.

RestClient client = new InsecureRestClient();

...

Testing

When testing you can make use of the FakeHttpClient, this allows you to set up canned responses as well as inspect any requests set into it. To test a simple PUT request we can use the fake client to assert on the request body:

public class Example {
    private final RestClient client;

    public Example(RestClient client) {
        this.client = client;
    }

    public void doPut(String jsonContent) {
        client.put("http://www.example.com", jsonContent);
    }
}

public class ExampleTest {

    @Test
    public void doesPut() throws IOException {
        FakeRestClient client = new FakeRestClient();
        Example example = new Example(client);

        String jsonContent = "{\"foo\": \"bar\"}";
        example.doPut(jsonContent);

        assertEquals(jsonContent, client.lastRequestBody());
    }
    
}

Running the Tests

You can run the tests for this project by running the following command:

gradlew clean build

Checking dependencies

You can check the current dependencies used by the project to see whether or not they are currently up to date by running the following command:

gradlew dependencyUpdates