Add Adhese bidder

src/main/java/org/prebid/server/bidder/adhese/AdheseBidder.java

@@ -0,0 +1,279 @@
+package org.prebid.server.bidder.adhese;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Site;
+import com.iab.openrtb.request.User;
+import com.iab.openrtb.response.Bid;
+import com.iab.openrtb.response.SeatBid;
+import io.netty.handler.codec.http.HttpResponseStatus;
+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.adhese.model.AdheseBid;
+import org.prebid.server.bidder.adhese.model.AdheseOriginData;
+import org.prebid.server.bidder.adhese.model.AdheseResponseExt;
+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.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.ExtUser;
+import org.prebid.server.proto.openrtb.ext.request.adhese.ExtImpAdhese;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.HttpUtil;
+
+import java.math.BigDecimal;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.TreeMap;
+import java.util.stream.Collectors;
+
+public class AdheseBidder implements Bidder<Void> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpAdhese>> ADHESE_EXT_TYPE_REFERENCE =
+            new TypeReference<ExtPrebid<?, ExtImpAdhese>>() {
+            };
+
+    private static final String DEFAULT_BID_CURRENCY = "USD";
+    private static final String ORIGIN = "JERLICIA";
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public AdheseBidder(String endpointUrl, JacksonMapper mapper) {
+        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    @Override
+    public Result<List<HttpRequest<Void>>> makeHttpRequests(BidRequest request) {
+        if (CollectionUtils.isEmpty(request.getImp())) {
+            return Result.emptyWithError(BidderError.badInput("No impression in the bid request"));
+        }
+
+        ExtImpAdhese extImpAdhese;
+        try {
+            extImpAdhese = parseImpExt(request.getImp().get(0));
+        } catch (PreBidException e) {
+            return Result.emptyWithError(BidderError.badInput(e.getMessage()));
+        }
+
+        final String uri = buildUrl(request, endpointUrl, extImpAdhese);
+
+        return Result.of(Collections.singletonList(
+                HttpRequest.<Void>builder()
+                        .method(HttpMethod.GET)
+                        .uri(uri)
+                        .body(null)
+                        .headers(HttpUtil.headers())
+                        .payload(null)
+                        .build()),
+                Collections.emptyList());
+    }
+
+    private ExtImpAdhese parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), ADHESE_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException(e.getMessage(), e);
+        }
+    }
+
+    private String buildUrl(BidRequest request, String endpointUrl, ExtImpAdhese extImpAdhese) {
+        final String uri = endpointUrl.replace("{{AccountId}}", extImpAdhese.getAccount());
+        final String slotParameter = String.format("/sl%s-%s", HttpUtil.encodeUrl(extImpAdhese.getLocation()),
+                HttpUtil.encodeUrl(extImpAdhese.getFormat()));
+
+        return String.format("%s%s%s%s%s", uri, slotParameter, getTargetParameters(extImpAdhese),
+                getGdprParameter(request.getUser()), getRefererParameter(request.getSite()));
+    }
+
+    private String getTargetParameters(ExtImpAdhese extImpAdhese) {
+        if (extImpAdhese.getKeywords().isNull()) {
+            return "";
+        }
+
+        final Map<String, List<String>> targetParameters = parseTargetParametersAndSort(extImpAdhese.getKeywords());
+        return targetParameters.entrySet().stream()
+                .map(stringListEntry -> createPartOrUrl(stringListEntry.getKey(), stringListEntry.getValue()))
+                .collect(Collectors.joining());
+    }
+
+    private Map<String, List<String>> parseTargetParametersAndSort(JsonNode keywords) {
+        return keywords != null ? new TreeMap<>(
+                mapper.mapper().convertValue(keywords, new TypeReference<Map<String, List<String>>>() {
+                })) : null;
+    }
+
+    private String createPartOrUrl(String key, List<String> values) {
+        final String formattedValues = String.join(";", values);
+        return String.format("/%s%s", HttpUtil.encodeUrl(key), formattedValues);
+    }
+
+    private String getGdprParameter(User user) {
+        final ExtUser extUser = user != null ? user.getExt() : null;
+        final String consent = extUser != null ? extUser.getConsent() : null;
+        return StringUtils.isNotBlank(consent) ? String.format("%s%s", "/xt", consent) : "";
+    }
+
+    private String getRefererParameter(Site site) {
+        final String page = site != null ? site.getPage() : null;
+        return StringUtils.isNotBlank(page) ? String.format("%s%s", "/xf", HttpUtil.encodeUrl(page)) : "";
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(HttpCall<Void> httpCall, BidRequest bidRequest) {
+        final int statusCode = httpCall.getResponse().getStatusCode();
+        if (statusCode == HttpResponseStatus.NO_CONTENT.code()) {
+            return Result.of(Collections.emptyList(), Collections.emptyList());
+        } else if (statusCode == HttpResponseStatus.BAD_REQUEST.code()) {
+            return Result.emptyWithError(BidderError.badInput("Invalid request."));
+        } else if (statusCode != HttpResponseStatus.OK.code()) {
+            return Result.emptyWithError(BidderError.badServerResponse(String.format("Unexpected HTTP status %s.",
+                    statusCode)));
+        }
+
+        final List<AdheseBid> adheseBid;
+        final List<AdheseResponseExt> adheseResponseExt;
+        final List<AdheseOriginData> adheseOriginData;
+        SeatBid seatBid;
+        try {
+            adheseBid = decodeBodyToBidList(httpCall, AdheseBid.class);
+            if (Objects.equals(adheseBid.get(0).getOrigin(), ORIGIN)) {
+                adheseResponseExt = decodeBodyToBidList(httpCall, AdheseResponseExt.class);
+                adheseOriginData = decodeBodyToBidList(httpCall, AdheseOriginData.class);
+                seatBid = convertAdheseBid(adheseBid.get(0), adheseResponseExt.get(0), adheseOriginData.get(0));
+            } else {
+                seatBid = convertAdheseOpenRtbBid(adheseBid.get(0));
+            }
+        } catch (PreBidException e) {
+            return Result.emptyWithError(BidderError.badServerResponse(e.getMessage()));
+        }
+
+        final BigDecimal price = new BigDecimal(adheseBid.get(0).getExtension().getPrebid().getCpm().getAmount());
+        final Integer width = Integer.valueOf(adheseBid.get(0).getWidth());
+        final Integer height = Integer.valueOf(adheseBid.get(0).getHeight());
+
+        SeatBid updateSeatBid = null;
+        if (seatBid != null && CollectionUtils.isNotEmpty(seatBid.getBid())) {
+            final Bid bid = seatBid.getBid().get(0);
+            updateSeatBid = seatBid.toBuilder()
+                    .bid(Collections.singletonList(Bid.builder()
+                            .price(price)
+                            .w(width)
+                            .h(height)
+                            .dealid(bid.getDealid())
+                            .crid(bid.getCrid())
+                            .adm(bid.getAdm())
+                            .ext(bid.getExt())
+                            .build()))
+                    .build();
+        }
+
+        if (updateSeatBid == null) {
+            return Result.emptyWithError(BidderError
+                    .badServerResponse("Response resulted in an empty seatBid array. %s."));
+        }
+
+        /**
+         * Used ImpId from Imp of bidRequest, because it is not provided and should be not empty value
+         */
+        final List<BidderError> errors = new ArrayList<>();
+        final List<BidderBid> bidderBids = updateSeatBid.getBid().stream()
+                .filter(Objects::nonNull)
+                .map(bid -> makeBid(bid, bidRequest.getImp().get(0).getId(), errors))
+                .filter(Objects::nonNull)
+                .collect(Collectors.toList());
+        return Result.of(bidderBids, errors);
+    }
+
+    private <T> List<T> decodeBodyToBidList(HttpCall<Void> httpCall, Class<T> bidClassName) {
+        try {
+            return mapper.mapper().readValue(
+                    httpCall.getResponse().getBody(),
+                    mapper.mapper().getTypeFactory().constructCollectionType(List.class, bidClassName));
+        } catch (DecodeException | JsonProcessingException e) {
+            throw new PreBidException(e.getMessage(), e);
+        }
+    }
+
+    private SeatBid convertAdheseBid(AdheseBid adheseBid, AdheseResponseExt adheseResponseExt,
+                                     AdheseOriginData adheseOriginData) {
+        final ObjectNode adheseExtJson = mapper.mapper().valueToTree(adheseOriginData);
+
+        return SeatBid.builder()
+                .bid(Collections.singletonList(Bid.builder()
+                        .id("1")
+                        .dealid(adheseResponseExt.getOrderId())
+                        .crid(adheseResponseExt.getId())
+                        .adm(getAdMarkup(adheseBid, adheseResponseExt))
+                        .ext(adheseExtJson)
+                        .build()))
+                .seat("")
+                .build();
+    }
+
+    private String getAdMarkup(AdheseBid adheseBid, AdheseResponseExt adheseResponseExt) {
+        if (Objects.equals(adheseResponseExt.getExt(), "js")) {
+            if (StringUtils.containsAny(adheseBid.getBody(), "<script", "<div", "<html")) {
+                String counter = "";
+                if (adheseResponseExt.getImpressionCounter().length() > 0) {
+                    counter = String.format("%s%s%s", "<img src='", adheseResponseExt.getImpressionCounter(),
+                            "' style='height:1px; width:1px; margin: -1px -1px; display:none;'/>");
+                }
+                return String.format("%s%s", adheseBid.getBody(), counter);
+            }
+            if (StringUtils.containsAny(adheseBid.getBody(), "<?xml", "<vast")) {
+                return adheseBid.getBody();
+            }
+        }
+        return adheseResponseExt.getTag();
+    }
+
+    private SeatBid convertAdheseOpenRtbBid(AdheseBid adheseBid) {
+        return (CollectionUtils.isNotEmpty(adheseBid.getOriginData().getSeatbid())
+                && CollectionUtils.isNotEmpty(adheseBid.getOriginData().getSeatbid().get(0).getBid()))
+                ? SeatBid.builder()
+                .bid(Collections.singletonList(Bid.builder().adm(adheseBid.getBody()).build()))
+                .build()
+                : null;
+    }
+
+    private static BidderBid makeBid(Bid bid, String impId, List<BidderError> errors) {
+        /**
+         * Hardcoded bidId =1, because it is not provided and should be not empty value
+         */
+        try {
+            final BidType bidType = getBidType(bid.getAdm());
+            final Bid updateBid = bid.toBuilder().id("1").impid(impId).build();
+            return BidderBid.of(updateBid, bidType, DEFAULT_BID_CURRENCY);
+        } catch (PreBidException e) {
+            errors.add(BidderError.badInput(e.getMessage()));
+            return null;
+        }
+    }
+
+    private static BidType getBidType(String bidAdm) {
+        return (StringUtils.isNotBlank(bidAdm) && StringUtils.containsAny(bidAdm, "<?xml", "<vast"))
+                ? BidType.video
+                : BidType.banner;
+    }
+
+    @Override
+    public Map<String, String> extractTargeting(ObjectNode ext) {
+        return Collections.emptyMap();
+    }
+}

