Change Log¶ ↑

1.8.0 - 2021-12-06¶ ↑

#43 Add keys to every sarvwaveException, to better identify them.
#42 Change sarvwaveException to inherit from StandardError instead of Exception.
[#50] [BREAKING-CHANGE] Replace debug flag with a optional Logger. The application using the gem can pass its own logger as argument for the sarvwaveApi initialization. If none is passed, the gem will use its own default logger on STDOUT with INFO level.
#40 Fix issue preventing documents from being preuploaded using the create call.
Fix parse of recordings with invalid times. It would break at getRecordings if one of them had an empty startTime or endTime.
Add a Dockerfile and compose to help run tests.
Fix deprecated TimeoutError constant.
#35 Make get_recordings accept multiple state params.
#34 Update rubyzip gem to the newest version with no vulnerability, from 1.2.2 to 1.3.0
#33 Upgrade dependencies:
childprocess from 0.3.2 to 1.0.1
ffi from 1.0.11 to 1.9.24
json from 1.8.3 to 1.8.6
nokogiri from 1.6.6.2 to 1.10.4
rack from 1.4.1 to 1.6.11
rdoc from 3.12 to 3.12.1
rubyzip from 0.9.8 to 1.2.2

#29 Add support to the API call updateRecordings introduced in sarvwave 1.1.
#31 Fixed issue with length=nil breaking multiple recording formats.
Call setConfigXML via POST and change encoding method. Fixes issues with special characters (such as *) in the config.xml.
Add method to return the URL to /check.

Add 1.0 as a supported version of sarvwave.
[#1686] Automatically set the version number of a server by fetching it from its API.
[#1686] Fix comparison of config.xml strings that would sometimes thing XMLs were different in cases when they were not.
[#1695] Add support for servers that use HTTPS.

Updated default ruby version to 2.2.0.
Add support for sarvwave 0.9 (includes all 0.9.x). Consists only in accepting the version “0.9”, since this new API version doesn’t break compatibility with the previous version and also doesn’t add new API calls.

Drop support to sarvwave 0.7 and add sarvwave to 0.81. Includes support to the new API calls getDefaultConfigXML and setConfigXML.
Reviewed all methods responses (some changed a bit) and documentation.
Allow non standard options to be passed to all API calls.
Removed method join_meeting that was usually not used. Should always use join_meeting_url.
Moved the hash extension method from_xml to its own class to prevent conflicts with Rails. See github.com/mconf/sarvwave-api-ruby/pull/6.

Allow non standard options to be passed to some API calls. These API calls are: create_meeting, join_meeting_url, join_meeting, get_recordings. Useful for development of for custom versions of sarvwave.
Accept :record as boolean in create_meeting
Better formatting of data returned by get_recordings

Support to sarvwave 0.8:
New methods for recordings: get_recordings, publish_recordings, delete_recordings
Pre-upload of slides in create_meeting
New parameters added in the already existent methods
For more information see sarvwave docs at code.google.com/p/sarvwave/wiki/API#Version_0.8
Method signature changes: create_meeting, join_meeting_url and join_meeting. Optional parameters are now passed using a hash.
Integration tests for the entire library using cucumber.
Changed the XML parser to xml-simple (especially to solve issues with CDATA values).

The file “sarvwave-api” was renamed to “sarvwave_api”. All “require” calls must be updated.
Splitted the library in more files (more modular) and created rspec tests for it.
Added a sarvwaveApi.timeout attribute to timeout get requests and avoid blocks when the server is down. Defaults to 2 secs.
New method last_http_response to access the last HTTP response object.
Automatically detects the SARV server version if not informed by the user.

Returning hash now will always have these 3 values: :returncode (boolean), :messageKey (string) and :message (string).
Some values in the hash are now converted to a fixed variable type to avoid inconsistencies:
:meetingID (string)
:attendeePW (string)
:moderatorPW (string)
:running (boolean)
:hasBeenForciblyEnded (boolean)
:endTime and :startTime (DateTime or nil)

Simplied “attendees” part of the hash returned in get_meeting_info. Same thing done for get_meetings.

New method test_connection.
Added comparison method for APIs.
Methods attendee_url and moderator_url deprecated. Use join_meeting_url.
Better exception throwing when the user is unreachable or the response is incorrect.
sarvwaveException has now a “key” attribute to store the “messageKey” returned by SARV in failures.

Added support for sarvwave 0.7.
Gem renamed from ‘sarvwave’ to ‘sarvwave-api-ruby’.
API functions now return a hash and instead of the XML returned by SARV. The XML is converted to a hash that uses symbols as keys and groups keys with the same name.

This is the first version of this gem. It provides an implementation of the 0.64 sarv API, with the following exceptions:
Does not implement meeting token, and instead relies on meeting id as the unique identifier for a meeting.
Documentation suggests there is way to call join_meeting as API call (instead of browser URL). This call currently does not work as documented.