bigbluebutton-api-ruby 0.0.11 → 0.1.0.rc1

data/examples/overall_0.7_example.rb

@@ -0,0 +1,92 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
+
+require 'bigbluebutton_api'
+require 'prepare'
+require 'securerandom'
+
+begin
+  prepare
+
+  puts
+  puts "---------------------------------------------------"
+  if @api.test_connection
+    puts "Connection successful! continuing..."
+  else
+    puts "Connection failed! The server might be unreachable. Exiting..."
+    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:"
+  response[:meetings].each do |m|
+    puts "  " + m[:meetingID] + ": " + m.inspect
+  end
+
+  puts
+  puts "---------------------------------------------------"
+  meeting_id = SecureRandom.hex(4)
+  meeting_name = meeting_id
+  moderator_name = "House"
+  attendee_name = "Cameron"
+  options = { :moderatorPW => "54321",
+              :attendeePW => "12345",
+              :welcome => 'Welcome to my meeting',
+              :dialNumber => '1-800-000-0000x00000#',
+              :voiceBridge => 70000 + rand(9999),
+              :webVoice => SecureRandom.hex(4),
+              :logoutURL => 'https://github.com/mconf/bigbluebutton-api-ruby',
+              :maxParticipants => 25 }
+
+  @api.create_meeting(meeting_name, meeting_id, options)
+  puts "The meeting has been created. Please open a web browser and enter the meeting using either of the URLs below."
+
+  puts
+  puts "---------------------------------------------------"
+  url = @api.join_meeting_url(meeting_id, moderator_name, options[:moderatorPW])
+  puts "1) Moderator URL = #{url}"
+  puts ""
+  url = @api.join_meeting_url(meeting_id, attendee_name, options[:attendeePW])
+  puts "2) Attendee URL = #{url}"
+
+  puts
+  puts "---------------------------------------------------"
+  puts "Waiting 30 seconds for you to enter via browser"
+  sleep(30)
+
+  unless @api.is_meeting_running?(meeting_id)
+    puts "You have NOT entered the meeting"
+    Kernel.exit!
+  end
+  puts "You have successfully entered the meeting"
+
+  puts
+  puts "---------------------------------------------------"
+  response = @api.get_meeting_info(meeting_id, options[:moderatorPW])
+  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(meeting_id, options[:moderatorPW])
+  puts "The meeting has been ended"
+
+rescue Exception => ex
+  puts "Failed with error #{ex.message}"
+  puts ex.backtrace
+end

data/examples/prepare.rb

@@ -0,0 +1,38 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
+
+require 'bigbluebutton_api'
+require 'yaml'
+
+def prepare
+  config_file = File.join(File.dirname(__FILE__), '..', 'features', 'config.yml')
+  unless File.exist? config_file
+    puts config_file + " does not exists. Copy the example and configure your server."
+    puts "cp features/config.yml.example features/config.yml"
+    puts
+    Kernel.exit!
+  end
+  @config = YAML.load_file(config_file)
+
+  puts "** Config:"
+  @config.each do |k,v|
+    puts k + ": " + v.to_s
+  end
+  puts
+
+  if ARGV.size > 0
+    unless @config['servers'].has_key?(ARGV[0])
+      throw Exception.new("Server #{ARGV[0]} does not exists in your configuration file.")
+    end
+    server = @config['servers'][ARGV[0]]
+  else
+    key = @config['servers'].keys.first
+    server = @config['servers'][key]
+  end
+
+  puts "** Using the server:"
+  puts server.inspect
+  puts
+
+  @api = BigBlueButton::BigBlueButtonApi.new(server['url'], server['salt'], server['version'].to_s, true)
+end

data/extras/bigbluebutton_bot.rb

