ape 1.0.0 → 1.5.0

data/lib/ape/validators/media_posts_validator.rb

@@ -0,0 +1,104 @@
+module Ape
+  class MediaPostsValidator < Validator
+    disabled
+    requires_presence_of :media_collection
+    
+    def validate(opts = {})
+      reporter.info(self, "TESTING: Posting to media collection.")
+      media_collection = opts[:media_collection]
+      reporter.info(self, "Will use collection '#{media_collection.title}' for media creation.")
+      
+      # * Post a picture to the media collection
+      #
+      poster = Poster.new(media_collection.href, @authent)
+      if poster.last_error
+        reporter.error(self, "Unacceptable URI for '#{media_coll.title}' collection: " +
+            poster.last_error)
+        return
+      end
+
+      name = 'Post image to media collection'
+
+      # ask it to use this in the URI
+      slug_num = rand(100000)
+      slug = "apix-#{slug_num}"
+      slug_re = %r{apix.?#{slug_num}}
+      poster.set_header('Slug', slug)
+
+      #poster.set_header('Slug', slug)
+      worked = poster.post('image/jpeg', Samples.picture)
+      reporter.save_dialog(name, poster)
+      if !worked
+        reporter.error(self, "Can't POST picture to media collection: #{poster.last_error}",
+          name)
+        return
+      end
+
+      reporter.success(self, "Post of image file reported success, media link location: " +
+          "#{poster.header('Location')}", name)
+      
+      # * Retrieve the media link entry
+      mle_uri = poster.header('Location')
+          
+      media_link_entry = check_resource(mle_uri, 'Retrieval of media link entry', Names::AtomMediaType)
+      return unless media_link_entry
+
+      if media_link_entry.last_error
+        reporter.error(self, "Can't proceed with media-post testing.")
+        return
+      end
+
+      # * See if the <content src= is there and usable
+      begin
+        media_link_entry = Entry.new(media_link_entry.body, mle_uri)
+      rescue REXML::ParseException
+        prob = $!.to_s.gsub(/\n/, '<br/>')
+        reporter.error(self, "Media link entry is not well-formed: #{prob}")
+        return
+      end
+      content_src = media_link_entry.content_src
+      if (!content_src) || (content_src == "")
+        reporter.error(self, "Media link entry has no content@src pointer to media resource.")
+        return
+      end
+
+      # see if slug was used in media URI
+      if content_src =~ slug_re
+        reporter.success(self, "Client-provided slug '#{slug}' was used in Media Resource URI.")
+      else
+        reporter.warning(self, "Client-provided slug '#{slug}' not used in Media Resource URI.")
+      end
+      
+      media_link_id = media_link_entry.child_content('id')
+
+      name = 'Retrieval of media resource'
+      picture = check_resource(content_src, name, 'image/jpeg')
+      return unless picture
+
+      if picture.body == Samples.picture
+        reporter.success(self, "Media resource was apparently stored and retrieved properly.")
+      else
+        reporter.warning(self, "Media resource differs from posted picture")
+      end
+
+      # * Delete the media link entry
+      return unless delete_entry(media_link_entry, 'Deletion of media link entry')
+
+      # * media link entry still in feed?
+      still_there = find_entry(media_collection.href, "media collection", media_link_id)
+      if still_there.class != String
+        reporter.error(self, "Media link entry is still in collection post-deletion.")
+      else
+        reporter.success(self, "Media link entry no longer in feed.")
+      end
+      
+      # is the resource there any more?
+      name = 'Check Media Resource deletion'
+      if check_resource(content_src, name, 'image/jpeg', false)
+        reporter.error(self, "Media resource still there after media link entry deletion.")
+      else
+        reporter.success(self, "Media resource no longer fetchable.")
+      end
+    end
+  end
+end

data/lib/ape/validators/sanitization_validator.rb

@@ -0,0 +1,57 @@
+module Ape
+  class SanitizationValidator < Validator
+    disabled
+    requires_presence_of :entry_collection
+    
+    def validate(opts = {})
+      reporter.info(self, "TESTING: Content sanitization")
+      coll = opts[:entry_collection]
+      
+      poster = Poster.new(coll.href, @authent)
+      name = 'Posting unclean XHTML'
+      worked = poster.post(Names::AtomEntryMediaType, Samples.unclean_xhtml_entry)
+      if !worked
+        reporter.save_dialog(name, poster)
+        reporter.error(self, "Can't POST unclean XHTML: #{poster.last_error}", name)
+        return
+      end
+      
+      location = poster.header('Location')
+      name = "Retrieval of unclean XHTML entry"
+      entry = check_resource(location, name, Names::AtomMediaType)
+      return unless entry
+
+      begin
+        entry = Entry.new(entry.body, location)
+      rescue REXML::ParseException
+        prob = $!.to_s.gsub(/\n/, '<br/>')
+        reporter.error(self, "New entry is not well-formed: #{prob}")
+        return
+      end
+
+      no_problem = true
+      patterns = {
+        '//xhtml:script' => "Published entry retains xhtml:script element.",
+        '//*[@background]' => "Published entry retains 'background' attribute.",
+        '//*[@style]' => "Published entry retains 'style' attribute.",
+        
+      }
+      patterns.each { |xp, message| 
+        reporter.warning(self, message) unless entry.xpath_match(xp).empty?
+      }
+      
+      entry.xpath_match('//xhtml:a').each do |a|
+        if a.attributes['href'] =~ /^([a-zA-Z]+):/
+          if $1 != 'http'
+            no_problem = false
+            reporter.warning(self, "Published entry retains dangerous hyperlink: '#{a.attributes['href']}'.")
+          end
+        end
+      end    
+
+      delete_entry(entry)
+      
+      reporter.success(self, "Published entry appears to be sanitized.") if no_problem
+    end
+  end
+end

data/lib/ape/validators/schema_validator.rb

@@ -0,0 +1,57 @@
+if RUBY_PLATFORM =~ /java/
+  require 'java'
+  CompactSchemaReader = com.thaiopensource.validate.rng.CompactSchemaReader
+  ValidationDriver = com.thaiopensource.validate.ValidationDriver
+  StringReader = java.io.StringReader
+  StringWriter = java.io.StringWriter
+  InputSource = org.xml.sax.InputSource
+  ErrorHandlerImpl = com.thaiopensource.xml.sax.ErrorHandlerImpl
+  PropertyMapBuilder = com.thaiopensource.util.PropertyMapBuilder
+  ValidateProperty = com.thaiopensource.validate.ValidateProperty
+end
+
+module Ape
+  class SchemaValidator < Validator
+    disabled
+    def validate(opts = {})
+      if RUBY_PLATFORM =~ /java/
+        rcn_validate(opts[:schema], opts[:doc].body, opts[:title])
+      else
+        reporter.add(self, :info, "Schema validation is just available building the ape with jruby.")
+        true
+      end
+    end
+    
+    def rnc_validate(schema, text, name, ape)
+      schemaError = StringWriter.new
+      schemaEH = ErrorHandlerImpl.new(schemaError)
+      properties = PropertyMapBuilder.new
+      properties.put(ValidateProperty::ERROR_HANDLER, schemaEH)
+      error = nil
+      driver = ValidationDriver.new(properties.toPropertyMap, CompactSchemaReader.getInstance)
+      if driver.loadSchema(InputSource.new(StringReader.new(schema)))
+        begin
+          if !driver.validate(InputSource.new(StringReader.new(text)))
+            error = schemaError.toString
+          end
+        rescue org.xml.sax.SAXParseException
+          error = $!.to_s.sub(/\n.*$/, '')
+        end
+      else
+        error = schemaError.toString
+      end
+
+      if !error
+        reporter.add(self, :success, "#{name} passed schema validation.")
+        true
+      else
+        # this kind of sucks, but I spent a looong time lost in a maze of twisty
+        #  little passages without being able to figure out how to
+        #  tell jing what name I'd like to call the InputSource
+        reporter.add(self, :error, "#{name} failed schema validation:\n" + error.gsub('(unknown file):', 'Line '))
+        false
+      end
+    end
+        
+  end
+end

data/lib/ape/validators/service_document_validator.rb

@@ -0,0 +1,64 @@
+module Ape
+  class ServiceDocumentValidator < Validator
+    disabled
+    deterministic
+    attr_reader :service_document, :entry_collections, :media_collections
+    
+    def validate(opts = {})
+      init_service_document(opts[:uri])
+      raise ValidationError, "service document not found in: #{opts[uri]}" unless @service
+      init_service_collections(opts[:uri])
+      raise ValidationError unless @entry_collections && @media_collections
+    end
+    
+    def init_service_document(uri)
+      reporter.info(self, "TESTING: Service document and collections.")
+      name = 'Retrieval of Service Document'
+      service = check_resource(uri, name, Names::AppMediaType)
+      return unless service
+
+      # * XML-parse the service doc
+      text = service.body
+      begin
+        @service = REXML::Document.new(text, { :raw => nil })
+      rescue REXML::ParseException
+        prob = $!.to_s.gsub(/\n/, '<br/>')
+        reporter.error(self, "Service document not well-formed: #{prob}")
+        return
+      end
+
+      # RNC-validate the service doc
+      Validator.instance(:schema, @reporter).validate(:schema => Samples.service_RNC, 
+        :title => 'Service doc', :doc => @service)
+    end
+    
+    def init_service_collections(uri)
+      # * Do we have collections we can post an entry and a picture to?
+      #   the requested_* arguments are the requested collection titles; if
+      #    provided, try to match them, otherwise just pick the first listed
+      #
+      begin
+        @service_collections = Service.collections(@service, uri)
+      rescue Exception
+        reporter.error(self, "Couldn't read collections from service doc: #{$!}")
+        return
+      end
+      
+      if @service_collections.length > 0
+        reporter.start_list(self, "Found these collections")
+        @service_collections.each do |collection|
+          reporter.list_item("'#{collection.title}' " +
+            "accepts #{collection.accept.join(', ')}")
+            
+          if (collection.accept.index(Names::AtomEntryMediaType))
+            @entry_collections ||= []
+            @entry_collections << collection
+          else
+            @media_collections ||= []
+            @media_collections << collection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ape/validators/sorting_validator.rb

@@ -0,0 +1,87 @@
+module Ape
+  class SortingValidator < Validator
+    disabled
+    requires_presence_of :entry_collection
+    
+    def validate(opts = {})
+      coll = opts[:entry_collection]
+      reporter.info(self, "TESTING: Collection re-ordering after PUT.")
+      
+      # We'll post three mini entries to the collection
+      poster = Poster.new(coll.href, @authent)
+      ['One', 'Two', 'Three'].each do |num|
+        sleep 2
+        text = Samples.mini_entry.gsub('Mini-1', "Mini #{num}")
+        name = "Posting Mini #{num}"
+        worked = poster.post(Names::AtomEntryMediaType, text)
+        reporter.save_dialog(name, poster)
+        if !worked
+          reporter.error(self, "Can't POST Mini #{name}: #{poster.last_error}", name)
+          return
+        end
+      end
+
+      # now let's grab the collection & check the order
+      wanted = ['Mini One', 'Mini Two', 'Mini Three']
+      two = nil
+      entries = Feed.read(coll.href, 'Entries with multi-post', reporter)
+      entries.each do |from_feed|
+        want = wanted.pop
+        unless from_feed.child_content('title').index(want)
+          reporter.error(self, "Entries feed out of order after multi-post.")
+          return
+        end
+        two = from_feed if want == 'Mini Two'
+        break if wanted.empty?
+      end
+      reporter.success(self, "Entries correctly ordered after multi-post.")
+      
+      # let's update one of them; have to fetch it first to get the ETag
+      link = two.link('edit', self)
+      unless link
+        reporter.error(self, "Can't check entry without edit link, entry id: #{two.get_child('id/text()')}")
+        return
+      end
+      two_resp = check_resource(link, 'fetch two', Names::AtomMediaType, false)
+      
+      correctly_ordered = false
+      if two_resp
+        etag = two_resp.header 'etag'
+          
+        putter = Putter.new(link, @authent)
+        putter.set_header('If-Match', etag)
+      
+        name = 'Updating mini-entry with PUT'
+        sleep 2
+        updated = two_resp.body.gsub('Mini Two', 'Mini-4')
+        unless putter.put(Names::AtomEntryMediaType, updated)
+          reporter.save_dialog(name, putter)
+          reporter.error(self, "Can't update mini-entry at #{link}", name)
+          return
+        end
+        # now the order should have changed
+        wanted = ['Mini One', 'Mini Three', 'Mini-4']
+        correctly_ordered = true
+      else
+        reporter.error(self, "Mini Two entry not received. Can't assure the correct order after update.")
+        wanted = ['Mini One', 'Mini Two', 'Mini Three']
+      end
+      
+      entries = Feed.read(coll.href, 'Entries post-update', reporter)
+      entries.each do |from_feed|
+        want = wanted.pop
+        unless from_feed.child_content('title').index(want)
+          reporter.error(self, "Entries feed out of order after update of multi-post.")
+          return
+        end
+        
+        # next to godliness
+        delete_entry(from_feed)
+        
+        break if wanted.empty?
+      end
+      reporter.success(self, "Entries correctly ordered after update of multi-post.")  if correctly_ordered
+      
+    end
+  end
+end

data/lib/ape/version.rb

@@ -1,7 +1,7 @@
 module Ape
   module VERSION
     MAJOR = 1
-    MINOR = 0
+    MINOR = 5
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/{lib/ape/samples → samples}/basic_entry.eruby

@@ -1,16 +1,16 @@
 <?xml version="1.0" ?>
 <entry xmlns="http://www.w3.org/2005/Atom">
   <id><%= id %></id>
-  <title><%= title %></title>
+  <title><%= @title %></title>
   <author><name>The Atom Protocol Exerciser</name></author>
   <updated><%= now %></updated>
   <link href='http://www.tbray.org/ape'/>
-  <summary type='html'><%= summary %></summary>
+  <summary type='html'><%= @summary %></summary>
   <content type='xhtml'><div xmlns='http://www.w3.org/1999/xhtml'>
-    <p>A test post from the &lt;APE&gt; at #{updated}</p>
+    <p>A test post from the &lt;APE&gt; at <%= now %></p>
     <p>If you see this in an entry, it's probably a left-over from an
     unsuccessful Ape run; feel free to delete it.</p>
     </div>
   </content>
-  <dc:subject xmlns:dc='<%=subject%>'>Simians</dc:subject>
+  <dc:subject xmlns:dc='<%= @subject%>'>Simians</dc:subject>
 </entry>

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 $:.unshift File.dirname(__FILE__) + '/../lib'
 require 'test/unit'
 require 'ape'
+require 'mocha'
 
 def load_test_dir(dir)
   Dir[File.join(File.dirname(__FILE__), dir, "*.rb")].each do |file|
@@ -13,5 +14,36 @@ module Writer
     @response = response
   end
 end
-
 Ape::Invoker.send(:include, Writer)
+
+module ApeAccessors
+  def service=(service)
+    @service = service
+  end
+  
+  def entry_collections=(colls)
+    @entry_collections = colls
+  end
+  
+  def media_collections=(colls)
+    @media_collections = colls
+  end
+  
+  def service
+    @service
+  end
+  
+  def entry_collections
+    @entry_collections
+  end
+  
+  def media_collections
+    @media_collections
+  end
+end
+Ape::Ape.send(:include, ApeAccessors)
+
+class ValidatorMock < Ape::Validator
+  deterministic
+  requires_presence_of :entry_collection
+end