Add support for API app CRUD. Add tests. Update documentation.

Author: Chris Paul

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2014 hellosign.com
+Copyright (C) 2015 hellosign.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -105,7 +105,7 @@ https://www.github.com/cmpaul/jellosign -->
 ```
 The MIT License (MIT)
 
-Copyright (C) 2014 hellosign.com
+Copyright (C) 2015 hellosign.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

pom.xml

@@ -6,7 +6,7 @@
   <groupId>com.hellosign</groupId>
   <artifactId>hellosign-java-sdk</artifactId>
   <packaging>jar</packaging>
-  <version>3.1.8</version>
+  <version>3.2.0</version>
   <name>HelloSign Java SDK</name>
   <url>https://github.com/HelloFax/hellosign-java-sdk</url>
   <properties>

src/main/java/com/hellosign/sdk/HelloSignClient.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -45,11 +45,14 @@
 import org.json.JSONObject;
 
 import com.hellosign.sdk.http.Authentication;
+import com.hellosign.sdk.http.HttpDeleteRequest;
 import com.hellosign.sdk.http.HttpGetRequest;
 import com.hellosign.sdk.http.HttpPostRequest;
+import com.hellosign.sdk.http.HttpPutRequest;
 import com.hellosign.sdk.resource.AbstractRequest;
 import com.hellosign.sdk.resource.AbstractResourceList;
 import com.hellosign.sdk.resource.Account;
+import com.hellosign.sdk.resource.ApiApp;
 import com.hellosign.sdk.resource.EmbeddedRequest;
 import com.hellosign.sdk.resource.EmbeddedResponse;
 import com.hellosign.sdk.resource.SignatureRequest;
@@ -58,6 +61,7 @@
 import com.hellosign.sdk.resource.TemplateDraft;
 import com.hellosign.sdk.resource.TemplateSignatureRequest;
 import com.hellosign.sdk.resource.UnclaimedDraft;
+import com.hellosign.sdk.resource.support.ApiAppList;
 import com.hellosign.sdk.resource.support.OauthData;
 import com.hellosign.sdk.resource.support.SignatureRequestList;
 import com.hellosign.sdk.resource.support.TemplateList;
@@ -127,6 +131,8 @@ public class HelloSignClient {
     private String URL_UNCLAIMED_DRAFT_CREATE;
     private String URL_UNCLAIMED_DRAFT_CREATE_EMBEDDED;
     private String URL_UNCLAIMED_DRAFT_CREATE_EMBEDDED_WITH_TEMPLATE;
+    private String URL_API_APP;
+    private String URL_API_APP_LIST;
 
     private String URL_PARAM_FILE_TYPE = "file_type";
 
@@ -197,6 +203,8 @@ private void initApiEndpoints() {
         URL_UNCLAIMED_DRAFT_CREATE = URL_API + "/unclaimed_draft/create";
         URL_UNCLAIMED_DRAFT_CREATE_EMBEDDED = URL_API + "/unclaimed_draft/create_embedded";
         URL_UNCLAIMED_DRAFT_CREATE_EMBEDDED_WITH_TEMPLATE = URL_API + "/unclaimed_draft/create_embedded_with_template";
+        URL_API_APP = URL_API + "/api_app";
+        URL_API_APP_LIST = URL_API_APP + "/list";
     }
 
     /**
@@ -858,6 +866,63 @@ public TemplateDraft createEmbeddedTemplateDraft(EmbeddedRequest req)
         }
     }
 
+    /**
+     * Retrieves the API app configuration for the given Client ID.
+     * @param clientId String
+     * @return ApiApp
+     * @throws HelloSignException
+     */
+    public ApiApp getApiApp(String clientId) throws HelloSignException {
+        HttpGetRequest request = new HttpGetRequest(URL_API_APP + "/" + clientId, auth);
+        return new ApiApp(request.getJsonResponse());
+    }
+
+    /**
+     * Retrieves a paged list of API apps for the authenticated account.
+     * @return ApiAppList
+     * @throws HelloSignException
+     */
+    public ApiAppList getApiApps() throws HelloSignException {
+        HttpGetRequest request = new HttpGetRequest(URL_API_APP_LIST, auth);
+        return new ApiAppList(request.getJsonResponse());
+    }
+
+    /**
+     * Creates a new ApiApp using the properties set on the provided ApiApp.
+     * @param app ApiApp
+     * @return ApiApp newly created ApiApp
+     * @throws HelloSignException
+     */
+    public ApiApp createApiApp(ApiApp app) throws HelloSignException {
+        HttpPostRequest request = new HttpPostRequest(URL_API_APP, app.getPostFields(), auth);
+        return new ApiApp(request.getJsonResponse());
+    }
+
+    /**
+     * Attempts to delete the API app with the given client ID.
+     * @param clientId String The Client ID of the app that should be deleted.
+     * @return boolean true if the API app was successfully deleted
+     * @throws HelloSignException
+     */
+    public boolean deleteApiApp(String clientId) throws HelloSignException {
+        HttpDeleteRequest request = new HttpDeleteRequest(URL_API_APP + "/" + clientId, auth);
+        return HttpURLConnection.HTTP_NO_CONTENT == request.getHttpResponseCode();
+    }
+
+    /**
+     * Updates the API app with the given ApiApp object properties.
+     * @param app ApiApp
+     * @return ApiApp updated ApiApp
+     * @throws HelloSignException
+     */
+    public ApiApp updateApiApp(ApiApp app) throws HelloSignException {
+        if (!app.hasClientId()) {
+            throw new HelloSignException("Cannot update an ApiApp without a client ID. Create one first!");
+        }
+        HttpPutRequest request = new HttpPutRequest(URL_API_APP, app.getPostFields(), auth);
+        return new ApiApp(request.getJsonResponse());
+    }
+
     /**
      * Performs a simple call to the HelloSign API to see if it's available
      * with the given credentials.

src/main/java/com/hellosign/sdk/HelloSignException.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

src/main/java/com/hellosign/sdk/http/AbstractHttpRequest.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

src/main/java/com/hellosign/sdk/http/Authentication.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

src/main/java/com/hellosign/sdk/http/HttpGetRequest.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -157,6 +157,7 @@ private static HttpURLConnection get(String url,
         logger.debug("GET: " + url);
         HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
         connection.setRequestProperty("Accept-Charset", DEFAULT_ENCODING);
+        connection.setRequestProperty("user-agent", USER_AGENT);
         if (auth != null) {
             logger.debug("Authenticating...");
             auth.authenticate(connection, url);

src/main/java/com/hellosign/sdk/http/HttpPostRequest.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -57,6 +57,8 @@ public class HttpPostRequest extends AbstractHttpRequest {
     private final String boundary;
     private static final String LINE_FEED = "\r\n";
 
+    protected String method = "POST";
+
     private HttpURLConnection httpConn;
     private OutputStream outputStream;
     private PrintWriter writer;
@@ -106,7 +108,7 @@ public JSONObject getJsonResponse() throws HelloSignException {
         try {
             int httpCode = connection.getResponseCode();
             InputStream response = null;
-            if (httpCode == HttpURLConnection.HTTP_OK) {
+            if (httpCode >= 200 && httpCode < 300) {
                 logger.debug("OK!");
                 response = connection.getInputStream();
             } else {
@@ -123,6 +125,8 @@ public JSONObject getJsonResponse() throws HelloSignException {
                 validate(json, httpCode);
                 logger.debug("JSON Response: " + json.toString(2));
             }
+        } catch (HelloSignException e) {
+            throw e;
         } catch (Exception e) {
             throw new HelloSignException(e);
         }
@@ -156,14 +160,18 @@ private HttpURLConnection post() throws HelloSignException {
     }
 
     private HttpURLConnection postQuery() throws HelloSignException {
-        logger.debug("POST: " + url);
+        logger.debug(this.method + ": " + url);
         HttpURLConnection connection;
         try {
             connection = (HttpURLConnection) new URL(url).openConnection();
+            if (!this.method.equals("POST")) {
+                connection.setRequestMethod(method);
+            }
         } catch (Exception e) {
             throw new HelloSignException(e);
         }
         connection.setDoOutput(true); // sets POST method
+
         connection.setRequestProperty("user-agent", USER_AGENT);
         connection.setRequestProperty("accept-encoding", DEFAULT_ENCODING);
         auth.authenticate(connection, url);

src/main/java/com/hellosign/sdk/resource/AbstractRequest.java

@@ -3,7 +3,7 @@
 /**
  * The MIT License (MIT)
  * 
- * Copyright (C) 2014 hellosign.com
+ * Copyright (C) 2015 hellosign.com
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal