Merge branch 'release/2.3.0'

Author: ryankazokas

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.channelape</groupId>
 	<artifactId>shopify-sdk</artifactId>
-	<version>2.2.0</version>
+	<version>2.3.0</version>
 
 	<name>Shopify SDK</name>
 	<description>Java SDK for Shopify REST API.</description>

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

@@ -103,6 +103,7 @@
 
 public class ShopifySdk {
 
+	static final String API_VERSION_PREFIX = "api";
 	private static final long TWO_HUNDRED_MILLISECONDS = 200L;
 	private static final String EQUALS = "=";
 	private static final String AMPERSAND = "&";
@@ -122,7 +123,6 @@ public class ShopifySdk {
 	static final String OAUTH = "oauth";
 	static final String REVOKE = "revoke";
 	static final String ACCESS_TOKEN = "access_token";
-	static final String VERSION_2020_01 = "api/2020-01";
 	static final String PRODUCTS = "products";
 	static final String VARIANTS = "variants";
 	static final String CUSTOM_COLLECTIONS = "custom_collections";
@@ -181,6 +181,7 @@ public class ShopifySdk {
 
 	private String shopSubdomain;
 	private String apiUrl;
+	private String apiVersion;
 	private String clientId;
 	private String clientSecret;
 	private String authorizationToken;
@@ -253,6 +254,18 @@ public static interface OptionalsStep {
 		 */
 		OptionalsStep withReadTimeout(int duration, TimeUnit timeUnit);
 
+		/**
+		 * String representation of the version you want to use. If not populated, this
+		 * will use shopify oldest stable version. Although this is not recommended so
+		 * you can target a set of shopify features. Ex: '2020-10' '2020-07' '2020-04'.
+		 * If you are specifying the API URL ensure you leave off the version if you are
+		 * using this.
+		 *
+		 * @param apiVersion
+		 * @return
+		 */
+		OptionalsStep withApiVersion(final String apiVersion);
+
 		ShopifySdk build();
 
 	}
@@ -291,6 +304,7 @@ protected ShopifySdk(final Steps steps) {
 			this.clientSecret = steps.clientSecret;
 			this.authorizationToken = steps.authorizationToken;
 			this.apiUrl = steps.apiUrl;
+			this.apiVersion = steps.apiVersion;
 			this.minimumRequestRetryRandomDelayMilliseconds = steps.minimumRequestRetryRandomDelayMilliseconds;
 			this.maximumRequestRetryRandomDelayMilliseconds = steps.maximumRequestRetryRandomDelayMilliseconds;
 			this.maximumRequestRetryTimeoutMilliseconds = steps.maximumRequestRetryTimeoutMilliseconds;
@@ -321,6 +335,7 @@ protected static class Steps
 		private String clientSecret;
 		private String authorizationToken;
 		private String apiUrl;
+		private String apiVersion;
 		private long minimumRequestRetryRandomDelayMilliseconds = DEFAULT_MINIMUM_REQUEST_RETRY_RANDOM_DELAY_IN_MILLISECONDS;
 		private long maximumRequestRetryRandomDelayMilliseconds = DEFAULT_MAXIMUM_REQUEST_RETRY_RANDOM_DELAY_IN_MILLISECONDS;
 		private long maximumRequestRetryTimeoutMilliseconds = DEFAULT_MAXIMUM_REQUEST_RETRY_TIMEOUT_IN_MILLISECONDS;
@@ -398,11 +413,17 @@ public OptionalsStep withReadTimeout(final int duration, final TimeUnit timeUnit
 			return this;
 		}
 
+		@Override
+		public OptionalsStep withApiVersion(final String apiVersion) {
+			this.apiVersion = apiVersion;
+			return this;
+		}
+
 	}
 
 	public boolean revokeOAuthToken() {
 		try {
-			final Response response = delete(getWebTarget().path(OAUTH).path(REVOKE));
+			final Response response = delete(getUnversionedWebTarget().path(OAUTH).path(REVOKE));
 			return Status.OK.getStatusCode() == response.getStatus();
 		} catch (final ShopifyErrorResponseException e) {
 			return false;
@@ -426,8 +447,8 @@ public ShopifyPage<ShopifyProduct> getProducts(final int pageSize) {
 	}
 
 	public ShopifyPage<ShopifyProduct> getProducts(final String pageInfo, final int pageSize) {
-		final Response response = get(getWebTarget().path(VERSION_2020_01).path(PRODUCTS)
-				.queryParam(LIMIT_QUERY_PARAMETER, pageSize).queryParam(PAGE_INFO_QUERY_PARAMETER, pageInfo));
+		final Response response = get(getWebTarget().path(PRODUCTS).queryParam(LIMIT_QUERY_PARAMETER, pageSize)
+				.queryParam(PAGE_INFO_QUERY_PARAMETER, pageInfo));
 		final ShopifyProductsRoot shopifyProductsRoot = response.readEntity(ShopifyProductsRoot.class);
 		return mapPagedResponse(shopifyProductsRoot.getProducts(), response);
 	}
@@ -723,7 +744,7 @@ public ShopifyCustomer getCustomer(final String customerId) {
 	}
 
 	public ShopifyPage<ShopifyCustomer> getCustomers(final ShopifyGetCustomersRequest shopifyGetCustomersRequest) {
-		WebTarget target = getWebTarget().path(VERSION_2020_01).path(CUSTOMERS);
+		WebTarget target = getWebTarget().path(CUSTOMERS);
 		if (shopifyGetCustomersRequest.getPageInfo() != null) {
 			target = target.queryParam(PAGE_INFO_QUERY_PARAMETER, shopifyGetCustomersRequest.getPageInfo());
 		}
@@ -749,14 +770,15 @@ public ShopifyPage<ShopifyCustomer> getCustomers(final ShopifyGetCustomersReques
 	}
 
 	public ShopifyPage<ShopifyCustomer> searchCustomers(final String query) {
-		final Response response = get(getWebTarget().path(VERSION_2020_01).path(CUSTOMERS).path(SEARCH)
+		final Response response = get(getWebTarget().path(CUSTOMERS).path(SEARCH)
 				.queryParam(QUERY_QUERY_PARAMETER, query).queryParam(LIMIT_QUERY_PARAMETER, DEFAULT_REQUEST_LIMIT));
 		return getCustomers(response);
 	}
 
 	public ShopifyFulfillment cancelFulfillment(final String orderId, final String fulfillmentId) {
+		final WebTarget buildOrdersEndpoint = buildOrdersEndpoint();
 		final Response response = post(
-				buildOrdersEndpoint().path(orderId).path(FULFILLMENTS).path(fulfillmentId).path(CANCEL),
+				buildOrdersEndpoint.path(orderId).path(FULFILLMENTS).path(fulfillmentId).path(CANCEL),
 				new ShopifyFulfillment());
 		final ShopifyFulfillmentRoot shopifyFulfillmentRootResponse = response.readEntity(ShopifyFulfillmentRoot.class);
 		return shopifyFulfillmentRootResponse.getFulfillment();
@@ -1009,8 +1031,8 @@ private String generateToken() {
 		try {
 
 			final Entity<String> entity = Entity.entity(EMPTY_STRING, MediaType.APPLICATION_JSON);
-			final Response response = this.webTarget.path(OAUTH).path(ACCESS_TOKEN).queryParam(CLIENT_ID, this.clientId)
-					.queryParam(CLIENT_SECRET, this.clientSecret)
+			final Response response = this.getUnversionedWebTarget().path(OAUTH).path(ACCESS_TOKEN)
+					.queryParam(CLIENT_ID, this.clientId).queryParam(CLIENT_SECRET, this.clientSecret)
 					.queryParam(AUTHORIZATION_CODE, this.authorizationToken).request(MediaType.APPLICATION_JSON)
 					.post(entity);
 
@@ -1027,6 +1049,14 @@ private String generateToken() {
 		}
 	}
 
+	private WebTarget getUnversionedWebTarget() {
+		if (StringUtils.isNotBlank(this.shopSubdomain)) {
+			return CLIENT
+					.target(new StringBuilder().append(HTTPS).append(this.shopSubdomain).append(API_TARGET).toString());
+		}
+		return CLIENT.target(this.apiUrl);
+	}
+
 	private WebTarget getWebTarget() {
 		if (this.webTarget == null) {
 
@@ -1037,9 +1067,13 @@ private WebTarget getWebTarget() {
 			} else {
 				this.webTarget = CLIENT.target(this.apiUrl);
 			}
+			if (StringUtils.isNotBlank(this.apiVersion)) {
+				this.webTarget = this.webTarget.path(API_VERSION_PREFIX).path(this.apiVersion);
+			}
 			if (this.accessToken == null) {
 				this.accessToken = generateToken();
 			}
+
 			final Shop shop = this.getShop().getShop();
 			LOGGER.info(SHOP_RETRIEVED_MESSAGE, shop.getId(), shop.getName());
 		}
@@ -1120,6 +1154,6 @@ private String getQueryParam(final URI uri, final String key) {
 	}
 
 	private WebTarget buildOrdersEndpoint() {
-		return getWebTarget().path(VERSION_2020_01).path(ORDERS);
+		return getWebTarget().path(ORDERS);
 	}
 }

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

@@ -81,7 +81,7 @@ public class ShopifySdkDriver {
 	public void setUp() {
 		shopifySdk = ShopifySdk.newBuilder().withSubdomain(SHOP_SUBDOMAIN).withAccessToken(ACCESS_TOKEN)
 				.withMaximumRequestRetryTimeout(5, TimeUnit.SECONDS)
-				.withMaximumRequestRetryRandomDelay(5, TimeUnit.SECONDS).build();
+				.withMaximumRequestRetryRandomDelay(5, TimeUnit.SECONDS).withApiVersion("2020-07").build();
 	}
 
 	@Test