bigbluebutton-api-ruby 1.2.0 → 1.3.0

data/spec/bigbluebutton_config_layout_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe BigBlueButton::BigBlueButtonConfigLayout do
+
+  let(:default_xml) { # a simplified layouts.xml file
+    "<layouts>
+       <layout name=\"Default\" default=\"true\">
+         <window name=\"NotesWindow\" hidden=\"true\" width=\"0.7\" height=\"1\" x=\"0\" y=\"0\" draggable=\"false\" resizable=\"false\"/>
+       </layout>
+       <layout name=\"Video Chat\">
+         <window name=\"NotesWindow\" hidden=\"true\" width=\"0.7\" height=\"1\" x=\"0\" y=\"0\" draggable=\"false\" resizable=\"false\"/>
+       </layout>
+     </layouts>"
+  }
+
+  describe "#initialize" do
+    context "with a valid xml" do
+      before {
+        XmlSimple.should_receive(:xml_in)
+          .with(default_xml, { 'ForceArray' => false, 'KeepRoot' => true })
+          .and_return("internal_xml")
+      }
+      subject { BigBlueButton::BigBlueButtonConfigLayout.new(default_xml) }
+      it("creates and stores a correct internal xml") { subject.xml.should eql("internal_xml") }
+    end
+
+    context "with an empty string as xml" do
+      it "throws an exception" do
+        expect {
+          BigBlueButton::BigBlueButtonConfigLayout.new("")
+        }.to raise_error(BigBlueButton::BigBlueButtonException)
+      end
+    end
+
+    context "throws any exception thrown by XmlSimple" do
+      before {
+        XmlSimple.should_receive(:xml_in) { raise Exception }
+      }
+      it {
+        expect {
+          BigBlueButton::BigBlueButtonConfigLayout.new(default_xml)
+        }.to raise_error(BigBlueButton::BigBlueButtonException)
+      }
+    end
+  end
+
+  describe "#get_available_layouts" do
+    subject { target.get_available_layouts }
+
+    context "returns nil if the xml has no <layouts>" do
+      let(:target) { BigBlueButton::BigBlueButtonConfigLayout.new("<test></test>") }
+      it { should be_nil }
+    end
+
+    context "returns nil if the xml has no <layouts><layout>" do
+      let(:target) { BigBlueButton::BigBlueButtonConfigLayout.new("<layouts></layouts>") }
+      it { should be_nil }
+    end
+
+    context "returns the correct available layout names" do
+      let(:target) { BigBlueButton::BigBlueButtonConfigLayout.new(default_xml) }
+      it { should be_instance_of(Array) }
+      it { subject.count.should be(2) }
+      it { should include("Default") }
+      it { should include("Video Chat") }
+    end
+
+    context "doesn't return duplicated layouts" do
+      let(:layouts_xml) {
+        "<layouts>
+           <layout name=\"Default\" default=\"true\">
+             <window name=\"NotesWindow\" hidden=\"true\" width=\"0.7\" height=\"1\" x=\"0\" y=\"0\" draggable=\"false\" resizable=\"false\"/>
+           </layout>
+           <layout name=\"Default\">
+             <window name=\"NotesWindow\" hidden=\"true\" width=\"0.7\" height=\"1\" x=\"0\" y=\"0\" draggable=\"false\" resizable=\"false\"/>
+           </layout>
+         </layouts>"
+      }
+      let(:target) { BigBlueButton::BigBlueButtonConfigLayout.new(layouts_xml) }
+      it { should be_instance_of(Array) }
+      it { subject.count.should be(1) }
+      it { should include("Default") }
+    end
+  end
+
+end

data/spec/bigbluebutton_config_xml_spec.rb

