bigbluebutton-api-ruby 1.0.0 → 1.1.0

data/.gitignore

@@ -5,4 +5,3 @@ features/config.yml
 logs/bbb.log
 rdoc/
 logs/*
-extras/bbb-bot.jar

data/.rvmrc

@@ -2,5 +2,5 @@
 if [ -e '.rvmrc_custom' ]; then
   source .rvmrc_custom;
 else
-  rvm --create use 1.9.2-p290@bigbluebutton-api-ruby;
+  rvm --create use 1.9.3-p194@bigbluebutton-api-ruby;
 fi

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+=== 1.1.0
+
+* Updated ruby to 1.9.3-194.
+* Support to BigBlueButton 0.4 rc1.
+
 === 1.0.0
 
 * Version 0.1.0 renamed to 1.0.0.

data/Gemfile

@@ -8,8 +8,9 @@ group :developement do
 end
 
 group :development, :test do
-  gem 'rspec', '~> 2.6'
+  gem 'rspec', '~> 2.10'
   gem 'cucumber-rails'
   gem 'forgery'
+  gem 'bbbot-ruby', :git => 'git://github.com/mconf/bbbot-ruby.git'
   # gem 'rails_best_practices'
 end

data/Gemfile.lock

@@ -1,12 +1,19 @@
+GIT
+  remote: git://github.com/mconf/bbbot-ruby.git
+  revision: 83f3ccf88aa355260a791eb450a8d73f94049053
+  specs:
+    bbbot-ruby (0.0.1)
+
 PATH
   remote: .
   specs:
-    bigbluebutton-api-ruby (1.0.0)
+    bigbluebutton-api-ruby (1.1.0)
       xml-simple (>= 1.1.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.2.8)
     builder (3.0.0)
     capybara (1.1.2)
       mime-types (>= 1.16)
@@ -15,46 +22,49 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    childprocess (0.2.2)
+    childprocess (0.3.2)
       ffi (~> 1.0.6)
-    cucumber (1.1.2)
+    cucumber (1.1.9)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.6.2)
+      gherkin (~> 2.9.0)
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.6)
-    cucumber-rails (1.2.0)
-      capybara (>= 1.1.1)
-      cucumber (>= 1.1.1)
+    cucumber-rails (1.3.0)
+      capybara (>= 1.1.2)
+      cucumber (>= 1.1.8)
       nokogiri (>= 1.5.0)
     diff-lcs (1.1.3)
     ffi (1.0.11)
     forgery (0.5.0)
-    gherkin (2.6.6)
+    gherkin (2.9.3)
       json (>= 1.4.6)
-    json (1.6.1)
-    json_pure (1.6.1)
-    mime-types (1.17.2)
-    nokogiri (1.5.0)
-    rack (1.3.5)
+    json (1.7.0)
+    libwebsocket (0.1.3)
+      addressable
+    mime-types (1.18)
+    multi_json (1.3.4)
+    nokogiri (1.5.2)
+    rack (1.4.1)
     rack-test (0.6.1)
       rack (>= 1.0)
     rake (0.9.2.2)
-    rdoc (3.11)
+    rdoc (3.12)
       json (~> 1.4)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (2.13.0)
-      childprocess (>= 0.2.1)
-      ffi (~> 1.0.9)
-      json_pure
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.0)
+    rubyzip (0.9.8)
+    selenium-webdriver (2.21.2)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
       rubyzip
     term-ansicolor (1.0.7)
     xml-simple (1.1.1)
@@ -65,9 +75,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bbbot-ruby!
   bigbluebutton-api-ruby!
   cucumber-rails
   forgery
   rake (>= 0.9)
   rdoc
-  rspec (~> 2.6)
+  rspec (~> 2.10)

data/Rakefile

@@ -17,11 +17,11 @@ Cucumber::Rake::Task.new do |t|
     prepend = "--tags ~@need-bot"
   end
 
-  # defaults to BBB 0.7
-  if ENV["V"]  == "0.8"
-    t.cucumber_opts = "--format pretty --tags ~@wip --tags @version-all,@version-08 #{prepend}"
-  else
+  # defaults to BBB 0.8
+  if ENV["V"] == "0.7" or ENV["VERSION"] == "0.7"
     t.cucumber_opts = "--format pretty --tags ~@wip --tags @version-all,@version-07 #{prepend}"
+  else
+    t.cucumber_opts = "--format pretty --tags ~@wip --tags @version-all,@version-08 #{prepend}"
   end
 end
 

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.0.0'
+  s.version = '1.1.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/features/create_meetings.feature

@@ -19,7 +19,7 @@ Feature: Create rooms
     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
+  @version-07 @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
@@ -27,3 +27,12 @@ Feature: Create rooms
       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"
+
+  @version-08 @need-bot
+  Scenario: Try to recreate a previously ended meeting
+    Given the create method is called
+      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 successful and well formatted
+      And the meeting exists in the server

data/features/end_meetings.feature

@@ -2,7 +2,7 @@ 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
+  @version-07 @need-bot
   Scenario: End a meeting
     Given that a meeting was created
       And the meeting is running
@@ -11,6 +11,15 @@ Feature: End rooms
       And the meeting should be ended
       And the information returned by get_meeting_info is correct
 
+  @version-08 @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
+      # the meeting may not exist anymore in 0.8
+
   # 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

data/features/step_definitions/check_status_steps.rb

@@ -105,15 +105,17 @@ Then /^it shows the (\d+) attendees in the list$/ do |count|
   @req.response[:attendees].size.should == 2
 
   # check the start time that should be within 2 hours from now
+  # we check with this 2-hour time window to prevent errors if the
+  # server clock is different
   @req.response[:startTime].should be_a(DateTime)
-  @req.response[:startTime].should < DateTime.now
-  @req.response[:startTime].should >= DateTime.now - (2/24.0)
+  @req.response[:startTime].should < DateTime.now + (1/24.0)
+  @req.response[:startTime].should >= DateTime.now - (1/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][:fullName].should == "Bot 1"
   @req.response[:attendees][0][:role].should == :moderator
-  @req.response[:attendees][1][:fullName].should == "BOT1"
+  @req.response[:attendees][1][:fullName].should == "Bot 2"
   @req.response[:attendees][1][:role].should == :moderator
 end

data/features/step_definitions/common_steps.rb

@@ -90,6 +90,7 @@ When /^the response to the create method is successful and well formatted$/ do
   @req.response[:messageKey].should == ""
   @req.response[:message].should == ""
 
+  @req.opts = {} if @req.opts.nil?
   if @req.opts.has_key?(:attendeePW)
     @req.response[:attendeePW].should == @req.opts[:attendeePW]
   else # auto generated password

data/features/step_definitions/end_meetings_steps.rb

@@ -17,7 +17,7 @@ When /^the meeting should be ended$/ do
       sleep 1
       response = @api.get_meetings
       selected = response[:meetings].reject!{ |m| m[:meetingID] != @req.id }
-      running = selected[0][:running] unless selected.nil?
+      running = selected[0].nil? ? false : selected[0][:running]
     end
   end
 
@@ -38,12 +38,12 @@ When /^the information returned by get_meeting_info is correct$/ do
   @req.response[:moderatorCount].should == 0
   @req.response[:attendees].should == []
 
-  # start and end times that should be within 2 hours from now
+  # start and end times should be within half an hour 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[:startTime].should < DateTime.now + (0.5/24.0)
+  @req.response[:startTime].should >= DateTime.now - (0.5/24.0)
   @req.response[:endTime].should be_a(DateTime)
-  @req.response[:endTime].should < DateTime.now
-  @req.response[:endTime].should >= DateTime.now - (2/24.0)
+  @req.response[:endTime].should < DateTime.now + (0.5/24.0)
+  @req.response[:endTime].should >= DateTime.now - (0.5/24.0)
   @req.response[:endTime].should > @req.response[:startTime]
 end

data/features/support/env.rb

@@ -1,7 +1,6 @@
 $:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib')
 
 require 'bigbluebutton_api'
+require 'bigbluebutton_bot'
 require 'forgery'
 Dir["#{File.dirname(__FILE__)}/../../spec/support/forgery/**/*.rb"].each { |f| require f }
