ape 1.0.0 → 1.5.0

data/lib/ape/reporters/atom_reporter.rb

@@ -0,0 +1,51 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+module Ape
+  class AtomReporter < Reporter
+    def escape(text)
+      Escaper.escape(text)
+    end
+    
+    def now
+      DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
+    end
+    
+    def id
+      id = ''
+      5.times { id += rand(1000000).to_s }
+      "tag:tbray.org,2005:#{id}"
+    end
+    
+    def content(step, dialog = nil)
+      xml = "<div xmlns=\"http://www.w3.org/1999/xhtml\">"
+      lines = step.split("\n")
+      lines[0 .. -2].each do |line|
+        xml += "#{line} <br/>"
+      end
+      xml += escape(lines[-1]) if lines[-1]
+      if dialog && dialogs[dialog]        
+        xml += '<div>'
+            xml += 'To server:'
+            dialogs[dialog].grep(/^>/).each do |crumb|
+              xml += show_message(crumb, :to)
+            end
+        xml += '</div>'
+        xml += '<div>'
+            xml += 'From server:'
+            dialogs[dialog].grep(/^</).each do |crumb|
+              xml += show_message(crumb, :from)
+            end
+        xml += '</div>'
+      end
+      xml += '</div>'
+      xml
+    end
+    
+    def report(output = STDOUT)      
+      output.puts evaluate_template("reporters/atom_template.eruby")
+    end
+  end
+end

data/lib/ape/reporters/atom_template.eruby

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+    <id><%= id %></id>
+    <author><name>The ape</name></author>
+    <title>Atom Protocol Exerciser Report</title>
+    <updated><%= now %></updated>    
+    <subtitle><%= errors.length == 1?"1 error":"#{errors.length} errors"%>, <%= warnings.length == 1?"1 warning":"#{warnings.length} warnings"%></subtitle>    
+    <% steps.each do |step| %>
+        <% if step.kind_of?(Array) %>
+            <entry>
+                <id><%= id %></id>
+                <title type="html"><%= "INFO: #{step[0]}"%></title>
+                <updated><%= now %></updated>
+                <category term="info"/>
+                <content type="xhtml">
+                    <% step[1..-1].each do |li| %>
+                    <%= content(li[:message]) %>
+                    <% end %>
+                </content>
+            </entry>            
+        <% else %>
+            <% if step[:severity] == :debug %>
+              <% @dialog = step[:message] %>
+            <% else %>
+                <entry>
+                    <id><%= id %></id>
+                    <title type="html"><%= step[:severity].to_s.upcase%>: <%= step[:message] %></title>
+                    <updated><%= now %></updated>
+                    <category term="<%= step[:severity].to_s %>"/>
+                    <content type="xhtml">
+                    <%= content(step[:message], @dialog) %>
+                    </content>
+                </entry>
+                <% @dialog = nil %>
+            <% end %>            
+        <% end %>
+    <% end %>
+</feed>

data/lib/ape/reporters/html_reporter.rb

@@ -0,0 +1,53 @@
+require 'erubis'
+module Ape
+  class HtmlReporter < Reporter    
+    
+    def static_dir      
+      dir = (server != true)?File.expand_path(File.dirname(__FILE__) + '/../../..') : ''
+      dir += "/web"
+      dir
+    end
+    
+    def stylesheet
+      static_dir + '/ape.css'
+    end
+    
+    def mark(mark)
+      span = "<span class=\"#{mark.to_s}\">"
+      case mark
+      when :success        
+        span << '&#x2713;' << '</span>'
+      when :warning
+        span << '?' << '</span>'
+      when :error
+        span << '!' << '</span>'
+      when :info
+        span = "<img class=\"info\" src=\"#{static_dir + '/info.png'}\"/>"
+      end      
+    end
+    
+    def report_li(step, dialog = nil, marker = nil)
+      html = '<li>'
+      if marker
+        html += "#{mark(marker)} "
+      end      
+      # preserve line-breaks in output
+      lines = step.split("\n")
+      lines[0 .. -2].each do |line|
+        html += "#{line} <br/>"
+      end
+      html += lines[-1] if lines[-1]
+      if dialog
+        html += "<a class=\"diaref\" href=\"#dia-#{@dianum}\">[Dialog]</a>"
+        @diarefs[dialog] = @dianum
+        @dianum += 1
+      end
+      html += '</li>'
+      html
+    end
+    
+    def report(output = STDOUT)      
+      output.puts evaluate_template("reporters/html_template.eruby")
+    end
+  end
+end

