Atheme Ruby

A ruby way to access the Atheme IRC Services XMLRPC interface.

Installation

Add this line to your application's Gemfile:

gem 'atheme'

And then execute:

$ bundle

Or install it yourself as:

$ gem install atheme

Usage

Requirements

You need to be using Atheme IRC Services with httpd and XMLRPC enabled.

Configuration

Atheme.configure hostname: 'example.com', port: 1234, protocol: 'http'

Optional: protocol (default http)

Authentication

cookie = Atheme.login('nickname', 'password') # Returns an authcookie

Atheme.set_user(cookie, 'nickname', 'ip.add.re.ss') # Sets the users info for commands

Services commands

Atheme::ChanServ.info '#channel'
Atheme::NickServ.set 'email', 'james@example.com'

Any command can be used that the user has access to use.

Command format: Atheme::ServiceName.command 'param', 'param', ...

To see supported services go here.

If you use a custom service you can create a class like so:

class Atheme::ServiceName < Atheme::Service
end

Each command will return an object of the Atheme::Service that is used. All will always have #to_raw that has the raw services output.

Some commands will return an object with additional methods on them depending if a parser exists for that command. Parsers can be seen here

Testing

In order to be able to generate VCR cassettes properly when testing (minus those that already exist!) you must run a local IRC server with Atheme with httpd and XMLRPC enabled (listening on localhost:1234).

Contributing

1. Fork it
2. Create your feature branch (git checkout -b feature/my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/my-new-feature)
5. Create new Pull Request