net.nitrado.api.Nitrapi Maven / Gradle / Ivy
package net.nitrado.api;
import com.google.gson.*;
import net.nitrado.api.common.exceptions.NitrapiErrorException;
import net.nitrado.api.common.http.HttpClient;
import net.nitrado.api.common.http.Parameter;
import net.nitrado.api.common.http.ProductionHttpClient;
import net.nitrado.api.customer.Customer;
import net.nitrado.api.order.Dimension;
import net.nitrado.api.payment.Country;
import net.nitrado.api.payment.PaymentMethod;
import net.nitrado.api.services.Service;
import net.nitrado.api.services.ServiceFactory;
import net.nitrado.api.services.gameservers.GlobalGameList;
import java.io.InputStream;
import java.lang.reflect.Type;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Map;
/**
* Main class to interact with the Nitrapi.
*
* You create it by passing it the access token of the user.
* The next step is to get a list of services and then operate further using the service-specific classes.
*
* Every call on this api can throw a NitrapiHttpException when there is a problem connection to the api (e.g. the pc
* has no internet connection)
* and a NitrapiErrorException if there is a problem using the api (e.g. not enough permissions)
*/
public class Nitrapi {
/**
* Base url of the api.
*/
public static final String NITRAPI_LIVE_URL = "https://api.nitrado.net/";
private HttpClient client;
private String accessToken;
private String nitrapiUrl;
/**
* Gson object to convert the json-data
*/
private Gson gson;
private String applicationName = "nitrapi";
/**
* Creates a new Nitrapi with the given access token.
*
* @param accessToken access token for the user
*/
public Nitrapi(String accessToken) {
this(accessToken, NITRAPI_LIVE_URL);
}
/**
* Creates a new Nitrapi with the given access token and url.
*
* @param accessToken access token for the user
* @param nitrapiUrl url at which nitrapi is listening
*/
public Nitrapi(String accessToken, String nitrapiUrl) {
this.accessToken = accessToken;
this.client = new ProductionHttpClient();
this.nitrapiUrl = nitrapiUrl;
this.gson = new GsonBuilder().registerTypeAdapter(GregorianCalendar.class, new JsonDeserializer() {
public GregorianCalendar deserialize(JsonElement json, Type type, JsonDeserializationContext context) throws JsonParseException {
GregorianCalendar calendar = (GregorianCalendar) (GregorianCalendar.getInstance());
try {
String value = json.getAsString();
DateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
format.setLenient(false);
Date date = format.parse(value);
calendar.setTime(date);
return calendar;
} catch (JsonParseException e) {
throw new IllegalStateException("Invalid Json format to convert Calendar: " + e.getMessage());
} catch (ParseException e) {
throw new IllegalStateException("Error to convert Calendar: " + e.getMessage());
}
}
}).registerTypeAdapter(Dimension.DimensionValues.class, new Dimension.DimensionValuesDeserializer()).create();
}
/**
* Returns the current customer.
*
* @return the current customer
*/
public Customer getCustomer() {
return Customer.newInstance(this);
}
/**
* Returns a specific service.
*
* @param id id of the service
* @return the service specified by the id
*/
public Service getService(int id) {
JsonObject data = this.dataGet("services/" + id, null);
return ServiceFactory.factory(this, data.get("service"));
}
/**
* Returns a list of all services.
*
* @return a list of all services for the current user
*/
public Service[] getServices() {
JsonObject data = this.dataGet("services", null);
JsonArray serviceArray = data.get("services").getAsJsonArray();
ArrayList services = new ArrayList();
for (int i = 0; i < serviceArray.size(); i++) {
try {
services.add(ServiceFactory.factory(this, serviceArray.get(i)));
} catch (NitrapiErrorException exception) {
exception.printStackTrace();
}
}
return services.toArray(new Service[services.size()]);
}
/**
* Returns true if the api is operating as expected.
*
* @return true if the api is working. otherwise an exception is thrown
*/
public boolean ping() {
this.dataGet("ping", null);
return true;
}
/**
* Returns the full list of games.
*
* Contains all available games.
*
* @return a GlobalGameList object
*/
public GlobalGameList getGames() {
return GlobalGameList.newInstance(this);
}
// PAYMENT
public Country[] getPaymentCountries() {
JsonObject data = this.dataGet("order/payment/countries", null);
return gson.fromJson(data.get("countries"), Country[].class);
}
public PaymentMethod[] getPaymentMethods() {
JsonObject data = this.dataGet("order/payment/payment_methods", null);
data = data.get("payment_methods").getAsJsonObject();
ArrayList methods = new ArrayList(data.entrySet().size());
for (Map.Entry entry: data.entrySet()) {
PaymentMethod method = fromJson(entry.getValue(), PaymentMethod.class);
method.setId(entry.getKey());
methods.add(method);
}
return methods.toArray(new PaymentMethod[0]);
}
/**
* Returns the current limit of requests per hour for each user.
*
* @return the current limit of requests
*/
public int getRateLimit() {
return client.getRateLimit();
}
/**
* Returns the remaining requests for this hour and the current user.
*
* @return the remaining requests
*/
public int getRateLimitRemaining() {
return client.getRateLimitRemaining();
}
/**
* Returns the date when the limit resets for the current user.
*
* @return the date when the limit resets
*/
public long getRateLimitReset() {
return client.getRateLimitReset();
}
/**
* Changes the language of error messages
* @param lang two char language code
*/
public void setLanguage(String lang) {
client.setLanguage(lang);
}
public String getLanguage() {
return client.getLanguage();
}
// http client stuff
/**
* Used internally.
*
* Creates a GET-Request.
*
* @param url URL to call
* @param parameters parameters
* @return the result as a JsonObject
*/
public JsonObject dataGet(String url, Parameter[] parameters) {
return client.dataGet(nitrapiUrl + url, accessToken, parameters);
}
/**
* Used internally.
*
* Creates a POST-Request.
*
* @param url URL to call
* @param parameters parameters
* @return the result as a JsonObject
*/
public JsonObject dataPost(String url, Parameter[] parameters) {
return client.dataPost(nitrapiUrl + url, accessToken, parameters);
}
/**
* Used internally.
*
* Creates a DELETE-Request.
*
* @param url URL to call
* @param parameters parameters
* @return the result as a JsonObject
*/
public JsonObject dataDelete(String url, Parameter[] parameters) {
return client.dataDelete(nitrapiUrl + url, accessToken, parameters);
}
/**
* Used internally.
*
* Creates a GET-Request and returns the raw InputStream.
*
* @param url URL to call
* @return the InputStream of the response
*/
public InputStream rawGet(String url) {
return client.rawGet(url);
}
/**
* Used internally.
*
* Creates a POST-Request and returns the raw InputStream.
*
* @param url URL to call
* @param token access token of the current user
* @param body body of the POST-REQUEST
*/
public void rawPost(String url, String token, byte[] body) {
client.rawPost(url, token, body);
}
/**
* This method deserializes the Json read from the specified parse tree into an object of the specified type.
* @param json the root of the parse tree of JsonElements from which the object is to be deserialized
* @param tClass The class of T
* @param the type of the desired object
* @return an object of type T from the json. Returns null if json is null.
*/
public T fromJson(JsonElement json, Class tClass) {
return gson.fromJson(json, tClass);
}
/**
* Changes the HttpClient.
*
* @param httpClient new http client to use
*/
public void setHttpClient(HttpClient httpClient) {
this.client = httpClient;
}
/**
* Changes the url at which the Nitrapi is.
* @param url nitrapi url
*/
public void changeNitrapiUrl(String url) {
this.nitrapiUrl = url;
}
/**
* Changes the name of the application displayed in logs.
* @param name name of this application
*/
public void setApplicationName(String name) {
this.applicationName = name;
}
/**
* Returns the name of the application displayed in logs.
* @return the name of this application
*/
public String getApplicationName() {
return applicationName;
}
public String getAccessToken() {
return accessToken;
}
}