bigbluebutton-api-ruby 0.0.6 → 0.0.8

data/.gitignore

@@ -2,4 +2,4 @@
 pkg
 *.*~
 test/config.yml
-doc/rdoc
+doc/

data/CHANGELOG.rdoc

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

data/README.rdoc

@@ -21,7 +21,7 @@ See CHANGELOG.rdoc
 Author::     Leonardo Crauss Daronco
 Email::      leonardodaronco@gmail.com
 Project::    GT-Mconf: Multiconference system for interoperable web and mobile @ PRAV Labs - UFRGS
-Home Page::  http://www.inf.ufrgs.br/prav/gtmconf/
+Home Page::  http://www.inf.ufrgs.br/prav/gtmconf
 License::    Distributed under same terms as Ruby
 
 === Version 0.0.3 and below

data/bigbluebutton-api-ruby.gemspec

@@ -2,8 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = 'bigbluebutton-api-ruby'
-  s.version = '0.0.6'
-  s.has_rdoc = true
+  s.version = '0.0.8'
   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

@@ -69,7 +69,7 @@ module BigBlueButton
     def moderator_url(meeting_id, user_name, password,
                       user_id = nil, web_voice_conf = nil)
       warn "#{caller[0]}: moderator_url is deprecated and will soon be removed, please use join_meeting_url instead."
-      join_meeting_url_url(meeting_id, user_name, password, user_id, web_voice_conf)
+      join_meeting_url(meeting_id, user_name, password, user_id, web_voice_conf)
     end
 
     # DEPRECATED
@@ -106,7 +106,27 @@ module BigBlueButton
     # welcome_message::     Welcome message to display in chat window
     # dialin_number::       Dial in number for conference using a regular phone
     # logout_url::          URL to return user to after exiting meeting
-    # voice_bridge::        Voice conference number (>=0.7)
+    # voice_bridge::        Voice conference number (>= 0.7)
+    #
+    # === Return examples
+    #
+    # On successful creation:
+    #
+    #   {
+    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test3",
+    #    :attendeePW=>1234, :moderatorPW=>4321, :hasBeenForciblyEnded=>"false",
+    #    :messageKey=>{}, :message=>{}
+    #   }
+    #
+    # Meeting that was just forcibly ended:
+    #
+    #   {
+    #    :returncode=>"SUCCESS", :meetingID=>"bigbluebutton-api-ruby-test3",
+    #    :attendeePW=>1234, :moderatorPW=>4321, :hasBeenForciblyEnded=>"true",
+    #    :messageKey=>"duplicateWarning",
+    #    :message=>"This conference was already in existence and may currently be in progress."
+    #   }
+    #
     # TODO check if voice_bridge exists in 0.64
     def create_meeting(meeting_name, meeting_id, moderator_password, attendee_password,
                        welcome_message = nil, dial_number = nil, logout_url = nil,
@@ -120,9 +140,20 @@ module BigBlueButton
       send_api_request(:create, params)
     end
 
-    # Ends an existing meeting.  Throws BigBlueButtonException on failure.
+    # Ends an existing meeting. Throws BigBlueButtonException on failure.
     # meeting_id::          Unique identifier for the meeting
     # moderator_password::  Moderator password
+    #
+    # === Return examples
+    #
+    # On success:
+    #
+    #   {
+    #    :returncode=>"SUCCESS", :messageKey=>"sentEndMeetingRequest",
+    #    :message=>"A request to end the meeting was sent.  Please wait a few seconds, and then use the getMeetingInfo
+    #               or isMeetingRunning API calls to verify that it was ended."
+    #   }
+    #
     def end_meeting(meeting_id, moderator_password)
       send_api_request(:end, { :meetingID => meeting_id, :password => moderator_password } )
     end
@@ -168,21 +199,66 @@ module BigBlueButton
       send_api_request(:getMeetingInfo, { :meetingID => meeting_id, :password => password } )
     end
 
-    # Returns a hash object containing the meeting information.
-    # See the API documentation for details on the return XML
-    # (http://code.google.com/p/bigbluebutton/wiki/API).
+    # Returns a hash object containing information about the meetings currently existent in the BBB
+    # server, either they are running or not.
+    #
+    # === Return examples
+    #
+    # Server with one or more meetings:
+    #
+    #   { :returncode => "SUCCESS",
+    #     :meetings => [
+    #       {:meetingID=>"Demo Meeting", :attendeePW=>"ap", :moderatorPW=>"mp", :hasBeenForciblyEnded=>"false", :running=>"true"},
+    #       {:meetingID=>"I was ended Meeting", :attendeePW=>"pass", :moderatorPW=>"pass", :hasBeenForciblyEnded=>"true", :running=>"false"}
+    #     ]
+    #   }
+    #
+    # Server with no meetings:
+    #
+    #   {:returncode=>"SUCCESS", :meetings=>[], :messageKey=>"noMeetings", :message=>"no meetings were found on this server"}
+    #
     def get_meetings
-      send_api_request(:getMeetings, { :random => rand(9999999999) } )
+      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
+        if node.kind_of?(Array)
+          meetings = node
+        else
+          meetings = []
+          meetings << node
+        end
+      end
+      response[:meetings] = meetings
+
+      response
+    end
+
+    # Returns the API version (as string) of the associated server. This actually returns
+    # the version requested to the BBB server, and not the version set by the user in
+    # the initialization.
+    #
+    # Works for BBB >= 0.7 only. For earlier versions, returns an empty string.
+    def get_api_version
+      response = send_api_request(:index)
+      if response[:returncode] == "SUCCESS"
+        response[:version]
+      else
+        ""
+      end
     end
 
     # Make a simple request to the server to test the connection
-    # TODO implement test for version 0.64
     def test_connection
       if @version == '0.7'
         response = send_api_request(:index)
         response[:returncode] == "SUCCESS"
       else
-        true
+        response = get_meetings
+        response[:returncode] == "SUCCESS"
       end
     end
 

data/test/test.rb

@@ -33,21 +33,17 @@ def general_test
     Kernel.exit!
   end
 
+  puts
+  puts "---------------------------------------------------"
+  version = @api.get_api_version
+  puts "The API version of your server is #{version}"
+
   puts
   puts "---------------------------------------------------"
   response = @api.get_meetings
   puts "Existent meetings in your server:"
-  if response[:meetings].empty?
-    puts "No meetings found"
-  else
-    node = response[:meetings][:meeting]
-    if node.kind_of?(Array)
-      node.each do |m|
-        puts "  " + m[:meetingID] + ": " + m.inspect
-      end
-    else
-      puts "  " + node[:meetingID] + ": " + node.inspect
-    end
+  response[:meetings].each do |m|
+    puts "  " + m[:meetingID] + ": " + m.inspect
   end
 
   puts

metadata

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