sarvwave-api-ruby 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18276391e184a1370aec5c66d03e3e1ae7beb424efbaedeb80974c3c9a8acb4c
+  data.tar.gz: 9c8e1e3b87db78efdbc2be48c5b9d98cc55318918fb8caefbcbe0bab81569ba8
+SHA512:
+  metadata.gz: dfd3a9640e671bbc86c3070602b1be24cc1ce9ceb02d9b12842a545229d36701a0dc1072eef2984cbfcf07df26b80d9ee91d90bfef32c69331c0ec50c9b5f11c
+  data.tar.gz: b1ee5034008ddf655f17b3cc1221b95fc2e0249f900ec9242f8d063a8f8aabb99968fa07bb2cc94e9de5f583a467e7a43068f6ed6138427da481a5e733abaf22

data/CHANGELOG.md

@@ -0,0 +1,197 @@
+# 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
+
+## [1.7.0] - 2018-08-17
+
+* [#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`.
+
+## [1.6.0] - 2016-06-15
+
+* Rename sarvwaveApi#salt to #secret
+
+## [1.5.0] - 2016-04-07
+
+* 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.
+
+## [1.4.0] - 2015-07-20
+
+* 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.
+
+## [1.3.0] - 2014-05-11
+
+* 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
+  https://github.com/mconf/sarvwave-api-ruby/pull/6.
+
+## [1.2.0] - 2013-03-13
+
+*  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
+
+## [1.1.1] - 2013-01-30
+
+* sarvwaveApi can now receive http headers to be sent in all get/post
+  requests
+
+## [1.1.0] - 2012-05-04
+
+* Updated ruby to 1.9.3-194.
+* Support to sarvwave 0.4 rc1.
+
+## [1.0.0] - 2012-05-04
+
+* Version 0.1.0 renamed to 1.0.0.
+
+## [0.1.0] - 2011-11-25
+
+* 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
+    http://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).
+
+## [0.0.11] - 2011-09-01
+
+* 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.
+
+## [0.0.10] - 2011-04-28
+
+* 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)
+
+## [0.0.9] - 2011-04-08
+
+* Simplied "attendees" part of the hash returned in get_meeting_info. Same
+  thing done for get_meetings.
+
+## [0.0.8] - 2011-04-06
+
+* New method get_api_version that returns the version of the server API (>= 0.7).
+* New simplified hash syntax for get_meetings. See docs for details.
+
+## [0.0.7] - 2011-04-06
+
+## [0.0.6] - 2011-04-05
+
+* 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.
+
+## 0.0.4
+
+* 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.
+
+## 0.0.3
+
+* Fixes module issue preventing proper throwing of exceptions.
+
+## 0.0.1
+
+* 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.
+
+<!-- PRs -->
+[#50]: https://github.com/mconf/sarvwave-api-ruby/pull/50
+[#43]: https://github.com/mconf/sarvwave-api-ruby/pull/43
+[#42]: https://github.com/mconf/sarvwave-api-ruby/pull/42
+[#40]: https://github.com/mconf/sarvwave-api-ruby/pull/40
+[#35]: https://github.com/mconf/sarvwave-api-ruby/pull/35
+[#34]: https://github.com/mconf/sarvwave-api-ruby/pull/34
+[#33]: https://github.com/mconf/sarvwave-api-ruby/pull/33
+[#31]: https://github.com/mconf/sarvwave-api-ruby/pull/31
+[#29]: https://github.com/mconf/sarvwave-api-ruby/pull/29
+
+<!-- Versions -->
+[1.8.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.7.0...v1.8.0
+[1.7.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.6.0...v1.7.0
+[1.6.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.5.0...v1.6.0
+[1.5.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.4.0...v1.5.0
+[1.4.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.1.1...v1.2.0
+[1.1.1]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.1.0...v1.0.0
+[0.1.0]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.0.11...v0.1.0
+[0.0.11]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.0.10...v0.0.11
+[0.0.10]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.0.9...v0.0.10
+[0.0.9]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.0.8...v0.0.9
+[0.0.8]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/mconf/sarvwave-api-ruby/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/mconf/sarvwave-api-ruby/compare/b586c4726d32e9c30139357bcbe2067f868ff36c...v0.0.6

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2011-2016 Mconf (http://mconf.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This project is developed as part of Mconf (http://mconf.org).
+Contact information:
+  Mconf: A scalable opensource multiconference system for web and mobile devices
+  PRAV Labs - UFRGS - Porto Alegre - Brazil
+  http://www.inf.ufrgs.br/prav/gtmconf

data/LICENSE_003

@@ -0,0 +1,20 @@
+== sarvwave
+
+Copyright (c) 2010 Joe Kinsella
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# sarvwave-api-ruby [<img src="http://travis-ci.org/mconf/sarvwave-api-ruby.png"/>](http://travis-ci.org/mconf/sarvwave-api-ruby)
+
+This is a ruby gem that provides access to the API of
+[sarvwave](http://sarvwave.org). See the documentation of the API
+[here](http://code.google.com/p/sarvwave/wiki/API).
+
+It enables a ruby application to interact with sarvwave by calling ruby
+methods instead of HTTP requests, making it a lot easier to interact with
+sarvwave. It also formats the responses to a ruby-friendly format and
+includes helper classes to deal with more complicated API calls, such as the
+pre-upload of slides.
+
+A few features it has:
+
+* 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 `sarvwaveException` exceptions;
+* Support to multiple sarvwave API versions (see below).
+
+## Supported versions
+
+This gem is mainly used with [Mconf-Web](https://github.com/mconf/mconf-web) through
+[SarvwaveRails](https://github.com/mconf/sarvwave_rails).
+You can always use it as a reference for verions of dependencies and examples of how
+to use the gem.
+
+### sarvwave
+
+The current version of this gem supports *all* the following versions of
+sarvwave:
+
+* 1.0
+* 0.9 (includes all 0.9.x)
+* 0.81
+* 0.8
+
+Older versions:
+
+* 0.7 (including 0.7, 0.71 and 0.71a): The last version with support to 0.7*
+  is [version
+  1.2.0](https://github.com/mconf/sarvwave-api-ruby/tree/v1.2.0). It
+  supports versions 0.7 and 0.8.
+* 0.64: see the branch `api-0.64`. The last version with support to 0.64 is
+  [version
+  0.0.10](https://github.com/mconf/sarvwave-api-ruby/tree/v0.0.10). It
+  supports versions 0.64 and 0.7.
+
+### Ruby
+
+Tested in rubies:
+
+* ruby-2.2 **recommended**
+* ruby-2.1
+* ruby-2.0 (p353)
+* ruby-1.9.3 (p484)
+* ruby-1.9.2 (p290)
+
+Use these versions to be sure it will work. Other patches and patch versions of these
+rubies (e.g. ruby 1.9.3-p194 or 2.1.2) should work as well.
+
+## Releases
+
+For a list of releases and release notes see
+[CHANGELOG.md](https://github.com/mconf/sarvwave-api-ruby/blob/master/CHANGELOG.md).
+
+## Development
+
+Information for developers of `sarvwave-api-ruby` can be found in [our
+wiki](https://github.com/mconf/sarvwave-api-ruby/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](https://github.com/mconf/wiki/wiki).
+
+## License
+
+Distributed under The MIT License (MIT). See
+[LICENSE](https://github.com/mconf/sarvwave-api-ruby/blob/master/LICENSE)
+for the latest license, valid for all versions after 0.0.4 (including it), and
+[LICENSE_003](https://github.com/mconf/sarvwave-api-ruby/blob/master/LICENSE_003)
+for version 0.0.3 and all the previous versions.
+
+## Contact
+
+This project is developed as part of Mconf (http://mconf.org).
+
+Mailing list:
+* mconf-dev@googlegroups.com
+
+Contact:
+* Mconf: A scalable opensource multiconference system for web and mobile devices
+* PRAV Labs - UFRGS - Porto Alegre - Brazil
+* http://www.inf.ufrgs.br/prav/gtmconf

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: sarvwave-api-ruby
+version: !ruby/object:Gem::Version
+  version: 1.8.0
+platform: ruby
+authors:
+- Mconf
+- Leonardo Crauss Daronco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.11
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Provides methods to access sarvwave in a ruby application through its
+  API
+email:
+- contact@mconf.org
+- leonardodaronco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+- LICENSE_003
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- LICENSE
+- LICENSE_003
+- README.md
+homepage: https://github.com/mconf/sarvwave-api-ruby/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: sarvwave integration for ruby
+test_files: []