CA-4834 Merges feature/Update-Order into develop

Author: rjdavis3

README.md

@@ -28,7 +28,7 @@ The final parameters of the SDK builder are optional and will use default values
 |Minimum Request Retry Random Delay|Shopify SDK uses a random wait strategy when calculating to perform the next attempt. This is the minimum duration to wait before performing the failed request.|1 second|
 |Maximum Request Retry Random Delay|Shopify SDK uses a random wait strategy when calculating to perform the next attempt. This is the maximum duration to wait before performing the failed request.|5 seconds|
 |Maximum Request Retry Timeout|The maximum time to keep retrying failed requests.|3 minutes|
-|Connection Timeout|The duration to attempt to read a response from Shopify's API.|1 minute|
+|Connection Timeout|The duration to attempt to connect to Shopify's API.|1 minute|
 |Read Timeout|The duration to attempt to read a response from Shopify's API.|15 Seconds|
 
 ## Building from source

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.channelape</groupId>
 	<artifactId>shopify-sdk</artifactId>
-	<version>1.4.0</version>
+	<version>1.5.0-SNAPSHOT</version>
 
 	<name>Shopify SDK</name>
 	<description>Java SDK for Shopify REST API.</description>
@@ -159,7 +159,8 @@
 							<goal>mutationCoverage</goal>
 						</goals>
 						<configuration>
-							<mutationThreshold>82</mutationThreshold>
+							<mutationThreshold>87</mutationThreshold>
+							<threads>10</threads>
 							<targetClasses>
 								<param>com.shopify.*</param>
 							</targetClasses>

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

@@ -23,15 +23,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.databind.AnnotationIntrospector;
-import com.fasterxml.jackson.databind.DeserializationFeature;
-import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;
-import com.fasterxml.jackson.databind.type.TypeFactory;
 import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
-import com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector;
 import com.github.rholder.retry.Attempt;
 import com.github.rholder.retry.RetryException;
 import com.github.rholder.retry.RetryListener;
@@ -41,6 +34,7 @@
 import com.github.rholder.retry.WaitStrategies;
 import com.shopify.exceptions.ShopifyClientException;
 import com.shopify.exceptions.ShopifyErrorResponseException;
+import com.shopify.mappers.ShopifySdkObjectMapper;
 import com.shopify.model.Count;
 import com.shopify.model.Image;
 import com.shopify.model.ImageAltTextCreationRequest;
@@ -67,6 +61,8 @@
 import com.shopify.model.ShopifyOrderRisk;
 import com.shopify.model.ShopifyOrderRisksRoot;
 import com.shopify.model.ShopifyOrderRoot;
+import com.shopify.model.ShopifyOrderShippingAddressUpdateRequest;
+import com.shopify.model.ShopifyOrderUpdateRoot;
 import com.shopify.model.ShopifyOrdersRoot;
 import com.shopify.model.ShopifyProduct;
 import com.shopify.model.ShopifyProductCreationRequest;
