bigbluebutton-api-ruby 1.1.1 → 1.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 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

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    bigbluebutton-api-ruby (1.1.1)
+    bigbluebutton-api-ruby (1.2.0)
       xml-simple (>= 1.1.1)
 
 GEM

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Leonardo Crauss Daronco
+Copyright (c) 2011-2013 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
@@ -17,7 +17,8 @@ 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 software is developed at:
-  GT-Mconf: Multiconference system for interoperable web and mobile
+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/README.rdoc

@@ -53,6 +53,6 @@ See {LICENSE}[https://github.com/mconf/bigbluebutton-api-ruby/blob/master/LICENS
 
 == Contact
 
-<b>Version 0.0.4+</b>: Leonardo Crauss Daronco (leonardodaronco@gmail.com), GT-Mconf: Multiconference system for interoperable web and mobile @ PRAV Labs - UFRGS. Home page: http://www.inf.ufrgs.br/prav/gtmconf
+<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

data/bigbluebutton-api-ruby.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = 'bigbluebutton-api-ruby'
-  s.version = '1.1.1'
+  s.version = '1.2.0'
   s.extra_rdoc_files = ['README.rdoc', 'LICENSE', 'LICENSE_003', 'CHANGELOG.rdoc']
   s.summary = 'Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)'
   s.description = s.summary

data/examples/overall_0.7_example.rb

@@ -30,6 +30,14 @@ begin
     puts "  " + m[:meetingID] + ": " + m.inspect
   end
 
+  puts
+  puts "---------------------------------------------------"
+  response = @api.get_recordings
+  puts "Existent recordings in your server:"
+  response[:recordings].each do |m|
+    puts "  " + m[:recordID] + ": " + m.inspect
+  end
+
   puts
   puts "---------------------------------------------------"
   meeting_id = SecureRandom.hex(4)

data/lib/bigbluebutton_api.rb

@@ -102,7 +102,7 @@ module BigBlueButton
     #
     #   options = { :moderatorPW => "123", :attendeePW => "321", :welcome => "Welcome here!",
     #               :dialNumber => 5190909090, :logoutURL => "http://mconf.org", :maxParticipants => 25,
-    #               :voiceBridge => 76543, :record => "true", :duration => 0, :meta_category => "Remote Class" }
+    #               :voiceBridge => 76543, :record => true, :duration => 0, :meta_category => "Remote Class" }
     #   create_meeting("My Meeting", "my-meeting", options)
     #
     # === Example with modules (see BigBlueButtonModules docs for more)
@@ -142,19 +142,12 @@ module BigBlueButton
     #   }
     #
     def create_meeting(meeting_name, meeting_id, options={}, modules=nil)
-      valid_options = [:moderatorPW, :attendeePW, :welcome, :maxParticipants,
-                       :dialNumber, :voiceBridge, :webVoice, :logoutURL]
+      params = { :name => meeting_name, :meetingID => meeting_id }.merge(options)
 
-      selected_opt = options.clone
-      if @version >= "0.8"
-        # v0.8 added "record", "duration" and "meta_" parameters
-        valid_options += [:record, :duration]
-        selected_opt.reject!{ |k,v| !valid_options.include?(k) and !(k.to_s =~ /^meta_.*$/) }
-        selected_opt[:record] = selected_opt[:record].to_s if selected_opt.has_key?(:record)
-      else
-        selected_opt.reject!{ |k,v| !valid_options.include?(k) }
+      # :record is passed as string, but we accept boolean as well
+      if params[:record] and !!params[:record] == params[:record]
+        params[:record] = params[:record].to_s
       end
-      params = { :name => meeting_name, :meetingID => meeting_id }.merge(selected_opt)
 
       # with modules we send a post request (only for >= 0.8)
       if modules and @version >= "0.8"
@@ -209,12 +202,7 @@ module BigBlueButton
     #                              userID (string, int), webVoiceConf (string, int) and createTime (int).
     #                              For details about each see BBB API docs.
     def join_meeting_url(meeting_id, user_name, password, options={})
-      valid_options = [:userID, :webVoiceConf]
-      valid_options += [:createTime] if @version >= "0.8"
-      options.reject!{ |k,v| !valid_options.include?(k) }
-
       params = { :meetingID => meeting_id, :password => password, :fullName => user_name }.merge(options)
-
       get_url(:join, params)
     end
 
@@ -232,12 +220,7 @@ module BigBlueButton
     #                              userID (string, int), webVoiceConf (string, int) and createTime (int).
     #                              For details about each see BBB API docs.
     def join_meeting(meeting_id, user_name, password, options={})
-      valid_options = [:userID, :webVoiceConf]
-      valid_options += [:createTime] if @version >= "0.8"
-      options.reject!{ |k,v| !valid_options.include?(k) }
-
       params = { :meetingID => meeting_id, :password => password, :fullName => user_name }.merge(options)
-
       send_api_request(:join, params)
     end
 
@@ -361,24 +344,30 @@ module BigBlueButton
     #                                   :meetingID => ["id1", "id2", "id3"]
     #
     # === Example responses
-    # TODO: this example is not accurate yet
     #
     #   { :returncode => true,
     #     :recordings => [
     #       {
-    #         :recordID => "7f5745a08b24fa27551e7a065849dda3ce65dd32-1321618219268", :meetingID=>"bd1811beecd20f24314819a52ec202bf446ab94b",
-    #         :name => "Evening Class1", :published => true,
+    #         :recordID => "7f5745a08b24fa27551e7a065849dda3ce65dd32-1321618219268",
+    #         :meetingID=>"bd1811beecd20f24314819a52ec202bf446ab94b",
+    #         :name => "Evening Class1",
+    #         :published => true,
     #         :startTime => #<DateTime: 2011-11-18T12:10:23+00:00 (212188378223/86400,0/1,2299161)>,
     #         :endTime => #<DateTime: 2011-11-18T12:12:25+00:00 (42437675669/17280,0/1,2299161)>,
-    #         :metadata => { :course => "Fundamentals Of JAVA",
+    #         :metadata => { :course => "Fundamentals of JAVA",
     #                        :description => "List of recordings",
     #                        :activity => "Evening Class1" },
     #         :playback => {
-    #           :format => {
-    #             :type => "slides",
-    #             :url => "http://test-install.blindsidenetworks.com/playback/slides/playback.html?meetingId=7f5745a08b24fa27551e7a065849dda3ce65dd32-1321618219268",
-    #             :length=>3
-    #           }
+    #           :format => [
+    #             { :type => "slides",
+    #               :url => "http://test-install.blindsidenetworks.com/playback/slides/playback.html?meetingId=125468758b24fa27551e7a065849dda3ce65dd32-1329872486268",
+    #               :length => 64
+    #             },
+    #             { :type => "presentation",
+    #               :url => "http://test-install.blindsidenetworks.com/presentation/slides/playback.html?meetingId=125468758b24fa27551e7a065849dda3ce65dd32-1329872486268",
+    #               :length => 64
+    #             }
+    #           ]
     #         }
     #       },
     #       { :recordID => "183f0bf3a0982a127bdb8161-13085974450", :meetingID => "CS102",
@@ -391,9 +380,6 @@ module BigBlueButton
     def get_recordings(options={})
       raise BigBlueButtonException.new("Method only supported for versions >= 0.8") if @version < "0.8"
 
-      valid_options = [:meetingID]
-      options.reject!{ |k,v| !valid_options.include?(k) }
-
       # ["id1", "id2", "id3"] becomes "id1,id2,id3"
       if options.has_key?(:meetingID)
         options[:meetingID] = options[:meetingID].join(",") if options[:meetingID].instance_of?(Array)
@@ -424,7 +410,7 @@ module BigBlueButton
       raise BigBlueButtonException.new("Method only supported for versions >= 0.8") if @version < "0.8"
 
       recordIDs = recordIDs.join(",") if recordIDs.instance_of?(Array) # ["id1", "id2"] becomes "id1,id2"
-      response = send_api_request(:publishRecordings, { :recordID => recordIDs, :publish => publish.to_s })
+      send_api_request(:publishRecordings, { :recordID => recordIDs, :publish => publish.to_s })
     end
 
     # Delete one or more recordings for a given recordID (or set of record IDs).
@@ -443,7 +429,7 @@ module BigBlueButton
       raise BigBlueButtonException.new("Method only supported for versions >= 0.8") if @version < "0.8"
 
       recordIDs = recordIDs.join(",") if recordIDs.instance_of?(Array) # ["id1", "id2"] becomes "id1,id2"
-      response = send_api_request(:deleteRecordings, { :recordID => recordIDs })
+      send_api_request(:deleteRecordings, { :recordID => recordIDs })
     end
 
 
@@ -573,5 +559,3 @@ module BigBlueButton
 
   end
 end
-
-

data/lib/bigbluebutton_formatter.rb

@@ -117,6 +117,25 @@ module BigBlueButton
       f.to_boolean(:published)
       f.to_datetime(:startTime)
       f.to_datetime(:endTime)
+      if rec[:playback] and rec[:playback][:format]
+        if rec[:playback][:format].is_a?(Hash)
+          f2 = BigBlueButtonFormatter.new(rec[:playback][:format])
+          f2.to_int(:length)
+        elsif rec[:playback][:format].is_a?(Array)
+          rec[:playback][:format].each do |format|
+            f2 = BigBlueButtonFormatter.new(format)
+            f2.to_int(:length)
+          end
+        end
+      end
+      if rec[:metadata]
+        rec[:metadata].each do |key, value|
+          if value.nil? or value.empty? or value.split.empty?
+            # removes any no {}s, []s, or " "s, should always be empty string
+            rec[:metadata][key] = ""
+          end
+        end
+      end
       rec
     end
 

data/spec/bigbluebutton_api_0.8_spec.rb

@@ -107,10 +107,10 @@ describe BigBlueButton::BigBlueButtonApi do
       it { expect { api.get_recordings }.to raise_error(BigBlueButton::BigBlueButtonException) }
     end
 
-    context "discards invalid options" do
-      let(:req_params) { { :meetingID => "meeting-id" } }
-      before { api.should_receive(:send_api_request).with(:getRecordings, req_params).and_return(response) }
-      it { api.get_recordings({ :meetingID => "meeting-id", :invalidParam1 => "1" }) }
+    context "accepts non standard options" do
+      let(:params) { { :meetingID => "meeting-id", :nonStandard => 1 } }
+      before { api.should_receive(:send_api_request).with(:getRecordings, params).and_return(response) }
+      it { api.get_recordings(params) }
     end
 
     context "without meeting ID" do

data/spec/bigbluebutton_api_spec.rb

@@ -46,7 +46,7 @@ describe BigBlueButton::BigBlueButtonApi do
       let(:req_params) {
         { :name => "name", :meetingID => "meeting-id", :moderatorPW => "mp", :attendeePW => "ap",
           :welcome => "Welcome!", :dialNumber => 12345678, :logoutURL => "http://example.com",
-          :maxParticipants => 25, :voiceBridge => 12345, :webVoice => "12345abc" }
+          :maxParticipants => 25, :voiceBridge => 12345, :webVoice => "12345abc", :record => "true" }
       }
       let(:req_response) {
         { :meetingID => 123, :moderatorPW => 111, :attendeePW => 222, :hasBeenForciblyEnded => "FALSE" }
@@ -58,32 +58,33 @@ describe BigBlueButton::BigBlueButtonApi do
       # ps: not mocking the formatter here because it's easier to just check the results (final_response)
       before { api.should_receive(:send_api_request).with(:create, req_params).and_return(req_response) }
       subject {
-        options = { :moderatorPW => "mp", :attendeePW => "ap", :welcome => "Welcome!", :dialNumber => 12345678,
-          :logoutURL => "http://example.com", :maxParticipants => 25, :voiceBridge => 12345, :webVoice => "12345abc" }
+        options = { :moderatorPW => "mp", :attendeePW => "ap", :welcome => "Welcome!",
+          :dialNumber => 12345678, :logoutURL => "http://example.com", :maxParticipants => 25,
+          :voiceBridge => 12345, :webVoice => "12345abc", :record => "true" }
         api.create_meeting("name", "meeting-id", options)
       }
       it { subject.should == final_response }
     end
 
-    context "discards invalid options" do
-      let(:req_params) {
-        { :name => "name", :meetingID => "meeting-id", :moderatorPW => "mp", :attendeePW => "ap" }
-      }
-      before { api.should_receive(:send_api_request).with(:create, req_params) }
-      it {
-        options = { :invalidParam => "1", :moderatorPW => "mp", :attendeePW => "ap", :invalidParam2 => "1" }
-        api.create_meeting("name", "meeting-id", options)
+    context "accepts non standard options" do
+      let(:params) {
+        { :name => "name", :meetingID => "meeting-id",
+          :moderatorPW => "mp", :attendeePW => "ap", :nonStandard => 1 }
       }
+      before { api.should_receive(:send_api_request).with(:create, params) }
+      it { api.create_meeting("name", "meeting-id", params) }
     end
 
-    context "discards options for >0.7" do
+    context "accepts :record as boolean" do
       let(:req_params) {
-        { :name => "name", :meetingID => "meeting-id" }
+        { :name => "name", :meetingID => "meeting-id",
+          :moderatorPW => "mp", :attendeePW => "ap", :record => "true" }
       }
       before { api.should_receive(:send_api_request).with(:create, req_params) }
       it {
-        options = { :record => true, :duration => 25, :meta_any => "meta" }
-        api.create_meeting("name", "meeting-id", options)
+        params = { :name => "name", :meetingID => "meeting-id",
+          :moderatorPW => "mp", :attendeePW => "ap", :record => true }
+        api.create_meeting("name", "meeting-id", params)
       }
     end
   end
@@ -129,26 +130,13 @@ describe BigBlueButton::BigBlueButtonApi do
       }
     end
 
-    context "discards invalid options" do
+    context "accepts non standard options" do
       let(:params) {
-        { :meetingID => "meeting-id", :password => "pw", :fullName => "Name", :userID => "id123" }
+        { :meetingID => "meeting-id", :password => "pw",
+          :fullName => "Name", :userID => "id123", :nonStandard => 1 }
       }
       before { api.should_receive(:get_url).with(:join, params) }
-      it {
-        options = { :invalidParam => "1", :userID => "id123", :invalidParam2 => "1" }
-        api.join_meeting_url("meeting-id", "Name", "pw", options)
-      }
-    end
-
-    context "discards options for <= 0.7" do
-      let(:params) {
-        { :meetingID => "meeting-id", :password => "pw", :fullName => "Name" }
-      }
-      before { api.should_receive(:get_url).with(:join, params) }
-      it {
-        options = { :createTime => 123456789 }
-        api.join_meeting_url("meeting-id", "Name", "pw", options)
-      }
+      it { api.join_meeting_url("meeting-id", "Name", "pw", params) }
     end
   end
 
@@ -166,26 +154,13 @@ describe BigBlueButton::BigBlueButtonApi do
       }
     end
 
