Creating BitPay client with URI of key

- Added constructors for passing the URI of your private key. We prefer to have users of this library pass in a URI for their key file. That way, this api isn't just writing new key files to the current working directory. If the URI does not have a key already, one will be created there (if writeable). It will be the user's responsibility to safeguard their private keys.
- A bit of code cleanup in terms of spelling and removal of warnings, etc.

Author: Chris Kleeschulte

src/main/java/controller/KeyUtils.java

@@ -7,34 +7,33 @@
 
 import java.io.*;
 import java.math.BigInteger;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.security.SecureRandom;
 
 public class KeyUtils {
 
     final private static char[] hexArray = "0123456789abcdef".toCharArray();
     final private static String PRIV_KEY_FILENAME = "bitpay_private.key";
+    private static URI privateKey;
 
-    public KeyUtils() {}
+    public KeyUtils() {
+    }
 
-    public static boolean privateKeyExists()
-    {
+    public static boolean privateKeyExists() {
         return new File(PRIV_KEY_FILENAME).exists();
     }
 
-    public static ECKey createEcKey()
-    {
+    public static ECKey createEcKey() {
         //Default constructor uses SecureRandom numbers.
         return new ECKey();
     }
 
-    public static ECKey createEcKeyFromHexString(String privateKey)
-    {
+    public static ECKey createEcKeyFromHexString(String privateKey) {
         //if you are going to choose this option, please ensure this string is as random as
         //possible, consider http://world.std.com/~reinhold/diceware.html
         SecureRandom randomSeed = new SecureRandom(privateKey.getBytes());
-        ECKey key = new ECKey(randomSeed);
-
-        return key;
+        return new ECKey(randomSeed);
     }
 
     /**
@@ -44,10 +43,9 @@ public static ECKey createEcKeyFromHexStringFile(String privKeyFile) throws IOEx
         return createEcKeyFromHexString(getKeyStringFromFile(privKeyFile));
     }
 
-    public static ECKey loadEcKey() throws IOException
-    {
-        FileInputStream fileInputStream = null;
-        File file = new File(PRIV_KEY_FILENAME);
+    public static ECKey loadEcKey() throws IOException {
+        FileInputStream fileInputStream;
+        File file;
 
         if (KeyUtils.privateKey == null) {
             file = new File(PRIV_KEY_FILENAME);
@@ -145,9 +143,6 @@ public static String deriveSIN(ECKey ecKey) throws IllegalArgumentException {
         return Base58.encode(unencodedBytes);
     }
 
-        return encoded;
-    }
-
     public static String sign(ECKey key, String input) throws UnsupportedEncodingException {
         byte[] data = input.getBytes("UTF8");
 
@@ -159,9 +154,8 @@ public static String sign(ECKey key, String input) throws UnsupportedEncodingExc
         return bytesToHex(bytes);
     }
 
-    private static int getHexVal(char hex)
-    {
-        int val = (int)hex;
+    private static int getHexVal(char hex) {
+        int val = (int) hex;
         return val - (val < 58 ? 48 : (val < 97 ? 55 : 87));
     }
 

src/test/java/test/BitPayTest.java

@@ -9,6 +9,9 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.List;
@@ -24,21 +27,33 @@ public class BitPayTest {
 
     private static String clientName = "BitPay Java Library Tester";
     private static String pairingCode;
-    private static String refundInvoiceId;
+    private static String refundInvoiceId = null;
+    private static URI myKeyFile;
 
     @Before
-    public void setUp() throws BitPayException {
+    public void setUp() throws BitPayException, IOException, URISyntaxException {
         //ensure the second argument (api url) is the same as the one used in setUpOneTime()
-        bitpay = new BitPay(clientName, BitPay.BITPAY_TEST_URL);
+        bitpay = new BitPay(myKeyFile, clientName, BitPay.BITPAY_TEST_URL);
     }
 
 	@BeforeClass
-	public static void setUpOneTime() throws Exception
-	{
+	public static void setUpOneTime() throws InterruptedException, IOException, BitPayException, URISyntaxException {
         boolean dumpOut = false;
+
+        //create a key, if a file does exist at the uri, myKeyfile, a new key will be created in the construction of the client
+        //ECKey myKey = KeyUtils.createEcKey();
+
+
+        myKeyFile = new URI("file:///tmp/bitpay_private.key"); //if file exists, it will not overwrite
+
+        //save the somewhere that you can reuse it:
+        //this saves a EC key to compressed ASN.1 DER encoded format
+        //if you use your own key (not generated by our key utils), then ensure your key is in the above format
+        //KeyUtils.saveEcKey(myKey, myKeyFile);
+
         // This scenario qualifies that this (test) client does not have merchant facade access.
 		clientName += " on " + java.net.InetAddress.getLocalHost();
-		BitPay bitpay = new BitPay(clientName, BitPay.BITPAY_TEST_URL);
+		BitPay bitpay = new BitPay(myKeyFile, clientName, BitPay.BITPAY_TEST_URL);
 
 		// Authorize this client for use with a BitPay merchant account.  This client requires both
 		// POS and MERCHANT facades.
@@ -62,7 +77,7 @@ public static void setUpOneTime() throws Exception
             System.out.println("Info: Client is requesting POS facade access. Pair this client with your merchant account using the pairing code: " + pairingCode);
             dumpOut = true;
             //we already failed to authorize for a POS token, therefore we must sleep a bit to try to authorize for any other facade (rate limiter on the api side)
-            Thread.sleep(3000);
+            Thread.sleep(10000);
         }
 
         if (!bitpay.clientIsAuthorized(BitPay.FACADE_MERCHANT))

src/test/java/test/BitPayTest2.java

@@ -7,6 +7,8 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 
+import java.net.UnknownHostException;
+
 import static org.junit.Assert.assertNotNull;
 
 import static org.junit.Assert.assertNotNull;
@@ -23,14 +25,14 @@ public void setUp() throws BitPayException {
     }
 
 	@BeforeClass
-	public static void setUpOneTime() throws Exception
+	public static void setUpOneTime() throws UnknownHostException, BitPayException
 	{
 		// If this test has never been run before then this test must be run twice in order to pass.
 		// The first time this test runs it will create an identity and emit a client pairing code.
 		// The pairing code must then be authorized in a BitPay account.  Running the test a second
 		// time should result in the authorized client (this test) running to completion.
 		clientName += " on " + java.net.InetAddress.getLocalHost();
-        BitPay bitpay = new BitPay(clientName, BitPay.BITPAY_TEST_URL);
+        BitPay bitpay = new BitPay(clientName, BitPay.BITPAY_TEST_URL); //this tests the old way of creating keys/clients
 
         if (!bitpay.clientIsAuthorized(BitPay.FACADE_POS))
         {
@@ -55,8 +57,6 @@ public void testShouldGetInvoiceId()
         } catch (BitPayException e) {
             e.printStackTrace();
         }
-        System.out.println(invoice.getId());
-        refundInvoiceId = invoice.getId();
         assertNotNull(invoice.getId());
     }
 }