Implement Outbrain bidder (#1229)

src/main/java/org/prebid/server/bidder/outbrain/OutbrainBidder.java

@@ -0,0 +1,177 @@
+package org.prebid.server.bidder.outbrain;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.iab.openrtb.request.App;
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Publisher;
+import com.iab.openrtb.request.Site;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+import io.vertx.core.http.HttpMethod;
+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.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.outbrains.ExtImpOutbrain;
+import org.prebid.server.proto.openrtb.ext.request.outbrains.ExtImpOutbrainPublisher;
+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.Objects;
+import java.util.stream.Collectors;
+
+/**
+ * Outbrain {@link Bidder} implementation.
+ */
+public class OutbrainBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpOutbrain>> OUTBRAIN_EXT_TYPE_REFERENCE =
+            new TypeReference<ExtPrebid<?, ExtImpOutbrain>>() {
+            };
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public OutbrainBidder(String endpointUrl, JacksonMapper mapper) {
+        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    @Override
+    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest request) {
+        final List<BidderError> errors = new ArrayList<>();
+        final List<Imp> modifiedImps = new ArrayList<>();
+
+        ExtImpOutbrain extImpOutbrain = null;
+        for (Imp imp : request.getImp()) {
+            try {
+                extImpOutbrain = parseImpExt(imp);
+                modifiedImps.add(modifyImp(imp, extImpOutbrain.getTagid()));
+            } catch (PreBidException e) {
+                errors.add(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        if (!errors.isEmpty()) {
+            return Result.withErrors(errors);
+        }
+
+        final BidRequest updatedRequest = updateBidRequest(request, modifiedImps, extImpOutbrain);
+
+        return Result.of(Collections.singletonList(
+                HttpRequest.<BidRequest>builder()
+                        .method(HttpMethod.POST)
+                        .uri(endpointUrl)
+                        .body(mapper.encode(updatedRequest))
+                        .headers(HttpUtil.headers())
+                        .payload(updatedRequest)
+                        .build()), errors);
+    }
+
+    private ExtImpOutbrain parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), OUTBRAIN_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException(String.format("Impression id=%s, has invalid Ext", imp.getId()));
+        }
+    }
+
+    private static Imp modifyImp(Imp imp, String tagId) {
+        return imp.toBuilder()
+                .tagid(tagId)
+                .build();
+    }
+
+    private static BidRequest updateBidRequest(BidRequest bidRequest, List<Imp> imps, ExtImpOutbrain extImpOutbrain) {
+        final BidRequest.BidRequestBuilder bidRequestBuilder = bidRequest.toBuilder();
+        final Publisher publisher = createPublisher(extImpOutbrain.getPublisher());
+
+        final Site site = bidRequest.getSite();
+        final App app = bidRequest.getApp();
+        if (site != null) {
+            bidRequestBuilder.site(updateSite(site, publisher));
+        } else if (app != null) {
+            bidRequestBuilder.app(updateApp(app, publisher));
+        }
+
+        final List<String> bcat = extImpOutbrain.getBcat();
+        if (CollectionUtils.isNotEmpty(bcat)) {
+            bidRequestBuilder.bcat(bcat);
+        }
+
+        final List<String> badv = extImpOutbrain.getBadv();
+        if (CollectionUtils.isNotEmpty(badv)) {
+            bidRequestBuilder.badv(badv);
+        }
+
+        return bidRequestBuilder.imp(imps).build();
+    }
+
+    private static Publisher createPublisher(ExtImpOutbrainPublisher extImpPublisher) {
+        return Publisher.builder()
+                .id(extImpPublisher.getId())
+                .name(extImpPublisher.getName())
+                .domain(extImpPublisher.getDomain())
+                .build();
+    }
+
+    private static Site updateSite(Site site, Publisher publisher) {
+        return site.toBuilder().publisher(publisher).build();
+    }
+
+    private static App updateApp(App app, Publisher publisher) {
+        return app.toBuilder().publisher(publisher).build();
+    }
+
+    @Override
+    public final Result<List<BidderBid>> makeBids(HttpCall<BidRequest> httpCall, BidRequest bidRequest) {
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            return Result.of(extractBids(httpCall.getRequest().getPayload(), bidResponse), Collections.emptyList());
+        } catch (DecodeException | PreBidException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidRequest bidRequest, BidResponse bidResponse) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidRequest, bidResponse);
+    }
+
+    private static List<BidderBid> bidsFromResponse(BidRequest bidRequest, BidResponse bidResponse) {
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .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<Imp> imps) {
+        for (Imp imp : imps) {
+            if (imp.getId().equals(impId)) {
+                if (imp.getXNative() != null) {
+                    return BidType.xNative;
+                } else if (imp.getBanner() != null) {
+                    return BidType.banner;
+                }
+            }
+        }
+        throw new PreBidException(String.format("Failed to find native/banner impression \"%s\"", impId));
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/outbrains/ExtImpOutbrain.java

@@ -0,0 +1,19 @@
+package org.prebid.server.proto.openrtb.ext.request.outbrains;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+import java.util.List;
+
+@Value
+@AllArgsConstructor(staticName = "of")
+public class ExtImpOutbrain {
+
+    ExtImpOutbrainPublisher publisher;
+
+    String tagid;
+
+    List<String> bcat;
+
+    List<String> badv;
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/outbrains/ExtImpOutbrainPublisher.java

@@ -0,0 +1,15 @@
+package org.prebid.server.proto.openrtb.ext.request.outbrains;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+@Value
+@AllArgsConstructor(staticName = "of")
+public class ExtImpOutbrainPublisher {
+
+    String id;
+
+    String name;
+
+    String domain;
+}

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

@@ -0,0 +1,51 @@
+package org.prebid.server.spring.config.bidder;
+
+import org.prebid.server.bidder.BidderDeps;
+import org.prebid.server.bidder.outbrain.OutbrainBidder;
+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.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/outbrain.yaml", factory = YamlPropertySourceFactory.class)
+public class OutbrainConfiguration {
+
+    private static final String BIDDER_NAME = "outbrain";
+
+    @Value("${external-url}")
+    @NotBlank
+    private String externalUrl;
+
+    @Autowired
+    private JacksonMapper mapper;
+
+    @Autowired
+    @Qualifier("outbrainConfigurationProperties")
+    private BidderConfigurationProperties configProperties;
+
+    @Bean("outbrainConfigurationProperties")
+    @ConfigurationProperties("adapters.outbrain")
+    BidderConfigurationProperties configurationProperties() {
+        return new BidderConfigurationProperties();
+    }
+
+    @Bean
+    BidderDeps outbrainBidderDeps() {
+        return BidderDepsAssembler.forBidder(BIDDER_NAME)
+                .withConfig(configProperties)
+                .usersyncerCreator(UsersyncerCreator.create(externalUrl))
+                .bidderCreator(config -> new OutbrainBidder(config.getEndpoint(), mapper))
+                .assemble();
+    }
+}

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

@@ -0,0 +1,25 @@
+adapters:
+  outbrain:
+    enabled: false
+    endpoint: https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/
+    pbs-enforces-gdpr: true
+    pbs-enforces-ccpa: true
+    modifying-vast-xml-allowed: true
+    deprecated-names:
+    aliases: {}
+    meta-info:
+      maintainer-email: prog-ops-team@outbrain.com
+      app-media-types:
+        - banner
+        - native
+      site-media-types:
+        - banner
+        - native
+      supported-vendors:
+      vendor-id: 164
+    usersync:
+      url: https://prebidtest.zemanta.com/usersync/prebidtest?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&cb=
+      redirect-url: /setuid?bidder=outbrain&gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&uid=__ZUID__
+      cookie-family-name: outbrain
+      type: redirect
+      support-cors: false

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

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Outbrain Adapter Params",
+  "description": "A schema which validates params accepted by the Outbrain adapter",
+
+  "type": "object",
+  "properties": {
+    "publisher": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "domain": {
+          "type": "string"
+        }
+      },
+      "required": ["id"]
+    },
+    "tagid": {
+      "type": "string"
+    },
+    "bcat": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "badv": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": ["publisher"]
+}