@@ -0,0 +1,64 @@
+class BigBlueButtonBot
+  BOT_FILENAME = "bbb-bot.jar"
+  @@pids = []
+
+  def initialize(api, meeting, salt="", count=1, timeout=20)
+    bot_file = File.join(File.dirname(__FILE__), BOT_FILENAME)
+    unless File.exist?(bot_file)
+      throw Exception.new(bot_file + " does not exists. See download_bot_from.txt and download the bot file.")
+    end
+
+    server = parse_server_url(api.url)
+
+    # note: fork + exec with these parameters was the only solution found to run the command in background
+    # and be able to wait for it (kill it) later on (see BigBlueButtonBot.finalize)
+    pid = Process.fork do
+      exec("java", "-jar", "#{bot_file}", "-s", "#{server}", "-p", "#{salt}", "-m", "#{meeting}", "-n", "#{count}")
+
+      # other options that didn't work:
+      # IO::popen("java -jar #{bot_file} -s \"#{server}\" -m \"#{meeting}\" -n #{count} >/dev/null")
+      # exec(["java", "-jar #{bot_file} -s \"#{server}\" -m \"#{meeting}\" -n #{count} >/dev/null"])
+      # exec("java -jar #{bot_file} -s \"#{server}\" -m \"#{meeting}\" -n #{count} >/dev/null")
+      # Process.exit!
+    end
+    @@pids << pid
+
+    wait_bot_startup(api, meeting, count, timeout)
+  end
+
+  def self.finalize
+    @@pids.each do |pid|
+      p = Process.kill("TERM", pid)
+      Process.detach(pid)
+    end
+    @@pids.clear
+  end
+
+  def parse_server_url(full_url)
+    uri = URI.parse(full_url)
+    uri_s = uri.scheme + "://" + uri.host
+    uri_s = uri_s + ":" + uri.port.to_s if uri.port != uri.default_port
+    uri_s
+  end
+
+  # wait until the meeting is running with a certain number of participants
+  def wait_bot_startup(api, meeting, participants, timeout=20)
+    Timeout::timeout(timeout) do
+      stop_wait = false
+      while !stop_wait
+        sleep 1
+
+        # find the meeting and hope it is running
+        response = api.get_meetings
+        selected = response[:meetings].reject!{ |m| m[:meetingID] != meeting }
+        if selected and selected.size > 0 and selected[0][:running]
+
+          # check how many participants are in the meeting
+          pass = selected[0][:moderatorPW]
+          response = api.get_meeting_info(meeting, pass)
+          stop_wait = response[:participantCount] >= participants
+        end
+      end
+    end
+  end
+end

data/extras/download_bot_from.txt

@@ -0,0 +1 @@
+https://github.com/daronco/mconf-mobile/blob/879f38e1be127f46b379c57a1933d3867b6bf14b/bbb-bot/bbb-bot.jar?raw=true

data/features/check_status.feature

@@ -0,0 +1,45 @@
+Feature: Check meeting configurations and status
+  To be able to monitor BigBlueButton
+  One needs to check the current meetings
+  and the status and configurations of a meeting
+
+  @version-all @need-bot
+  Scenario: Check that a meeting is running
+    Given that a meeting was created
+      And the meeting is running
+    Then the method isMeetingRunning informs that the meeting is running
+
+  @version-all
+  Scenario: Check that a meeting is NOT running
+    Given that a meeting was created
+    Then the method isMeetingRunning informs that the meeting is NOT running
+
+  @version-all
+  Scenario: Check the information of a meeting
+    Given that a meeting was created
+    When calling the method get_meeting_info
+    Then the response is successful with no messages
+      And it shows all the information of the meeting that was created
+
+  # to make sure that getMeetingInfo is returning the proper info used in create
+  @version-all
+  Scenario: Check the information of a meeting created with optional parameters
+    Given that a meeting was created with ALL the optional arguments
+    When calling the method get_meeting_info
+    Then the response is successful with no messages
+      And it shows all the information of the meeting that was created
+
+  @version-all @need-bot
+  Scenario: Check the information of a meeting that is running and has attendees
+    Given that a meeting was created
+      And the meeting is running with 2 attendees
+    When calling the method get_meeting_info
+    Then the response is successful with no messages
+      And it shows the 2 attendees in the list
+
+  @version-all
+  Scenario: List the meetings in a server
+    Given that a meeting was created
+    When calling the method get_meetings
+    Then the response is successful with no messages
+      And the created meeting should be listed in the response with proper information

data/features/config.yml.example

@@ -0,0 +1,21 @@
+debug: false
+
+# maximum wait for a response to any API request (secs)
+timeout_req: 60
+
+# maximum wait for a meeting to be ended after end_meeting is called (secs)
+timeout_ending: 30
+
+# maximum wait until the bot starts (secs)
+timeout_bot_start: 60
+
+servers:
+  bbb-dev-07:
+    salt: 'your-salt'
+    url: 'http://your-server/bigbluebutton/api'
+    version: '0.7'
+  test-install-08:
+    salt: '8cd8ef52e8e101574e400365b55e11a6'
+    url: 'http://test-install.blindsidenetworks.com/bigbluebutton/api'
+    version: '0.8'
+    mobile_salt: '03b07' # needed for >= 0.8

data/features/create_meetings.feature

@@ -0,0 +1,29 @@
+Feature: Create rooms
+  To be able to use BigBlueButton
+  One needs to create a webconference room first
+
+  @version-all
+  Scenario: Create a new room
+    When the create method is called with ALL the optional arguments
+    Then the response is successful and well formatted
+      And the meeting exists in the server
+
+  @version-all
+  Scenario: Create a new room with default parameters
+    When the create method is called with NO optional arguments
+    Then the response is successful and well formatted
+      And the meeting exists in the server
+
+  @version-all
+  Scenario: Try to create a room with a duplicated meeting id
+    When the create method is called with a duplicated meeting id
+    Then the response is an error with the key "idNotUnique"
+
+  @version-all @need-bot
+  Scenario: Try to recreate a previously ended meeting
+    Given the create method is called
+      # note: meeting needs to be running to be ended in 0.7
+      And the meeting is running
+      And the meeting is forcibly ended
+    When the create method is called again with the same meeting id
+    Then the response is an error with the key "idNotUnique"

