Atom Protocol Exerciser
11 | 12 |(Only the URI argument is required)
13 | 35 |Error
13 |#{message}.
14 | EndOfText 15 | end 16 | end 17 | end 18 | -------------------------------------------------------------------------------- /lib/ape/print_writer.rb: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved 2 | # See the included LICENSE[link:/files/LICENSE.html] file for details. 3 | module Ape 4 | # this is a wrapper for the weird derived-from-PrintWriter class that comes 5 | # out of HttpResponse.getWriter 6 | class Printwriter 7 | def initialize(java_writer) 8 | @w = java_writer 9 | end 10 | 11 | def puts(s) 12 | @w.println s 13 | end 14 | 15 | def << (s) 16 | @w.print s 17 | end 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /scripts/go.rb: -------------------------------------------------------------------------------- 1 | $:.unshift File.dirname(__FILE__) + '/../lib' 2 | require 'cgi' 3 | require 'html' 4 | require 'ape' 5 | 6 | debug = ENV['APE_DEBUG'] || false 7 | 8 | cgi = debug ? CGI.new('html4') : CGI.new 9 | 10 | if !cgi['uri'] || (cgi['uri'] == '') 11 | HTML.error "URI argument is required" 12 | end 13 | 14 | uri = cgi['uri'] 15 | user = cgi['username'] 16 | pass = cgi['password'] 17 | 18 | ape = Ape::Ape.new({:crumbs => true, :output => 'html', :debug => debug}) 19 | 20 | if user == '' 21 | ape.check(uri) 22 | else 23 | ape.check(uri, user, pass) 24 | end 25 | ape.report 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /lib/ape/samples/basic_entry.eruby: -------------------------------------------------------------------------------- 1 | 2 |
10 |
14 | A test post from the <APE> at #{updated}
11 |If you see this in an entry, it's probably a left-over from an 12 | unsuccessful Ape run; feel free to delete it.
13 |
9 |
14 | hey
10 | 11 | 12 |Hey
13 |
9 |
10 |
36 |
41 | 42 |
The Ape source code may be found at 43 | ape.rubyforge.org. 44 | 45 |
46 |
Ape Logo by Greg 47 | Borenstein.
48 | 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /lib/ape/authent.rb: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved 2 | # Use is subject to license terms - see file "LICENSE" 3 | 4 | module Ape 5 | class AuthenticationError < StandardError ; end 6 | 7 | class Authent 8 | def initialize(username, password, scheme=nil) 9 | @username = username 10 | @password = password 11 | @auth_plugin = nil 12 | end 13 | 14 | def add_to(req, authentication = nil) 15 | return unless @username && @password 16 | if (authentication) 17 | if authentication.strip.downcase.include? 'basic' 18 | req.basic_auth @username, @password 19 | else 20 | @auth_plugin = resolve_plugin(authentication) unless @auth_plugin 21 | @auth_plugin.add_credentials(req, authentication, @username, @password) 22 | end 23 | else 24 | req.basic_auth @username, @password 25 | end 26 | end 27 | 28 | def resolve_plugin(authentication) 29 | Dir.glob(File.join(File.dirname(__FILE__), 'auth/*.rb')).each do |file| 30 | plugin_name = file.gsub(/(.+\/auth\/)(.+)(_credentials.rb)/, '\2').gsub(/_/, '') 31 | plugin_class = file.gsub(/(.+\/auth\/)(.+)(.rb)/, '\2').gsub(/(^|_)(.)/) { $2.upcase } 32 | 33 | if (authentication.strip.downcase.include?(plugin_name)) 34 | return eval("#{plugin_class}.new", binding, __FILE__, __LINE__) 35 | end 36 | end 37 | raise AuthenticationError, "Unknown authentication method: #{authentication}" 38 | end 39 | end 40 | end 41 | 42 | Dir[File.dirname(__FILE__) + '/auth/*.rb'].each { |l| require l } 43 | -------------------------------------------------------------------------------- /lib/ape/crumbs.rb: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved 2 | # Use is subject to license terms - see file "LICENSE" 3 | 4 | module Ape 5 | 6 | # All descendants of Invoker use Net::HTTP::set_debug_output 7 | # to capture the dialogue. This class is what gets passed to 8 | # set_debug_output; it exists to define #<< to save only the interesting bits 9 | # of the dialog. 10 | class Crumbs 11 | 12 | def initialize #:nodoc: 13 | @crumbs = [] 14 | @keep_next = false 15 | end 16 | 17 | # call-seq: 18 | # crumbs.grep(pattern) => array 19 | # 20 | # Returns an array of crumbs for whichpattern === crumb
21 | #
22 | # ==== Options
23 | # * pattern - A string or Regexp literal, as with Enumerable#grep.
24 | def grep(pattern)
25 | @crumbs.grep(pattern)
26 | end
27 |
28 | # Appends +data+ to the report dialog
29 | #
30 | # ==== Options
31 | # * data - The message, as passed by an Invoker descendant. Required.
32 | def <<(data)
33 | if @keep_next
34 | @crumbs << "> #{data}"
35 | @keep_next = false
36 | elsif data =~ /^->/
37 | @crumbs << "< #{data.gsub(/^.../, '')}"
38 | elsif data =~ /^<-/
39 | @keep_next = true
40 | end
41 | end
42 |
43 | # Yields each crumb sequentially to the supplied block.
44 | def each #:yields: crumb
45 | @crumbs.each { |c| yield c }
46 | end
47 |
48 | # call-seq:
49 | # crumbs.to_s => string
50 | #
51 | # Returns a string containing all crumbs, seperated by newlines.
52 | def to_s
53 | " " + @crumbs.join("...\n")
54 | end
55 | end
56 | end
57 |
--------------------------------------------------------------------------------
/lib/ape/samples/categories_schema.txt:
--------------------------------------------------------------------------------
1 | # -*- rnc -*-
2 | # RELAX NG Compact Syntax Grammar for the Atom Protocol
3 |
4 | namespace app = "http://www.w3.org/2007/app"
5 | namespace atom = "http://www.w3.org/2005/Atom"
6 | namespace xsd = "http://www.w3.org/2001/XMLSchema"
7 | namespace local = ""
8 |
9 | start = appCategories
10 |
11 | atomCommonAttributes =
12 | attribute xml:base { atomURI }?,
13 | attribute xml:lang { atomLanguageTag }?,
14 | undefinedAttribute*
15 |
16 | undefinedAttribute =
17 | attribute * - (xml:base | xml:lang | local:*) { text }
18 |
19 | atomURI = text
20 |
21 | atomLanguageTag = xsd:string {
22 | pattern = "[A-Za-z]{1,8}(-[A-Za-z0-9]{1,8})*"
23 | }
24 |
25 |
26 | atomCategory =
27 | element atom:category {
28 | atomCommonAttributes,
29 | attribute term { text },
30 | attribute scheme { atomURI }?,
31 | attribute label { text }?,
32 | undefinedContent
33 | }
34 |
35 | appInlineCategories =
36 | element app:categories {
37 | attribute fixed { "yes" | "no" }?,
38 | attribute scheme { atomURI }?,
39 | (atomCategory*)
40 | }
41 |
42 | appOutOfLineCategories =
43 | element app:categories {
44 | attribute href { atomURI },
45 | (empty)
46 | }
47 |
48 | appCategories = appInlineCategories | appOutOfLineCategories
49 |
50 |
51 | # Extensibility
52 |
53 | undefinedContent = (text|anyForeignElement)*
54 |
55 | anyElement =
56 | element * {
57 | (attribute * { text }
58 | | text
59 | | anyElement)*
60 | }
61 |
62 | anyForeignElement =
63 | element * - atom:* {
64 | (attribute * { text }
65 | | text
66 | | anyElement)*
67 | }
68 |
69 | # EOF
--------------------------------------------------------------------------------
/lib/ape/invoker.rb:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
2 | # Use is subject to license terms - see file "LICENSE"
3 | require 'net/https'
4 |
5 | module Ape
6 | class Invoker
7 | attr_reader :last_error, :crumbs, :response
8 |
9 | def initialize(uriString, authent)
10 | @last_error = nil
11 | @crumbs = Crumbs.new
12 | @uri = AtomURI.check(uriString)
13 | if (@uri.class == String)
14 | @last_error = @uri
15 | end
16 | @authent = authent
17 | @authent_checker = 0
18 | end
19 |
20 | def header(which)
21 | @response[which]
22 | end
23 |
24 | def prepare_http
25 | http = Net::HTTP.new(@uri.host, @uri.port)
26 | if @uri.scheme == 'https'
27 | http.use_ssl = true
28 | http.verify_mode = OpenSSL::SSL::VERIFY_NONE
29 | end
30 | http.set_debug_output @crumbs if @crumbs
31 | http
32 | end
33 |
34 | def need_authentication?(req)
35 | if @response.instance_of?(Net::HTTPUnauthorized) && @authent
36 | #tries to authenticate just two times in order to avoid infinite loops
37 | raise AuthenticationError, 'Authentication is required' unless @authent_checker <= 1
38 | @authent_checker += 1
39 |
40 | @authent.add_to req, header('WWW-Authenticate')
41 | #clean the request body attribute, if we don't do it http.request(req, body) will raise an exception
42 | req.body = nil unless req.body.nil?
43 | return true
44 | end
45 | return false
46 | end
47 |
48 | def restart_authent_checker
49 | @authent_checker = 0
50 | end
51 | end
52 | end
53 |
54 | Dir[File.dirname(__FILE__) + '/invokers/*.rb'].each { |l| require l }
55 |
--------------------------------------------------------------------------------
/lib/ape/invokers/poster.rb:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
2 | # Use is subject to license terms - see file "LICENSE"
3 | require 'net/http'
4 |
5 | module Ape
6 | class Poster < Invoker
7 | attr_reader :entry, :uri
8 |
9 | def initialize(uriString, authent)
10 | super uriString, authent
11 | @headers = {}
12 | @entry = nil
13 | end
14 |
15 | def set_header(name, val)
16 | @headers[name] = val
17 | end
18 |
19 | def post(contentType, body, req = nil)
20 | req = Net::HTTP::Post.new(AtomURI.on_the_wire(@uri)) if req.nil?
21 | req.set_content_type contentType
22 | @headers.each { |k, v| req[k]= v }
23 |
24 | begin
25 | http = prepare_http
26 |
27 | http.start do |connection|
28 | @response = connection.request(req, body)
29 |
30 | return post(contentType, body, req) if need_authentication?(req)
31 | restart_authent_checker
32 |
33 | if @response.code != '201'
34 | @last_error = @response.message
35 | return false
36 | end
37 |
38 | if (!((@response['Content-type'] =~ %r{^application/atom\+xml}) ||
39 | (@response['Content-type'] =~ %r{^application/atom\+xml;type=entry})))
40 | return true
41 | end
42 |
43 | begin
44 | @entry = Entry.new(@response.body)
45 | return true
46 | rescue ArgumentError
47 | @last_error = @entry.broken
48 | return false
49 | end
50 | end
51 | rescue Exception
52 | @last_error = "Can't connect to #{@uri.host} on port #{@uri.port}: #{$!}"
53 | return false
54 | end
55 | end
56 | end
57 | end
58 |
--------------------------------------------------------------------------------
/lib/ape/validator.rb:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
2 | # Use is subject to license terms - see file "LICENSE"
3 |
4 | if RUBY_PLATFORM =~ /java/
5 | require 'java'
6 | CompactSchemaReader = com.thaiopensource.validate.rng.CompactSchemaReader
7 | ValidationDriver = com.thaiopensource.validate.ValidationDriver
8 | StringReader = java.io.StringReader
9 | StringWriter = java.io.StringWriter
10 | InputSource = org.xml.sax.InputSource
11 | ErrorHandlerImpl = com.thaiopensource.xml.sax.ErrorHandlerImpl
12 | PropertyMapBuilder = com.thaiopensource.util.PropertyMapBuilder
13 | ValidateProperty = com.thaiopensource.validate.ValidateProperty
14 | end
15 |
16 | module Ape
17 | class Validator
18 |
19 | attr_reader :error
20 |
21 | def Validator.validate(schema, text, name, ape)
22 | # Can do this in JRuby, not native Ruby (sigh)
23 | if RUBY_PLATFORM =~ /java/
24 | rnc_validate(schema, text, name, ape)
25 | else
26 | true
27 | end
28 | end
29 |
30 | def Validator.rnc_validate(schema, text, name, ape)
31 | schemaError = StringWriter.new
32 | schemaEH = ErrorHandlerImpl.new(schemaError)
33 | properties = PropertyMapBuilder.new
34 | properties.put(ValidateProperty::ERROR_HANDLER, schemaEH)
35 | error = nil
36 | driver = ValidationDriver.new(properties.toPropertyMap, CompactSchemaReader.getInstance)
37 | if driver.loadSchema(InputSource.new(StringReader.new(schema)))
38 | begin
39 | if !driver.validate(InputSource.new(StringReader.new(text)))
40 | error = schemaError.toString
41 | end
42 | rescue org.xml.sax.SAXParseException
43 | error = $!.to_s.sub(/\n.*$/, '')
44 | end
45 | else
46 | error = schemaError.toString
47 | end
48 |
49 | if !error
50 | ape.good "#{name} passed schema validation."
51 | true
52 | else
53 | # this kind of sucks, but I spent a looong time lost in a maze of twisty
54 | # little passages without being able to figure out how to
55 | # tell jing what name I'd like to call the InputSource
56 | ape.error "#{name} failed schema validation:\n" + error.gsub('(unknown file):', 'Line ')
57 | false
58 | end
59 |
60 | end
61 |
62 | end
63 | end
64 |
65 |
66 |
--------------------------------------------------------------------------------
/lib/ape/invokers/getter.rb:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
2 | # Use is subject to license terms - see file "LICENSE"
3 | require 'net/http'
4 |
5 | module Ape
6 | class Getter < Invoker
7 | attr_reader :contentType, :charset, :body, :security_warning
8 |
9 | def get(contentType = nil, depth = 0, req = nil)
10 | req = Net::HTTP::Get.new(AtomURI.on_the_wire(@uri)) unless req
11 | @last_error = nil
12 |
13 | return false if document_failed?(depth, req)
14 |
15 | begin
16 | http = prepare_http
17 |
18 | http.start do |connection|
19 | @response = connection.request(req)
20 |
21 | if need_authentication?(req)
22 | @security_warning = true unless http.use_ssl?
23 | return get(contentType, depth + 1, req)
24 | end
25 | restart_authent_checker
26 |
27 | case @response
28 | when Net::HTTPSuccess
29 | return getBody(contentType)
30 |
31 | when Net::HTTPRedirection
32 | redirect_to = @uri.merge(@response['location'])
33 | @uri = AtomURI.check(redirect_to)
34 | return get(contentType, depth + 1)
35 |
36 | else
37 | @last_error = @response.message
38 | return false
39 | end
40 | end
41 | rescue Exception
42 | @last_error = "Can't connect to #{@uri.host} on port #{@uri.port}: #{$!}"
43 | return false
44 | end
45 | end
46 |
47 | def document_failed?(depth, req)
48 | if (depth > 10)
49 | if need_authentication?(req)
50 | #Authentication required
51 | @last_error = "Authentication is required"
52 | else
53 | # too many redirects
54 | @last_error = "Too many redirects"
55 | end
56 | return true
57 | end
58 | return false
59 | end
60 |
61 | def getBody contentType
62 |
63 | if contentType
64 | @contentType = @response['Content-Type']
65 | # XXX TODO - better regex
66 | if @contentType =~ /^([^;]*);/
67 | @contentType = $1
68 | end
69 |
70 | if contentType != @contentType
71 | @last_error = "Content-type must be '#{contentType}', not '#{@contentType}'"
72 | end
73 | end
74 |
75 | @body = @response.body
76 | return true
77 | end
78 | end
79 | end
80 |
81 |
--------------------------------------------------------------------------------
/lib/ape/categories.rb:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
2 | # Copyright © 2006 Sun Microsystems, Inc. All rights reserved
3 | # Use is subject to license terms - see file "LICENSE"
4 |
5 | require 'rexml/document'
6 | require 'rexml/xpath'
7 |
8 | module Ape
9 | class Categories
10 | attr_reader :fixed
11 |
12 | def Categories.from_collection(collection, authent, ape=nil)
13 |
14 | # "catses" because if cats is short for categories, then catses
15 | # suggests multiple rather than this element
88 | if n.attributes['type'] == 'xhtml'
89 | n = REXML::XPath.first(n, "./xhtml:div", Names::XmlNamespaces)
90 | unless n
91 | return "Error: required xhtml:div child of #{field} is missing"
92 | end
93 | end
94 |
95 | text_from n
96 | end
97 |
98 | def text_from node
99 | text = ''
100 | is_html = node.name =~ /(rights|subtitle|summary|title|content)$/ && node.attributes['type'] == 'html'
101 | node.find_all do | child |
102 | if child.kind_of? REXML::Text
103 | v = child.value
104 | v = CGI.unescapeHTML(v).gsub(/'/, "'") if is_html
105 | text << v
106 | elsif child.kind_of? REXML::Element
107 | text << text_from(child)
108 | end
109 | end
110 | text
111 | end
112 |
113 | def link(rel, ape=nil)
114 | l = nil
115 | a = REXML::XPath.first(@element, "./atom:link[@rel=\"#{rel}\"]", Names::XmlNamespaces)
116 | if a
117 | l = a.attributes['href']
118 | l = @base.absolutize(l, @element) if @base
119 | end
120 | l
121 | end
122 |
123 | def alt_links
124 | REXML::XPath.match(@element, "./atom:link", Names::XmlNamespaces).select do |l|
125 | l.attributes['rel'] == nil || l.attributes['rel'] == 'alternate'
126 | end
127 | end
128 |
129 | def summarize
130 | child_content('title')
131 | end
132 |
133 | # utility routine
134 | def xpath_match(xp)
135 | REXML::XPath.match(@element, xp, Names::XmlNamespaces)
136 | end
137 |
138 | # debugging
139 | def Entry.dump(node, depth=0)
140 | prefix = '.' * depth
141 | name = node.getNodeName
142 | uri = node.getNamespaceURI
143 | if uri
144 | puts "#{prefix} #{uri}:#{node.getNodeName}"
145 | else
146 | puts "#{prefix} #{node.getNodeName}"
147 | end
148 | Nodes.each_node(node.getChildNodes) {|child| dump(child, depth+1)}
149 | end
150 | end
151 | end
152 |
--------------------------------------------------------------------------------
/lib/ape/samples.rb:
--------------------------------------------------------------------------------
1 | # Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved
2 | # Use is subject to license terms - see file "LICENSE"
3 | require 'rexml/xpath'
4 | require 'date'
5 | require 'base64'
6 | require 'erubis'
7 |
8 | module Ape
9 | class Samples
10 |
11 | @@service_schema = nil
12 | @@categories_schema = nil
13 | @@atom_schema = nil
14 | @@home = nil
15 |
16 | def Samples.home=(home)
17 | @@home = home
18 | end
19 |
20 | def Samples.foreign_child
21 | 'subject'
22 | end
23 | def Samples.foreign_namespace
24 | Names::DcNamespace
25 | end
26 | def Samples.foreign_child_content
27 | 'Simians'
28 | end
29 |
30 | def Samples.load_schema(file_name)
31 | schema = ""
32 | File.open(File.join(File.dirname(__FILE__), "/samples/#{file_name}_schema.txt")) do |file|
33 | while(line = file.gets)
34 | schema << line
35 | end
36 | end
37 | schema
38 | end
39 |
40 | def Samples.service_RNC
41 | @@service_schema = load_schema('service') unless @@service_schema
42 | @@service_schema
43 | end
44 |
45 | def Samples.categories_RNC
46 | @@categories_schema = load_schema('categories') unless @@categories_schema
47 | @@categories_schema
48 | end
49 |
50 | def Samples.atom_RNC
51 | @@atom_schema = load_schema('atom') unless @@atom_schema
52 | @@atom_schema
53 | end
54 |
55 | #recipe from cap
56 | def Samples.home_directory
57 | ENV["HOME"] || (ENV["HOMEPATH"] && "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}") ||
58 | "/"
59 | end
60 |
61 | def Samples.home
62 | @@home || ENV["APE_HOME"] || File.join(home_directory,".ape")
63 | end
64 |
65 | def Samples.make_id
66 | id = ''
67 | 5.times { id += rand(1000000).to_s }
68 | "tag:tbray.org,2005:#{id}"
69 | end
70 |
71 | def Samples.entry_path(type)
72 | File.exist?(File.join(home, "/#{type}.eruby"))?
73 | File.join(home, "/#{type}.eruby") :
74 | File.join(File.dirname(__FILE__), "/samples/#{type}.eruby")
75 | end
76 |
77 | def Samples.load_template(type)
78 | entry_path = entry_path(type)
79 | input = File.read(entry_path)
80 | eruby = Erubis::Eruby.new(input)
81 | end
82 |
83 |
84 | def Samples.mini_entry
85 | eruby = load_template('mini_entry')
86 |
87 | now = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
88 | id = make_id
89 |
90 | eruby.result(binding())
91 | end
92 |
93 | def Samples.basic_entry
94 | eruby = load_template('basic_entry')
95 |
96 | id = make_id
97 | now = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
98 | title = Escaper.escape('From the (サル)')
99 | summary = "Summary from the <b>< APE ></b> at #{now}"
100 | subject = Names::DcNamespace
101 |
102 | eruby.result(binding())
103 | end
104 |
105 | def Samples.unclean_xhtml_entry
106 | eruby = load_template('unclean_xhtml_entry')
107 |
108 | id = make_id
109 | now = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
110 |
111 | eruby.result(binding())
112 | end
113 |
114 | def Samples.cat_test_entry
115 | e = retitled_entry('Testing category posting')
116 | end
117 |
118 | def Samples.retitled_entry(new_title, new_id = nil)
119 | e = basic_entry
120 | e.gsub!(/.*<\/title>/, "<title>#{new_title} ")
121 | new_id = make_id unless new_id
122 | e.gsub(/.*<\/id>/, "#{new_id} ")
123 | end
124 |
125 | def Samples.picture
126 | b64 =< nil })
72 | rescue REXML::ParseException
73 | prob = $!.to_s.gsub(/\n/, '
') 74 | error "Service document not well-formed: #{prob}" 75 | return 76 | end 77 | 78 | # RNC-validate the service doc 79 | Validator.validate(Samples.service_RNC, text, 'Service doc', self) 80 | 81 | # * Do we have collections we can post an entry and a picture to? 82 | # the requested_* arguments are the requested collection titles; if 83 | # provided, try to match them, otherwise just pick the first listed 84 | # 85 | begin 86 | collections = Service.collections(service, uri) 87 | rescue Exception 88 | error "Couldn't read collections from service doc: #{$!}" 89 | return 90 | end 91 | entry_coll = media_coll = nil 92 | if collections.length > 0 93 | start_list "Found these collections" 94 | collections.each do |collection| 95 | list_item "'#{collection.title}' " + 96 | "accepts #{collection.accept.join(', ')}" 97 | if (!entry_coll) && collection.accept.index(Names::AtomEntryMediaType) 98 | if requested_e_coll 99 | if requested_e_coll == collection.title 100 | entry_coll = collection 101 | end 102 | else 103 | entry_coll = collection 104 | end 105 | end 106 | 107 | if !media_coll 108 | image_jpeg_ok = false 109 | collection.accept.each do |types| 110 | types.split(/, */).each do |type| 111 | 112 | if type == '*/*' || type == 'image/*' || type == 'image/jpeg' 113 | image_jpeg_ok = true 114 | end 115 | end 116 | end 117 | if image_jpeg_ok 118 | if requested_m_coll 119 | if requested_m_coll == collection.title 120 | media_coll = collection 121 | end 122 | else 123 | media_coll = collection 124 | end 125 | end 126 | end 127 | end 128 | end 129 | 130 | end_list 131 | 132 | if entry_coll 133 | info "Will use collection '#{entry_coll.title}' for entry creation." 134 | test_entry_posts entry_coll 135 | test_sorting entry_coll 136 | test_sanitization entry_coll 137 | else 138 | warning "No collection for 'application/atom+xml;type=entry', won't test entry posting." 139 | end 140 | 141 | if media_coll 142 | info "Will use collection '#{media_coll.title}' for media creation." 143 | test_media_posts media_coll.href 144 | test_media_linkage media_coll 145 | else 146 | warning "No collection for 'image/jpeg', won't test media posting." 147 | end 148 | end 149 | 150 | def test_media_linkage(coll) 151 | info "TESTING: Media collection re-ordering after PUT." 152 | 153 | # We'll post three mini entries to the collection 154 | data = Samples.picture 155 | poster = Poster.new(coll.href, @authent) 156 | ['One', 'Two', 'Three'].each do |num| 157 | slug = "Picture #{num}" 158 | poster.set_header('Slug', slug) 159 | name = "Posting pic #{num}" 160 | worked = poster.post('image/jpeg', data) 161 | save_dialog(name, poster) 162 | if !worked 163 | error("Can't POST Picture #{num}: #{poster.last_error}", name) 164 | return 165 | end 166 | sleep 2 167 | end 168 | 169 | # grab the collection to gather the MLE ids 170 | entries = Feed.read(coll.href, 'Pictures from multi-post', self, true) 171 | if entries.size < 3 172 | error "Pictures apparently not in collection" 173 | return 174 | end 175 | 176 | ids = entries.map { |e| e.child_content('id)') } 177 | 178 | # let's update one of them; have to fetch it first to get the ETag 179 | two_media = entries[1].link('edit-media') 180 | if !two_media 181 | error "Second entry from feed doesn't have an 'edit-media' link." 182 | return 183 | end 184 | two_resp = check_resource(two_media, 'Fetch image to get ETag', 'image/jpeg', true) 185 | unless two_resp 186 | error "Can't fetch image to get ETag" 187 | return 188 | end 189 | etag = two_resp.header 'etag' 190 | 191 | putter = Putter.new(two_media, @authent) 192 | putter.set_header('If-Match', etag) 193 | 194 | name = 'Updating one of three pix with PUT' 195 | if putter.put('image/jpeg', data) 196 | good "Update one of newly posted pictures went OK." 197 | else 198 | save_dialog(name, putter) 199 | error("Can't update picture at #{two_media}", name) 200 | return 201 | end 202 | 203 | # now the order should have changed 204 | wanted = [ ids[2], ids[0], ids[1] ] 205 | entries = Feed.read(coll.href, 'MLEs post-update', self, true) 206 | entries.each do |from_feed| 207 | want = wanted.pop 208 | unless from_feed.child_content('id').eql?(want) 209 | error "Updating bits failed to re-order link entries in media collection." 210 | return 211 | end 212 | 213 | # next to godliness 214 | delete_entry(from_feed) 215 | 216 | break if wanted.empty? 217 | end 218 | good "Entries correctly ordered after update of multi-post." 219 | 220 | end 221 | 222 | def test_sanitization(coll) 223 | info "TESTING: Content sanitization" 224 | 225 | poster = Poster.new(coll.href, @authent) 226 | name = 'Posting unclean XHTML' 227 | worked = poster.post(Names::AtomEntryMediaType, Samples.unclean_xhtml_entry) 228 | if !worked 229 | save_dialog(name, poster) 230 | error("Can't POST unclean XHTML: #{poster.last_error}", name) 231 | return 232 | end 233 | 234 | location = poster.header('Location') 235 | name = "Retrieval of unclean XHTML entry" 236 | entry = check_resource(location, name, Names::AtomMediaType) 237 | return unless entry 238 | 239 | begin 240 | entry = Entry.new(entry.body, location) 241 | rescue REXML::ParseException 242 | prob = $!.to_s.gsub(/\n/, '
') 243 | error "New entry is not well-formed: #{prob}" 244 | return 245 | end 246 | 247 | no_problem = true 248 | patterns = { 249 | '//xhtml:script' => "Published entry retains xhtml:script element.", 250 | '//*[@background]' => "Published entry retains 'background' attribute.", 251 | '//*[@style]' => "Published entry retains 'style' attribute.", 252 | 253 | } 254 | patterns.each { |xp, message| warning(message) unless entry.xpath_match(xp).empty? } 255 | 256 | entry.xpath_match('//xhtml:a').each do |a| 257 | if a.attributes['href'] =~ /^([a-zA-Z]+):/ 258 | if $1 != 'http' 259 | no_problem = false 260 | warning "Published entry retains dangerous hyperlink: '#{a.attributes['href']}'." 261 | end 262 | end 263 | end 264 | 265 | delete_entry(entry) 266 | 267 | good "Published entry appears to be sanitized." if no_problem 268 | end 269 | 270 | def test_sorting(coll) 271 | 272 | info "TESTING: Collection re-ordering after PUT." 273 | 274 | # We'll post three mini entries to the collection 275 | poster = Poster.new(coll.href, @authent) 276 | ['One', 'Two', 'Three'].each do |num| 277 | sleep 2 278 | text = Samples.mini_entry.gsub('Mini-1', "Mini #{num}") 279 | name = "Posting Mini #{num}" 280 | worked = poster.post(Names::AtomEntryMediaType, text) 281 | save_dialog(name, poster) 282 | if !worked 283 | error("Can't POST Mini #{name}: #{poster.last_error}", name) 284 | return 285 | end 286 | end 287 | 288 | # now let's grab the collection & check the order 289 | wanted = ['Mini One', 'Mini Two', 'Mini Three'] 290 | two = nil 291 | entries = Feed.read(coll.href, 'Entries with multi-post', self, true) 292 | entries.each do |from_feed| 293 | want = wanted.pop 294 | unless from_feed.child_content('title').index(want) 295 | error "Entries feed out of order after multi-post." 296 | return 297 | end 298 | two = from_feed if want == 'Mini Two' 299 | break if wanted.empty? 300 | end 301 | good "Entries correctly ordered after multi-post." 302 | 303 | # let's update one of them; have to fetch it first to get the ETag 304 | link = two.link('edit', self) 305 | unless link 306 | error "Can't check entry without edit link, entry id: #{two.get_child('id/text()')}" 307 | return 308 | end 309 | two_resp = check_resource(link, 'fetch two', Names::AtomMediaType, false) 310 | 311 | correctly_ordered = false 312 | if two_resp 313 | etag = two_resp.header 'etag' 314 | 315 | putter = Putter.new(link, @authent) 316 | putter.set_header('If-Match', etag) 317 | 318 | name = 'Updating mini-entry with PUT' 319 | sleep 2 320 | updated = two_resp.body.gsub('Mini Two', 'Mini-4') 321 | unless putter.put(Names::AtomEntryMediaType, updated) 322 | save_dialog(name, putter) 323 | error("Can't update mini-entry at #{link}", name) 324 | return 325 | end 326 | # now the order should have changed 327 | wanted = ['Mini One', 'Mini Three', 'Mini-4'] 328 | correctly_ordered = true 329 | else 330 | error "Mini Two entry not received. Can't assure the correct order after update." 331 | wanted = ['Mini One', 'Mini Two', 'Mini Three'] 332 | end 333 | 334 | entries = Feed.read(coll.href, 'Entries post-update', self, true) 335 | entries.each do |from_feed| 336 | want = wanted.pop 337 | unless from_feed.child_content('title').index(want) 338 | error "Entries feed out of order after update of multi-post." 339 | return 340 | end 341 | 342 | # next to godliness 343 | delete_entry(from_feed) 344 | 345 | break if wanted.empty? 346 | end 347 | good "Entries correctly ordered after update of multi-post." if correctly_ordered 348 | 349 | end 350 | 351 | def test_entry_posts(entry_collection) 352 | 353 | collection_uri = entry_collection.href 354 | entries = Feed.read(collection_uri, 'Entry collection', self) 355 | 356 | # * List the current entries, remember which IDs we've seen 357 | info "TESTING: Entry-posting basics." 358 | ids = [] 359 | unless entries.empty? 360 | start_list "Now in the Entries feed" 361 | entries.each do |entry| 362 | list_item entry.summarize 363 | ids << entry.child_content('id') 364 | end 365 | end_list 366 | end 367 | 368 | # Setting up to post a new entry 369 | poster = Poster.new(collection_uri, @authent) 370 | if poster.last_error 371 | error("Unacceptable URI for '#{entry_collection.title}' collection: " + 372 | poster.last_error) 373 | return 374 | end 375 | 376 | my_entry = Entry.new(Samples.basic_entry) 377 | 378 | # ask it to use this in the URI 379 | slug_num = rand(100000) 380 | slug = "ape-#{slug_num}" 381 | slug_re = %r{ape.?#{slug_num}} 382 | poster.set_header('Slug', slug) 383 | 384 | # add some categories to the entry, and remember which 385 | @cats = Categories.add_cats(my_entry, entry_collection, @authent, self) 386 | 387 | # * OK, post it 388 | worked = poster.post(Names::AtomEntryMediaType, my_entry.to_s) 389 | name = 'Posting new entry' 390 | save_dialog(name, poster) 391 | if !worked 392 | error("Can't POST new entry: #{poster.last_error}", name) 393 | return 394 | end 395 | 396 | location = poster.header('Location') 397 | unless location 398 | error("No Location header upon POST creation", name) 399 | return 400 | end 401 | good("Posting of new entry to the Entries collection " + 402 | "reported success, Location: #{location}", name) 403 | 404 | info "Examining the new entry as returned in the POST response" 405 | check_new_entry(my_entry, poster.entry, "Returned entry") if poster.entry 406 | 407 | # * See if the Location uri can be retrieved, and check its consistency 408 | name = "Retrieval of newly created entry" 409 | new_entry = check_resource(location, name, Names::AtomMediaType) 410 | return unless new_entry 411 | 412 | # Grab its etag 413 | etag = new_entry.header 'etag' 414 | 415 | info "Examining the new entry as retrieved using Location header in POST response:" 416 | 417 | begin 418 | new_entry = Entry.new(new_entry.body, location) 419 | rescue REXML::ParseException 420 | prob = $!.to_s.gsub(/\n/, '
') 421 | error "New entry is not well-formed: #{prob}" 422 | return 423 | end 424 | 425 | # * See if the slug was used 426 | slug_used = false 427 | new_entry.alt_links.each do |a| 428 | href = a.attributes['href'] 429 | if href && href.index(slug_re) 430 | slug_used = true 431 | end 432 | end 433 | if slug_used 434 | good "Client-provided slug '#{slug}' was used in server-generated URI." 435 | else 436 | warning "Client-provided slug '#{slug}' not used in server-generated URI." 437 | end 438 | 439 | check_new_entry(my_entry, new_entry, "Retrieved entry") 440 | 441 | entry_id = new_entry.child_content('id') 442 | 443 | # * fetch the feed again and check that version 444 | from_feed = find_entry(collection_uri, "entry collection", entry_id) 445 | if from_feed.class == String 446 | good "About to check #{collection_uri}" 447 | Feed.read(collection_uri, "Can't find entry in collection", self) 448 | error "New entry didn't show up in the collections feed." 449 | return 450 | end 451 | 452 | info "Examining the new entry as it appears in the collection feed:" 453 | 454 | # * Check the entry from the feed 455 | check_new_entry(my_entry, from_feed, "Entry from collection feed") 456 | 457 | edit_uri = new_entry.link('edit', self) 458 | if !edit_uri 459 | error "Entry from Location header has no edit link." 460 | return 461 | end 462 | 463 | # * Update the entry, see if the update took 464 | name = 'In-place update with put' 465 | putter = Putter.new(edit_uri, @authent) 466 | 467 | # Conditional PUT if an etag 468 | putter.set_header('If-Match', etag) if etag 469 | 470 | new_title = "Let’s all do the Ape!" 471 | new_text = Samples.retitled_entry(new_title, entry_id) 472 | response = putter.put(Names::AtomEntryMediaType, new_text) 473 | save_dialog(name, putter) 474 | 475 | if response 476 | good("Update of new entry reported success.", name) 477 | from_feed = find_entry(collection_uri, "entry collection", entry_id) 478 | if from_feed.class == String 479 | check_resource(collection_uri, "Check collection after lost update", nil, true) 480 | error "Updated entry ID #{entry_id} not found in entries collection." 481 | return 482 | end 483 | if from_feed.child_content('title') == new_title 484 | good "Title of new entry successfully updated." 485 | else 486 | warning "After PUT update of title, Expected " + 487 | "'#{new_title}', but saw '#{from_feed.child_content('title')}'" 488 | end 489 | else 490 | warning("Can't update new entry with PUT: #{putter.last_error}", name) 491 | end 492 | 493 | # the edit-uri might have changed 494 | return unless delete_entry(from_feed, 'New Entry deletion') 495 | 496 | # See if it's gone from the feed 497 | still_there = find_entry(collection_uri, "entry collection", entry_id) 498 | if still_there.class != String 499 | error "Entry is still in collection post-deletion." 500 | else 501 | good "Entry not found in feed after deletion." 502 | end 503 | 504 | end 505 | 506 | def test_media_posts media_collection 507 | 508 | info "TESTING: Posting to media collection." 509 | 510 | # * Post a picture to the media collection 511 | # 512 | poster = Poster.new(media_collection, @authent) 513 | if poster.last_error 514 | error("Unacceptable URI for '#{media_coll.title}' collection: " + 515 | poster.last_error) 516 | return 517 | end 518 | 519 | name = 'Post image to media collection' 520 | 521 | # ask it to use this in the URI 522 | slug_num = rand(100000) 523 | slug = "apix-#{slug_num}" 524 | slug_re = %r{apix.?#{slug_num}} 525 | poster.set_header('Slug', slug) 526 | 527 | #poster.set_header('Slug', slug) 528 | worked = poster.post('image/jpeg', Samples.picture) 529 | save_dialog(name, poster) 530 | if !worked 531 | error("Can't POST picture to media collection: #{poster.last_error}", 532 | name) 533 | return 534 | end 535 | 536 | good("Post of image file reported success, media link location: " + 537 | "#{poster.header('Location')}", name) 538 | 539 | # * Retrieve the media link entry 540 | mle_uri = poster.header('Location') 541 | 542 | media_link_entry = check_resource(mle_uri, 'Retrieval of media link entry', Names::AtomMediaType) 543 | return unless media_link_entry 544 | 545 | if media_link_entry.last_error 546 | error "Can't proceed with media-post testing." 547 | return 548 | end 549 | 550 | # * See if the
") 898 | message.gsub!(/\\t/, ' ') 899 | @w.div(:class => tf) { @w.target! << message } 900 | end 901 | 902 | def report_text(output=STDOUT) 903 | output.puts @header if @header 904 | @steps.each do |step| 905 | if step.class == Crumbs 906 | output.puts " Dialog:" 907 | step.each { |crumb| output.puts " #{crumb}" } 908 | else 909 | body = step[1 .. -1] 910 | case step[0,1] 911 | when "W" 912 | line 913 | output.puts "WARNING: #{body}" 914 | when "E" 915 | line 916 | output.puts "ERROR: #{body}" 917 | when "G" 918 | line 919 | output.puts body 920 | when "L" 921 | line 922 | output.puts body 923 | when "e" 924 | # no-op 925 | when "I" 926 | output.puts " #{body}" 927 | when "D" 928 | # later, dude 929 | else 930 | line 931 | output.puts "HUH? #{body}" 932 | end 933 | end 934 | output.puts @footer if @footer 935 | end 936 | end 937 | 938 | def compare_entries(e1, e2, e1Name, e2Name) 939 | problems = 0 940 | [ 'title', 'summary', 'content' ].each do |field| 941 | problems += 1 if compare1(e1, e2, e1Name, e2Name, field) 942 | end 943 | return problems == 0 944 | end 945 | 946 | def compare1(e1, e2, e1Name, e2Name, field) 947 | c1 = e1.child_content(field) 948 | c2 = e2.child_content(field) 949 | if c1 != c2 950 | problem = true 951 | if c1 == nil 952 | warning "'#{field}' absent in #{e1Name}." 953 | elsif c2 == nil 954 | warning "'#{field}' absent in #{e2Name}." 955 | else 956 | t1 = e1.child_type(field) 957 | t2 = e2.child_type(field) 958 | if t1 != t2 959 | warning "'#{field}' has type='#{t1}' " + 960 | "in #{e1Name}, type='#{t2}' in #{e2Name}." 961 | else 962 | c1 = Escaper.escape(c1) 963 | c2 = Escaper.escape(c2) 964 | warning "'#{field}' in #{e1Name} [#{c1}] " + 965 | "differs from that in #{e2Name} [#{c2}]." 966 | end 967 | end 968 | end 969 | return problem 970 | end 971 | 972 | def write_mark(mark) 973 | case mark 974 | when :check 975 | @w.span(:class => 'good') { @w.target << '✓' } 976 | when :question 977 | @w.span(:class => 'warning') { @w.text! '?' } 978 | when :exclamation 979 | @w.span(:class => 'error') { @w.text! '!' } 980 | when :info 981 | @w.img(:align => 'top', :src => '../ape/info.png') 982 | end 983 | end 984 | 985 | def delete_entry(entry, name = nil) 986 | link = entry.link('edit', self) 987 | unless link 988 | error "Can't delete entry without edit link" 989 | return false 990 | end 991 | deleter = Deleter.new(link, @authent) 992 | worked = deleter.delete 993 | 994 | save_dialog(name, deleter) if name 995 | if worked 996 | good("Entry deletion reported success.", name) 997 | else 998 | error("Couldn't delete the entry: " + deleter.last_error, name) 999 | end 1000 | return worked 1001 | end 1002 | end 1003 | end 1004 | 1005 | --------------------------------------------------------------------------------
') 74 | error "Service document not well-formed: #{prob}" 75 | return 76 | end 77 | 78 | # RNC-validate the service doc 79 | Validator.validate(Samples.service_RNC, text, 'Service doc', self) 80 | 81 | # * Do we have collections we can post an entry and a picture to? 82 | # the requested_* arguments are the requested collection titles; if 83 | # provided, try to match them, otherwise just pick the first listed 84 | # 85 | begin 86 | collections = Service.collections(service, uri) 87 | rescue Exception 88 | error "Couldn't read collections from service doc: #{$!}" 89 | return 90 | end 91 | entry_coll = media_coll = nil 92 | if collections.length > 0 93 | start_list "Found these collections" 94 | collections.each do |collection| 95 | list_item "'#{collection.title}' " + 96 | "accepts #{collection.accept.join(', ')}" 97 | if (!entry_coll) && collection.accept.index(Names::AtomEntryMediaType) 98 | if requested_e_coll 99 | if requested_e_coll == collection.title 100 | entry_coll = collection 101 | end 102 | else 103 | entry_coll = collection 104 | end 105 | end 106 | 107 | if !media_coll 108 | image_jpeg_ok = false 109 | collection.accept.each do |types| 110 | types.split(/, */).each do |type| 111 | 112 | if type == '*/*' || type == 'image/*' || type == 'image/jpeg' 113 | image_jpeg_ok = true 114 | end 115 | end 116 | end 117 | if image_jpeg_ok 118 | if requested_m_coll 119 | if requested_m_coll == collection.title 120 | media_coll = collection 121 | end 122 | else 123 | media_coll = collection 124 | end 125 | end 126 | end 127 | end 128 | end 129 | 130 | end_list 131 | 132 | if entry_coll 133 | info "Will use collection '#{entry_coll.title}' for entry creation." 134 | test_entry_posts entry_coll 135 | test_sorting entry_coll 136 | test_sanitization entry_coll 137 | else 138 | warning "No collection for 'application/atom+xml;type=entry', won't test entry posting." 139 | end 140 | 141 | if media_coll 142 | info "Will use collection '#{media_coll.title}' for media creation." 143 | test_media_posts media_coll.href 144 | test_media_linkage media_coll 145 | else 146 | warning "No collection for 'image/jpeg', won't test media posting." 147 | end 148 | end 149 | 150 | def test_media_linkage(coll) 151 | info "TESTING: Media collection re-ordering after PUT." 152 | 153 | # We'll post three mini entries to the collection 154 | data = Samples.picture 155 | poster = Poster.new(coll.href, @authent) 156 | ['One', 'Two', 'Three'].each do |num| 157 | slug = "Picture #{num}" 158 | poster.set_header('Slug', slug) 159 | name = "Posting pic #{num}" 160 | worked = poster.post('image/jpeg', data) 161 | save_dialog(name, poster) 162 | if !worked 163 | error("Can't POST Picture #{num}: #{poster.last_error}", name) 164 | return 165 | end 166 | sleep 2 167 | end 168 | 169 | # grab the collection to gather the MLE ids 170 | entries = Feed.read(coll.href, 'Pictures from multi-post', self, true) 171 | if entries.size < 3 172 | error "Pictures apparently not in collection" 173 | return 174 | end 175 | 176 | ids = entries.map { |e| e.child_content('id)') } 177 | 178 | # let's update one of them; have to fetch it first to get the ETag 179 | two_media = entries[1].link('edit-media') 180 | if !two_media 181 | error "Second entry from feed doesn't have an 'edit-media' link." 182 | return 183 | end 184 | two_resp = check_resource(two_media, 'Fetch image to get ETag', 'image/jpeg', true) 185 | unless two_resp 186 | error "Can't fetch image to get ETag" 187 | return 188 | end 189 | etag = two_resp.header 'etag' 190 | 191 | putter = Putter.new(two_media, @authent) 192 | putter.set_header('If-Match', etag) 193 | 194 | name = 'Updating one of three pix with PUT' 195 | if putter.put('image/jpeg', data) 196 | good "Update one of newly posted pictures went OK." 197 | else 198 | save_dialog(name, putter) 199 | error("Can't update picture at #{two_media}", name) 200 | return 201 | end 202 | 203 | # now the order should have changed 204 | wanted = [ ids[2], ids[0], ids[1] ] 205 | entries = Feed.read(coll.href, 'MLEs post-update', self, true) 206 | entries.each do |from_feed| 207 | want = wanted.pop 208 | unless from_feed.child_content('id').eql?(want) 209 | error "Updating bits failed to re-order link entries in media collection." 210 | return 211 | end 212 | 213 | # next to godliness 214 | delete_entry(from_feed) 215 | 216 | break if wanted.empty? 217 | end 218 | good "Entries correctly ordered after update of multi-post." 219 | 220 | end 221 | 222 | def test_sanitization(coll) 223 | info "TESTING: Content sanitization" 224 | 225 | poster = Poster.new(coll.href, @authent) 226 | name = 'Posting unclean XHTML' 227 | worked = poster.post(Names::AtomEntryMediaType, Samples.unclean_xhtml_entry) 228 | if !worked 229 | save_dialog(name, poster) 230 | error("Can't POST unclean XHTML: #{poster.last_error}", name) 231 | return 232 | end 233 | 234 | location = poster.header('Location') 235 | name = "Retrieval of unclean XHTML entry" 236 | entry = check_resource(location, name, Names::AtomMediaType) 237 | return unless entry 238 | 239 | begin 240 | entry = Entry.new(entry.body, location) 241 | rescue REXML::ParseException 242 | prob = $!.to_s.gsub(/\n/, '
') 243 | error "New entry is not well-formed: #{prob}" 244 | return 245 | end 246 | 247 | no_problem = true 248 | patterns = { 249 | '//xhtml:script' => "Published entry retains xhtml:script element.", 250 | '//*[@background]' => "Published entry retains 'background' attribute.", 251 | '//*[@style]' => "Published entry retains 'style' attribute.", 252 | 253 | } 254 | patterns.each { |xp, message| warning(message) unless entry.xpath_match(xp).empty? } 255 | 256 | entry.xpath_match('//xhtml:a').each do |a| 257 | if a.attributes['href'] =~ /^([a-zA-Z]+):/ 258 | if $1 != 'http' 259 | no_problem = false 260 | warning "Published entry retains dangerous hyperlink: '#{a.attributes['href']}'." 261 | end 262 | end 263 | end 264 | 265 | delete_entry(entry) 266 | 267 | good "Published entry appears to be sanitized." if no_problem 268 | end 269 | 270 | def test_sorting(coll) 271 | 272 | info "TESTING: Collection re-ordering after PUT." 273 | 274 | # We'll post three mini entries to the collection 275 | poster = Poster.new(coll.href, @authent) 276 | ['One', 'Two', 'Three'].each do |num| 277 | sleep 2 278 | text = Samples.mini_entry.gsub('Mini-1', "Mini #{num}") 279 | name = "Posting Mini #{num}" 280 | worked = poster.post(Names::AtomEntryMediaType, text) 281 | save_dialog(name, poster) 282 | if !worked 283 | error("Can't POST Mini #{name}: #{poster.last_error}", name) 284 | return 285 | end 286 | end 287 | 288 | # now let's grab the collection & check the order 289 | wanted = ['Mini One', 'Mini Two', 'Mini Three'] 290 | two = nil 291 | entries = Feed.read(coll.href, 'Entries with multi-post', self, true) 292 | entries.each do |from_feed| 293 | want = wanted.pop 294 | unless from_feed.child_content('title').index(want) 295 | error "Entries feed out of order after multi-post." 296 | return 297 | end 298 | two = from_feed if want == 'Mini Two' 299 | break if wanted.empty? 300 | end 301 | good "Entries correctly ordered after multi-post." 302 | 303 | # let's update one of them; have to fetch it first to get the ETag 304 | link = two.link('edit', self) 305 | unless link 306 | error "Can't check entry without edit link, entry id: #{two.get_child('id/text()')}" 307 | return 308 | end 309 | two_resp = check_resource(link, 'fetch two', Names::AtomMediaType, false) 310 | 311 | correctly_ordered = false 312 | if two_resp 313 | etag = two_resp.header 'etag' 314 | 315 | putter = Putter.new(link, @authent) 316 | putter.set_header('If-Match', etag) 317 | 318 | name = 'Updating mini-entry with PUT' 319 | sleep 2 320 | updated = two_resp.body.gsub('Mini Two', 'Mini-4') 321 | unless putter.put(Names::AtomEntryMediaType, updated) 322 | save_dialog(name, putter) 323 | error("Can't update mini-entry at #{link}", name) 324 | return 325 | end 326 | # now the order should have changed 327 | wanted = ['Mini One', 'Mini Three', 'Mini-4'] 328 | correctly_ordered = true 329 | else 330 | error "Mini Two entry not received. Can't assure the correct order after update." 331 | wanted = ['Mini One', 'Mini Two', 'Mini Three'] 332 | end 333 | 334 | entries = Feed.read(coll.href, 'Entries post-update', self, true) 335 | entries.each do |from_feed| 336 | want = wanted.pop 337 | unless from_feed.child_content('title').index(want) 338 | error "Entries feed out of order after update of multi-post." 339 | return 340 | end 341 | 342 | # next to godliness 343 | delete_entry(from_feed) 344 | 345 | break if wanted.empty? 346 | end 347 | good "Entries correctly ordered after update of multi-post." if correctly_ordered 348 | 349 | end 350 | 351 | def test_entry_posts(entry_collection) 352 | 353 | collection_uri = entry_collection.href 354 | entries = Feed.read(collection_uri, 'Entry collection', self) 355 | 356 | # * List the current entries, remember which IDs we've seen 357 | info "TESTING: Entry-posting basics." 358 | ids = [] 359 | unless entries.empty? 360 | start_list "Now in the Entries feed" 361 | entries.each do |entry| 362 | list_item entry.summarize 363 | ids << entry.child_content('id') 364 | end 365 | end_list 366 | end 367 | 368 | # Setting up to post a new entry 369 | poster = Poster.new(collection_uri, @authent) 370 | if poster.last_error 371 | error("Unacceptable URI for '#{entry_collection.title}' collection: " + 372 | poster.last_error) 373 | return 374 | end 375 | 376 | my_entry = Entry.new(Samples.basic_entry) 377 | 378 | # ask it to use this in the URI 379 | slug_num = rand(100000) 380 | slug = "ape-#{slug_num}" 381 | slug_re = %r{ape.?#{slug_num}} 382 | poster.set_header('Slug', slug) 383 | 384 | # add some categories to the entry, and remember which 385 | @cats = Categories.add_cats(my_entry, entry_collection, @authent, self) 386 | 387 | # * OK, post it 388 | worked = poster.post(Names::AtomEntryMediaType, my_entry.to_s) 389 | name = 'Posting new entry' 390 | save_dialog(name, poster) 391 | if !worked 392 | error("Can't POST new entry: #{poster.last_error}", name) 393 | return 394 | end 395 | 396 | location = poster.header('Location') 397 | unless location 398 | error("No Location header upon POST creation", name) 399 | return 400 | end 401 | good("Posting of new entry to the Entries collection " + 402 | "reported success, Location: #{location}", name) 403 | 404 | info "Examining the new entry as returned in the POST response" 405 | check_new_entry(my_entry, poster.entry, "Returned entry") if poster.entry 406 | 407 | # * See if the Location uri can be retrieved, and check its consistency 408 | name = "Retrieval of newly created entry" 409 | new_entry = check_resource(location, name, Names::AtomMediaType) 410 | return unless new_entry 411 | 412 | # Grab its etag 413 | etag = new_entry.header 'etag' 414 | 415 | info "Examining the new entry as retrieved using Location header in POST response:" 416 | 417 | begin 418 | new_entry = Entry.new(new_entry.body, location) 419 | rescue REXML::ParseException 420 | prob = $!.to_s.gsub(/\n/, '
') 421 | error "New entry is not well-formed: #{prob}" 422 | return 423 | end 424 | 425 | # * See if the slug was used 426 | slug_used = false 427 | new_entry.alt_links.each do |a| 428 | href = a.attributes['href'] 429 | if href && href.index(slug_re) 430 | slug_used = true 431 | end 432 | end 433 | if slug_used 434 | good "Client-provided slug '#{slug}' was used in server-generated URI." 435 | else 436 | warning "Client-provided slug '#{slug}' not used in server-generated URI." 437 | end 438 | 439 | check_new_entry(my_entry, new_entry, "Retrieved entry") 440 | 441 | entry_id = new_entry.child_content('id') 442 | 443 | # * fetch the feed again and check that version 444 | from_feed = find_entry(collection_uri, "entry collection", entry_id) 445 | if from_feed.class == String 446 | good "About to check #{collection_uri}" 447 | Feed.read(collection_uri, "Can't find entry in collection", self) 448 | error "New entry didn't show up in the collections feed." 449 | return 450 | end 451 | 452 | info "Examining the new entry as it appears in the collection feed:" 453 | 454 | # * Check the entry from the feed 455 | check_new_entry(my_entry, from_feed, "Entry from collection feed") 456 | 457 | edit_uri = new_entry.link('edit', self) 458 | if !edit_uri 459 | error "Entry from Location header has no edit link." 460 | return 461 | end 462 | 463 | # * Update the entry, see if the update took 464 | name = 'In-place update with put' 465 | putter = Putter.new(edit_uri, @authent) 466 | 467 | # Conditional PUT if an etag 468 | putter.set_header('If-Match', etag) if etag 469 | 470 | new_title = "Let’s all do the Ape!" 471 | new_text = Samples.retitled_entry(new_title, entry_id) 472 | response = putter.put(Names::AtomEntryMediaType, new_text) 473 | save_dialog(name, putter) 474 | 475 | if response 476 | good("Update of new entry reported success.", name) 477 | from_feed = find_entry(collection_uri, "entry collection", entry_id) 478 | if from_feed.class == String 479 | check_resource(collection_uri, "Check collection after lost update", nil, true) 480 | error "Updated entry ID #{entry_id} not found in entries collection." 481 | return 482 | end 483 | if from_feed.child_content('title') == new_title 484 | good "Title of new entry successfully updated." 485 | else 486 | warning "After PUT update of title, Expected " + 487 | "'#{new_title}', but saw '#{from_feed.child_content('title')}'" 488 | end 489 | else 490 | warning("Can't update new entry with PUT: #{putter.last_error}", name) 491 | end 492 | 493 | # the edit-uri might have changed 494 | return unless delete_entry(from_feed, 'New Entry deletion') 495 | 496 | # See if it's gone from the feed 497 | still_there = find_entry(collection_uri, "entry collection", entry_id) 498 | if still_there.class != String 499 | error "Entry is still in collection post-deletion." 500 | else 501 | good "Entry not found in feed after deletion." 502 | end 503 | 504 | end 505 | 506 | def test_media_posts media_collection 507 | 508 | info "TESTING: Posting to media collection." 509 | 510 | # * Post a picture to the media collection 511 | # 512 | poster = Poster.new(media_collection, @authent) 513 | if poster.last_error 514 | error("Unacceptable URI for '#{media_coll.title}' collection: " + 515 | poster.last_error) 516 | return 517 | end 518 | 519 | name = 'Post image to media collection' 520 | 521 | # ask it to use this in the URI 522 | slug_num = rand(100000) 523 | slug = "apix-#{slug_num}" 524 | slug_re = %r{apix.?#{slug_num}} 525 | poster.set_header('Slug', slug) 526 | 527 | #poster.set_header('Slug', slug) 528 | worked = poster.post('image/jpeg', Samples.picture) 529 | save_dialog(name, poster) 530 | if !worked 531 | error("Can't POST picture to media collection: #{poster.last_error}", 532 | name) 533 | return 534 | end 535 | 536 | good("Post of image file reported success, media link location: " + 537 | "#{poster.header('Location')}", name) 538 | 539 | # * Retrieve the media link entry 540 | mle_uri = poster.header('Location') 541 | 542 | media_link_entry = check_resource(mle_uri, 'Retrieval of media link entry', Names::AtomMediaType) 543 | return unless media_link_entry 544 | 545 | if media_link_entry.last_error 546 | error "Can't proceed with media-post testing." 547 | return 548 | end 549 | 550 | # * See if the
") 898 | message.gsub!(/\\t/, ' ') 899 | @w.div(:class => tf) { @w.target! << message } 900 | end 901 | 902 | def report_text(output=STDOUT) 903 | output.puts @header if @header 904 | @steps.each do |step| 905 | if step.class == Crumbs 906 | output.puts " Dialog:" 907 | step.each { |crumb| output.puts " #{crumb}" } 908 | else 909 | body = step[1 .. -1] 910 | case step[0,1] 911 | when "W" 912 | line 913 | output.puts "WARNING: #{body}" 914 | when "E" 915 | line 916 | output.puts "ERROR: #{body}" 917 | when "G" 918 | line 919 | output.puts body 920 | when "L" 921 | line 922 | output.puts body 923 | when "e" 924 | # no-op 925 | when "I" 926 | output.puts " #{body}" 927 | when "D" 928 | # later, dude 929 | else 930 | line 931 | output.puts "HUH? #{body}" 932 | end 933 | end 934 | output.puts @footer if @footer 935 | end 936 | end 937 | 938 | def compare_entries(e1, e2, e1Name, e2Name) 939 | problems = 0 940 | [ 'title', 'summary', 'content' ].each do |field| 941 | problems += 1 if compare1(e1, e2, e1Name, e2Name, field) 942 | end 943 | return problems == 0 944 | end 945 | 946 | def compare1(e1, e2, e1Name, e2Name, field) 947 | c1 = e1.child_content(field) 948 | c2 = e2.child_content(field) 949 | if c1 != c2 950 | problem = true 951 | if c1 == nil 952 | warning "'#{field}' absent in #{e1Name}." 953 | elsif c2 == nil 954 | warning "'#{field}' absent in #{e2Name}." 955 | else 956 | t1 = e1.child_type(field) 957 | t2 = e2.child_type(field) 958 | if t1 != t2 959 | warning "'#{field}' has type='#{t1}' " + 960 | "in #{e1Name}, type='#{t2}' in #{e2Name}." 961 | else 962 | c1 = Escaper.escape(c1) 963 | c2 = Escaper.escape(c2) 964 | warning "'#{field}' in #{e1Name} [#{c1}] " + 965 | "differs from that in #{e2Name} [#{c2}]." 966 | end 967 | end 968 | end 969 | return problem 970 | end 971 | 972 | def write_mark(mark) 973 | case mark 974 | when :check 975 | @w.span(:class => 'good') { @w.target << '✓' } 976 | when :question 977 | @w.span(:class => 'warning') { @w.text! '?' } 978 | when :exclamation 979 | @w.span(:class => 'error') { @w.text! '!' } 980 | when :info 981 | @w.img(:align => 'top', :src => '../ape/info.png') 982 | end 983 | end 984 | 985 | def delete_entry(entry, name = nil) 986 | link = entry.link('edit', self) 987 | unless link 988 | error "Can't delete entry without edit link" 989 | return false 990 | end 991 | deleter = Deleter.new(link, @authent) 992 | worked = deleter.delete 993 | 994 | save_dialog(name, deleter) if name 995 | if worked 996 | good("Entry deletion reported success.", name) 997 | else 998 | error("Couldn't delete the entry: " + deleter.last_error, name) 999 | end 1000 | return worked 1001 | end 1002 | end 1003 | end 1004 | 1005 | --------------------------------------------------------------------------------