bigbluebutton-api-ruby 1.3.0 → 1.8.0

data/spec/bigbluebutton_config_xml_spec.rb

@@ -168,10 +168,28 @@ describe BigBlueButton::BigBlueButtonConfigXml do
       end
 
       context "if the module and attribute are found" do
-        before(:each) {
-          target.set_attribute("LayoutModule", "layoutConfig", "value").should eql("value")
-        }
-        it { target.get_attribute("LayoutModule", "layoutConfig").should eql("value") }
+        context "setting an attribute as string" do
+          before(:each) {
+            target.set_attribute("LayoutModule", "layoutConfig", "value").should eql("value")
+          }
+          it { target.get_attribute("LayoutModule", "layoutConfig").should eql("value") }
+        end
+
+        context "sets values always as string" do
+          context "boolean" do
+            before(:each) {
+              target.set_attribute("LayoutModule", "layoutConfig", true).should eql("true")
+            }
+            it { target.get_attribute("LayoutModule", "layoutConfig").should eql("true") }
+          end
+
+          context "Hash" do
+            before(:each) {
+              target.set_attribute("LayoutModule", "layoutConfig", {}).should eql("{}")
+            }
+            it { target.get_attribute("LayoutModule", "layoutConfig").should eql("{}") }
+          end
+        end
       end
 
       context "if the module is not found" do
@@ -271,6 +289,14 @@ describe BigBlueButton::BigBlueButtonConfigXml do
       }
       it { target.is_modified?.should be_false }
     end
+
+    context "if an attribute is set to the same value it already had, but with a different type" do
+      before(:each) {
+        # it's already false in the original XML, but as a string, not boolean
+        target.set_attribute("LayoutModule", "enableEdit", false)
+      }
+      it { target.is_modified?.should be_false }
+    end
   end
 
 end

data/spec/bigbluebutton_formatter_spec.rb

@@ -100,14 +100,43 @@ describe BigBlueButton::BigBlueButtonFormatter do
     it { hash[:param7].should == nil }
     it { hash[:param8].should == nil }
 
-    context "returns nil if the param doesn't exists" do
-      subject { BigBlueButton::BigBlueButtonFormatter.new({ :param => 1}) }
-      it { subject.to_datetime(:inexistent).should == nil }
-    end
+    context "returns nil if" do
+      context "the param doesn't exists" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ :param => 1}) }
+        it { subject.to_datetime(:inexistent).should == nil }
+      end
 
-    context "returns nil if the hash is nil" do
-      subject { BigBlueButton::BigBlueButtonFormatter.new(nil) }
-      it { subject.to_datetime(:inexistent).should == nil }
+      context "the hash is nil" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new(nil) }
+        it { subject.to_datetime(:inexistent).should == nil }
+      end
+
+      context "the value is an empty string" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: '' }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      context "the value is nil" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: nil }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      context "the value is an empty hash" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: {} }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      context "the value is an empty array" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: [] }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      ['null', 'NULL'].each do |v|
+        context "the value is '#{v}'" do
+          subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: v }) }
+          it { subject.to_datetime(:param1).should == nil }
+        end
+      end
     end
   end
 

metadata

@@ -1,57 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
-  prerelease: 
+  version: 1.8.0
 platform: ruby
 authors:
+- Mconf
 - Leonardo Crauss Daronco
-- Joe Kinsella
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2021-12-06 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
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
-description: Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)
+        version: '1.1'
+description: Provides methods to access BigBlueButton in a ruby application through
+  its API
 email:
+- contact@mconf.org
 - leonardodaronco@gmail.com
-- joe.kinsella@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - LICENSE
 - LICENSE_003
-- CHANGELOG.rdoc
+- CHANGELOG.md
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
-- CHANGELOG.rdoc
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - LICENSE_003
-- README.rdoc
+- README.md
 - Rakefile
 - bigbluebutton-api-ruby.gemspec
+- docker-compose.yml
 - examples/config_xml.rb
 - examples/create.rb
 - examples/get_version_example.rb
@@ -84,6 +168,7 @@ files:
 - lib/bigbluebutton_hash_to_xml.rb
 - lib/bigbluebutton_modules.rb
 - spec/bigbluebutton_api_0.81_spec.rb
+- spec/bigbluebutton_api_0.9_spec.rb
 - spec/bigbluebutton_api_spec.rb
 - spec/bigbluebutton_config_layout_spec.rb
 - spec/bigbluebutton_config_xml_spec.rb
@@ -96,33 +181,26 @@ files:
 - spec/support/forgery/forgeries/random_name.rb
 - spec/support/forgery/forgeries/url.rb
 homepage: https://github.com/mconf/bigbluebutton-api-ruby/
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1402282552445394412
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1402282552445394412
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
-summary: Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)
+specification_version: 4
+summary: BigBlueButton integration for ruby
 test_files: []

