[REFERENCE ONLY DO NOT REVIEW!!!] Implement Mojang WebAPI, common user root class, and playerheads

.github/workflows/ci.yml

@@ -37,3 +37,25 @@ jobs:
       run: chmod +x gradlew
     - name: Run the license formatter checker
       run: ./gradlew licenseMain licenseTest
+  docs-test:
+    runs-on: ubuntu-latest
+    container:
+      image: jcxldn/openjdk-alpine:11-jdk
+    steps:
+      - uses: actions/checkout@v2
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Generate javadocs
+        run: ./gradlew javadoc
+      - name: Save docs artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: javadocs
+          path: build/docs/*
+      - name: Save failed javadocs options
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: javadocs-opts
+          path: build/tmp/javadoc/javadoc.options
+

CONTRIBUTING.md

@@ -6,7 +6,7 @@ This project is open for all developers for contribution, so it's important we e
 
 -   No pushing to master without opening a pull request (The only exceptions are small hotfixes, any new features or such MUST go in a new branch)
 -   Must be backwards compatible down to Java 11
--   Javadoc your code according to google's [Javadoc guidlines](https://google.github.io/styleguide/javaguide.html#s7-javadoc)
+-   Javadoc your code according to Google's [Javadoc guidlines](https://google.github.io/styleguide/javaguide.html#s7-javadoc)
 
 ## Pull Requests
 

build.gradle

@@ -6,6 +6,8 @@ plugins {
     id "com.github.hierynomus.license" version "0.15.0"
 }
 
+
+
 jacoco {
     // Use JaCoCo 0.8.6 for (experimental) support for Java 15 class files.
     toolVersion = "0.8.6"
@@ -25,6 +27,10 @@ license {
 tasks.withType(JavaCompile) {
     options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation" << "-XDignore.symbol.file"
 }
+
+javadoc{
+    options.addBooleanOption("-frames", true)
+}
 // Run the license formatter before compiling the source code.
 tasks.compileJava.dependsOn licenseFormatMain, licenseFormatTest
 
@@ -48,30 +54,37 @@ dependencies {
 
     compileOnly 'com.destroystokyo.paper:paper-api:1.16.4-R0.1-SNAPSHOT'
     compileOnly 'net.md-5:bungeecord-api:1.16-R0.4-SNAPSHOT'
+
     implementation 'org.jetbrains:annotations:20.1.0'
     implementation 'com.google.code.gson:gson:2.8.6'
     implementation 'io.github.classgraph:classgraph:4.8.92'
     implementation 'com.github.seancfoley:ipaddress:5.3.3'
+    implementation 'com.squareup.okhttp3:okhttp:4.9.0'
+    implementation 'commons-validator:commons-validator:1.7'
 
     // JUnit 5 Testing
-	testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.0")
-    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0")
+	testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'
 
     // Mocking
-    testImplementation("org.powermock:powermock-module-junit4:2.0.9")
-    testImplementation("org.powermock:powermock-api-mockito2:2.0.9")
-    testImplementation("org.powermock:powermock-module-junit4-rule:2.0.9")
-    testImplementation("org.powermock:powermock-classloading-xstream:2.0.9")
-    testImplementation("org.mockito:mockito-core:3.6.28")
+    testImplementation 'org.powermock:powermock-module-junit4:2.0.9'
+    testImplementation 'org.powermock:powermock-api-mockito2:2.0.9'
+    testImplementation 'org.powermock:powermock-module-junit4-rule:2.0.9'
+    testImplementation 'org.powermock:powermock-classloading-xstream:2.0.9'
+    testImplementation 'org.mockito:mockito-core:3.6.28'
+    testImplementation 'com.github.seeseemelk:MockBukkit-v1.16:0.5.0'
+    testImplementation 'it.unimi.dsi:fastutil:8.4.4'
 }
 
+
 test {
 	useJUnitPlatform()
 	testLogging {
 		events "passed", "skipped", "failed"
         // Show System.out for code ran by tests
         showStandardStreams = true
 	}
+    //ignoreFailures = true
     finalizedBy jacocoTestReport // report is always generated after tests run
 }
 
@@ -88,9 +101,22 @@ task sources(type: Jar, dependsOn: classes) {
     from sourceSets.main.allSource
 }
 
+tasks.delombok.shouldRunAfter(sources)
+
 
-tasks.publish.dependsOn build, sources
+tasks.publish.dependsOn build
+
+tasks.javadoc.dependsOn delombok
+javadoc {
+    options.addBooleanOption('XDignore.symbol.file', true)
+    options.addBooleanOption('-frames', true)
+}
+tasks.build.finalizedBy(sources)
 
+task rebuild {}
+tasks.rebuild.dependsOn build, clean
+tasks.build.shouldRunAfter(clean)
+tasks.javadoc.shouldRunAfter(clean)
 
 
 

gradle.properties

@@ -0,0 +1 @@
+systemProp.file.encoding=utf-8

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-compileJava.options.encoding=UTF-8

src/main/java/com/dumbdogdiner/stickyapi/StickyAPI.java

@@ -4,6 +4,7 @@
  */
 package com.dumbdogdiner.stickyapi;
 
