com.vaushell.superpipes.tools.scribe.OAuthClient.java Source code

Java tutorial

Introduction

Here is the source code for com.vaushell.superpipes.tools.scribe.OAuthClient.java

Source

/*
 * Copyright (C) 2013 Fabien Vauchelles (fabien_AT_vauchelles_DOT_com).
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3, 29 June 2007, of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */

package com.vaushell.superpipes.tools.scribe;

import com.fasterxml.jackson.databind.JsonNode;
import com.vaushell.superpipes.tools.scribe.code.A_ValidatorCode;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import org.scribe.builder.ServiceBuilder;
import org.scribe.builder.api.Api;
import org.scribe.model.OAuthRequest;
import org.scribe.model.Response;
import org.scribe.model.Token;
import org.scribe.model.Verifier;
import org.scribe.oauth.OAuthService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * OAuth client pattern.
 *
 * @author Fabien Vauchelles (fabien_AT_vauchelles_DOT_com)
 */
public class OAuthClient {
    // PROTECTED
    protected OAuthClient() {
        this.key = null;
    }

    protected String getKey() {
        return key;
    }

    /**
     * Log in.
     *
     * @param api Scribe API class
     * @param key OAuth key
     * @param secret OAuth secret
     * @param scope OAuth scope (or null)
     * @param callback OAuth URL callback (or null)
     * @param useRequestToken OAuth use of request token ?
     * @param tokenPath Path to save the token
     * @param vCode How to get the verification code
     * @throws IOException
     * @throws java.lang.InterruptedException
     */
    protected void loginImpl(final Class<? extends Api> api, final String key, final String secret,
            final String scope, final String callback, final boolean useRequestToken, final Path tokenPath,
            final A_ValidatorCode vCode) throws IOException, InterruptedException {
        if (api == null || key == null || secret == null || tokenPath == null || vCode == null) {
            throw new IllegalArgumentException();
        }

        if (LOGGER.isTraceEnabled()) {
            LOGGER.trace("[" + getClass().getSimpleName() + "] loginImpl() : api=" + api + " / key=" + key
                    + " / scope=" + scope + " / callback=" + callback + " / useRequestToken=" + useRequestToken
                    + " / tokenPath=" + tokenPath);
        }

        this.key = key;

        final ServiceBuilder builder = new ServiceBuilder().provider(api).apiKey(this.key).apiSecret(secret);

        if (scope != null) {
            builder.scope(scope);
        }

        if (callback != null) {
            builder.callback(callback);
        }

        service = builder.build();

        accessToken = loadToken(tokenPath);
        if (accessToken == null) {
            // Get the request token
            final Token requestToken = useRequestToken ? service.getRequestToken() : null;

            // Making the user validate your request token
            final String authUrl = service.getAuthorizationUrl(requestToken);
            final String code = vCode.getValidationCode(authUrl);

            // Get the access Token
            final Verifier v = new Verifier(code);
            accessToken = service.getAccessToken(requestToken, v);

            saveToken(accessToken, tokenPath);
        }
    }

    /**
     * Change access token.
     *
     * @param newToken the new token
     */
    protected void changeAccessToken(final Token newToken) {
        if (newToken == null || newToken.getToken() == null) {
            throw new IllegalArgumentException();
        }

        if (LOGGER.isTraceEnabled()) {
            LOGGER.trace("[" + getClass().getSimpleName() + "] changeAccessToken() : newToken=" + newToken);
        }

        this.accessToken = newToken;
    }

    /**
     * Send a signed request.
     *
     * @param request the request
     * @return the response
     */
    protected Response sendSignedRequest(final OAuthRequest request) {
        if (request == null) {
            throw new IllegalArgumentException();
        }

        if (LOGGER.isTraceEnabled()) {
            LOGGER.trace("[" + getClass().getSimpleName() + "] sendSignedRequest() : request=" + request);
        }

        service.signRequest(accessToken, request);

        return request.send();
    }

    /**
     * Send a unsigned request.
     *
     * @param request the request
     * @return the response
     */
    protected Response sendUnsignedRequest(final OAuthRequest request) {
        if (request == null) {
            throw new IllegalArgumentException();
        }

        if (LOGGER.isTraceEnabled()) {
            LOGGER.trace("[" + getClass().getSimpleName() + "] sendUnsignedRequest() : request=" + request);
        }

        return request.send();
    }

    /**
     * Convert a string node to a string.
     *
     * @param node the node
     * @return a string or null if node is null
     */
    protected static String convertNodeToString(final JsonNode node) {
        if (node == null) {
            return null;
        } else {
            return node.asText();
        }
    }

    // PRIVATE
    private static final Logger LOGGER = LoggerFactory.getLogger(OAuthClient.class);
    private OAuthService service;
    private Token accessToken;
    private String key;

    private static Token loadToken(final Path path) throws IOException {
        if (path == null) {
            throw new IllegalArgumentException();
        }

        if (LOGGER.isTraceEnabled()) {
            LOGGER.trace("[" + OAuthClient.class.getSimpleName() + "] loadToken() : path=" + path);
        }

        if (Files.notExists(path)) {
            return null;
        }

        try (final BufferedReader bfr = Files.newBufferedReader(path, Charset.forName("utf-8"))) {
            final String token = bfr.readLine();
            final String secret = bfr.readLine();
            final String raw = bfr.readLine();

            if (raw == null) {
                return new Token(token, secret);
            } else {
                return new Token(token, secret, raw);
            }
        }
    }

    private static void saveToken(final Token accessToken, final Path path) throws IOException {
        if (path == null) {
            throw new IllegalArgumentException();
        }

        if (LOGGER.isTraceEnabled()) {
            LOGGER.trace("[" + OAuthClient.class.getSimpleName() + "] saveToken() : accessToken=" + accessToken
                    + " / path=" + path);
        }

        if (accessToken == null) {
            return;
        }

        if (Files.notExists(path.getParent())) {
            Files.createDirectories(path.getParent());
        }

        try (final BufferedWriter bfr = Files.newBufferedWriter(path, Charset.forName("utf-8"))) {
            bfr.write(accessToken.getToken());
            bfr.newLine();

            bfr.write(accessToken.getSecret());
            bfr.newLine();

            if (accessToken.getRawResponse() != null) {
                bfr.write(accessToken.getRawResponse());
                bfr.newLine();
            }
        }
    }
}