partial implementation of prospect create, update, upsert

stephen powis · stephen powis · commit b0f18eaa4c5c · 2017-08-14T11:25:57.000+09:00
diff --git a/README.md b/README.md
@@ -109,6 +109,16 @@ Official Documentation: [Emails](http://developer.pardot.com/kb/api-version-3/em
 - Sending One to One Emails
 - Sending List Emails
 
+### Prospects
+Official Documentation: [Emails](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.
+- Delete
+- Query
+
 ### Users
 Official Documentation: [Users](http://developer.pardot.com/kb/api-version-3/users/)
 
diff --git a/src/main/java/com/darksci/pardot/api/PardotClient.java b/src/main/java/com/darksci/pardot/api/PardotClient.java
@@ -2,6 +2,7 @@
 
 import com.darksci.pardot.api.parser.ErrorResponseParser;
 import com.darksci.pardot.api.parser.ResponseParser;
+import com.darksci.pardot.api.parser.StringResponseParser;
 import com.darksci.pardot.api.parser.account.AccountReadResponseParser;
 import com.darksci.pardot.api.parser.campaign.CampaignQueryResponseParser;
 import com.darksci.pardot.api.parser.campaign.CampaignReadResponseParser;
@@ -24,8 +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.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.ProspectUpdateRequest;
+import com.darksci.pardot.api.request.prospect.ProspectUpsertRequest;
 import com.darksci.pardot.api.request.user.UserAbilitiesRequest;
 import com.darksci.pardot.api.request.user.UserQueryRequest;
 import com.darksci.pardot.api.request.user.UserReadRequest;
@@ -100,12 +105,20 @@ private <T> T submitRequest(final Request request, ResponseParser<T> responsePar
 
         // Submit request
         final RestResponse restResponse = getRestClient().submitRequest(request);
+        final int responseCode = restResponse.getHttpCode();
+        String responseStr = restResponse.getResponseStr();
 
         // If we have a valid response
         logger.info("Response: {}", restResponse);
 
         // Check for invalid http status codes
-        if (restResponse.getHttpCode() >= 200 && restResponse.getHttpCode() < 300) {
+        if (responseCode >= 200 && responseCode < 300) {
+            // These response codes have no values
+            if (responseCode == 205 && responseStr == null) {
+                // Avoid NPE
+                responseStr = "";
+            }
+
             // High level check for error response
             if (restResponse.getResponseStr().contains("<rsp stat=\"fail\"")) {
                 try {
@@ -301,6 +314,33 @@ public Prospect prospectRead(final ProspectReadRequest request) {
         return submitRequest(request, new ProspectReadResponseParser());
     }
 
+    /**
+     * Make API request to create a new prospect.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Prospect prospectCreate(final ProspectCreateRequest request) {
+        return submitRequest(request, new ProspectReadResponseParser());
+    }
+
+    /**
+     * Make API request to update an existing prospect.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Prospect prospectUpdate(final ProspectUpdateRequest request) {
+        return submitRequest(request, new ProspectReadResponseParser());
+    }
+
+    /**
+     * Make API request to upsert a prospect.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Prospect prospectUpsert(final ProspectUpsertRequest request) {
+        return submitRequest(request, new ProspectReadResponseParser());
+    }
+
     /**
      * Make API request to query prospects.
      * @param request Request definition.
@@ -309,11 +349,21 @@ public Prospect prospectRead(final ProspectReadRequest request) {
     public ProspectQueryResponse.Result prospectQuery(final ProspectQueryRequest request) {
         return submitRequest(request, new ProspectQueryResponseParser());
     }
+    /**
+     * Make API request to delete prospects.
+     * @param request Request definition.
+     * @return true if success, false if error.
+     */
+    public boolean prospectDelete(final ProspectDeleteRequest request) {
+        submitRequest(request, new StringResponseParser());
+        return true;
+    }
 
     /**
      * Clean up instance, releasing any resources held internally.
      */
     public void close() {
         getRestClient().close();
     }
+
 }
diff --git a/src/main/java/com/darksci/pardot/api/parser/StringResponseParser.java b/src/main/java/com/darksci/pardot/api/parser/StringResponseParser.java
@@ -0,0 +1,17 @@
+package com.darksci.pardot.api.parser;
+
+import java.io.IOException;
+
+/**
+ * Simple pass through parser.
+ */
+public class StringResponseParser implements ResponseParser<String> {
+    @Override
+    public String parseResponse(final String responseStr) throws IOException {
+        // avoid NPE
+        if (responseStr == null) {
+            return "";
+        }
+        return responseStr;
+    }
+}
diff --git a/src/main/java/com/darksci/pardot/api/parser/prospect/ProspectQueryResponseParser.java b/src/main/java/com/darksci/pardot/api/parser/prospect/ProspectQueryResponseParser.java
@@ -2,7 +2,6 @@
 
 import com.darksci.pardot.api.parser.JacksonFactory;
 import com.darksci.pardot.api.parser.ResponseParser;
-import com.darksci.pardot.api.response.campaign.CampaignQueryResponse;
 import com.darksci.pardot.api.response.prospect.ProspectQueryResponse;
 
 import java.io.IOException;
diff --git a/src/main/java/com/darksci/pardot/api/request/BaseRequest.java b/src/main/java/com/darksci/pardot/api/request/BaseRequest.java
@@ -1,7 +1,5 @@
 package com.darksci.pardot.api.request;
 
-import com.darksci.pardot.api.request.email.EmailSendOneToOneRequest;
-
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
diff --git a/src/main/java/com/darksci/pardot/api/request/email/EmailSendOneToOneRequest.java b/src/main/java/com/darksci/pardot/api/request/email/EmailSendOneToOneRequest.java
@@ -3,7 +3,6 @@
 import com.darksci.pardot.api.request.BaseRequest;
 
 import java.util.Collection;
-import java.util.HashSet;
 
 /**
  * For sending 1-to-1 prospect emails via Pardot Api.
diff --git a/src/main/java/com/darksci/pardot/api/request/prospect/ProspectCreateRequest.java b/src/main/java/com/darksci/pardot/api/request/prospect/ProspectCreateRequest.java
@@ -0,0 +1,12 @@
+package com.darksci.pardot.api.request.prospect;
+
+/**
+ * For creating new Prospects using Pardot's API.
+ */
+public class ProspectCreateRequest extends ProspectModifyRequest<ProspectCreateRequest> {
+    @Override
+    public String getApiEndpoint() {
+        return "prospect/do/create";
+    }
+
+}
diff --git a/src/main/java/com/darksci/pardot/api/request/prospect/ProspectDeleteRequest.java b/src/main/java/com/darksci/pardot/api/request/prospect/ProspectDeleteRequest.java
@@ -0,0 +1,33 @@
+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> {
+    @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);
+    }
+}
diff --git a/src/main/java/com/darksci/pardot/api/request/prospect/ProspectModifyRequest.java b/src/main/java/com/darksci/pardot/api/request/prospect/ProspectModifyRequest.java
@@ -0,0 +1,51 @@
+package com.darksci.pardot.api.request.prospect;
+
+import com.darksci.pardot.api.request.BaseRequest;
+import com.darksci.pardot.api.response.prospect.Prospect;
+
+/**
+ * Abstract shared code between Create, Update, and Upsert Prospect operations.
+ */
+abstract class ProspectModifyRequest<T> extends BaseRequest<T> {
+
+    /**
+     * Define the campaign you want to create in pardot.
+     * @param prospect The prospect you want to create in pardot.
+     * @return CampaignCreateRequest builder.
+     */
+    public T withProspect(final Prospect prospect) {
+        setParam("email", prospect.getEmail());
+        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());
+        setParam("country", prospect.getCountry());
+        setParam("address_one", prospect.getAddressOne());
+        setParam("address_two", prospect.getAddressTwo());
+        setParam("city", prospect.getCity());
+        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());
+
+        // TODO add other fields?  How to handle custom fields?
+
+        return (T) this;
+    }
+}
diff --git a/src/main/java/com/darksci/pardot/api/request/prospect/ProspectQueryRequest.java b/src/main/java/com/darksci/pardot/api/request/prospect/ProspectQueryRequest.java
@@ -2,8 +2,6 @@
 
 import com.darksci.pardot.api.request.BaseQueryRequest;
 import com.darksci.pardot.api.request.DateParameter;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.util.Collection;
 import java.util.stream.Collectors;
diff --git a/src/main/java/com/darksci/pardot/api/request/prospect/ProspectUpdateRequest.java b/src/main/java/com/darksci/pardot/api/request/prospect/ProspectUpdateRequest.java
@@ -0,0 +1,12 @@
+package com.darksci.pardot.api.request.prospect;
+
+/**
+ * For updating existing Prospects using Pardot's API.
+ */
+public class ProspectUpdateRequest extends ProspectModifyRequest<ProspectUpdateRequest> {
+
+    @Override
+    public String getApiEndpoint() {
+        return "prospect/do/update";
+    }
+}
diff --git a/src/main/java/com/darksci/pardot/api/request/prospect/ProspectUpsertRequest.java b/src/main/java/com/darksci/pardot/api/request/prospect/ProspectUpsertRequest.java
@@ -0,0 +1,11 @@
+package com.darksci.pardot.api.request.prospect;
+
+/**
+ * For upserting Prospects using Pardot's API.
+ */
+public class ProspectUpsertRequest extends ProspectModifyRequest<ProspectUpsertRequest> {
+    @Override
+    public String getApiEndpoint() {
+        return "prospect/do/upsert";
+    }
+}
diff --git a/src/main/java/com/darksci/pardot/api/response/prospect/Prospect.java b/src/main/java/com/darksci/pardot/api/response/prospect/Prospect.java
@@ -283,6 +283,106 @@ public List<Visitor> getVisitors() {
         return visitors;
     }
 
+    public void setId(final Long id) {
+        this.id = id;
+    }
+
+    public void setCampaignId(final Long campaignId) {
+        this.campaignId = campaignId;
+    }
+
+    public void setSalutation(final String salutation) {
+        this.salutation = salutation;
+    }
+
+    public void setFirstName(final String firstName) {
+        this.firstName = firstName;
+    }
+
+    public void setLastName(final String lastName) {
+        this.lastName = lastName;
+    }
+
+    public void setEmail(final String email) {
+        this.email = email;
+    }
+
+    public void setCompany(final String company) {
+        this.company = company;
+    }
+
+    public void setProspectAccountId(final long prospectAccountId) {
+        this.prospectAccountId = prospectAccountId;
+    }
+
+    public void setWebsite(final String website) {
+        this.website = website;
+    }
+
+    public void setJobTitle(final String jobTitle) {
+        this.jobTitle = jobTitle;
+    }
+
+    public void setDepartment(final String department) {
+        this.department = department;
+    }
+
+    public void setCountry(final String country) {
+        this.country = country;
+    }
+
+    public void setAddressOne(final String addressOne) {
+        this.addressOne = addressOne;
+    }
+
+    public void setAddressTwo(final String addressTwo) {
+        this.addressTwo = addressTwo;
+    }
+
+    public void setCity(final String city) {
+        this.city = city;
+    }
+
+    public void setState(final String state) {
+        this.state = state;
+    }
+
+    public void setTerritory(final String territory) {
+        this.territory = territory;
+    }
+
+    public void setZip(final String zip) {
+        this.zip = zip;
+    }
+
+    public void setPhone(final String phone) {
+        this.phone = phone;
+    }
+
+    public void setFax(final String fax) {
+        this.fax = fax;
+    }
+
+    public void setSource(final String source) {
+        this.source = source;
+    }
+
+    public void setAnnualRevenue(final String annualRevenue) {
+        this.annualRevenue = annualRevenue;
+    }
+
+    public void setEmployees(final String employees) {
+        this.employees = employees;
+    }
+
+    public void setIndustry(final String industry) {
+        this.industry = industry;
+    }
+
+    public void setYearsInBusiness(final String yearsInBusiness) {
+        this.yearsInBusiness = yearsInBusiness;
+    }
+
     @Override
     public String toString() {
         return "Prospect{"
diff --git a/src/main/java/com/darksci/pardot/api/response/prospect/ProspectQueryResponse.java b/src/main/java/com/darksci/pardot/api/response/prospect/ProspectQueryResponse.java
diff --git a/src/test/java/com/darksci/pardot/api/PardotClientTest.java b/src/test/java/com/darksci/pardot/api/PardotClientTest.java
diff --git a/src/test/java/com/darksci/pardot/api/parser/prospect/ProspectQueryResponseParserTest.java b/src/test/java/com/darksci/pardot/api/parser/prospect/ProspectQueryResponseParserTest.java
