tap-ubiquity 0.3.0 → 0.4.0

data/History

@@ -1,3 +1,7 @@
+== 0.4.0 / 2009-06-17
+
+Updates to utilize Tap-0.18.0.  Cleanup and documentation.
+
 == 0.3.0 / 2009-05-25
 
 Updates to utilize Tap-0.17.0

data/README

@@ -1,7 +1,30 @@
-= Tap-Ubiqity
+= Tap-Ubiquity
 
 A gem making {Tap}[http://tap.rubyforge.org] available in
-{Ubiqity}[http://labs.mozilla.com/2008/08/introducing-ubiquity/]
+{Ubiquity}[http://labs.mozilla.com/2008/08/introducing-ubiquity/]
+
+== Description
+
+Tap-Ubiquity allows you to dynamically reprocess web content into new web
+pages and to manipulate web content within existing pages.
+
+* Website[http://tap.rubyforge.org/tap-ubiquity]
+* GitHub[http://github.com/bahuvrihi/tap-ubiquity/tree/master] Issues[http://github.com/bahuvrihi/tap-ubiquity/issues]
+* {Google Group}[http://groups.google.com/group/ruby-on-tap]
+
+== Usage
+
+To get a feel for what is possible with Tap-Ubiquity:
+
+* Install {Ubiquity}[http://labs.mozilla.com/2008/08/introducing-ubiquity/]
+* Install Tap-Ubiquity (see below)
+
+And then start a tap server:
+
+  % tap server
+
+Now in Firefox, go to the Tutorial (http://localhost:8080/ubiquity) and
+follow the example.
 
 == Installation
 

data/lib/tap/ubiquity/ubiquity.rb

@@ -1,24 +1,73 @@
 require 'tap/controller'
-require 'json'
+require 'tap/ubiquity/utils'
 
 module Tap
   module Ubiquity
   
-    # ::controller
+    # :startdoc::controller an index of available ubiquity feeds
+    # :startdoc::ubiquity
+    # :startdoc:::-
+    #
+    # The Ubiquity controller provides an index of feeds available in the
+    # current environment.  Ubiquity expects to run with a Tap::Server
+    # that has a router (otherwise the uris for the feeds may be off).
+    #
+    #   % tap server
+    #
+    # Ubiquity controllers are identifies by the '::ubiquity' resource
+    # identifier.  The subject of the identifier specifies which action
+    # provides the feed.  The default action is 'commands'; multiple
+    # commands can be provided from the same feed.
+    #
+    # Note that ubiquity controllers must also be identified as controllers
+    # using the '::controller' resource id.
+    #
+    # See Tap::Ubiquity::Utils for more information.
+    #
+    # :startdoc:::+
     class Ubiquity < Tap::Controller
       UBIQUITY_WEBSITE = "http://labs.mozilla.com/projects/ubiquity/"
-     
+      
+      include Utils
+      
+      # Renders an index of the available feeds.
       def index
         link = {:uri => request['uri'], :name => request['name']}
         render 'index.erb', :locals => {:feeds => feeds, :link => link}
       end
-    
+      
+      # Serves the echo and alert actions as examples of standard and
+      # javascript injection commands.
+      def commands
+        serve command(:echo) + js_injection(:alert)
+      end
+      
+      # An example of a command action.
+      def echo
+        input = request['input']
+        if request.get? 
+          "Got: #{input}"
+        else
+          render 'echo.erb', :locals => {:input => input}
+        end
+      end
+      
+      # An example of a js_injection action.
+      def alert
+        response['Content-Type'] = 'text/plain'
+        "alert('#{request['input']}')"
+      end
+      
       protected
       
+      # helper to provide the ubiquity website
       def ubiquity_website
         UBIQUITY_WEBSITE
       end
     
+      # Returns an array of (uri, key) arrays identifying command feeds.
+      # The uris are relative to the domain and so require a server with
+      # a router.
       def feeds
         env_names = {}
         server.env.minimap.each do |env_name, env|
@@ -29,10 +78,12 @@ module Tap
         server.env.each do |env|
           env_name = env_names[env]
         
-          env.constant_manifest(:ubiquity).minimap.each do |name, constant|
+          env.manifest(:ubiquity).minimap.each do |name, constant|
             action = constant.comment.strip
             action = 'commands' if action.empty?
-            feeds << [server.uri(name, action), "#{env_name}:#{name}"]
+            key = "#{env_name}:#{name}"
+            
+            feeds << ["/#{escape(key)}/#{action}", key]
           end
         end
       

data/lib/tap/ubiquity/utils.rb

@@ -1,10 +1,11 @@
 require 'json'
+require 'tap/controller/extname'
 
 module Tap
   module Ubiquity
     
     # Utils provides methods for serving ubiquity commands that link back to
-    # actions on a controller.  
+    # actions on a controller.
     #
     # :startdoc:::-
     #   # ::controller
@@ -25,120 +26,86 @@ module Tap
     #
     # Utils expects to be included in a Tap::Controller.
     module Utils
+      include Tap::Controller::Extname
       
       # Serves the command from the calling method.
       def serve(command)
-        response['Content-Type'] = 'application/x-javascript'
-        command
+        if extname == '.js'
+          response['Content-Type'] = 'application/x-javascript'
+          command
+        else
+          caller[0] =~ /in\W+(\w+)\W$/
+          "<pre>#{command}</pre>#{command_link(uri($1))}"
+        end
       end
       
       # Returns the link tag for subscribing to a ubiquity command served
       # from the specified action.
       def command_link(href)
-        "<link rel='commands' href='#{href}' />"
+        "<link rel='commands' href='#{href}.js' />"
       end
       
-      # Formats a Ubiquity command that calls action with an 'input' parameter
-      # containing the currently selected text.  If the request is a get, the
-      # action results will be set in the preview box.  Otherwise the current
-      # page is redirected to the action url.
+      # Returns a ubiquity command to redirect to action.  The action may
+      # respond differentl to GET and POST requests; GET results will be
+      # displayed in the preview box and the browser will be redirected
+      # to view POST results.
+      #
+      # The action will be called with an 'input' parameter that provides
+      # the currently selected text in the browser.
+      #
+      # ==== Example
+      #
+      #   class Sample < Tap::Controller
+      #     include Ubiquity::Utils
+      # 
+      #     def commands
+      #       serve command(:echo)
+      #     end
+      #
+      #     def echo
+      #       input = request['input']
+      #       request.get? ? "got: #{input}" : "received: #{input}"
+      #     end
+      #   end
       #
       #-- TODO
       # name should be minipath, not action
-      def command(action, attrs={})
-        attrs = {:name => action}.merge(attrs)
-%Q{
-var cmd = #{attrs.to_json};
-cmd.takes = {"selection": noun_arb_text};
-cmd.preview = function( pblock, selection ) {
-  jQuery.ajax({
-    type: 'GET',
-    url: '#{uri(action)}',
-    data: {input: selection.text},
-    success: function(data) { 
-      pblock.innerHTML = data;
-    },
-    error: function(XMLHttpRequest, textStatus, errorThrown) {
-      pblock.innerHTML = "Could not generate preview: " + errorThrown;
-    },
-  });
-};
-cmd.execute = function(selection) {
-  var document = Application.activeWindow.activeTab.document;
-
-  var form = document.createElement("form");
-  form.setAttribute('action', '#{uri(action)}');
-  form.setAttribute('style', 'display:none');
-  form.setAttribute('method', 'POST');
-
-  var input = document.createElement('input');
-  input.setAttribute('name', 'input');
-  input.setAttribute('type', 'text');
-  input.value = selection.text;
-  form.appendChild(input);
-
-  document.body.appendChild(form);
-  form.submit();
-};
-
-CmdUtils.CreateCommand(cmd);
-}
+      def command(action, cmd={})
+        render 'command.js', :locals => {
+          :cmd => {:name => action}.merge(cmd), 
+          :uri => uri(:action => action)
+        }
       end
       
+      # Returns a ubiquity command to inject javascript into the current
+      # page.  The javascript is returned by action and should have a
+      # 'text/plain' content type.  The action may respond differently to
+      # GET and POST requests; GET results will be displayed in the preview
+      # box while POST results will actually be injected.
+      #
+      # The action will be called with an 'input' parameter that provides
+      # the currently selected text in the browser.
+      #
+      # ==== Example
+      #
       #   class Sample < Tap::Controller
       #     include Ubiquity::Utils
       # 
       #     def commands
-      #       serve js_injection(:action)
+      #       serve js_injection(:alert)
       #     end
       #
-      #     def action
+      #     def alert
       #       response['Content-Type'] = 'text/plain'
       #       "alert('#{request['input']}')"
       #     end
       #   end
       #
-      def js_injection(action, attrs={}, inject=true)
-        attrs = {:name => action}.merge(attrs)
-%Q{
-var cmd = #{attrs.to_json};
-cmd.takes = {"selection": noun_arb_text};
-cmd.preview = function( pblock, selection ) {
-  jQuery.ajax({
-    type: 'GET',
-    url: '#{uri(action)}',
-    data: {input: selection.text},
-    success: function(data) { 
-      pblock.innerHTML = data;
-    },
-    error: function(XMLHttpRequest, textStatus, errorThrown) {
-      pblock.innerHTML = "Could not generate preview: " + errorThrown;
-    },
-  });
-};
-cmd.execute = function(selection) {
-  jQuery.ajax({
-    type: 'POST',
-    url: '#{uri(action)}',
-    data: {input: selection.text},
-    success: function(data) { 
-      if(#{inject ? 'true' : 'false'}) {
-        var doc = Application.activeWindow.activeTab.document;
-        var script = doc.createElement("script");
-        script.type = "text/javascript";
-        script.innerHTML = data;
-        doc.body.appendChild(script);
-      } else {
-        eval(data);
-      }
-    },
-    error: function(XMLHttpRequest, textStatus, errorThrown) {
-      displayMessage("Could not execute: " + errorThrown);
-    },
-  });
-};
-
-CmdUtils.CreateCommand(cmd);}
+      def js_injection(action, cmd={})
+        render 'js_injection.js', :locals => {
+          :cmd => {:name => action}.merge(cmd), 
+          :uri => uri(:action => action)
+        }
       end
     end
   end

data/tap-ubiquity.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "tap-ubiquity"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
   s.author = "Simon Chiang"
   s.email = "simon.a.chiang@gmail.com"
   s.homepage = "http://tap.rubyforge.org/ubiquity/"
@@ -27,7 +27,9 @@ Gem::Specification.new do |s|
     lib/tap/ubiquity/utils.rb
     tap-ubiquity.gemspec
     tap.yml
-    views/tap/ubiquity/ubiquity/commands.js
+    views/tap/ubiquity/ubiquity/echo.erb
     views/tap/ubiquity/ubiquity/index.erb
+    views/tap/ubiquity/utils/command.js
+    views/tap/ubiquity/utils/js_injection.js
   }
 end

data/views/tap/ubiquity/ubiquity/echo.erb

@@ -0,0 +1,5 @@
+<h1>Recieved:</h1>
+<blockquote>
+<%= input %>
+</blockquote>
+<p>Back to <a href="<%= uri %>">Tutorial</a></p>

data/views/tap/ubiquity/ubiquity/index.erb

@@ -1,15 +1,24 @@
-<h1>Welcome to Tap!</h1>
+<h1>Welcome!</h1>
 
-<p><a href="http://tap.rubyforge.org">Tap</a> interfaces with the web using <a href="<%= ubiquity_website %>">Ubiquity</a>.</p>
+<p><a href="http://tap.rubyforge.org">Tap</a> interfaces with the web using <a
+href="<%= ubiquity_website %>">Ubiquity</a>.</p>
+
+<h2>Tutorial</h2>
+<p>To get a sense for what is possible using this gem:</p>
 <ul>
+  <li>Subscribe to the 'tap-ubiquity:ubiquity' feed</li>
+  <li>Select some text on this page</li>
   <li>Press 'option' + 'space' to bring up a prompt</li>
+  <li>Type in 'echo' or 'alert' and hit enter</li>
 </ul>
 
-<% unless feeds.empty? %>
-<p>Subscribe to local feeds by clicking on the links below:</p>
+<p>You should see the selected text echoed back to you, either as a new web
+page or in an alert box. Your selection was sent to the server, processed by
+a controller written in ruby, and the result was displayed by the browser.</p>
+
+<h2>Feeds:</h2>
 <ul>
 <% feeds.each do |(uri, name)| %>
   <li><a href="<%= uri %>"><%= name %></a></li>
 <% end %>
-</ul>
-<% end %>
+</ul>

data/views/tap/ubiquity/utils/command.js

@@ -0,0 +1,34 @@
+var cmd = <%= cmd.to_json %>;
+cmd.takes = {"selection": noun_arb_text};
+cmd.preview = function( pblock, selection ) {
+  jQuery.ajax({
+    type: 'GET',
+    url: '<%= uri %>',
+    data: {input: selection.text},
+    success: function(data) { 
+      pblock.innerHTML = data;
+    },
+    error: function(XMLHttpRequest, textStatus, errorThrown) {
+      pblock.innerHTML = "Could not generate preview: " + errorThrown;
+    },
+  });
+};
+cmd.execute = function(selection) {
+  var document = Application.activeWindow.activeTab.document;
+
+  var form = document.createElement("form");
+  form.setAttribute('action', '<%= uri %>');
+  form.setAttribute('style', 'display:none');
+  form.setAttribute('method', 'POST');
+
+  var input = document.createElement('input');
+  input.setAttribute('name', 'input');
+  input.setAttribute('type', 'text');
+  input.value = selection.text;
+  form.appendChild(input);
+
+  document.body.appendChild(form);
+  form.submit();
+};
+
+CmdUtils.CreateCommand(cmd);

data/views/tap/ubiquity/utils/js_injection.js

@@ -0,0 +1,34 @@
+var cmd = <%= cmd.to_json %>;
+cmd.takes = {"selection": noun_arb_text};
+cmd.preview = function( pblock, selection ) {
+  jQuery.ajax({
+    type: 'GET',
+    url: '<%= uri %>',
+    data: {input: selection.text},
+    success: function(data) { 
+      pblock.innerHTML = data;
+    },
+    error: function(XMLHttpRequest, textStatus, errorThrown) {
+      pblock.innerHTML = "Could not generate preview: " + errorThrown;
+    },
+  });
+};
+cmd.execute = function(selection) {
+  jQuery.ajax({
+    type: 'POST',
+    url: '<%= uri %>',
+    data: {input: selection.text},
+    success: function(data) { 
+      var doc = Application.activeWindow.activeTab.document;
+      var script = doc.createElement("script");
+      script.type = "text/javascript";
+      script.innerHTML = data;
+      doc.body.appendChild(script);
+    },
+    error: function(XMLHttpRequest, textStatus, errorThrown) {
+      displayMessage("Could not execute: " + errorThrown);
+    },
+  });
+};
+
+CmdUtils.CreateCommand(cmd);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap-ubiquity
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-25 00:00:00 -06:00
+date: 2009-06-17 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,8 +47,10 @@ files:
 - lib/tap/ubiquity/utils.rb
 - tap-ubiquity.gemspec
 - tap.yml
-- views/tap/ubiquity/ubiquity/commands.js
+- views/tap/ubiquity/ubiquity/echo.erb
 - views/tap/ubiquity/ubiquity/index.erb
+- views/tap/ubiquity/utils/command.js
+- views/tap/ubiquity/utils/js_injection.js
 - MIT-LICENSE
 - README
 - History

data/views/tap/ubiquity/ubiquity/commands.js

@@ -1,88 +0,0 @@
-var Dispatch = {
-  
-  /* Sends a preview request from the server and sets the preview
-   * block innerHTML on success. */
-  preview: function(pblock, data) {
-    jQuery.ajax({
-      type: "GET",
-      url: "<%= uri(:dispatch) %>",
-      data: data,
-      dataType: 'html',
-      success: function(html, textStatus) {
-        pblock.innerHTML = html;
-      },
-      error: function(XMLHttpRequest, textStatus, errorThrown) {
-        Dispatch.ping("Error generating preview: " + textStatus);
-      },
-    });
-  },
-  
-  /* Sends an execute request to the server.  A successful response is a
-   * JSON object specifying 'inject' (true or false) and 'script'.  The
-   * script is injected into the DOM as a <script> tag if inject is true,
-   * or evaluated in the context of Ubiquity if inject is false.
-   */
-  execute: function(data) {
-    jQuery.ajax({
-      type: "POST",
-      url: "<%= uri(:dispatch) %>",
-      data: data,
-      dataType: 'json',
-      success: function(json, textStatus) {
-        if(json.inject) {
-          var doc = Application.activeWindow.activeTab.document;
-          var script = doc.createElement("script");
-          script.type = "text/javascript";
-          script.innerHTML = json.script;
-          doc.body.appendChild(script);
-        } else {
-          eval(json.script);
-        }
-      },
-      error: function(XMLHttpRequest, textStatus, errorThrown) {
-        Dispatch.ping("Error executing command: " + textStatus);
-      },
-    });
-  },
-  
-  /* Pings the server to check if it is active. */
-  ping: function(active_msg) {
-    jQuery.ajax({
-      type: "GET",
-      url: "<%= uri(:ping) %>",
-      success: function(response, textStatus) {
-        displayMessage(active_msg);
-      },
-      error: function(XMLHttpRequest, textStatus, errorThrown) {
-        displayMessage("No server is active at: <%= uri %>");
-      },
-    });
-  },
-};
-
-/////////////////////////////////////////////////////////////////////////////
-//
-// Generated Commands
-//
-/////////////////////////////////////////////////////////////////////////////
-
-<% commands.each do |cmd| %>
-CmdUtils.CreateCommand({
-  name: "<%= cmd[:name] %>",
-  description: "<%= cmd[:description] %>",
-  help: "<%= cmd[:help] %>",
-  takes: {"what": noun_arb_text},
-  
-  data: function(what) {
-    return {what: what.text, name: '<%= cmd[:name] %>'};
-  },
-  
-  preview: function(pblock, what) {
-    Dispatch.preview(pblock, this.data(what));
-  },
-  
-  execute: function(what) {
-    Dispatch.execute(this.data(what));
-  },
-});
-<% end %>