Merge pull request #222 from mwarzybok-sumoheavy/feature/javadoc

fix javadoc, improve naming convention

Author: bobbrodie

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

@@ -54,7 +54,7 @@ public BillClient(BitPayClient bitPayClient, TokenContainer accessTokens) {
      * @throws BitPayException       BitPayException class
      * @throws BillCreationException BillCreationException class
      */
-    public Bill createBill(Bill bill, Facade facade, boolean signRequest)
+    public Bill create(Bill bill, Facade facade, boolean signRequest)
         throws BitPayException, BillCreationException {
         if (Objects.isNull(bill) || Objects.isNull(facade)) {
             throw new BillCreationException(null, "missing required parameter");
@@ -91,7 +91,7 @@ public Bill createBill(Bill bill, Facade facade, boolean signRequest)
      * @throws BitPayException    BitPayException class
      * @throws BillQueryException BillQueryException class
      */
-    public Bill getBill(String billId, Facade facade, boolean signRequest) throws BitPayException, BillQueryException {
+    public Bill get(String billId, Facade facade, boolean signRequest) throws BitPayException, BillQueryException {
         if (Objects.isNull(billId) || Objects.isNull(facade)) {
             throw new BillQueryException(null, "missing required parameter");
         }
@@ -180,7 +180,7 @@ public List<Bill> getBills() throws BitPayException, BillQueryException {
      * @throws BitPayException     BitPayException class
      * @throws BillUpdateException BillUpdateException class
      */
-    public Bill updateBill(Bill bill, String billId) throws BitPayException, BillUpdateException {
+    public Bill update(Bill bill, String billId) throws BitPayException, BillUpdateException {
         if (Objects.isNull(billId) || Objects.isNull(bill)) {
             throw new BillUpdateException(null, "missing required parameter");
         }
@@ -212,7 +212,7 @@ public Bill updateBill(Bill bill, String billId) throws BitPayException, BillUpd
      * @return A response status returned from the API.
      * @throws BillDeliveryException BillDeliveryException class
      */
-    public String deliverBill(String billId, String billToken, boolean signRequest) throws BillDeliveryException {
+    public String deliver(String billId, String billToken, boolean signRequest) throws BillDeliveryException {
         if (Objects.isNull(billId) || Objects.isNull(billToken)) {
             throw new BillDeliveryException(null, "missing required parameter");
         }

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

@@ -45,7 +45,7 @@ public CurrencyClient(BitPayClient client) throws BitPayException {
      * @throws BitPayException the bit pay exception
      */
     @SuppressWarnings (value="unchecked")
-    public Map<String, Object> getCurrencyInfo(String currencyCode) throws BitPayException {
+    public Map<String, Object> getInfo(String currencyCode) throws BitPayException {
         if (Objects.isNull(currencyCode)) {
             throw new BitPayException(null, "missing required parameter");
         }

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

@@ -64,7 +64,7 @@ public InvoiceClient(
      * @throws BitPayException          BitPayException class
      * @throws InvoiceCreationException InvoiceCreationException class
      */
-    public Invoice createInvoice(Invoice invoice, Facade facade, Boolean signRequest) throws BitPayException,
+    public Invoice create(Invoice invoice, Facade facade, Boolean signRequest) throws BitPayException,
         InvoiceCreationException {
         if (Objects.isNull(invoice) || Objects.isNull(facade)) {
             throw new InvoiceCreationException(null, "missing required parameter");
@@ -106,7 +106,7 @@ public Invoice createInvoice(Invoice invoice, Facade facade, Boolean signRequest
      * @throws BitPayException       BitPayException class
      * @throws InvoiceQueryException InvoiceQueryException class
      */
-    public Invoice getInvoice(String invoiceId, Facade facade, Boolean signRequest) throws BitPayException,
+    public Invoice get(String invoiceId, Facade facade, Boolean signRequest) throws BitPayException,
         InvoiceQueryException {
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
         ParameterAdder.execute(params, "token", this.accessTokens.getAccessToken(facade));
@@ -138,7 +138,7 @@ public Invoice getInvoice(String invoiceId, Facade facade, Boolean signRequest)
      * @return A BitPay Invoice object.
      * @throws InvoiceQueryException InvoiceQueryException class
      */
-    public Invoice getInvoiceByGuid(String guid, Facade facade, Boolean signRequest) throws InvoiceQueryException {
+    public Invoice getByGuid(String guid, Facade facade, Boolean signRequest) throws InvoiceQueryException {
         if (Objects.isNull(guid) || Objects.isNull(facade)) {
             throw new InvoiceQueryException(null, "missing required parameters");
         }
@@ -252,7 +252,7 @@ public InvoiceEventToken getInvoiceEventToken(String invoiceId) throws BitPayExc
      * @throws BitPayException        BitPayException class
      * @throws InvoiceUpdateException InvoiceUpdateException class
      */
-    public Invoice updateInvoice(
+    public Invoice update(
         String invoiceId,
         String buyerSms,
         String smsCode,
@@ -304,27 +304,6 @@ 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.
      *
@@ -334,7 +313,7 @@ private void validateSmsCode(String buyerSms, String smsCode, Boolean autoVerify
      * @throws BitPayException        BitPayException class
      * @throws InvoiceUpdateException InvoiceUpdateException class
      */
-    public Invoice payInvoice(String invoiceId, String status) throws BitPayException, InvoiceUpdateException {
+    public Invoice pay(String invoiceId, String status) throws BitPayException, InvoiceUpdateException {
         final Map<String, Object> params = new HashMap<>();
         params.put("token", this.accessTokens.getAccessToken(Facade.MERCHANT));
         if (status != null) {
@@ -372,9 +351,9 @@ public Invoice payInvoice(String invoiceId, String status) throws BitPayExceptio
      * @throws InvoiceCancellationException InvoiceCancellationException class
      * @throws BitPayException              BitPayException class
      */
-    public Invoice cancelInvoice(String invoiceId) throws InvoiceCancellationException, BitPayException {
+    public Invoice cancel(String invoiceId) throws InvoiceCancellationException, BitPayException {
         try {
-            return this.cancelInvoice(invoiceId, false);
+            return this.cancel(invoiceId, false);
         } catch (BitPayException ex) {
             throw new InvoiceCancellationException(ex.getStatusCode(), ex.getReasonPhrase());
         } catch (Exception e) {
@@ -391,7 +370,7 @@ public Invoice cancelInvoice(String invoiceId) throws InvoiceCancellationExcepti
      * @throws InvoiceCancellationException InvoiceCancellationException class
      * @throws BitPayException              BitPayException class
      */
-    public Invoice cancelInvoice(String invoiceId, Boolean forceCancel)
+    public Invoice cancel(String invoiceId, Boolean forceCancel)
         throws InvoiceCancellationException, BitPayException {
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
         ParameterAdder.execute(params, "token", this.accessTokens.getAccessToken(Facade.MERCHANT));
@@ -413,7 +392,7 @@ public Invoice cancelInvoice(String invoiceId, Boolean forceCancel)
         return invoice;
     }
 
-    public Invoice cancelInvoiceByGuid(String guid, Boolean forceCancel) throws BitPayException {
+    public Invoice cancelByGuid(String guid, Boolean forceCancel) throws BitPayException {
         if (Objects.isNull(guid) || Objects.isNull(forceCancel)) {
             throw new InvoiceCancellationException(null, "missing required parameter");
         }
@@ -470,4 +449,25 @@ private void validateRequiredField(String buyerSms, String buyerEmail) throws In
             throw new InvoiceUpdateException(null, "Updating an invoice will require EITHER an SMS or E-mail)");
         }
     }
+
+    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");
+    }
 }

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

@@ -40,7 +40,7 @@ public LedgerClient(BitPayClient bitPayClient, TokenContainer accessTokens) {
     }
 
     /**
-     * Retrieve a list of ledgers entries by currency & date range using the merchant facade.
+     * Retrieve a list of ledgers entries by currency and date range using the merchant facade.
      *
      * @param currency  The three digit currency string for the ledger to retrieve.
      * @param dateStart The first date for the query filter.
@@ -49,7 +49,7 @@ public LedgerClient(BitPayClient bitPayClient, TokenContainer accessTokens) {
      * @throws BitPayException      BitPayException class
      * @throws LedgerQueryException LedgerQueryException class
      */
-    public List<LedgerEntry> getLedgerEntries(String currency, String dateStart, String dateEnd) throws BitPayException,
+    public List<LedgerEntry> getEntries(String currency, String dateStart, String dateEnd) throws BitPayException,
         LedgerQueryException {
         if (Objects.isNull(currency) || Objects.isNull(dateStart) || Objects.isNull(dateEnd)) {
             throw new BitPayException(null, "missing mandatory fields");

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

@@ -132,7 +132,7 @@ public Boolean cancel(String payoutId) throws BitPayException, PayoutCancellatio
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
         ParameterAdder.execute(params, "token", this.accessTokens.getAccessToken(Facade.PAYOUT));
 
-        Boolean result;
+        boolean result;
         JsonMapper mapper = JsonMapperFactory.create();
 
         try {
@@ -214,7 +214,7 @@ public List<Payout> getPayouts(
      * @throws BitPayException             BitPayException class
      * @throws PayoutNotificationException PayoutNotificationException class
      */
-    public Boolean requestPayoutNotification(String payoutId)
+    public Boolean requestNotification(String payoutId)
         throws BitPayException, PayoutNotificationException {
         if (Objects.isNull(payoutId)) {
             throw new PayoutNotificationException(null, "missing required parameter");
@@ -225,7 +225,7 @@ public Boolean requestPayoutNotification(String payoutId)
 
         JsonMapper mapper = JsonMapperFactory.create();
 
-        Boolean result;
+        boolean result;
         String json;
 
         try {

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

@@ -111,7 +111,7 @@ public List<PayoutRecipient> submit(PayoutRecipients recipients)
      * @throws BitPayException               BitPayException class
      * @throws PayoutRecipientQueryException PayoutRecipientQueryException class
      */
-    public List<PayoutRecipient> getByFilters(String status, Integer limit, Integer offset)
+    public List<PayoutRecipient> getRecipientsByFilters(String status, Integer limit, Integer offset)
         throws BitPayException, PayoutRecipientQueryException {
 
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
@@ -193,7 +193,7 @@ public PayoutRecipient update(String recipientId, PayoutRecipient recipient)
             throw new PayoutRecipientUpdateException(null, "missing required parameter");
         }
         recipient.setToken(this.accessTokens.getAccessToken(Facade.PAYOUT));
-        recipient.setGuid(this.guidGenerator.execute());
+        recipient.setGuid(Objects.isNull(recipient.getGuid()) ? this.guidGenerator.execute() : recipient.getGuid());
         JsonMapper mapper = JsonMapperFactory.create();
         String json;
 
@@ -265,7 +265,7 @@ public Boolean delete(String recipientId)
      * @throws PayoutRecipientNotificationException PayoutRecipientNotificationException                                              class
      * @throws BitPayException                      BitPayException class
      */
-    public Boolean requestPayoutRecipientNotification(String recipientId)
+    public Boolean requestNotification(String recipientId)
         throws PayoutRecipientNotificationException, BitPayException {
         if (Objects.isNull(recipientId)) {
             throw new PayoutRecipientNotificationException(null, "missing required parameter");

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

@@ -39,7 +39,7 @@ public RateClient(BitPayClient bitPayClient) {
      * @throws RateQueryException RateQueryException class
      * @since 8.8.0
      */
-    public Rate getRate(String baseCurrency, String currency) throws RateQueryException {
+    public Rate get(String baseCurrency, String currency) throws RateQueryException {
         try {
             HttpResponse response = this.bitPayClient.get("rates/" + baseCurrency + "/" + currency);
             final String content = this.bitPayClient.responseToJsonString(response);

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

@@ -96,9 +96,7 @@ public Refund create(Refund refund) throws BitPayException {
      * @throws BitPayException      BitPayException class
      */
     public Refund getById(String refundId) throws RefundQueryException, BitPayException {
-        if (Objects.isNull(refundId)) {
-            throw new RefundQueryException(null, "missing required parameter");
-        }
+        validateRefundId(refundId);
 
         Refund refund;
 
@@ -129,9 +127,7 @@ public Refund getById(String refundId) throws RefundQueryException, BitPayExcept
      * @throws BitPayException BitPayException
      */
     public Refund getByGuid(String guid) throws BitPayException {
-        if (Objects.isNull(guid)) {
-            throw new RefundQueryException(null, "missing required parameter");
-        }
+        validateRefundId(guid);
 
         Refund refund;
 
@@ -164,9 +160,7 @@ public Refund getByGuid(String guid) throws BitPayException {
      * @throws BitPayException      BitPayException class
      */
     public List<Refund> getRefundsByInvoiceId(String invoiceId) throws RefundQueryException, BitPayException {
-        if (Objects.isNull(invoiceId)) {
-            throw new RefundQueryException(null, "missing required parameter");
-        }
+        validateRefundId(invoiceId);
 
         List<Refund> refunds;
         final List<BasicNameValuePair> params = new ArrayList<BasicNameValuePair>();
@@ -420,4 +414,10 @@ private Map<String, Object> createBasicParamsForCreate(Refund refund) throws Bit
 
         return params;
     }
+
+    private void validateRefundId(String refundId) throws RefundQueryException {
+        if (Objects.isNull(refundId)) {
+            throw new RefundQueryException(null, "missing required parameter");
+        }
+    }
 }

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

@@ -99,7 +99,7 @@ public List<Settlement> getSettlements(String currency, String dateStart, String
      * @throws BitPayException          BitPayException class
      * @throws SettlementQueryException SettlementQueryException class
      */
-    public Settlement getSettlement(String settlementId) throws BitPayException, SettlementQueryException {
+    public Settlement get(String settlementId) throws BitPayException, SettlementQueryException {
         if (Objects.isNull(settlementId)) {
             throw new SettlementQueryException(null, "missing required parameter");
         }