update readme, add example code

Author: stephen powis

README.md

@@ -15,7 +15,70 @@ requesting it.
 
 ## How to use this library
 
-More information soon.
+This client library is released on Maven Central.  Add a new dependency to your project's POM file:
+
+```xml
+<dependency>
+    <groupId>com.darksci</groupId>
+    <artifactId>pardot-api-client</artifactId>
+    <version>0.1.0-SNAPSHOT</version>
+</dependency>
+```
+
+Example Code:
+```java
+/*
+ * Create a new configuration object with your Pardot credentials.
+ *
+ * This configuration also allows you to define some optional details on your connection,
+ * such as using an outbound proxy (authenticated or not).
+ */
+final Configuration configuration = new Configuration("YourPardotUserNameHere", "PardotPassword", "UserKey");
+
+/*
+ * Create an instance of PardotClient, passing your configuration.
+ */
+final PardotClient client = new PardotClient(configuration);
+
+/*
+ * The client will automatically authenticate when you make your first request, no need to
+ * explicitly login.
+ *
+ * Lets create a simple Account request, and execute it.
+ */
+final AccountReadRequest accountReadRequest = new AccountReadRequest();
+final Account account = client.accountRead(accountReadRequest);
+
+
+/*
+ * Or lets do a more complex Campaign search.
+ */
+final CampaignQueryRequest campaignQueryRequest = new CampaignQueryRequest()
+    .withUpdatedAfter(DateParameter.last7Days())
+    .withIdLessThan(1234L)
+    .withSortById()
+    .withSortOrderDescending();
+final CampaignQueryResponse.Result campaignQueryResponse = client.campaignQuery(campaignQueryRequest);
+
+/*
+ * And when you're done, call close on PardotClient.
+ */
+client.close();
+```
+
+Or Using the Try-With-Resources Pattern:
+```java
+/*
+ * Since PardotClient implements Autoclosable, you can also use the try-with-resources pattern.
+ */
+final Configuration configuration = new Configuration("YourPardotUserNameHere", "PardotPassword", "UserKey");
+try (final PardotClient client = new PardotClient(configuration)) {
+    // Use client instance as needed
+    client.accountRead(new AccountReadRequest());
+
+    // client.close() is automatically called at the end of the try {} block.
+}
+```
 
 ## What Features are implemented?
 

src/main/java/com/darksci/pardot/api/Example.java

@@ -0,0 +1,74 @@
+package com.darksci.pardot.api;
+
+import com.darksci.pardot.api.request.DateParameter;
+import com.darksci.pardot.api.request.account.AccountReadRequest;
+import com.darksci.pardot.api.request.campaign.CampaignQueryRequest;
+import com.darksci.pardot.api.response.account.Account;
+import com.darksci.pardot.api.response.campaign.CampaignQueryResponse;
+
+import java.io.IOException;
+
+/**
+ * Just a simple example code showing basic usage.
+ */
+public class Example {
+
+    /**
+     * Example code.
+     */
+    public static void example() throws IOException {
+        /*
+         * Create a new configuration object with your Pardot credentials.
+         *
+         * This configuration also allows you to define some optional details on your connection,
+         * such as using an outbound proxy (authenticated or not).
+         */
+        final Configuration configuration = new Configuration("YourPardotUserNameHere", "PardotPassword", "UserKey");
+
+        /*
+         * Create an instance of PardotClient, passing your configuration.
+         */
+        final PardotClient client = new PardotClient(configuration);
+
+        /*
+         * The client will automatically authenticate when you make your first request, no need to
+         * explicitly login.
+         *
+         * Lets create a simple Account request, and execute it.
+         */
+        final AccountReadRequest accountReadRequest = new AccountReadRequest();
+        final Account account = client.accountRead(accountReadRequest);
+
+
+        /*
+         * Or lets do a more complex Campaign search.
+         */
+        final CampaignQueryRequest campaignQueryRequest = new CampaignQueryRequest()
+            .withUpdatedAfter(DateParameter.last7Days())
+            .withIdLessThan(1234L)
+            .withSortById()
+            .withSortOrderDescending();
+        final CampaignQueryResponse.Result campaignQueryResponse = client.campaignQuery(campaignQueryRequest);
+
+        /*
+         * And when you're done, call close on PardotClient.
+         */
+        client.close();
+    }
+
+    /**
+     * Example code showing off Auto-closable.
+     */
+    public static void autoCloseableExample() throws IOException {
+        /*
+         * Since PardotClient implements Autoclosable, you can also use the try-with-resources pattern.
+         */
+        final Configuration configuration = new Configuration("YourPardotUserNameHere", "PardotPassword", "UserKey");
+        try (final PardotClient client = new PardotClient(configuration)) {
+            // Use client instance as needed
+            client.accountRead(new AccountReadRequest());
+
+            // client.close() is automatically called at the end of the try {} block.
+        }
+    }
+}