@@ -171,6 +167,7 @@ public class ShopifySdk {
 	private long minimumRequestRetryRandomDelayMilliseconds;
 	private long maximumRequestRetryRandomDelayMilliseconds;
 	private long maximumRequestRetryTimeoutMilliseconds;
+	private final ShopifySdkRetryListener shopifySdkRetryListener = new ShopifySdkRetryListener();
 
 	private static final Client CLIENT = buildClient();
 
@@ -623,6 +620,16 @@ public ShopifyOrder createOrder(final ShopifyOrderCreationRequest shopifyOrderCr
 		return shopifyOrderRootResponse.getOrder();
 	}
 
+	public ShopifyOrder updateOrderShippingAddress(
+			final ShopifyOrderShippingAddressUpdateRequest shopifyOrderUpdateRequest) {
+		final ShopifyOrderUpdateRoot shopifyOrderRoot = new ShopifyOrderUpdateRoot();
+		shopifyOrderRoot.setOrder(shopifyOrderUpdateRequest);
+		final Response response = put(getWebTarget().path(ORDERS).path(shopifyOrderUpdateRequest.getId()),
+				shopifyOrderRoot);
+		final ShopifyOrderRoot shopifyOrderRootResponse = response.readEntity(ShopifyOrderRoot.class);
+		return shopifyOrderRootResponse.getOrder();
+	}
+
 	public ShopifyFulfillment cancelFulfillment(final String orderId, final String fulfillmentId) {
 		final Response response = post(
 				getWebTarget().path(ORDERS).path(orderId).path(FULFILLMENTS).path(fulfillmentId).path(CANCEL),
@@ -811,6 +818,7 @@ private <T> Response put(final WebTarget webTarget, final T object) {
 	}
 
 	private Response handleResponse(final Response response, final Status... expectedStatus) {
+
 		if ((response.getHeaders() != null) && response.getHeaders().containsKey(DEPRECATED_REASON_HEADER)) {
 			LOGGER.error(DEPRECATED_SHOPIFY_CALL_ERROR_MESSAGE, response.getLocation(), response.getStatus(),
 					response.getStringHeaders());
@@ -820,7 +828,8 @@ private Response handleResponse(final Response response, final Status... expecte
 		if (expectedStatusCodes.contains(response.getStatus())) {
 			return response;
 		}
-		throw new ShopifyErrorResponseException(response);
+
+		throw new ShopifyErrorResponseException(response, shopifySdkRetryListener.getResponseBody());
 	}
 
 	private List<Integer> getExpectedStatusCodes(final Status... expectedStatus) {
@@ -842,7 +851,7 @@ private Retryer<Response> buildResponseRetyer() {
 						TimeUnit.MILLISECONDS, maximumRequestRetryRandomDelayMilliseconds, TimeUnit.MILLISECONDS))
 				.withStopStrategy(
 						StopStrategies.stopAfterDelay(maximumRequestRetryTimeoutMilliseconds, TimeUnit.MILLISECONDS))
-				.withRetryListener(new ShopifySdkRetryListener()).build();
+				.withRetryListener(shopifySdkRetryListener).build();
 	}
 
 	private static boolean shouldRetryResponse(final Response response) {
@@ -859,9 +868,10 @@ 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()) {
-			response.bufferEntity();
 			final String shopifyErrorResponse = response.readEntity(String.class);
+			LOGGER.debug(shopifyErrorResponse);
 			return shopifyErrorResponse.contains(COULD_NOT_BE_SAVED_SHOPIFY_ERROR_MESSAGE);
 		}
 		return false;
@@ -909,43 +919,38 @@ private WebTarget getWebTarget() {
 	}
 
 	private static Client buildClient() {
-		final ObjectMapper mapper = buildMapper();
+		final ObjectMapper mapper = ShopifySdkObjectMapper.buildMapper();
 		final JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider();
 		provider.setMapper(mapper);
 
 		return ClientBuilder.newClient().register(JacksonFeature.class).register(provider);
 	}
 
-	static ObjectMapper buildMapper() {
-		final ObjectMapper mapper = new ObjectMapper();
-		mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
-		mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
-
-		final AnnotationIntrospector pair = AnnotationIntrospector.pair(
-				new JaxbAnnotationIntrospector(TypeFactory.defaultInstance()), new JacksonAnnotationIntrospector());
-		mapper.setAnnotationIntrospector(pair);
-
-		mapper.enable(MapperFeature.USE_ANNOTATIONS);
-		return mapper;
-	}
-
-	private static class ShopifySdkRetryListener implements RetryListener {
+	public class ShopifySdkRetryListener implements RetryListener {
 
-		private static final String RETRY_EXCEPTION_ATTEMPT_MESSAGE = "An exception occurred while making an API call to shopify on attempt number {} and {} seconds since first attempt with exception {}";
+		private static final String RETRY_EXCEPTION_ATTEMPT_MESSAGE = "An exception occurred while making an API call to shopify: {} on attempt number {} and {} seconds since first attempt";
 		private static final String RETRY_INVALID_RESPONSE_ATTEMPT_MESSAGE = "Waited {} seconds since first retry attempt. This is attempt {}. Please review the following failed request information.\nRequest Location of {}\nResponse Status Code of {}\nResponse Headers of:\n{}\nResponse Body of:\n{}";
 
+		private String responseBody;
+
 		@Override
 		public <V> void onRetry(final Attempt<V> attempt) {
-			if (LOGGER.isWarnEnabled() && attempt.hasResult()) {
+			if (attempt.hasResult()) {
 				final Response response = (Response) attempt.getResult();
+
 				response.bufferEntity();
-				if (shouldRetryResponse(response) && !hasExceededRateLimit(response)) {
+				this.responseBody = response.readEntity(String.class);
+
+				if (LOGGER.isWarnEnabled() && !hasExceededRateLimit(response) && shouldRetryResponse(response)) {
+
 					final long delaySinceFirstAttemptInSeconds = convertMillisecondsToSeconds(
 							attempt.getDelaySinceFirstAttempt());
 					LOGGER.warn(RETRY_INVALID_RESPONSE_ATTEMPT_MESSAGE, delaySinceFirstAttemptInSeconds,
 							attempt.getAttemptNumber(), response.getLocation(), response.getStatus(),
-							response.getStringHeaders(), response.readEntity(String.class));
+							response.getStringHeaders(), this.responseBody);
+
 				}
+
 			} else if (LOGGER.isWarnEnabled() && attempt.hasException()) {
 
 				final long delaySinceFirstAttemptInSeconds = convertMillisecondsToSeconds(
@@ -955,9 +960,14 @@ public <V> void onRetry(final Attempt<V> attempt) {
 			}
 		}
 
+		public String getResponseBody() {
+			return responseBody;
+		}
+
 		private long convertMillisecondsToSeconds(final long milliiseconds) {
 			return TimeUnit.SECONDS.convert(milliiseconds, TimeUnit.MILLISECONDS);
 		}
+
 	}
 
 }

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

@@ -0,0 +1,29 @@
+package com.shopify.exceptions;
+
+import java.io.Serializable;
+
+public class ShopifyErrorCode implements Serializable {
+
+	private static final long serialVersionUID = -3870975240510101019L;
+
+	public enum Type implements Serializable {
+		SHIPPING_ADDRESS, UNKNOWN
+	}
+
+	private final Type type;
+	private final String message;
+
+	public ShopifyErrorCode(final Type type, final String message) {
+		this.type = type;
+		this.message = message;
+	}
+
+	public Type getType() {
+		return type;
+	}
+
+	public String getMessage() {
+		return message;
+	}
+
+}

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

@@ -0,0 +1,46 @@
+package com.shopify.exceptions;
+
+import java.util.LinkedList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.shopify.mappers.ShopifySdkObjectMapper;
+import com.shopify.model.ShopifyErrorsRoot;
+
+public class ShopifyErrorCodeFactory {
+	private static final Logger LOGGER = LoggerFactory.getLogger(ShopifyErrorCodeFactory.class);
+	private static final String COULD_NOT_PARSE_ERROR_RESPONSE_MESSAGE = "Could not parse error message from shopify for response body: {}";
+	private static final String NO_VALID_ERROR_CODES_FOUND_MESSAGE = "Shopify error format is not readable %s";
+
+	private ShopifyErrorCodeFactory() {
+	}
+
+	public static final List<ShopifyErrorCode> create(final String responseBody) {
+		final List<ShopifyErrorCode> shopifyErrorCodes = new LinkedList<>();
+		try {
+			final ObjectMapper objectMapper = ShopifySdkObjectMapper.buildMapper();
+
+			final ShopifyErrorsRoot shopifyErrorsRoot = objectMapper.readValue(responseBody, ShopifyErrorsRoot.class);
+			final List<ShopifyErrorCode> shippingAddressErrorCodes = shopifyErrorsRoot.getErrors()
+					.getShippingAddressErrors().stream()
+					.map(shippingAddress -> new ShopifyErrorCode(ShopifyErrorCode.Type.SHIPPING_ADDRESS,
+							shippingAddress))
+					.collect(Collectors.toList());
+			shopifyErrorCodes.addAll(shippingAddressErrorCodes);
+
+			if (shopifyErrorCodes.isEmpty()) {
+				throw new IllegalArgumentException(String.format(NO_VALID_ERROR_CODES_FOUND_MESSAGE, responseBody));
+			}
+		} catch (final Exception e) {
+			final ShopifyErrorCode shopifyErrorCode = new ShopifyErrorCode(ShopifyErrorCode.Type.UNKNOWN, responseBody);
+			shopifyErrorCodes.add(shopifyErrorCode);
+			LOGGER.warn(COULD_NOT_PARSE_ERROR_RESPONSE_MESSAGE, responseBody, e);
+		}
+		return shopifyErrorCodes;
+	}
+
+}

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

@@ -1,15 +1,37 @@
 package com.shopify.exceptions;
 
+import java.util.List;
+
 import javax.ws.rs.core.Response;
 
 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";
-
+	private final int statusCode;
 	private static final long serialVersionUID = 5646635633348617058L;
+	private final String responseBody;
+	private final List<ShopifyErrorCode> shopifyErrorCodes;
 
 	public ShopifyErrorResponseException(final Response response) {
 		super(buildMessage(response));
+		response.bufferEntity();
+		this.responseBody = response.readEntity(String.class);
+		this.shopifyErrorCodes = ShopifyErrorCodeFactory.create(responseBody);
+		this.statusCode = response.getStatus();
+	}
+
+	public ShopifyErrorResponseException(final Response response, final String responseBody) {
+		super(buildMessage(response, responseBody));
+		response.bufferEntity();
+
+		this.responseBody = responseBody;
+		this.shopifyErrorCodes = ShopifyErrorCodeFactory.create(responseBody);
+		this.statusCode = response.getStatus();
+	}
+
+	private static String buildMessage(final Response response, final String responseBody) {
+		response.bufferEntity();
+		return String.format(MESSAGE, response.getStatus(), response.getStringHeaders(), responseBody);
 	}
 
 	private static String buildMessage(final Response response) {
@@ -18,4 +40,16 @@ private static String buildMessage(final Response response) {
 				response.readEntity(String.class));
 	}
 
+	public int getStatusCode() {
+		return statusCode;
+	}
+
+	public String getResponseBody() {
+		return responseBody;
+	}
+
+	public List<ShopifyErrorCode> getShopifyErrorCodes() {
+		return shopifyErrorCodes;
+	}
+
 }

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

@@ -0,0 +1,29 @@
+package com.shopify.mappers;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.AnnotationIntrospector;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.MapperFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;
+import com.fasterxml.jackson.databind.type.TypeFactory;
+import com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector;
+
+public class ShopifySdkObjectMapper {
+
+	private ShopifySdkObjectMapper() {
+	}
+
+	public static ObjectMapper buildMapper() {
+		final ObjectMapper mapper = new ObjectMapper();
+		mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+		mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+
+		final AnnotationIntrospector pair = AnnotationIntrospector.pair(
+				new JaxbAnnotationIntrospector(TypeFactory.defaultInstance()), new JacksonAnnotationIntrospector());
+		mapper.setAnnotationIntrospector(pair);
+
+		mapper.enable(MapperFeature.USE_ANNOTATIONS);
+		return mapper;
+	}
+}