data/lib/ape/reporters/html_template.eruby

@@ -0,0 +1,62 @@
+<html>
+    <head>
+    <title>Atom Protocol Exerciser Report</title>
+    <link rel="stylesheet" type="text/css" href="<%= stylesheet %>" />
+    </head>
+    <body>
+    <h2>The Ape says:</h2>
+    <% if header %>
+        <p><%= header %></p>
+        <p>Summary: <%= errors.length == 1?"1 error":"#{errors.length} errors"%>, 
+            <%= warnings.length == 1?"1 warning":"#{warnings.length} warnings"%>
+        </p>
+    <% end %>
+    <ol id="steps">
+    <% steps.each do |step| %>
+      <% if step.kind_of?(Array) %>
+        <li>
+          <p><%= mark(:info) %> <%= step[0] %></p>
+          <ul>
+            <% step[1..-1].each do |li| %>
+                <%= report_li(li[:message]) %>
+            <% end %>            
+          </ul>
+        </li>
+      <% else %>
+        <% if step[:severity] == :debug %>
+          <% @dialog = step[:message] %>
+        <% else %>
+          <%= report_li(step[:message], @dialog, step[:severity])%>
+          <% @dialog = nil %>
+        <% end %>
+      <% end %>
+    <% end %>
+    </ol>
+    
+    <% if footer %>
+      <p><%= footer %></p>
+    <% end %>
+    
+    <% unless dialogs.empty? %>
+      <h2>Recorded client/server dialogs</h2>
+      <% diarefs.each do |k, v| %>
+        <% @dialog = @dialogs[k] %>
+        <h3 id="<%="dia-#{v}"%>"><%= k %></h3>
+        <div class="dialog">
+          <div class="dialab">
+            To server:
+            <% @dialog.grep(/^>/).each do |crumb| %>
+                <%= show_message(crumb, :to) %>
+            <% end %>            
+          </div>
+          <div class="dialab">
+            From server:
+            <% @dialog.grep(/^</).each do |crumb| %>
+                <%= show_message(crumb, :from) %>
+            <% end %>            
+          </div>
+        </div>
+      <% end %>
+    <% end %>
+    </body>
+</html>

data/lib/ape/reporters/text_reporter.rb

@@ -0,0 +1,37 @@
+module Ape
+  class TextReporter < Reporter
+    def report(output = STDOUT)
+      if @header
+        output.puts @header 
+        output.puts errors.length == 1?"1 error":"#{errors.length} errors"
+        output.puts warnings.length == 1?"1 warning":"#{warnings.length} warnings"
+      end
+      steps.each do |step|
+        if step.class == Crumbs
+          output.puts "   Dialog:"
+          step.each { |crumb| output.puts "     #{crumb}" }
+        else
+          line
+          if (step.kind_of?Array)
+            output.puts "INFO: #{step[0]}"
+            step[1..-1].each do |li|
+              lines = li[:message].split("\n")
+              lines[0..-2].each do |line|
+                output.puts("\t #{line} \n")
+              end
+              output.puts("\t #{lines[-1]}") if lines[-1]
+            end
+          else          
+            case step[:severity]
+            when :warning, :error            
+              output.puts "#{step[:severity].to_s.upcase}: #{step[:message]}"
+            else            
+              output.puts step[:message]
+            end
+          end
+        end
+        output.puts @footer if @footer
+      end
+    end
+  end
+end

data/lib/ape/samples.rb

@@ -1,4 +1,4 @@
-#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
 #   Use is subject to license terms - see file "LICENSE"
 require 'rexml/xpath'
 require 'date'
@@ -6,17 +6,23 @@ require 'base64'
 require 'erubis'
 
 module Ape
