erik/jokeapi
erik/jokeapi
1
1
Fork 0
Code Issues Releases Activity

Added configuration builder

Browse source
This commit is contained in:
Erik C. Thauvin 2022-09-26 14:22:13 -07:00
parent a2636f404d
commit 6925d68db7
8 changed files with 241 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

33
src/main/kotlin/net/thauvin/erik/jokeapi/JokeApi.kt
View file

@ -94,7 +94,6 @@ class JokeApi {
}
@JvmStatic
@JvmOverloads
@Throws(HttpErrorException::class, IOException::class)
fun getRawJoke(
categories: Set<Category> = setOf(Category.ANY),
@ -171,6 +170,22 @@ class JokeApi {
return apiCall(JOKE_ENDPOINT, path, params)
}
@JvmStatic
@Throws(HttpErrorException::class, IOException::class)
fun getRawJoke(config: JokeConfig): String {
return getRawJoke(
categories = config.categories,
language = config.language,
flags = config.flags,
type = config.type,
format = config.format,
search = config.search,
idRange = config.idRange,
amount = config.amount,
safe = config.safe
)
}
@Throws(HttpErrorException::class, IOException::class)
internal fun fetchUrl(url: String): String {
if (logger.isLoggable(Level.FINE)) {
@ -251,7 +266,6 @@ class JokeApi {
}
@JvmStatic
@JvmOverloads
@Throws(JokeException::class, HttpErrorException::class, IOException::class)
fun getJoke(
categories: Set<Category> = setOf(Category.ANY),
@ -312,5 +326,20 @@ class JokeApi {
)
}
}
@JvmStatic
@Throws(JokeException::class, HttpErrorException::class, IOException::class)
fun getJoke(config: JokeConfig): Joke {
return getJoke(
categories = config.categories,
language = config.language,
flags = config.flags,
type = config.type,
search = config.search,
idRange = config.idRange,
safe = config.safe,
splitNewLine = config.splitNewLine
)
}
}
}

81
src/main/kotlin/net/thauvin/erik/jokeapi/JokeConfig.kt Normal file
View file

@ -0,0 +1,81 @@
/*
* Configuration.kt
*
* Copyright (c) 2022, Erik C. Thauvin (erik@thauvin.net)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of this project nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.jokeapi
import net.thauvin.erik.jokeapi.models.Category
import net.thauvin.erik.jokeapi.models.Flag
import net.thauvin.erik.jokeapi.models.Format
import net.thauvin.erik.jokeapi.models.IdRange
import net.thauvin.erik.jokeapi.models.Language
import net.thauvin.erik.jokeapi.models.Type
class JokeConfig private constructor(
val categories: Set<Category>,
val language: Language,
val flags: Set<Flag>,
val type: Type,
val format: Format,
val search: String,
val idRange: IdRange,
val amount: Int = 1,
val safe: Boolean,
val splitNewLine: Boolean,
) {
data class Builder(
var categories: Set<Category> = setOf(Category.ANY),
var language: Language = Language.ENGLISH,
var flags: Set<Flag> = emptySet(),
var type: Type = Type.ALL,
var format: Format = Format.JSON,
var search: String = "",
var idRange: IdRange = IdRange(),
var amount: Int = 1,
var safe: Boolean = false,
var splitNewLine: Boolean = true
) {
fun categories(categories: Set<Category>) = apply { this.categories = categories }
fun language(language: Language) = apply { this.language = language }
fun flags(flags: Set<Flag>) = apply { this.flags = flags }
fun type(type: Type) = apply { this.type = type }
fun format(format: Format) = apply { this.format = format }
fun search(search: String) = apply { this.search = search }
fun idRange(idRange: IdRange) = apply { this.idRange = idRange }
fun amount(amount: Int) = apply { this.amount = amount }
fun safe(safe: Boolean) = apply { this.safe = safe }
fun splitNewLine(splitNewLine: Boolean) = apply { this.splitNewLine = splitNewLine }
fun build() = JokeConfig(
categories, language, flags, type, format, search, idRange, amount, safe, splitNewLine
)
}
}

2
src/test/kotlin/net/thauvin/erik/jokeapi/GetJokeTest.kt
View file

@ -32,10 +32,8 @@
package net.thauvin.erik.jokeapi
import net.thauvin.erik.jokeapi.JokeApi.Companion.fetchUrl
import net.thauvin.erik.jokeapi.JokeApi.Companion.getJoke
import net.thauvin.erik.jokeapi.JokeApi.Companion.logger
import net.thauvin.erik.jokeapi.exceptions.HttpErrorException
import net.thauvin.erik.jokeapi.exceptions.JokeException
import net.thauvin.erik.jokeapi.models.Category
import net.thauvin.erik.jokeapi.models.Flag

101
src/test/kotlin/net/thauvin/erik/jokeapi/JokeConfigTest.kt Normal file
View file

@ -0,0 +1,101 @@
/*
* JokeConfigTest.kt
*
* Copyright (c) 2022, Erik C. Thauvin (erik@thauvin.net)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of this project nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.thauvin.erik.jokeapi
import net.thauvin.erik.jokeapi.JokeApi.Companion.getJoke
import net.thauvin.erik.jokeapi.JokeApi.Companion.getRawJoke
import net.thauvin.erik.jokeapi.JokeApi.Companion.logger
import net.thauvin.erik.jokeapi.models.Category
import net.thauvin.erik.jokeapi.models.Flag
import net.thauvin.erik.jokeapi.models.Format
import net.thauvin.erik.jokeapi.models.IdRange
import net.thauvin.erik.jokeapi.models.Language
import net.thauvin.erik.jokeapi.models.Type
import org.junit.jupiter.api.Assertions.assertAll
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.BeforeAll
import org.junit.jupiter.api.Test
import java.util.logging.ConsoleHandler
import java.util.logging.Level
class JokeConfigTest {
@Test
fun `Get Joke with Builder`() {
val id = 266
val config = JokeConfig.Builder().apply {
categories(setOf(Category.PROGRAMMING))
language(Language.EN)
flags(setOf(Flag.ALL))
type(Type.TWOPART)
idRange(IdRange(id - 2, id + 2))
safe(true)
splitNewLine(false)
}.build()
val joke = getJoke(config)
logger.fine(joke.toString())
assertAll("Two-Parts Joke",
{ assertEquals(Type.TWOPART, joke.type, "type should be two-part") },
{ assertEquals(joke.category, Category.PROGRAMMING) { "category should be ${Category.PROGRAMMING}" } },
{ assertEquals(joke.joke.size, 2, "should have two lines") },
{ assertEquals(joke.language, Language.EN, "language should be english") },
{ assertTrue(joke.flags.isEmpty(), "flags should empty") },
{ assertTrue(joke.id in id - 2..id + 2) { "id should be $id +- 2" } })
}
@Test
fun `Get Raw Joke with Builder`() {
val config = JokeConfig.Builder().apply {
categories(setOf(Category.PROGRAMMING))
format(Format.TEXT)
search("bar")
amount(2)
safe(true)
}.build()
val joke = getRawJoke(config)
assertTrue(
joke.contains("----------------------------------------------"), "should contain -- delimiter"
)
}
companion object {
@JvmStatic
@BeforeAll
fun beforeAll() {
with(logger) {
addHandler(ConsoleHandler().apply { level = Level.FINE })
level = Level.FINE
}
}
}
}