@@ -0,0 +1,276 @@
+require 'spec_helper'
+
+describe BigBlueButton::BigBlueButtonConfigXml do
+
+  let(:default_xml) { # a simplified config.xml file
+    "<config>
+       <help url=\"http://test-server.org/help.html\"/>
+       <modules>
+         <module name=\"LayoutModule\" url=\"http://test-server.org/client/LayoutModule.swf?v=4357\"
+                 uri=\"rtmp://test-server.org/bigbluebutton\"
+                 layoutConfig=\"http://test-server.org/client/conf/layout.xml\"
+                 enableEdit=\"false\"/>
+       </modules>
+     </config>"
+  }
+
+  let(:complex_xml) {
+    "<config>\
+       <localeversion suppressWarning=\"false\">0.8</localeversion>\
+       <version>4357-2014-02-06</version>\
+       <help url=\"http://test-server.org/help.html\"/>\
+       <javaTest url=\"http://test-server.org/testjava.html\"/>\
+       <modules>
+         <module name=\"ChatModule\" url=\"http://test-server.org/client/ChatModule.swf\"
+                 uri=\"rtmp://test-server.org/bigbluebutton\"
+                 dependsOn=\"UsersModule\" translationOn=\"false\"
+                 translationEnabled=\"false\" privateEnabled=\"true\"
+                 position=\"top-right\" baseTabIndex=\"701\"/>
+         <module name=\"UsersModule\" url=\"http://test-server.org/client/UsersModule.swf\"
+                 uri=\"rtmp://test-server.org/bigbluebutton\"
+                 allowKickUser=\"true\" enableRaiseHand=\"true\"
+                 enableSettingsButton=\"true\" baseTabIndex=\"301\"/>
+         <module name=\"LayoutModule\" url=\"http://test-server.org/client/LayoutModule.swf?v=4357\"
+                 uri=\"rtmp://test-server.org/bigbluebutton\"
+                 layoutConfig=\"http://test-server.org/client/conf/layout.xml\"
+                 enableEdit=\"false\"/>
+       </modules>
+     </config>"
+  }
+
+  describe "#initialize" do
+    context "with a valid xml" do
+      before {
+        XmlSimple.should_receive(:xml_in)
+          .with(default_xml, { 'ForceArray' => false, 'KeepRoot' => true })
+          .and_return("response")
+      }
+      subject { BigBlueButton::BigBlueButtonConfigXml.new(default_xml) }
+      it("creates and stores a correct internal xml") { subject.xml.should eql("response") }
+    end
+
+    context "with an empty string as xml" do
+      it "throws an exception" do
+        expect {
+          BigBlueButton::BigBlueButtonConfigXml.new("")
+        }.to raise_error(BigBlueButton::BigBlueButtonException)
+      end
+    end
+
+    context "throws any exception thrown by XmlSimple" do
+      before {
+        XmlSimple.should_receive(:xml_in) { raise Exception }
+      }
+      it {
+        expect {
+          BigBlueButton::BigBlueButtonConfigXml.new(default_xml)
+        }.to raise_error(BigBlueButton::BigBlueButtonException)
+      }
+    end
+  end
+
+  describe "#get_attribute" do
+    let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(default_xml) }
+
+    context "searching inside a module" do
+      context "if the xml has no <config>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<any></any>") }
+        subject { target.get_attribute("LayoutModule", "layoutConfig") }
+        it { should be_nil }
+      end
+
+      context "if the xml has no <config><modules>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<config></config>") }
+        subject { target.get_attribute("LayoutModule", "layoutConfig") }
+        it { should be_nil }
+      end
+
+      context "if the xml has no <config><modules><module>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<config><modules></modules></config>") }
+        subject { target.get_attribute("LayoutModule", "layoutConfig") }
+        it { should be_nil }
+      end
+
+      context "if the module and attribute are found" do
+        subject { target.get_attribute("LayoutModule", "layoutConfig") }
+        it { should eql("http://test-server.org/client/conf/layout.xml") }
+      end
+
+      context "if the module is not found" do
+        subject { target.get_attribute("InexistentModule", "layoutConfig") }
+        it { should be_nil }
+      end
+
+      context "if the attribute is not found" do
+        subject { target.get_attribute("LayoutModule", "inexistentAttribute") }
+        it { should be_nil }
+      end
+
+      # just to make sure it won't break in a more complete config.xml
+      context "works with a complex xml" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(complex_xml) }
+        subject { target.get_attribute("LayoutModule", "layoutConfig") }
+        it { should eql("http://test-server.org/client/conf/layout.xml") }
+      end
+    end
+
+    context "searching outside a module" do
+      context "if the xml has no <config>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<any></any>") }
+        subject { target.get_attribute("help", "url", false) }
+        it { should be_nil }
+      end
+
+      context "if the tag and attribute are found" do
+        subject { target.get_attribute("help", "url", false) }
+        it { should eql("http://test-server.org/help.html") }
+      end
+
+      context "if the tag is not found" do
+        subject { target.get_attribute("inexistent", "url", false) }
+        it { should be_nil }
+      end
+
+      context "if the attribute is not found" do
+        subject { target.get_attribute("help", "inexistent", false) }
+        it { should be_nil }
+      end
+
+      # just to make sure it won't break in a more complete config.xml
+      context "works with a complex xml" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(complex_xml) }
+        subject { target.get_attribute("help", "url", false) }
+        it { should eql("http://test-server.org/help.html") }
+      end
+    end
+  end
+
+  describe "#set_attribute" do
+    let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(default_xml) }
+
+    context "setting an attribute inside a module" do
+      context "if the xml has no <config>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<any></any>") }
+        subject { target.set_attribute("LayoutModule", "layoutConfig", "value") }
+        it { should be_nil }
+      end
+
+      context "if the xml has no <config><modules>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<config></config>") }
+        subject { target.set_attribute("LayoutModule", "layoutConfig", "value") }
+        it { should be_nil }
+      end
+
+      context "if the xml has no <config><modules><module>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<config><modules></modules></config>") }
+        subject { target.set_attribute("LayoutModule", "layoutConfig", "value") }
+        it { should be_nil }
+      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") }
+      end
+
+      context "if the module is not found" do
+        subject { target.set_attribute("InexistentModule", "layoutConfig", "value") }
+        it { should be_nil }
+      end
+
+      context "if the attribute is not found" do
+        subject { target.set_attribute("LayoutModule", "inexistentAttribute", "value") }
+        it { should be_nil }
+      end
+
+      # just to make sure it won't break in a more complete config.xml
+      context "works with a complex xml" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(complex_xml) }
+        before(:each) {
+          target.set_attribute("LayoutModule", "layoutConfig", "value").should eql("value")
+        }
+        it { target.get_attribute("LayoutModule", "layoutConfig").should eql("value") }
+      end
+    end
+
+    context "setting an attribute outside of a module" do
+      context "if the xml has no <config>" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new("<any></any>") }
+        subject { target.set_attribute("help", "url", "value", false) }
+        it { should be_nil }
+      end
+
+      context "if the module and attribute are found" do
+        before(:each) {
+          target.set_attribute("help", "url", "value", false).should eql("value")
+        }
+        it { target.get_attribute("help", "url", false).should eql("value") }
+      end
+
+      context "if the module is not found" do
+        subject { target.set_attribute("InexistentModule", "url", "value", false) }
+        it { should be_nil }
+      end
+
+      context "if the attribute is not found" do
+        subject { target.set_attribute("help", "inexistentAttribute", "value", false) }
+        it { should be_nil }
+      end
+
+      # just to make sure it won't break in a more complete config.xml
+      context "works with a complex xml" do
+        let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(complex_xml) }
+        before(:each) {
+          target.set_attribute("help", "url", "value", false).should eql("value")
+        }
+        it { target.get_attribute("help", "url", false).should eql("value") }
+      end
+    end
+
+  end
+
+  describe "#as_string" do
+    context "for a simple xml" do
+      let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(default_xml) }
+      subject { target.as_string }
+      it {
+        # it is the same XML as `default_xml`, just formatted slightly differently
+        expected = "<config><help url=\"http://test-server.org/help.html\" /><modules><module name=\"LayoutModule\" url=\"http://test-server.org/client/LayoutModule.swf?v=4357\" uri=\"rtmp://test-server.org/bigbluebutton\" layoutConfig=\"http://test-server.org/client/conf/layout.xml\" enableEdit=\"false\" /></modules></config>"
+        should eql(expected)
+      }
+    end
+
+    context "for a complex xml" do
+      let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(complex_xml) }
+      subject { target.as_string }
+      it {
+        # it is the same XML as `default_xml`, just formatted slightly differently
+        expected = "<config version=\"4357-2014-02-06\"><localeversion suppressWarning=\"false\">0.8</localeversion><help url=\"http://test-server.org/help.html\" /><javaTest url=\"http://test-server.org/testjava.html\" /><modules><module name=\"ChatModule\" url=\"http://test-server.org/client/ChatModule.swf\" uri=\"rtmp://test-server.org/bigbluebutton\" dependsOn=\"UsersModule\" translationOn=\"false\" translationEnabled=\"false\" privateEnabled=\"true\" position=\"top-right\" baseTabIndex=\"701\" /><module name=\"UsersModule\" url=\"http://test-server.org/client/UsersModule.swf\" uri=\"rtmp://test-server.org/bigbluebutton\" allowKickUser=\"true\" enableRaiseHand=\"true\" enableSettingsButton=\"true\" baseTabIndex=\"301\" /><module name=\"LayoutModule\" url=\"http://test-server.org/client/LayoutModule.swf?v=4357\" uri=\"rtmp://test-server.org/bigbluebutton\" layoutConfig=\"http://test-server.org/client/conf/layout.xml\" enableEdit=\"false\" /></modules></config>"
+        should eql(expected)
+      }
+    end
+  end
+
+  describe "#is_modified?" do
+    let(:target) { BigBlueButton::BigBlueButtonConfigXml.new(default_xml) }
+
+    context "before any attribute is set" do
+      it { target.is_modified?.should be_false }
+    end
+
+    context "after setting an attribute" do
+      before(:each) { target.set_attribute("LayoutModule", "layoutConfig", "value") }
+      it { target.is_modified?.should be_true }
+    end
+
+    context "if an attribute is set to the same value it already had" do
+      before(:each) {
+        value = target.get_attribute("LayoutModule", "layoutConfig")
+        target.set_attribute("LayoutModule", "layoutConfig", value)
+      }
+      it { target.is_modified?.should be_false }
+    end
+  end
+
+end

