Add supporting gdpr and us_privacy to ConsumableBidder

src/main/java/org/prebid/server/bidder/consumable/ConsumableBidder.java

@@ -5,6 +5,7 @@
 import com.iab.openrtb.request.Device;
 import com.iab.openrtb.request.Format;
 import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Regs;
 import com.iab.openrtb.request.Site;
 import com.iab.openrtb.request.User;
 import com.iab.openrtb.response.Bid;
@@ -14,6 +15,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.prebid.server.bidder.Bidder;
 import org.prebid.server.bidder.consumable.model.ConsumableAdType;
+import org.prebid.server.bidder.consumable.model.ConsumableBidGdpr;
 import org.prebid.server.bidder.consumable.model.ConsumableBidRequest;
 import org.prebid.server.bidder.consumable.model.ConsumableBidResponse;
 import org.prebid.server.bidder.consumable.model.ConsumableDecision;
@@ -28,6 +30,8 @@
 import org.prebid.server.json.DecodeException;
 import org.prebid.server.json.EncodeException;
 import org.prebid.server.json.JacksonMapper;
+import org.prebid.server.proto.openrtb.ext.request.ExtRegs;
+import org.prebid.server.proto.openrtb.ext.request.ExtUser;
 import org.prebid.server.proto.openrtb.ext.request.consumable.ExtImpConsumable;
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 import org.prebid.server.util.HttpUtil;
@@ -65,6 +69,28 @@ public Result<List<HttpRequest<ConsumableBidRequest>>> makeHttpRequests(BidReque
                     .url(site.getPage());
         }
 