-    context "discards invalid options" do
-      let(:params) {
-        { :meetingID => "meeting-id", :password => "pw", :fullName => "Name", :userID => "id123" }
-      }
-      before { api.should_receive(:send_api_request).with(:join, params) }
-      it {
-        options = { :invalidParam => "1", :userID => "id123", :invalidParam2 => "1" }
-        api.join_meeting("meeting-id", "Name", "pw", options)
-      }
-    end
-
-    context "discards options for <= 0.7" do
+    context "accepts non standard options" do
       let(:params) {
-        { :meetingID => "meeting-id", :password => "pw", :fullName => "Name" }
+        { :meetingID => "meeting-id", :password => "pw",
+          :fullName => "Name", :userID => "id123", :nonStandard => 1 }
       }
       before { api.should_receive(:send_api_request).with(:join, params) }
-      it {
-        options = { :createTime => 123456789 }
-        api.join_meeting("meeting-id", "Name", "pw", options)
-      }
+      it { api.join_meeting("meeting-id", "Name", "pw", params) }
     end
   end
 

data/spec/bigbluebutton_formatter_spec.rb

@@ -224,28 +224,51 @@ describe BigBlueButton::BigBlueButtonFormatter do
   end
 
   describe ".format_recording" do
-    let(:hash) { { :recordID => 123, :meetingID => 123, :name => 123, :published => "true",
-                   :startTime => "Thu Mar 04 14:05:56 UTC 2010",
-                   :endTime => "Thu Mar 04 15:01:01 UTC 2010",
-                   :metadata => {
-                     :title => "Test Recording", :subject => "English 232 session",
-                     :description => "First Class", :creator => "Fred Dixon",
-                     :contributor => "Richard Alam", :language => "en_US"
-                    },
-                   :playback => {
-                     :format => {
-                       :type => "simple",
-                       :url => "http://server.com/simple/playback?recordID=183f0bf3a0982a127bdb8161-1",
-                       :length => 62 }
-                   }
-    } }
-
-    subject { BigBlueButton::BigBlueButtonFormatter.format_recording(hash) }
-    it { subject[:recordID].should == "123" }
-    it { subject[:meetingID].should == "123" }
-    it { subject[:name].should == "123" }
-    it { subject[:startTime].should == DateTime.parse("Thu Mar 04 14:05:56 UTC 2010") }
-    it { subject[:endTime].should == DateTime.parse("Thu Mar 04 15:01:01 UTC 2010") }
+    let(:hash) {
+      { :recordID => 123, :meetingID => 123, :name => 123, :published => "true",
+        :startTime => "Thu Mar 04 14:05:56 UTC 2010",
+        :endTime => "Thu Mar 04 15:01:01 UTC 2010",
+        :metadata => {
+          :title => "Test Recording",
+          :empty1 => nil,
+          :empty2 => {},
+          :empty3 => [],
+          :empty4 => " ",
+          :empty5 => "\n\t"
+        },
+        :playback => {
+          :format => [
+            { :type => "simple",
+              :url => "http://server.com/simple/playback?recordID=183f0bf3a0982a127bdb8161-1",
+              :length => "62" },
+            { :type => "simple",
+              :url => "http://server.com/simple/playback?recordID=183f0bf3a0982a127bdb8161-1",
+              :length => "48" }
+          ]
+        }
+      }
+    }
+
+    context do
+      subject { BigBlueButton::BigBlueButtonFormatter.format_recording(hash) }
+      it { subject[:recordID].should == "123" }
+      it { subject[:meetingID].should == "123" }
+      it { subject[:name].should == "123" }
+      it { subject[:startTime].should == DateTime.parse("Thu Mar 04 14:05:56 UTC 2010") }
+      it { subject[:endTime].should == DateTime.parse("Thu Mar 04 15:01:01 UTC 2010") }
+      it { subject[:playback][:format][0][:length].should == 62 }
+      it { subject[:metadata][:empty1].should == "" }
+      it { subject[:metadata][:empty2].should == "" }
+      it { subject[:metadata][:empty3].should == "" }
+      it { subject[:metadata][:empty4].should == "" }
+      it { subject[:metadata][:empty5].should == "" }
+    end
+
+    context "doesn't fail without playback formats" do
+      before { hash.delete(:playback) }
+      subject { BigBlueButton::BigBlueButtonFormatter.format_recording(hash) }
+      it { subject[:playback].should == nil }
+    end
   end
 
   describe "#flatten_objects" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1556921647631366101
+      hash: 1899678905392441618
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1556921647631366101
+      hash: 1899678905392441618
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24