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 do |config|
  config.url = 'http://example.com'
  config.port = 9876
end

Authentication

cookie = Atheme.('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', '[email protected]'

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

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

To see services supported go here.

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