Merge pull request #214 from mwarzybok-sumoheavy/feature/SP-418

bobbrodie · web-flow · commit fb1a21f17f4c · 2023-02-06T09:36:48.000-05:00
SP-418 Java 9.0.0 Functional test suite
diff --git a/pom.xml b/pom.xml
@@ -129,6 +129,9 @@
                 <version>2.22.2</version>
                 <configuration>
                     <argLine>@{argLine} -Duser.timezone=UTC</argLine>
+                    <excludes>
+                        <exclude>**/integration/ClientIntegrationTest.java</exclude>
+                    </excludes>
                 </configuration>
             </plugin>
         </plugins>
diff --git a/src/main/java/com/bitpay/sdk/Client.java b/src/main/java/com/bitpay/sdk/Client.java
@@ -295,7 +295,7 @@ public String getAccessToken(String key) throws BitPayException {
      * @return Map|null
      * @throws BitPayException the bit pay exception
      */
-    public Map getCurrencyInfo(String currencyCode) throws BitPayException {
+    public Map<String, Object> getCurrencyInfo(String currencyCode) throws BitPayException {
         CurrencyClient client = new CurrencyClient(this.bitPayClient);
         return client.getCurrencyInfo(currencyCode);
     }
@@ -341,6 +341,19 @@ public Invoice getInvoice(String invoiceId) throws BitPayException {
         }
     }
 
+    /**
+     * Retrieve a BitPay invoice by guid using the specified facade.  The client must have been previously authorized for the specified facade.
+     *
+     * @param guid        The guid of the invoice to retrieve.
+     * @return A BitPay Invoice object.
+     * @throws InvoiceQueryException InvoiceQueryException class
+     */
+    public Invoice getInvoiceByGuid(String guid) throws InvoiceQueryException {
+        Facade facade = getFacadeBasedOnAccessToken();
+        boolean signRequest = isSignRequest(facade);
+        return this.getInvoiceClient().getInvoiceByGuid(guid, facade, signRequest);
+    }
+
     /**
      * Retrieve a BitPay invoice by guid using the specified facade.  The client must have been previously authorized for the specified facade.
      *
@@ -806,7 +819,7 @@ public String deliverBill(String billId, String billToken, boolean signRequest)
      * @since 8.8.0
      */
     public Rate getRate(String baseCurrency, String currency) throws RateQueryException {
-        return this.getRatesClient().getRate(baseCurrency, currency);
+        return this.getRateClient().getRate(baseCurrency, currency);
     }
 
     /**
@@ -829,7 +842,7 @@ public Rates getRates() throws RateQueryException {
      * @since 8.8.0
      */
     public Rates getRates(String baseCurrency) throws RateQueryException {
-        return this.getRatesClient().getRates(baseCurrency);
+        return this.getRateClient().getRates(baseCurrency);
     }
 
     /**
diff --git a/src/main/java/com/bitpay/sdk/client/InvoiceClient.java b/src/main/java/com/bitpay/sdk/client/InvoiceClient.java
@@ -35,8 +35,8 @@
 public class InvoiceClient {
 
     private final BitPayClient bitPayClient;
-    private AccessTokens accessTokens;
-    private GuidGenerator guidGenerator;
+    private final AccessTokens accessTokens;
+    private final GuidGenerator guidGenerator;
 
     /**
      * Instantiates a new Invoice client.
@@ -90,7 +90,8 @@ public Invoice createInvoice(Invoice invoice, Facade facade, Boolean signRequest
         } catch (BitPayException ex) {
             throw new InvoiceCreationException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (Exception e) {
-            throw new InvoiceCreationException(null, "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
+            throw new InvoiceCreationException(null,
+                "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
         }
 
         return invoice;
@@ -119,9 +120,11 @@ public Invoice getInvoice(String invoiceId, Facade facade, Boolean signRequest)
         } catch (BitPayException ex) {
             throw new InvoiceQueryException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (JsonProcessingException e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
         } catch (Exception e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
         }
 
         return invoice;
@@ -151,9 +154,11 @@ public Invoice getInvoiceByGuid(String guid, Facade facade, Boolean signRequest)
         } catch (BitPayException ex) {
             throw new InvoiceQueryException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (JsonProcessingException e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
         } catch (Exception e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoice) : " + e.getMessage());
         }
 
         return invoice;
@@ -172,17 +177,18 @@ public Invoice getInvoiceByGuid(String guid, Facade facade, Boolean signRequest)
      * @throws BitPayException       BitPayException class
      * @throws InvoiceQueryException InvoiceQueryException class
      */
-    public List<Invoice> getInvoices(String dateStart, String dateEnd, String status, String orderId, Integer limit, Integer offset) throws BitPayException, InvoiceQueryException {
+    public List<Invoice> getInvoices(String dateStart, String dateEnd, String status, String orderId, Integer limit,
+                                     Integer offset) throws BitPayException, InvoiceQueryException {
         if (Objects.isNull(dateStart) || Objects.isNull(dateEnd)) {
             throw new InvoiceQueryException(null, "missing required parameter");
         }
 
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
         ParameterAdder.execute(params, "token", this.accessTokens.getAccessToken(Facade.MERCHANT));
-        ParameterAdder.execute(params,"dateStart", dateStart);
-        ParameterAdder.execute(params,"dateEnd", dateEnd);
-        ParameterAdder.execute(params,"orderId", orderId);
-        ParameterAdder.execute(params,"status", status);
+        ParameterAdder.execute(params, "dateStart", dateStart);
+        ParameterAdder.execute(params, "dateEnd", dateEnd);
+        ParameterAdder.execute(params, "orderId", orderId);
+        ParameterAdder.execute(params, "status", status);
         if (Objects.nonNull(limit)) {
             ParameterAdder.execute(params, "limit", limit.toString());
         }
@@ -194,13 +200,16 @@ public List<Invoice> getInvoices(String dateStart, String dateEnd, String status
 
         try {
             HttpResponse response = this.bitPayClient.get("invoices", params);
-            invoices = Arrays.asList(new ObjectMapper().readValue(this.bitPayClient.responseToJsonString(response), Invoice[].class));
+            invoices = Arrays.asList(
+                new ObjectMapper().readValue(this.bitPayClient.responseToJsonString(response), Invoice[].class));
         } catch (BitPayException ex) {
             throw new InvoiceQueryException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (JsonProcessingException e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
         } catch (Exception e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
         }
 
         return invoices;
@@ -219,13 +228,16 @@ public InvoiceEventToken getInvoiceEventToken(String invoiceId) throws BitPayExc
 
         try {
             HttpResponse response = this.bitPayClient.get("invoices/" + invoiceId + "/events", params);
-            return JsonMapperFactory.create().readValue(this.bitPayClient.responseToJsonString(response), InvoiceEventToken.class);
+            return JsonMapperFactory.create()
+                .readValue(this.bitPayClient.responseToJsonString(response), InvoiceEventToken.class);
         } catch (BitPayException ex) {
             throw new InvoiceQueryException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (JsonProcessingException e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
         } catch (Exception e) {
-            throw new InvoiceQueryException(null, "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
+            throw new InvoiceQueryException(null,
+                "failed to deserialize BitPay server response (Invoices) : " + e.getMessage());
         }
     }
 
@@ -254,10 +266,9 @@ public Invoice updateInvoice(
 
         final Map<String, Object> params = new HashMap<>();
         params.put("token", this.accessTokens.getAccessToken(Facade.MERCHANT));
-        if (buyerSms == null && smsCode == null) {
-            throw new InvoiceUpdateException(null,
-                "Updating the invoice requires Mobile Phone Number for SMS reception.");
-        }
+        validateRequiredField(buyerSms, buyerEmail);
+        validateSmsCode(buyerSms, smsCode, autoVerify);
+
         if (buyerSms != null) {
             params.put("buyerSms", buyerSms);
         }
@@ -294,6 +305,27 @@ public Invoice updateInvoice(
         return invoice;
     }
 
+    private void validateSmsCode(String buyerSms, String smsCode, Boolean autoVerify) throws InvoiceUpdateException {
+        if (Objects.isNull(autoVerify)) {
+            return;
+        }
+
+        if (autoVerify) {
+            return;
+        }
+
+        if (Objects.nonNull(buyerSms) && Objects.nonNull(smsCode)) {
+            return;
+        }
+
+        if (Objects.isNull(buyerSms) && Objects.isNull(smsCode)) {
+            return;
+        }
+
+        throw new InvoiceUpdateException(null,
+            "If provided alongside a valid SMS, will bypass the need to complete an SMS challenge");
+    }
+
     /**
      * Pay a BitPay invoice with a mock transaction.
      *
@@ -321,7 +353,8 @@ public Invoice payInvoice(String invoiceId, String status) throws BitPayExceptio
 
         try {
             HttpResponse response = this.bitPayClient.update("invoices/pay/" + invoiceId, json);
-            invoice = JsonMapperFactory.create().readValue(this.bitPayClient.responseToJsonString(response), Invoice.class);
+            invoice =
+                JsonMapperFactory.create().readValue(this.bitPayClient.responseToJsonString(response), Invoice.class);
         } catch (BitPayException ex) {
             throw new InvoiceUpdateException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (Exception e) {
@@ -362,9 +395,9 @@ public Invoice cancelInvoice(String invoiceId) throws InvoiceCancellationExcepti
     public Invoice cancelInvoice(String invoiceId, Boolean forceCancel)
         throws InvoiceCancellationException, BitPayException {
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
-        ParameterAdder.execute(params,"token", this.accessTokens.getAccessToken(Facade.MERCHANT));
+        ParameterAdder.execute(params, "token", this.accessTokens.getAccessToken(Facade.MERCHANT));
         if (forceCancel) {
-            ParameterAdder.execute(params,"forceCancel", forceCancel.toString());
+            ParameterAdder.execute(params, "forceCancel", forceCancel.toString());
         }
         Invoice invoice;
 
@@ -387,9 +420,9 @@ public Invoice cancelInvoiceByGuid(String guid, Boolean forceCancel) throws BitP
         }
 
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
-        ParameterAdder.execute(params,"token", this.accessTokens.getAccessToken(Facade.MERCHANT));
+        ParameterAdder.execute(params, "token", this.accessTokens.getAccessToken(Facade.MERCHANT));
         if (forceCancel.equals(true)) {
-            ParameterAdder.execute(params,"forceCancel", forceCancel.toString());
+            ParameterAdder.execute(params, "forceCancel", forceCancel.toString());
         }
         Invoice invoice;
 
@@ -427,4 +460,15 @@ public Boolean requestInvoiceWebhookToBeResent(String invoiceId) throws BitPayEx
             throw new BitPayException(null, "failed to process request : " + e.getMessage());
         }
     }
+
+    private void validateRequiredField(String buyerSms, String buyerEmail) throws InvoiceUpdateException {
+        if (buyerSms == null && buyerEmail == null) {
+            throw new InvoiceUpdateException(null,
+                "Updating the invoice requires Mobile Phone Number for SMS reception.");
+        }
+
+        if (Objects.nonNull(buyerSms) && Objects.nonNull(buyerEmail)) {
+            throw new InvoiceUpdateException(null, "Updating an invoice will require EITHER an SMS or E-mail)");
+        }
+    }
 }
diff --git a/src/main/java/com/bitpay/sdk/model/Payout/PayoutRecipient.java b/src/main/java/com/bitpay/sdk/model/Payout/PayoutRecipient.java
@@ -49,7 +49,8 @@ public class PayoutRecipient {
      *
      * @param email           string Recipient email address to which the invite shall be sent.
      * @param label           string Recipient nickname assigned by the merchant (Optional).
-     * @param notificationURL string URL to which BitPay sends webhook notifications to inform the merchant about the                        status of a given recipient. HTTPS is mandatory (Optional).
+     * @param notificationURL string URL to which BitPay sends webhook notifications to inform the merchant about the
+     *                        status of a given recipient. HTTPS is mandatory (Optional).
      */
     public PayoutRecipient(String email, String label, String notificationURL) {
         this.email = email;
diff --git a/src/setup/java/BitPaySetup.java b/src/setup/java/BitPaySetup.java
@@ -89,7 +89,7 @@ public static void main(String[] args) {
         try {
             ObjectMapper mapper = new ObjectMapper();
 
-            client = Client.createClient(new PrivateKey(privateKey), new AccessTokens());
+            client = new Client(env, new PrivateKey(privateKey), new AccessTokens(), null, null);
             pairingCodeMerchant = client.authorizeClient(Facade.MERCHANT);
             pairingCodePayout = client.authorizeClient(Facade.PAYOUT);
 
diff --git a/src/test/java/com/bitpay/sdk/integration/.gitignore b/src/test/java/com/bitpay/sdk/integration/.gitignore
@@ -0,0 +1,3 @@
+BitPay.config.json
+bitpay_private_prod.key
+email.txt
diff --git a/src/test/java/com/bitpay/sdk/integration/ClientIntegrationTest.java b/src/test/java/com/bitpay/sdk/integration/ClientIntegrationTest.java

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+BitPay.config.json`
	`2`	`+bitpay_private_prod.key`
	`3`	`+email.txt`