data/features/end_meetings.feature

@@ -0,0 +1,27 @@
+Feature: End rooms
+  To stop a meeting using the API
+  One needs to be able to call 'end' to this meeting
+
+  @version-all @need-bot
+  Scenario: End a meeting
+    Given that a meeting was created
+      And the meeting is running
+    When the method to end the meeting is called
+    Then the response is successful and well formatted
+      And the meeting should be ended
+      And the information returned by get_meeting_info is correct
+
+  # in 0.7 ending a meeting that is not running generates an error
+  @version-07
+  Scenario: Try to end a meeting that is not running in 0.7
+    Given that a meeting was created
+    When the method to end the meeting is called
+    Then the response is an error with the key "notFound"
+
+  # in 0.8 ending a meeting that is not running is ok
+  @version-08
+  Scenario: Try to end a meeting that is not running in 0.8
+    Given that a meeting was created
+    When the method to end the meeting is called
+    Then the response is successful
+      And the response has the messageKey "sentEndMeetingRequest"

data/features/join_meetings.feature

@@ -0,0 +1,29 @@
+Feature: Join meeting
+  To participate in a meeting
+  The user needs to be able to join a created meeting
+
+  @version-all
+  Scenario: Join a meeting as moderator
+    Given that a meeting was created
+    When the user tries to access the link to join the meeting as moderator
+    Then he is redirected to the BigBlueButton client
+    # can't really check if the user is in the session because in bbb he will
+    # only be listed as an attendee after stabilishing a rtmp connection
+
+  @version-all
+  Scenario: Join a meeting as attendee
+    Given that a meeting was created
+    When the user tries to access the link to join the meeting as attendee
+    Then he is redirected to the BigBlueButton client
+
+  @version-all
+  Scenario: Join a non created meeting
+    Given the default BigBlueButton server
+    When the user tries to access the link to join a meeting that was not created
+    Then the response is an xml with the error "invalidMeetingIdentifier"
+
+  @version-all
+  Scenario: Try to join with the wrong password
+    Given that a meeting was created
+    When the user tries to access the link to join the meeting using a wrong password
+    Then the response is an xml with the error "invalidPassword"

data/features/pre_upload_slides.feature

@@ -0,0 +1,14 @@
+@version-08
+Feature: Pre-upload slides
+  To have presentations ready in the meeting when the users join
+  One needs to pre-upload these presentations when the meeting is created
+
+  Scenario: Pre-upload presentations
+    Given the default BigBlueButton server
+    When the user creates a meeting pre-uploading the following presentations:
+      | type | presentation                   |
+      | url  | http://www.samplepdf.com/sample.pdf |
+      | file | extras/test-presentation.pdf        |
+    Then the response is successful and well formatted
+    # OPTIMIZE: There's no way to check if the presentation is really in the meeting
+    #  And these presentations should be available in the meeting as it begins

data/features/recordings.feature

@@ -0,0 +1,34 @@
+@version-08
+Feature: Record a meeting and manage recordings
+  To record a meeting or manage the recorded meeting
+  One needs be able to list the recordings, publish and unpublish them
+
+  # We don't check if meetings will really be recorded
+  # To record a meeting we need at least audio in the session
+  # And also it would probably that a long time to record and process test meetings
+  # For now we'll have only basic tests in this feature
+
+  Scenario: Set a meeting to be recorded
+    Given the default BigBlueButton server
+    When the user creates a meeting with the record flag
+    Then the response is successful and well formatted
+      And the meeting is set to be recorded
+
+  Scenario: By default a meeting will not be recorded
+    Given the default BigBlueButton server
+    When the user creates a meeting without the record flag
+   Then the response is successful and well formatted
+      And the meeting is NOT set to be recorded
+
+  Scenario: List the available recordings in a server with no recordings
+    Given the default BigBlueButton server
+    When the user calls the get_recordings method
+    Then the response is successful and well formatted
+      And the response has the messageKey "noRecordings"
+
+  # Possible scenarios to test in the future
+  # Scenario: Record a meeting # not only set to be recorded
+  # Scenario: List the available recordings
+  # Scenario: Publish a recording
+  # Scenario: Unpublish a recording
+  # Scenario: Remove a recording

data/features/step_definitions/check_status_steps.rb

