Project

openfire

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby client for the Openfire API. Provides access to Group, User, and Room service APIs.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0

Runtime

 Project Readme

Openfire

Gem Version Build Status Code Climate

A Ruby client for accessing Openfire's User, Room, and Group service API.

Installation

Add it to your Gemfile:

gem 'openfire' # git: 'chrisb/openfire'

And bundle install.

Usage

Connect to the API by providing the endpoint URL and secret token:

client = Openfire::Client.new 'http://localhost:9090/', 'ABC123DEF456'
Register a New User
client.add_user! username: 'john', password: 'sup3rs3cr3t!'
client.add_user! username: 'john', password: 'sup3rs3cr3t!', :name => ..., :email => ..., :groups => ...
Update an Existing User
client.update_user! username: 'john', password: 'sup3rs3cr3t!'
client.update_user! username: 'john', password: 'sup3rs3cr3t!', :name => ..., :email => ..., :groups => ...
Delete a User
client.delete_user! username: 'john'
Lock a User
api.lock_user! username: 'john'
Unlock a User
client.unlock_user! username: 'john'
Create a Room
client.add_room! roomname: 'general', :jid => "jid", :subdomain => "generalchat"
Delete a Room
client.delete_room! roomname: 'general', :subdomain => "generalchat"
Create a MUC (multi-user chat) Service
client.add_muc_service! :subdomain => 'demo-service', :description => 'this is a demo muc service'
Delete a MUC Service
client.delete_muc_service! :subdomain => 'demo-service'

License

Licensed under the MIT License.

Authors