ape 1.5.1 → 1.6.0

data/lib/ape/invokers/getter.rb

@@ -57,6 +57,10 @@ module Ape
       end
       return false
     end
+    
+    def code
+      @response.code
+    end
 
     def getBody contentType
 
@@ -66,15 +70,27 @@ module Ape
         if @contentType =~ /^([^;]*);/
           @contentType = $1
         end
-      
+
         if contentType != @contentType
-          @last_error = "Content-type must be '#{contentType}', not '#{@contentType}'"
+          @response = Net::HTTPGone.new('1.1', '409',
+            "Content-type must be '#{contentType}', not '#{@contentType}'")
+          @body = ""
         end
       end
         
       @body = @response.body
       return true
     end
+
+    # Handy wrapper with optional media-type checking; return the Response object
+    def Getter.retrieve(uri, content_type=nil, authent=nil)
+
+      getter = Getter.new(uri, authent)
+      raise(Exception, "Bad URI value #{uri}") if getter.last_error
+
+      getter.get content_type
+      return getter.response
+    end
   end
 end
 

data/lib/ape/invokers/poster.rb

@@ -8,12 +8,11 @@ module Ape
 
     def initialize(uriString, authent)
       super uriString, authent
-      @headers = {}
       @entry = nil
     end
     
-    def set_header(name, val)
-      @headers[name] = val
+    def authoritative?
+      @response['Location'] == @response['Content-Location']
     end
 
     def post(contentType, body, req = nil)
@@ -35,16 +34,16 @@ module Ape
             return false
           end
 
-          if (!((@response['Content-type'] =~ %r{^application/atom\+xml}) ||
-                (@response['Content-type'] =~ %r{^application/atom\+xml;type=entry})))
+          # XXX how can this happen?
+          if (!(@response['Content-type'] =~ %r{^application/atom\+xml(;type=entry)?}))
             return true
           end
 
           begin
-            @entry = Entry.new(@response.body)
+            @entry = Entry.new(:text => @response.body, :uri => @response['Location'])
             return true
           rescue ArgumentError
-            @last_error = @entry.broken
+            @last_error = $!.to_s
             return false
           end
         end

data/lib/ape/names.rb

@@ -1,4 +1,4 @@
-#   Copyright (c) 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
@@ -16,6 +16,7 @@ module Ape
     
     AtomMediaType = 'application/atom+xml' unless defined?(AtomMediaType)
     AtomEntryMediaType = 'application/atom+xml;type=entry' unless defined?(AtomEntryMediaType)
+    AtomFeedMediaType = 'application/atom+xml;type=feed' unless defined?(AtomFeedMediaType)
     AppMediaType = 'application/atomsvc+xml' unless defined?(AppMediaType)
 
   end

data/lib/ape/reporter.rb

@@ -23,7 +23,7 @@ module Ape
     
     def self.supported_outputs
       Dir[File.join(File.dirname(__FILE__), 'reporters/*.rb'),
-          File.join(Ape.home, 'reporters/*.rb')].map { |file|        
+          File.join(::Ape.home, 'reporters/*.rb')].map { |file|        
         file.gsub(/(.+\/reporters\/)(.+)(_reporter.rb)/, '\2').gsub(/_/, '')
       }.sort.join(", ").downcase
     end

data/lib/ape/samples.rb

@@ -61,8 +61,8 @@ module Ape
     end
     
     def Samples.entry_path(type)
