bigbluebutton-api-ruby 0.0.11 → 0.1.0.rc1

data/.gitignore

@@ -1,5 +1,8 @@
 *.gem
 pkg
 *~
-test/config.yml
-doc/
+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@bigbluebutton-api-ruby;
+  rvm --create use 1.9.2-p290@bigbluebutton-api-ruby;
 fi

data/.travis.yml

@@ -0,0 +1,6 @@
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - jruby

data/CHANGELOG.rdoc

@@ -1,4 +1,15 @@
-== 0.0.11
+=== 0.1.0.rc1
+
+* Support to BigBlueButton 0.8:
+  * New methods for recordings: get_recordings, publish_recordings, delete_recordings
+  * Pre-upload of slides in create_meeting
+  * New parameters added in the already existent methods
+  * For more information see BigBlueButton docs at http://code.google.com/p/bigbluebutton/wiki/API#Version_0.8
+* Method signature changes: create_meeting, join_meeting_url and join_meeting. Optional parameters are now passed using a hash.
+* Integration tests for the entire library using cucumber.
+* Changed the XML parser to xml-simple (especially to solve issues with CDATA values).
+
+=== 0.0.11
 
 * The file "bigbluebutton-api" was renamed to "bigbluebutton_api". All "require" calls must be updated.
 * Splitted the library in more files (more modular) and created rspec tests for it.
@@ -6,7 +17,7 @@
 * New method last_http_response to access the last HTTP response object.
 * Automatically detects the BBB server version if not informed by the user.
 
-== 0.0.10
+=== 0.0.10
 
 * Returning hash now will *always* have these 3 values: :returncode (boolean), :messageKey (string) and :message (string).
 * Some values in the hash are now converted to a fixed variable type to avoid inconsistencies:
@@ -17,16 +28,16 @@
   * :hasBeenForciblyEnded (boolean)
   * :endTime and :startTime (DateTime or nil)
 
-== 0.0.9
+=== 0.0.9
 
 * Simplied "attendees" part of the hash returned in get_meeting_info. Same thing done for get_meetings.
 
-== 0.0.8
+=== 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.
 
-== 0.0.6
+=== 0.0.6
 
 * New method test_connection.
 * Added comparison method for APIs.
@@ -34,17 +45,17 @@
 * Better exception throwing when the user is unreachable or the response is incorrect.
   * BigBlueButtonException has now a "key" attribute to store the "messageKey" returned by BBB in failures.
 
-== 0.0.4
+=== 0.0.4
 
 * Added support for BigBlueButton 0.7.
 * Gem renamed from 'bigbluebutton' to 'bigbluebutton-api-ruby'.
 * API functions now return a hash and instead of the XML returned by BBB. The XML is converted to a hash that uses symbols as keys and groups keys with the same name.
 
-== 0.0.3
+=== 0.0.3
 
 * Fixes module issue preventing proper throwing of exceptions.
 
-== 0.0.1
+=== 0.0.1
 
 * This is the first version of this gem. It provides an implementation of the 0.64 bbb API, with the following exceptions:
   * Does not implement meeting token, and instead relies on meeting id as the unique identifier for a meeting.

data/Gemfile

@@ -1,7 +1,15 @@
 source 'http://rubygems.org'
 
-gem 'nokogiri', '1.4.1'
+gemspec
 
 group :developement do
+  gem 'rake', '>= 0.9'
+  gem 'rdoc'
+end
+
+group :development, :test do
   gem 'rspec', '~> 2.6'
+  gem 'cucumber-rails'
+  gem 'forgery'
+  # gem 'rails_best_practices'
 end

data/Gemfile.lock

