ape 1.0.0 → 1.5.0

data/lib/ape/atomURI.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 'uri'
 

data/lib/ape/authent.rb

@@ -1,14 +1,16 @@
-#   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"
 
 module Ape
   class AuthenticationError < StandardError ; end
   
-  class Authent  
+  class Authent
+    require File.dirname(__FILE__) + '/util.rb'
+    include Ape::Util
+    
     def initialize(username, password, scheme=nil)
       @username = username
-      @password = password
-      @auth_plugin = nil
+      @password = password      
     end
     
     def add_to(req, authentication = nil)
@@ -17,7 +19,7 @@ module Ape
         if authentication.strip.downcase.include? 'basic'
           req.basic_auth @username, @password
         else
-          @auth_plugin = resolve_plugin(authentication) unless @auth_plugin
+          @auth_plugin ||= load_plugin(authentication)
           @auth_plugin.add_credentials(req, authentication, @username, @password)
         end
       else
@@ -25,18 +27,10 @@ module Ape
       end
     end
     
-    def resolve_plugin(authentication)
-      Dir.glob(File.join(File.dirname(__FILE__), 'auth/*.rb')).each do |file|
-        plugin_name = file.gsub(/(.+\/auth\/)(.+)(_credentials.rb)/, '\2').gsub(/_/, '')
-        plugin_class = file.gsub(/(.+\/auth\/)(.+)(.rb)/, '\2').gsub(/(^|_)(.)/) { $2.upcase }
-        
-        if (authentication.strip.downcase.include?(plugin_name))
-          return eval("#{plugin_class}.new", binding, __FILE__, __LINE__)
-        end
-      end
-      raise AuthenticationError, "Unknown authentication method: #{authentication}"
+    def load_plugin(authentication)
+      plugin = Authent.resolve_plugin(authentication, 'auth', 'credentials', true)
+      plugin || (raise AuthenticationError, "Unknown authentication method: #{authentication}")
     end
   end
+  Dir[File.dirname(__FILE__) + '/auth/*.rb'].each { |l| require l }
 end
-
-Dir[File.dirname(__FILE__) + '/auth/*.rb'].each { |l| require l }

data/lib/ape/categories.rb

@@ -1,3 +1,4 @@
+#   Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
 #   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
 #   Use is subject to license terms - see file "LICENSE"
 
@@ -8,7 +9,7 @@ module Ape
   class Categories
     attr_reader :fixed
 
-    def Categories.from_collection(collection, authent, ape=nil)
+    def Categories.from_collection(collection, authent, reporter = nil)
 
       # "catses" because if cats is short for categories, then catses 
       #  suggests multiple <app:categories> elements
@@ -18,17 +19,17 @@ module Ape
         if cats.attribute(:href)
           getter = Getter.new(cats.attribute(:href).value, authent)
           if getter.last_error # wonky URI
-            ape.error getter.last_error if ape
+            reporter.error(self, getter.last_error) if reporter
             nil
           end
 
           if !getter.get('application/atomcat+xml')
-            ape.error "Can't fetch categories doc " + 
-              "'#{cats.attribute(:href).value}': getter.last_error" if ape
+            reporter.error(self, "Can't fetch categories doc " + 
+              "'#{cats.attribute(:href).value}': getter.last_error") if reporter
             nil
           end
 
-          ape.warning(getter.last_error) if ape && getter.last_error
+          reporter.warning(self, getter.last_error) if reporter && getter.last_error
           REXML::Document.new(getter.body).root
         else
           # no href attribute
@@ -46,7 +47,7 @@ module Ape
   #  at least one with fixed="no", also add a syntho-cat that we make up.
   #  Return the list of categories that we added.
   #
-  def Categories.add_cats(entry, collection, authent, ape=nil)
+  def Categories.add_cats(entry, collection, authent, reporter = nil)
 
     added = []
     c = from_collection(collection, authent)
@@ -68,7 +69,7 @@ module Ape
             # for each <app:category> take the first one whose attribute "term" is not empty
             cat_list.each do |cat|
               if cat.attributes['term'].empty?