-      File.exist?(File.join(Ape.home, "/#{type}.eruby"))?
-        File.join(Ape.home, "/#{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
     

data/lib/ape/server.rb

@@ -16,7 +16,7 @@ module Ape
     #  * :port - the port number to listen on
     #  * :directory - the ape home directory
     def self.run(options)      
-      Ape.home = options[:home]
+      ::Ape.home = options[:home]
       
       mongrel = Mongrel::Configurator.new(:host => options[:host], :port => options[:port]) do
         log "=> Booting mongrel"

data/lib/ape/service.rb

@@ -4,9 +4,26 @@ require 'rexml/xpath'
 
 module Ape
   class Service
-    def Service.collections(service, uri)
-      nodes = REXML::XPath.match(service, '//app:collection', Names::XmlNamespaces)
-      nodes.collect { |n| Collection.new(n, uri) }
+    require File.dirname(__FILE__) + '/util.rb'
+    include Ape::Util::InstanceMethods
+    
+    attr_accessor :service, :reporter
+    
+    def initialize(opts = {})                 #uri = nil, authent = nil)
+      @authent = opts[:authent]
+      @reporter = opts[:reporter]
+      if opts[:uri]
+        @uri = opts[:uri]
+        resource = check_resource(@uri, 'Service document', Names::AppMediaType, @reporter)
+        raise StandardError, "Service document not found at: #{@uri}" unless resource
+    
+        @service = REXML::Document.new(resource.body, { :raw => nil })
+      end
+    end
+
+    def collections(uri = @uri)
+      nodes = REXML::XPath.match(@service, '//app:collection', Names::XmlNamespaces)
+      nodes.collect { |n| CollElement.new(n, uri) }
     end
   end
 end

data/lib/ape/util.rb

@@ -1,9 +1,14 @@
 module Ape
   module Util
-    def self.included(base)
-      base.extend ClassMethods
+    def self.included(base)      
+      base.extend ClassMethods  
       include InstanceMethods
     end
+
+    def self.extended(base)
+      base.extend InstanceMethods
+      base.extend ClassMethods
+    end
     
     module InstanceMethods
 =begin
@@ -20,9 +25,9 @@ module Ape
 
       # * Get it, make sure it has the right content-type
       worked = resource.get(content_type)
-      reporter.save_dialog(name, resource)
+      reporter.save_dialog(name, resource) if report
 
-      reporter.security_warning(self) if (resource.security_warning)
+      reporter.security_warning(self) if (resource.security_warning && report)
 
       if !worked
         # oops, couldn't even get get it
@@ -32,7 +37,6 @@ module Ape
       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
@@ -48,7 +52,7 @@ module Ape
 resolvers or samples.
 =end    
       def resolve_plugin(key, dir, suffix, drop_underlines = false)
-        [File.dirname(__FILE__), Ape.home].each do |path|
+        [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')
@@ -64,4 +68,4 @@ resolvers or samples.
       end
     end
   end
-end
+end

data/lib/ape/validator.rb

@@ -11,7 +11,7 @@ module Ape
     
     def self.custom_validators(reporter, authent)
       validators = []
-      Dir[Ape.home + '/validators/*.rb'].each do |v|
+      Dir[::Ape.home + '/validators/*.rb'].each do |v|
         require v
         class_name = v.gsub(/(.+\/validators\/)(.+)(.rb)/, '\2').gsub(/(^|_)(.)/) { $2.upcase }
         validator = eval("#{class_name}.new", binding, __FILE__, __LINE__)

data/lib/ape/validators/entry_posts_validator.rb

@@ -29,7 +29,7 @@ module Ape
         return
       end
 
-      my_entry = Entry.new(Samples.basic_entry)
+      my_entry = Entry.new(:text => Samples.basic_entry)
 
       # ask it to use this in the URI
       slug_num = rand(100000)
@@ -71,7 +71,7 @@ module Ape
       reporter.info(self, "Examining the new entry as retrieved using Location header in POST response:")
 
       begin
-        new_entry = Entry.new(new_entry.body, location)
+        new_entry = Entry.new(:text => new_entry.body, :uri => location)
       rescue REXML::ParseException
         prob = $!.to_s.gsub(/\n/, '<br/>')
         reporter.error(self, "New entry is not well-formed: #{prob}")
@@ -99,7 +99,6 @@ module Ape
       # * fetch the feed again and check that version
       from_feed = find_entry(collection_uri, "entry collection", entry_id)
       if from_feed.class == String
-        reporter.success(self, "About to check #{collection_uri}")
         Feed.read(collection_uri, "Can't find entry in collection", reporter)
         reporter.error(self, "New entry didn't show up in the collections feed.")
         return

data/lib/ape/validators/media_linkage_validator.rb

@@ -30,7 +30,7 @@ module Ape
         return
       end
         
-      ids = entries.map { |e| e.child_content('id)') }
+      ids = entries.map { |e| e.child_content('id') }
       
       # let's update one of them; have to fetch it first to get the ETag
       two_media = entries[1].link('edit-media')
@@ -75,4 +75,4 @@ module Ape
       reporter.success(self, "Entries correctly ordered after update of multi-post.")
     end
   end
-end
+end

data/lib/ape/validators/media_posts_validator.rb

@@ -25,7 +25,6 @@ module Ape
       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
@@ -50,7 +49,7 @@ module Ape
 
       # * See if the <content src= is there and usable
       begin
-        media_link_entry = Entry.new(media_link_entry.body, mle_uri)
+        media_link_entry = Entry.new(:text => media_link_entry.body, :uri => mle_uri)
       rescue REXML::ParseException
         prob = $!.to_s.gsub(/\n/, '<br/>')
         reporter.error(self, "Media link entry is not well-formed: #{prob}")

data/lib/ape/validators/sanitization_validator.rb

@@ -22,7 +22,7 @@ module Ape
       return unless entry
 
       begin
-        entry = Entry.new(entry.body, location)
+        entry = Entry.new(:text => entry.body, :uri => location)
       rescue REXML::ParseException
         prob = $!.to_s.gsub(/\n/, '<br/>')
         reporter.error(self, "New entry is not well-formed: #{prob}")

data/lib/ape/validators/service_document_validator.rb

@@ -6,30 +6,23 @@ module Ape
     
     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
+        @service_document = Service.new(:uri => uri, :reporter => reporter )
+      rescue Exception
         prob = $!.to_s.gsub(/\n/, '<br/>')
-        reporter.error(self, "Service document not well-formed: #{prob}")
+        reporter.error(self, "Service document not usable: #{prob}")
         return
       end
 
       # RNC-validate the service doc
       Validator.instance(:schema, @reporter).validate(:schema => Samples.service_RNC, 
-        :title => 'Service doc', :doc => @service)
+        :title => 'Service doc', :doc => @service_document.service)
     end
     
     def init_service_collections(uri)
@@ -37,23 +30,20 @@ module Ape
       #   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
+      collections = @service_document.collections
+      if collections.length > 0
+
         reporter.start_list(self, "Found these collections")
-        @service_collections.each do |collection|
+        collections.each do |collection|
           reporter.list_item("'#{collection.title}' " +
-            "accepts #{collection.accept.join(', ')}")
+              "accepts #{collection.accept.join(', ')}")
             
