New Exco Adapter

src/main/java/org/prebid/server/bidder/exco/ExcoBidder.java

@@ -0,0 +1,153 @@
+package org.prebid.server.bidder.exco;
+
+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.Bid;
+import com.iab.openrtb.response.BidResponse;
+import com.iab.openrtb.response.SeatBid;
+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.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.exco.ExtImpExco;
+import org.prebid.server.proto.openrtb.ext.response.BidType;
+import org.prebid.server.util.BidderUtil;
+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.Optional;
+import java.util.stream.Collectors;
+
+public class ExcoBidder implements Bidder<BidRequest> {
+
+    private static final TypeReference<ExtPrebid<?, ExtImpExco>> EXCO_EXT_TYPE_REFERENCE = new TypeReference<>() {
+    };
+
+    private final String endpointUrl;
+    private final JacksonMapper mapper;
+
+    public ExcoBidder(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<Imp> modifiedImps = new ArrayList<>();
+
+        String publisherId = null;
+
+        for (Imp imp : request.getImp()) {
+            try {
+                final ExtImpExco extImp = parseImpExt(imp);
+                modifiedImps.add(imp.toBuilder().tagid(extImp.getTagId()).build());
+                publisherId = extImp.getPublisherId();
+            } catch (PreBidException e) {
+                return Result.withError(BidderError.badInput(e.getMessage()));
+            }
+        }
+
+        final BidRequest outgoingRequest = modifyRequest(request, modifiedImps, publisherId);
+        return Result.withValue(BidderUtil.defaultRequest(outgoingRequest, endpointUrl, mapper));
+    }
+
+    private ExtImpExco parseImpExt(Imp imp) {
+        try {
+            return mapper.mapper().convertValue(imp.getExt(), EXCO_EXT_TYPE_REFERENCE).getBidder();
+        } catch (IllegalArgumentException e) {
+            throw new PreBidException("Invalid imp.ext for impression %s. Error Information: %s"
+                    .formatted(imp.getId(), e.getMessage()));
+        }
+    }
+
+    private BidRequest modifyRequest(BidRequest request, List<Imp> imps, String publisherId) {
+        final Site site = request.getSite();
+        final App app = request.getApp();
+
+        return request.toBuilder()
+                .imp(imps)
+                .site(site != null ? modifySite(site, publisherId) : null)
+                .app(app != null ? modifyApp(app, publisherId) : null)
+                .build();
+    }
+
+    private static Site modifySite(Site site, String publisherId) {
+        return site.toBuilder().publisher(modifyPublisher(site.getPublisher(), publisherId)).build();
+    }
+
+    private static App modifyApp(App app, String publisherId) {
+        return app.toBuilder().publisher(modifyPublisher(app.getPublisher(), publisherId)).build();
+    }
+
+    private static Publisher modifyPublisher(Publisher publisher, String publisherId) {
+        return Optional.ofNullable(publisher)
+                .map(Publisher::toBuilder)
+                .orElseGet(Publisher::builder)
+                .id(publisherId)
+                .build();
+    }
+
+    @Override
+    public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequest bidRequest) {
+        try {
+            final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
+            final List<BidderError> errors = new ArrayList<>();
+            return Result.of(extractBids(bidResponse, errors), errors);
+        } catch (DecodeException e) {
+            return Result.withError(BidderError.badServerResponse(e.getMessage()));
+        }
+    }
+
+    private static List<BidderBid> extractBids(BidResponse bidResponse, List<BidderError> errors) {
+        if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) {
+            return Collections.emptyList();
+        }
+        return bidsFromResponse(bidResponse, errors);
+    }
+
+    private static List<BidderBid> bidsFromResponse(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)
+                .collect(Collectors.toList());
+    }
+
+    private static BidderBid makeBidderBid(Bid bid, String currency, List<BidderError> errors) {
+        final BidType bidType = getBidType(bid, errors);
+        return bidType != null
+                ? BidderBid.of(bid, bidType, currency)
+                : null;
+    }
+
+    private static BidType getBidType(Bid bid, List<BidderError> errors) {
+        return switch (bid.getMtype()) {
+            case 1 -> BidType.banner;
+            case 2 -> BidType.video;
+            case null, default -> {
+                errors.add(BidderError.badServerResponse(
+                        "unrecognized bid_ad_type in response from exco: " + bid.getMtype()));
+                yield null;
+            }
+        };
+    }
+}

src/main/java/org/prebid/server/bidder/zentotem/ZentotemBidder.java

@@ -61,7 +61,7 @@ public Result<List<BidderBid>> makeBids(BidderCall<BidRequest> httpCall, BidRequ
             final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class);
             final List<BidderError> errors = new ArrayList<>();
             return Result.of(extractBids(bidResponse, errors), errors);
-        } catch (DecodeException | PreBidException e) {
+        } catch (DecodeException e) {
             return Result.withError(BidderError.badServerResponse(e.getMessage()));
         }
     }

src/main/java/org/prebid/server/proto/openrtb/ext/request/exco/ExtImpExco.java

@@ -0,0 +1,17 @@
+package org.prebid.server.proto.openrtb.ext.request.exco;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Value;
+
+@Value(staticConstructor = "of")
+public class ExtImpExco {
+
+    @JsonProperty("accountId")
+    String accountId;
+
+    @JsonProperty("publisherId")
+    String publisherId;
+
+    @JsonProperty("tagId")
+    String tagId;
+}

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

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

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

@@ -0,0 +1,19 @@
+adapters:
+  exco:
+    endpoint: https://v.ex.co/se/openrtb/hb/pbs
+    meta-info:
+      maintainer-email: [email protected]
+      app-media-types:
+        - banner
+        - video
+      site-media-types:
+        - banner
+        - video
+      supported-vendors:
+      vendor-id: 444
+    usersync:
+      cookie-family-name: exco
+      redirect:
+        url: https://sync.ex.co/v1/user_sync?gdpr={{gdpr}}&gdpr_consent={{gdpr_consent}}&us_privacy={{us_privacy}}&redirect={{redirect_url}}
+        support-cors: false
+        uid-macro: '[UID]'

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

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "The Exco Adapter Params",
+  "description": "A schema which validates params accepted by Exco adapter",
+  "type": "object",
+  "properties": {
+    "accountId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "A unique account identifier provided by EX.CO."
+    },
+    "publisherId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Publisher ID provided by EX.CO."
+    },
+    "tagId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "A unique Tag ID (supply id) identifier provided by EX.CO."
+    }
+  },
+  "required": [
+    "accountId",
+    "publisherId",
+    "tagId"
+  ]
+}