Visitor + Visitor Activity API requests (#3)

Author: Crim

CHANGELOG.md

@@ -2,6 +2,11 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.0 (12/15/17)
+- Add support for Visitor and VisitorActivity API endpoints.
+- Bugfix to Prospect parser.
+
+
 ## 0.2.0 (11/11/17)
 - Support Api version 4 via configuration method .withApiVersion4()
 - Add support for List and ListMembership API endpoints.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.darksci</groupId>
     <artifactId>pardot-api-client</artifactId>
-    <version>0.2.0</version>
+    <version>0.3.0</version>
     <packaging>jar</packaging>
 
     <!-- Require Maven 3.3.9 -->

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

@@ -35,6 +35,10 @@
 import com.darksci.pardot.api.parser.user.UserAbilitiesParser;
 import com.darksci.pardot.api.parser.user.UserQueryResponseParser;
 import com.darksci.pardot.api.parser.user.UserReadResponseParser;
+import com.darksci.pardot.api.parser.visitor.VisitorQueryResponseParser;
+import com.darksci.pardot.api.parser.visitor.VisitorReadResponseParser;
+import com.darksci.pardot.api.parser.visitoractivity.VisitorActivityQueryResponseParser;
+import com.darksci.pardot.api.parser.visitoractivity.VisitorActivityReadResponseParser;
 import com.darksci.pardot.api.request.Request;
 import com.darksci.pardot.api.request.account.AccountReadRequest;
 import com.darksci.pardot.api.request.campaign.CampaignCreateRequest;
@@ -65,6 +69,11 @@
 import com.darksci.pardot.api.request.user.UserAbilitiesRequest;
 import com.darksci.pardot.api.request.user.UserQueryRequest;
 import com.darksci.pardot.api.request.user.UserReadRequest;
+import com.darksci.pardot.api.request.visitor.VisitorAssignRequest;
+import com.darksci.pardot.api.request.visitor.VisitorQueryRequest;
+import com.darksci.pardot.api.request.visitor.VisitorReadRequest;
+import com.darksci.pardot.api.request.visitoractivity.VisitorActivityQueryRequest;
+import com.darksci.pardot.api.request.visitoractivity.VisitorActivityReadRequest;
 import com.darksci.pardot.api.response.ErrorResponse;
 import com.darksci.pardot.api.response.account.Account;
 import com.darksci.pardot.api.response.campaign.Campaign;
@@ -81,6 +90,10 @@
 import com.darksci.pardot.api.response.user.User;
 import com.darksci.pardot.api.response.user.UserAbilitiesResponse;
 import com.darksci.pardot.api.response.user.UserQueryResponse;
+import com.darksci.pardot.api.response.visitor.Visitor;
+import com.darksci.pardot.api.response.visitor.VisitorQueryResponse;
+import com.darksci.pardot.api.response.visitoractivity.VisitorActivity;
+import com.darksci.pardot.api.response.visitoractivity.VisitorActivityQueryResponse;
 import com.darksci.pardot.api.rest.HttpClientRestClient;
 import com.darksci.pardot.api.rest.RestClient;
 import com.darksci.pardot.api.rest.RestResponse;
@@ -155,7 +168,7 @@ private <T> T submitRequest(final Request request, ResponseParser<T> responsePar
             }
 
             // High level check for error response
-            if (restResponse.getResponseStr().contains("<rsp stat=\"fail\"")) {
+            if (responseStr.contains("<rsp stat=\"fail\"")) {
                 try {
                     // Parse error response
                     final ErrorResponse error = new ErrorResponseParser().parseResponse(restResponse.getResponseStr());
@@ -184,9 +197,7 @@ public Configuration getConfiguration() {
     }
 
     /**
-     *
-
-package protected for access in tests.
+     * package protected for access in tests.
      * @return Rest Client.
      */
     RestClient getRestClient() {
@@ -487,6 +498,51 @@ public Prospect prospectUnassign(final ProspectUnassignRequest request) {
         return submitRequest(request, new ProspectReadResponseParser());
     }
 
+    /**
+     * Make API request to assign a visitor.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public Visitor visitorAssign(final VisitorAssignRequest request) {
+        return submitRequest(request, new VisitorReadResponseParser());
+    }
+
+    /**
+     * Make API request to query visitors.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public VisitorQueryResponse.Result visitorQuery(final VisitorQueryRequest request) {
+        return submitRequest(request, new VisitorQueryResponseParser());
+    }
+
+    /**
+     * Make API request to read a visitor activity.
+     * @param request Request definition.
+     * @return Parsed api response
+     */
+    public Visitor visitorRead(final VisitorReadRequest request) {
+        return submitRequest(request, new VisitorReadResponseParser());
+    }
+
+    /**
+     * Make API request to query visitorActivities.
+     * @param request Request definition.
+     * @return Parsed api response.
+     */
+    public VisitorActivityQueryResponse.Result visitorActivityQuery(final VisitorActivityQueryRequest request) {
+        return submitRequest(request, new VisitorActivityQueryResponseParser());
+    }
+
+    /**
+     * Make API request to read a visitor activity.
+     * @param request Request definition.
+     * @return Parsed api response
+     */
+    public VisitorActivity visitorActivityRead(final VisitorActivityReadRequest request) {
+        return submitRequest(request, new VisitorActivityReadResponseParser());
+    }
+
     /**
      * Clean up instance, releasing any resources held internally.
      */

src/main/java/com/darksci/pardot/api/parser/visitor/VisitorQueryResponseParser.java

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2017 Stephen Powis https://github.com/Crim/pardot-java-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.darksci.pardot.api.parser.visitor;
+
+import com.darksci.pardot.api.parser.JacksonFactory;
+import com.darksci.pardot.api.parser.ResponseParser;
+import com.darksci.pardot.api.response.visitor.VisitorQueryResponse;
+
+import java.io.IOException;
+
+/**
+ * Handles parsing Visitor Query API responses into POJOs.
+ */
+public class VisitorQueryResponseParser implements ResponseParser<VisitorQueryResponse.Result> {
+
+    @Override
+    public VisitorQueryResponse.Result parseResponse(final String responseStr) throws IOException {
+        return JacksonFactory.newInstance().readValue(responseStr, VisitorQueryResponse.class).getResult();
+    }
+}

src/main/java/com/darksci/pardot/api/parser/visitor/VisitorReadResponseParser.java

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2017 Stephen Powis https://github.com/Crim/pardot-java-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.darksci.pardot.api.parser.visitor;
+
+import com.darksci.pardot.api.parser.JacksonFactory;
+import com.darksci.pardot.api.parser.ResponseParser;
+import com.darksci.pardot.api.response.visitor.Visitor;
+import com.darksci.pardot.api.response.visitor.VisitorReadResponse;
+
+import java.io.IOException;
+
+/**
+ * Handles parsing Visitor Read API responses into POJOs.
+ */
+public class VisitorReadResponseParser implements ResponseParser<Visitor> {
+
+    @Override
+    public Visitor parseResponse(final String responseStr) throws IOException {
+        return JacksonFactory.newInstance().readValue(responseStr, VisitorReadResponse.class).getVisitor();
+    }
+}

src/main/java/com/darksci/pardot/api/parser/visitoractivity/VisitorActivityQueryResponseParser.java

@@ -0,0 +1,35 @@
+/**
+ * Copyright 2017 Stephen Powis https://github.com/Crim/pardot-java-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.darksci.pardot.api.parser.visitoractivity;
+
+import com.darksci.pardot.api.parser.JacksonFactory;
+import com.darksci.pardot.api.parser.ResponseParser;
+import com.darksci.pardot.api.response.visitoractivity.VisitorActivityQueryResponse;
+
+import java.io.IOException;
+
+/**
+ * Handles parsing VisitorActivity Query API responses into POJOs.
+ */
+public class VisitorActivityQueryResponseParser implements ResponseParser<VisitorActivityQueryResponse.Result> {
+
+    @Override
+    public VisitorActivityQueryResponse.Result parseResponse(final String responseStr) throws IOException {
+        return JacksonFactory.newInstance().readValue(responseStr, VisitorActivityQueryResponse.class).getResult();
+    }
+}

src/main/java/com/darksci/pardot/api/parser/visitoractivity/VisitorActivityReadResponseParser.java

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2017 Stephen Powis https://github.com/Crim/pardot-java-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.darksci.pardot.api.parser.visitoractivity;
+
+import com.darksci.pardot.api.parser.JacksonFactory;
+import com.darksci.pardot.api.parser.ResponseParser;
+import com.darksci.pardot.api.response.visitoractivity.VisitorActivity;
+import com.darksci.pardot.api.response.visitoractivity.VisitorActivityReadResponse;
+
+import java.io.IOException;
+
+/**
+ * Handles parsing VisitorActivity Read API responses into POJOs.
+ */
+public class VisitorActivityReadResponseParser implements ResponseParser<VisitorActivity> {
+
+    @Override
+    public VisitorActivity parseResponse(final String responseStr) throws IOException {
+        return JacksonFactory.newInstance().readValue(responseStr, VisitorActivityReadResponse.class).getVisitorActivity();
+    }
+}

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

@@ -30,10 +30,12 @@ public abstract class BaseRequest<T> implements Request {
     // Param holder
     private Map<String, Object> params = new HashMap<>();
 
+    @SuppressWarnings("unchecked")
     protected <T> T getParam(final String name) {
         return (T) params.getOrDefault(name, null);
     }
 
+    @SuppressWarnings("unchecked")
     protected T setParam(final String name, Object value) {
         if (value == null) {
             params.remove(name);
@@ -50,6 +52,7 @@ protected T setParam(final String name, Object value) {
      * @return BaseRequest
      */
     protected T setBooleanParam(final String parameterName, final boolean booleanValue) {
+        // TODO i think this is a bug? Or needs to be removed.
         String value = "true";
         if (!booleanValue) {
             value = "false";
@@ -67,6 +70,7 @@ protected T withCollectionParam(final String name, final Object value) {
         return setParam(name, values);
     }
 
+    @SuppressWarnings("unchecked")
     protected T withCollectionParams(final String name, Collection<?> values) {
         for (final Object value: values) {
             withCollectionParam(name, value);

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

@@ -32,6 +32,7 @@ abstract class ProspectModifyRequest<T> extends BaseRequest<T> {
      * @param prospect The prospect you want to create in pardot.
      * @return CampaignCreateRequest builder.
      */
+    @SuppressWarnings("unchecked")
     public T withProspect(final Prospect prospect) {
         // Identifying fields
         setParam("id", prospect.getId());
@@ -69,8 +70,6 @@ public T withProspect(final Prospect prospect) {
             }
         }
 
-        // TODO add other fields?  How to handle custom fields?
-
         return (T) this;
     }
 

src/main/java/com/darksci/pardot/api/request/visitor/VisitorAssignRequest.java

@@ -0,0 +1,60 @@
+/**
+ * Copyright 2017 Stephen Powis https://github.com/Crim/pardot-java-client
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.darksci.pardot.api.request.visitor;
+
+
+import com.darksci.pardot.api.request.BaseQueryRequest;
+
+/**
+ * Request for assigning a visitor to a prospect.
+ */
+public class VisitorAssignRequest extends BaseQueryRequest<VisitorAssignRequest> {
+    @Override
+    public String getApiEndpoint() {
+        return "visitor/do/assign";
+    }
+
+    /**
+     * Assign visitor to the specified Prospect's email address.
+     * @param email Email address of prospect.
+     * @return RequestBuilder
+     */
+    public VisitorAssignRequest withProspectEmail(final String email) {
+        setParam("prospect_id", null);
+        return setParam("prospect_email", email);
+    }
+
+    /**
+     * Assign visitor to the specified prospect by prospectId.
+     * @param prospectId Id of prospect.
+     * @return RequestBuilder
+     */
+    public VisitorAssignRequest withProspectId(final Long prospectId) {
+        setParam("prospect_email", null);
+        return setParam("prospect_id", prospectId);
+    }
+
+    /**
+     * Select which visitor to assign.
+     * @param visitorId The id of the visitor to assign.
+     * @return RequestBuilder
+     */
+    public VisitorAssignRequest withVisitorId(final Long visitorId) {
+        return setParam("id", visitorId);
+    }
+}