-          if (collection.accept.index(Names::AtomEntryMediaType))
+          if collection.accept?(Names::AtomEntryMediaType)
             @entry_collections ||= []
             @entry_collections << collection
-          else
+          end
+            
+          if collection.accept?('image/jpeg')
             @media_collections ||= []
             @media_collections << collection
           end

data/lib/ape/version.rb

@@ -1,8 +1,8 @@
-module Ape
-  module VERSION
+module Ape #:nodoc:
+  module VERSION #:nodoc:
     MAJOR = 1
-    MINOR = 5
-    TINY  = 1
+    MINOR = 6
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_helper.rb

@@ -15,7 +15,7 @@ module Writer
   end
 end
 Ape::Invoker.send(:include, Writer)
-
+  
 module ApeAccessors
   def service=(service)
     @service = service
@@ -47,3 +47,26 @@ class ValidatorMock < Ape::Validator
   deterministic
   requires_presence_of :entry_collection
 end
+
+def collection(title, accept = ['application/atom+xml;type=entry'])
+  collection = "<collection href=\"http://localhost\">" +
+    "<atom:title>#{title}</atom:title>"
+  accept.each do |a|
+    collection += "<accept>#{a}</accept>"
+  end
+  collection += "</collection>"
+end
+
+def service(&block)
+  service = "<service xmlns=\"http://www.w3.org/2007/app\"" +
+    " xmlns:atom=\"http://www.w3.org/2005/Atom\"><workspace>"
+  service += yield
+  service += "</workspace></service>"
+  REXML::Document.new(service)
+end
+
+def collections(&block)
+  s = service(&block)
+  nodes = REXML::XPath.match(s, '//app:collection', Ape::Names::XmlNamespaces)
+  nodes.collect { |n| Ape::CollElement.new(n) }
+end

