Merge branch 'release/2.1.0'

Author: ryankazokas

README.md

@@ -20,6 +20,8 @@ final ShopifySdk shopifySdk = ShopifySdk.newBuilder()
 final ShopifyShop shopifyShop = shopifySdk.getShop();
 ```
 
+For private apps, `accessToken` should be the private app's Admin API password.
+
 ## Optional Configuration
 The final parameters of the SDK builder are optional and will use default values when not supplied:
 

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.channelape</groupId>
 	<artifactId>shopify-sdk</artifactId>
-	<version>2.0.1</version>
+	<version>2.1.0</version>
 
 	<name>Shopify SDK</name>
 	<description>Java SDK for Shopify REST API.</description>
@@ -56,7 +56,7 @@
 		<maven.compiler.source>1.8</maven.compiler.source>
 		<maven.compiler.target>1.8</maven.compiler.target>
 		<java.version>1.8</java.version>
-		<junit.version>4.12</junit.version>
+		<junit.version>4.13.1</junit.version>
 		<slf4j.version>1.7.22</slf4j.version>
 		<jersey.version>2.25.1</jersey.version>
 		<pitest.version>1.4.3</pitest.version>
@@ -94,6 +94,12 @@
 			<artifactId>commons-lang3</artifactId>
 			<version>3.4</version>
 		</dependency>
+		<dependency>
+		    <groupId>org.apache.commons</groupId>
+		    <artifactId>commons-io</artifactId>
+		    <version>1.3.2</version>
+		</dependency>
+				
 		<dependency>
 			<groupId>joda-time</groupId>
 			<artifactId>joda-time</artifactId>

src/main/java/com/shopify/ShopifySdk.java

@@ -37,6 +37,7 @@
 import com.github.rholder.retry.WaitStrategies;
 import com.shopify.exceptions.ShopifyClientException;
 import com.shopify.exceptions.ShopifyErrorResponseException;
+import com.shopify.mappers.ResponseEntityToStringMapper;
 import com.shopify.mappers.ShopifySdkObjectMapper;
 import com.shopify.model.Count;
 import com.shopify.model.Image;
@@ -996,9 +997,8 @@ private static boolean isServerError(final Response response) {
 	}
 
 	private static boolean hasNotBeenSaved(final Response response) {
-		response.bufferEntity();
 		if ((UNPROCESSABLE_ENTITY_STATUS_CODE == response.getStatus()) && response.hasEntity()) {
-			final String shopifyErrorResponse = response.readEntity(String.class);
+			final String shopifyErrorResponse = ResponseEntityToStringMapper.map(response);
 			LOGGER.debug(shopifyErrorResponse);
 			return shopifyErrorResponse.contains(COULD_NOT_BE_SAVED_SHOPIFY_ERROR_MESSAGE);
 		}
@@ -1064,8 +1064,7 @@ public <V> void onRetry(final Attempt<V> attempt) {
 			if (attempt.hasResult()) {
 				final Response response = (Response) attempt.getResult();
 
-				response.bufferEntity();
-				final String responseBody = response.readEntity(String.class);
+				final String responseBody = ResponseEntityToStringMapper.map(response);
 
 				if (LOGGER.isWarnEnabled() && !hasExceededRateLimit(response) && shouldRetryResponse(response)) {
 

src/main/java/com/shopify/exceptions/ShopifyErrorResponseException.java

@@ -4,6 +4,8 @@
 
 import javax.ws.rs.core.Response;
 
+import com.shopify.mappers.ResponseEntityToStringMapper;
+
 public class ShopifyErrorResponseException extends RuntimeException {
 
 	static final String MESSAGE = "Received unexpected Response Status Code of %d\nResponse Headers of:\n%s\nResponse Body of:\n%s";
@@ -14,15 +16,13 @@ public class ShopifyErrorResponseException extends RuntimeException {
 
 	public ShopifyErrorResponseException(final Response response) {
 		super(buildMessage(response));
-		response.bufferEntity();
-		this.responseBody = response.readEntity(String.class);
+		this.responseBody = ResponseEntityToStringMapper.map(response);
 		this.shopifyErrorCodes = ShopifyErrorCodeFactory.create(responseBody);
 		this.statusCode = response.getStatus();
 	}
 
 	private static String buildMessage(final Response response) {
-		response.bufferEntity();
-		final String readEntity = response.readEntity(String.class);
+		final String readEntity = ResponseEntityToStringMapper.map(response);
 		return String.format(MESSAGE, response.getStatus(), response.getStringHeaders(), readEntity);
 	}
 

src/main/java/com/shopify/mappers/ResponseEntityToStringMapper.java

@@ -0,0 +1,42 @@
+package com.shopify.mappers;
+
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+
+import javax.ws.rs.core.Response;
+
+import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ResponseEntityToStringMapper {
+
+	private static final Logger LOGGER = LoggerFactory.getLogger(ResponseEntityToStringMapper.class);
+
+	private ResponseEntityToStringMapper() {
+	}
+
+	/**
+	 * JAXRS Jersey Client implementation closes stream buffers when reading entity
+	 * by string. To combat this and be able to read entities via a string more than
+	 * once, this deals with the input streams involved and resets where necessary.
+	 *
+	 * @param response
+	 * @return
+	 */
+	public static String map(final Response response) {
+
+		try {
+			response.bufferEntity();
+			final InputStream entityBytes = (InputStream) response.getEntity();
+			final String responseBody = IOUtils.toString(entityBytes, StandardCharsets.UTF_8.toString());
+			entityBytes.reset();
+			return responseBody;
+		} catch (final Exception e) {
+			LOGGER.error("There was an error parsing response body on response with status {}, returning null",
+					response.getStatus());
+			return null;
+		}
+	}
+
+}

src/test/java/com/shopify/ShopifySdkDriver.java

@@ -9,6 +9,7 @@
 import java.math.BigDecimal;
 import java.util.Arrays;
 import java.util.Collections;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.Random;
 import java.util.UUID;
@@ -691,6 +692,19 @@ public void givenSomeValuesWhenUpdatingACustomerThenExpectValuesToBeUpdatedOnCus
 		assertEquals("RyanTest", updatedCustomer.getFirstName());
 	}
 
+	@Test
+	public void givenSomeErrorOccurrsWhenCreatingFulfillmentThenExpectCorrectErrors() {
+		try {
+			shopifySdk.createFulfillment(ShopifyFulfillmentCreationRequest.newBuilder().withOrderId("2854620102717")
+					.withTrackingCompany("UPS").withTrackingNumber("ABC-123").withNotifyCustomer(false)
+					.withLineItems(new LinkedList<>()).withLocationId("5523767400")
+					.withTrackingUrls(Arrays.asList("http://google.com/123")).build());
+		} catch (final Exception e) {
+			e.printStackTrace();
+		}
+
+	}
+
 	@After
 	public void after() {
 		System.out.println(TEST_DELIMITER);

src/test/java/com/shopify/exceptions/ShopifyErrorResponseExceptionTest.java

@@ -5,6 +5,9 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 
 import javax.ws.rs.core.MultivaluedHashMap;
@@ -32,7 +35,9 @@ public void givenResponseWith422StatusCodeAndSomeResponseBodyAndSomeResponsHeade
 		when(response.getStringHeaders()).thenReturn(responseHeaders);
 
 		final String expectedResponseBodyString = "{\"error\": \"something went wrong.\"}";
-		when(response.readEntity(String.class)).thenReturn(expectedResponseBodyString);
+		final InputStream expectedResponseStream = new ByteArrayInputStream(
+				expectedResponseBodyString.getBytes(StandardCharsets.UTF_8));
+		when(response.getEntity()).thenReturn(expectedResponseStream);
 
 		final ShopifyErrorResponseException actualShopifyErrorResponseException = new ShopifyErrorResponseException(
 				response);
@@ -65,7 +70,9 @@ public void givenResponseWith422StatusCodeAndSomeResponseBodyAndSomeResponsHeade
 		when(response.getStringHeaders()).thenReturn(responseHeaders);
 
 		final String expectedResponseBodyString = "Some unaprseable error";
-		when(response.readEntity(String.class)).thenReturn(expectedResponseBodyString);
+		final InputStream expectedResponseStream = new ByteArrayInputStream(
+				expectedResponseBodyString.getBytes(StandardCharsets.UTF_8));
+		when(response.getEntity()).thenReturn(expectedResponseStream);
 		final ShopifyErrorResponseException actualShopifyErrorResponseException = new ShopifyErrorResponseException(
 				response);
 
@@ -100,7 +107,9 @@ public void givenResponseWith422StatusCodeAndSomeResponseBodyAndSomeResponsHeade
 				+ "            \"address1 can't be blank, zip is not valid for united states, and city can't be blank\"\n"
 				+ "        ]\n" + "    }\n" + "}";
 
-		when(response.readEntity(String.class)).thenReturn(expectedResponseBodyString);
+		final InputStream expectedResponseStream = new ByteArrayInputStream(
+				expectedResponseBodyString.getBytes(StandardCharsets.UTF_8));
+		when(response.getEntity()).thenReturn(expectedResponseStream);
 		final ShopifyErrorResponseException actualShopifyErrorResponseException = new ShopifyErrorResponseException(
 				response);
 

src/test/java/com/shopify/mappers/ResponseEntityToStringMapperTest.java

@@ -0,0 +1,41 @@
+package com.shopify.mappers;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+
+import javax.ws.rs.core.Response;
+
+import org.junit.Test;
+
+public class ResponseEntityToStringMapperTest {
+
+	@Test
+	public void givenSomeValuesWhenMappingResponseEntityToAStringThenExpectCorrectValues() throws Exception {
+		final Response response = mock(Response.class);
+
+		final String expectedResponseBodyString = "{\"error\": \"something went wrong.\"}";
+		final InputStream expectedResponseStream = new ByteArrayInputStream(
+				expectedResponseBodyString.getBytes(StandardCharsets.UTF_8));
+		when(response.getEntity()).thenReturn(expectedResponseStream);
+		final String actualResponseBodyString = ResponseEntityToStringMapper.map(response);
+		assertEquals(expectedResponseBodyString, actualResponseBodyString);
+
+	}
+
+	@Test
+	public void givenSomeExceptionOccursWhenMappingResponseEntityToAStringThenExpectNullValue() throws Exception {
+		final Response response = mock(Response.class);
+
+		when(response.getEntity()).thenThrow(new NullPointerException());
+		final String actualResponseBodyString = ResponseEntityToStringMapper.map(response);
+		assertNull(actualResponseBodyString);
+
+	}
+
+}

src/test/java/com/shopify/model/ImageAltTextCreationRequestTest.java

@@ -6,9 +6,6 @@
 
 import org.junit.Test;
 
-import com.shopify.model.ImageAltTextCreationRequest;
-import com.shopify.model.Metafield;
-
 public class ImageAltTextCreationRequestTest {
 
 	@Test

src/test/java/com/shopify/model/ShopifyFulfillmentCreationRequestTest.java

@@ -9,10 +9,6 @@
 
 import org.junit.Test;
 
-import com.shopify.model.ShopifyFulfillment;
-import com.shopify.model.ShopifyFulfillmentCreationRequest;
-import com.shopify.model.ShopifyLineItem;
-
 public class ShopifyFulfillmentCreationRequestTest {
 
 	private static final List<String> SOME_TRACKING_URLS = Arrays.asList("https://ups.com/123", "https://ups.com/456");