A ruby way to access the Atheme IRC Services XMLRPC interface.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install atheme
You need to be using Atheme IRC Services with httpd and XMLRPC enabled.
. hostname: 'example.com', port: 1234, protocol: 'http'
protocol (default http)
= .('nickname', 'password') # Returns an authcookie .(, 'nickname', 'ip.add.re.ss') # Sets the users info for commands
::ChanServ.info '#channel' ::NickServ.set 'email', '[email protected]'
Any command can be used that the user has access to use.
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 ::ServiceName < :: 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
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
- Fork it
- Create your feature branch (
git checkout -b feature/my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin feature/my-new-feature)
- Create new Pull Request