ape 1.0.0

data/lib/ape/escaper.rb

@@ -0,0 +1,29 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+module Ape
+  class Escaper
+    def Escaper.escape(text)
+      text.gsub(/([&<'">])/) do
+        case $1
+        when '&' then '&amp;'
+        when '<' then '&lt;'
+        when "'" then '&apos;'
+        when '"' then '&quot;'
+        when '>' then '&gt;'
+        end
+      end
+    end
+
+    def Escaper.unescape(text)
+      text.gsub(/&([^;]*);/) do
+        case $1
+        when 'lt' then '<'
+        when 'amp' then '&'
+        when 'gt' then '>'
+        when 'apos' then "'"
+        when 'quot' then '"'
+        end
+      end
+    end
+  end
+end

data/lib/ape/feed.rb

@@ -0,0 +1,117 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+# Use is subject to license terms - see file "LICENSE"
+
+require 'rexml/document'
+require 'rexml/xpath'
+
+module Ape
+  class Feed
+    # 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)
+
+      entries = []
+      uris = []
+      next_page = uri
+      page_num = 1
+
+      while (next_page) && (page_num < 10) do
+
+        label = "Page #{page_num} of #{name}"
+        uris << next_page
+        page = ape.check_resource(next_page, label, Names::AtomMediaType, report)
+        break unless page
+
+        # * Validate it
+        Validator.validate(Samples.atom_RNC, page.body, label, ape) if report
+
+        # XML-parse the feed
+        error = "not well-formed"
+        feed = nil
+        begin
+          feed = REXML::Document.new(page.body, { :raw => nil })
+        rescue Exception
+          error = $!.to_s
+          feed = nil
+        end
+        if feed == nil
+          ape.error "Can't parse #{label} at #{next_page}, Parser said: #{$!}" if report
+          break
+        end
+
+        feed = feed.root
+        if feed == nil
+          ape.warning "#{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."
+        end
+
+        entries += page_entries.map { |e| Entry.new(e, next_page)}
+        
+        next_link = REXML::XPath.first(feed, "./atom:link[@rel=\"next\"]", Names::XmlNamespaces)
+        if next_link
+          next_link = next_link.attributes['href']
+          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
+            break
+          end
+          page_num += 1
+        end
+        next_page = next_link
+      end
+
+      if report && next_page
+        ape.warning "Stopped reading collection after #{page_num} pages." 
+      end
+
+      # all done unless we're error-checking
+      return entries unless report
+
+      # Ensure that entries are ordered by app:edited
+      last_date = nil
+      with_app_date = 0
+      clean = true
+      entries.each do |e|
+        datestr = e.child_content("edited", Names::AppNamespace)
+        error = nil
+        if datestr
+          if datestr =~ /\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d+)?(Z|([-+]\d\d:\d\d))/
+            begin
+              date = Time.parse(datestr)
+              with_app_date += 1
+              if last_date && (date > last_date)
+                error = "app:edited values out of order, d #{date} ld #{last_date}"
+              end
+              last_date = date
+            rescue ArgumentError
+              error = "invalid app:edited value: #{datestr}"
+            end
+          else
+            error = "invalid app:edited child: #{datestr}"
+          end
+          if error
+            title = e.child_content "title"
+            ape.error "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."
+        clean = false
+      end
+
+      ape.good "#{name} has correct app:edited value order." if clean
+
+      entries
+    end
+  end
+end
+

data/lib/ape/handler.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'mongrel'
+require 'ape'
+
+module Ape
+  class Handler < Mongrel::HttpHandler
+    def process(request, response)
+      cgi = Mongrel::CGIWrapper.new(request, response)
+
+      uri  = cgi['uri'].strip
+      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'
+          body << 'URI argument is required'
+        end
+        return
+      end
+
+      format = request.params['HTTP_ACCEPT'] == 'text/plain' ? 'text' : 'html'
+      ape = Ape.new({ :crumbs => true, :output => format })
+      (user && pass) ? ape.check(uri, user, pass) : ape.check(uri)
+
+      response.start(200, true) do |header, body|
+        header['Content-Type'] = 'text/html'
+        ape.report(body)
+      end
+    end
+  end
+end

data/lib/ape/html.rb

@@ -0,0 +1,17 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+
+module Ape
+  class HTML
+    def HTML.error(message, output=STDOUT)
+      headers(output)
+      output.puts <<EndOfText
+  <title>Error: #{message}</title>
+  </head>
+  <body>
+  <h2>Error</h2>
+  <p>#{message}.</p>
+EndOfText
+    end
+  end
+end

data/lib/ape/invoker.rb

@@ -0,0 +1,54 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+require 'net/https'
+
+module Ape
+  class Invoker
+    attr_reader :last_error, :crumbs, :response
+    
+    def initialize(uriString, authent)
+      @last_error = nil
+      @crumbs = Crumbs.new
+      @uri = AtomURI.check(uriString)
+      if (@uri.class == String)
+        @last_error = @uri
+      end   
+      @authent = authent
+      @authent_checker = 0
+    end
+    
+    def header(which)
+      @response[which]
+    end
+    
+    def prepare_http
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      if @uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http.set_debug_output @crumbs if @crumbs
+      http
+    end
+    
+    def need_authentication?(req)
+      if @response.instance_of?(Net::HTTPUnauthorized) && @authent
+        #tries to authenticate just two times in order to avoid infinite loops
+        raise AuthenticationError, 'Authentication is required' unless @authent_checker <= 1
+        @authent_checker += 1
+        
+        @authent.add_to req, header('WWW-Authenticate')
+        #clean the request body attribute, if we don't do it http.request(req, body) will raise an exception
+        req.body = nil unless req.body.nil?
+        return true
+      end
+      return false 
+    end
+    
+    def restart_authent_checker
+      @authent_checker = 0
+    end  
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/invokers/*.rb'].each { |l| require l }

data/lib/ape/invokers/deleter.rb

@@ -0,0 +1,31 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+require 'net/http'
+
+module Ape
+  class Deleter < Invoker
+
+    def delete( req = nil )
+      req = Net::HTTP::Delete.new(AtomURI.on_the_wire(@uri)) unless req
+
+      begin
+        http = prepare_http
+        
+        http.start do |connection|
+          @response = connection.request(req)
+          
+          return delete(req) if need_authentication?(req)
+          restart_authent_checker
+          
+          return true if @response.kind_of? Net::HTTPSuccess
+
+          @last_error = @response.message
+          return false
+        end
+      rescue Exception
+        @last_error = "Can't connect to #{@uri.host} on port #{@uri.port}: #{$!}"
+        return nil
+      end
+    end
+  end
+end

data/lib/ape/invokers/getter.rb

@@ -0,0 +1,80 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+require 'net/http'
+
+module Ape
+  class Getter < Invoker
+    attr_reader :contentType, :charset, :body, :security_warning
+
+    def get(contentType = nil, depth = 0, req = nil)
+      req = Net::HTTP::Get.new(AtomURI.on_the_wire(@uri)) unless req
+      @last_error = nil
+
+      return false if document_failed?(depth, req)    
+      
+      begin
+        http = prepare_http
+       
+        http.start do |connection|
+          @response = connection.request(req)
+
+          if need_authentication?(req)
+            @security_warning = true unless http.use_ssl?
+            return get(contentType, depth + 1, req) 
+          end
+          restart_authent_checker
+          
+          case @response
+          when Net::HTTPSuccess
+            return getBody(contentType)
+            
+          when Net::HTTPRedirection
+            redirect_to = @uri.merge(@response['location'])
+            @uri = AtomURI.check(redirect_to)
+            return get(contentType, depth + 1)
+            
+          else
+            @last_error = @response.message
+            return false
+          end      
+        end
+      rescue Exception
+        @last_error = "Can't connect to #{@uri.host} on port #{@uri.port}: #{$!}"
+        return false
+      end
+    end
+
+    def document_failed?(depth, req)    
+      if (depth > 10)      
+        if need_authentication?(req)
+  	#Authentication required
+          @last_error = "Authentication is required"
+        else
+  	# too many redirects
+          @last_error = "Too many redirects"
+        end
+        return true
+      end
+      return false
+    end
+
+    def getBody contentType
+
+      if contentType
+        @contentType = @response['Content-Type']
+        # XXX TODO - better regex
+        if @contentType =~ /^([^;]*);/
+          @contentType = $1
+        end
+      
+        if contentType != @contentType
+          @last_error = "Content-type must be '#{contentType}', not '#{@contentType}'"
+        end
+      end
+        
+      @body = @response.body
+      return true
+    end
+  end
+end
+

data/lib/ape/invokers/poster.rb

@@ -0,0 +1,57 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+require 'net/http'
+
+module Ape
+  class Poster < Invoker
+    attr_reader :entry, :uri
+
+    def initialize(uriString, authent)
+      super uriString, authent
+      @headers = {}
+      @entry = nil
+    end
+    
+    def set_header(name, val)
+      @headers[name] = val
+    end
+
+    def post(contentType, body, req = nil)
+      req = Net::HTTP::Post.new(AtomURI.on_the_wire(@uri)) if req.nil?
+      req.set_content_type contentType
+      @headers.each { |k, v| req[k]= v }
+
+      begin
+        http = prepare_http
+        
+        http.start do |connection|
+          @response = connection.request(req, body)
+          
+          return post(contentType, body, req) if need_authentication?(req)
+          restart_authent_checker
+          
+          if @response.code != '201'
+            @last_error = @response.message
+            return false
+          end
+
+          if (!((@response['Content-type'] =~ %r{^application/atom\+xml}) ||
+                (@response['Content-type'] =~ %r{^application/atom\+xml;type=entry})))
+            return true
+          end
+
+          begin
+            @entry = Entry.new(@response.body)
+            return true
+          rescue ArgumentError
+            @last_error = @entry.broken
+            return false
+          end
+        end
+      rescue Exception
+        @last_error = "Can't connect to #{@uri.host} on port #{@uri.port}: #{$!}"
+        return false
+      end
+    end
+  end
+end

data/lib/ape/invokers/putter.rb

@@ -0,0 +1,46 @@
+#   Copyright © 2006 Sun Microsystems, Inc. All rights reserved
+#   Use is subject to license terms - see file "LICENSE"
+require 'net/http'
+
+module Ape
+  class Putter < Invoker
+    attr_reader :headers
+
+    def initialize(uriString, authent)
+      super uriString, authent
+      @headers = {}
+    end
+    
+    def set_header(name, val)
+      @headers[name] = val
+    end
+    
+    def put(contentType, body, req = nil)
+      req = Net::HTTP::Put.new(AtomURI.on_the_wire(@uri)) unless req
+      
+      req.set_content_type contentType
+      @headers.each { |k, v| req[k]= v }
+
+      begin
+        http = prepare_http
+        
+        http.start do |connection|
+          @response = connection.request(req, body)
+          
+          return put(contentType, body, req) if need_authentication?(req)
+          restart_authent_checker
+          
+          unless @response.kind_of? Net::HTTPSuccess
+            @last_error = @response.message
+            return false
+          end
+          
+          return true
+        end
+      rescue Exception
+        @last_error = "Can't connect to #{@uri.host} on port #{@uri.port}: #{$!}"
+        return nil
+      end
+    end
+  end
+end