org.kohsuke.github.GHCommitBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of github-api Show documentation
GitHub API for Java
There is a newer version: 2.0.0-alpha-2
package org.kohsuke.github;

import java.io.IOException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.TimeZone;

// TODO: Auto-generated Javadoc
/**
 * Builder pattern for creating a new commit. Based on https://developer.github.com/v3/git/commits/#create-a-commit
 */
public class GHCommitBuilder {
    private final GHRepository repo;
    private final Requester req;

    private final List parents = new ArrayList();

    private static final class UserInfo {
        private final String name;
        private final String email;
        private final String date;

        private UserInfo(String name, String email, Date date) {
            this.name = name;
            this.email = email;
            TimeZone tz = TimeZone.getTimeZone("UTC");
            DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
            df.setTimeZone(tz);
            this.date = df.format((date != null) ? date : new Date());
        }
    }

    /**
     * Instantiates a new GH commit builder.
     *
     * @param repo
     *            the repo
     */
    GHCommitBuilder(GHRepository repo) {
        this.repo = repo;
        req = repo.root().createRequest().method("POST");
    }

    /**
     * Message gh commit builder.
     *
     * @param message
     *            the commit message
     * @return the gh commit builder
     */
    public GHCommitBuilder message(String message) {
        req.with("message", message);
        return this;
    }

    /**
     * Tree gh commit builder.
     *
     * @param tree
     *            the SHA of the tree object this commit points to
     * @return the gh commit builder
     */
    public GHCommitBuilder tree(String tree) {
        req.with("tree", tree);
        return this;
    }

    /**
     * Parent gh commit builder.
     *
     * @param parent
     *            the SHA of a parent commit.
     * @return the gh commit builder
     */
    public GHCommitBuilder parent(String parent) {
        parents.add(parent);
        return this;
    }

    /**
     * Configures the author of this commit.
     *
     * @param name
     *            the name
     * @param email
     *            the email
     * @param date
     *            the date
     * @return the gh commit builder
     */
    public GHCommitBuilder author(String name, String email, Date date) {
        req.with("author", new UserInfo(name, email, date));
        return this;
    }

    /**
     * Configures the PGP signature of this commit.
     *
     * @param signature
     *            the signature calculated from the commit
     *
     * @return the gh commit builder
     */
    public GHCommitBuilder withSignature(String signature) {
        req.with("signature", signature);
        return this;
    }

    /**
     * Configures the committer of this commit.
     *
     * @param name
     *            the name
     * @param email
     *            the email
     * @param date
     *            the date
     * @return the gh commit builder
     */
    public GHCommitBuilder committer(String name, String email, Date date) {
        req.with("committer", new UserInfo(name, email, date));
        return this;
    }

    private String getApiTail() {
        return String.format("/repos/%s/%s/git/commits", repo.getOwnerName(), repo.getName());
    }

    /**
     * Creates a blob based on the parameters specified thus far.
     *
     * @return the gh commit
     * @throws IOException
     *             the io exception
     */
    public GHCommit create() throws IOException {
        req.with("parents", parents);
        return req.method("POST").withUrlPath(getApiTail()).fetch(GHCommit.class).wrapUp(repo);
    }
}