You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rave.apache.org by rg...@apache.org on 2011/10/20 03:39:48 UTC
svn commit: r1186598 - in /incubator/rave/trunk:
rave-portal-resources/src/main/webapp/WEB-INF/db/
rave-portal-resources/src/main/webapp/script/
rave-portal-resources/src/test/javascript/
rave-providers/rave-w3c-provider/ rave-providers/rave-w3c-provid...
Author: rgardler
Date: Thu Oct 20 01:39:48 2011
New Revision: 1186598
URL: http://svn.apache.org/viewvc?rev=1186598&view=rev
Log:
Implement basic W3C widget support via Apache Wookie (fixes RACE-30)
Modified:
incubator/rave/trunk/rave-portal-resources/src/main/webapp/WEB-INF/db/initial_data.sql
incubator/rave/trunk/rave-portal-resources/src/main/webapp/script/rave_wookie.js
incubator/rave/trunk/rave-portal-resources/src/test/javascript/raveWookieSpec.js
incubator/rave/trunk/rave-providers/rave-w3c-provider/pom.xml
incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/service/impl/WookieWidgetService.java
incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRenderer.java
incubator/rave/trunk/rave-providers/rave-w3c-provider/src/test/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRendererTest.java
Modified: incubator/rave/trunk/rave-portal-resources/src/main/webapp/WEB-INF/db/initial_data.sql
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-portal-resources/src/main/webapp/WEB-INF/db/initial_data.sql?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-portal-resources/src/main/webapp/WEB-INF/db/initial_data.sql (original)
+++ incubator/rave/trunk/rave-portal-resources/src/main/webapp/WEB-INF/db/initial_data.sql Thu Oct 20 01:39:48 2011
@@ -223,7 +223,17 @@ insert into widget (entity_id, title, ur
values(@user_prefs_demo_widget_id, 'User Prefs Demo', 'http://localhost:8080/demogadgets/user_prefs_demo.xml', 'OpenSocial', 'PUBLISHED', 'An example gadget which demos some of the different capabilities of user preferences.', 'Anthony Carlucci');
UPDATE RAVE_PORTAL_SEQUENCES SET seq_count = (seq_count + 1) WHERE seq_name = @widget_seq;
--- end widget data ----
+-- end gadget data ----
+
+-- W3C Widget data
+
+-- simple chat widget
+set @chat_widget_id = (SELECT seq_count FROM RAVE_PORTAL_SEQUENCES WHERE seq_name = @widget_seq);
+insert into widget (entity_id, title, url, type, widget_status, description, author)
+values(@chat_widget_id, 'Simple Chat', 'http://wookie.apache.org/widgets/simplechat', 'W3C', 'PUBLISHED', 'NOTE: This is a W3C Widget managed by a Wookie server. It is an ALPHA feature. Must have an Apache Wookie server running on the same machine as the Rave server on port 8888', 'Apache Wookie Community');
+UPDATE RAVE_PORTAL_SEQUENCES SET seq_count = (seq_count + 1) WHERE seq_name = @widget_seq;
+
+-- end W3C Widget data
-- User layouts
Modified: incubator/rave/trunk/rave-portal-resources/src/main/webapp/script/rave_wookie.js
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-portal-resources/src/main/webapp/script/rave_wookie.js?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-portal-resources/src/main/webapp/script/rave_wookie.js (original)
+++ incubator/rave/trunk/rave-portal-resources/src/main/webapp/script/rave_wookie.js Thu Oct 20 01:39:48 2011
@@ -18,20 +18,20 @@
*/
var rave = rave || {};
rave.wookie = rave.wookie || (function() {
-
var WIDGET_TYPE = "W3C";
+ var OFFSET = 10;
+ var MIN_HEIGHT = 250;
- function createWidgets(widgets){
- if(!widgets || widgets.length == 0) return;
+ var container;
+
+ function validateAndRenderWidget(widget){
+ var widgetBodyElement = document.getElementById(["widget-", widget.regionWidgetId, "-body"].join(""));
- for(var i = 0; i < widgets.length; i++){
- var widgetBodyElement = document.getElementById(["widget-", widgets[i].regionWidgetId, "-body"].join(""));
- var widgetIframe = document.createElement("iframe");
- widgetIframe.setAttribute("height",250);
- widgetIframe.setAttribute("width",250);
- widgetIframe.setAttribute("src",widgets[i].widgetUrl);
- widgetBodyElement.appendChild(widgetIframe);
- }
+ var widgetIframe = document.createElement("iframe");
+ widgetIframe.setAttribute("height",250);
+ widgetIframe.setAttribute("width",250);
+ widgetIframe.setAttribute("src",widget.widgetUrl);
+ widgetBodyElement.appendChild(widgetIframe);
}
/**
@@ -44,16 +44,16 @@ rave.wookie = rave.wookie || (function()
* Init function required by Rave's initialization infrastructure
*/
init : function() {},
-
/**
- * Renders the given Widgets list
- * @param a list of widgets to render
+ * Instantiates and renders the given widget
+ * @param a widget to render
*/
- initWidgets: createWidgets
+ initWidget: validateAndRenderWidget
};
})();
+
//Register the widget provider with Rave
rave.registerProvider(rave.wookie);
\ No newline at end of file
Modified: incubator/rave/trunk/rave-portal-resources/src/test/javascript/raveWookieSpec.js
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-portal-resources/src/test/javascript/raveWookieSpec.js?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-portal-resources/src/test/javascript/raveWookieSpec.js (original)
+++ incubator/rave/trunk/rave-portal-resources/src/test/javascript/raveWookieSpec.js Thu Oct 20 01:39:48 2011
@@ -22,45 +22,11 @@ describe("Rave Wookie", function() {
expect(rave.wookie.TYPE).toEqual("W3C");
});
- describe("Verify null widgets results in clean return", function() {
- it("Tests null argument", function() {
- var wookieMap=rave.wookie.initWidgets(null);
- //Lifted from raveSpec.js. Must be other ways to test this.
- var count=0;
- for (i in wookieMap) {count++;}
- expect(count).toEqual(0);
- });
+ describe("Init", function() {
- it("Tests uncreated list", function() {
- var widgets;
- var wookieMap=rave.wookie.initWidgets(widgets);
- //Lifted from raveSpec.js. Must be other ways to test this.
- var count=0;
- for (i in wookieMap) {count++;}
- expect(count).toEqual(0);
- });
-
- it("Tests empty list", function() {
- var widgets=[];
- var wookieMap=rave.wookie.initWidgets(widgets);
- //Lifted from raveSpec.js. Must be other ways to test this.
- var count=0;
- for (i in wookieMap) {count++;}
- expect(count).toEqual(0);
- });
- });
-
- describe("Create Wookie Widgets",function() {
- //This test is currently incomplete because we need to find
- //a way to handle the document.getElementID() call within rave_wookie.js
- it("initializes wookie widgets", function() {
- var widgets = [
- {regionWidgetId: 0, type: "W3C"},
- {regionWidgetId: 1, type: "null"},
- {regionWidgetId: 2}
- ];
- var wookieMap=rave.wookie.initWidgets(widgets[rave.wookie.TYPE]);
- });
+ it("initializes the Wookie container machinery", function() {
+ rave.wookie.init();
+ });
});
});
\ No newline at end of file
Modified: incubator/rave/trunk/rave-providers/rave-w3c-provider/pom.xml
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-providers/rave-w3c-provider/pom.xml?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-providers/rave-w3c-provider/pom.xml (original)
+++ incubator/rave/trunk/rave-providers/rave-w3c-provider/pom.xml Thu Oct 20 01:39:48 2011
@@ -35,6 +35,12 @@
<packaging>jar</packaging>
<dependencies>
+ <dependency>
+ <groupId>org.apache.wookie</groupId>
+ <artifactId>wookie-java-connector</artifactId>
+ <scope>compile</scope>
+ <version>0.9.1-incubating-SNAPSHOT</version>
+ </dependency>
<dependency>
<groupId>org.apache.rave</groupId>
<artifactId>rave-commons</artifactId>
Modified: incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/service/impl/WookieWidgetService.java
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/service/impl/WookieWidgetService.java?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/service/impl/WookieWidgetService.java (original)
+++ incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/service/impl/WookieWidgetService.java Thu Oct 20 01:39:48 2011
@@ -22,20 +22,27 @@ package org.apache.rave.provider.w3c.ser
import org.apache.rave.portal.model.User;
import org.apache.rave.portal.model.Widget;
import org.apache.rave.portal.service.WidgetProviderService;
+import org.apache.wookie.connector.framework.WidgetInstance;
+import org.apache.wookie.connector.framework.WookieConnectorException;
+import org.apache.wookie.connector.framework.WookieConnectorService;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
+import java.io.IOException;
+
//import org.apache.wookie.connector.framework.WidgetInstance;
//import org.apache.wookie.connector.framework.WookieConnectorException;
-//import org.apache.wookie.connector.framework.WookieConnectorService;
@Service
public class WookieWidgetService implements WidgetProviderService {
-
- // TODO RAVE-68 uncomment when Wookie Connector is available in Maven
-
- private static final String WOOKIE_SERVER_URL = "http://localhost:8080/wookie";
+ private static Logger logger = LoggerFactory.getLogger(WookieWidgetService.class);
+
+ // FIXME: shouldn't hard code the server location
+ private static final String WOOKIE_SERVER_URL = "http://bombax.oucs.ox.ac.uk:8888/wookie";
private static final String WOOKIE_API_KEY = "TEST";
- //private static WookieConnectorService connectorService;
+ private static final String WOOKIE_SHARED_DATA_KEY = "mysharedkey";
+ private static WookieConnectorService connectorService;
public WookieWidgetService(){
}
@@ -45,27 +52,31 @@ public class WookieWidgetService impleme
*/
@Override
public Widget getWidget(User viewer, String context, Widget widget) {
- //if (widget.getType().equals("W3C")) return getWidgetForViewer(widget, context, viewer);
- return widget;
+ if (widget.getType().equals("W3C")) {
+ return getWidgetForViewer(widget, context, viewer);
+ } else {
+ return null;
+ }
}
-
- /*
private Widget getWidgetForViewer(Widget widget, String context, User viewer){
try {
- connectorService = getWookieConnectorService(WOOKIE_SERVER_URL, WOOKIE_API_KEY, context);
- org.apache.wookie.connector.framework.User user = new org.apache.wookie.connector.framework.User(String.valueOf(viewer.getEntityId()), viewer.getUsername());
+ // TODO: parameters for WookieConnectorService should not be fixed in code.
+ connectorService = getWookieConnectorService(WOOKIE_SERVER_URL, WOOKIE_API_KEY, WOOKIE_SHARED_DATA_KEY);
+ org.apache.wookie.connector.framework.User user = new org.apache.wookie.connector.framework.User(String.valueOf(viewer.getUsername()), viewer.getUsername());
connectorService.setCurrentUser(user);
- System.out.println("Getting widget:"+widget.getUrl()+" from:" +connectorService.getConnection().getURL());
+ logger.debug("Getting widget:"+widget.getUrl()+" from:" +connectorService.getConnection().getURL());
WidgetInstance instance = connectorService.getOrCreateInstance(widget.getUrl());
return createWidget(instance);
} catch (WookieConnectorException e) {
- e.printStackTrace();
- return null;
+ logger.error("Unable to connect to Wookie server", e);
+ // FIXME: provide a real error widget
+ return createWidget(new WidgetInstance("error", "error", e.getMessage(), "100", "100"));
} catch (IOException e) {
- e.printStackTrace();
- return null;
+ logger.error("Problem communicating with Wookie server", e);
+ // FIXME: provide a real error widget
+ return createWidget(new WidgetInstance("error", "error", e.getMessage(), "100", "100"));
}
}
@@ -73,7 +84,7 @@ public class WookieWidgetService impleme
* Create a Rave Widget object for the widget instance.
* This is a transient object and is not persisted
* @return
- *
+ */
private Widget createWidget(WidgetInstance instance){
Widget widget = new Widget();
widget.setUrl(instance.getUrl());
@@ -91,7 +102,5 @@ public class WookieWidgetService impleme
return connectorService;
}
- */
-
}
Modified: incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRenderer.java
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRenderer.java?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRenderer.java (original)
+++ incubator/rave/trunk/rave-providers/rave-w3c-provider/src/main/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRenderer.java Thu Oct 20 01:39:48 2011
@@ -21,10 +21,20 @@ package org.apache.rave.provider.w3c.web
import org.apache.rave.exception.NotSupportedException;
import org.apache.rave.portal.model.RegionWidget;
+import org.apache.rave.portal.model.RegionWidgetPreference;
+import org.apache.rave.portal.model.User;
import org.apache.rave.portal.model.Widget;
+import org.apache.rave.portal.service.UserService;
import org.apache.rave.portal.service.WidgetProviderService;
import org.apache.rave.portal.web.renderer.RegionWidgetRenderer;
+import org.apache.rave.portal.web.renderer.RenderScope;
+import org.apache.rave.portal.web.renderer.ScriptLocation;
+import org.apache.rave.portal.web.renderer.ScriptManager;
import org.apache.rave.portal.web.renderer.model.RenderContext;
+import org.json.JSONException;
+import org.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
@@ -36,20 +46,27 @@ import static org.apache.rave.provider.w
*/
@Component
public class W3cWidgetRenderer implements RegionWidgetRenderer {
-
-
- private static final String IFRAME_MARKUP = "<script>rave.registerWidget(widgetsByRegionIdMap, %1$s, {type: '%2$s'," +
- " regionWidgetId: %3$s," +
- " widgetUrl: '%4$s'});</script>";
-
- private static final String INLINE_MARKUP = "";
+ private static Logger logger = LoggerFactory.getLogger(W3cWidgetRenderer.class);
private final WidgetProviderService widgetService;
+ private final UserService userService;
+ private ScriptManager scriptManager;
@Autowired
- public W3cWidgetRenderer(@Qualifier("wookieWidgetService") WidgetProviderService widgetService) {
+ public W3cWidgetRenderer(@Qualifier("wookieWidgetService") WidgetProviderService widgetService,
+ UserService userService, ScriptManager scriptManager) {
this.widgetService = widgetService;
+ this.userService = userService;
+ this.scriptManager = scriptManager;
}
+
+ private static final String SCRIPT_BLOCK =
+ "<script>rave.registerWidget(widgetsByRegionIdMap, %1$s, {type: '%2$s'," +
+ " regionWidgetId: %3$s," +
+ " widgetUrl: '%4$s', " +
+ " collapsed: %5$s});</script>";
+ private static final String MARKUP = "<!-- RegionWidget %1$s placeholder -->";
+
@Override
public String getSupportedContext() {
@@ -69,8 +86,30 @@ public class W3cWidgetRenderer implement
if(!WIDGET_TYPE.equals(widget.getType())) {
throw new NotSupportedException("Invalid widget type passed to renderer: " + widget.getType());
}
- Widget contextualizedWidget = widgetService.getWidget(null, null, widget);
- String url = contextualizedWidget == null ? null : contextualizedWidget.getUrl();
- return String.format(IFRAME_MARKUP, item.getRegion().getEntityId(), WIDGET_TYPE, item.getEntityId(), url);
+
+ String widgetScript = getWidgetScript(item);
+ scriptManager.registerScriptBlock(widgetScript, ScriptLocation.AFTER_RAVE, RenderScope.CURRENT_REQUEST, context);
+ logger.debug("Gadget Script Data: " + widgetScript);
+
+ return String.format(MARKUP, item.getEntityId());
+ }
+
+ private String getWidgetScript(RegionWidget item) {
+ User user = userService.getAuthenticatedUser();
+ Widget contextualizedWidget = widgetService.getWidget(user, null, item.getWidget());
+
+ JSONObject userPrefs = new JSONObject();
+ if (item.getPreferences() != null) {
+ for (RegionWidgetPreference regionWidgetPreference : item.getPreferences()) {
+ try {
+ userPrefs.put(regionWidgetPreference.getName(), regionWidgetPreference.getValue());
+ } catch (JSONException e) {
+ logger.error("Exception caught adding preference to JSONObject: " + regionWidgetPreference, e);
+ }
+ }
+ }
+
+ return String.format(SCRIPT_BLOCK, item.getRegion().getEntityId(), WIDGET_TYPE, item.getEntityId(),
+ contextualizedWidget.getUrl(), item.isCollapsed());
}
}
Modified: incubator/rave/trunk/rave-providers/rave-w3c-provider/src/test/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRendererTest.java
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-providers/rave-w3c-provider/src/test/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRendererTest.java?rev=1186598&r1=1186597&r2=1186598&view=diff
==============================================================================
--- incubator/rave/trunk/rave-providers/rave-w3c-provider/src/test/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRendererTest.java (original)
+++ incubator/rave/trunk/rave-providers/rave-w3c-provider/src/test/java/org/apache/rave/provider/w3c/web/renderer/W3cWidgetRendererTest.java Thu Oct 20 01:39:48 2011
@@ -19,34 +19,47 @@
package org.apache.rave.provider.w3c.web.renderer;
+import static org.easymock.EasyMock.createNiceMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.replay;
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+
import org.apache.rave.exception.NotSupportedException;
import org.apache.rave.portal.model.Region;
import org.apache.rave.portal.model.RegionWidget;
+import org.apache.rave.portal.model.User;
import org.apache.rave.portal.model.Widget;
+import org.apache.rave.portal.service.UserService;
import org.apache.rave.portal.service.WidgetProviderService;
import org.apache.rave.portal.web.renderer.Renderer;
+import org.apache.rave.portal.web.renderer.ScriptManager;
+import org.apache.rave.portal.web.renderer.model.RenderContext;
import org.apache.rave.provider.w3c.Constants;
import org.junit.Before;
import org.junit.Test;
-import static org.easymock.EasyMock.createNiceMock;
-import static org.easymock.EasyMock.expect;
-import static org.easymock.EasyMock.replay;
-import static org.hamcrest.CoreMatchers.equalTo;
-import static org.hamcrest.CoreMatchers.is;
-import static org.junit.Assert.assertThat;
-
/*
*/
public class W3cWidgetRendererTest {
+ private static final String VALID_WIDGET_URL = "http://example.com/widgets/1";
+ private static final String VALID_WIDGET_INSTANCE_URL = "http://example.com/widgetinstances/1";
private Renderer<RegionWidget> renderer;
private WidgetProviderService wookieService;
+ private UserService userService;
+ private RenderContext renderContext;
+ private ScriptManager scriptManager;
@Before
public void setup() {
+ renderContext = new RenderContext();
wookieService = createNiceMock(WidgetProviderService.class);
- renderer = new W3cWidgetRenderer(wookieService);
+ userService = createNiceMock(UserService.class);
+ scriptManager = createNiceMock(ScriptManager.class);
+ renderer = new W3cWidgetRenderer(wookieService, userService, scriptManager);
}
@Test
@@ -56,6 +69,10 @@ public class W3cWidgetRendererTest {
@Test
public void render_valid() {
+ User user = new User(9999L, "testUser");
+ expect(userService.getAuthenticatedUser()).andReturn(user);
+ replay(userService);
+
Widget w = new Widget();
w.setType(Constants.WIDGET_TYPE);
w.setUrl("http://example.com/widgets/1");
@@ -66,42 +83,25 @@ public class W3cWidgetRendererTest {
rw.setRegion(region);
Widget wookieWidget = new Widget();
- final String WIDGET_INSTANCE = "http://example.com/widgetinstances/1";
- wookieWidget.setUrl(WIDGET_INSTANCE);
+ wookieWidget.setUrl(VALID_WIDGET_INSTANCE_URL);
- expect(wookieService.getWidget(null, null, w)).andReturn(wookieWidget);
+ expect(wookieService.getWidget(user, null, w)).andReturn(wookieWidget);
replay(wookieService);
- String result = renderer.render(rw, null);
- assertThat(result.matches(".*regionWidgetId[ ]*:[ ]*1,.*"), is(true));
- assertThat(result.matches(".*type[ ]*:[ ]*'W3C',.*"), is(true));
- assertThat(result.matches(".*widgetUrl[ ]*:[ ]*'" + WIDGET_INSTANCE + "'.*"), is(true));
- }
-
- @Test
- public void render_null() {
- Widget w = new Widget();
- w.setType(Constants.WIDGET_TYPE);
- Region region = new Region(1L);
- RegionWidget rw = new RegionWidget();
- rw.setWidget(w);
- rw.setRegion(region);
-
- String result = renderer.render(rw, null);
- assertThat(result.matches(".*regionWidgetId[ ]*:[ ]*null,.*"), is(true));
- assertThat(result.matches(".*type[ ]*:[ ]*'W3C',.*"), is(true));
- assertThat(result.matches(".*widgetUrl[ ]*:[ ]*'null'.*"), is(true));
+ String placeholder = renderer.render(rw, renderContext);
+ assertEquals("Script block for widget is incorrect", "<!-- RegionWidget 1 placeholder -->", placeholder);
}
@Test(expected = NotSupportedException.class)
public void render_invalid() {
Widget w = new Widget();
w.setType("NONE");
- w.setUrl("http://example.com/widgets/1");
+ w.setUrl(VALID_WIDGET_URL);
RegionWidget rw = new RegionWidget();
rw.setEntityId(1L);
rw.setWidget(w);
- renderer.render(rw, null);
+ RenderContext renderContext = createNiceMock(RenderContext.class);
+ renderer.render(rw, renderContext);
}
}