src/main/java/com/darksci/pardot/api/PardotClient.java

@@ -46,7 +46,7 @@
 /**
  * Interface for Pardot's API.
  */
-public class PardotClient {
+public class PardotClient implements AutoCloseable {
     private static final Logger logger = LoggerFactory.getLogger(PardotClient.class);
 
     /**
@@ -288,4 +288,11 @@ public Email emailSendOneToOne(final EmailSendOneToOneRequest request) throws IO
     public Email emailSendList(final EmailSendListRequest request) throws IOException {
         return submitRequest(request, new EmailReadResponseParser());
     }
+
+    /**
+     * Clean up instance, releasing any resources held internally.
+     */
+    public void close() {
+        getRestClient().close();
+    }
 }

src/main/java/com/darksci/pardot/api/request/BaseQueryRequest.java

@@ -13,7 +13,7 @@ public abstract class BaseQueryRequest<T> extends BaseRequest<T> {
      * @param idGreaterThan Id constraint.
      * @return BaseQueryRequest
      */
-    public T withIdGreaterThan(final Integer idGreaterThan) {
+    public T withIdGreaterThan(final Long idGreaterThan) {
         return setParam("id_greater_than", idGreaterThan);
     }
 
@@ -22,7 +22,7 @@ public T withIdGreaterThan(final Integer idGreaterThan) {
      * @param idLessThan Id constraint.
      * @return BaseQueryRequest
      */
-    public T withIdLessThan(final Integer idLessThan) {
+    public T withIdLessThan(final Long idLessThan) {
         return setParam("id_less_than", idLessThan);
     }
 

src/main/java/com/darksci/pardot/api/rest/HttpClientRestClient.java

@@ -138,6 +138,18 @@ public RestResponse submitRequest(final Request request) throws IOException {
         return submitRequest(request, new RestResponseHandler());
     }
 
+    @Override
+    public void close() {
+        if (httpClient != null) {
+            try {
+                httpClient.close();
+            } catch (IOException e) {
+                logger.error("Error closing: {}", e.getMessage(), e);
+            }
+        }
+        httpClient = null;
+    }
+
     /**
      * For issuing an API Request.
      * @param request The Request to perform.

src/main/java/com/darksci/pardot/api/rest/MockRestClient.java

@@ -15,11 +15,17 @@ public class MockRestClient implements RestClient {
 
     @Override
     public void init(final Configuration configuration) {
-
+        // Noop.
     }
 
     @Override
     public RestResponse submitRequest(final Request request) throws IOException {
+        // Not implemented yet.
         return null;
     }
+
+    @Override
+    public void close() {
+        // Noop.
+    }
 }

src/main/java/com/darksci/pardot/api/rest/RestClient.java

@@ -23,4 +23,10 @@ public interface RestClient {
      * @throws IOException if something goes wrong?
      */
     RestResponse submitRequest(final Request request) throws IOException;
+
+    /**
+     * Called to release any internally held resources.
+     */
+    void close();
+
 }