me.shib.java.lib.jiraclient.greenhopper.SprintReport Maven / Gradle / Ivy

Go to download
package me.shib.java.lib.jiraclient.greenhopper;

import me.shib.java.lib.jiraclient.JiraException;
import me.shib.java.lib.jiraclient.RestClient;
import net.sf.json.JSON;
import net.sf.json.JSONObject;

import java.net.URI;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * GreenHopper sprint statistics.
 */
public class SprintReport {

    private RestClient restclient = null;
    private Sprint sprint = null;
    private List completedIssues = null;
    private List incompletedIssues = null;
    private List puntedIssues = null;
    private EstimateSum completedIssuesEstimateSum = null;
    private EstimateSum incompletedIssuesEstimateSum = null;
    private EstimateSum allIssuesEstimateSum = null;
    private EstimateSum puntedIssuesEstimateSum = null;
    private List issueKeysAddedDuringSprint = null;

    /**
     * Creates a sprint report from a JSON payload.
     *
     * @param restclient REST client instance
     * @param json       JSON payload
     */
    protected SprintReport(RestClient restclient, JSONObject json) {
        this.restclient = restclient;

        if (json != null)
            deserialise(json);
    }

    /**
     * Retrieves the sprint report for the given rapid view and sprint.
     *
     * @param restclient REST client instance
     * @param rv         Rapid View instance
     * @param sprint     Sprint instance
     * @return the sprint report
     * @throws JiraException when the retrieval fails
     */
    public static SprintReport get(RestClient restclient, RapidView rv, Sprint sprint)
            throws JiraException {

        final int rvId = rv.getId();
        final int sprintId = sprint.getId();
        JSON result = null;

        try {
            URI reporturi = restclient.buildURI(
                    GreenHopperResource.RESOURCE_URI + "rapid/charts/sprintreport",
                    new HashMap() {{
                        put("rapidViewId", Integer.toString(rvId));
                        put("sprintId", Integer.toString(sprintId));
                    }});
            result = restclient.get(reporturi);
        } catch (Exception ex) {
            throw new JiraException("Failed to retrieve sprint report", ex);
        }

        if (!(result instanceof JSONObject))
            throw new JiraException("JSON payload is malformed");

        JSONObject jo = (JSONObject) result;

        if (!jo.containsKey("contents") || !(jo.get("contents") instanceof JSONObject))
            throw new JiraException("Sprint report content is malformed");

        return new SprintReport(restclient, (JSONObject) jo.get("contents"));
    }

    private void deserialise(JSONObject json) {
        Map map = json;

        sprint = GreenHopperField.getResource(Sprint.class, map.get("sprint"), restclient);
        completedIssues = GreenHopperField.getResourceArray(
                SprintIssue.class,
                map.get("completedIssues"),
                restclient);
        incompletedIssues = GreenHopperField.getResourceArray(
                SprintIssue.class,
                map.get("incompletedIssues"),
                restclient);
        puntedIssues = GreenHopperField.getResourceArray(
                SprintIssue.class,
                map.get("puntedIssues"),
                restclient);
        completedIssuesEstimateSum = GreenHopperField.getEstimateSum(
                map.get("completedIssuesEstimateSum"));
        incompletedIssuesEstimateSum = GreenHopperField.getEstimateSum(
                map.get("incompletedIssuesEstimateSum"));
        allIssuesEstimateSum = GreenHopperField.getEstimateSum(
                map.get("allIssuesEstimateSum"));
        puntedIssuesEstimateSum = GreenHopperField.getEstimateSum(
                map.get("puntedIssuesEstimateSum"));
        issueKeysAddedDuringSprint = GreenHopperField.getStringArray(
                map.get("issueKeysAddedDuringSprint"));
    }

    public Sprint getSprint() {
        return sprint;
    }

    public List getCompletedIssues() {
        return completedIssues;
    }

    public List getIncompletedIssues() {
        return incompletedIssues;
    }

    public List getPuntedIssues() {
        return puntedIssues;
    }

    public EstimateSum getCompletedIssuesEstimateSum() {
        return completedIssuesEstimateSum;
    }

    public EstimateSum getIncompletedIssuesEstimateSum() {
        return incompletedIssuesEstimateSum;
    }

    public EstimateSum getAllIssuesEstimateSum() {
        return allIssuesEstimateSum;
    }

    public EstimateSum getPuntedIssuesEstimateSum() {
        return puntedIssuesEstimateSum;
    }

    public List getIssueKeysAddedDuringSprint() {
        return issueKeysAddedDuringSprint;
    }
}