com.github.aistomin.jenkins.real.RealUser Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2016, Istomin Andrei
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.aistomin.jenkins.real;

import com.github.aistomin.http.PostRequest;
import com.github.aistomin.iterators.Transformation;
import com.github.aistomin.jenkins.Credentials;
import com.github.aistomin.jenkins.User;
import com.github.aistomin.xml.XmlString;
import java.net.URLEncoder;

/**
 * Jenkins' user.
 *
 * @author Andrei Istomin ([email protected])
 * @version $Id$
 * @since 0.1
 */
public final class RealUser implements User {

    /**
     * API URL.
     */
    private final transient String api;

    /**
     * Jenkins credentials.
     */
    private final transient Credentials creds;

    /**
     * User's username.
     */
    private final transient String identifier;

    /**
     * Ctor.
     *
     * @param username User's username.
     * @param url API URL that returns users' details.
     * @param credentials Jenkins credentials
     */
    public RealUser(
        final String username, final String url, final Credentials credentials
    ) {
        this.api = url;
        this.creds = credentials;
        this.identifier = username;
    }

    @Override
    public String username() throws Exception {
        return this.identifier;
    }

    @Override
    public String fullName() throws Exception {
        return new XmlString(this.xml()).field("//user/fullName/text()");
    }

    @Override
    public String email() throws Exception {
        return new XmlString(this.xml()).field("//property/address/text()");
    }

    @Override
    public String url() throws Exception {
        return new XmlString(this.xml()).field("//user/absoluteUrl/text()");
    }

    @Override
    public String description() throws Exception {
        return new XmlString(this.xml()).field("//user/description/text()");
    }

    @Override
    public String xml() throws Exception {
        return new PostRequest(this.request(), this.creds.headers()).execute();
    }

    /**
     * Creates API URL to request Jenkins' user data.
     *
     * @return URL string.
     * @throws Exception If error occurred.
     */
    private String request() throws Exception {
        return String.format(
            "%s%s", this.api,
            String.format(
                "&xpath=people/user/user[id=%s]",
                URLEncoder.encode(
                    String.format("'%s'", this.identifier), "UTF-8"
                )
            )
        );
    }

    /**
     * Transformer for getting user by his id name.
     */
    public static final class Transformer implements
        Transformation {

        /**
         * API URL.
         */
        private final transient String api;

        /**
         * Jenkins credentials.
         */
        private final transient Credentials creds;

        /**
         * Ctor.
         * @param url API URL.
         * @param credentials Jenkins credentials.
         */
        public Transformer(final String url, final Credentials credentials) {
            this.api = url;
            this.creds = credentials;
        }

        @Override
        public User transform(final String source) {
            return new RealUser(source, this.api, this.creds);
        }
    }
}