Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change BidResponse.ext to be a JsonElement #155

Merged
merged 5 commits into from
Aug 15, 2024
Merged

change BidResponse.ext to be a JsonElement #155

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4566472
change BidResponse.ext to be a JsonElement rather than Map<String, St…
renam Aug 14, 2024
9b713cb
fix use_new_renderer key in json
renam Aug 14, 2024
279879e
make BidResponse.ext a class, updates tests
renam Aug 14, 2024
f796604
fix property name case to match the rest of the file
renam Aug 14, 2024
7d475ee
adds documentation to BidRequest.Extension
renam Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions kotlin/src/commonMain/kotlin/com/adsbynimbus/openrtb/response/BidResponse.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public class BidResponse(
@JvmField @SerialName("duration") public val duration: Int = 0,
@JvmField @SerialName("exp") public val exp: Int = -1,
@JvmField @SerialName("external_notifications") public val external_notifications: Map<String, String> = emptyMap(),
@JvmField @SerialName("ext") public val ext: Map<String, String> = emptyMap(),
@JvmField @SerialName("ext") public val ext: Extension = Extension(),
) {
/** Urls to fire a request to when an impression is registered */
public val impression_trackers: Array<String>? get() = trackers["impression_trackers"]
Expand All @@ -66,9 +66,6 @@ public class BidResponse(
/** Url to fire a request to when this bid loses an auction */
public val loss_response: String? get() = external_notifications["loss_response"]

public val useNewRenderer: Boolean
get() = ext["use_new_renderer"].toBoolean()

public companion object {
/** Decodes a BidResponse from a Json string using the built in serializer */
@JvmStatic @JvmOverloads
Expand All @@ -84,4 +81,9 @@ public class BidResponse(
jsonSerializer: Json = BidRequest.lenientSerializer,
): String = jsonSerializer.encodeToString(serializer(), response)
}

@Serializable
public class Extension(
@JvmField @SerialName("use_new_renderer") public val use_new_renderer: Boolean = false,
)
}
19 changes: 17 additions & 2 deletions kotlin/src/commonTest/kotlin/com/adsbynimbus/openrtb/response/DeserializationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldContain
import io.kotest.matchers.string.shouldStartWith

const val testJson = """
private fun testJson(ext: String = "") = """
{
"type": "native",
"auction_id": "d07668d6-35ba-4870-a3cd-02b18fec1a12",
Expand All @@ -33,12 +33,13 @@ const val testJson = """
"win_response": "https://test.adsbynimbus.com/win_response/",
"loss_response": "https://test.adsbynimbus.com/loss_response/auctionPrice=[AUCTION_PRICE]&auctionMinToWin=[AUCTION_MIN_TO_WIN]&winningSource=[WINNING_SOURCE]"
}
$ext
}
"""

class DeserializationTest : StringSpec({

val response = BidResponse.fromJson(testJson)
val response = BidResponse.fromJson(testJson())

"BidResponse fromJson deserializes the type field" {
response.type shouldBe "native"
Expand Down Expand Up @@ -104,6 +105,20 @@ class DeserializationTest : StringSpec({
response.win_response shouldBe "https://test.adsbynimbus.com/win_response/"
}

"BidResponse fromJson deserializes use_new_renderer" {
response.ext.use_new_renderer shouldBe false
BidResponse.fromJson(testJson("""
,"ext": {
"use_new_renderer": true
}
""".trimIndent())).ext.use_new_renderer shouldBe true
BidResponse.fromJson(testJson("""
,"ext": {
"use_new_renderer": false
}
""".trimIndent())).ext.use_new_renderer shouldBe false
}

"BidResponse fromJson deserializes loss urls" {
response.loss_response shouldStartWith "https://test.adsbynimbus.com/loss_response/"
response.loss_response shouldContain "auctionPrice=[AUCTION_PRICE]"
Expand Down
Loading