+import java.io.InputStream;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.logging.Logger;
@@ -25,4 +26,15 @@ public class StickyAPI {
     @Getter
     @Setter
     private static ExecutorService pool = Executors.newCachedThreadPool();
+
+    /**
+     * Provides a wrapper for {@link java.lang.Class#getResourceAsStream(String)} (String)}
+     * @param resourceName The resource to get
+     * @return an {@link InputStream} to that resource
+     */
+    public static InputStream getResourceAsStream(String resourceName){
+        return StickyAPI.class.getResourceAsStream(resourceName);
+    }
+
+    private StickyAPI() {}
 }

src/main/java/com/dumbdogdiner/stickyapi/bukkit/command/AsyncCommand.java

@@ -30,7 +30,7 @@
  * 
  * @deprecated Use
  *             {@link com.dumbdogdiner.stickyapi.bukkit.command.BukkitCommandBuilder}
- *             as this will be removed in the next release
+ *             as this will be removed in a future release
  */
 @Deprecated
 public abstract class AsyncCommand extends Command implements PluginIdentifiableCommand {

src/main/java/com/dumbdogdiner/stickyapi/bukkit/command/ExitCode.java

@@ -10,8 +10,8 @@
  * Enum based exit codes for StickyAPI command classes.
  * 
  * @deprecated use {@link com.dumbdogdiner.stickyapi.common.command.ExitCode} as
- *             this will be removed in the next release
- * @see {@link com.dumbdogdiner.stickyapi.common.command.ExitCode}
+ *             this will be removed in a future release
+ * @see com.dumbdogdiner.stickyapi.common.command.ExitCode
  */
 @Deprecated
 public enum ExitCode {

src/main/java/com/dumbdogdiner/stickyapi/bukkit/generator/VoidGenerator.java

@@ -13,10 +13,11 @@
 /**
  * A class for generating empty void worlds
  */
+@SuppressWarnings("unused")
 public class VoidGenerator extends ChunkGenerator {
 
     @Override
-    public ChunkData generateChunkData(@NotNull World world, Random random, int x, int z, BiomeGrid biome) {
+    public @NotNull ChunkData generateChunkData(@NotNull World world, @NotNull Random random, int x, int z, @NotNull BiomeGrid biome) {
         return createChunkData(world);
     }
 }

src/main/java/com/dumbdogdiner/stickyapi/bukkit/item/generator/PlayerHeadGenerator.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
+ * Licensed under the MIT license, see LICENSE for more information...
+ */
+package com.dumbdogdiner.stickyapi.bukkit.item.generator;
+
+import com.destroystokyo.paper.profile.PlayerProfile;
+import com.destroystokyo.paper.profile.ProfileProperty;
+import com.dumbdogdiner.stickyapi.bukkit.user.StickyUserBukkit;
+import org.bukkit.Bukkit;
+import org.bukkit.Material;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.SkullMeta;
+import com.google.gson.Gson;
+
+import java.net.URL;
+import java.util.Base64;
+import java.util.UUID;
+
+public class PlayerHeadGenerator {
+    private SkullMeta meta = (SkullMeta) (new ItemStack(Material.PLAYER_HEAD, 1)).getItemMeta();
+
+    PlayerProfile ownerProfile;
+
+    public PlayerHeadGenerator(UUID playerId){
+        meta.setOwningPlayer(Bukkit.getOfflinePlayer(playerId));
+        ownerProfile = Bukkit.getServer().createProfile(playerId);
+    }
+
+    public PlayerHeadGenerator(Player player){
+        this(Bukkit.getOfflinePlayer(player.getUniqueId()));
+    }
+
+    public PlayerHeadGenerator(StickyUserBukkit player){
+        meta.setOwningPlayer(player.getAsBukkitPlayer());
+        ownerProfile = player.getAsBukkitPlayer().getPlayerProfile();
+    }
+
+    public PlayerHeadGenerator(OfflinePlayer player){
+        meta.setOwningPlayer(player);
+        ownerProfile = Bukkit.createProfile(player.getUniqueId());
+    }
+
+    public PlayerHeadGenerator(ItemStack head){
+        if(head.getType() != Material.PLAYER_HEAD && head.getType() != Material.PLAYER_WALL_HEAD)
+            throw new IllegalArgumentException("head must be a player head or player wall head");
+        meta = (SkullMeta) head.getItemMeta();
+        meta.getPlayerProfile();
+        if(!ownerProfile.hasTextures()){
+            if(!ownerProfile.complete()){
+                throw new IllegalArgumentException("Invalid player profile attached to the head, with no UUID or textures!");
+            }
+        }
+    }
+
+
+    public void setTexture(URL textureURL){
+        // {"textures":{"SKIN":{"url":"http://textures.minecraft.net/texture/63d621100fea5883922e78bb448056448c983e3f97841948a2da747d6b08b8ab"}}}
+        class textures {
+            SKIN skn;
+            public textures(String url){
+                skn = new SKIN(url);
+            }
+            class SKIN{
+                String url;
+                public SKIN(String s){
+                    url = s;
+                }
+            }
+        }
+
+        setTexture(new String(Base64.getEncoder().encode(new Gson().toJson(new textures(textureURL.toString())).getBytes())));
+    }
+
+    /**
+     * Set the texture with a pre-encoded string
+     * @param texture Base64 string of the json of texture location
+     */
+    public void setTexture(String texture){
+        ownerProfile.setProperty(new ProfileProperty("texture", texture));
+        meta.setPlayerProfile(ownerProfile);
+    }
+
+    public ItemStack getHead(){
+        return getHead(1);
+    }
+
+    public ItemStack getHead(int amount){
+        ItemStack head = new ItemStack(Material.PLAYER_HEAD, amount);
+        head.setItemMeta(meta);
+        return null;
+    }
+
+}

src/main/java/com/dumbdogdiner/stickyapi/bukkit/item/generator/SkullBuilder.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
+ * Licensed under the MIT license, see LICENSE for more information...
+ */
+package com.dumbdogdiner.stickyapi.bukkit.item.generator;
+
+import com.destroystokyo.paper.profile.PlayerProfile;
+import com.destroystokyo.paper.profile.ProfileProperty;
+import com.dumbdogdiner.stickyapi.common.util.textures.TextureHelper;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import org.apache.commons.lang.StringUtils;
+import org.bukkit.Bukkit;
+import org.bukkit.Material;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.SkullMeta;
+
+import java.util.UUID;
+
+
+public class SkullBuilder {
+    @Getter
+    private String filter = "*";
+    @Getter
+    private int quantity = 1;
+    @Getter
+    private String head;
+    @Accessors(fluent = true, chain = true)
+    @Setter @Getter
+    private String name;
+
+
+    public SkullBuilder() {
+
+    }
+
+    public SkullBuilder filter(String group) {
+        if (TextureHelper.getCategories().contains(group.toUpperCase())) {
+            filter = group.toUpperCase();
+        }
+        return this;
+    }
+
+    public SkullBuilder head(String head) {
+        head = head.toUpperCase();
+        if (TextureHelper.getTexture(filter, head) != null) {
+            this.head = head;
+        }
+        return this;
+    }
+
+    public SkullBuilder quantity(int i) {
+        if (i >= 0 && i <= 64) {
+            this.quantity = i;
+        }
+        return this;
+    }
+
+    public ItemStack build() {
+        SkullMeta meta = (SkullMeta) (new ItemStack(Material.PLAYER_HEAD, 1)).getItemMeta();
+        PlayerProfile profile = Bukkit.createProfile(new UUID(0, 0), null);
+
+        profile.setName(TextureHelper.asQualifiedName(filter, head));
+        if(name != null){
+            meta.setDisplayName(name);
+        } else {
+            meta.setDisplayName(StringUtils.capitalize(head));
+        }
+
+        profile.setProperty(new ProfileProperty("texture", TextureHelper.getTexture(filter, head)));
+        ItemStack head = new ItemStack(Material.PLAYER_HEAD, quantity);
+        head.setItemMeta(meta);
+        return head;
+    }
+}