Add Pubnative bidder implementation (#580)

src/main/java/org/prebid/server/bidder/pubnative/PubnativeBidder.java

@@ -0,0 +1,180 @@
+package org.prebid.server.bidder.pubnative;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+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.Format;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import io.netty.handler.codec.http.HttpResponseStatus;
+import io.vertx.core.http.HttpMethod;
+import io.vertx.core.json.DecodeException;
+import io.vertx.core.json.Json;
+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.HttpResponse;
+import org.prebid.server.bidder.model.Result;
+import org.prebid.server.exception.PreBidException;
+import org.prebid.server.proto.openrtb.ext.ExtPrebid;
+import org.prebid.server.proto.openrtb.ext.request.pubnative.ExtImpPubnative;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.HttpUtil;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+public class PubnativeBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpPubnative>> PUBNATIVE_EXT_TYPE_REFERENCE =
+            new TypeReference<ExtPrebid<?, ExtImpPubnative>>() {
+            };
+    private static final String DEFAULT_BID_CURRENCY = "USD";
+
+    private final String endpointUrl;
+
+    public PubnativeBidder(String endpointUrl) {
+        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+    }
+
+    @Override
+    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest bidRequest) {
+        final Device device = bidRequest.getDevice();
+        if (device == null || StringUtils.isBlank(device.getOs())) {
+            return Result.emptyWithError(BidderError.badInput("Impression is missing device OS information"));
+        }
+
+        final List<HttpRequest<BidRequest>> httpRequests = new ArrayList<>();
+        final List<BidderError> errors = new ArrayList<>();
+        for (Imp imp : bidRequest.getImp()) {
+            try {
+                validateImp(imp);
+                final ExtImpPubnative extImpPubnative = parseImpExt(imp.getExt());
+                final BidRequest outgoingRequest = modifyRequest(bidRequest, imp);
+                httpRequests.add(createHttpRequest(outgoingRequest, extImpPubnative));
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        return Result.of(httpRequests, errors);
+    }
+
+    private static void validateImp(Imp imp) {
+        if (imp.getBanner() == null && imp.getVideo() == null && imp.getXNative() == null) {
+            throw new PreBidException("Pubnative only supports banner, video or native ads.");
+        }
+    }
+
+    private static ExtImpPubnative parseImpExt(ObjectNode impExt) {
+        try {
+            return Json.mapper.convertValue(impExt, PUBNATIVE_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException(e.getMessage());
+        }
+    }
+
+    private static BidRequest modifyRequest(BidRequest bidRequest, Imp imp) {
+        final BidRequest.BidRequestBuilder bidRequestBuilder = bidRequest.toBuilder()
+                .test(0);
+
+        Imp outgoingImp = imp;
+        final Banner banner = imp.getBanner();
+        if (banner != null) {
+            final Integer bannerHeight = banner.getH();
+            final Integer bannerWidth = banner.getW();
+            if (bannerWidth == null || bannerWidth == 0 || bannerHeight == null || bannerHeight == 0) {
+                final List<Format> bannerFormats = banner.getFormat();
+                if (CollectionUtils.isEmpty(bannerFormats)) {
+                    throw new PreBidException("Size information missing for banner");
+                }
+
+                final Format firstFormat = bannerFormats.get(0);
+                final Banner modifiedBanner = banner.toBuilder()
+                        .h(firstFormat.getH())
+                        .w(firstFormat.getW())
+                        .build();
+                outgoingImp = imp.toBuilder().banner(modifiedBanner).build();
+            }
+        }
+
+        return bidRequestBuilder
+                .imp(Collections.singletonList(outgoingImp))
+                .build();
+    }
+
+    private HttpRequest<BidRequest> createHttpRequest(BidRequest outgoingRequest, ExtImpPubnative impExt) {
+        final String requestUri = String.format("%s?apptoken=%s&zoneid=%s", endpointUrl, impExt.getAppAuthToken(),
+                impExt.getZoneId());
+
+        return HttpRequest.<BidRequest>builder()
+                .method(HttpMethod.POST)
+                .uri(requestUri)
+                .headers(HttpUtil.headers())
+                .body(Json.encode(outgoingRequest))
+                .payload(outgoingRequest)
+                .build();
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(HttpCall<BidRequest> httpCall, BidRequest bidRequest) {
+        final HttpResponse httpResponse = httpCall.getResponse();
+        if (httpResponse.getStatusCode() == HttpResponseStatus.NO_CONTENT.code()) {
+            return Result.of(Collections.emptyList(), Collections.emptyList());
+        }
+
+        try {
+            final BidResponse bidResponse = Json.decodeValue(httpResponse.getBody(), BidResponse.class);
+            return Result.of(extractBids(bidResponse, httpCall.getRequest().getPayload()), Collections.emptyList());
+        } catch (DecodeException e) {
+            return Result.emptyWithError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidResponse bidResponse, BidRequest bidRequest) {
+        return bidResponse == null || bidResponse.getSeatbid() == null
+                ? Collections.emptyList()
+                : bidsFromResponse(bidResponse.getSeatbid(), bidRequest.getImp());
+    }
+
+    private static List<BidderBid> bidsFromResponse(List<SeatBid> seatbid, List<Imp> imps) {
+        return seatbid.stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .map(bid -> BidderBid.of(bid, resolveBidType(bid.getImpid(), imps), DEFAULT_BID_CURRENCY))
+                .collect(Collectors.toList());
+    }
+
+    private static BidType resolveBidType(String impid, List<Imp> imps) {
+        for (Imp imp : imps) {
+            if (imp.getId().equals(impid)) {
+                if (imp.getVideo() != null) {
+                    return BidType.video;
+                }
+                if (imp.getXNative() != null) {
+                    return BidType.xNative;
+                }
+            }
+        }
+        return BidType.banner;
+    }
+
+    @Override
+    public Map<String, String> extractTargeting(ObjectNode ext) {
+        return Collections.emptyMap();
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/pubnative/ExtImpPubnative.java

@@ -0,0 +1,16 @@
+package org.prebid.server.proto.openrtb.ext.request.pubnative;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+/**
+ * Defines the contract for bidRequest.imp[i].ext.pubnative
+ */
+@AllArgsConstructor(staticName = "of")
+@Value
+public class ExtImpPubnative {
+
+    Integer zoneId;
+
+    String appAuthToken;
+}

src/main/java/org/prebid/server/spring/config/bidder/PubnativeConfiguration.java

@@ -0,0 +1,49 @@
+package org.prebid.server.spring.config.bidder;
+
+import org.prebid.server.bidder.BidderDeps;
+import org.prebid.server.bidder.pubnative.PubnativeBidder;
+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.BidderInfoCreator;
+import org.prebid.server.spring.config.bidder.util.UsersyncerCreator;
+import org.prebid.server.spring.env.YamlPropertySourceFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+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/pubnative.yaml", factory = YamlPropertySourceFactory.class)
+public class PubnativeConfiguration {
+
+    private static final String BIDDER_NAME = "pubnative";
+
+    @Value("${external-url}")
+    @NotBlank
+    private String externalUrl;
+
+    @Autowired
+    @Qualifier("pubnativeConfigurationProperties")
+    private BidderConfigurationProperties configProperties;
+
+    @Bean("pubnativeConfigurationProperties")
+    @ConfigurationProperties("adapters.pubnative")
+    BidderConfigurationProperties configurationProperties() {
+        return new BidderConfigurationProperties();
+    }
+
+    @Bean
+    BidderDeps pubnativeBidderDeps() {
+        return BidderDepsAssembler.forBidder(BIDDER_NAME)
+                .withConfig(configProperties)
+                .bidderInfo(BidderInfoCreator.create(configProperties))
+                .usersyncerCreator(UsersyncerCreator.create(configProperties.getUsersync(), externalUrl))
+                .bidderCreator(() -> new PubnativeBidder(configProperties.getEndpoint()))
+                .assemble();
+    }
+}

src/main/resources/bidder-config/pubnative.yaml

@@ -0,0 +1,26 @@
+adapters:
+  pubnative:
+    enabled: false
+    endpoint: http://dsp.pubnative.net/bid/v1/request
+    pbs-enforces-gdpr: true
+    modifying-vast-xml-allowed: true
+    deprecated-names:
+    aliases:
+    meta-info:
+      maintainer-email: product@pubnative.net
+      app-media-types:
+        - banner
+        - video
+        - native
+      site-media-types:
+        - banner
+        - video
+        - native
+      supported-vendors:
+      vendor-id: 0
+    usersync:
+      url:
+      redirect-url:
+      cookie-family-name: pubnative
+      type: redirect
+      support-cors: false

src/main/resources/static/bidder-params/pubnative.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Pubnative Adapter Params",
+  "description": "A schema which validates params accepted by the Pubnative adapter",
+  "type": "object",
+  "properties": {
+    "zone_id": {
+      "type": "integer",
+      "description": "The ad zone identifier"
+    },
+    "app_auth_token": {
+      "type": "string",
+      "description": "The app's authentication token"
+    }
+  },
+  "required": [
+    "zone_id",
+    "app_auth_token"
+  ]
+}