Merge pull request #45 from securitiesindustrydataexchange/StatusCode-Issue-35

Status code is now an enum

Author: Alvin Reyes

pom.xml

@@ -76,8 +76,13 @@
 		<dependency>
 			<groupId>com.google.code.gson</groupId>
 			<artifactId>gson</artifactId>
-			<version>2.7</version>
+			<version>2.8.2</version>
 		</dependency>
+		<!--
+		You must install java-crypto-conditions-2.0.0-SNAPSHOT.jar in your local Maven repository with the following
+		
+		mvn install:install-file -Dfile=<absolute_path_to_repo>\libs\java-crypto-conditions-2.0.0-SNAPSHOT.jar -DgroupId=org.interledger -DartifactId=java-crypto-conditions -Dversion=2.0.0-SNAPSHOT -Dpackaging=jar
+		-->
 		<dependency>
 			<groupId>org.interledger</groupId>
 			<artifactId>java-crypto-conditions</artifactId>

src/main/java/com/authenteq/api/StatusException.java

@@ -0,0 +1,32 @@
+package com.authenteq.api;
+
+/**
+ * Any http errors when checking the status of Transactions or Blocks
+ */
+public class StatusException extends Exception
+{
+	private final int httpResponseCode;
+
+	/**
+	 * Constructor
+	 *
+	 * @param httpResponseCode the http error
+	 * @param msg the error message
+	 */
+	public StatusException( int httpResponseCode, String msg )
+	{
+		super( msg );
+		this.httpResponseCode = httpResponseCode;
+	}
+
+	/**
+	 * Get the augmented error message with the HTTP Response code
+	 *
+	 * @return the message
+	 */
+	@Override
+	public String getMessage()
+	{
+		return "HTTP Response code: " + httpResponseCode + " Message: "+ super.getMessage();
+	}
+}

src/main/java/com/authenteq/api/StatusesApi.java

@@ -10,8 +10,6 @@
 import java.io.IOException;
 import java.util.logging.Logger;
 
-
-
 /**
  * The Class StatusesApi.
  */