-
-Dir["#{File.dirname(__FILE__)}/../../extras/**/*.rb"].each { |f| require f }

data/features/support/features_helpers.rb

@@ -0,0 +1,54 @@
+module BigBlueButton
+  module Features
+
+    # Test object that stores information about an API request
+    class APIRequest
+      attr_accessor :opts       # options hash
+      attr_accessor :id         # meetind id
+      attr_accessor :mod_pass   # moderator password
+      attr_accessor :name       # meeting name
+      attr_accessor :method     # last api method called
+      attr_accessor :response   # last api response
+      attr_accessor :exception  # last exception
+    end
+
+    # Global configurations
+    module Configs
+      class << self
+        attr_accessor :cfg           # configuration file
+        attr_accessor :cfg_server    # shortcut to the choosen server configs
+        attr_accessor :req           # api request
+
+        def initialize_cfg
+          config_file = File.join(File.dirname(__FILE__), '..', 'config.yml')
+          unless File.exist? config_file
+            throw Exception.new(config_file + " does not exists. Copy the example and configure your server.")
+          end
+          config = YAML.load_file(config_file)
+          config
+        end
+
+        def initialize_cfg_server
+          if ENV['SERVER']
+            unless self.cfg['servers'].has_key?(ENV['SERVER'])
+              throw Exception.new("Server #{ENV['SERVER']} does not exists in your configuration file.")
+            end
+            server = self.cfg['servers'][ENV['SERVER']]
+          else
+            server = self.cfg['servers'].first[1]
+          end
+          server['version'] = '0.7' unless server.has_key?('version')
+          server
+        end
+
+        def load
+          self.cfg = initialize_cfg
+          self.cfg_server = initialize_cfg_server
+          self.req = BigBlueButton::Features::APIRequest.new
+        end
+
+      end
+    end
+
+  end
+end