data/test/unit/ape_test.rb

@@ -10,26 +10,26 @@ class ApeTest < Test::Unit::TestCase
   end
   
   def test_check_manifest_raises_validation_error
-    @ape.entry_collections = service { collection('Attachments', ['image/jpg']) }
+    @ape.media_collections = collections { collection('Attachments', ['image/jpg']) }
     assert_raise(Ape::ValidationError) {
-      variables = @ape.check_manifest(ValidatorMock.new)
+      @ape.check_manifest(ValidatorMock.new)
     }
   end
   
   def test_check_manifest_assert_first_entry_collection
-    @ape.entry_collections = service { collection('Posts') }
+    @ape.entry_collections = collections { collection('Posts') }
     variables = @ape.check_manifest(ValidatorMock.new)
     assert_equal('Posts', variables[:entry_collection].title)
   end
   
   def test_check_manifest_assert_first_media_collection
-    @ape.media_collections = service { collection('Attachments', ['image/jpg']) }
+    @ape.media_collections = collections { collection('Attachments', ['image/jpg']) }
     variables = stub_manifest([:media_collection])
     assert_equal('Attachments', variables[:media_collection].title)
   end
   
   def test_check_manifest_assert_select_last_collection
-   @ape.entry_collections = service {
+   @ape.entry_collections = collections {
       collection('Posts') +
       collection('Comments')
     }
@@ -39,7 +39,7 @@ class ApeTest < Test::Unit::TestCase
   end
   
   def test_select_first_collection_by_type
-    @ape.entry_collections = service {
+    @ape.entry_collections = collections {
       collection('Posts') +
       collection('Attachments', ['image/jpg']) +
       collection('Attachments2', ['image/png'])
@@ -49,7 +49,7 @@ class ApeTest < Test::Unit::TestCase
   end
   
   def test_select_first_collection_by_title
-    @ape.entry_collections = service {
+    @ape.entry_collections = collections {
       collection('Posts') +
       collection('Attachments', ['image/jpg'])
     }
@@ -58,7 +58,7 @@ class ApeTest < Test::Unit::TestCase
   end
   
   def test_select_by_name_raises_validation_error
-    @ape.entry_collections = service {
+    @ape.entry_collections = collections {
       collection('Posts') +
       collection('Attachments', ['image/jpg'])
     }
@@ -73,20 +73,4 @@ class ApeTest < Test::Unit::TestCase
     @ape.check_manifest(validator)
   end
   
-  def collection(title, accept = ['application/atom+xml;type=entry'])
-    collection = "<collection href=\"http://localhost\">" +
-      "<atom:title>#{title}</atom:title>"
-    accept.each do |a|
-      collection += "<accept>#{a}</accept>"
-    end
-    collection += "</collection>"
-  end
-  
-  def service(&block)
-    service = "<service xmlns=\"http://www.w3.org/2007/app\"" +
-      " xmlns:atom=\"http://www.w3.org/2005/Atom\"><workspace>"
-    service += yield
-    service += "</workspace></service>"
-    Ape::Service.collections(REXML::Document.new(service), nil)
-  end
 end