diff --git a/src/main/java/org/prebid/server/bidder/optidigital/OptidigitalBidder.java b/src/main/java/org/prebid/server/bidder/optidigital/OptidigitalBidder.java new file mode 100644 index 00000000000..8e6e3572fea --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/optidigital/OptidigitalBidder.java @@ -0,0 +1,66 @@ +package org.prebid.server.bidder.optidigital; + +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.apache.commons.collections4.CollectionUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.json.DecodeException; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Objects; + +public class OptidigitalBidder implements Bidder { + + private final String endpointUrl; + private final JacksonMapper mapper; + + public OptidigitalBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public final Result>> makeHttpRequests(BidRequest bidRequest) { + return Result.withValue(BidderUtil.defaultRequest(bidRequest, endpointUrl, mapper)); + } + + @Override + public final Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + return Result.withValues(extractBids(bidResponse)); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private static List extractBids(BidResponse bidResponse) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + return bidsFromResponse(bidResponse); + } + + private static List bidsFromResponse(BidResponse bidResponse) { + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .map(bid -> BidderBid.of(bid, BidType.banner, bidResponse.getCur())) + .toList(); + } + +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/OptidigitalConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/OptidigitalConfiguration.java new file mode 100644 index 00000000000..dbd9309821b --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/OptidigitalConfiguration.java @@ -0,0 +1,41 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.optidigital.OptidigitalBidder; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.spring.config.bidder.model.BidderConfigurationProperties; +import org.prebid.server.spring.config.bidder.util.BidderDepsAssembler; +import org.prebid.server.spring.config.bidder.util.UsersyncerCreator; +import org.prebid.server.spring.env.YamlPropertySourceFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; + +import jakarta.validation.constraints.NotBlank; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/optidigital.yaml", factory = YamlPropertySourceFactory.class) +public class OptidigitalConfiguration { + + private static final String BIDDER_NAME = "optidigital"; + + @Bean("optidigitalConfigurationProperties") + @ConfigurationProperties("adapters.optidigital") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps optidigitalBidderDeps(BidderConfigurationProperties optidigitalConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(optidigitalConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new OptidigitalBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/optidigital.yaml b/src/main/resources/bidder-config/optidigital.yaml new file mode 100644 index 00000000000..9e48244221b --- /dev/null +++ b/src/main/resources/bidder-config/optidigital.yaml @@ -0,0 +1,22 @@ +adapters: + optidigital: + enabled: false + endpoint: https://pbs.optidigital.com/bidder/openrtb2 + endpoint-compression: gzip + ortb-version: "2.6" + meta-info: + maintainer-email: prebid@optidigital.com + app-media-types: + - banner + site-media-types: + - banner + dooh-media-types: + - banner + supported-vendors: + vendor-id: 915 + usersync: + cookie-family-name: optidigital + iframe: + url: https://scripts.opti-digital.com/js/presyncs2s.html?endpoint=optidigital&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&redir={{redirect_url}} + support-cors: false + uid-macro: '$UID' diff --git a/src/main/resources/static/bidder-params/optidigital.json b/src/main/resources/static/bidder-params/optidigital.json new file mode 100644 index 00000000000..4cde58a8100 --- /dev/null +++ b/src/main/resources/static/bidder-params/optidigital.json @@ -0,0 +1,30 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Optidigital Adapter Params", + "description": "A schema which validates params accepted by the Optidigital adapter", + "type": "object", + "properties": { + "publisherId": { + "type": "string", + "minLength": 2, + "description": "Publisher ID" + }, + "placementId": { + "type": "string", + "minLength": 1, + "description": "Placement ID" + }, + "divId": { + "type": "string", + "description": "Div ID" + }, + "pageTemplate": { + "type": "string", + "description": "Page Template" + } + }, + "required": [ + "publisherId", + "placementId" + ] +} diff --git a/src/test/java/org/prebid/server/bidder/optidigital/OptidigitalBidderTest.java b/src/test/java/org/prebid/server/bidder/optidigital/OptidigitalBidderTest.java new file mode 100644 index 00000000000..a2723b65c80 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/optidigital/OptidigitalBidderTest.java @@ -0,0 +1,153 @@ +package org.prebid.server.bidder.optidigital; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.Test; +import org.prebid.server.VertxTest; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.HttpResponse; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.util.Collections; +import java.util.List; +import java.util.function.UnaryOperator; + +import static java.util.function.UnaryOperator.identity; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; + +public class OptidigitalBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.com"; + + private final OptidigitalBidder target = new OptidigitalBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException() + .isThrownBy(() -> new OptidigitalBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldNotModifyIncomingRequest() { + // given + final BidRequest bidRequest = givenBidRequest(identity(), identity()); + + // when + final Result>> result; + result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) + .containsExactly(bidRequest); + } + + @Test + public void makeBidsShouldReturnErrorIfResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall(null, "invalid"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()).startsWith("Failed to decode: Unrecognized token"); + }); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(null, mapper.writeValueAsString(null)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseSeatBidIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(null, + mapper.writeValueAsString(BidResponse.builder().build())); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBidderBidWithNoErrors() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(identity()); + final BidderCall httpCall = givenHttpCall(bidRequest, + mapper.writeValueAsString(givenBidResponse(bidBuilder -> bidBuilder.impid("impId")))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .containsExactly(BidderBid.of(Bid.builder().impid("impId").build(), BidType.banner, "USD")); + } + + private static BidRequest givenBidRequest(UnaryOperator impCustomizer) { + return givenBidRequest(identity(), impCustomizer); + } + + private static BidRequest givenBidRequest( + UnaryOperator bidRequestCustomizer, + UnaryOperator impCustomizer) { + + return bidRequestCustomizer.apply(BidRequest.builder() + .id("requestId") + .imp(Collections.singletonList(givenImp(impCustomizer)))) + .build(); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder() + .id("impId") + .banner(Banner.builder().build()) + .ext(null)) + .build(); + } + + private static BidResponse givenBidResponse(UnaryOperator bidCustomizer) { + return BidResponse.builder() + .seatbid(Collections.singletonList(SeatBid.builder() + .bid(Collections.singletonList(bidCustomizer.apply(Bid.builder()).build())) + .build())) + .cur("USD") + .build(); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/OptidigitalTest.java b/src/test/java/org/prebid/server/it/OptidigitalTest.java new file mode 100644 index 00000000000..61188100aad --- /dev/null +++ b/src/test/java/org/prebid/server/it/OptidigitalTest.java @@ -0,0 +1,37 @@ +package org.prebid.server.it; + +import io.restassured.response.Response; +import org.json.JSONException; +import org.junit.jupiter.api.Test; +import org.prebid.server.model.Endpoint; + +import java.io.IOException; + +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson; +import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static java.util.Collections.singletonList; + +public class OptidigitalTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromOptidigital() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/optidigital-exchange")) + .withRequestBody(equalToJson( + jsonFrom("openrtb2/optidigital/test-optidigital-bid-request.json"))) + .willReturn(aResponse().withBody( + jsonFrom("openrtb2/optidigital/test-optidigital-bid-response.json")))); + + // when + final Response response = + responseFor("openrtb2/optidigital/test-auction-optidigital-request.json", Endpoint.openrtb2_auction); + + // then + assertJsonEquals( + "openrtb2/optidigital/test-auction-optidigital-response.json", + response, + singletonList("optidigital")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-auction-optidigital-request.json b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-auction-optidigital-request.json new file mode 100644 index 00000000000..f85e77eb3bf --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-auction-optidigital-request.json @@ -0,0 +1,22 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "optidigital": { + "publisherId": "testPublisherId", + "placementId": "testPlacementId" + } + } + } + ], + "tmax": 5000, + "regs": { + "gdpr": 0 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-auction-optidigital-response.json b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-auction-optidigital-response.json new file mode 100644 index 00000000000..91c2bda3b0d --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-auction-optidigital-response.json @@ -0,0 +1,42 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "price": 3.33, + "adm": "adm001", + "adid": "adid001", + "cid": "cid001", + "crid": "crid001", + "w": 300, + "h": 250, + "ext": { + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "optidigital" + } + }, + "origbidcpm": 3.33 + } + } + ], + "seat": "optidigital", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "optidigital": 0 + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-optidigital-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-optidigital-bid-request.json new file mode 100644 index 00000000000..18dee6e53fb --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-optidigital-bid-request.json @@ -0,0 +1,55 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "secure": 1, + "ext": { + "tid": "${json-unit.any-string}", + "bidder": { + "publisherId": "testPublisherId", + "placementId": "testPlacementId" + } + } + } + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "site": { + "domain": "www.example.com", + "page": "http://www.example.com", + "publisher": { + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "regs": { + "gdpr": 0 + }, + "ext": { + "prebid": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-optidigital-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-optidigital-bid-response.json new file mode 100644 index 00000000000..a4c0edc3e09 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/optidigital/test-optidigital-bid-response.json @@ -0,0 +1,20 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adid": "adid001", + "crid": "crid001", + "cid": "cid001", + "adm": "adm001", + "h": 250, + "w": 300 + } + ] + } + ] +} diff --git a/src/test/resources/org/prebid/server/it/test-application.properties b/src/test/resources/org/prebid/server/it/test-application.properties index 747b9a2fc6a..6286e960f18 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -396,6 +396,8 @@ adapters.openx.enabled=true adapters.openx.endpoint=http://localhost:8090/openx-exchange adapters.operaads.enabled=true adapters.operaads.endpoint=http://localhost:8090/operaads-exchange +adapters.optidigital.enabled=true +adapters.optidigital.endpoint=http://localhost:8090/optidigital-exchange adapters.oraki.enabled=true adapters.oraki.endpoint=http://localhost:8090/oraki-exchange adapters.orbidder.enabled=true