-                ape.warning 'A mangled category is present in your categories list' if ape
+                reporter.warning(self, 'A mangled category is present in your categories list') if reporter
               else
                 scheme = cat.attributes['scheme']
                 if !scheme

data/lib/ape/collection.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'
 
@@ -12,9 +12,7 @@ module Ape
       @title = REXML::XPath.first(input, './atom:title', Names::XmlNamespaces)
 
       # sigh, RNC validation *should* take care of this
-      unless @title
-        raise(SyntaxError, "Collection is missing required 'atom:title'")
-      end
+      raise(SyntaxError, "Collection is missing required 'atom:title'") unless @title
       @title = @title.texts.join
 
       if doc_uri
@@ -30,9 +28,7 @@ module Ape
         @accept << a.texts.join
       end
 
-      if @accept.empty?
-        @accept = [ Names::AtomEntryMediaType ]
-      end
+      @accept = [ Names::AtomEntryMediaType ] if @accept.empty?
     end
 
     def to_s

data/lib/ape/crumbs.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"
 
 # All the methods (getter/poster/putter/deleter) use the set_debug_output method

data/lib/ape/entry.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/document'

data/lib/ape/escaper.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"
 module Ape
   class Escaper

data/lib/ape/feed.rb

@@ -1,16 +1,26 @@
-#   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 File.dirname(__FILE__) + '/util.rb'
 require 'rexml/document'
 require 'rexml/xpath'
 
 module Ape
   class Feed
+    extend Ape::Util
+    
+    def Feed.reporter
+      @@reporter
+    end
+    
+    def Feed.reporter=(reporter)
+      @@reporter = reporter
+    end
+    
     # Load up a collection feed from its URI.  Return an array of <entry> objects.
     #  follow <link rel="next" /> pointers as required to get the whole
     #  collection
-    def Feed.read(uri, name, ape, report=true)
-
+    def Feed.read(uri, name, reporter, report = true)
+      Feed.reporter = reporter
       entries = []
       uris = []
       next_page = uri
@@ -20,11 +30,13 @@ module Ape
 
         label = "Page #{page_num} of #{name}"
         uris << next_page
-        page = ape.check_resource(next_page, label, Names::AtomMediaType, report)
+        page = check_resource(next_page, label, Names::AtomMediaType, report)
         break unless page
 
         # * Validate it
-        Validator.validate(Samples.atom_RNC, page.body, label, ape) if report
+        Validator.instance(:schema, reporter).validate(:schema => Samples.atom_RNC, 
+          :title => label, :doc => page) if report
+        #Validator.validate(Samples.atom_RNC, page.body, label, ape.reporter) if report
 
         # XML-parse the feed
         error = "not well-formed"
@@ -36,19 +48,19 @@ module Ape
           feed = nil
         end
         if feed == nil
-          ape.error "Can't parse #{label} at #{next_page}, Parser said: #{$!}" if report
+          reporter.error(self, "Can't parse #{label} at #{next_page}, Parser said: #{$!}") if report
           break
         end
 
         feed = feed.root
         if feed == nil
-          ape.warning "#{label} is empty."
+          reporter.warning(self, "#{label} is empty.")
           break
         end
         
         page_entries = REXML::XPath.match(feed, "./atom:entry", Names::XmlNamespaces)
         if page_entries.empty? && report
-          ape.info "#{label} has no entries."
+          reporter.info(self, "#{label} has no entries.")
         end
 
         entries += page_entries.map { |e| Entry.new(e, next_page)}
@@ -59,7 +71,7 @@ module Ape
           base = AtomURI.new(next_page)
           next_link = base.absolutize(next_link, feed)
           if uris.index(next_link)
-            ape.error "Collection contains circular 'next' linkage: #{next_link}" if report
+            reporter.error(self, "Collection contains circular 'next' linkage: #{next_link}") if report
             break
           end
           page_num += 1
@@ -68,7 +80,7 @@ module Ape
       end
 
       if report && next_page