@@ -1,20 +1,73 @@
+PATH
+  remote: .
+  specs:
+    bigbluebutton-api-ruby (0.1.0.rc1)
+      xml-simple (>= 1.1.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    cucumber (1.1.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.6.2)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    cucumber-rails (1.2.0)
+      capybara (>= 1.1.1)
+      cucumber (>= 1.1.1)
+      nokogiri (>= 1.5.0)
     diff-lcs (1.1.3)
-    nokogiri (1.4.1)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    ffi (1.0.11)
+    forgery (0.5.0)
+    gherkin (2.6.6)
+      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)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      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.6.0)
+    rspec-mocks (2.7.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (2.13.0)
+      childprocess (>= 0.2.1)
+      ffi (~> 1.0.9)
+      json_pure
+      rubyzip
+    term-ansicolor (1.0.7)
+    xml-simple (1.1.1)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  nokogiri (= 1.4.1)
+  bigbluebutton-api-ruby!
+  cucumber-rails
+  forgery
+  rake (>= 0.9)
+  rdoc
   rspec (~> 2.6)

data/LICENSE

@@ -1,11 +1,4 @@
-== bigbluebutton-api-ruby
-
 Copyright (c) 2011 Leonardo Crauss Daronco
-GT-Mconf: Multiconference system for interoperable web and mobile
-  * http://www.inf.ufrgs.br/prav/gtmconf
-  * PRAV Labs - UFRGS
-
-Copyright (c) 2010 Joe Kinsella
 
 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
@@ -23,3 +16,8 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 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
+  PRAV Labs - UFRGS - Porto Alegre - Brazil
+  http://www.inf.ufrgs.br/prav/gtmconf

data/LICENSE_003

@@ -0,0 +1,20 @@
+== bigbluebutton
+
+Copyright (c) 2010 Joe Kinsella
+
+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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+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.

data/README.rdoc

@@ -1,32 +1,55 @@
-= Project: bigbluebutton-api-ruby
+= bigbluebutton-api-ruby {<img src="http://travis-ci.org/mconf/bigbluebutton-api-ruby.png"/>}[http://travis-ci.org/mconf/bigbluebutton-api-ruby]
 
-== Goal
+This is a ruby gem that provides access to the {BigBlueButton}[http://bigbluebutton.org] API.
+For the API documentation see {this page}[http://code.google.com/p/bigbluebutton/wiki/API].
 
-Provide access to the BigBlueButton web conferencing API.
+Basically it enables a ruby application to interact with BigBlueButton by calling ruby methods instead of HTTP requests making it a lot easier to
+interact with BigBlueButton. And also formats the responses to a ruby-friendly format.
 
-== Dependencies
+Some details:
 
-Tested in Ruby 1.8.7 and Ruby 1.9.2.
+* Provides methods to perform all API calls and get the responses;
+* Converts the XML responses to ruby hashes, that are easier to work with;
+* Converts the string values returned to native ruby types. For instance:
+  * Dates are converted DateTime objects (e.g. "Thu Sep 01 17:51:42 UTC 2011");
+  * Response codes are converted to boolean (e.g. "SUCCESS" becomes <tt>true</tt>);
+* Deals with errors (e.g. timeouts) throwing BigBlueButtonException exceptions;
+* Support to multiple BigBlueButton API versions (see below).
 
-Needs: rake, rubygems, nokogiri
+== Supported BigBlueButton versions
+
+Currently supports the following versions of BigBlueButton:
+
+* 0.8 (currently in the beta3 stage).
+* 0.7 (including 0.7, 0.71 and 0.71a).
+* 0.64: see the branch "api-0.64". The last version with support to 0.64 is {version 0.0.10}[https://github.com/mconf/bigbluebutton-api-ruby/tree/v0.0.10].
+
+== Supported ruby versions
+
+Tested in rubies:
+
+* ruby-1.8.7
+* ruby-1.9.2
+* ree-1.8.7
+* jruby
 
 == Releases
 
-See CHANGELOG.rdoc
+For a list of releases and release notes see {CHANGELOG.rdoc}[https://github.com/mconf/bigbluebutton-api-ruby/blob/master/CHANGELOG.rdoc].
 
-== Contact
+== Development
+
+Information about the development of <tt>bigbluebutton-api-ruby</tt> can be found in {our wiki}[https://github.com/mconf/bigbluebutton-api-ruby/wiki].
+
+The development of this gem is guided by the requirements of the project Mconf. To know more about it visit the {project's wiki}[http://code.google.com/p/mconf/].
 
-=== Version 0.0.4+
+== License
 
-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
-License::    Distributed under same terms as Ruby
+Distributed under The MIT License (MIT).
+See {LICENSE}[https://github.com/mconf/bigbluebutton-api-ruby/blob/master/LICENSE] for the latest license, valid for all versions after 0.0.4 (including it), and {LICENSE_003}[https://github.com/mconf/bigbluebutton-api-ruby/blob/master/LICENSE_003] for version 0.0.3 and all the previous versions.
+
+== Contact
 
-=== Version 0.0.3 and below
+<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
 
-Author::     Joe Kinsella
-Email::      joe.kinsella@gmail.com
-Home Page::  http://www.brownbaglunch.com/bigbluebutton
-License::    Distributes under same terms as Ruby
+<b>Version 0.0.3 and below</b>: Joe Kinsella (joe.kinsella@gmail.com), Home page: http://www.brownbaglunch.com/bigbluebutton

data/Rakefile

@@ -1,31 +1,43 @@
 require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/rdoctask'
-require 'rake/testtask'
-require 'rake/gempackagetask'
+require 'rdoc/task'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 
 desc 'Default: run tests.'
-task :default => :test
+task :default => [:spec, :cucumber]
 
-Rake::RDocTask.new do |rdoc|
-  files = ['README.rdoc', 'LICENSE', 'CHANGELOG.rdoc', 'lib/**/*.rb']
-  rdoc.rdoc_files.add(files)
-  rdoc.main = "README" # page to start on
+RSpec::Core::RakeTask.new(:spec)
+
+Cucumber::Rake::Task.new do |t|
+
+  # in jruby the class BigBlueButtonBot doesn't work (it uses fork)
+  if defined?(RUBY_ENGINE) and RUBY_ENGINE == 'jruby'
+    puts "Jruby detected, ignoring features with @need-bot"
+    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
+    t.cucumber_opts = "--format pretty --tags ~@wip --tags @version-all,@version-07 #{prepend}"
+  end
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'LICENSE_003', 'CHANGELOG.rdoc', 'lib/**/*.rb')
+  rdoc.main = "README.rdoc"
   rdoc.title = "bigbluebutton-api-ruby Docs"
-  rdoc.rdoc_dir = 'doc' # rdoc output folder
-  rdoc.options << '--line-numbers'
+  rdoc.rdoc_dir = 'rdoc'
 end
 
-eval("$specification = begin; #{ IO.read('bigbluebutton-api-ruby.gemspec')}; end")
-Rake::GemPackageTask.new $specification do |pkg|
+eval("$specification = begin; #{IO.read('bigbluebutton-api-ruby.gemspec')}; end")
+Gem::PackageTask.new $specification do |pkg|
   pkg.need_tar = true
   pkg.need_zip = true
 end
 
-desc 'Test the gem.'
-Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*test.rb'
-  t.verbose = true
-  t.libs << 'test'
+task :notes do
+  puts `grep -r 'OPTIMIZE\\|FIXME\\|TODO' lib/ spec/ features/`
 end

data/bigbluebutton-api-ruby.gemspec

@@ -2,16 +2,16 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = 'bigbluebutton-api-ruby'
-  s.version = '0.0.11'
-  s.extra_rdoc_files = ['README.rdoc', 'LICENSE', 'CHANGELOG.rdoc']
+  s.version = '0.1.0.rc1'
+  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
   s.authors = ['Leonardo Crauss Daronco', 'Joe Kinsella']
   s.email = ['leonardodaronco@gmail.com', 'joe.kinsella@gmail.com']
   s.homepage = "https://github.com/mconf/bigbluebutton-api-ruby/"
   s.bindir = "bin"
-  s.files         = `git ls-files`.split("\n")
+  s.files = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency('nokogiri', '~> 1.4.0')
-end
+  s.add_runtime_dependency('xml-simple', '>= 1.1.1')
+end

data/examples/get_version_example.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
+
+require 'bigbluebutton_api'
+require 'prepare'
+
+begin
+  prepare
+
+  @api = BigBlueButton::BigBlueButtonApi.new(@config['bbb_url'], @config['bbb_salt'], nil, true)
+
+  puts
+  puts "---------------------------------------------------"
+  puts "The version of your BBB server is: #{@api.version}"
+rescue Exception => ex
+  puts "Failed with error #{ex.message}"
+  puts ex.backtrace
+end

data/examples/join_example.rb

@@ -0,0 +1,59 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
+
+require 'bigbluebutton_api'
+require 'prepare'
+
+begin
+  prepare
+
+  meeting_name = "Test Meeting"
+  meeting_id = "test-meeting"
+  moderator_name = "House"
+  attendee_name = "Cameron"
+  unless @api.is_meeting_running?(meeting_id)
+    puts "---------------------------------------------------"
+    options = { :moderatorPW => "54321",
+      :attendeePW => "12345",
+      :welcome => 'Welcome to my meeting',
+      :dialNumber => '1-800-000-0000x00000#',
+      :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
+    puts "---------------------------------------------------"
+    puts "Waiting 30 seconds for you to enter via browser"
+    sleep(30)
+  end
+
+  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
+  puts "---------------------------------------------------"
+  response = @api.join_meeting(meeting_id, attendee_name, options[:attendeePW])
+  puts "Join meeting response:"
+  puts response.inspect
+
+rescue Exception => ex
+  puts "Failed with error #{ex.message}"
+  puts ex.backtrace
+end