@@ -26,12 +24,16 @@ public class StatusesApi {
 	 * @return the transaction status
 	 * @throws IOException Signals that an I/O exception has occurred.
 	 */
-	public static Status getTransactionStatus(String transactionId) throws IOException { 
+	public static Status getTransactionStatus(String transactionId) throws StatusException, IOException
+	{
 		LOGGER.info("getTransactionStatus Call :" + transactionId);
-		Response response = NetworkUtils.sendGetRequest(BigChainDBGlobals.getBaseUrl() + BigchainDbApi.STATUSES + "?transaction_id="+ transactionId);
+		try( Response response = NetworkUtils.sendGetRequest(BigChainDBGlobals.getBaseUrl() + BigchainDbApi.STATUSES + "?transaction_id="+ transactionId) ) {
+			if( response.code() == 200 ) {
 		String body = response.body().string();
-		response.close();
 		return JsonUtils.fromJson(body, Status.class);
+			}
+			throw new StatusException( response.code(), response.body() != null ? response.body().toString() : "Error in response, body is empty" );
+		}
 	}
 
 	/**
@@ -41,11 +43,15 @@ public static Status getTransactionStatus(String transactionId) throws IOExcepti
 	 * @return the block status
 	 * @throws IOException Signals that an I/O exception has occurred.
 	 */
-	public static Status getBlockStatus(String blockId) throws IOException {
+	public static Status getBlockStatus(String blockId) throws StatusException, IOException {
 		LOGGER.info("getBlockStatus Call :" + blockId);
-		Response response = NetworkUtils.sendGetRequest(BigChainDBGlobals.getBaseUrl() + BigchainDbApi.STATUSES + "?block_id="+ blockId);
+		try( Response response = NetworkUtils.sendGetRequest(BigChainDBGlobals.getBaseUrl() + BigchainDbApi.STATUSES + "?block_id="+ blockId) ) {
+			if( response.code() == 200 ) {
 		String body = response.body().string();
-		response.close();
 		return JsonUtils.fromJson(body, Status.class);
+			}
+			throw new StatusException( response.code(), response.body() != null ? response.body().toString() : "Error in response, body is empty" );
+		}
 	}
 }
+                                                               

src/main/java/com/authenteq/model/Status.java

@@ -7,18 +7,18 @@
 /**
  * The Class Status.
  */
-public class Status {
-
+public class Status
+{
 	/** The status. */
-	@SerializedName("status")
-	private String status;
+	private StatusCode status;
 
 	/**
 	 * Gets the status.
 	 *
 	 * @return the status
 	 */
-	public String getStatus() {
+	public StatusCode getStatus()
+	{
 		return status;
 	}
 
@@ -27,18 +27,8 @@ public String getStatus() {
 	 *
 	 * @param status the new status
 	 */
-	public void setStatus(String status) {
-		this.status = status;
-	}
-
-	/**
-	 * toString
-	 *
-	 * @return status
-	 */
-	@Override
-	public String toString()
+	public void setStatus( StatusCode statusCode )
 	{
-		return status;
+		this.status = statusCode;
 	}
 }

src/main/java/com/authenteq/model/StatusCode.java

@@ -0,0 +1,46 @@
+package com.authenteq.model;
+
+import com.google.gson.annotations.SerializedName;
+
+public enum StatusCode
+{
+	@SerializedName( "valid" )
+	VALID( "valid" ),
+	@SerializedName( "backlog" )
+	BACKLOG( "backlog" ),
+	@SerializedName( "undecided" )
+	UNDECIDED( "undecided" );
+
+	private final String statusCode;
+
+	/**
+	 * Status code initializer
+	 *
+	 * @param status the status code
+	 */
+	StatusCode( final String status )
+	{
+		this.statusCode = status;
+	}
+
+	/**
+	 * get the status
+	 *
+	 * @return the status
+	 */
+	public String statusCode()
+	{
+		return this.statusCode;
+	}
+
+	/**
+	 * toString
+	 *
+	 * @return status
+	 */
+	@Override
+	public String toString()
+	{
+		return this.statusCode;
+	}
+}

src/main/java/com/authenteq/util/JsonUtils.java

@@ -6,6 +6,7 @@
 import com.authenteq.model.Outputs;
 import com.authenteq.model.Transactions;
 import com.authenteq.model.Votes;
+import com.google.gson.FieldNamingPolicy;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 
@@ -33,7 +34,10 @@ public static Gson getGson() {
 		if (gson == null) {
 			GsonBuilder builder = new GsonBuilder();
 
-			gson = builder.setPrettyPrinting().serializeNulls().disableHtmlEscaping().setPrettyPrinting()
+			gson = builder.setPrettyPrinting()
+					.serializeNulls()
+					.disableHtmlEscaping()
+					.setPrettyPrinting()
 					.registerTypeAdapter(Transactions.class, new TransactionsDeserializer())
 					.registerTypeAdapter(Assets.class, new AssetsDeserializer())
 					.registerTypeAdapter(Outputs.class, new OutputsDeserializer())

src/test/java/com/authenteq/AbstractTest.java

@@ -1,7 +1,9 @@
 package com.authenteq;
 
+import com.authenteq.api.StatusException;
 import com.authenteq.api.StatusesApi;
 import com.authenteq.model.Status;
+import com.authenteq.model.StatusCode;
 import com.authenteq.model.Transaction;
 
 import java.io.FileInputStream;
@@ -131,7 +133,7 @@ protected static String getEnv( final String envKey, final String otherwise )
 	 * @return the status
 	 * @throws IOException network error
 	 */
-	protected Status getStatus( final Transaction transaction ) throws IOException
+	protected Status getStatus( final Transaction transaction ) throws IOException, StatusException
 	{
 		return getStatus( transaction, getInt( "test.status.retries", 60 ) );
 	}
@@ -144,17 +146,30 @@ protected Status getStatus( final Transaction transaction ) throws IOException
 	 * @return the status
 	 * @throws IOException network error
 	 */
-	protected Status getStatus( final Transaction transaction, final int attempts ) throws IOException
+	protected Status getStatus( final Transaction transaction, final int attempts ) throws IOException, StatusException
 	{
+		return getStatus( transaction, attempts, StatusCode.VALID );
+	}
+
+	/**
+	 * Poll for transaction status
+	 *
+	 * @param transaction transaction to check the status of
+	 * @param attempts how many tries while waiting for validation
+	 * @return the status
+	 * @throws IOException network error
+	 */
+	protected Status getStatus( final Transaction transaction, final int attempts, final StatusCode expectedStatus ) throws IOException, StatusException
+	{
+		Status status = null;
 		for( int idx = 0; idx < attempts; idx++ ) {
-			Status status = StatusesApi.getTransactionStatus( transaction.getId() );
-			if( status.getStatus().equalsIgnoreCase( "valid" ) )
+			status = StatusesApi.getTransactionStatus( transaction.getId() );
+			System.err.println( " status " + status );
+			if( status.getStatus().equals( expectedStatus ) )
 				return status;
 		}
 
-		Status invalid = new Status();
-		invalid.setStatus( "timeout" );
-		return invalid;
+		throw new RuntimeException( "Could not get valid status, last status " + status + " after " + attempts + " attempts ");
 	}
 
 	/**

src/test/java/com/authenteq/api/AssetsApiTest.java

@@ -8,17 +8,16 @@
 import com.authenteq.AbstractTest;
 import com.authenteq.builders.BigchainDbTransactionBuilder;
 import com.authenteq.model.Assets;
+import com.authenteq.model.StatusCode;
 import com.authenteq.model.Transaction;
 import net.i2p.crypto.eddsa.EdDSAPrivateKey;
 import net.i2p.crypto.eddsa.EdDSAPublicKey;
 import org.junit.BeforeClass;
 import org.junit.Test;
 
-import com.authenteq.api.AssetsApi;
 import com.authenteq.builders.BigchainDbConfigBuilder;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
 
 /**
  * The Class AssetsApiTest.
@@ -42,7 +41,8 @@ public static void init() {
 	 * Test asset search.
 	 */
 	@Test
-	public void testAssetSearch() {
+	public void testAssetSearch()
+	{
 		String uuid = getUUID();
 		System.err.println( "AssetApiTest.testAssetSearch.uuid " + uuid );
 		try {
@@ -55,11 +55,11 @@ public void testAssetSearch() {
 				                          .addAsset( "uuid", uuid )
 				                          .buildAndSign( (EdDSAPublicKey) alice.getPublic(), (EdDSAPrivateKey) alice.getPrivate() )
 				                          .sendTransaction();
-			assertEquals( "valid", getStatus( transaction ).toString());    // wait for the transaction to be marked valid
+			assertEquals( StatusCode.VALID, getStatus( transaction ).getStatus() );    // wait for the transaction to be marked VALID
 
 			Assets assets = AssetsApi.getAssets( asQuoted( uuid ) );
 			assertTrue( assets.size() == 1 ); // there should be one and only one
-		} catch (IOException e) {
+		} catch (IOException | StatusException e) {
 			e.printStackTrace();
 		}
 	}

src/test/java/com/authenteq/api/BlocksApiTest.java

@@ -28,6 +28,9 @@
  */
 public class BlocksApiTest extends AbstractTest
 {
+	private String publicKey = "302a300506032b657003210033c43dc2180936a2a9138a05f06c892d2fb1cfda4562cbc35373bf13cd8ed373";
+	private String privateKey = "302e020100300506032b6570042204206f6b0cd095f1e83fc5f08bffb79c7c8a30e77a3ab65f4bc659026b76394fcea8";
+
 	/**
 	 * Inits the.
 	 */

src/test/java/com/authenteq/api/StatusesApiTest.java

@@ -6,10 +6,8 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 
-import com.authenteq.api.AssetsApi;
 import com.authenteq.builders.BigchainDbConfigBuilder;
 
-
 /**
  * The Class StatusesApiTest.
  */
@@ -35,7 +33,7 @@ public static void init() {
 	public void testStatusTransaction() {
 		try {
 			System.out.println(StatusesApi.getTransactionStatus("437ce30de5cf1c3ad199fa983aded47d0db43567befa92e3a36b38a5784e4d3a").getStatus());
-		} catch (IOException e) {
+		} catch (IOException | StatusException e) {
 			// TODO Auto-generated catch block
 			e.printStackTrace();
 		}