+  class SamplesContext < Erubis::Context
+    def now
+      DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
+    end
+    def id
+      id = ''
+      5.times { id += rand(1000000).to_s }
+      "tag:tbray.org,2005:#{id}"
+    end
+  end
+  
   class Samples
     
      @@service_schema = nil
      @@categories_schema = nil
      @@atom_schema = nil
-     @@home = nil
      
-     def Samples.home=(home)
-       @@home = home
-     end
-
     def Samples.foreign_child
       'subject'
     end
@@ -28,13 +34,7 @@ module Ape
     end
     
     def Samples.load_schema(file_name)
-      schema = ""
-      File.open(File.join(File.dirname(__FILE__), "/samples/#{file_name}_schema.txt")) do |file|
-        while(line = file.gets)
-          schema << line
-        end
-      end
-      schema
+      IO.read(File.join(File.dirname(__FILE__), "/../../samples/#{file_name}_schema.txt"))      
     end
       
     def Samples.service_RNC
@@ -52,15 +52,7 @@ module Ape
     @@atom_schema
   end
 
-  #recipe from cap
-  def Samples.home_directory
-      ENV["HOME"] || (ENV["HOMEPATH"] && "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}") ||
-          "/"
-  end
   
-  def Samples.home
-    @@home || ENV["APE_HOME"] || File.join(home_directory,".ape")
-  end
   
     def Samples.make_id
       id = ''
@@ -69,57 +61,44 @@ module Ape
     end
     
     def Samples.entry_path(type)
-      File.exist?(File.join(home, "/#{type}.eruby"))?
-        File.join(home, "/#{type}.eruby") :
-        File.join(File.dirname(__FILE__), "/samples/#{type}.eruby")
+      File.exist?(File.join(Ape.home, "/#{type}.eruby"))?
+        File.join(Ape.home, "/#{type}.eruby") :
+        File.join(File.dirname(__FILE__), "/../../samples/#{type}.eruby")
     end
     
     def Samples.load_template(type)
-      entry_path = entry_path(type)
-      input = File.read(entry_path)
-      eruby = Erubis::Eruby.new(input)
+      Erubis::FastEruby.new(IO.read(entry_path(type)))      
     end
     
     
     def Samples.mini_entry
-      eruby = load_template('mini_entry')
-      
-      now = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
-      id = make_id
-      
-      eruby.result(binding())
+      load_template('mini_entry').evaluate(SamplesContext.new)      
     end
 
     def Samples.basic_entry
-      eruby = load_template('basic_entry')
+      eruby = load_template('basic_entry')      
+       
+      context = SamplesContext.new(        
+        :title => Escaper.escape('From the <APE> (サル)'),
+        :subject => Names::DcNamespace
+      )
+      context[:summary] = "Summary from the &lt;b>&amp;lt;&amp;nbsp;APE&amp;nbsp;>&lt;/b> at #{context.now}"
       
-      id = make_id
-      now = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
-      title = Escaper.escape('From the <APE> (サル)')
-      summary = "Summary from the &lt;b>&amp;lt;&amp;nbsp;APE&amp;nbsp;>&lt;/b> at #{now}"
-      subject = Names::DcNamespace
-      
-      eruby.result(binding())
+      eruby.evaluate(context)
     end
     
     def Samples.unclean_xhtml_entry
-      eruby = load_template('unclean_xhtml_entry')
-      
-      id = make_id
-      now = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
-      
-      eruby.result(binding())
+      load_template('unclean_xhtml_entry').evaluate(SamplesContext.new)      
     end
 
     def Samples.cat_test_entry
-      e = retitled_entry('Testing category posting')
+      retitled_entry('Testing category posting')
     end
 
     def Samples.retitled_entry(new_title, new_id = nil)
       e = basic_entry
-      e.gsub!(/<title>.*<\/title>/, "<title>#{new_title}</title>")
-      new_id = make_id unless new_id
-      e.gsub(/<id>.*<\/id>/, "<id>#{new_id}</id>")
+      e.gsub!(/<title>.*<\/title>/, "<title>#{new_title}</title>")      
+      e.gsub(/<id>.*<\/id>/, "<id>#{new_id}</id>") if new_id
     end
 
     def Samples.picture

