duwanis-aide

= Aide - What can Jabber do for you?

http://github.com/duwanis/aide

== DESCRIPTION:

Aide is a DSL for defining and running Jabber bots. In order to have a good grasp on how to use Aide, you'll want to familiarize yourself with two classes: Aide::Dsl (used to actually read the Aide DSL), and Aide::ActionContext (blocks defined using the DSL get executed in the scope of an ActionContext). More thorough documentation will be coming soon...

== FEATURES/PROBLEMS:

It doesn't do anything yet. This is the main problem, really.

== EXAMPLE:

Check out example.aide in the source. If you install the gem (see INSTALL below), you should be able to do the following to see the results of parsing the file (or any other file matching the DSL): aide example.aide

== REQUIREMENTS:

Patience.

== INSTALL:

sudo gem install duwanis-aide --source=http://gems.github.com

== ROADMAP:

Here's the plan:

• 0.1 - Functionality in place to create a very simple bot. Can take in any number of static commands, but nothing fancy.
• 0.2 - Help/describe functionality built in by default.
• 0.3 - Dynamic commands.
• 0.4 - Ability to subscribe to an XMPP Publisher (XEP-0060)
• 0.5 - Scheduled tasks (e.g. "execute this code every minute")
• 0.6 - Ability to act as an XMPP Publisher (XEP-0060)
• 0.7 - Command-line interface for publishing events (e.g. aide-publish [botname] [event])
• 0.8 - ?????
• 0.9 - Profit!
• 1.0 - Fully functional 1.0 release.

== HISTORY:

• 0.0.4 - Beginnings of xmpp4r integration.
• 0.0.2 - Bot class started, DSL is done in a sane way (no more creating kernel methods, woo)
• 0.0.1 - Proof of concept. DSL is somewhat spec'd out, and you are now capable of parsing files (albeit crudely).
• 0.0.0 - A new project is born!

== LICENSE:

(The MIT License)

Copyright (c) 2008 Tommy Morgan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.