+        final Regs regs = request.getRegs();
+        final ExtRegs extRegs = regs != null ? regs.getExt() : null;
+        final String usPrivacy = extRegs != null ? extRegs.getUsPrivacy() : null;
+        if (usPrivacy != null) {
+            requestBuilder.usPrivacy(usPrivacy);
+        }
+
+        final Integer gdpr = extRegs != null ? extRegs.getGdpr() : null;
+        final User user = request.getUser();
+        final ExtUser extUser = user != null ? user.getExt() : null;
+        final String gdprConsent = extUser != null ? extUser.getConsent() : null;
+        if (gdpr != null || gdprConsent != null) {
+            final ConsumableBidGdpr.ConsumableBidGdprBuilder bidGdprBuilder = ConsumableBidGdpr.builder();
+            if (gdpr != null) {
+                bidGdprBuilder.applies(gdpr != 0);
+            }
+            if (gdprConsent != null) {
+                bidGdprBuilder.consent(gdprConsent).build();
+            }
+            requestBuilder.gdpr(bidGdprBuilder.build());
+        }
+
         try {
             resolveRequestFields(requestBuilder, request.getImp());
         } catch (PreBidException e) {
@@ -163,7 +189,6 @@ public Result<List<BidderBid>> makeBids(HttpCall<ConsumableBidRequest> httpCall,
         } catch (DecodeException e) {
             return Result.emptyWithError(BidderError.badServerResponse(e.getMessage()));
         }
-
         final List<BidderError> errors = new ArrayList<>();
         final List<BidderBid> bidderBids = extractBids(bidRequest, consumableResponse.getDecisions(), errors);
         return Result.of(bidderBids, errors);
@@ -172,7 +197,6 @@ public Result<List<BidderBid>> makeBids(HttpCall<ConsumableBidRequest> httpCall,
     private static List<BidderBid> extractBids(BidRequest bidRequest, Map<String, ConsumableDecision> impIdToDecisions,
                                                List<BidderError> errors) {
         final List<BidderBid> bidderBids = new ArrayList<>();
-
         for (Map.Entry<String, ConsumableDecision> entry : impIdToDecisions.entrySet()) {
             final ConsumableDecision decision = entry.getValue();
 

src/main/java/org/prebid/server/bidder/consumable/model/ConsumableBidGdpr.java

@@ -0,0 +1,13 @@
+package org.prebid.server.bidder.consumable.model;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Builder
+@Value
+public class ConsumableBidGdpr {
+
+    Boolean applies;
+
+    String consent;
+}

src/main/java/org/prebid/server/bidder/consumable/model/ConsumableBidRequest.java

@@ -41,4 +41,8 @@ public class ConsumableBidRequest {
     Boolean enableBotFiltering;
 
     Boolean parallel;
+
+    String usPrivacy;
+
+    ConsumableBidGdpr gdpr;
 }

src/test/java/org/prebid/server/bidder/consumable/ConsumableBidderTest.java

@@ -6,6 +6,7 @@
 import com.iab.openrtb.request.Device;
 import com.iab.openrtb.request.Format;
 import com.iab.openrtb.request.Imp;
+import com.iab.openrtb.request.Regs;
 import com.iab.openrtb.request.Site;
 import com.iab.openrtb.request.User;
 import com.iab.openrtb.response.Bid;
@@ -14,6 +15,7 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.prebid.server.VertxTest;
+import org.prebid.server.bidder.consumable.model.ConsumableBidGdpr;
 import org.prebid.server.bidder.consumable.model.ConsumableBidRequest;
 import org.prebid.server.bidder.consumable.model.ConsumableBidResponse;
 import org.prebid.server.bidder.consumable.model.ConsumableContents;
@@ -27,6 +29,8 @@
 import org.prebid.server.bidder.model.HttpResponse;
 import org.prebid.server.bidder.model.Result;
 import org.prebid.server.proto.openrtb.ext.ExtPrebid;
+import org.prebid.server.proto.openrtb.ext.request.ExtRegs;
+import org.prebid.server.proto.openrtb.ext.request.ExtUser;
 import org.prebid.server.proto.openrtb.ext.request.consumable.ExtImpConsumable;
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 import org.prebid.server.util.HttpUtil;
@@ -224,6 +228,21 @@ public void makeHttpRequestsShouldReturnRequestWithExpectedPlacements() {
                                 .unitId(345).unitName("unit").adTypes(Arrays.asList(3, 429)).build());
     }
 
+    @Test
+    public void makeHttpRequestsShouldReturnHttpRequestWithCorrectGdprParameters() {
+        // given
+        final BidRequest bidRequest = givenBidRequest(identity());
+
+        // when
+        final Result<List<HttpRequest<ConsumableBidRequest>>> result = consumableBidder.makeHttpRequests(bidRequest);
+
+        // then
+        assertThat(result.getValue()).hasSize(1)
+                .extracting(httpRequest -> mapper.readValue(httpRequest.getBody(), ConsumableBidRequest.class))
+                .flatExtracting(ConsumableBidRequest::getGdpr)
+                .containsOnly(ConsumableBidGdpr.builder().applies(true).consent("consent").build());
+    }
+
     @Test
     public void makeBidsShouldReturnErrorIfResponseBodyCouldNotBeParsed() {
         // given
@@ -327,6 +346,9 @@ private static BidRequest givenBidRequestWithTwoImpsAndTwoFormats() {
                                 .ext(mapper.valueToTree(ExtPrebid.of(null,
                                         ExtImpConsumable.of(123, 234, 345, "unit"))))
                                 .build()))
+                .user(User.builder()
+                        .ext(ExtUser.builder().consent("consent").build())
+                        .build())
                 .build();
     }
 
@@ -335,7 +357,11 @@ private static BidRequest givenBidRequest(
             Function<Imp.ImpBuilder, Imp.ImpBuilder> impCustomizer) {
 
         return bidRequestCustomizer.apply(BidRequest.builder()
-                .imp(singletonList(givenImp(impCustomizer))))
+                .imp(singletonList(givenImp(impCustomizer)))
+                .regs(Regs.of(null, ExtRegs.of(1, null)))
+                .user(User.builder()
+                        .ext(ExtUser.builder().consent("consent").build())
+                        .build()))
                 .build();
     }
 

src/test/java/org/prebid/server/it/ConsumableTest.java

@@ -34,7 +34,7 @@ public void openrtb2AuctionShouldRespondWithBidsFromConsumable() throws IOExcept
                 .withHeader("Referer", equalTo("http://www.example.com"))
                 .withHeader("X-Forwarded-For", equalTo("193.168.244.1"))
                 .withHeader("Host", equalTo("localhost:8090"))
-                .withHeader("Content-Length", equalTo("302"))
+                .withHeader("Content-Length", equalTo("372"))
                 .withHeader("Content-Type", equalTo("application/json;charset=UTF-8"))
                 .withCookie("azk", equalTo("CS-UID"))
                 // The "time" field in consumable bid request is not being checked as its value is Instance.now()
@@ -65,7 +65,6 @@ public void openrtb2AuctionShouldRespondWithBidsFromConsumable() throws IOExcept
         final String expectedAuctionResponse = openrtbAuctionResponseFrom(
                 "openrtb2/consumable/test-auction-consumable-response.json",
                 response, singletonList("consumable")).replaceAll("\\{\\{time}}", timeMs);
-
         JSONAssert.assertEquals(expectedAuctionResponse, response.asString(), JSONCompareMode.NON_EXTENSIBLE);
     }
 }

src/test/resources/org/prebid/server/it/openrtb2/consumable/test-auction-consumable-request.json

@@ -75,7 +75,8 @@
   },
   "regs": {
     "ext": {
-      "gdpr": 0
+      "gdpr": 0,
+      "us_privacy": "1YNN"
     }
   }
 }

src/test/resources/org/prebid/server/it/openrtb2/consumable/test-consumable-bid-request-1.json

@@ -18,5 +18,10 @@
   "includePricingData": true,
   "url": "http://www.example.com",
   "enableBotFiltering": true,
-  "parallel": true
+  "parallel": true,
+  "gdpr": {
+    "applies": false,
+    "consent": "consentValue"
+  },
+  "us_privacy": "1YNN"
 }