tap-ubiquity 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009, Regents of the University of Colorado.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,18 @@
+= Tap-Ubiqity
+
+A gem making {Tap}[http://tap.rubyforge.org] available in
+{Ubiqity}[http://labs.mozilla.com/2008/08/introducing-ubiquity/]
+
+== Installation
+
+Tap-Ubiquity is available as a gem on
+RubyForge[http://rubyforge.org/projects/tap]. Use:
+
+  % gem install tap-ubiquity
+
+== Info 
+
+Copyright (c) 2009, Regents of the University of Colorado.
+Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com], {Biomolecular Structure Program}[http://biomol.uchsc.edu/], {Hansen Lab}[http://hsc-proteomics.uchsc.edu/hansenlab/] 
+Support:: CU Denver School of Medicine Deans Academic Enrichment Fund
+Licence:: {MIT-Style}[link:files/MIT-LICENSE.html]

data/lib/tap/ubiquity/ubiquity.rb

@@ -0,0 +1,45 @@
+require 'tap/controller'
+require 'json'
+
+module Tap
+  module Ubiquity
+  
+    # ::controller
+    class Ubiquity < Tap::Controller
+      def index
+        link = {:uri => request['uri'], :name => request['name']}
+        render 'index.erb', :locals => {:feeds => feeds, :link => link}
+      end
+    
+      protected
+    
+      def feeds
+        env_names = {}
+        server.env.minimap.each do |env_name, env|
+          env_names[env] = env_name
+        end
+      
+        feeds = []
+        server.env.each do |env|
+          env_name = env_names[env]
+        
+          env.controllers.minimap.each do |name, constant|
+            document = Lazydoc[constant.require_path]
+            document.resolve(nil, true)  # ?? why is force required ??
+            if comment = document[constant.name]['ubiquity']
+              action = comment.subject.strip
+              action = 'commands' if action.empty?
+              feeds << [
+                server.uri(name, action), 
+                "#{env_name}:#{name}", 
+                comment.content.join("\n").strip
+              ]
+            end
+          end
+        end
+      
+        feeds
+      end
+    end
+  end
+end

data/lib/tap/ubiquity/utils.rb

@@ -0,0 +1,156 @@
+require 'json'
+
+module Tap
+  module Ubiquity
+    
+    # Utils provides methods for serving ubiquity commands that link back to
+    # actions on a controller.  
+    #
+    # :startdoc:::-
+    #   # ::controller
+    #   # ::ubiquity
+    #   class Sample < Tap::Controller
+    #     include Ubiquity::Utils
+    # 
+    #     def commands
+    #       serve command(:action)
+    #     end
+    # 
+    #     def action
+    #       input = request['input']
+    #       request.get? ? "got: #{input}" : "received: #{input}"
+    #     end
+    #   end
+    # :startdoc:::+
+    #
+    # Utils expects to be included in a Tap::Controller.
+    module Utils
+      module_function
+      
+      # Serves the command from the calling method.
+      def serve(command)
+        if command_request?
+          response['Content-Type'] = 'application/x-javascript'
+          command
+        else
+          link = "<link rel='commands' href='#{command_href}' />"
+          block_given? ? yield(link) : link
+        end
+      end
+      
+      # Returns true if the current request indicates the command javascript
+      # should be returned by serve (ie the path_info ends with '.js')
+      def command_request?
+        File.extname(request.path_info) == '.js'
+      end
+      
+      # Returns the href that returns the command javascript.
+      def command_href
+        "#{uri(File.basename(request.path_info))}.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.
+      #
+      #-- 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);
+}
+      end
+      
+      #   class Sample < Tap::Controller
+      #     include Ubiquity::Utils
+      # 
+      #     def commands
+      #       serve js_injection(:action)
+      #     end
+      #
+      #     def action
+      #       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);}
+      end
+    end
+  end
+end

data/tap-ubiquity.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name = "tap-ubiquity"
+  s.version = "0.2.0"
+  s.author = "Simon Chiang"
+  s.email = "simon.a.chiang@gmail.com"
+  s.homepage = "http://tap.rubyforge.org/ubiquity/"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Making Tap available in Ubiquity"
+  s.require_path = "lib"
+  s.rubyforge_project = "tap"
+  s.add_dependency("tap-server", ">= 0.3.0")
+  s.add_dependency("json", ">= 1.1.3")
+  s.has_rdoc = true
+  s.rdoc_options.concat %W{--main README -S -N --title Tap\sUbiquity}
+  
+  # list extra rdoc files here.
+  s.extra_rdoc_files = %W{
+    MIT-LICENSE
+    README
+  }
+  
+  # list the files you want to include here. you can
+  # check this manifest using 'rake :print_manifest'
+  s.files = %W{
+    lib/tap/ubiquity/ubiquity.rb
+    lib/tap/ubiquity/utils.rb
+    tap-ubiquity.gemspec
+    tap.yml
+    views/tap/ubiquity/ubiquity/commands.js
+    views/tap/ubiquity/ubiquity/index.erb
+  }
+end

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

@@ -0,0 +1,88 @@
+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 %>

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

@@ -0,0 +1,18 @@
+<h1>Welcome to Tap!</h1>
+
+<p><a href="http://tap.rubyforge.org">Tap</a> interfaces with the web using <a href="">Ubiquity</a>.</p>
+<ul>
+  <li>Press 'option' + 'space' to bring up a prompt</li>
+</ul>
+
+<% unless feeds.empty? %>
+<p>Subscribe to local feeds by clicking on the links below:</p>
+<ul>
+<% feeds.each do |(uri, name, help)| %>
+  <li>
+    <a href="<%= uri %>"><%= name %></a>
+    <div><%= help %></div>
+  </li>
+<% end %>
+</ul>
+<% end %>

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: tap-ubiquity
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Simon Chiang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tap-server
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: 
+email: simon.a.chiang@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README
+files: 
+- lib/tap/ubiquity/ubiquity.rb
+- lib/tap/ubiquity/utils.rb
+- tap-ubiquity.gemspec
+- tap.yml
+- views/tap/ubiquity/ubiquity/commands.js
+- views/tap/ubiquity/ubiquity/index.erb
+- MIT-LICENSE
+- README
+has_rdoc: true
+homepage: http://tap.rubyforge.org/ubiquity/
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+- -S
+- -N
+- --title
+- Tap Ubiquity
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tap
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Making Tap available in Ubiquity
+test_files: []
+