Full Maven refactoring

.gitignore

@@ -1,5 +1,14 @@
 #Ignore
-bin/*
-testreport/*
-examples/backtothefuture/build/*
-target/*
+bin/
+testreport/
+examples/backtothefuture/build/
+
+## Maven
+target/
+
+## IntelliJ
+*.iml
+.idea
+
+## Mac OS X
+.DS_Store

LICENSE.txt

@@ -0,0 +1,28 @@
+Copyright (c) 2010-2021 John Deverall. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1.  Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+3.  Neither the name of the copyright holder nor the names of its
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -6,11 +6,11 @@ Due to the lack of useful native DOM parsers this class implements the HTMLClean
 ## Usage ##
 In this example we will fetch the og:title and og:type contents, while ignoring any errors if this page does not comply with the Open Graph protocol standard (set in the constructor via true)
 
-> OpenGraph testPage = new OpenGraph("http://uk.rottentomatoes.com/m/1217700-kick_ass", true);
+> `OpenGraph testPage = new OpenGraph("http://uk.rottentomatoes.com/m/1217700-kick_ass", true);`
 
-> String title = testPage.getContent("title");
+> `String title = testPage.getContent("title");`
 
-> String type = testPage.getContent("type");
+> `String type = testPage.getContent("type");`
 
 Another example (available in the examples/ folder) demonstrates the support for custom OpenGraph namespaces
 

examples/backtothefuture/src/BackToTheFuture.java → examples/backtothefuture/src/main/java/org/opengraph/examples/BackToTheFuture.java

@@ -1,19 +1,16 @@
 package org.opengraph.examples;
 
-import org.opengraph.OpenGraph;
 import org.opengraph.MetaElement;
+import org.opengraph.OpenGraph;
 
 public class BackToTheFuture {
-	static String uri = "http://www.rottentomatoes.com/m/back_to_the_future/";
-
-	public static void main(String [] args)
-	{
-		try
-		{
+	static String uri = "https://web.archive.org/web/20110924151516/https://www.rottentomatoes.com/m/back_to_the_future";
+
+	public static void main(String[] args) {
+		try {
 			OpenGraph movie = new OpenGraph(uri, true);
 			System.out.println("Movie: " + movie.getContent("title"));
-			for (MetaElement director : movie.getProperties("director"))
-			{
+			for (MetaElement director : movie.getProperties("director")) {
 				OpenGraph extendedInfo = director.getExtendedData();
 				System.out.println("Directed by: " + extendedInfo.getContent("title"));
 			}

examples/pom.xml

@@ -0,0 +1,55 @@
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>opengraph-examples</artifactId>
+    <version>${project.parent.version}</version>
+    <packaging>jar</packaging>
+
+    <parent>
+        <groupId>opengraph</groupId>
+        <artifactId>opengraph</artifactId>
+        <version>0.0.2-SNAPSHOT</version>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>opengraph</groupId>
+            <artifactId>opengraph-plugin</artifactId>
+            <version>0.0.2-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
+    <build>
+        <sourceDirectory>backtothefuture/src/main/java</sourceDirectory>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>3.3.0</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                        <configuration>
+                            <archive>
+                                <manifest>
+                                    <mainClass>org.opengraph.examples.BackToTheFuture</mainClass>
+                                </manifest>
+                            </archive>
+                            <descriptorRefs>
+                                <descriptorRef>jar-with-dependencies</descriptorRef>
+                            </descriptorRefs>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

plugin/pom.xml

@@ -0,0 +1,24 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>opengraph-plugin</artifactId>
+    <version>${project.parent.version}</version>
+    <packaging>jar</packaging>
+
+    <parent>
+        <groupId>opengraph</groupId>
+        <artifactId>opengraph</artifactId>
+        <version>0.0.2-SNAPSHOT</version>
+    </parent>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

plugin/src/main/java/org/opengraph/MetaElement.java

@@ -0,0 +1,65 @@
+package org.opengraph;
+
+import java.net.URL;
+
+/**
+ * Represents OpenGraph enabled meta data for a specific document
+ *
+ * @author Callum Jones
+ */
+public class MetaElement {
+  private OpenGraphNamespace namespace; //either "og" an NS specific
+  private String property;
+  private String content;
+
+  /**
+   * Construct the representation of an element
+   *
+   * @param namespace The namespace the element belongs to
+   * @param property  The property key
+   * @param content   The content or value of this element
+   */
+  public MetaElement(OpenGraphNamespace namespace, String property, String content) {
+    this.namespace = namespace;
+    this.property = property;
+    this.content = content;
+  }
+
+  /**
+   * Fetch the content string of the element
+   */
+  public String getContent() {
+    return content;
+  }
+
+  /**
+   * Fetch the OpenGraph namespace
+   */
+  public OpenGraphNamespace getNamespace() {
+    return namespace;
+  }
+
+  /**
+   * Fetch the property of the element
+   */
+  public String getProperty() {
+    return property;
+  }
+
+  /**
+   * Fetch the OpenGraph data from the object
+   *
+   * @return If the content is a URL, then an attempted will be made to build OpenGraph data from the object
+   */
+  public OpenGraph getExtendedData() {
+    //The Java language should know the best form of a URL
+    try {
+      URL url = new URL(getContent());
+
+      //success
+      return new OpenGraph(url.toString(), true);
+    } catch (Exception e) {
+      return null; //not a valid URL
+    }
+  }
+}