-        ape.warning "Stopped reading collection after #{page_num} pages." 
+        reporter.warning(self, "Stopped reading collection after #{page_num} pages.")
       end
 
       # all done unless we're error-checking
@@ -98,17 +110,17 @@ module Ape
           end
           if error
             title = e.child_content "title"
-            ape.error "In entry with title '#{title}', #{error}."
+            reporter.error(self, "In entry with title '#{title}', #{error}.")
             clean = false
           end
         end
       end
       if with_app_date < entries.size
-        ape.error "#{entries.size - with_app_date} of #{entries.size} entries in #{name} lack app:edited elements."
+        reporter.error(self, "#{entries.size - with_app_date} of #{entries.size} entries in #{name} lack app:edited elements.")
         clean = false
       end
 
-      ape.good "#{name} has correct app:edited value order." if clean
+      reporter.success(self, "#{name} has correct app:edited value order.") if clean
 
       entries
     end

data/lib/ape/handler.rb

@@ -3,7 +3,14 @@ require 'mongrel'
 require 'ape'
 
 module Ape
+  
+  # Implements the APE application handler for processing
+  # and responding to requests. See process for more detail.
   class Handler < Mongrel::HttpHandler
+    
+    # Called by Mongrel with Mongrel::HttpRequest and
+    # Mongrel::HttpResponse objects. Creates an Ape
+    # instance for the request and responds with its report.
     def process(request, response)
       cgi = Mongrel::CGIWrapper.new(request, response)
 
@@ -11,8 +18,6 @@ module Ape
       user = cgi['username'].strip
       pass = cgi['password'].strip
 
-#      invoke_ape uri, user, pass, request, response
-  
       if uri.empty?
         response.start(200, true) do |header, body|
           header['Content-Type'] = 'text/plain'
@@ -22,7 +27,7 @@ module Ape
       end
 
       format = request.params['HTTP_ACCEPT'] == 'text/plain' ? 'text' : 'html'
-      ape = Ape.new({ :crumbs => true, :output => format })
+      ape = Ape.new({ :crumbs => true, :output => format, :server => true })
       (user && pass) ? ape.check(uri, user, pass) : ape.check(uri)
 
       response.start(200, true) do |header, body|

data/lib/ape/html.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"
 
 module Ape

data/lib/ape/invoker.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 'net/https'
 

data/lib/ape/invokers/deleter.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 'net/http'
 

data/lib/ape/invokers/getter.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 'net/http'
 

data/lib/ape/invokers/poster.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 'net/http'
 

data/lib/ape/invokers/putter.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 'net/http'
 

data/lib/ape/names.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"
 
 module Ape

data/lib/ape/print_writer.rb

@@ -1,10 +1,8 @@
-#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
-#   Use is subject to license terms - see file "LICENSE"
-
-# this is a wrapper for the weird derived-from-PrintWriter class that comes
-#  out of HttpResponse.getWriter
-
+# Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
+# See the included LICENSE[link:/files/LICENSE.html] file for details.
 module Ape
+  # this is a wrapper for the weird derived-from-PrintWriter class that comes
+  # out of HttpResponse.getWriter
   class Printwriter
     def initialize(java_writer)
       @w = java_writer

data/lib/ape/reporter.rb

