implement assign, unassign. also fix some parsing bugs

Author: stephen powis

README.md

@@ -96,35 +96,37 @@ Official Documentation: [Accounts](http://developer.pardot.com/kb/api-version-3/
 ### Campaigns
 Official Documentation: [Campaigns](http://developer.pardot.com/kb/api-version-3/campaigns/)
 
+- Create
 - Query
 - Read
-- Create
 - Update
 
 ### Emails
 Official Documentation: [Emails](http://developer.pardot.com/kb/api-version-3/emails/)
 
 - Read
-- Stats
-- Sending One to One Emails
 - Sending List Emails
+- Sending One to One Emails
+- Stats
 
 ### Prospects
 Official Documentation: [Prospects](http://developer.pardot.com/kb/api-version-3/prospects/)
 
-- Read
-- Create - Partial implementation, can only set default fields.
-- Update - Partial implementation, can only set default fields.
-- Upsert - Partial implementation, can only set default fields.
+- Assign
+- Create - Does not support multiple values for record-multiple fields.
 - Delete
 - Query
+- Read
+- Unassign
+- Update - Does not support multiple values for record-multiple fields.
+- Upsert - Does not support multiple values for record-multiple fields.
 
 ### Users
 Official Documentation: [Users](http://developer.pardot.com/kb/api-version-3/users/)
 
+- Abilities of current API User
 - Query
 - Read
-- Abilities of API User
 
 ## How to Contribute 
 

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

@@ -25,10 +25,12 @@
 import com.darksci.pardot.api.request.email.EmailSendOneToOneRequest;
 import com.darksci.pardot.api.request.email.EmailStatsRequest;
 import com.darksci.pardot.api.request.login.LoginRequest;
+import com.darksci.pardot.api.request.prospect.ProspectAssignRequest;
 import com.darksci.pardot.api.request.prospect.ProspectCreateRequest;
 import com.darksci.pardot.api.request.prospect.ProspectDeleteRequest;
 import com.darksci.pardot.api.request.prospect.ProspectQueryRequest;
 import com.darksci.pardot.api.request.prospect.ProspectReadRequest;
+import com.darksci.pardot.api.request.prospect.ProspectUnassignRequest;
 import com.darksci.pardot.api.request.prospect.ProspectUpdateRequest;
 import com.darksci.pardot.api.request.prospect.ProspectUpsertRequest;
 import com.darksci.pardot.api.request.user.UserAbilitiesRequest;
@@ -360,6 +362,24 @@ public boolean prospectDelete(final ProspectDeleteRequest request) {
         return true;
     }
 
+    /**
+     * Make API request to assign a prospect.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Prospect prospectAssign(final ProspectAssignRequest request) {
+        return submitRequest(request, new ProspectReadResponseParser());
+    }
+
+    /**
+     * Make API request to unassign a prospect.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Prospect prospectUnassign(final ProspectUnassignRequest request) {
+        return submitRequest(request, new ProspectReadResponseParser());
+    }
+
     /**
      * Clean up instance, releasing any resources held internally.
      */

src/main/java/com/darksci/pardot/api/parser/PardotBooleanSerializer.java

@@ -0,0 +1,37 @@
+package com.darksci.pardot.api.parser;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+
+import java.io.IOException;
+
+/**
+ * Converts values to boolean.
+ *
+ * False values: NULL, emptyString, NO, FALSE, 0
+ * True values: all others.
+ */
+public class PardotBooleanSerializer extends JsonDeserializer<Boolean> {
+    @Override
+    public Boolean deserialize(final JsonParser jsonParser, final DeserializationContext ctxt) throws IOException {
+        final String value = jsonParser.getText();
+
+        // Null => false
+        // Empty string => false
+        if (value == null || value.isEmpty()) {
+            return false;
+        }
+
+        // Make all lower case
+        final String normalizedValue = value.toLowerCase();
+
+        // No, false, and 0 => false
+        if (normalizedValue.equals("no") || normalizedValue.equals("false") || normalizedValue.equals("0")) {
+            return false;
+        }
+
+        // All others defaulted to true
+        return true;
+    }
+}

src/main/java/com/darksci/pardot/api/request/prospect/ProspectActionRequest.java

@@ -0,0 +1,30 @@
+package com.darksci.pardot.api.request.prospect;
+
+import com.darksci.pardot.api.request.BaseRequest;
+
+/**
+ * Represents a request to perform an action against a specific prospect, either by
+ * Id or Email address.
+ */
+abstract class ProspectActionRequest<T> extends BaseRequest<T> {
+
+    /**
+     * Define which prospect to perform action on by Id.
+     * @param prospectId Id of prospect to delete.
+     * @return RequestBuilder
+     */
+    public T withProspectId(final Long prospectId) {
+        setParam("email", null);
+        return setParam("id", prospectId);
+    }
+
+    /**
+     * Define which prospect to perform action on by email.
+     * @param email Email of prospect to delete.
+     * @return RequestBuilder
+     */
+    public T withProspectEmail(final String email) {
+        setParam("id", null);
+        return setParam("email", email);
+    }
+}

src/main/java/com/darksci/pardot/api/request/prospect/ProspectAssignRequest.java

@@ -0,0 +1,44 @@
+package com.darksci.pardot.api.request.prospect;
+
+/**
+ * Request for assigning a Prospect to a user.
+ */
+public class ProspectAssignRequest extends ProspectActionRequest<ProspectAssignRequest> {
+    @Override
+    public String getApiEndpoint() {
+        return "prospect/do/assign";
+    }
+
+    /**
+     * Assign prospect to the specified User's email address.
+     * @param email Email address of user.
+     * @return RequestBuilder
+     */
+    public ProspectAssignRequest withUserEmail(final String email) {
+        setParam("user_id", null);
+        setParam("group_id", null);
+        return setParam("user_email", email);
+    }
+
+    /**
+     * Assign prospect to the specified User by userId.
+     * @param userId Id of user.
+     * @return RequestBuilder
+     */
+    public ProspectAssignRequest withUserId(final Long userId) {
+        setParam("user_id", userId);
+        setParam("group_id", null);
+        return setParam("user_email", null);
+    }
+
+    /**
+     * Assign prospect to the specified Group by the group's Id.
+     * @param groupId Id of the Group.
+     * @return RequestBuilder
+     */
+    public ProspectAssignRequest withGroupId(final Long groupId) {
+        setParam("user_id", null);
+        setParam("group_id", groupId);
+        return setParam("user_email", null);
+    }
+}

src/main/java/com/darksci/pardot/api/request/prospect/ProspectDeleteRequest.java

@@ -1,33 +1,11 @@
 package com.darksci.pardot.api.request.prospect;
 
-import com.darksci.pardot.api.request.BaseRequest;
-
 /**
  * For deleting Prospects using Pardot's API.
  */
-public class ProspectDeleteRequest extends BaseRequest<ProspectDeleteRequest> {
+public class ProspectDeleteRequest extends ProspectActionRequest<ProspectDeleteRequest> {
     @Override
     public String getApiEndpoint() {
         return "prospect/do/delete";
     }
-
-    /**
-     * Define which prospect to delete by Id.
-     * @param prospectId Id of prospect to delete.
-     * @return RequestBuilder
-     */
-    public ProspectDeleteRequest withProspectId(final Long prospectId) {
-        setParam("email", null);
-        return setParam("id", prospectId);
-    }
-
-    /**
-     * Define which prospect to delete by email.
-     * @param email Email of prospect to delete.
-     * @return RequestBuilder
-     */
-    public ProspectDeleteRequest withProspectEmail(final String email) {
-        setParam("id", null);
-        return setParam("email", email);
-    }
 }

src/main/java/com/darksci/pardot/api/request/prospect/ProspectModifyRequest.java

@@ -3,6 +3,8 @@
 import com.darksci.pardot.api.request.BaseRequest;
 import com.darksci.pardot.api.response.prospect.Prospect;
 
+import java.util.Map;
+
 /**
  * Abstract shared code between Create, Update, and Upsert Prospect operations.
  */
@@ -14,16 +16,17 @@ abstract class ProspectModifyRequest<T> extends BaseRequest<T> {
      * @return CampaignCreateRequest builder.
      */
     public T withProspect(final Prospect prospect) {
+        // Identifying fields
+        setParam("id", prospect.getId());
         setParam("email", prospect.getEmail());
+
+        // Default fields
         setParam("first_name", prospect.getFirstName());
         setParam("last_name", prospect.getLastName());
-
-        setParam("id", prospect.getId());
         setParam("campaign_id", prospect.getCampaignId());
         setParam("salutation", prospect.getSalutation());
         setParam("company", prospect.getCompany());
         setParam("prospect_account_d", prospect.getProspectAccountId());
-
         setParam("website", prospect.getWebsite());
         setParam("job_title", prospect.getJobTitle());
         setParam("department", prospect.getDepartment());
@@ -34,18 +37,91 @@ public T withProspect(final Prospect prospect) {
         setParam("state", prospect.getState());
         setParam("territory", prospect.getTerritory());
         setParam("zip", prospect.getZip());
-
         setParam("phone", prospect.getPhone());
         setParam("fax", prospect.getFax());
-
         setParam("source", prospect.getSource());
         setParam("annual_revenue", prospect.getAnnualRevenue());
         setParam("employees", prospect.getEmployees());
         setParam("industry", prospect.getIndustry());
         setParam("years_in_business", prospect.getYearsInBusiness());
 
+        // Loop through and set custom fields
+        if (prospect.getCustomFields() != null) {
+            for (Map.Entry<String, String> entry: prospect.getCustomFields().entrySet()) {
+                setParam(entry.getKey(), entry.getValue());
+            }
+        }
+
         // TODO add other fields?  How to handle custom fields?
 
         return (T) this;
     }
+
+    /**
+     * Explicitly clear the value of a field.
+     *
+     * You can get the same behavior by setting the field on a Prospect to empty string ""
+     * or by calling setFieldValue(fieldName, "")
+     *
+     * @param fieldName The field to clear.
+     * @return RequestBuilder
+     */
+    public T withFieldValueCleared(final String fieldName) {
+        return setParam(fieldName, "");
+    }
+
+    /**
+     * Explicity set the value of a field.
+     * @param fieldName The field to set
+     * @param value The value to set.
+     * @return RequestBuilder
+     */
+    public T withFieldValue(final String fieldName, final Object value) {
+        return setParam(fieldName, value);
+    }
+
+    /**
+     * Subscribe prospect to specified list.
+     * @param listId List to subscribe prospect to.
+     * @return RequestBuilder
+     */
+    public T withSubscribeToList(final Long listId) {
+        return setParam("list_" + String.valueOf(listId), "1");
+    }
+
+    /**
+     * Subscribe prospect to specified list.
+     * @param listId List to subscribe prospect to.
+     * @return RequestBuilder
+     */
+    public T withUnsubscribeFromList(final Long listId) {
+        return setParam("list_" + String.valueOf(listId), "0");
+    }
+
+    /**
+     * Set a prospect's profile criteria as matching.
+     * @param profileCriteriaId Id of the profile criteria to mark as matching.
+     * @return RequestBuilder
+     */
+    public T withProfileCriteriaMatching(final Long profileCriteriaId) {
+        return setParam("profile_criteria_" + String.valueOf(profileCriteriaId), "match");
+    }
+
+    /**
+     * Set a prospect's profile criteria as not matching.
+     * @param profileCriteriaId Id of the profile criteria to mark as not matching.
+     * @return RequestBuilder
+     */
+    public T withProfileCriteriaNotMatching(final Long profileCriteriaId) {
+        return setParam("profile_criteria_" + String.valueOf(profileCriteriaId), "nomatch");
+    }
+
+    /**
+     * Set a prospect's profile criteria as unknown.
+     * @param profileCriteriaId Id of the profile criteria to mark as unknown.
+     * @return RequestBuilder
+     */
+    public T withProfileCriteriaUnknown(final Long profileCriteriaId) {
+        return setParam("profile_criteria_" + String.valueOf(profileCriteriaId), "unknown");
+    }
 }

src/main/java/com/darksci/pardot/api/request/prospect/ProspectUnassignRequest.java

@@ -0,0 +1,12 @@
+package com.darksci.pardot.api.request.prospect;
+
+/**
+ * Request for unassigning a Prospect to a user.
+ */
+public class ProspectUnassignRequest extends ProspectActionRequest<ProspectUnassignRequest> {
+
+    @Override
+    public String getApiEndpoint() {
+        return "prospect/do/unassign";
+    }
+}