#8 use jsoup over default java xml libs

Author: kennycason

pom.xml

@@ -24,6 +24,12 @@
             <artifactId>commons-lang3</artifactId>
             <version>3.4</version>
         </dependency>
+        <dependency>
+            <groupId>org.jsoup</groupId>
+            <artifactId>jsoup</artifactId>
+            <version>1.8.2</version>
+        </dependency>
+
 
         <dependency>
             <groupId>log4j</groupId>

src/main/java/com/alchemyapi/api/AlchemyApi.java

@@ -14,27 +14,22 @@
 import com.alchemyapi.api.parameters.TargetedSentimentParameters;
 import com.alchemyapi.api.parameters.TaxonomyParameters;
 import com.alchemyapi.api.parameters.TextParameters;
+import org.apache.commons.io.IOUtils;
 import org.apache.log4j.Logger;
-import org.w3c.dom.Document;
-import org.w3c.dom.NodeList;
+import org.jsoup.Jsoup;
+import org.jsoup.nodes.Document;
+import org.jsoup.nodes.Element;
+import org.jsoup.parser.Parser;
 import org.xml.sax.SAXException;
 
-import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.xpath.XPath;
-import javax.xml.xpath.XPathConstants;
-import javax.xml.xpath.XPathExpression;
 import javax.xml.xpath.XPathExpressionException;
-import javax.xml.xpath.XPathFactory;
-import java.io.DataInputStream;
 import java.io.DataOutputStream;
 import java.io.IOException;
 import java.net.HttpURLConnection;
 import java.net.URL;
 import java.nio.charset.Charset;
 
-import static org.apache.commons.lang3.StringUtils.isBlank;
-import static org.apache.commons.lang3.StringUtils.isNotBlank;
 import static org.apache.commons.lang3.StringUtils.length;
 import static org.apache.commons.lang3.StringUtils.trimToEmpty;
 
@@ -510,32 +505,32 @@ public Document imageGetRankedImageKeywords(final ImageParameters params) {
             outputStream.write(image);
             outputStream.close();
 
-            return doRequest(handle, params.getOutputMode());
+            return doRequest(handle, params);
 
         } catch(IOException e) {
             throw new AlchemyApiException(e);
         }
     }
 
