Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 2.81 KB

README.rdoc

File metadata and controls

58 lines (36 loc) · 2.81 KB
Raw

bigbluebutton-api-ruby <img src=“http://travis-ci.org/mconf/bigbluebutton-api-ruby.png”/> ↑

This is a ruby gem that provides access to the BigBlueButton API. For the API documentation see this page.

Basically it enables a ruby application to interact with BigBlueButton by calling ruby methods instead of HTTP requests making it a lot easier to interact with BigBlueButton. And also formats the responses to a ruby-friendly format.

Some details:

  • Provides methods to perform all API calls and get the responses;

  • Converts the XML responses to ruby hashes, that are easier to work with;

  • Converts the string values returned to native ruby types. For instance:

    • Dates are converted DateTime objects (e.g. “Thu Sep 01 17:51:42 UTC 2011”);

    • Response codes are converted to boolean (e.g. “SUCCESS” becomes true);

  • Deals with errors (e.g. timeouts) throwing BigBlueButtonException exceptions;

  • Support to multiple BigBlueButton API versions (see below).

Supported BigBlueButton versions ↑

The current version of this gem supports all the following versions of BigBlueButton:

  • 0.8: currently in the beta3 stage.

  • 0.7: including 0.7, 0.71 and 0.71a.

Older versions:

  • 0.64: see the branch “api-0.64”. The last version with support to 0.64 is version 0.0.10. It supports both 0.64 and 0.7.

Supported ruby versions ↑

Tested in rubies:

  • ruby-1.8.7

  • ruby-1.9.2

  • ree-1.8.7

  • jruby

Releases ↑

For a list of releases and release notes see CHANGELOG.rdoc.

Development ↑

Information about the development of bigbluebutton-api-ruby can be found in our wiki.

The development of this gem is guided by the requirements of the project Mconf. To know more about it visit the project’s wiki.

License ↑

Distributed under The MIT License (MIT). See LICENSE for the latest license, valid for all versions after 0.0.4 (including it), and LICENSE_003 for version 0.0.3 and all the previous versions.

Contact ↑

Version 0.0.4+: This project is developed as part of Mconf (mconf.org). Contact: Leonardo Crauss Daronco (leonardodaronco@gmail.com), Mconf: A scalable opensource multiconference system for web and mobile devices @ PRAV Labs - UFRGS. Home page: www.inf.ufrgs.br/prav/gtmconf

Version 0.0.3 and below: Joe Kinsella (joe.kinsella@gmail.com), Home page: www.brownbaglunch.com/bigbluebutton