@@ -0,0 +1,119 @@
+When /^the method isMeetingRunning informs that the meeting is running$/ do
+  @req.response = @api.is_meeting_running?(@req.id)
+  @req.response.should be_true
+end
+
+When /^the method isMeetingRunning informs that the meeting is not running$/i do
+  @req.response = @api.is_meeting_running?(@req.id)
+  @req.response.should be_false
+end
+
+When /^calling the method get_meetings$/ do
+  @req.response = @api.get_meetings
+end
+
+When /^calling the method get_meeting_info$/ do
+  @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
+end
+
+When /^the created meeting should be listed in the response with proper information$/ do
+  @req.response[:meetings].size.should >= 1
+
+  # the created meeting is in the list and has only 1 occurance
+  found = @req.response[:meetings].reject{ |m| m[:meetingID] != @req.id }
+  found.should_not be_nil
+  found.size.should == 1
+
+  # proper information in the meeting hash
+  found = found[0]
+  found[:attendeePW].should be_a(String)
+  found[:attendeePW].should_not be_empty
+  found[:moderatorPW].should == @req.mod_pass
+  found[:hasBeenForciblyEnded].should be_false
+  found[:running].should be_false
+  if @api.version >= "0.8"
+    found[:meetingName].should == @req.id
+    found[:createTime].should be_a(Numeric)
+  end
+end
+
+When /^it shows all the information of the meeting that was created$/ do
+  @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
+  @req.response[:meetingID].should == @req.id
+  @req.response[:running].should be_false
+  @req.response[:hasBeenForciblyEnded].should be_false
+  @req.response[:startTime].should be_nil
+  @req.response[:endTime].should be_nil
+  @req.response[:participantCount].should == 0
+  @req.response[:moderatorCount].should == 0
+  @req.response[:attendees].should == []
+  @req.response[:messageKey].should == ""
+  @req.response[:message].should == ""
+  if @req.opts.has_key?(:attendeePW)
+    @req.response[:attendeePW].should == @req.opts[:attendeePW]
+  else # auto generated password
+    @req.response[:attendeePW].should be_a(String)
+    @req.response[:attendeePW].should_not be_empty
+    @req.opts[:attendeePW] = @req.response[:attendeePW]
+  end
+  if @req.opts.has_key?(:moderatorPW)
+    @req.response[:moderatorPW].should == @req.opts[:moderatorPW]
+  else # auto generated password
+    @req.response[:moderatorPW].should be_a(String)
+    @req.response[:moderatorPW].should_not be_empty
+    @req.opts[:moderatorPW] = @req.response[:moderatorPW]
+  end
+
+  if @api.version >= "0.8"
+    @req.response[:meetingName].should == @req.id
+    @req.response[:createTime].should be_a(Numeric)
+
+    @req.opts.has_key?(:record) ?
+      (@req.response[:recording].should == @req.opts[:record]) :
+      (@req.response[:recording].should be_false)
+    @req.opts.has_key?(:maxParticipants) ?
+      (@req.response[:maxUsers].should == @req.opts[:maxParticipants]) :
+      (@req.response[:maxUsers].should == 20)
+    @req.opts.has_key?(:voiceBridge) ?
+      (@req.response[:voiceBridge].should == @req.opts[:voiceBridge]) :
+      (@req.response[:voiceBridge].should be_a(Numeric))
+
+    if @req.opts.has_key?(:meta_one)
+      @req.response[:metadata].size.should == 2
+      @req.response[:metadata].should be_a(Hash)
+      @req.response[:metadata].should include(:one => "one")
+      @req.response[:metadata].should include(:two => "TWO")
+    else
+      @req.response[:metadata].should == {}
+    end
+
+    # note: the duration passed in the api call is not returned (so it won't be checked)
+  end
+end
+
+Then /^it shows the (\d+) attendees in the list$/ do |count|
+  # check only what is different in a meeting that is RUNNING
+  # the rest is checked in other scenarios
+
+  @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
+  participants = count.to_i
+
+  @req.response[:running].should be_true
+  @req.response[:moderatorCount].should > 0
+  @req.response[:hasBeenForciblyEnded].should be_false
+  @req.response[:participantCount].should == participants
+  @req.response[:attendees].size.should == 2
+
+  # check the start time that should be within 2 hours from now
+  @req.response[:startTime].should be_a(DateTime)
+  @req.response[:startTime].should < DateTime.now
+  @req.response[:startTime].should >= DateTime.now - (2/24.0)
+  @req.response[:endTime].should be_nil
+
+  # in the bot being used, bots are always moderators with these names
+  @req.response[:attendees].sort! { |h1,h2| h1[:fullName] <=> h2[:fullName] }
+  @req.response[:attendees][0][:fullName].should == "BOT0"
+  @req.response[:attendees][0][:role].should == :moderator
+  @req.response[:attendees][1][:fullName].should == "BOT1"
+  @req.response[:attendees][1][:role].should == :moderator
+end