implement validations and exceptions

pom.xml

@@ -42,6 +42,12 @@
       <version>4.11</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>2.8.8</version>
+      <scope>compile</scope>
+    </dependency>
   </dependencies>
 
   <build>

src/main/java/com/shipengine/Config.java

@@ -1,26 +1,64 @@
 package com.shipengine;
 
+import java.util.HashMap;
+
 public class Config {
+    private String apiKey;
+    private String baseUrl = "https://api.shipengine.com/";
+    private int pageSize = 5000;
+    private int retries = 1;
+    private int timeout = 50;
+
+    public Config(String apiKey) {
+        setApiKey(apiKey);
+    }
+
+    public Config(String apiKey, int timeout, int retries, int pageSize) {
+        setApiKey(apiKey);
+        setTimeout(timeout);
+        setRetries(retries);
+        setPageSize(pageSize);
+    }
+
+    /*
+     * The URL of the ShipEngine API. You can usually leave this unset and it will
+     * default to our public API.
+     */
+    public String getBaseUrl() {
+        return baseUrl;
+    }
+
     /*
      * Your ShipEngine API key. This can be a production or sandbox key. Sandbox
      * keys start with "TEST_".
      */
-    String apiKey;
+    public String getApiKey() {
+        return apiKey;
+    }
 
     /*
-     * The URL of the ShipEngine API. You can usually leave this unset and it will
-     * default to our public API.
+     * Set the ShipEngine API key.
      */
-    String baseUrl = "https://api.shipengine.com/";
+    public void setApiKey(String apiKey) {
+        this.apiKey = apiKey;
+    }
 
     /*
-     * Some ShipEngine API endpoints return paged data. This lets you control the
-     * number of items returned per request. Larger numbers will use more memory but
-     * will require fewer HTTP requests.
+     * The maximum amount of time (in milliseconds) to wait for a response from the
+     * ShipEngine server.
      *
-     * Defaults to 50.
+     * Defaults to 5000 (5 seconds).
      */
-    int pageSize;
+    public int getTimeout() {
+        return timeout;
+    }
+
+    /*
+     * Set the timeout (in milliseconds).
+     */
+    public void setTimeout(int timeout) {
+        this.timeout = timeout;
+    }
 
     /*
      * If the ShipEngine client receives a rate limit error it can automatically
@@ -30,40 +68,49 @@ public class Config {
      * Defaults to 1, which means up to 2 attempts will be made (the original
      * attempt, plus one retry).
      */
-    int retries;
+    public int getRetries() {
+        return retries;
+    }
 
     /*
-     * The maximum amount of time (in milliseconds) to wait for a response from the
-     * ShipEngine server.
-     *
-     * Defaults to 5000 (5 seconds).
+     * Set the retries.
      */
-    int timeout;
-
-    public Config(String apiKey) {
-        this.apiKey = apiKey;
-        this.timeout = 5000;
-        this.retries = 1;
-        this.pageSize = 50;
+    public void setRetries(int retries) {
+        this.retries = retries;
     }
 
-    public String getBaseUrl() {
-        return baseUrl;
+    /*
+     * Some ShipEngine API endpoints return paged data. This lets you control the
+     * number of items returned per request. Larger numbers will use more memory but
+     * will require fewer HTTP requests.
+     *
+     * Defaults to 50.
+     */
+    public int getPageSize() {
+        return pageSize;
     }
 
-    public String getApiKey() {
-        return apiKey;
+    /*
+     * Set the page size.
+     */
+    public void setPageSize(int pageSize) {
+        this.pageSize = pageSize;
     }
 
-    public int getTimeout() {
-        return timeout;
+    public Config merge() {
+        return this;
     }
 
-    public int getRetries() {
-        return retries;
+    public Config merge(String apiKey) {
+        return new Config(apiKey);
     }
 
-    public int getPageSize() {
-        return pageSize;
+    public Config merge(String apiKey, int timeout, int retries, int pageSize) {
+        return new Config(
+                apiKey,
+                timeout,
+                retries,
+                pageSize
+        );
     }
 }

src/main/java/com/shipengine/InternalClient.java

@@ -0,0 +1,15 @@
+package com.shipengine;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class InternalClient {
+    public HashMap requestLoop(
+            String httpMethod,
+            String endpoint,
+            String body,
+            Config config
+    ) {
+        return new HashMap();
+    }
+}

src/main/java/com/shipengine/ShipEngine.java

@@ -1,12 +1,16 @@
 package com.shipengine;
 
 public class ShipEngine {
-    Config config;
+    private Config config;
 
     public ShipEngine(String apiKey) {
         this.config = new Config(apiKey);
     }
 
+    public ShipEngine(String apiKey, int timeout, int retries, int pageSize) {
+        this.config = new Config(apiKey, timeout, retries, pageSize);
+    }
+
     public Config getConfig() {
         return config;
     }

src/main/java/com/shipengine/exception/ClientTimeoutError.java

@@ -0,0 +1,24 @@
+package com.shipengine.exception;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+public class ClientTimeoutError extends ShipEngineException {
+
+    int retryAfter;
+
+    ErrorSource source;
+
+    String requestID;
+
+    public ClientTimeoutError(String requestID, ErrorSource source, int retryAfter) throws MalformedURLException {
+        super(
+                String.format("The request took longer than the %s seconds allowed.", retryAfter),
+                requestID,
+                source,
+                ErrorType.SYSTEM,
+                ErrorCode.TIMEOUT,
+                new URL("https://www.shipengine.com/docs/rate-limits")
+        );
+    }
+}

src/main/java/com/shipengine/exception/FieldValueRequiredException.java

@@ -0,0 +1,18 @@
+package com.shipengine.exception;
+
+/**
+ * This error occurs when a required field has not been set. This includes fields
+ * that are conditionally required.
+ */
+public class FieldValueRequiredException extends RuntimeException {
+    /**
+     * The name of the invalid field.
+     */
+    String fieldName;
+
+    public FieldValueRequiredException(
+            String fieldName
+    ) {
+        super(String.format("%s is a required field.", fieldName));
+    }
+}

src/main/java/com/shipengine/exception/InvalidFieldValueException.java

@@ -0,0 +1,51 @@
+package com.shipengine.exception;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+/**
+ * This error occurs when a field has been set to an invalid value.
+ */
+public class InvalidFieldValueException extends ShipEngineException {
+    /**
+     * The name of the invalid field.
+     */
+    String fieldName;
+
+    /**
+     * The value of the invalid field.
+     */
+    String fieldValue;
+
+    public String getFieldName() {
+        return fieldName;
+    }
+
+    public void setFieldName(String fieldName) {
+        this.fieldName = fieldName;
+    }
+
+    public String getFieldValue() {
+        return fieldValue;
+    }
+
+    public void setFieldValue(String fieldValue) {
+        this.fieldValue = fieldValue;
+    }
+
+    public InvalidFieldValueException(
+            String fieldName,
+            String fieldValue
+    ) throws MalformedURLException {
+        super(
+                String.format("%s - %s was provided.", fieldName, fieldValue),
+                "",
+                ErrorSource.SHIPENGINE,
+                ErrorType.VALIDATION,
+                ErrorCode.INVALID_FIELD_VALUE,
+                new URL("https://www.shipengine.com/docs/")
+        );
+        this.setFieldName(fieldName);
+        this.setFieldValue(fieldValue);
+    }
+}

src/main/java/com/shipengine/exception/RateLimitExceededException.java

@@ -0,0 +1,37 @@
+package com.shipengine.exception;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+/**
+ * This error occurs when a request to ShipEngine API is blocked due to the rate
+ * limit being exceeded.
+ */
+public class RateLimitExceededException extends ShipEngineException {
+    /**
+     * The amount of time (in milliseconds) to wait before retrying the request.
+     */
+    private int retryAfter;
+
+    public int getRetryAfter() {
+        return retryAfter;
+    }
+
+    public void setRetryAfter(int retryAfter) {
+        this.retryAfter = retryAfter;
+    }
+
+    public RateLimitExceededException(
+            String requestID, ErrorSource source, int retryAfter
+    ) throws MalformedURLException {
+        super(
+                "You have exceeded the rate limit.",
+                requestID,
+                source,
+                ErrorType.SYSTEM,
+                ErrorCode.RATE_LIMIT_EXCEEDED,
+                new URL("https://www.shipengine.com/docs/rate-limits")
+        );
+        this.setRetryAfter(retryAfter);
+    }
+}