data/features/support/hooks.rb

@@ -1,9 +1,9 @@
 Before do
   # stores the global configurations in variables that are easier to access
-  BigBlueButtonAPITests::Configs.load
-  @config = BigBlueButtonAPITests::Configs.cfg
-  @config_server = BigBlueButtonAPITests::Configs.cfg_server
-  @req = BigBlueButtonAPITests::Configs.req
+  BigBlueButton::Features::Configs.load
+  @config = BigBlueButton::Features::Configs.cfg
+  @config_server = BigBlueButton::Features::Configs.cfg_server
+  @req = BigBlueButton::Features::Configs.req
 end
 
 After do |scenario|

data/lib/bigbluebutton_formatter.rb

@@ -52,6 +52,7 @@ module BigBlueButton
           if value.downcase == "null"
             result = nil
           else
+            # note: BBB 0.7 uses strings in the format: "Thu Sep 01 17:51:42 UTC 2011"
             result = DateTime.parse(value)
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-05 00:00:00.000000000Z
+date: 2012-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &74945770 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,12 @@ dependencies:
         version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *74945770
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 description: Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)
 email:
 - leonardodaronco@gmail.com
@@ -51,8 +56,6 @@ files:
 - examples/join_example.rb
 - examples/overall_0.7_example.rb
 - examples/prepare.rb
-- extras/bigbluebutton_bot.rb
-- extras/download_bot_from.txt
 - extras/test-presentation.pdf
 - features/check_status.feature
 - features/config.yml.example
@@ -68,8 +71,8 @@ files:
 - features/step_definitions/join_meetings_steps.rb
 - features/step_definitions/pre_upload_slides_steps.rb
 - features/step_definitions/recordings_steps.rb
-- features/support/api_tests/configs.rb
 - features/support/env.rb
+- features/support/features_helpers.rb
 - features/support/hooks.rb
 - lib/bigbluebutton_api.rb
 - lib/bigbluebutton_exception.rb
@@ -100,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -707052209
+      hash: -937799181
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,10 +112,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -707052209
+      hash: -937799181
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)

data/extras/bigbluebutton_bot.rb

@@ -1,64 +0,0 @@
-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

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

data/features/support/api_tests/configs.rb

@@ -1,51 +0,0 @@
-module BigBlueButtonAPITests
-
-  # Test object that stores information about an API request
-  class APIRequest
-    attr_accessor :opts       # options hash
-    attr_accessor :id         # meetind id
-    attr_accessor :mod_pass   # moderator password
-    attr_accessor :name       # meeting name
-    attr_accessor :method     # last api method called
-    attr_accessor :response   # last api response
-    attr_accessor :exception  # last exception
-  end
-
-  # Global configurations
-  module Configs
-    class << self
-      attr_accessor :cfg           # configuration file
-      attr_accessor :cfg_server    # shortcut to the choosen server configs
-      attr_accessor :req           # api request
-
-      def initialize_cfg
-        config_file = File.join(File.dirname(__FILE__), '..', '..', 'config.yml')
-        unless File.exist?(config_file)
-          throw Exception.new(config_file + " does not exists. Copy the example and configure your server.")
-        end
-        config = YAML.load_file(config_file)
-        config
-      end
-
-      def initialize_cfg_server
-        if ENV['SERVER']
-          unless self.cfg['servers'].has_key?(ENV['SERVER'])
-            throw Exception.new("Server #{ENV['SERVER']} does not exists in your configuration file.")
-          end
-          server = self.cfg['servers'][ENV['SERVER']]
-        else
-          server = self.cfg['servers'][self.cfg['servers'].keys.first]
-        end
-        server['version'] = '0.7' unless server.has_key?('version')
-        server
-      end
-
-      def load
-        self.cfg = initialize_cfg
-        self.cfg_server = initialize_cfg_server
-        self.req = BigBlueButtonAPITests::APIRequest.new
-      end
-
-    end
-  end
-end