Add document:update

[y-abs]

What does this PR do ?

This PR implements the document:update method with its unit tests.

How should this be manually tested?

Clone this branch and run unit tests
./gradlew test

When it succeed, compile it

./gradlew jar

Initiate another java project by adding the compiled SDK as a dependency.

Then, run Kuzzle, create an index nyc-open-data and a yellow-taxi collection in the admin console. Create a document with id some-id and content:

{
        "name" : "random"
}

Finally, run this code

import io.kuzzle.sdk.*;
import io.kuzzle.sdk.Options.KuzzleOptions;
import io.kuzzle.sdk.Options.Protocol.WebSocketOptions;
import io.kuzzle.sdk.Protocol.WebSocket;

import java.util.concurrent.ConcurrentHashMap;

public class updateDocument {
    private static Kuzzle kuzzle;

    public static void main(String[] args) {
        WebSocketOptions opts = new WebSocketOptions();
        opts.setAutoReconnect(true).setConnectionTimeout(42000);

        try {
            WebSocket ws = new WebSocket("localhost", opts);

            kuzzle = new Kuzzle(ws, (KuzzleOptions) null);

            kuzzle.connect();

            ConcurrentHashMap<String, Object> content = new ConcurrentHashMap<>();
            content.put("name", "not-so-random");

            ConcurrentHashMap<String, Object> options = new ConcurrentHashMap<>();
            options.put("source", true);

            ConcurrentHashMap<String, Object> response =
            kuzzle.getDocumentController().update("nyc-open-data", "yellow-taxi", "some-id", content, options)
            .get();
            System.out.println("Document updated!");
            System.out.println(response);
	}  catch (Exception e) {
            e.printStackTrace();
        }

        kuzzle.disconnect();
    }
};

You should see the document updated in your collection.
You can test without options as well

Other changes

Update subscribe documentation -> Remove non existing snippets
Remove class DocumentOptions and add a CreateOptions class

[scottinet]

I'm not sure that this test can pass. Can you add documentation snippet tests to travis to make sure of that?

[scottinet]

Same problems than in your other PR (#55)

[Aschen]

Can you add the result of the println in comment?
It helps developer to better apprehend the structure of the response object they have. We try to do this for every method (Look the Javascript SDK and Doc)

[Aschen]

You should let Kuzzle handle default values

Suggested change

	.put("retryOnConflict", _options != null ? _options.getNumber("retryOnConflict") : 0)
	.put("retryOnConflict", _options != null ? _options.getNumber("retryOnConflict") : null)

[y-abs]

When its null Kuzzle throw an error

[scottinet]

Confirmed, but this sounds like a bug in Kuzzle. So I fixed it: kuzzleio/kuzzle#1579

Aschen's point still stands.

[y-abs]

Okay thanks!
So unfortunately, until it's released, the snippet test will fail

[scottinet]

Ok I'm releasing kuzzle 2.1.1 then

[scottinet]

@Yoann-Abbes > kuzzle 2.1.1 released

[jenow]

We should have a DocumentOptions class containing waitForRefresh, retryOnConflict and source

[Aschen]

After @jenow request 👍

[scottinet]

I disagree with that name: that option class can only be passed to methods having a use for all its exposed options, namely waitForRefresh, retryOnConflict and source. These last 2 in particular are only relevant for update (and possibly mUpdate) methods.

You have to design 1 option class per "use" (in term of functionalities), meaning that all options must have meaning for a particular method. If you use a "DocumentOption" class for methods having no use for the retryOnConflict option for instance, then this can be hard for users to understand.

Rename this to UpdateOptions, DocumentUpdateOptions, or whatever is more fitting for this method.

[scottinet]

I just saw that DocumentOptions already existed prior to this PR, and that it contains an id option for methods such as document.create.

This makes my point even more relevant: the update method has no use for that id option, and this can even be very confusing for users, as the update method already takes an "id" argument.

[y-abs]

Changed 👍