svn commit: r741376 - in /incubator/shindig/trunk/java/gadgets/src: main/java/org/apache/shindig/gadgets/spec/ApplicationManifest.java test/java/org/apache/shindig/gadgets/spec/ApplicationManifestTest.java

[et...@apache.org]

Author: etnu
Date: Fri Feb  6 02:17:59 2009
New Revision: 741376

URL: http://svn.apache.org/viewvc?rev=741376&view=rev
Log:
Application manifest (SHINDIG-757) implementation. Not currently bound to the gadget spec factory / rendering pipeline. Missing support for container disambiguation.


Added:
    incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/ApplicationManifest.java
    incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/spec/ApplicationManifestTest.java

Added: incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/ApplicationManifest.java
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/ApplicationManifest.java?rev=741376&view=auto
==============================================================================
--- incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/ApplicationManifest.java (added)
+++ incubator/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/ApplicationManifest.java Fri Feb  6 02:17:59 2009
@@ -0,0 +1,113 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.shindig.gadgets.spec;
+
+import org.apache.shindig.common.uri.Uri;
+
+import com.google.common.collect.ImmutableMap;
+
+import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Represents an opensocial application manifest.
+ */
+public class ApplicationManifest {
+  public static final String NAMESPACE = "http://ns.opensocial.org/2008/application";
+
+  private final Map<String, String> versions;
+  private final Map<String, Uri> gadgets;
+
+  public ApplicationManifest(Uri base, Element xml) throws SpecParserException {
+    ImmutableMap.Builder<String, String> versions = ImmutableMap.builder();
+    ImmutableMap.Builder<String, Uri> gadgets = ImmutableMap.builder();
+
+    NodeList nodes = xml.getElementsByTagName("gadget");
+    for (int i = 0, j = nodes.getLength(); i < j; ++i) {
+      Element gadget = (Element) nodes.item(i);
+      String version = getVersionString(gadget);
+      Uri spec = getSpecUri(base, gadget);
+      gadgets.put(version, spec);
+      for (String label : getLabels(gadget)) {
+        versions.put(label, version);
+      }
+    }
+
+    this.versions = versions.build();
+    this.gadgets = gadgets.build();
+  }
+
+  private static Uri getSpecUri(Uri base, Element gadget) throws SpecParserException {
+    NodeList specs = gadget.getElementsByTagName("spec");
+
+    if (specs.getLength() > 1) {
+      throw new SpecParserException("Only one spec per gadget block may be specified.");
+    } else if (specs.getLength() == 0) {
+      throw new SpecParserException("No spec specified.");
+    }
+
+    try {
+      String relative = specs.item(0).getTextContent();
+      return base.resolve(Uri.parse(relative));
+    } catch (IllegalArgumentException e) {
+      throw new SpecParserException("Invalid spec URI.");
+    }
+  }
+
+  private static String getVersionString(Element gadget) throws SpecParserException {
+    NodeList versions = gadget.getElementsByTagName("version");
+
+    if (versions.getLength() > 1) {
+      throw new SpecParserException("Only one version per gadget block may be specified.");
+    } else if (versions.getLength() == 0) {
+      throw new SpecParserException("No version specified.");
+    }
+
+    return versions.item(0).getTextContent();
+  }
+
+  private static List<String> getLabels(Element gadget) {
+    NodeList labels = gadget.getElementsByTagName("label");
+    List<String> list = new ArrayList<String>(labels.getLength());
+
+    for (int i = 0, j = labels.getLength(); i < j; ++i) {
+      list.add(labels.item(i).getTextContent());
+    }
+
+    return list;
+  }
+
+  /**
+   * @return The gadget specified for the version string, or null if the version doesn't exist.
+   */
+  public Uri getGadget(String version) {
+    return gadgets.get(version);
+  }
+
+  /**
+   * @return The version of the gadget for the given label, or null if the label is unsupported.
+   */
+  public String getVersion(String label) {
+    return versions.get(label);
+  }
+}

Added: incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/spec/ApplicationManifestTest.java
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/spec/ApplicationManifestTest.java?rev=741376&view=auto
==============================================================================
--- incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/spec/ApplicationManifestTest.java (added)
+++ incubator/shindig/trunk/java/gadgets/src/test/java/org/apache/shindig/gadgets/spec/ApplicationManifestTest.java Fri Feb  6 02:17:59 2009
@@ -0,0 +1,153 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.shindig.gadgets.spec;
+
+import static org.junit.Assert.assertEquals;
+
+import org.apache.shindig.common.uri.Uri;
+import org.apache.shindig.common.xml.XmlUtil;
+
+import org.junit.Test;
+
+public class ApplicationManifestTest {
+  private static final Uri BASE_URI = Uri.parse("http://example.org/manifest.xml");
+
+  @Test
+  public void resolveRelativeUri() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "  <spec>app.xml</spec>" +
+        "</gadget></app>";
+
+    ApplicationManifest manifest = new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+
+    assertEquals(BASE_URI.resolve(Uri.parse("app.xml")), manifest.getGadget("1.0"));
+  }
+
+  @Test(expected = SpecParserException.class)
+  public void malformedUriThrows() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "  <spec><![CDATA[$%&$%*$%&$%(]]></spec>" +
+        "</gadget></app>";
+
+    new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+  }
+
+  @Test
+  public void getVersion() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>development</label>" +
+        "  <version>2.0</version>" +
+        "  <spec>whatever</spec>" +
+        "</gadget>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "  <spec>whatever</spec>" +
+        "</gadget></app>";
+
+    ApplicationManifest manifest = new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+
+    assertEquals("1.0", manifest.getVersion("production"));
+    assertEquals("2.0", manifest.getVersion("development"));
+  }
+
+  @Test(expected = SpecParserException.class)
+  public void missingVersion() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <spec>whatever</spec>" +
+        "</gadget></app>";
+
+    new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+  }
+
+  @Test(expected = SpecParserException.class)
+  public void tooManyVersions() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "  <version>2.0</version>" +
+        "  <spec>whatever</spec>" +
+        "</gadget></app>";
+
+    new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+  }
+
+  @Test
+  public void getGadget() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>development</label>" +
+        "  <version>2.0</version>" +
+        "  <spec>app2.xml</spec>" +
+        "</gadget>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "  <spec>app.xml</spec>" +
+        "</gadget></app>";
+
+    ApplicationManifest manifest = new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+
+    assertEquals(BASE_URI.resolve(Uri.parse("app.xml")), manifest.getGadget("1.0"));
+    assertEquals(BASE_URI.resolve(Uri.parse("app2.xml")), manifest.getGadget("2.0"));
+  }
+
+  @Test(expected = SpecParserException.class)
+  public void missingSpec() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "</gadget></app>";
+
+    new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+  }
+
+  @Test(expected = SpecParserException.class)
+  public void tooManySpecs() throws Exception {
+    String xml =
+        "<app xmlns='" + ApplicationManifest.NAMESPACE + "'>" +
+        "<gadget>" +
+        "  <label>production</label>" +
+        "  <version>1.0</version>" +
+        "  <spec>whoever</spec>" +
+        "  <spec>whatever</spec>" +
+        "</gadget></app>";
+
+    new ApplicationManifest(BASE_URI, XmlUtil.parse(xml));
+  }
+
+}