More docs, bugfix, gitignore update

Author: dec4234

.gitignore

@@ -1,3 +1,3 @@
-/src/main/java/net/dec4234/javadestinyapi/jdaSrc/
 /.idea/
 /out/
+/src/main/java/Testing.java

README.md

@@ -34,7 +34,7 @@ If you happen to need a JAR version, check out [releases](https://github.com/dec
 You need to get an API key from [bungie.net/developer](https://bungie.net/developer)
 
 ```java
-DestinyAPI api = new DestinyAPI().setApiKey("YOUR API KEY HERE");
+DestinyAPI api = new DestinyAPI("YOUR API KEY HERE");
 ```
 **IMPORTANT:** *DestinyAPI MUST be the first thing initialized before making any interactions with the API! This is because
 all interactions with the API rely on the API Key set in DestinyAPI.*

src/main/java/net/dec4234/javadestinyapi/material/DestinyAPI.java

@@ -38,6 +38,13 @@ public class DestinyAPI {
 
     private static HttpUtils httpUtils;
 
+    // Force set API key
+    private DestinyAPI() {}
+
+    public DestinyAPI(String apiKey) {
+        setApiKey(apiKey);
+    }
+
     /**
      * Set the api key used by the DestinyAPI
      */
@@ -52,66 +59,82 @@ public DestinyAPI setApiKey(String apiKey) {
         return this;
     }
 
+    /**
+     * Sets the internal client ID, needed for OAuth generation
+     * @param clientId The client ID
+     * @return This DestinyAPI instance
+     */
     public DestinyAPI setClientID(String clientId) {
         DestinyAPI.clientId = clientId;
         return this;
     }
 
+    /**
+     * Sets the internal client secret
+     * @param clientSecret The client secret
+     * @return This DestinyAPI instance
+     */
     public DestinyAPI setClientSecret(String clientSecret) {
         DestinyAPI.clientSecret = clientSecret;
         return this;
     }
 
+    /**
+     * Set the oauth code used to generate access and refresh tokens
+     * @param oauthCode The oauth code
+     * @return This DestinyAPI instance
+     */
     public DestinyAPI setOauthCode(String oauthCode) {
         DestinyAPI.oauthCode = oauthCode;
         return this;
     }
 
-    public DestinyAPI setAccessToken(String accessToken) {
+    /**
+     * Sets the OAuth Access token. This is typically an internal function only, but is provided for convenience.
+     * @param accessToken The OAuth access token
+     * @return This DestinyAPI instance
+     */
+    public static void setAccessToken(String accessToken) {
         DestinyAPI.accessToken = accessToken;
         if (hasOauthManager()) {
             oam.setAccessToken(accessToken);
         }
-        return this;
     }
 
-    public DestinyAPI setRefreshToken(String refreshToken) {
+    /**
+     * Sets the OAuth refresh token. This is typically an internal function only, but is provided for convenience.
+     * @param refreshToken The OAuth refresh token
+     * @return This DestinyAPI instance
+     */
+    public static void setRefreshToken(String refreshToken) {
         DestinyAPI.refreshToken = refreshToken;
         if (hasOauthManager()) {
             oam.setRefreshToken(refreshToken);
         }
-        return this;
     }
 
     /**
-     * Debug mode prints all requests and their responses to the console
-     * This is very useful for feature development
+     * Debug mode prints all requests and their responses to the console.
+     * <br>
+     * WARNING: This could expose sensitive information, this is for development ONLY
      */
-    public DestinyAPI enableDebugMode() {
+    public static void enableDebugMode() {
         DestinyAPI.debugEnabled = true;
-
-        return this;
     }
 
     /**
      * Disable debug mode
      */
-    public DestinyAPI disableDebugMode() {
+    public static void disableDebugMode() {
         DestinyAPI.debugEnabled = false;
-
-        return this;
     }
 
     /**
      * Set the OAuth management class
      * The class passed in this parameter must "extends OAuthManager"
      */
-    public DestinyAPI setOauthManager(OAuthManager oam) {
+    public static void setOauthManager(OAuthManager oam) {
         DestinyAPI.oam = oam;
-        // setApiKey(oam.getAPIToken());
-        // setAccessToken(oam.getAccessToken());
-
-        return this;
     }
 
     /**
@@ -225,8 +248,9 @@ public static BungieUser getUserWithName(String nameAndDiscrim) throws APIExcept
      * Search users across all platforms for anyone with that name.
      * <p>
      * Searching "dec4234" will return an array containing a single
-     * BungieUser. While searching "Gladd" or "Datto" should return
-     * multiple.
+     * BungieUser. While searching "Gladd" or "Datto" should return many users.
+     * <p>
+     * // TODO: Issue #16
      */
     public static List<BungieUser> searchUsers(String name) throws APIException {
         List<BungieUser> users = new ArrayList<>();

src/main/java/net/dec4234/javadestinyapi/material/user/BungieUser.java

@@ -383,7 +383,7 @@ public DestinyCharacter getCharacterOfType(DestinyCharacter.DestinyClass destiny
 	}
 
 	/**
-	 * Adds up all of the time played across all characters in minutes
+	 * Adds up all the time played across all characters in minutes
 	 *
 	 * @return The time played of this user, in minutes
 	 */

src/main/java/net/dec4234/javadestinyapi/utils/HttpUtils.java

@@ -36,7 +36,7 @@ public class HttpUtils {
 
 	public static final String URL_BASE = "https://www.bungie.net/Platform";
 
-	private String apiKey = DestinyAPI.getApiKey();
+	private String apiKey;
 	private static String bearerToken;
 
 	public HttpUtils(String apiKey) {
@@ -171,7 +171,8 @@ public String setTokenViaRefresh() throws APIException {
 		String at = response.get("access_token").getAsString();
 		String rt = response.get("refresh_token").getAsString();
 		bearerToken = at;
-		new DestinyAPI().setAccessToken(at).setRefreshToken(rt);
+		DestinyAPI.setAccessToken(at);
+		DestinyAPI.setRefreshToken(rt);
 
 		if(DestinyAPI.isDebugEnabled()) {
 			System.out.println("TOKENS REFRESHED");
@@ -181,7 +182,7 @@ public String setTokenViaRefresh() throws APIException {
 	}
 
 	/**
-	 * Requries an OAuthCode to be manually set inside of the DestinyAPI.setOAuthCode()
+	 * Requries an OAuthCode to be manually set inside the DestinyAPI.setOAuthCode()
 	 */
 	public void setTokenViaAuth() throws APIException {
 		setTokenViaAuth(DestinyAPI.getOauthCode());
@@ -203,11 +204,26 @@ public void setTokenViaAuth(String oAuthCode) throws APIException {
 		String accessToken = jsonObject.get("access_token").getAsString();
 		String refreshToken = jsonObject.get("refresh_token").getAsString();
 
-		new DestinyAPI().setAccessToken(accessToken).setRefreshToken(refreshToken);
+		DestinyAPI.setRefreshToken(refreshToken);
+		DestinyAPI.setAccessToken(accessToken);
 
 		HttpUtils.bearerToken = accessToken;
 	}
 
+	public boolean hasValidOAuthTokens() throws APIException {
+		boolean value = DestinyAPI.hasOauthManager() && DestinyAPI.getAccessToken() != null && DestinyAPI.getHttpUtils().setTokenViaRefresh() != null;
+
+		if(value) {
+			try {
+				DestinyAPI.getHttpUtils().setTokenViaRefresh();
+			} catch (AccessTokenExpiredException | RefreshTokenExpiredException | OAuthUnauthorizedException e) {
+				value = false;
+			}
+		}
+
+		return value;
+	}
+
 	private JsonObject getJsonObject(HttpRequest httpRequest) throws APIException {
 		HttpClient httpClient = HttpClient.newHttpClient();
 		String responseString;

src/main/java/net/dec4234/javadestinyapi/utils/framework/JDAOAuth.java

@@ -8,9 +8,9 @@
 package net.dec4234.javadestinyapi.utils.framework;
 
 /**
- * Contains all of the functions needed for the API to adequately store OAuth tokens.
+ * Contains all the functions needed for the API to adequately store OAuth tokens.
  * <br>
- * Note: OAuth could allow potenially dangerous actions such as full control over your clan (if you are an admin) as
+ * Note: OAuth could allow potentially dangerous actions such as full control over your clan (if you are an admin) as
  * well as your inventory. Use at your own risk, and use good data management and protection practices.
  */
 public interface JDAOAuth {

…estinyapi/jdaSrc/JavaDestinyAPIMain.java …pi/utils/framework/JsonOAuthManager.javasrc/main/java/net/dec4234/javadestinyapi/jdaSrc/JavaDestinyAPIMain.java renamed to src/main/java/net/dec4234/javadestinyapi/utils/framework/JsonOAuthManager.java src/main/java/net/dec4234/javadestinyapi/jdaSrc/JavaDestinyAPIMain.java renamed to src/main/java/net/dec4234/javadestinyapi/utils/framework/JsonOAuthManager.java

@@ -5,7 +5,7 @@
  * Github -> https://github.com/dec4234/JavaDestinyAPI
  */
 
-package net.dec4234.javadestinyapi.jdaSrc;
+package net.dec4234.javadestinyapi.utils.framework;
 
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
@@ -15,12 +15,19 @@
 import java.io.*;
 import java.nio.file.Paths;
 
-public class JavaDestinyAPIMain extends OAuthManager {
+/**
+ * This class is provided for convenience for local apps using OAuth. It is also provided as a template for what
+ * you should do to implement your own token manager.
+ * <br>
+ * The author assumes no responsibility for the use of this class. It is unsafe to use this in a production environment,
+ * proceed with your own risk.
+ */
+public class JsonOAuthManager extends OAuthManager {
 
 	private File file = new File(Paths.get("").toAbsolutePath() + "\\oauth.json");
 	private JsonObject jsonObject;
 
-	public JavaDestinyAPIMain() {
+	public JsonOAuthManager() {
 		try {
 			if (!file.exists()) {
 				file.createNewFile();