data/CHANGELOG.rdoc

@@ -1,90 +0,0 @@
-=== 1.3.0
-
-* Drop support to BigBlueButton 0.7 and add BigBlueButton to 0.81. Includes support to the new API calls <tt>getDefaultConfigXML</tt> and <tt>setConfigXML</tt>.
-* Reviewed all methods responses (some changed a bit) and documentation.
-* Allow non standard options to be passed to *all* API calls.
-* Removed method <tt>join_meeting</tt> that was usually not used. Should always use <tt>join_meeting_url</tt>.
-* Moved the hash extension method <tt>from_xml</tt> to its own class to prevent conflicts with Rails. See https://github.com/mconf/bigbluebutton-api-ruby/pull/6.
-
-=== 1.2.0
-
-* 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 BigBlueButton.
-* Accept :record as boolean in create_meeting
-* Better formatting of data returned by get_recordings
-
-=== 1.1.1
-
-* BigBlueButtonApi can now receive http headers to be sent in all get/post requests
-
-=== 1.1.0
-
-* Updated ruby to 1.9.3-194.
-* Support to BigBlueButton 0.4 rc1.
-
-=== 1.0.0
-
-* Version 0.1.0 renamed to 1.0.0.
-
-=== 0.1.0
-
-* Support to BigBlueButton 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 BigBlueButton docs at http://code.google.com/p/bigbluebutton/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
-
-* The file "bigbluebutton-api" was renamed to "bigbluebutton_api". All "require" calls must be updated.
-* Splitted the library in more files (more modular) and created rspec tests for it.
-* Added a BigBlueButtonApi.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 BBB server version if not informed by the user.
-
-=== 0.0.10
-
-* 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
-
-* Simplied "attendees" part of the hash returned in get_meeting_info. Same thing done for get_meetings.
-
-=== 0.0.8
-
-* 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.6
-
-* 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.
-  * BigBlueButtonException has now a "key" attribute to store the "messageKey" returned by BBB in failures.
-
-=== 0.0.4
-
-* Added support for BigBlueButton 0.7.
-* Gem renamed from 'bigbluebutton' to 'bigbluebutton-api-ruby'.
-* API functions now return a hash and instead of the XML returned by BBB. 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 bbb 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.

data/README.rdoc

@@ -1,62 +0,0 @@
-= bigbluebutton-api-ruby {<img src="http://travis-ci.org/mconf/bigbluebutton-api-ruby.png"/>}[http://travis-ci.org/mconf/bigbluebutton-api-ruby]
-
-This is a ruby gem that provides access to the API of {BigBlueButton}[http://bigbluebutton.org].
-See the documentation of the API {here}[http://code.google.com/p/bigbluebutton/wiki/API].
-
-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. 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 <tt>true</tt>);
-* Deals with errors (e.g. timeouts) throwing <tt>BigBlueButtonException</tt> exceptions;
-* Support to multiple BigBlueButton API versions (see below).
-
-== Supported BigBlueButton versions
-
-The current version of this gem supports <em>all</em> the following versions of BigBlueButton:
-
-* 0.8
-* 0.81
-
-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/bigbluebutton-api-ruby/tree/v1.2.0]. It supports versions 0.7 and 0.8.
-* 0.64: see the branch <tt>api-0.64</tt>. The last version with support to 0.64 is {version 0.0.10}[https://github.com/mconf/bigbluebutton-api-ruby/tree/v0.0.10]. It supports versions 0.64 and 0.7.
-
-== Supported ruby versions
-
-Tested in rubies:
-
-* ruby-2.0.0 (p353)
-* ruby-1.9.3 (p484) *recommended*
-* ruby-1.9.2 (p290)
-
-Use these versions to be sure it will work. Other patches of these rubies (e.g. ruby 1.9.3-p194) should work as well.
-
-== Releases
-
-For a list of releases and release notes see {CHANGELOG.rdoc}[https://github.com/mconf/bigbluebutton-api-ruby/blob/master/CHANGELOG.rdoc].
-
-== Development
-
-Information for developers of <tt>bigbluebutton-api-ruby</tt> can be found in {our wiki}[https://github.com/mconf/bigbluebutton-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/bigbluebutton-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/bigbluebutton-api-ruby/blob/master/LICENSE_003] for version 0.0.3 and all the previous versions.
-
-== Contact
-
-<b>Version 0.0.4+</b>: This project is developed as part of Mconf (http://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: http://www.inf.ufrgs.br/prav/gtmconf
-
-<b>Version 0.0.3 and below</b>: Joe Kinsella (joe.kinsella@gmail.com), Home page: http://www.brownbaglunch.com/bigbluebutton