diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0602b5e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Do’s and Don’ts + +* **Search tickets before you file a new one.** Add to tickets if you have new information about the issue. +* **Keep tickets short but sweet.** Make sure you include all the context needed to solve the issue. Don't overdo it. Great tickets allow us to focus on solving problems instead of discussing them. +* **Take care of your ticket.** When you spend time to report a ticket with care we'll enjoy fixing it for you. +* **Use [GitHub-flavored Markdown](https://help.github.com/articles/markdown-basics/).** Especially put code blocks and console outputs in backticks (```` ``` ````). That increases the readability. Bonus points for applying the appropriate syntax highlighting. + +## Bug Reports + +In short, since you are most likely a developer, provide a ticket that you _yourself_ would _like_ to receive. + +First check if you are using the latest library version and Kotlin version before filing a ticket. + +Please include steps to reproduce and _all_ other relevant information, including any other relevant dependency and version information. + +## Feature Requests + +Please try to be precise about the proposed outcome of the feature and how it +would related to existing features. + + +## Pull Requests + +We **love** pull requests! + +All contributions _will_ be licensed under the Apache 2 license. + +Code/comments should adhere to the following rules: + +* Names should be descriptive and concise. +* Use four spaces and no tabs. +* Remember that source code usually gets written once and read often: ensure + the reader doesn't have to make guesses. Make sure that the purpose and inner + logic are either obvious to a reasonably skilled professional, or add a + comment that explains it. +* Please add a detailed description. + +If you consistently contribute improvements and/or bug fixes, we're happy to make you a maintainer. diff --git a/README.md b/README.md index 8a3a2ac..8369e11 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ repositories { } // Append dependency -implementation("com.icerockdev.service:fcm-push-service:0.1.1") +implementation("com.icerockdev.service:fcm-push-service:0.2.0") ```` ## Koin configure diff --git a/build.gradle b/build.gradle deleted file mode 100644 index 3f2e251..0000000 --- a/build.gradle +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright 2019 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license. - */ - -allprojects { - repositories { - mavenLocal() - mavenCentral() - jcenter() - maven { url "https://jitpack.io" } - } - - configurations { - provided - runtimeClasspath - } - - plugins.withId('org.jetbrains.kotlin.jvm', { _ -> - compileJava.dependsOn copyLibsCompile - sourceCompatibility=1.8 - }) - - task copyLibsCompile(type: Copy) { - from configurations.runtimeClasspath - into "$project.rootDir/build/libs/" -} -} - -task clean(type: Delete) { - delete rootProject.buildDir -} diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..6895817 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,32 @@ +/* + * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license. + */ + +allprojects { + repositories { + mavenLocal() + mavenCentral() + } + + configurations { + maybeCreate("runtimeClasspath") + maybeCreate("provided") + } + + val copyLibsCompileTask = tasks.create("copyLibsCompile", Copy::class.java) { + from(configurations["runtimeClasspath"]) + into(File(project.rootDir, "build/libs")) + } + + plugins.withId("org.jetbrains.kotlin.jvm") { + tasks.withType(JavaCompile::class.java).all { + dependsOn(copyLibsCompileTask) + sourceCompatibility = JavaVersion.VERSION_11.toString() + targetCompatibility = JavaVersion.VERSION_11.toString() + } + } +} + +tasks.create("clean", Delete::class.java) { + delete(rootProject.buildDir) +} diff --git a/fcm-push-service/build.gradle.kts b/fcm-push-service/build.gradle.kts index 1f95174..89d1670 100644 --- a/fcm-push-service/build.gradle.kts +++ b/fcm-push-service/build.gradle.kts @@ -5,7 +5,7 @@ import kotlin.text.String */ group = "com.icerockdev.service" -version = "0.1.1" +version = "0.2.0" plugins { id("org.jetbrains.kotlin.jvm") @@ -23,20 +23,17 @@ val sourcesJar by tasks.registering(Jar::class) { } dependencies { - // kotlin - implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:${properties["kotlin_version"]}") // logging implementation("ch.qos.logback:logback-classic:${properties["logback_version"]}") implementation("io.ktor:ktor-client-apache:${properties["ktor_version"]}") - api("org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:${properties["coroutines_version"]}") api("io.ktor:ktor-client-logging-jvm:${properties["ktor_version"]}") implementation("io.ktor:ktor-client-jackson:${properties["ktor_version"]}") // tests testImplementation("io.ktor:ktor-server-tests:${properties["ktor_version"]}") - testImplementation("io.ktor:ktor-client-mock:${properties["ktor_version"]}") + testImplementation(kotlin("test")) } java { diff --git a/fcm-push-service/src/test/kotlin/PushTest.kt b/fcm-push-service/src/test/kotlin/PushTest.kt index 90edf65..384612f 100644 --- a/fcm-push-service/src/test/kotlin/PushTest.kt +++ b/fcm-push-service/src/test/kotlin/PushTest.kt @@ -6,19 +6,32 @@ import com.fasterxml.jackson.databind.SerializationFeature import com.fasterxml.jackson.databind.util.StdDateFormat import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper import com.fasterxml.jackson.module.kotlin.registerKotlinModule -import com.icerockdev.service.fcmpush.* +import com.icerockdev.service.fcmpush.FCMConfig +import com.icerockdev.service.fcmpush.FCMMessage +import com.icerockdev.service.fcmpush.FCMPayLoad +import com.icerockdev.service.fcmpush.FCMResponse +import com.icerockdev.service.fcmpush.IPushRepository +import com.icerockdev.service.fcmpush.NotificationData +import com.icerockdev.service.fcmpush.PushService +import com.icerockdev.service.fcmpush.RequestData import io.ktor.client.HttpClient import io.ktor.client.engine.mock.MockEngine import io.ktor.client.engine.mock.respond -import io.ktor.http.* +import io.ktor.http.ContentType +import io.ktor.http.HttpHeaders +import io.ktor.http.HttpStatusCode +import io.ktor.http.Url import io.ktor.http.content.TextContent +import io.ktor.http.fullPath +import io.ktor.http.headersOf +import io.ktor.http.hostWithPort +import kotlin.test.assertEquals +import kotlin.test.assertNotNull import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.SupervisorJob import kotlinx.coroutines.runBlocking import org.junit.Test -import kotlin.test.assertEquals -import kotlin.test.assertNotNull class PushTest { private val validServerKey = "VALID_SERVER_KEY" @@ -77,8 +90,8 @@ class PushTest { ) } - var success = 0; - var failure = 0; + var success = 0 + var failure = 0 val messageList = ArrayList() for (token in data.registrationTokenList) { if (token == validClientToken) { @@ -169,4 +182,4 @@ class PushTest { assertEquals(0, result.success) assertEquals(1, result.failure) } -} \ No newline at end of file +} diff --git a/gradle.properties b/gradle.properties index 65c0928..97fa4ff 100644 --- a/gradle.properties +++ b/gradle.properties @@ -4,6 +4,6 @@ org.gradle.parallel=true logback_version=1.2.3 kotlin.code.style=official -kotlin_version=1.4.31 -coroutines_version=1.4.2 -ktor_version=1.5.2 +kotlin_version=1.6.10 +coroutines_version=1.6.0 +ktor_version=1.6.7 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c..41d9927 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 442d913..00e33ed 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 4f906e0..1b6c787 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # 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 +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${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='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # 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 - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + 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 @@ -106,80 +140,95 @@ 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 +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac 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 +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; 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 +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # 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\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg 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; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# -# 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" +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts index 514cb08..fd24c58 100644 --- a/sample/build.gradle.kts +++ b/sample/build.gradle.kts @@ -16,39 +16,36 @@ apply(plugin = "java") apply(plugin = "kotlin") repositories { - maven { url = uri("https://dl.bintray.com/icerockdev/backend") } + mavenCentral() } application { - mainClassName = "com.icerockdev.sample.Main" + mainClass.set("com.icerockdev.sample.Main") } dependencies { - implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:${properties["kotlin_version"]}") - -// implementation(project(":fcm-push-service")) - implementation("com.icerockdev.service:fcm-push-service:0.0.2") + implementation(project(":fcm-push-service")) } java { - sourceCompatibility = JavaVersion.VERSION_1_8 - targetCompatibility = JavaVersion.VERSION_1_8 + sourceCompatibility = JavaVersion.VERSION_11 + targetCompatibility = JavaVersion.VERSION_11 } tasks.withType { kotlinOptions { - jvmTarget = JavaVersion.VERSION_1_8.toString() + jvmTarget = JavaVersion.VERSION_11.toString() } } tasks.jar { - archiveName = "sample.jar" - destinationDir = file("${project.rootDir}/build") + archiveFileName.set("sample.jar") + destinationDirectory.set(file("${project.rootDir}/build")) manifest { attributes( - "Main-Class" to application.mainClassName, - "Class-Path" to configurations.runtimeClasspath.get().files.joinToString(" ") { "libs/${it.name}" } + "Main-Class" to application.mainClass, + "Class-Path" to configurations.runtimeClasspath.get().files.joinToString(" ") { "libs/${it.name}" } ) } } diff --git a/settings.gradle.kts b/settings.gradle.kts index 03125b0..8cd4118 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -5,13 +5,11 @@ pluginManagement { repositories { mavenLocal() gradlePluginPortal() - jcenter() google() maven { // The google mirror is less flaky than mavenCentral() url = uri("https://maven-central.storage-download.googleapis.com/repos/central/data/") } maven { url = uri ("https://plugins.gradle.org/m2/") } - maven { url = uri ("https://dl.bintray.com/kotlin/kotlin") } } resolutionStrategy { @@ -31,7 +29,7 @@ include(":fcm-push-service") val properties = startParameter.projectProperties // ./gradlew -PlibraryPublish publishToMavenLocal -// ./gradlew -DBINTRAY_USER=user -DBINTRAY_KEY=key -PlibraryPublish :fcm-push-service:publish +// ./gradlew :fcm-push-service:publish -PlibraryPublish val libraryPublish: Boolean = properties.containsKey("libraryPublish") if(!libraryPublish) { include(":sample")