bigbluebutton-api-ruby 0.0.8 → 0.0.9

data/CHANGELOG.rdoc

@@ -1,4 +1,8 @@
-== 0.0.7
+== 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.

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 = '0.0.8'
+  s.version = '0.0.9'
   s.extra_rdoc_files = ['README.rdoc', 'LICENSE', '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/lib/bigbluebutton-api.rb

@@ -108,12 +108,12 @@ module BigBlueButton
     # logout_url::          URL to return user to after exiting meeting
     # voice_bridge::        Voice conference number (>= 0.7)
     #
-    # === Return examples
+    # === Return examples (for 0.7)
     #
     # On successful creation:
     #
     #   {
-    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test3",
+    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test",
     #    :attendeePW=>1234, :moderatorPW=>4321, :hasBeenForciblyEnded=>"false",
     #    :messageKey=>{}, :message=>{}
     #   }
@@ -121,7 +121,7 @@ module BigBlueButton
     # Meeting that was just forcibly ended:
     #
     #   {
-    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test3",
+    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test",
     #    :attendeePW=>1234, :moderatorPW=>4321, :hasBeenForciblyEnded=>"true",
     #    :messageKey=>"duplicateWarning",
     #    :message=>"This conference was already in existence and may currently be in progress."
@@ -144,7 +144,7 @@ module BigBlueButton
     # meeting_id::          Unique identifier for the meeting
     # moderator_password::  Moderator password
     #
-    # === Return examples
+    # === Return examples (for 0.7)
     #
     # On success:
     #
@@ -195,14 +195,54 @@ module BigBlueButton
     #
     # meeting_id::  Unique identifier for the meeting
     # password::    Moderator password for this meeting
+    #
+    # === Return examples (for 0.7)
+    #
+    # With attendees:
+    #
+    #   {
+    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test", :attendeePW=>1234, :moderatorPW=>4321, :running=>"true",
+    #    :hasBeenForciblyEnded=>"false", :startTime=>"Wed Apr 06 17:09:57 UTC 2011", :endTime=>"null", :participantCount=>4, :moderatorCount=>2,
+    #    :attendees => [
+    #      {:userID=>"ndw1fnaev0rj", :fullName=>"House M.D.", :role=>"MODERATOR"},
+    #      {:userID=>"gn9e22b7ynna", :fullName=>"Dexter Morgan", :role=>"MODERATOR"},
+    #      {:userID=>"llzihbndryc3", :fullName=>"Cameron Palmer", :role=>"VIEWER"},
+    #      {:userID=>"rbepbovolsxt", :fullName=>"Trinity", :role=>"VIEWER"}
+    #    ], :messageKey=>{}, :message=>{}
+    #   }
+    #
+    # Without attendees (not started):
+    #
+    #   {
+    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test", :attendeePW=>1234, :moderatorPW=>4321, :running=>"false",
+    #    :hasBeenForciblyEnded=>"false", :startTime=>"null", :endTime=>"null", :participantCount=>0, :moderatorCount=>0,
+    #    :attendees=>[], :messageKey=>{ }, :message=>{ }
+    #   }
+    #
     def get_meeting_info(meeting_id, password)
-      send_api_request(:getMeetingInfo, { :meetingID => meeting_id, :password => password } )
+      response = send_api_request(:getMeetingInfo, { :meetingID => meeting_id, :password => password } )
+
+      # simplify the hash making a node :attendees with an array with all attendees
+      if response[:attendees].empty?
+        meetings = []
+      else
+        node = response[:attendees][:attendee]
+        if node.kind_of?(Array)
+          meetings = node
+        else
+          meetings = []
+          meetings << node
+        end
+      end
+      response[:attendees] = meetings
+
+      response
     end
 
     # Returns a hash object containing information about the meetings currently existent in the BBB
     # server, either they are running or not.
     #
-    # === Return examples
+    # === Return examples (for 0.7)
     #
     # Server with one or more meetings:
     #
@@ -221,10 +261,10 @@ module BigBlueButton
       response = send_api_request(:getMeetings, { :random => rand(9999999999) } )
 
       # simplify the hash making a node :meetings with an array with all meetings
-      node = response[:meetings][:meeting]
       if response[:meetings].empty?
         meetings = []
       else
+        node = response[:meetings][:meeting]
         if node.kind_of?(Array)
           meetings = node
         else
@@ -263,10 +303,10 @@ module BigBlueButton
     end
 
     # API's are equal if all the following attributes are equal
-    def == other
+    def ==(other)
       r = true
       [:url, :supported_versions, :salt, :version, :debug].each do |param|
-        r = r and self.send(param) == other.send(param)
+        r = r && self.send(param) == other.send(param)
       end
       r
     end

data/test/test.rb

@@ -77,6 +77,14 @@ def general_test
   puts "Meeting info:"
   puts response.inspect
 
+  puts
+  puts "---------------------------------------------------"
+  puts "Attendees:"
+  response[:attendees].each do |m|
+    puts "  " + m[:fullName] + " (" +  m[:userID] + "): " + m.inspect
+  end
+
+
   puts
   puts "---------------------------------------------------"
   @api.end_meeting(@config['meeting_id'], @config['moderator_password'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-06 00:00:00.000000000Z
+date: 2011-04-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &78256160 !ruby/object:Gem::Requirement
+  requirement: &78653840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +22,7 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *78256160
+  version_requirements: *78653840
 description: Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)
 email:
 - leonardodaronco@gmail.com