@@ -0,0 +1,156 @@
+module Ape
+  require 'erubis'
+  class Reporter < Erubis::Context
+    require File.dirname(__FILE__) + '/util.rb'
+    include Ape::Util
+    
+    attr_accessor :header, :footer, :debug, :dialogs, :diarefs, :dianum, :server
+    
+    def steps
+      @steps ||= []
+    end
+    
+    def self.instance(key, opts = {})
+      reporter = resolve_plugin(key, 'reporters', 'reporter')
+      raise StandardError, "Unknown reporter: #{key}, outputs supported: #{supported_outputs}" unless reporter
+      reporter.debug = opts[:debug] || false
+      reporter.server = opts[:server] || false
+      reporter.dialogs = {}
+      reporter.diarefs = {}
+      reporter.dianum = 1
+      reporter
+    end
+    
+    def self.supported_outputs
+      Dir[File.join(File.dirname(__FILE__), 'reporters/*.rb'),
+          File.join(Ape.home, 'reporters/*.rb')].map { |file|        
+        file.gsub(/(.+\/reporters\/)(.+)(_reporter.rb)/, '\2').gsub(/_/, '')
+      }.sort.join(", ").downcase
+    end
+=begin
+  This method saves the messages that the validators send
+  === Parameters
+    * args[0] must be allways a reference to the validator.
+    * args[1] should be the severity of the message, but it could be an array if several steps are recorded at once.
+    * args[2] is the message to show.
+    * args[3] is the message group key if it exits
+=end
+    def add(*args)
+      if (args.length == 2 && args[1].kind_of?(Array))
+        steps << args[1]
+      elsif (args.length == 3)
+        steps << {:severity => args[1], :message => args[2]}
+      else
+        steps << {:severity => :debug, :message => args[3]}
+        show_crumbs(args[3]) if debug
+        steps << {:severity => args[1], :message => args[2], :key => args[3]}        
+      end
+      puts "#{steps[-1][:severity].to_s.upcase}: #{steps[-1][:message]}" if debug && !steps[-1].kind_of?(Array)
+    end
+    
+    def security_warning(validator)
+      unless (@sec_warning_writed)
+        warning(validator, "Sending authentication information over an open channel is not a good security practice.", name)
+        @sec_warning_writed = true
+      end
+    end
+    
+    def warning(validator, message, crumb_key=nil)
+      unless crumb_key
+        add(validator, :warning, message)
+      else
+        add(validator, :warning, message, crumb_key)
+      end
+    end
+
+    def error(validator, message, crumb_key=nil)
+      unless crumb_key
+        add(validator, :error, message)
+      else
+        add(validator, :error, message, crumb_key)
+      end
+    end
+
+    def success(validator, message, crumb_key=nil)
+      unless crumb_key
+        add(validator, :success, message)
+      else
+        add(validator, :success, message, crumb_key)
+      end
+    end
+
+    def info(validator, message)
+      add(validator, :info, message)
+    end
+    
+    def start_list(validator, message)
+      add(validator, [ message + ":" ])
+    end
+
+    def list_item(message)
+      steps[-1] << {:severity => :debug, :message => message}
+    end
+    
+    def line(output=STDOUT)     
+      printf(output, "%2d. ", @lnum ||= 1)
+      @lnum += 1
+    end
+    
+    def save_dialog(name, actor)
+      dialogs[name] = actor.crumbs
+    end
+    
+    def show_crumbs(key)     
+      dialogs[key].each do |d|
+        puts "Dialog: #{d}"
+      end      
+    end
+    
+    def show_message(crumb, tf)
+      message = crumb[1 .. -1]
+      message.gsub!(/^\s*"/, '')
+      message.gsub!(/"\s*$/, '')
+      message.gsub!(/\\"/, '"')
+      message = Escaper.escape message
+      message.gsub!(/(\\r\\n|\\n|\\r)/, "\n<br/>")      
+      message.gsub!(/\\t/, '&#xa0;&#xa0;&#xa0;&#xa0;')
+      "<div class=\"#{tf.to_s}\">#{message}</div>"      
+    end
+    
+    def successes
+      select(:success)
+    end
+    
+    def infos
+      select(:info)
+    end
+    
+    def warnings
+      select(:warning)
+    end
+    
+    def errors
+      select(:error)
+    end
+    
+protected
+
+    def select(option)
+      steps.select { |step|
+        unless step.kind_of?(Array)
+          step.values.include?(option)
+        else
+          !step[1..-1].select {|dialog| dialog.values.include?(option)}.empty?
+        end
+      }
+    end
+    
+    def evaluate_template(name)
+      template = Erubis::FastEruby.new(IO.read(
+        File.expand_path(File.join(File.dirname(__FILE__), name))))
+      template.evaluate(self)
+    end
+    
+  end
+  Dir[File.dirname(__FILE__) + '/reporters/*.rb'].each { |l| require l }
+end