data/lib/ape/server.rb

@@ -4,18 +4,30 @@ require 'ape/handler'
 require 'ape/samples'
 
 module Ape
+  
+  # Manages and initializes the Mongrel handler. See run for more details.
   class Server
+    
+    # Starts the Mongrel handler with options given in +options+ and
+    # maps the <b>/</b>, <b>/ape</b> and <b>/atompub/go</b> URIs to handlers.
+    #
+    # ==== Options
+    #  * :host - the IP address to bind to
+    #  * :port - the port number to listen on
+    #  * :directory - the ape home directory
     def self.run(options)      
-      Samples.home = options[:home]
+      Ape.home = options[:home]
       
       mongrel = Mongrel::Configurator.new(:host => options[:host], :port => options[:port]) do
         log "=> Booting mongrel"
         begin
           log "=> The ape starting on http://#{options[:host]}:#{options[:port]}"
           listener do
-            redirect '/', '/ape/index.html'
-            uri '/ape', :handler => Mongrel::DirHandler.new(File.dirname(__FILE__) + '/layout', true)
-            uri '/atompub/go', :handler => Handler.new    
+            redirect '/', '/web/index.html'
+            uri '/web', :handler => 
+              Mongrel::DirHandler.new(
+                File.expand_path(File.dirname(__FILE__) + '/../../web'), true)
+            uri '/atompub/go', :handler => Handler.new
           end
         rescue Errno::EADDRINUSE
           log "ERROR: Address (#{options[:host]}:#{options[:port]}) is already in use"

data/lib/ape/service.rb

@@ -1,4 +1,4 @@
-#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
 #   Use is subject to license terms - see file "LICENSE"
 require 'rexml/xpath'
 

data/lib/ape/util.rb

@@ -0,0 +1,67 @@
+module Ape
+  module Util
+    def self.included(base)
+      base.extend ClassMethods
+      include InstanceMethods
+    end
+    
+    module InstanceMethods
+=begin
+    Get a resource, optionally check its content-type
+=end
+    def check_resource(uri, name, content_type = nil, report = true)
+      resource = Getter.new(uri, @authent)
+
+      # * Check the URI
+      if resource.last_error
+        reporter.error(self, "Unacceptable #{name} URI: " + resource.last_error, name) if report
+        return nil
+      end
+
+      # * Get it, make sure it has the right content-type
+      worked = resource.get(content_type)
+      reporter.save_dialog(name, resource)
+
+      reporter.security_warning(self) if (resource.security_warning)
+
+      if !worked
+        # oops, couldn't even get get it
+        reporter.error(self, "#{name} failed: " + resource.last_error, name) if report
+        return nil
+
+      elsif resource.last_error
+        # oops, media-type problem
+        reporter.error(self, "#{name}: #{resource.last_error}", name) if report
+
+      else
+        # resource fetched and is of right type
+        reporter.success(self, "#{name}: it exists and is served properly.", name) if report
+      end
+
+      return resource
+    end
+  end
+    
+    module ClassMethods
+=begin
+  Resolve extensions into the lib directory or into the ape home directory. These extensions could be validators,
+resolvers or samples.
+=end    
+      def resolve_plugin(key, dir, suffix, drop_underlines = false)
+        [File.dirname(__FILE__), Ape.home].each do |path|
+          Dir[File.join(path, "#{dir}/*.rb")].each do |file|
+            require file
+            plugin_name = file.gsub(/(.+\/#{dir}\/)(.+)(_#{suffix}.rb)/, '\2')
+            plugin_name.gsub!(/_/, '') if drop_underlines
+            plugin_class = file.gsub(/(.+\/#{dir}\/)(.+)(.rb)/, '\2').gsub(/(^|_)(.)/) { $2.upcase }
+
+            if (key.to_s.strip.downcase.include?(plugin_name))
+              return eval("#{plugin_class}.new", binding, __FILE__, __LINE__)            
+            end
+          end
+        end
+        return nil
+      end
+    end
+  end
+end