netbout-spi-1.5.src.main.java.com.netbout.spi.client.RestSession Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2009-2012, Netbout.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met: 1) Redistributions of source code must retain the above
 * copyright notice, this list of conditions and the following
 * disclaimer. 2) Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided
 * with the distribution. 3) Neither the name of the NetBout.com nor
 * the names of its contributors may be used to endorse or promote
 * products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.netbout.spi.client;

import com.jcabi.log.Logger;
import com.netbout.spi.Identity;
import com.netbout.spi.Urn;
import com.rexsl.test.RestTester;
import java.net.HttpURLConnection;
import java.net.URI;
import javax.ws.rs.core.UriBuilder;
import org.hamcrest.Matchers;

/**
 * Restful session.
 *
 * @author Yegor Bugayenko ([email protected])
 * @version $Id: RestSession.java 3338 2012-09-11 11:05:55Z guard $
 */
public final class RestSession {

    /**
     * Authentication header.
     */
    public static final String AUTH_HEADER = "Netbout-auth";

    /**
     * HTTP header with error message.
     */
    public static final String ERROR_HEADER = "Netbout-error";

    /**
     * Authentication query param.
     */
    public static final String AUTH_PARAM = "auth";

    /**
     * Super user authentication query param.
     */
    public static final String SUDO_PARAM = "sudo";

    /**
     * Bundle turning ON/OFF in inbox.
     */
    public static final String BUNDLE_PARAM = "bundle";

    /**
     * Name of the user authentication cookie.
     */
    public static final String AUTH_COOKIE = "netbout";

    /**
     * Log holder cookie.
     */
    public static final String LOG_COOKIE = "netbout-log";

    /**
     * Name of the message transferring cookie.
     */
    public static final String MESSAGE_COOKIE = "netbout-msg";

    /**
     * Next-to-go URL.
     */
    public static final String GOTO_COOKIE = "netbout-goto";

    /**
     * Query param to search INBOX.
     */
    public static final String QUERY_PARAM = "q";

    /**
     * Home URI.
     */
    private final transient URI home;

    /**
     * Super user secret word.
     */
    private final transient String sudo;

    /**
     * Public ctor.
     * @param uri Home URI
     * @param secret Super user secret
     */
    public RestSession(final URI uri, final String secret) {
        if (!uri.isAbsolute()) {
            throw new IllegalArgumentException(
                Logger.format(
                    "URI '%s' has to be absolute",
                    uri
                )
            );
        }
        this.sudo = secret;
        this.home = UriBuilder.fromUri(uri).path("/").build();
    }

    /**
     * Public ctor.
     * @param uri Home URI
     */
    public RestSession(final URI uri) {
        this(uri, "");
    }

    /**
     * Get identity in the session through Netbout authentication mechanism.
     * @param iname Name of the identity
     * @param secret The secret word to use
     * @return The identity to work with
     */
    public Identity authenticate(final Urn iname, final String secret) {
        return new RestIdentity(
            new RexslRestClient(
                RestTester.start(this.home),
                this.fetch(iname, secret)
            )
        );
    }

    /**
     * Fetch auth code.
     * @param identity Name of the identity
     * @param secret The secret word to use
     * @return The URL
     */
    private String fetch(final Urn identity, final String secret) {
        final URI uri = this.uri(identity, secret);
        final String token = RestTester.start(uri)
            .get("authorization")
            .assertThat(new EtaAssertion())
            .assertStatus(HttpURLConnection.HTTP_SEE_OTHER)
            .assertHeader(
                RestSession.AUTH_HEADER,
                Matchers.not(Matchers.emptyIterableOf(String.class))
            )
            .getHeaders()
            .getFirst(RestSession.AUTH_HEADER);
        Logger.debug(
            this,
            "#fetch('%s', '%s'): '%s' authenticated us as '%s'",
            identity,
            secret,
            uri,
            token
        );
        return token;
    }

    /**
     * Create auth URI.
     * @param identity Name of the identity
     * @param secret The secret word to use
     * @return The URI
     */
    private URI uri(final Urn identity, final String secret) {
        URI uri = UriBuilder.fromUri(this.home)
            .path("/auth")
            .queryParam("identity", "{identity}")
            .queryParam("secret", "{secret}")
            .build(identity.toString(), secret);
        if (!this.sudo.isEmpty()) {
            uri = UriBuilder.fromUri(uri)
                .queryParam(RestSession.SUDO_PARAM, "{sudo}")
                .build(this.sudo);
        }
        return uri;
    }

}