New adapter: BeOp

src/main/java/org/prebid/server/bidder/beop/BeopBidder.java

@@ -0,0 +1,149 @@
+package org.prebid.server.bidder.beop;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+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.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.http.client.utils.URIBuilder;
+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.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.beop.ExtImpBeop;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.BidderUtil;
+import org.prebid.server.util.HttpUtil;
+
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Objects;
+
+public class BeopBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpBeop>> BEOP_EXT_TYPE_REFERENCE = new TypeReference<>() {
+    };
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public BeopBidder(String endpointUrl, JacksonMapper mapper) {
+        this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
+        this.mapper = Objects.requireNonNull(mapper);
+    }
+
+    @Override
+    public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest bidRequest) {
+        final List<Imp> imps = bidRequest.getImp();
+
+        final ExtImpBeop extImpBeop;
+        try {
+            extImpBeop = parseImpExt(imps.getFirst());
+        } catch (PreBidException e) {
+            return Result.withError(BidderError.badInput(e.getMessage()));
+        }
+
+        final String resolvedUrl;
+        try {
+            resolvedUrl = buildEndpointUrl(extImpBeop);
+        } catch (PreBidException e) {
+            return Result.withError(BidderError.badInput(e.getMessage()));
+        }
+
+        return Result.withValue(BidderUtil.defaultRequest(bidRequest, resolvedUrl, mapper));
+    }
+
+    private ExtImpBeop parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), BEOP_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("ext.bidder not provided: " + e.getMessage());
+        }
+    }
+
+    private String buildEndpointUrl(ExtImpBeop ext) {
+        final URIBuilder uriBuilder;
+        try {
+            uriBuilder = new URIBuilder(endpointUrl);
+        } catch (URISyntaxException e) {
+            throw new PreBidException("Invalid endpoint URL: " + e.getMessage());
+        }
+
+        final String pid = StringUtils.trimToNull(ext.getPid());
+        if (StringUtils.isNotEmpty(pid)) {
+            uriBuilder.addParameter("pid", pid);
+        }
+
+        final String nid = StringUtils.trimToNull(ext.getNid());
+        if (StringUtils.isNotEmpty(nid)) {
+            uriBuilder.addParameter("nid", nid);
+        }
+
+        final String nptnid = StringUtils.trimToNull(ext.getNtpnid());
+        if (StringUtils.isNotEmpty(nptnid)) {
+            uriBuilder.addParameter("nptnid", nptnid);
+        }
+
+        return uriBuilder.toString();
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        final BidResponse bidResponse;
+        try {
+            bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Result.empty();
+        }
+
+        final List<BidderError> errors = new ArrayList<>();
+        final List<BidderBid> bids = extractBids(bidResponse, errors);
+        return Result.of(bids, errors);
+    }
+
+    private static List<BidderBid> extractBids(BidResponse bidResponse, List<BidderError> errors) {
+        return bidResponse.getSeatbid().stream()
+                .filter(Objects::nonNull)
+                .map(SeatBid::getBid)
+                .filter(Objects::nonNull)
+                .flatMap(Collection::stream)
+                .filter(Objects::nonNull)
+                .map(bid -> makeBidderBid(bid, bidResponse.getCur(), errors))
+                .filter(Objects::nonNull)
+                .toList();
+    }
+
+    private static BidderBid makeBidderBid(Bid bid, String currency, List<BidderError> errors) {
+        try {
+            return BidderBid.of(bid, resolveBidType(bid), currency);
+        } catch (PreBidException e) {
+            errors.add(BidderError.badServerResponse(e.getMessage()));
+            return null;
+        }
+    }
+
+    private static BidType resolveBidType(Bid bid) {
+        final Integer mtype = bid.getMtype();
+        return switch (mtype) {
+            case 1 -> BidType.banner;
+            case 2 -> BidType.video;
+            case null, default -> throw new PreBidException(
+                    "Failed to parse bid mtype for impression \"%s\"".formatted(bid.getImpid()));
+        };
+    }
+}

src/main/java/org/prebid/server/proto/openrtb/ext/request/beop/ExtImpBeop.java

@@ -0,0 +1,17 @@
+package org.prebid.server.proto.openrtb.ext.request.beop;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ExtImpBeop {
+
+    @JsonProperty("pid")
+    String pid;
+
+    @JsonProperty("nid")
+    String nid;
+
+    @JsonProperty("ntpnid")
+    String ntpnid;
+}

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

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

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

@@ -0,0 +1,14 @@
+adapters:
+  beop:
+    endpoint: "https://hb.collectiveaudience.co/rtb/bid"
+    ortb-version: "2.6"
+    endpoint-compression: gzip
+    geoscope:
+      - USA
+    meta-info:
+      maintainer-email: "tech@collectiveaudience.co"
+      site-media-types:
+        - banner
+        - video
+      supported-vendors: []
+      vendor-id: 666

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

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "BeOp Adapter Params",
+  "description": "A schema which validates params accepted by the BeOp adapter",
+  "type": "object",
+  "properties": {
+    "pid": {
+      "type": "string",
+      "description": "Beop publisher ID"
+    },
+    "nid": {
+      "type": "string",
+      "description": "Beop Network ID"
+    },
+    "ntpnid": {
+      "type": "string",
+      "description": "Network partner ID"
+    }
+  },
+  "oneOf": [
+    {
+      "required": [
+        "pid"
+      ]
+    },
+    {
+      "required": [
+        "nid",
+        "ntpnid"
+      ]
+    }
+  ]
+}