-    private Document get(final String callName, final String callPrefix, final Parameters params) {
+    private Document get(final String callName, final String callPrefix, final Parameters parameters) {
         try {
-            final String urlQuery = "?apikey=" + configuration.getApiKey() + params.getUrlQuery();
+            final String urlQuery = "?apikey=" + configuration.getApiKey() + parameters.getUrlQuery();
             final URL url = new URL(buildBaseApiUrl() + callPrefix + "/" + callName + urlQuery);
 
             final HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
             httpURLConnection.setDoOutput(true);
 
-            return doRequest(httpURLConnection, params.getOutputMode());
+            return doRequest(httpURLConnection, parameters);
 
         } catch(IOException e) {
             throw new AlchemyApiException(e);
         }
     }
 
-    private Document post(final String callName, final String callPrefix, final Parameters params) {
+    private Document post(final String callName, final String callPrefix, final Parameters parameters) {
         try {
             final URL url = new URL(buildBaseApiUrl() + callPrefix + "/" + callName);
-            final String data = "apikey=" + configuration.getApiKey() + params.getUrlQuery();
+            final String data = "apikey=" + configuration.getApiKey() + parameters.getUrlQuery();
 
             final HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
             httpURLConnection.setDoOutput(true);
@@ -545,7 +540,7 @@ private Document post(final String callName, final String callPrefix, final Para
             outputStream.write(data.getBytes(Charset.forName("UTF-8")));
             outputStream.close();
 
-            return doRequest(httpURLConnection, params.getOutputMode());
+            return doRequest(httpURLConnection, parameters);
 
         } catch(IOException e) {
             throw new AlchemyApiException(e);
@@ -554,74 +549,62 @@ private Document post(final String callName, final String callPrefix, final Para
 
     // TODO add json handling
     // TODO return pojo with parsed field, but allow a "raw" xml/json getter to protect against api updates
-    private Document doRequest(final HttpURLConnection httpURLConnection, final String outputMode) {
+    private Document doRequest(final HttpURLConnection httpURLConnection, final Parameters parameters) {
         try {
-            final DataInputStream inputStream = new DataInputStream(httpURLConnection.getInputStream());
-            final Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(inputStream);
-
-            inputStream.close();
+            final String response = IOUtils.toString(httpURLConnection.getInputStream());
             httpURLConnection.disconnect();
 
-            switch (outputMode) {
+            switch (parameters.getOutputMode()) {
                 case Parameters.OUTPUT_XML:
-                    return parseXml(document);
+                    return parseXml(response, parameters);
 
                 case Parameters.OUTPUT_RDF:
-                    return praseRdf(document);
+                    return praseRdf(response, parameters);
 
                 case Parameters.OUTPUT_JSON:
                     throw new AlchemyApiException("Json Response not supported yet");
-            }
-            return document;
 
-        } catch (SAXException | ParserConfigurationException | IOException e) {
+                default:
+                    throw new AlchemyApiException("Unknown output mode, must be one of [xml,rdf,json]");
+            }
+        } catch (IOException e) {
             throw new AlchemyApiException(e);
         }
     }
 
-    private Document parseXml(final Document document) {
-        final XPathFactory factory = XPathFactory.newInstance();
-        final String status = getNodeValue(factory, document, "/results/status/text()");
-        if (isBlank(status) || !status.equals("OK")) {
-            final String statusInfo = getNodeValue(factory, document, "/results/statusInfo/text()");
-            if (isNotBlank(statusInfo)) {
-                throw new AlchemyApiException("Error making API call: " + statusInfo);
-            }
-            throw new AlchemyApiException("Error making API call: " + status);
-        }
-        return document;
-    }
+    private Document parseXml(final String response, final Parameters parameters) {
+        final Document document = Jsoup.parse(response, parameters.getEncoding(), Parser.xmlParser());
 
-    private Document praseRdf(final Document document) {
-        final XPathFactory factory = XPathFactory.newInstance();
-        final String status = getNodeValue(factory, document, "//RDF/Description/ResultStatus/text()");
-        if (isBlank(status) || !status.equals("OK")) {
-            final String statusInfo = getNodeValue(factory, document, "//RDF/Description/ResultStatus/text()");
-            if (isNotBlank(statusInfo)) {
+        final Element status = document.select("results > status").first();
+        if (status == null || !status.text().equals("OK")) {
+            final Element statusInfo = document.select("results > statusInfo").first();
+            if (statusInfo != null) {
                 throw new AlchemyApiException("Error making API call: " + statusInfo);
             }
             throw new AlchemyApiException("Error making API call: " + status);
         }
         return document;
     }
 
-    private String getNodeValue(XPathFactory factory, Document doc, String xpathStr) {
-        try {
-            final XPath xpath = factory.newXPath();
-            final XPathExpression expr = xpath.compile(xpathStr);
-            final Object result = expr.evaluate(doc, XPathConstants.NODESET);
-            final NodeList results = (NodeList) result;
-
-            if(results.getLength() == 0 || results.item(0) == null) { return null; }
-            return results.item(0).getNodeValue();
+    // TODO investigate rdf format
+    private Document praseRdf(final String response, final Parameters parameters) {
+        final Document document = Jsoup.parse(response, parameters.getEncoding(), Parser.xmlParser());
 
-        } catch (XPathExpressionException e) {
-            throw new AlchemyApiException(e);
+        final Element status = document.select("RDF > Description > ResultStatus").first();
+        if (status == null || !status.text().equals("OK")) {
+            throw new AlchemyApiException("Error making API call: " + status);
         }
+        return document;
     }
 
     private String buildBaseApiUrl() {
         return API_URL.replace("{SUB_DOMAIN}", configuration.getApiSubDomain());
     }
 
+    private String parseBaseUrl(final HttpURLConnection httpURLConnection) {
+        final URL url = httpURLConnection.getURL();
+        String path = url.getFile().substring(0, url.getFile().lastIndexOf('/'));
+        return url.getProtocol() + "://" + url.getHost() + path;
+    }
+
 }

src/main/java/com/alchemyapi/api/parameters/Parameters.java

@@ -21,6 +21,7 @@ public class Parameters {
     private String text;
     private String outputMode = OUTPUT_XML; // TODO make json default
     private String customParameters;
+    private String encoding = "UTF-8";
 
     public String getUrl() {
         return url;
@@ -49,6 +50,14 @@ public void setText(String text) {
         this.text = text;
     }
 
+    public String getEncoding() {
+        return encoding;
+    }
+
+    public void setEncoding(final String encoding) {
+        this.encoding = encoding;
+    }
+
     public String getOutputMode() {
         return outputMode;
     }

src/test/java/com/alchemyapi/STestAuthor.java

@@ -1,34 +1,28 @@
 package com.alchemyapi;
 
 import com.alchemyapi.api.AlchemyApi;
-import com.alchemyapi.helpers.DocumentUtils;
 import com.alchemyapi.helpers.ResourceUtils;
 import com.alchemyapi.helpers.TestApiFactory;
+import org.jsoup.nodes.Document;
 import org.junit.Test;
-import org.w3c.dom.Document;
-import org.xml.sax.SAXException;
 
-import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.xpath.XPathExpressionException;
 import java.io.File;
-import java.io.IOException;
 
 public class STestAuthor {
 
 	private final AlchemyApi alchemyApi = TestApiFactory.build(new File(System.getProperty("user.home"), ".alchemy/api.key"));
 
 	@Test
-	public void parseFromTestData() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+	public void parseFromTestData() {
 		final String html = ResourceUtils.toString("data/example.html");
-
 		final Document document = alchemyApi.htmlGetAuthor(html, "http://www.test.com/");
-		System.out.println(DocumentUtils.toString(document));
+		System.out.println(document);
 	}
 
 	@Test
-	public void parseFromUrl() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+	public void parseFromUrl() {
 	    final Document document = alchemyApi.urlGetAuthor("http://www.politico.com/blogs/media/2012/02/detroit-news-ed-upset-over-romney-edit-115247.html");
-		System.out.println(DocumentUtils.toString(document));
+		System.out.println(document);
 	}
 
 }

src/test/java/com/alchemyapi/STestSentiment.java

@@ -4,17 +4,12 @@
 import com.alchemyapi.api.parameters.KeywordParameters;
 import com.alchemyapi.api.parameters.NamedEntityParameters;
 import com.alchemyapi.api.parameters.TargetedSentimentParameters;
-import com.alchemyapi.helpers.DocumentUtils;
 import com.alchemyapi.helpers.ResourceUtils;
 import com.alchemyapi.helpers.TestApiFactory;
+import org.jsoup.nodes.Document;
 import org.junit.Test;
-import org.w3c.dom.Document;
-import org.xml.sax.SAXException;
 
-import javax.xml.parsers.ParserConfigurationException;
-import javax.xml.xpath.XPathExpressionException;
 import java.io.File;
-import java.io.IOException;
 
 public class STestSentiment {
 
@@ -23,60 +18,60 @@ public class STestSentiment {
     @Test
     public void url() {
         final Document document = alchemyApi.urlGetTextSentiment("http://www.techcrunch.com/");
-        System.out.println(DocumentUtils.toString(document));
+        System.out.println(document);
     }
 
     @Test
-    public void text() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+    public void text() {
         final Document document = alchemyApi.textGetTextSentiment("That hat is ridiculous, Charles.");
-        System.out.println(DocumentUtils.toString(document));
+        System.out.println(document);
     }
 
     @Test
-    public void file() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+    public void file() {
         final String html = ResourceUtils.toString("data/example.html");
         final Document document = alchemyApi.htmlGetTextSentiment(html, "http://www.test.com/");
-        System.out.println(DocumentUtils.toString(document));
+        System.out.println(document);
     }
 
     @Test
-    public void entityTargetedSentimentText() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+    public void entityTargetedSentimentText() {
         final NamedEntityParameters entityParams = new NamedEntityParameters();
         entityParams.setSentiment(true);
         final Document document = alchemyApi.textGetRankedNamedEntities("That Mike Tyson is such a sweetheart.", entityParams);
-        System.out.println(DocumentUtils.toString(document));
+        System.out.println(document);
 
         final KeywordParameters keywordParams = new KeywordParameters();
         keywordParams.setSentiment(true);
         final Document document2 = alchemyApi.textGetRankedKeywords("That Mike Tyson is such a sweetheart.", keywordParams);
-        System.out.println(DocumentUtils.toString(document2));
+        System.out.println(document2);
 
         final TargetedSentimentParameters sentimentParams = new TargetedSentimentParameters();
         sentimentParams.setShowSourceText(true);
         final Document document3 = alchemyApi.textGetTargetedSentiment("This car is terrible.", "car", sentimentParams);
-        System.out.print(DocumentUtils.toString(document3));
+        System.out.print(document3);
     }
 
     @Test
-    public void entityTargetedSentimentUrl() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+    public void entityTargetedSentimentUrl() {
         final TargetedSentimentParameters sentimentParams = new TargetedSentimentParameters();
         sentimentParams.setShowSourceText(true);
 
         final Document document = alchemyApi.urlGetTargetedSentiment(
                 "http://techcrunch.com/2012/03/01/keen-on-anand-rajaraman-how-walmart-wants-to-leapfrog-over-amazon-tctv/",
                 "Walmart",
                 sentimentParams);
-        System.out.print(DocumentUtils.toString(document));
+        System.out.print(document);
     }
 
     @Test
-    public void entityTargetedSentimentHtml() throws SAXException, ParserConfigurationException, XPathExpressionException, IOException {
+    public void entityTargetedSentimentHtml() {
         final TargetedSentimentParameters sentimentParams = new TargetedSentimentParameters();
         sentimentParams.setShowSourceText(true);
 
         final String html = ResourceUtils.toString("data/example.html");
         final Document document2 = alchemyApi.htmlGetTargetedSentiment(html, "http://www.test.com/", "WujWuj", sentimentParams);
-        System.out.print(DocumentUtils.toString(document2));
+        System.out.print(document2);
     }
 
 }