data/spec/bigbluebutton_formatter_spec.rb

@@ -70,10 +70,17 @@ describe BigBlueButton::BigBlueButtonFormatter do
   end
 
   describe "#to_datetime" do
-    let(:hash) { { :param1 => "Thu Sep 01 17:51:42 UTC 2011", :param2 => "Thu Sep 08",
-                   :param3 => 1315254777880, :param4 => "1315254777880",
-                   :param5 => "0", :param6 => 0,
-                   :param7 => "NULL", :param8 => nil } }
+    let(:hash) {
+      { :param1 => "Thu Sep 01 17:51:42 UTC 2011",
+        :param2 => "Thu Sep 08",
+        :param3 => 1315254777880,
+        :param4 => "1315254777880",
+        :param5 => "0",
+        :param6 => 0,
+        :param7 => "NULL",
+        :param8 => nil
+      }
+    }
     let(:formatter) { BigBlueButton::BigBlueButtonFormatter.new(hash) }
     before {
       formatter.to_datetime(:param1)
@@ -201,17 +208,25 @@ describe BigBlueButton::BigBlueButtonFormatter do
 
   describe ".format_meeting" do
     let(:hash) {
-      { :meetingID => 123, :moderatorPW => 111, :attendeePW => 222,
-        :hasBeenForciblyEnded => "FALSE", :running => "TRUE", :createTime => "123456789" }
+      { :meetingID => 123, :meetingName => 123, :moderatorPW => 111, :attendeePW => 222,
+        :hasBeenForciblyEnded => "FALSE", :running => "TRUE", :createTime => "123456789",
+        :dialNumber => 1234567890, :voiceBridge => "12345",
+        :participantCount => "10", :listenerCount => "3", :videoCount => "5" }
     }
 
     subject { BigBlueButton::BigBlueButtonFormatter.format_meeting(hash) }
     it { subject[:meetingID].should == "123" }
+    it { subject[:meetingName].should == "123" }
     it { subject[:moderatorPW].should == "111" }
     it { subject[:attendeePW].should == "222" }
     it { subject[:hasBeenForciblyEnded].should == false }
     it { subject[:running].should == true }
     it { subject[:createTime].should == 123456789 }
+    it { subject[:voiceBridge].should == 12345 }
+    it { subject[:dialNumber].should == "1234567890" }
+    it { subject[:participantCount].should == 10 }
+    it { subject[:listenerCount].should == 3 }
+    it { subject[:videoCount].should == 5 }
   end
 
   describe ".format_attendee" do
@@ -282,6 +297,13 @@ describe BigBlueButton::BigBlueButtonFormatter do
         it { subject.should == { :objects => [] } }
       end
 
+      context "when the target key doesn't exist in the hash" do
+        let(:hash) { { } }
+        before { formatter.hash = hash }
+        subject { formatter.flatten_objects(:objects, :object) }
+        it { subject.should == { :objects => [] } } # adds the one the doesn't exist
+      end
+
       context "when there's only one object in the list" do
         let(:object_hash) { { :id => 1 } }
         let(:hash) { { :objects => { :object => object_hash } } }

data/spec/{hash_to_xml_spec.rb → bigbluebutton_hash_to_xml_spec.rb}

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe Hash do
+describe BigBlueButton::BigBlueButtonHash do
 
   describe ".from_xml" do
     it "simple example" do
       xml = "<response><returncode>1</returncode></response>"
       hash = { :returncode => "1" }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
 
     it "maintains all values as strings" do
@@ -16,7 +16,7 @@ describe Hash do
             "  <node3>true</node3>" \
             "</parent>"
       hash = { :node1 => "1", :node2 => "string", :node3 => "true" }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
 
     it "works for xmls with multiple levels" do
@@ -28,7 +28,7 @@ describe Hash do
             "  </node1>" \
             "</parent>"
       hash = { :node1 => { :node2 => { :node3 => "true" } } }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
 
     it "transforms CDATA fields to string" do
@@ -37,7 +37,7 @@ describe Hash do
             "  <course><![CDATA[Advanced Ruby]]></course>" \
             "</parent>"
       hash = { :name => "Evening Class", :course => "Advanced Ruby" }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
 
     it "transforms duplicated keys in arrays" do
@@ -51,7 +51,7 @@ describe Hash do
             "</parent>"
       hash = { :meetings => { :meeting => [ "1", "2", { :details => "3" } ],
                               :other => "4" } }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
 
     it "works with attributes" do
@@ -59,7 +59,7 @@ describe Hash do
             "  <meeting attr1=\"v1\">1</meeting>" \
             "</parent>"
       hash = { :meeting => { :attr1 => "v1", :content => "1" } }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
 
     it "complex real example" do
@@ -104,7 +104,7 @@ describe Hash do
                    } ]
                  }
       }
