/*
 * Copyright (c) 2000-2018 TeamDev Ltd. All rights reserved.
 * TeamDev PROPRIETARY and CONFIDENTIAL.
 * Use is subject to license terms.
 */

package io.spine.web.parser;

import com.google.protobuf.Message;

import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Optional;

import static com.google.common.base.Preconditions.checkNotNull;
import static java.util.stream.Collectors.joining;

/**
 * A HTTP request to message parser.
 *
 * <p>The parser supports two string representation formats:
 * <ul>
 *     <li>JSON - <a href="https://developers.google.com/protocol-buffers/docs/proto3#json">
 *         the Protobuf JSON format</a>;
 *     <li>Base64 - the message bytes encoded in Base64.
 * </ul>
 *
 * <p>In order to specify either format, add the {@code Content-Type} header. The accepted values
 * are {@code application/json} and {@code application/x-protobuf}, case insensitive. If the header
 * is absent, the JSON format is expected. If the header value is not recognized, the parsing is
 * failed.
 *
 * @see MessageFormat
 * @author Dmytro Dashenkov
 */
public final class HttpMessages {

    /**
     * Prevents the utility class instantiation.
     */
    private HttpMessages() {
    }

    /**
     * Parses the body of the given request into a message of the given type.
     *
     * @param request the request with a JSON in its body
     * @param type    the class of message contained in the JSON
     * @param <M>     the type of the message to parse
     * @return parsed message or {@code Optional.empty()} if the message cannot be parsed
     * @throws IOException if the {@code request} throws the exception
     */
    public static <M extends Message> Optional<M> parse(HttpServletRequest request, Class<M> type)
            throws IOException {
        checkNotNull(request, type);
        final Optional<MessageFormat> format = MessageFormat.formatOf(request);
        final String requestBody = body(request);
        final Optional<M> message = format.map(messageFormat -> messageFormat.parserFor(type))
                                          .flatMap(parser -> parser.parse(requestBody));
        return message;
    }

    private static String body(ServletRequest request) throws IOException {
        final String result = request.getReader()
                                     .lines()
                                     .collect(joining(" "));
        return result;
    }
}

@@ -1087,16 +1087,403 @@
 led.%0A *%0A
+ * %3Cp%3EThere is a difference in behavior when parsing one or the other format.%0A * When parsing a JSON-encoded message, if an unknown field is found, the parsing is considered%0A * failed. In contrary, an unknown field in a Base64-encoded message does not fail parsing;%0A * the field can be found in the %7B@linkplain Message#getUnknownFields() unknown fields set%7D of%0A * the parsed message.%0A *%0A
  * @see 

Add some more doc for the `HttpMessages`.