/
README
36 lines (20 loc) · 1.46 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
== Atom Protocol Exerciser (APE)
APE is a sanity-checker for implementations of the Atom Publishing Protocol (AtomPub or APP). It is written in Ruby,
and provides a Mongrel-based HTML interface describing its interactions with the APP implementation under test.
For more information about the history and impetus for the creation of APE, see Tim Bray's account here[http://www.tbray.org/ongoing/When/200x/2006/08/11/Meet-the-Ape].
== License
Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved. See the included LICENSE[link:/files/LICENSE.html] file for details.
== Quick Start
=== Install APE via RubyGems:
$ gem install ape
Now, you should have the ape_server command available in your $PATH. Start the server with:
$ ape_server
This will start the server in the foreground. You can access APE in your browser at http://localhost:4000
=== Execute APE from the command line:
If you've downloaded APE's source code you can execute it from the command line with ruby rake. From the root directory you can execute one of these three tasks:
$ rake ape:go:html['service document uri', 'username', 'password']
$ rake ape:go:text['service document uri', 'username', 'password']
$ rake ape:go:atom['service document uri', 'username', 'password']
The username and password parameters are not mandatory, and the format response depends on the executed task.
== The Source
To access the latest source code for APE, see the project site at https://rubyforge.org/projects/ape