diff --git a/src/main/java/org/prebid/server/bidder/impactify/ImpactifyBidder.java b/src/main/java/org/prebid/server/bidder/impactify/ImpactifyBidder.java new file mode 100644 index 00000000000..95e1a8d9126 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/impactify/ImpactifyBidder.java @@ -0,0 +1,201 @@ +package org.prebid.server.bidder.impactify; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Device; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.request.User; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import io.vertx.core.MultiMap; +import io.vertx.core.http.HttpMethod; +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.StringUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpCall; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.currency.CurrencyConversionService; +import org.prebid.server.exception.PreBidException; +import org.prebid.server.json.DecodeException; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.impactify.ExtImpImpactify; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.stream.Collectors; + +public class ImpactifyBidder implements Bidder { + + private static final TypeReference> IMPACTIFY_EXT_TYPE_REFERENCE = + new TypeReference>() { + }; + private static final String X_OPENRTB_VERSION = "2.5"; + private static final String BIDDER_CURRENCY = "USD"; + + private final String endpointUrl; + private final JacksonMapper mapper; + private final CurrencyConversionService currencyConversionService; + + public ImpactifyBidder(String endpointUrl, JacksonMapper mapper, CurrencyConversionService conversionService) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + this.currencyConversionService = Objects.requireNonNull(conversionService); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final List updatedImps = new ArrayList<>(); + + for (Imp imp : request.getImp()) { + try { + final BigDecimal resolvedBidFloor = resolveBidFloor(request, imp); + updatedImps.add(updateImp(imp, resolvedBidFloor)); + } catch (PreBidException e) { + return Result.withError(BidderError.badInput(e.getMessage())); + } + } + + final BidRequest updatedBidRequest = updateBidRequest(request, updatedImps); + + return Result.withValue(HttpRequest.builder() + .method(HttpMethod.POST) + .uri(endpointUrl) + .headers(constructHeaders(updatedBidRequest)) + .body(mapper.encodeToBytes(updatedBidRequest)) + .payload(updatedBidRequest) + .build()); + } + + private BigDecimal resolveBidFloor(BidRequest request, Imp imp) { + return shouldConvertBidFloor(imp.getBidfloor(), imp.getBidfloorcur()) + ? convertBidFloorCurrency(imp.getBidfloor(), request, imp.getId(), imp.getBidfloorcur()) + : imp.getBidfloor(); + } + + private static boolean shouldConvertBidFloor(BigDecimal bidFloor, String bidFloorCur) { + return BidderUtil.isValidPrice(bidFloor) && !StringUtils.equalsIgnoreCase(bidFloorCur, BIDDER_CURRENCY); + } + + private BigDecimal convertBidFloorCurrency(BigDecimal bidFloor, + BidRequest bidRequest, + String impId, + String bidFloorCur) { + try { + return currencyConversionService + .convertCurrency(bidFloor, bidRequest, bidFloorCur, BIDDER_CURRENCY); + } catch (PreBidException e) { + throw new PreBidException(String.format( + "Unable to convert provided bid floor currency from %s to %s for imp `%s`", + bidFloorCur, BIDDER_CURRENCY, impId)); + } + } + + private Imp updateImp(Imp imp, BigDecimal bidFloor) { + return imp.toBuilder() + .bidfloorcur(BIDDER_CURRENCY) + .bidfloor(bidFloor) + .ext(mapper.mapper().createObjectNode() + .set("impactify", mapper.mapper().valueToTree(parseExtImp(imp)))) + .build(); + } + + private ExtImpImpactify parseExtImp(Imp imp) { + try { + return mapper.mapper() + .convertValue(imp.getExt(), IMPACTIFY_EXT_TYPE_REFERENCE) + .getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException(String.format("Unable to decode the impression ext for id: %s", imp.getId())); + } + } + + private static BidRequest updateBidRequest(BidRequest request, List updatedImps) { + return request.toBuilder() + .imp(updatedImps) + .cur(Collections.singletonList(BIDDER_CURRENCY)) + .build(); + } + + private static MultiMap constructHeaders(BidRequest bidRequest) { + final MultiMap headers = HttpUtil.headers().set(HttpUtil.X_OPENRTB_VERSION_HEADER, X_OPENRTB_VERSION); + + final Device device = bidRequest.getDevice(); + if (device != null) { + HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.USER_AGENT_HEADER, device.getUa()); + + final String deviceIp = device.getIp(); + if (deviceIp != null) { + HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.X_FORWARDED_FOR_HEADER, deviceIp); + } else { + HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.X_FORWARDED_FOR_HEADER, device.getIpv6()); + } + } + + final Site site = bidRequest.getSite(); + if (site != null) { + HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.REFERER_HEADER, site.getPage()); + } + + final User user = bidRequest.getUser(); + final String userUid = user != null ? user.getBuyeruid() : null; + if (StringUtils.isNotBlank(userUid)) { + headers.set(HttpUtil.COOKIE_HEADER, "uids=" + userUid); + } + + return headers; + } + + @Override + public Result> makeBids(HttpCall httpCall, BidRequest bidRequest) { + try { + final List errors = new ArrayList<>(); + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + return Result.of(extractBids(bidRequest, bidResponse), errors); + } catch (DecodeException | PreBidException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private List extractBids(BidRequest bidRequest, BidResponse bidResponse) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + return bidsFromResponse(bidResponse, bidRequest); + } + + private List bidsFromResponse(BidResponse bidResponse, BidRequest bidRequest) { + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .flatMap(Collection::stream) + .map(bid -> BidderBid.of(bid, getBidType(bid.getImpid(), bidRequest.getImp()), bidResponse.getCur())) + .collect(Collectors.toList()); + } + + private static BidType getBidType(String impId, List imps) { + for (Imp imp : imps) { + if (imp.getId().equals(impId)) { + if (imp.getBanner() != null) { + return BidType.banner; + } + if (imp.getVideo() != null) { + return BidType.video; + } + } + } + throw new PreBidException( + String.format("Failed to find a supported media type impression with ID: '%s'", impId)); + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/impactify/ExtImpImpactify.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/impactify/ExtImpImpactify.java new file mode 100644 index 00000000000..d562605a312 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/impactify/ExtImpImpactify.java @@ -0,0 +1,15 @@ +package org.prebid.server.proto.openrtb.ext.request.impactify; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpImpactify { + + @JsonProperty("appId") + String appId; + + String format; + + String style; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/ImpactifyConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/ImpactifyConfiguration.java new file mode 100644 index 00000000000..6daed5621b3 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/ImpactifyConfiguration.java @@ -0,0 +1,43 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.impactify.ImpactifyBidder; +import org.prebid.server.currency.CurrencyConversionService; +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 javax.validation.constraints.NotBlank; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/impactify.yaml", factory = YamlPropertySourceFactory.class) +public class ImpactifyConfiguration { + + private static final String BIDDER_NAME = "impactify"; + + @Bean("impactifyConfigurationProperties") + @ConfigurationProperties("adapters.impactify") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps impactifyBidderDeps(BidderConfigurationProperties impactifyConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + CurrencyConversionService currencyConversionService, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(impactifyConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new ImpactifyBidder(config.getEndpoint(), mapper, currencyConversionService)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/impactify.yaml b/src/main/resources/bidder-config/impactify.yaml new file mode 100644 index 00000000000..162d0d36ddf --- /dev/null +++ b/src/main/resources/bidder-config/impactify.yaml @@ -0,0 +1,17 @@ +adapters: + impactify: + endpoint: https://sonic.impactify.media/bidder + meta-info: + maintainer-email: support@impactify.io + app-media-types: + site-media-types: + - banner + - video + supported-vendors: + vendor-id: 606 + usersync: + url: https://sonic.impactify.media/static/cookie_sync.html?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&redirect_url= + redirect-url: /setuid?bidder=impactify&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&uid={IMPACTIFY_UID} + cookie-family-name: impactify + type: iframe + support-cors: false diff --git a/src/main/resources/static/bidder-params/impactify.json b/src/main/resources/static/bidder-params/impactify.json new file mode 100644 index 00000000000..1b0bbf4596a --- /dev/null +++ b/src/main/resources/static/bidder-params/impactify.json @@ -0,0 +1,28 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Impactify Adapter Params", + "description": "A schema which validates params accepted by the Impactify adapter", + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "The appId of your website", + "minLength": 1 + }, + "format": { + "type": "string", + "description": "The format of the ad", + "minLength": 1 + }, + "style": { + "type": "string", + "description": "The style of the ad", + "minLength": 1 + } + }, + "required": [ + "appId", + "format", + "style" + ] +} diff --git a/src/test/java/org/prebid/server/bidder/impactify/ImpactifyBidderTest.java b/src/test/java/org/prebid/server/bidder/impactify/ImpactifyBidderTest.java new file mode 100644 index 00000000000..871080fb89b --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/impactify/ImpactifyBidderTest.java @@ -0,0 +1,375 @@ +package org.prebid.server.bidder.impactify; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Device; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.request.User; +import com.iab.openrtb.request.Video; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.vertx.core.MultiMap; +import org.junit.Before; +import org.junit.Rule; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.junit.MockitoJUnit; +import org.mockito.junit.MockitoRule; +import org.prebid.server.VertxTest; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpCall; +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.currency.CurrencyConversionService; +import org.prebid.server.exception.PreBidException; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.impactify.ExtImpImpactify; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.HttpUtil; + +import java.math.BigDecimal; +import java.util.List; +import java.util.Map; +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; +import static org.assertj.core.api.Assertions.tuple; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.BDDMockito.given; + +public class ImpactifyBidderTest extends VertxTest { + + @Rule + public final MockitoRule mockitoRule = MockitoJUnit.rule(); + + private ImpactifyBidder impactifyBidder; + + @Mock + private CurrencyConversionService currencyConversionService; + + @Before + public void setUp() { + impactifyBidder = + new ImpactifyBidder("https://test.endpoint.com", jacksonMapper, currencyConversionService); + } + + @Test + public void createBidderWithWrongEndpointShouldThrowException() { + assertThatIllegalArgumentException().isThrownBy(() -> new ImpactifyBidder("incorrect.endpoint", + jacksonMapper, currencyConversionService)); + } + + @Test + public void makeHttpRequestsShouldConvertCurrencyIfNotDefault() { + // given + given(currencyConversionService.convertCurrency(any(), any(), anyString(), anyString())) + .willReturn(BigDecimal.TEN); + + final BidRequest bidRequest = givenBidRequest( + impCustomizer -> impCustomizer.bidfloor(BigDecimal.ONE).bidfloorcur("EUR")); + + // when + Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly(tuple(BigDecimal.TEN, "USD")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorMessageOnFailedCurrencyConversion() { + // given + given(currencyConversionService.convertCurrency(any(), any(), anyString(), anyString())) + .willThrow(PreBidException.class); + + final BidRequest bidRequest = givenBidRequest( + impCustomizer -> impCustomizer.bidfloor(BigDecimal.ONE).bidfloorcur("EUR")); + + // when + Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .extracting(BidderError::getMessage) + .containsExactly("Unable to convert provided bid floor currency from EUR to USD for imp `123`"); + + } + + @Test + public void makeHttpRequestsShouldReturnValidBidResponseWithAllHeadersExceptIpv6() { + // given + final BidRequest bidRequest = givenBidRequest( + bidRequestCustomizer -> bidRequestCustomizer + .device(givenDevice(deviceCustomizer -> deviceCustomizer.ua("ua").ip("ip").ipv6("ipv6"))) + .site(Site.builder().page("https://proper.web.site").build()) + .user(User.builder().buyeruid("buyer_user_uid").build()), + impCustomizer -> impCustomizer + .bidfloorcur("USD") + .bidfloor(BigDecimal.ONE)); + + // when + final Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getHeaders) + .flatExtracting(MultiMap::entries) + .extracting(Map.Entry::getKey, Map.Entry::getValue) + .containsExactlyInAnyOrder( + tuple(HttpUtil.CONTENT_TYPE_HEADER.toString(), HttpUtil.APPLICATION_JSON_CONTENT_TYPE), + tuple(HttpUtil.ACCEPT_HEADER.toString(), HttpHeaderValues.APPLICATION_JSON.toString()), + tuple(HttpUtil.USER_AGENT_HEADER.toString(), "ua"), + tuple(HttpUtil.X_FORWARDED_FOR_HEADER.toString(), "ip"), + tuple(HttpUtil.X_OPENRTB_VERSION_HEADER.toString(), "2.5"), + tuple(HttpUtil.REFERER_HEADER.toString(), "https://proper.web.site"), + tuple(HttpUtil.COOKIE_HEADER.toString(), "uids=buyer_user_uid") + ); + } + + @Test + public void makeHttpRequestsWithValidDataShouldContainCorrectExt() { + // given + final BidRequest bidRequest = givenBidRequest( + bidRequestCustomizer -> bidRequestCustomizer + .site(Site.builder().page("https://proper.web.site").build()) + .user(User.builder().buyeruid("buyer_user_uid").build()), + impCustomizer -> impCustomizer + .bidfloorcur("USD") + .bidfloor(BigDecimal.ONE)); + + // when + final Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + final ObjectNode expectedExtNode = mapper.createObjectNode() + .set("impactify", mapper.valueToTree(ExtImpImpactify.of("appId", "format", "style"))); + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getExt) + .containsExactly(expectedExtNode); + } + + @Test + public void makeHttpRequestsShouldReturnValidBidResponseWithAllHeadersExceptIpv4() { + // given + final BidRequest bidRequest = givenBidRequest( + bidRequestCustomizer -> bidRequestCustomizer + .device(givenDevice(deviceCustomizer -> deviceCustomizer.ua("ua").ipv6("ipv6"))) + .site(Site.builder().page("https://proper.web.site").build()) + .user(User.builder().buyeruid("buyer_user_uid").build()), + impCustomizer -> impCustomizer + .bidfloorcur("USD") + .bidfloor(BigDecimal.ONE)); + + // when + final Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getHeaders) + .flatExtracting(MultiMap::entries) + .extracting(Map.Entry::getKey, Map.Entry::getValue) + .containsExactlyInAnyOrder( + tuple(HttpUtil.CONTENT_TYPE_HEADER.toString(), HttpUtil.APPLICATION_JSON_CONTENT_TYPE), + tuple(HttpUtil.ACCEPT_HEADER.toString(), HttpHeaderValues.APPLICATION_JSON.toString()), + tuple(HttpUtil.USER_AGENT_HEADER.toString(), "ua"), + tuple(HttpUtil.X_FORWARDED_FOR_HEADER.toString(), "ipv6"), + tuple(HttpUtil.X_OPENRTB_VERSION_HEADER.toString(), "2.5"), + tuple(HttpUtil.REFERER_HEADER.toString(), "https://proper.web.site"), + tuple(HttpUtil.COOKIE_HEADER.toString(), "uids=buyer_user_uid") + ); + } + + @Test + public void makeHttpRequestsShouldCheckIfValidDataInImpressionHasCorrectBidFloorAndBidFloorCur() { + // given + final BidRequest bidRequest = givenBidRequest( + impCustomizer -> impCustomizer.bidfloor(BigDecimal.ONE).bidfloorcur("USD")); + + // when + Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), BidRequest.class)) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly(tuple(BigDecimal.ONE, "USD")); + } + + @Test + public void makeHttpRequestsWithInvalidImpressionExtShouldReturnUnableToDecodeError() { + // given + final BidRequest bidRequest = givenBidRequest(impCustomizer -> impCustomizer + .ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode())))); + + // when + Result>> result = impactifyBidder.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1) + .extracting(BidderError::getMessage) + .containsExactly("Unable to decode the impression ext for id: 123"); + } + + @Test + public void makeBidsShouldReturnValidBidResponseWithBanner() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(impCustomizer -> impCustomizer.banner(Banner.builder().build())); + + final HttpCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(identity()))); + + // when + final Result> result = impactifyBidder.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .containsOnly(Bid.builder() + .impid("123") + .build()); + + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.banner); + } + + @Test + public void makeBidsWithInvalidBodyShouldResultInError() { + // given + final HttpCall httpCall = givenHttpCall(null, "invalid"); + + // when + final Result> result = impactifyBidder.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).hasSize(1); + assertThat(result.getErrors().get(0).getMessage()).startsWith("Failed to decode: Unrecognized token"); + } + + @Test + public void makeBidsReturnEmptyListsResultWhenEmptySeatBidInBidResponse() throws JsonProcessingException { + // given + final BidRequest bidRequest = BidRequest.builder().build(); + + final HttpCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString(BidResponse.builder().build())); + + // when + final Result> result = impactifyBidder.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnValidBidResponseWithVideo() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(impCustomizer -> impCustomizer.video(Video.builder().build())); + + final HttpCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(identity()))); + + // when + final Result> result = impactifyBidder.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(BidderBid::getBid) + .containsOnly(Bid.builder() + .impid("123") + .build()); + assertThat(result.getValue()) + .extracting(BidderBid::getType) + .containsExactly(BidType.video); + } + + @Test + public void makeBidsShouldReturnErrorWhenBidResponseImpIdIsNotSameAsBidRequestImpId() + throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(identity()); + + final HttpCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("321")))); + + // when + final Result> result = impactifyBidder.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).hasSize(1); + assertThat(result.getErrors()) + .extracting(BidderError::getMessage) + .containsExactly("Failed to find a supported media type impression with ID: '321'"); + } + + private static BidRequest givenBidRequest( + UnaryOperator bidRequestCustomizer, + UnaryOperator impCustomizer) { + + return bidRequestCustomizer.apply(BidRequest.builder() + .imp(List.of(givenImp(impCustomizer)))) + .build(); + } + + private static BidRequest givenBidRequest(UnaryOperator impCustomizer) { + return givenBidRequest(identity(), impCustomizer); + } + + private static Device givenDevice(UnaryOperator deviceCustomizer) { + return deviceCustomizer.apply(Device.builder()).build(); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder() + .id("123") + .ext(mapper.valueToTree(ExtPrebid.of(null, + ExtImpImpactify.of("appId", "format", "style"))))) + .build(); + } + + private static BidResponse givenBidResponse(UnaryOperator bidCustomizer) { + return BidResponse.builder() + .seatbid(List.of(SeatBid.builder() + .bid(List.of(bidCustomizer.apply(Bid.builder().impid("123")).build())) + .build())) + .build(); + } + + private static HttpCall givenHttpCall(BidRequest bidRequest, String body) { + return HttpCall.success( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/ImpactifyTest.java b/src/test/java/org/prebid/server/it/ImpactifyTest.java new file mode 100644 index 00000000000..d4e58997f55 --- /dev/null +++ b/src/test/java/org/prebid/server/it/ImpactifyTest.java @@ -0,0 +1,34 @@ +package org.prebid.server.it; + +import io.restassured.response.Response; +import org.json.JSONException; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.prebid.server.model.Endpoint; +import org.springframework.test.context.junit4.SpringRunner; + +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; + +@RunWith(SpringRunner.class) +public class ImpactifyTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromImpactify() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/impactify-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/impactify/test-impactify-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/impactify/test-impactify-bid-response.json")))); + // when + final Response response = responseFor("openrtb2/impactify/test-auction-impactify-request.json", + Endpoint.openrtb2_auction); + // then + assertJsonEquals("openrtb2/impactify/test-auction-impactify-response.json", + response, singletonList("impactify")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-auction-impactify-request.json b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-auction-impactify-request.json new file mode 100644 index 00000000000..4006623abaf --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-auction-impactify-request.json @@ -0,0 +1,27 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 320, + "h": 250 + }, + "bidfloor": 10, + "bidfloorcur": "USD", + "ext": { + "impactify": { + "appId": "appId", + "format": "format", + "style": "style" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-auction-impactify-response.json b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-auction-impactify-response.json new file mode 100644 index 00000000000..4bfd0bcee03 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-auction-impactify-response.json @@ -0,0 +1,35 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 0.01, + "adid": "2068416", + "cid": "8048", + "crid": "24080", + "ext": { + "prebid": { + "type": "banner" + }, + "origbidcpm": 0.01 + } + } + ], + "seat": "impactify", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "impactify": "{{ impactify.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-impactify-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-impactify-bid-request.json new file mode 100644 index 00000000000..08b94025306 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-impactify-bid-request.json @@ -0,0 +1,45 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 320, + "h": 250 + }, + "bidfloor": 10, + "bidfloorcur": "USD", + "ext": { + "impactify": { + "appId": "appId", + "format": "format", + "style": "style" + } + } + } + ], + "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": 5000, + "cur": [ + "USD" + ], + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-impactify-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-impactify-bid-response.json new file mode 100644 index 00000000000..2dd18dff6c6 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/impactify/test-impactify-bid-response.json @@ -0,0 +1,18 @@ +{ + "id": "tid", + "seatbid": [ + { + "bid": [ + { + "crid": "24080", + "adid": "2068416", + "price": 0.01, + "id": "bid_id", + "impid": "imp_id", + "cid": "8048" + } + ], + "type": "banner" + } + ] +} 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 5cc7be651b9..b2c6c6cae2f 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -117,6 +117,8 @@ adapters.grid.enabled=true adapters.grid.endpoint=http://localhost:8090/grid-exchange adapters.gumgum.enabled=true adapters.gumgum.endpoint=http://localhost:8090/gumgum-exchange +adapters.impactify.enabled=true +adapters.impactify.endpoint=http://localhost:8090/impactify-exchange adapters.improvedigital.enabled=true adapters.improvedigital.endpoint=http://localhost:8090/improvedigital-exchange adapters.iqzone.enabled=true