evetool/src/uk/co/md87/evetool/api/EveApi.java

/*
 * Copyright (c) 2009 Chris Smith
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package uk.co.md87.evetool.api;

import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import uk.co.md87.evetool.api.io.ApiCache;
import uk.co.md87.evetool.api.io.ApiDownloader;
import uk.co.md87.evetool.api.parser.ApiElement;
import uk.co.md87.evetool.api.parser.ApiParser;
import uk.co.md87.evetool.api.parser.ApiResult;
import uk.co.md87.evetool.api.wrappers.CertificateTree;
import uk.co.md87.evetool.api.wrappers.CharacterList;
import uk.co.md87.evetool.api.wrappers.CharacterSheet;
import uk.co.md87.evetool.api.wrappers.MarketOrders;
import uk.co.md87.evetool.api.wrappers.RaceList;
import uk.co.md87.evetool.api.wrappers.ShipList;
import uk.co.md87.evetool.api.wrappers.SkillInTraining;
import uk.co.md87.evetool.api.wrappers.SkillList;
import uk.co.md87.evetool.api.wrappers.SkillQueue;

/**
 * Allows access to the EVE Api (see http://api.eve-online.com/).
 *
 * @author chris
 */
public class EveApi implements Cloneable {

    /** Logger to use for this class. */
    private static final Logger LOGGER = Logger.getLogger(EveApi.class.getName());

    /** Date format for dates returned by the API. */
    public static final String DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";

    /** The downloader to use. */
    private final ApiDownloader downloader;

    /** The cache to use. */
    private final ApiCache cache;
    
    /** The client's user ID, if specified. */
    private int userID;

    /** The client's character ID, if specified. */
    private int charID;

    /** The client's API key, if specified. */
    private String apiKey;

    /**
     * Creates a new instance of the EVE API client using the specified database
     * connection.
     *
     * @param cache The Cache implementation to use.
     */
    public EveApi(final ApiCache cache) {
        this.cache = cache;
        this.downloader = new ApiDownloader(cache, new ApiParser());
    }

    /**
     * Sets the API key used by this client.
     *
     * @param apiKey The user's API key
     */
    public void setApiKey(final String apiKey) {
        this.apiKey = apiKey;
    }

    /**
     * Sets the character ID used by this client.
     *
     * @param charID The user's chosen character ID
     */
    public void setCharID(final int charID) {
        this.charID = charID;
    }

    /**
     * Sets the user ID used by this client.
     *
     * @param userID The user's user ID
     */
    public void setUserID(final int userID) {
        this.userID = userID;
    }

    /**
     * Retrieves the character list for the user's account.
     * Requires a limited API key and user ID.
     *
     * @return The user's character list
     */
    public ApiResponse<CharacterList> getCharacterList() {
        return getResponse("/account/Characters.xml.aspx", CharacterList.class, true, false);
    }

    /**
     * Retrieves the character sheet for the specified character.
     * Requires a limited API key, user ID and character ID.
     *
     * @return The character's extended information
     */
    public ApiResponse<CharacterSheet> getCharacterSheet() {
        return getResponse("/char/CharacterSheet.xml.aspx", CharacterSheet.class, true, true);
    }

    /**
     * Retrieves the skill that's currently in training.
     * Requires a limited API key, user ID and character ID.
     *
     * @return The character's currently training skill
     */
    public ApiResponse<SkillInTraining> getSkillInTraining() {
        return getResponse("/char/SkillInTraining.xml.aspx", SkillInTraining.class, true, true);
    }

    /**
     * Retrieves the skill queue for the specified character.
     * Requires a limited API key, user ID and character ID.
     *
     * @return The character's current skill queue
     */
    public ApiResponse<SkillQueue> getSkillQueue() {
        return getResponse("/char/SkillQueue.xml.aspx", SkillQueue.class, true, true);
    }

    /**
     * Retrieves a list of market orders placed by the character.
     * Requires a limited API key, user ID and character ID.
     *
     * @return The character's market orders
     */
    public ApiResponse<MarketOrders> getMarketOrders() {
        return getResponse("/char/MarketOrders.xml.aspx", MarketOrders.class, true, true);
    }

    /**
     * Retrieves the full skill tree for EVE.
     * Does not require an API key.
     *
     * @return The complete EVE skill tree
     */
    public ApiResponse<SkillList> getSkillTree() {
        return getResponse("/eve/SkillTree.xml.aspx", SkillList.class, false, false);
    }

    /**
     * Retrieves the full certificate tree for EVE.
     * Does not require an API key.
     *
     * @return The complete EVE certificate tree
     */
    public ApiResponse<CertificateTree> getCertificateTree() {
        return getResponse("/eve/CertificateTree.xml.aspx", CertificateTree.class, false, false);
    }

    /**
     * Retrieves a list of ships in EVE.
     * Does not require an API key.
     *
     * @return A list of ships in EVE
     */
    public ApiResponse<ShipList> getShipList() {
        return getResponse("http://evetool.md87.co.uk/api/types.php?category=6"
                + "&published&attributes=requiredSkill%&groups", ShipList.class, false, false);
    }

    /**
     * Retrieves a list of races in EVE.
     * Does not require an API key.
     *
     * @return A list of races in EVE
     */
    public ApiResponse<RaceList> getRaceList() {
        return getResponse("http://evetool.md87.co.uk/api/races.php",
                RaceList.class, false, false);
    }

    /**
     * Utility method to send a request to the API and manufacture the
     * appropaite response objects.
     *
     * @param <T> The type of object that will be returned on success
     * @param method The method (path) of the API being used
     * @param type The class of object to return on success
     * @param needKey Whether or not an API key is needed
     * @param needChar Whether or not a character ID is needed
     * @return An appropriate ApiResponse encapsulating the request
     */
    protected <T> ApiResponse<T> getResponse(final String method, final Class<T> type,
            final boolean needKey, final boolean needChar) {
        final Map<String, String> args = new HashMap<String, String>();

        if (needKey) {
            args.put("userID", String.valueOf(userID));
            args.put("apiKey", apiKey);

            if (needChar) {
                args.put("characterID", String.valueOf(charID));
            }
        }

        final ApiResult result = downloader.getPage(method, args);

        if (result.wasSuccessful()) {
            try {
                return new ApiResponse<T>(type
                        .getConstructor(ApiElement.class)
                        .newInstance(result.getResultElement()), result);
            } catch (Exception ex) {
                LOGGER.log(Level.SEVERE, "Unable to create response object", ex);
            }

            return null;
        } else {
            return new ApiResponse<T>(result.getError(), result);
        }
    }

    /** {@inheritDoc} */
    @Override
    public EveApi clone() {
        final EveApi copy = new EveApi(cache);
        copy.setApiKey(apiKey);
        copy.setUserID(userID);
        copy.setCharID(charID);
        return copy;
    }

}