https://github.com/calavera/ape

The Atom Protocol Exerciser
https://github.com/calavera/ape

Last synced: about 2 months ago
JSON representation

The Atom Protocol Exerciser

• Host: GitHub
• URL: https://github.com/calavera/ape
• Owner: calavera
• License: mit
• Created: 2009-10-27T09:47:31.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2009-10-27T16:56:20.000Z (about 15 years ago)
• Last Synced: 2024-04-25T19:22:03.744Z (8 months ago)
• Language: Ruby
• Homepage: http://github.com/calavera/ape
• Size: 156 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • Changelog: History.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
== 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