-      Hash.from_xml(xml).should == hash
+      BigBlueButton::BigBlueButtonHash.from_xml(xml).should == hash
     end
   end
 
@@ -112,31 +112,31 @@ describe Hash do
     it "converts string-keys to symbols" do
       before = { "one" => 1, "two" => 2, "three" => 3 }
       after = { :one => 1, :two => 2, :three => 3 }
-      Hash.symbolize_keys(before).should == after
+      BigBlueButton::BigBlueButtonHash.symbolize_keys(before).should == after
     end
 
     it "maintains case" do
       before = { "One" => 1, "tWo" => 2, "thrEE" => 3 }
       after = { :One => 1, :tWo => 2, :thrEE => 3 }
-      Hash.symbolize_keys(before).should == after
+      BigBlueButton::BigBlueButtonHash.symbolize_keys(before).should == after
     end
 
     it "works with multilevel hashes" do
       before = { "l1" => { "l2" => { "l3" => 1 } }, "l1b" => 2 }
       after = { :l1 => { :l2 => { :l3 => 1 } }, :l1b => 2 }
-      Hash.symbolize_keys(before).should == after
+      BigBlueButton::BigBlueButtonHash.symbolize_keys(before).should == after
     end
 
     it "works with arrays" do
       before = { "a1" => [ "b1" => 1,  "b2" => 2 ], "b2" => 2 }
       after = { :a1 => [ :b1 => 1,  :b2 => 2 ], :b2 => 2 }
-      Hash.symbolize_keys(before).should == after
+      BigBlueButton::BigBlueButtonHash.symbolize_keys(before).should == after
     end
 
     it "doesn't convert values" do
       before = { "a" => "a", "b" => "b" }
       after = { :a => "a", :b => "b" }
-      Hash.symbolize_keys(before).should == after
+      BigBlueButton::BigBlueButtonHash.symbolize_keys(before).should == after
     end
   end