SP-1153: use resource token in webhook resend requests

Author: swlodarski-sumoheavy

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.bitpay</groupId>
     <artifactId>bitpay_sdk</artifactId>
-    <version>10.1.2</version>
+    <version>10.1.3</version>
     <packaging>jar</packaging>
 
     <name>BitPay</name>

src/main/java/com/bitpay/sdk/Client.java

@@ -735,14 +735,19 @@ public Invoice cancelInvoiceByGuid(
      * The intent of this call is to address issues when BitPay sends a webhook but the client doesn't receive it,
      * so the client can request that BitPay resend it.
      *
-     * @param invoiceId The id of the invoice for which you want the last webhook to be resent.
+     * @param invoiceId    The id of the invoice for which you want the last webhook to be resent.
+     * @param invoiceToken The resource token for the invoiceId.
+     *                     This token can be retrieved from the Bitpay's invoice object.
      * @return Boolean status of request
      * @throws BitPayApiException BitPayApiException class
      * @throws BitPayGenericException BitPayGenericException class
      * @see <a href="https://developer.bitpay.com/reference/request-an-invoice-webhook-to-be-resent">Request an Invoice Webhook to be Resent</a>
      */
-    public Boolean requestInvoiceWebhookToBeResent(String invoiceId) throws BitPayApiException, BitPayGenericException {
-        return this.getInvoiceClient().requestInvoiceWebhookToBeResent(invoiceId);
+    public Boolean requestInvoiceWebhookToBeResent(
+        String invoiceId,
+        String invoiceToken
+    ) throws BitPayApiException, BitPayGenericException {
+        return this.getInvoiceClient().requestInvoiceWebhookToBeResent(invoiceId, invoiceToken);
     }
 
     /**
@@ -907,14 +912,19 @@ public Refund updateRefundByGuid(String guid, String status) throws BitPayGeneri
     /**
      * Send a refund notification.
      *
-     * @param refundId A BitPay refund ID.
+     * @param refundId    A BitPay refund ID.
+     * @param refundToken The resource token for the refundId.
+     *                    This token can be retrieved from the Bitpay's refund object.
      * @return An updated Refund Object
      * @throws BitPayGenericException BitPayGenericException class
      * @throws BitPayApiException BitPayApiException class
      * @see <a href="https://developer.bitpay.com/reference/request-a-refund-notification-to-be-resent">Request a Refund Notification to be Resent</a>
      */
-    public Boolean sendRefundNotification(String refundId) throws BitPayGenericException, BitPayApiException {
-        return this.getRefundClient().sendRefundNotification(refundId);
+    public Boolean sendRefundNotification(
+        String refundId,
+        String refundToken
+    ) throws BitPayGenericException, BitPayApiException {
+        return this.getRefundClient().sendRefundNotification(refundId, refundToken);
     }
 
     /**

src/main/java/com/bitpay/sdk/Config.java

@@ -34,7 +34,7 @@ public class Config {
     /**
      * BitPay Plugin Info Version.
      */
-    public static final String BITPAY_PLUGIN_INFO = "BitPay_Java_Client_v10.1.2";
+    public static final String BITPAY_PLUGIN_INFO = "BitPay_Java_Client_v10.1.3";
     /**
      * BitPay Api Frame.
      */

src/main/java/com/bitpay/sdk/client/InvoiceClient.java

@@ -453,14 +453,19 @@ public Invoice cancelByGuid(String guid, Boolean forceCancel) throws BitPayApiEx
     /**
      * Request an Invoice Webhook to be Resent.
      *
-     * @param invoiceId Invoice ID
+     * @param invoiceId    Invoice ID
+     * @param invoiceToken The resource token for the invoiceId.
+     *                     This token can be retrieved from the Bitpay's invoice object.
      * @return Boolean
      * @throws BitPayApiException BitPayApiException class
      * @throws BitPayGenericException BitPayGenericException class
      */
-    public Boolean requestInvoiceWebhookToBeResent(String invoiceId) throws BitPayApiException, BitPayGenericException {
+    public Boolean requestInvoiceWebhookToBeResent(
+        String invoiceId,
+        String invoiceToken
+    ) throws BitPayApiException, BitPayGenericException {
         final Map<String, String> params = new HashMap<>();
-        params.put("token", this.accessTokens.getAccessToken(Facade.MERCHANT));
+        params.put("token", invoiceToken);
 
         JsonMapper mapper = JsonMapperFactory.create();
         String json = null;

src/main/java/com/bitpay/sdk/client/RefundClient.java

@@ -272,18 +272,23 @@ public Refund updateByGuid(
     /**
      * Send a refund notification.
      *
-     * @param refundId A BitPay refund ID.
+     * @param refundId    A BitPay refund ID.
+     * @param refundToken The resource token for the refundId.
+     *                    This token can be retrieved from the Bitpay's refund object.
      * @return An updated Refund Object
      * @throws BitPayGenericException BitPayGenericException class
      * @throws BitPayApiException         BitPayApiException class
      */
-    public Boolean sendRefundNotification(final String refundId) throws BitPayApiException, BitPayGenericException {
+    public Boolean sendRefundNotification(
+        final String refundId,
+        final String refundToken
+    ) throws BitPayApiException, BitPayGenericException {
         if (Objects.isNull(refundId)) {
             BitPayExceptionProvider.throwMissingParameterException();
         }
 
         final Map<String, String> params = new HashMap<>();
-        params.put("token", this.accessTokens.getAccessToken(Facade.MERCHANT));
+        params.put("token", refundToken);
 
         final JsonMapper mapper = JsonMapperFactory.create();
         String json = null;

src/main/java/com/bitpay/sdk/model/invoice/Refund.java

@@ -48,6 +48,7 @@ public class Refund {
     protected String transactionCurrency = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
     protected String id;
     protected String status = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
+    protected String token;
 
 
     /**
@@ -543,4 +544,29 @@ public String getType() {
     public void setType(final String type) {
         this.type = type;
     }
+
+    /**
+     * Gets refund resource token.
+     * This token is derived from the API token initially used to create the refund and is tied
+     * to the specific resource id created.
+     *
+     * @return the token
+     */
+    @JsonProperty("token")
+    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
+    public String getToken() {
+        return this.token;
+    }
+
+    /**
+     * Sets refund resource token.
+     * This token is derived from the API token initially used to create the refund and is tied
+     * to the specific resource id created.
+     *
+     * @param token the token
+     */
+    @JsonProperty("token")
+    public void setToken(final String token) {
+        this.token = token;
+    }
 }

src/test/java/com/bitpay/sdk/ClientTest.java

@@ -636,21 +636,19 @@ public void it_should_throws_exception_for_cancel_invoice_for_invalid_state_of_c
     @Test
     public void it_should_request_invoice_webhook_to_be_resent() throws BitPayApiException, BitPayGenericException {
         // given
-        final String merchantToken = "merchantToken";
         final String invoiceId = "UZjwcYkWAKfTMn9J1yyfs4";
-        final String requestJson = "{\"token\":\"merchantToken\"}";
+        final String invoiceToken = "cM78LHk17Q8fktDE6QLBBFfvH1QKBhRkHibTLcxhgzsu3VDRvSyu3CGi17DuwYxhT";
+        final String requestJson = String.format("{\"token\":\"%s\"}", invoiceToken);
 
         Mockito.when(this.bitPayClient.post(
             ArgumentMatchers.eq("invoices/" + invoiceId + "/notifications"), ArgumentMatchers.eq(requestJson))
         ).thenReturn(this.getHttpResponseWithSpecificBody("{\"data\": \"Success\"}"));
-        Mockito.when(this.accessTokens.getAccessToken(Facade.MERCHANT)).thenReturn(merchantToken);
         Client testedClass = this.getTestedClass();
 
         // when
-        Boolean result = testedClass.requestInvoiceWebhookToBeResent(invoiceId);
+        Boolean result = testedClass.requestInvoiceWebhookToBeResent(invoiceId, invoiceToken);
 
         // then
-        Mockito.verify(this.accessTokens, Mockito.times(1)).getAccessToken(Facade.MERCHANT);
         Mockito.verify(this.bitPayClient, Mockito.times(1)).post("invoices/" + invoiceId + "/notifications", requestJson);
         Assertions.assertTrue(result);
     }
@@ -791,7 +789,7 @@ public void it_should_throws_bitpay_api_exception_for_invalid_sendRefundNotifica
                 )).thenThrow(new BitPayApiException("error message", "500"));
 
                 // when
-                testedClass.sendRefundNotification("1");
+                testedClass.sendRefundNotification("1", "cM78LHk17Q8fktDE6QLBBFfvH1QKBhRkHibTLcxhgzsu3VDRvSyu3CGi17DuwYxhT");
             }
         );
 
@@ -1046,27 +1044,23 @@ public void it_should_update_refund_by_guid() throws BitPayApiException, BitPayG
     @Test
     public void it_should_test_sendRefundNotification() throws BitPayApiException, BitPayGenericException {
         // given
-        final String merchantToken = "merchantToken";
         final String refundId = "WoE46gSLkJQS48RJEiNw3L";
+        final String refundToken = "cM78LHk17Q8fktDE6QLBBFfvH1QKBhRkHibTLcxhgzsu3VDRvSyu3CGi17DuwYxhT";
         final String getRefundsJsonConvertedResponse = getPreparedJsonDataFromFile("refundNotificationResponse.json");
 
-        final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
-        params.add(new BasicNameValuePair("token", merchantToken));
-        final String requestedJson = "{\"token\":\"merchantToken\"}";
+        final String requestedJson = String.format("{\"token\":\"%s\"}", refundToken);
 
         Mockito.when(this.bitPayClient.post(
             "refunds/" + refundId + "/notifications",
             requestedJson,
             true
         )).thenReturn(this.getHttpResponseWithSpecificBody(getRefundsJsonConvertedResponse));
-        Mockito.when(this.accessTokens.getAccessToken(Facade.MERCHANT)).thenReturn(merchantToken);
         Client testedClass = this.getTestedClass();
 
         // when
-        Boolean result = testedClass.sendRefundNotification(refundId);
+        Boolean result = testedClass.sendRefundNotification(refundId, refundToken);
 
         // then
-        Mockito.verify(this.accessTokens, Mockito.times(1)).getAccessToken(Facade.MERCHANT);
         Mockito.verify(this.bitPayClient, Mockito.times(1)).post(
             "refunds/" + refundId + "/notifications",
             requestedJson,

src/test/java/com/bitpay/sdk/ConfigTest.java

@@ -58,7 +58,7 @@ public void it_should_returns_bitpay_api_version() {
 
     @Test
     public void it_should_returns_bitpay_plugin_info() {
-        Assertions.assertTrue(Config.BITPAY_PLUGIN_INFO.contains("BitPay_Java_Client_v10.1.2"));
+        Assertions.assertTrue(Config.BITPAY_PLUGIN_INFO.contains("BitPay_Java_Client_v10.1.3"));
     }
 
     @Test

src/test/java/com/bitpay/sdk/client/InvoiceClientTest.java

@@ -436,12 +436,12 @@ public void it_should_request_invoice_webhook_to_be_resent() throws BitPayExcept
         this.addServerJsonResponse(
             "/invoices/Hpqc63wvE1ZjzeeH4kEycF/notifications",
             "POST",
-            "{\"token\":\"someMerchantToken\"}",
+            "{\"token\":\"cM78LHk17Q8fktDE6QLBBFfvH1QKBhRkHibTLcxhgzsu3VDRvSyu3CGi17DuwYxhT\"}",
             getPreparedJsonDataFromFile("invoiceWebhookResponse.json")
         );
 
         // when
-        Boolean result = this.getTestedClass(accessTokens).requestInvoiceWebhookToBeResent("Hpqc63wvE1ZjzeeH4kEycF");
+        Boolean result = this.getTestedClass(accessTokens).requestInvoiceWebhookToBeResent("Hpqc63wvE1ZjzeeH4kEycF", "cM78LHk17Q8fktDE6QLBBFfvH1QKBhRkHibTLcxhgzsu3VDRvSyu3CGi17DuwYxhT");
         Assertions.assertTrue(result);
     }
 

src/test/java/com/bitpay/sdk/client/RefundClientTest.java

@@ -236,7 +236,7 @@ public void it_should_send_refund_notification() throws BitPayException {
         );
 
         // when
-        Boolean result = this.getTestedClass().sendRefundNotification("WoE46gSLkJQS48RJEiNw3L");
+        Boolean result = this.getTestedClass().sendRefundNotification("WoE46gSLkJQS48RJEiNw3L", "cM78LHk17Q8fktDE6QLBBFfvH1QKBhRkHibTLcxhgzsu3VDRvSyu3CGi17DuwYxhT");
 
         // then
         Assertions.assertTrue(result);