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

Cleaned up parameters

Browse source
This commit is contained in:
Erik C. Thauvin 2022-10-11 09:23:33 -07:00
parent 0824c8f059
commit 888c9eddfd
14 changed files with 103 additions and 97 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -13,7 +13,7 @@ import net.thauvin.erik.jokeapi.getJoke
val joke = getJoke()
val safe = getJoke(safe = true)
val pun = getJoke(category = Category.PUN)
val pun = getJoke(categories = setOf(Category.PUN))
```
The parameters match the [joke endpoint](https://v2.jokeapi.dev/#joke-endpoint).
@ -27,7 +27,7 @@ data class Joke(
val flags: Set<Flag>,
val id: Int,
val safe: Boolean,
val language: Language
val lang: Language
)
```
- View more [examples](https://github.com/ethauvin/jokeapi/blob/master/src/test/kotlin/net/thauvin/erik/jokeapi/GetJokeTest.kt)...
@ -35,7 +35,7 @@ data class Joke(
To retrieve multiple jokes:
```kotlin
val frenchJokes = getJokes(amount = 2, type = Type.TWOPART, language = Language.FR)
val frenchJokes = getJokes(amount = 2, type = Type.TWOPART, lang = Language.FR)
frenchJokes.forEach {
println(it.joke.joinToString("\n"))
println("-".repeat(46))
@ -70,6 +70,18 @@ class HttpErrorException(
```
- View more [examples](https://github.com/ethauvin/jokeapi/blob/master/src/test/kotlin/net/thauvin/erik/jokeapi/ExceptionsTest.kt)...
## Java
To make it easier to use the library with Java, a configuration builder is available:
```java
var config = new JokeConfig.Builder()
.type(Type.SINGLE)
.safe(true)
.build();
var joke = JokeApi.getJoke(config);
joke.getJoke().forEach(System.out::println);
```
## Gradle, Maven, etc.
To use with [Gradle](https://gradle.org/), include the following dependency in your build file:
@ -114,19 +126,6 @@ lang: "en"
```
- View more [examples](https://github.com/ethauvin/jokeapi/blob/master/src/test/kotlin/net/thauvin/erik/jokeapi/GetRawJokeTest.kt)...
## Java
To make it easier to use the library with Java, a configuration builder is also available:
```java
var config = new JokeConfig.Builder()
.type(Type.SINGLE)
.safe(true)
.build();
var joke = JokeApi.getJoke(config);
joke.getJoke().forEach(System.out::println);
```
## Extending
A generic `apiCall()` function is available to access other [JokeAPI endpoints](https://v2.jokeapi.dev/#endpoints).

2
build.gradle.kts
View file

@ -8,7 +8,7 @@ plugins {
id("io.gitlab.arturbosch.detekt") version "1.21.0"
id("java")
id("maven-publish")
id("org.jetbrains.dokka") version "1.7.10"
id("org.jetbrains.dokka") version "1.7.20"
id("org.jetbrains.kotlinx.kover") version "0.6.1"
id("org.sonarqube") version "3.4.0.2513"
id("signing")

11
detekt-baseline.xml
View file

@ -2,11 +2,11 @@
<SmellBaseline>
<ManuallySuppressedIssues/>
<CurrentIssues>
<ID>ComplexMethod:JokeApi.kt$fun getRawJokes( categories: Set&lt;Category> = setOf(Category.ANY), language: Language = Language.EN, flags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, format: Format = Format.JSON, search: String = "", idRange: IdRange = IdRange(), amount: Int = 1, safe: Boolean = false, auth: String = "" ): String</ID>
<ID>LongParameterList:JokeApi.kt$( amount: Int, categories: Set&lt;Category> = setOf(Category.ANY), language: Language = Language.EN, flags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, search: String = "", idRange: IdRange = IdRange(), safe: Boolean = false, splitNewLine: Boolean = false, auth: String = "" )</ID>
<ID>LongParameterList:JokeApi.kt$( categories: Set&lt;Category> = setOf(Category.ANY), language: Language = Language.EN, flags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, format: Format = Format.JSON, search: String = "", idRange: IdRange = IdRange(), amount: Int = 1, safe: Boolean = false, auth: String = "" )</ID>
<ID>LongParameterList:JokeApi.kt$( categories: Set&lt;Category> = setOf(Category.ANY), language: Language = Language.EN, flags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, search: String = "", idRange: IdRange = IdRange(), safe: Boolean = false, splitNewLine: Boolean = false, auth: String = "" )</ID>
<ID>LongParameterList:JokeConfig.kt$JokeConfig$( val categories: Set&lt;Category>, val language: Language, val flags: Set&lt;Flag>, val type: Type, val format: Format, val search: String, val idRange: IdRange, val amount: Int, val safe: Boolean, val splitNewLine: Boolean, val auth: String )</ID>
<ID>ComplexMethod:JokeApi.kt$fun getRawJokes( categories: Set&lt;Category> = setOf(Category.ANY), lang: Language = Language.EN, blacklistFlags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, format: Format = Format.JSON, contains: String = "", idRange: IdRange = IdRange(), amount: Int = 1, safe: Boolean = false, auth: String = "" ): String</ID>
<ID>LongParameterList:JokeApi.kt$( amount: Int, categories: Set&lt;Category> = setOf(Category.ANY), lang: Language = Language.EN, blacklistFlags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, contains: String = "", idRange: IdRange = IdRange(), safe: Boolean = false, auth: String = "", splitNewLine: Boolean = false )</ID>
<ID>LongParameterList:JokeApi.kt$( categories: Set&lt;Category> = setOf(Category.ANY), lang: Language = Language.EN, blacklistFlags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, contains: String = "", idRange: IdRange = IdRange(), safe: Boolean = false, auth: String = "", splitNewLine: Boolean = false )</ID>
<ID>LongParameterList:JokeApi.kt$( categories: Set&lt;Category> = setOf(Category.ANY), lang: Language = Language.EN, blacklistFlags: Set&lt;Flag> = emptySet(), type: Type = Type.ALL, format: Format = Format.JSON, contains: String = "", idRange: IdRange = IdRange(), amount: Int = 1, safe: Boolean = false, auth: String = "" )</ID>
<ID>LongParameterList:JokeConfig.kt$JokeConfig$( val categories: Set&lt;Category>, val language: Language, val flags: Set&lt;Flag>, val type: Type, val format: Format, val contains: String, val idRange: IdRange, val amount: Int, val safe: Boolean, val splitNewLine: Boolean, val auth: String )</ID>
<ID>LongParameterList:JokeException.kt$JokeException$( val internalError: Boolean, val code: Int, message: String, val causedBy: List&lt;String>, val additionalInfo: String, val timestamp: Long, cause: Throwable? = null )</ID>
<ID>MagicNumber:util.kt$200</ID>
<ID>MagicNumber:util.kt$399</ID>
@ -19,5 +19,6 @@
<ID>MagicNumber:util.kt$500</ID>
<ID>MagicNumber:util.kt$523</ID>
<ID>TooManyFunctions:JokeConfig.kt$JokeConfig$Builder</ID>
<ID>UnusedPrivateMember:JokeConfig.kt$JokeConfig.Builder$search: String</ID>
</CurrentIssues>
</SmellBaseline>

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

@ -111,11 +111,11 @@ class JokeApi private constructor() {
fun getRawJokes(config: JokeConfig): String {
return getRawJokes(
categories = config.categories,
language = config.language,
flags = config.flags,
lang = config.language,
blacklistFlags = config.flags,
type = config.type,
format = config.format,
search = config.search,
contains = config.contains,
idRange = config.idRange,
amount = config.amount,
safe = config.safe,
@ -134,14 +134,14 @@ class JokeApi private constructor() {
fun getJoke(config: JokeConfig = JokeConfig.Builder().build()): Joke {
return getJoke(
categories = config.categories,
language = config.language,
flags = config.flags,
lang = config.language,
blacklistFlags = config.flags,
type = config.type,
search = config.search,
contains = config.contains,
idRange = config.idRange,
safe = config.safe,
splitNewLine = config.splitNewLine,
auth = config.auth
auth = config.auth,
splitNewLine = config.splitNewLine
)
}
@ -155,15 +155,15 @@ class JokeApi private constructor() {
fun getJokes(config: JokeConfig): Array<Joke> {
return getJokes(
categories = config.categories,
language = config.language,
flags = config.flags,
lang = config.language,
blacklistFlags = config.flags,
type = config.type,
search = config.search,
contains = config.contains,
idRange = config.idRange,
amount = config.amount,
safe = config.safe,
splitNewLine = config.splitNewLine,
auth = config.auth
auth = config.auth,
splitNewLine = config.splitNewLine
)
}
}
@ -179,22 +179,22 @@ class JokeApi private constructor() {
*/
fun getJoke(
categories: Set<Category> = setOf(Category.ANY),
language: Language = Language.EN,
flags: Set<Flag> = emptySet(),
lang: Language = Language.EN,
blacklistFlags: Set<Flag> = emptySet(),
type: Type = Type.ALL,
search: String = "",
contains: String = "",
idRange: IdRange = IdRange(),
safe: Boolean = false,
splitNewLine: Boolean = false,
auth: String = ""
auth: String = "",
splitNewLine: Boolean = false
): Joke {
val json = JSONObject(
getRawJokes(
categories = categories,
language = language,
flags = flags,
lang = lang,
blacklistFlags = blacklistFlags,
type = type,
search = search,
contains = contains,
idRange = idRange,
safe = safe,
auth = auth
@ -218,22 +218,22 @@ fun getJoke(
fun getJokes(
amount: Int,
categories: Set<Category> = setOf(Category.ANY),
language: Language = Language.EN,
flags: Set<Flag> = emptySet(),
lang: Language = Language.EN,
blacklistFlags: Set<Flag> = emptySet(),
type: Type = Type.ALL,
search: String = "",
contains: String = "",
idRange: IdRange = IdRange(),
safe: Boolean = false,
splitNewLine: Boolean = false,
auth: String = ""
auth: String = "",
splitNewLine: Boolean = false
): Array<Joke> {
val json = JSONObject(
getRawJokes(
categories = categories,
language = language,
flags = flags,
lang = lang,
blacklistFlags = blacklistFlags,
type = type,
search = search,
contains = contains,
idRange = idRange,
amount = amount,
safe = safe,
@ -259,11 +259,11 @@ fun getJokes(
*/
fun getRawJokes(
categories: Set<Category> = setOf(Category.ANY),
language: Language = Language.EN,
flags: Set<Flag> = emptySet(),
lang: Language = Language.EN,
blacklistFlags: Set<Flag> = emptySet(),
type: Type = Type.ALL,
format: Format = Format.JSON,
search: String = "",
contains: String = "",
idRange: IdRange = IdRange(),
amount: Int = 1,
safe: Boolean = false,
@ -279,16 +279,16 @@ fun getRawJokes(
}
// Language
if (language != Language.EN) {
params[Parameter.LANG] = language.value
if (lang != Language.EN) {
params[Parameter.LANG] = lang.value
}
// Flags
if (flags.isNotEmpty()) {
if (flags.contains(Flag.ALL)) {
if (blacklistFlags.isNotEmpty()) {
if (blacklistFlags.contains(Flag.ALL)) {
params[Parameter.FLAGS] = Flag.ALL.value
} else {
params[Parameter.FLAGS] = flags.stream().map(Flag::value).collect(Collectors.joining(","))
params[Parameter.FLAGS] = blacklistFlags.stream().map(Flag::value).collect(Collectors.joining(","))
}
}
@ -303,8 +303,8 @@ fun getRawJokes(
}
// Contains
if (search.isNotBlank()) {
params[Parameter.CONTAINS] = search
if (contains.isNotBlank()) {
params[Parameter.CONTAINS] = contains
}
// Range

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

@ -51,7 +51,7 @@ class JokeConfig private constructor(
val flags: Set<Flag>,
val type: Type,
val format: Format,
val search: String,
val contains: String,
val idRange: IdRange,
val amount: Int,
val safe: Boolean,
@ -67,31 +67,31 @@ class JokeConfig private constructor(
*/
data class Builder(
var categories: Set<Category> = setOf(Category.ANY),
var language: Language = Language.EN,
var flags: Set<Flag> = emptySet(),
var lang: Language = Language.EN,
var blacklistFlags: Set<Flag> = emptySet(),
var type: Type = Type.ALL,
var format: Format = Format.JSON,
var search: String = "",
var contains: String = "",
var idRange: IdRange = IdRange(),
var amount: Int = 1,
var safe: Boolean = false,
var splitNewLine: Boolean = false,
var auth: String = ""
var auth: String = "",
var splitNewLine: Boolean = false
) {
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 lang(language: Language) = apply { lang = language }
fun blacklistFlags(flags: Set<Flag>) = apply { blacklistFlags = 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 contains(search: String) = apply { contains = 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 auth(auth: String) = apply { this.auth = auth }
fun splitNewLine(splitNewLine: Boolean) = apply { this.splitNewLine = splitNewLine }
fun build() = JokeConfig(
categories, language, flags, type, format, search, idRange, amount, safe, splitNewLine, auth
categories, lang, blacklistFlags, type, format, contains, idRange, amount, safe, splitNewLine, auth
)
}
}

1
src/main/kotlin/net/thauvin/erik/jokeapi/models/Format.kt
View file

@ -37,6 +37,7 @@ package net.thauvin.erik.jokeapi.models
*/
enum class Format(val value: String) {
JSON("json"),
/** Plain Text */
TXT("txt"),
XML("xml"),

2
src/main/kotlin/net/thauvin/erik/jokeapi/models/Joke.kt
View file

@ -42,5 +42,5 @@ data class Joke(
val flags: Set<Flag>,
val id: Int,
val safe: Boolean,
val language: Language
val lang: Language
)

5
src/main/kotlin/net/thauvin/erik/jokeapi/models/Language.kt
View file

@ -38,14 +38,19 @@ package net.thauvin.erik.jokeapi.models
enum class Language(val value: String) {
/** Czech */
CS("cs"),
/** German */
DE("de"),
/** English */
EN("en"),
/** Spanish */
ES("es"),
/** French */
FR("fr"),
/** Portuguese */
PT("pt")
}

2
src/main/kotlin/net/thauvin/erik/jokeapi/util.kt
View file

@ -166,7 +166,7 @@ internal fun parseJoke(json: JSONObject, splitNewLine: Boolean): Joke {
flags = enabledFlags,
safe = json.getBoolean("safe"),
id = json.getInt("id"),
language = Language.valueOf(json.getString(Parameter.LANG).uppercase())
lang = Language.valueOf(json.getString(Parameter.LANG).uppercase())
)
}

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

@ -60,7 +60,7 @@ internal class ExceptionsTest {
@Test
fun `Validate Joke Exception`() {
val e = assertThrows<JokeException> {
getJoke(categories = setOf(Category.CHRISTMAS), search = "foo")
getJoke(categories = setOf(Category.CHRISTMAS), contains = "foo")
}
logger.fine(e.debug())
assertThat(e, "getJoke(${Category.CHRISTMAS},foo)").all {

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

@ -72,20 +72,20 @@ internal class GetJokeTest {
prop(Joke::joke).isNotEmpty()
prop(Joke::type).isIn(Type.SINGLE, Type.TWOPART)
prop(Joke::id).isGreaterThanOrEqualTo(0)
prop(Joke::language).isEqualTo(Language.EN)
prop(Joke::lang).isEqualTo(Language.EN)
}
}
@Test
fun `Get Joke without Blacklist Flags`() {
val joke = getJoke(flags = setOf(Flag.ALL))
val joke = getJoke(blacklistFlags = setOf(Flag.ALL))
assertThat(joke::flags).isEmpty()
}
@Test
fun `Get Joke without any Blacklist Flags`() {
val allFlags = Flag.values().filter { it != Flag.ALL }.toSet()
val joke = getJoke(flags = allFlags)
val joke = getJoke(blacklistFlags = allFlags)
assertThat(joke::flags).isEmpty()
}
@ -115,7 +115,7 @@ internal class GetJokeTest {
@Test
fun `Get Joke with invalid ID Range`() {
val idRange = IdRange(100, 1)
val e = assertThrows<IllegalArgumentException> { getJoke(idRange = idRange, language = Language.DE) }
val e = assertThrows<IllegalArgumentException> { getJoke(idRange = idRange, lang = Language.DE) }
assertThat(e::message).isNotNull().contains("100, 1")
}
@ -150,9 +150,9 @@ internal class GetJokeTest {
@Test
fun `Get Joke with each Languages`() {
Language.values().forEach {
val joke = getJoke(language = it)
val joke = getJoke(lang = it)
logger.fine(joke.toString())
assertThat(joke::language, "getJoke($it)").prop(Language::value).isEqualTo(it.value)
assertThat(joke::lang, "getJoke($it)").prop(Language::value).isEqualTo(it.value)
}
}
@ -202,7 +202,7 @@ internal class GetJokeTest {
val id = 265
val search = "his wife"
val joke =
getJoke(search = search, categories = setOf(Category.PROGRAMMING), idRange = IdRange(id), safe = true)
getJoke(contains = search, categories = setOf(Category.PROGRAMMING), idRange = IdRange(id), safe = true)
logger.fine(joke.toString())
assertThat(joke, "getJoke($search)").all {
prop(Joke::id).isEqualTo(id)

4
src/test/kotlin/net/thauvin/erik/jokeapi/GetJokesTest.kt
View file

@ -57,14 +57,14 @@ internal class GetJokesTest {
@Test
fun `Get Multiple Jokes`() {
val amount = 2
val jokes = getJokes(amount = amount, safe = true, language = Language.FR)
val jokes = getJokes(amount = amount, safe = true, lang = Language.FR)
assertThat(jokes, "jokes").all {
size().isEqualTo(amount)
each {
it.prop(Joke::id).isGreaterThanOrEqualTo(0)
it.prop(Joke::safe).isTrue()
it.prop(Joke::flags).isEmpty()
it.prop(Joke::language).isEqualTo(Language.FR)
it.prop(Joke::lang).isEqualTo(Language.FR)
}
}
}

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

@ -76,7 +76,7 @@ internal class GetRawJokesTest {
@Test
fun `Get Raw Invalid Jokes`() {
val response = getRawJokes(search = "foo", safe = true, amount = 2, idRange = IdRange(160, 161))
val response = getRawJokes(contains = "foo", safe = true, amount = 2, idRange = IdRange(160, 161))
assertContains(response, "\"error\": true", false, "getRawJokes(foo)")
}

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

@ -65,7 +65,7 @@ class JokeConfigTest {
val joke = getJoke()
assertThat(joke, "joke").all {
prop(Joke::id).isGreaterThanOrEqualTo(0)
prop(Joke::language).isEqualTo(Language.EN)
prop(Joke::lang).isEqualTo(Language.EN)
}
}
@ -74,8 +74,8 @@ class JokeConfigTest {
val id = 266
val config = JokeConfig.Builder().apply {
categories(setOf(Category.PROGRAMMING))
language(Language.EN)
flags(setOf(Flag.ALL))
lang(Language.EN)
blacklistFlags(setOf(Flag.ALL))
type(Type.TWOPART)
idRange(IdRange(id - 2, id + 2))
safe(true)
@ -86,7 +86,7 @@ class JokeConfigTest {
prop(Joke::type).isEqualTo(Type.TWOPART)
prop(Joke::category).isEqualTo(Category.PROGRAMMING)
prop(Joke::joke).size().isEqualTo(2)
prop(Joke::language).isEqualTo(Language.EN)
prop(Joke::lang).isEqualTo(Language.EN)
prop(Joke::flags).isEmpty()
prop(Joke::id).isBetween(id - 2, id + 2)
}
@ -113,7 +113,7 @@ class JokeConfigTest {
val config = JokeConfig.Builder().apply {
categories(setOf(Category.PROGRAMMING))
format(Format.TXT)
search("bar")
contains("bar")
amount(2)
safe(true)
}.build()
@ -127,7 +127,7 @@ class JokeConfigTest {
val config = JokeConfig.Builder().apply {
amount(amount)
safe(true)
language(Language.FR)
lang(Language.FR)
}.build()
val jokes = getJokes(config)
assertThat(jokes, "jokes").all {
@ -136,7 +136,7 @@ class JokeConfigTest {
it.prop(Joke::id).isGreaterThanOrEqualTo(0)
it.prop(Joke::safe).isTrue()
it.prop(Joke::flags).isEmpty()
it.prop(Joke::language).isEqualTo(Language.FR)
it.prop(Joke::lang).isEqualTo(Language.FR)
}
}
}
@ -156,11 +156,11 @@ class JokeConfigTest {
val auth = "token"
val config = JokeConfig.Builder().apply {
categories(categories)
language(language)
flags(flags)
lang(language)
blacklistFlags(flags)
type(type)
format(format)
search(search)
contains(search)
idRange(idRange)
amount(amount)
safe(safe)
@ -173,7 +173,7 @@ class JokeConfigTest {
prop(JokeConfig::flags).isEqualTo(flags)
prop(JokeConfig::type).isEqualTo(type)
prop(JokeConfig::format).isEqualTo(format)
prop(JokeConfig::search).isEqualTo(search)
prop(JokeConfig::contains).isEqualTo(search)
prop(JokeConfig::idRange).isEqualTo(idRange)
prop(JokeConfig::amount).isEqualTo(amount)
prop(JokeConfig::safe).isEqualTo(safe)