src/main/java/org/prebid/server/bidder/adhese/model/AdheseBid.java

@@ -0,0 +1,27 @@
+package org.prebid.server.bidder.adhese.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.iab.openrtb.response.BidResponse;
+import lombok.Builder;
+import lombok.Value;
+
+@Builder
+@Value
+public class AdheseBid {
+
+    String origin;
+
+    @JsonProperty("originData")
+    BidResponse originData;
+
+    @JsonProperty("originInstance")
+    String originInstance;
+
+    String body;
+
+    String height;
+
+    String width;
+
+    Prebid extension;
+}

src/main/java/org/prebid/server/bidder/adhese/model/AdheseOriginData.java

@@ -0,0 +1,33 @@
+package org.prebid.server.bidder.adhese.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@AllArgsConstructor(staticName = "of")
+@Value
+public class AdheseOriginData {
+
+    String priority;
+
+    @JsonProperty("orderProperty")
+    String orderProperty;
+
+    @JsonProperty("adFormat")
+    String adFormat;
+
+    @JsonProperty("adType")
+    String adType;
+
+    @JsonProperty("adspaceId")
+    String adspaceId;
+
+    @JsonProperty("libId")
+    String libId;
+
+    @JsonProperty("slotId")
+    String slotId;
+
+    @JsonProperty("viewableImpressionCounter")
+    String viewableImpressionCounter;
+}

src/main/java/org/prebid/server/bidder/adhese/model/AdheseResponseExt.java

@@ -0,0 +1,22 @@
+package org.prebid.server.bidder.adhese.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@AllArgsConstructor(staticName = "of")
+@Value
+public class AdheseResponseExt {
+
+    String id;
+
+    @JsonProperty("orderId")
+    String orderId;
+
+    @JsonProperty("impressionCounter")
+    String impressionCounter;
+
+    String tag;
+
+    String ext;
+}

src/main/java/org/prebid/server/bidder/adhese/model/CPM.java

@@ -0,0 +1,11 @@
+package org.prebid.server.bidder.adhese.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@AllArgsConstructor(staticName = "of")
+@Value
+public class CPM {
+
+    CPMValues cpm;
+}

src/main/java/org/prebid/server/bidder/adhese/model/CPMValues.java

@@ -0,0 +1,13 @@
+package org.prebid.server.bidder.adhese.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@AllArgsConstructor(staticName = "of")
+@Value
+public class CPMValues {
+
+    String amount;
+
+    String currency;
+}