Skip to content

Commit

Permalink
Commit initial code based on that from progwml6/javacurseapi
Browse files Browse the repository at this point in the history
  • Loading branch information
progwml6 committed Jan 7, 2018
1 parent 98cea7f commit f4f347f
Show file tree
Hide file tree
Showing 73 changed files with 2,088 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
*~
bin/
.metadata/
*.jardesc
ftblaunch.cfg
target/
/target/
#eclipse
/.settings/
.project
.classpath
/bin/

#idea
/.idea
*.iml
.idea/
#gradle
/build
/.gradle

#mac
.DS_Store
*.ipr
*.iws
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Java library for CurseForge


## Contributions
* We take contributions for improving the library
* Please create feature branches and issue pull requests for the FTB Dev team to review before merging
* API Compatibility breaks MUST have version bumps to prevent breaking end users

## Building
* this library uses the gradle build system
* to build run `./gradlew build`
* artifacts are located in the `build/libs` folder

## Artifacts
* the main artifact is not shaded
* the javadocs & sources jars contain library javadoc/sources
* -all is a shaded jar with all dependencies

## sample code
* various sample usage code exists under the following packages:
* com.feed_the_beast.javacurseforgelib.examples.app_v1


## Maven Information
* javadoc & source jars are uploaded as well
* The library is deployed to progwml6's maven repo
```
maven {
name = 'DVS1'
url = 'http://dvs1.progwml6.com/files/maven'
}
```
and can be added as a gradle dependency as follows:
```
dependencies {
compile 'com.feed_the_beast:javacurseforgeapi:0.0.1.+'
}
```

## Project Lombok
* This project uses Lombok, for some IDE's plugins are required for lombok to work properly
* For Eclipse: https://projectlombok.org/setup/eclipse
* For Intellij: https://projectlombok.org/setup/intellij
* General Information: https://projectlombok.org/

148 changes: 148 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
plugins {
id 'java'
id 'maven'

id 'idea'
id 'eclipse'

id 'com.github.johnrengelman.shadow' version '2.0.2'
}



configurations {
deployerJars
}

repositories {
mavenCentral()
maven {
name = 'FTB'
url = 'http://ftb.cursecdn.com/FTB2/maven'
}
}

dependencies {
compile 'com.google.code.gson:gson:2.2.4'//JSON support

compile 'com.squareup.okhttp3:okhttp:3.4.1'

//these are versions used by minecraft which is one of the known planned uses of this library
compile 'commons-io:commons-io:2.4'//general utility classes
compile 'org.apache.commons:commons-lang3:3.3.2'
compile 'com.google.guava:guava:17.0'//general utility classes
compile 'com.google.code.findbugs:jsr305:1.3.9'//nonnull stuff
compile 'org.apache.commons:commons-compress:1.8.1'//bz2 decompression
compile 'org.projectlombok:lombok:1.16.8'

compile 'org.slf4j:slf4j-api:1.7.21'

compile 'org.isomorphism:token-bucket:1.6' //rate limiting
runtime 'org.slf4j:slf4j-simple:1.7.21'

compile 'org.javers:javers-core:3.7.8'

// test frameworks
testCompile 'junit:junit:4.12'
testCompile 'uk.co.datumedge:hamcrest-json:0.2'
testCompile 'org.powermock:powermock-module-junit4:1.6.3'
testCompile 'org.powermock:powermock-api-mockito:1.6.3'
testCompile 'org.powermock:powermock-module-junit4-rule-agent:1.6.3'
testCompile 'org.openjdk.jmh:jmh-core:1.12'
testCompile 'org.openjdk.jmh:jmh-generator-annprocess:1.12'
testCompile 'com.squareup.okhttp3:mockwebserver:3.4.1'
compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'

deployerJars 'org.apache.maven.wagon:wagon-ssh:2.2'
}

project.ext {
currentYear = '2018'
}
if (System.getenv().BUILD_NUMBER != null) {
ext.buildNum = System.getenv().BUILD_NUMBER
} else {
ext.buildNum = "9999999"
}

group = 'com.feed_the_beast'
version = "0.0.1.${project.buildNum}"
description = "Java CurseForge library"

sourceCompatibility = 1.8
targetCompatibility = 1.8
shadowJar {
dependencies {
exclude 'META-INF/*.DSA'
exclude 'META-INF/*.RSA'
exclude dependency('org.projectlombok:lombok')
}
classifier = 'all'
}


build.dependsOn(shadowJar)

jar {
manifest {
attributes 'Launcher-Jenkins': project.buildNum
}
}

allprojects {
tasks.withType(Javadoc) {
options.addStringOption('Xdoclint:none', '-quiet')
}
}

task sourceJar(type: Jar, dependsOn:classes) {
classifier = 'sources'
from sourceSets.main.allSource
}

task javadocJar(type: Jar, dependsOn:javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}

artifacts {
archives shadowJar
archives jar
archives sourceJar
archives javadocJar
}
def gitSha() {
return 'git rev-parse HEAD'.execute().text.trim()
}

if (project.hasProperty("local_maven")) {
apply plugin: 'maven'
uploadArchives {
repositories {
mavenDeployer {
repository(url: "file://${local_maven}")
}
}
}
}
if (project.hasProperty("remote_maven") && project.hasProperty("sftp_pass")) {
apply plugin: 'maven'
uploadArchives {
repositories.mavenDeployer {
configuration = configurations.deployerJars
repository(url: "sftp://${remote_maven}") {
authentication(userName: "${ftp_username}", password: "${sftp_pass}")
}
}
}
}


task dependencySizes << {
def size = 0
configurations.compile.files.each { file ->
println file.getName() + " " + file.size() + " bytes"
size += file.size()
}
println "Dependencies size: $size bytes"
}
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.4.1-bin.zip
172 changes: 172 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
#!/usr/bin/env sh

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi

exec "$JAVACMD" "$@"
Loading

0 comments on commit f4f347f

Please sign in to comment.