org.arkanos.pivotal_analytics.pivotal.Project.java Source code

Introduction

Here is the source code for org.arkanos.pivotal_analytics.pivotal.Project.java

Source

/**
 *  Copyright (C) 2014 Matheus Borges Teixeira
 *  
 *  This file is part of Pivotal Analytics, a web tool for statistical
 *  observation and measurement of Pivotal Projects.
 *
 *  Pivotal Analytics is free software: you can redistribute it and/or 
 *  modify it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program 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 Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with Pivotal Analytics.  If not, see <http://www.gnu.org/licenses/>
 */
package org.arkanos.pivotal_analytics.pivotal;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Vector;

import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;

/**
 * The {@code Project} class models a Pivotal Tracker Project.
 * 
 * Not all information provided by the Pivotal Tracker API is processed.
 * Only data relevant to Pivotal Analytics is extracted from the documents.
 *  
 * @version 1.0
 * @author Matheus Borges Teixeira
 */
public class Project {
    /** All Project Stories (Bugs, Features, Chores and Releases) **/
    private TicketSet stories;

    /** Current Iteration Number **/
    int current_iteration = 0;

    /** Iteration size in ms **/
    long iteration_size = 0;

    /** Exact date where the first Iteration starts **/
    Date iterations_start = null;

    /** Name of the Project **/
    String name;

    /** Name of the Company using the Project **/
    String company;

    /** User names lookup list **/
    UserLookup users;

    /** Map of stories per iteration according to Pivotal **/
    HashMap<String, Long> iteration_map;

    /**
     * Downloads and constructs a given project.
     * 
     * @param projectID specifies Pivotal ID reference to the Project.
     * @param token specifies User API Token from Pivotal.
     */
    public Project(int projectID, String token) {
        PivotalAPI api = new PivotalAPI(token);
        String downloaded = api.downloadProject(projectID);
        JSONParser jp = new JSONParser();
        try {
            JSONObject jo = (JSONObject) jp.parse(downloaded);
            String date_start = (String) jo.get("start_date");
            if (date_start == null) {
                iterations_start = new SimpleDateFormat("yyyy-MM-dd").parse("2013-01-01");
            } else {
                iterations_start = new SimpleDateFormat("yyyy-MM-dd").parse(date_start);
            }

            current_iteration = ((Long) jo.get("current_iteration_number")).intValue();

            long size = ((Long) jo.get("iteration_length")).longValue();
            iteration_size = size * 7 * 24 * 60 * 60 * 1000;

            name = (String) jo.get("name");
            company = (Long) jo.get("account_id") + "";

            downloaded = api.downloadUsers(projectID);

            JSONArray ja = (JSONArray) jp.parse(downloaded);

            users = new UserLookup();
            for (Object pm : ja.toArray()) {
                users.addUser((JSONObject) (((JSONObject) pm).get("person")));
            }

            loadStories(projectID, token);
        } catch (ParseException e) {
            System.out.println(
                    "[ERROR:ParseException] There was an Exception while parsing Pivotal Project Content, see error logs for stack trace.");
            e.printStackTrace();
        } catch (org.json.simple.parser.ParseException e) {
            System.out.println(
                    "[ERROR:ParseException] There was an Exception while parsing Pivotal Project JSON, see error logs for stack trace.");
            e.printStackTrace();
        }
    }

    /**
     * Downloads the stories for the project.
     * Method broken from constructor for clarity and modularization.
     * 
     * @param projectID specifies Pivotal ID reference to the Project.
     * @param token specifies User API Token from Pivotal.
     */
    private void loadStories(int projectID, String token) {
        PivotalAPI api = new PivotalAPI(token);
        Vector<String> downloaded = api.downloadProjectContent(projectID);
        JSONParser jp = new JSONParser();
        JSONArray list;
        try {
            stories = new TicketSet();
            int iteration = 0;
            for (String d : downloaded) {
                list = (JSONArray) jp.parse(d);
                for (int i = 0; i < list.size(); i++) {
                    Ticket t = new Ticket((JSONObject) list.get(i), users);
                    stories.add(t);
                    if (iteration > 0)
                        t.addMissingIterationLabel(iteration);
                }
                iteration++;
            }
        } catch (org.json.simple.parser.ParseException e) {
            System.out.println("[ERROR:json.ParseException] Error while parsing JSON information for the project.");
            e.printStackTrace();
        }
    }

    /**
     * Gets all stories.
     * @return stories.
     */
    public TicketSet getStories() {
        return stories;
    }

    /**
     * Gets when the Project (and iterations) started.
     * @return the date when iterations started.
     */
    public Date getStart() {
        return iterations_start;
    }

    /**
     * Gets the current iteration.
     * @return the current iteration.
     */
    public int getCurrentIteration() {
        return current_iteration;
    }

    /**
     * Gets the iteration size in ms.
     * @return the iteration size.
     */
    public long getIterationSize() {
        return iteration_size;
    }

    /**
     * Gets the project title.
     * @return the project title.
     */
    public String getDisplayName() {
        return "Account: " + company + ", " + name;
    }

}