bigbluebutton_rails 0.0.6 → 0.1.0

data/.gitignore

@@ -4,6 +4,6 @@ pkg
 *.sqlite3
 log
 *.gem
-spec/integration_conf.yml
+spec/rails_app/features/config.yml
 coverage/
 rails_best_practices_output.html

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 0.1.0
+
+* First version with support to BigBlueButton 0.8:
+  * The support is still very basic: you can use the gem with BBB 0.8 but not all features are supported yet, such as pre-upload of slides and anything related to recordings.
+  * Updated bigbluebutton-api-ruby to 0.1.0 to support BBB 0.8.
+  * Added several integration tests.
+* Several small bug fixes
+
 == 0.0.6
 
 * After fetch_meetings, the rooms that are not found in the DB are *not* saved by default anymore.

data/Gemfile

@@ -2,15 +2,9 @@ source 'http://rubygems.org'
 
 gemspec
 
-group :development, :test do
-  gem "rspec-rails"
-  gem "factory_girl"
+group :development do
   gem "sqlite3-ruby"
-  gem "generator_spec"
-  gem "shoulda-matchers"
   gem "forgery"
-  gem "cucumber-rails"
-  gem "database_cleaner"
   gem "rdoc"
   gem "rails_best_practices"
 end
@@ -19,4 +13,16 @@ group :test do
   if RUBY_VERSION >= "1.9"
     gem 'simplecov', '>= 0.4.0', :require => false
   end
+
+  gem "cucumber-rails"
+  gem "database_cleaner"
+  gem "shoulda-matchers"
+  gem "factory_girl"
+  gem "generator_spec"
+  gem "rspec-rails"
+  gem "bbbot-ruby", :git => "git://github.com/mconf/bbbot-ruby.git"
+
+  gem "capybara-mechanize", "0.3.0.rc3" # allows remote requests
+  gem "launchy"
+  gem "capybara-webkit" # best option found for js
 end

data/Gemfile.lock

@@ -1,20 +1,26 @@
+GIT
+  remote: git://github.com/mconf/bbbot-ruby.git
+  revision: 83f3ccf88aa355260a791eb450a8d73f94049053
+  specs:
+    bbbot-ruby (0.0.1)
+
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (0.0.6)
-      bigbluebutton-api-ruby (~> 0.0.11)
-      rails (>= 3.0.3)
+    bigbluebutton_rails (0.1.0)
+      bigbluebutton-api-ruby (~> 0.1.0)
+      rails (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.9)
-      actionpack (= 3.0.9)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
       mail (~> 2.2.19)
-    actionpack (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.5.0)
@@ -22,133 +28,149 @@ GEM
       rack-mount (~> 0.6.14)
       rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
       arel (~> 2.0.10)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-    activesupport (3.0.9)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    addressable (2.2.6)
     arel (2.0.10)
-    bigbluebutton-api-ruby (0.0.11)
-      nokogiri (~> 1.4.0)
+    bigbluebutton-api-ruby (0.1.0)
+      xml-simple (>= 1.1.1)
     builder (2.1.2)
-    capybara (1.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 (~> 0.2.0)
+      selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    childprocess (0.2.0)
+    capybara-mechanize (0.3.0.rc3)
+      capybara (~> 1.1.0)
+      mechanize (~> 2.0.0)
+    capybara-webkit (0.7.2)
+      capybara (< 1.2, >= 1.0.0)
+    childprocess (0.2.3)
       ffi (~> 1.0.6)
     colored (1.2)
-    cucumber (1.0.2)
+    cucumber (1.1.4)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.4.5)
+      gherkin (~> 2.7.1)
       json (>= 1.4.6)
-      term-ansicolor (>= 1.0.5)
-    cucumber-rails (1.0.2)
-      capybara (>= 1.0.0)
-      cucumber (~> 1.0.0)
-      nokogiri (>= 1.4.6)
-    database_cleaner (0.6.7)
-    diff-lcs (1.1.2)
+      term-ansicolor (>= 1.0.6)
+    cucumber-rails (1.2.1)
+      capybara (>= 1.1.2)
+      cucumber (>= 1.1.3)
+      nokogiri (>= 1.5.0)
+    database_cleaner (0.7.0)
+    diff-lcs (1.1.3)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    factory_girl (2.0.2)
-    ffi (1.0.9)
-    forgery (0.3.12)
-      nokogiri (~> 1.4)
-    generator_spec (0.8.3)
-      rails (~> 3.0)
+    factory_girl (2.3.2)
+      activesupport
+    ffi (1.0.11)
+    forgery (0.5.0)
+    generator_spec (0.8.4)
+      rails (< 4.0, >= 3.0)
       rspec-rails
-    gherkin (2.4.5)
+    gherkin (2.7.1)
       json (>= 1.4.6)
-    haml (3.1.2)
     i18n (0.5.0)
-    json (1.5.3)
-    json_pure (1.5.3)
+    json (1.6.3)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    nokogiri (1.4.7)
-    polyglot (0.3.2)
-    rack (1.2.3)
+    mechanize (2.0.1)
+      net-http-digest_auth (>= 1.1.1, ~> 1.1)
+      net-http-persistent (~> 1.8)
+      nokogiri (~> 1.4)
+      webrobots (>= 0.0.9, ~> 0.0)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    net-http-digest_auth (1.2)
+    net-http-persistent (1.9)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    progressbar (0.9.2)
+    rack (1.2.4)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.9)
-      actionmailer (= 3.0.9)
-      actionpack (= 3.0.9)
-      activerecord (= 3.0.9)
-      activeresource (= 3.0.9)
-      activesupport (= 3.0.9)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
       bundler (~> 1.0)
-      railties (= 3.0.9)
-    rails_best_practices (0.10.1)
+      railties (= 3.0.11)
+    rails_best_practices (1.7.1)
       activesupport
       colored
       erubis
-      haml
       i18n
-      ruby-progressbar
-      ruby_parser
-    railties (3.0.9)
-      actionpack (= 3.0.9)
-      activesupport (= 3.0.9)
+      progressbar
+      sexp_processor
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (0.9.2)
-    rdoc (3.9.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)
+    rake (0.9.2.2)
+    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.6.0)
-    rspec-rails (2.6.1)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
       actionpack (~> 3.0)
       activesupport (~> 3.0)
       railties (~> 3.0)
-      rspec (~> 2.6.0)
-    ruby-progressbar (0.0.10)
-    ruby_parser (2.0.6)
-      sexp_processor (~> 3.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.2.2)
-      childprocess (>= 0.1.9)
-      ffi (>= 1.0.7)
-      json_pure
+      rspec (~> 2.7.0)
+    rubyzip (0.9.5)
+    selenium-webdriver (2.15.0)
+      childprocess (>= 0.2.1)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
       rubyzip
-    sexp_processor (3.0.5)
-    shoulda-matchers (1.0.0.beta3)
-    simplecov (0.4.2)
-      simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.5)
-    sqlite3 (1.3.4)
+    sexp_processor (3.0.9)
+    shoulda-matchers (1.0.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sqlite3 (1.3.5)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
-    term-ansicolor (1.0.6)
+    term-ansicolor (1.0.7)
     thor (0.14.6)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    tzinfo (0.3.31)
+    webrobots (0.0.12)
+      nokogiri (>= 1.4.4)
+    xml-simple (1.1.1)
     xpath (0.1.4)
       nokogiri (~> 1.3)
 
@@ -156,12 +178,16 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bbbot-ruby!
   bigbluebutton_rails!
+  capybara-mechanize (= 0.3.0.rc3)
+  capybara-webkit
   cucumber-rails
   database_cleaner
   factory_girl
   forgery
   generator_spec
+  launchy
   rails_best_practices
   rdoc
   rspec-rails

data/README.rdoc

@@ -14,14 +14,29 @@ Features:
 * Server activity monitor
 
 Planned features:
-* Friendly URLs (e.g. http://somewhere.com/my-server/my-room) (half way done)
+* Friendly URLs (e.g. http://somewhere.com/my-server/my-room)
 * Limit the number of users per room and rooms per server
 * Server administration (modify config.xml, use bbb-conf, etc.)
-* Load balancing
 * Decouple servers-rooms to allow server selection on-the-fly
+* Load balancing
 
 For more future features and issues check {our google code page}[http://code.google.com/p/mconf/issues/list?can=2&q=label%3AComponent%20label%3ABigBlueButtonRails].
 
+== Supported BigBlueButton versions
+
+The current version of this gem supports *all* the following versions of BigBlueButton:
+
+* 0.8: Currently in the beta3 stage. It can be used with BBB 0.8 but not all features are supported yet, such as pre-upload of slides and anything related to recordings. See {TODO_08}[https://github.com/mconf/bigbluebutton_rails/blob/api-0.8/TODO_08].
+* 0.7: Including 0.7, 0.71 and 0.71a.
+
+== Supported ruby versions
+
+Tested in rubies:
+
+* ruby-1.8.7
+* ruby-1.9.2
+* ree-1.8.7
+
 == Installation
 
 You can install the latest version of BigbluebuttonRails using RubyGems:
@@ -48,18 +63,7 @@ The routes to BigbluebuttonRails can be generated with the helper <tt>bigbluebut
 
   bigbluebutton_routes :default
 
-  resources :users do
-    bigbluebutton_routes :room_matchers
-    resources :spaces do
-      bigbluebutton_routes :room_matchers
-    end
-  end
-
-The first line generates the default routes. You need to call it at least once to generate the following routes:
-
-  bigbluebutton_routes :default
-
-It generates routes scoped with 'bigbluebutton'. These routes look like:
+It will generate the default routes. You need to call it at least once and the routes will be scoped with 'bigbluebutton'. They will look like:
 
   /bigbluebutton/servers
   /bigbluebutton/servers/default-server/rooms/my-room
@@ -70,23 +74,23 @@ You can customize the scope name and also make the routes point to custom contro
   bigbluebutton_routes :default, :scope => 'webconference', :controllers => { :servers => 'custom_servers', :rooms => 'custom_rooms' }
   bigbluebutton_routes :default, :scope => '' # to remove the scope
 
-If you customize the controllers as in the first line in the example above, be warned that every route generated after this will
-be using these controllers!
-
 You may also want shorter routes to access conference rooms. For that, use the option <tt>room_matchers</tt>:
 
   bigbluebutton_routes :room_matchers
 
-It creates routes to the actions used to access the conference room: "show", "join", "auth", "running", "end", "invite", and "join_mobile".
-So you can allow access to webconference rooms using URLs such as:
+  resources :users do
+    bigbluebutton_routes :room_matchers
+  end
+
+It creates routes to the actions used to access the conference room, so you can allow access to webconference rooms using URLs such as:
 
   http://myserver.com/server-name/room-name/join
   http://myserver.com/user-name/public-room/join
   http://myserver.com/ziltoid-room/join
 
-Obs: The URLs are not yet exactly like these, but soon they will be. But you can of course implement this in your application. Today they are like:
+For more information see:
 
-  http://myserver.com/bigblugbutton/server-name/rooms/room-name/join
+* {How to: Routes}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Routes]
 
 === User authorization, permissions and assumptions
 
@@ -106,71 +110,13 @@ and you can reimplement them in your application controller to change their beha
 * {How to: Integrate with Devise}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Integrate-with-Devise]
 * {How to: Integrate with CanCan}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Integrate-with-CanCan]
 
-== How it works
-
-=== Overview
-
-BigbluebuttonRails has two entities: servers and rooms. Servers can have multiple rooms, that belong to a server and can also belong to any other model.
-You can make a room belong to a user, for example.
-
-Every server has an associated API object (using the gem bigbluebutton-api-ruby) used to access the BigBlueButton server.
-The server controller has only the standard CRUD actions defined by Rails.
-
-The rooms controller also have the CRUD actions, plus some specific actions to join, end, and check if a meeting is currently running in the room.
-These extra actions will be explained bellow.
-
-A room model has methods to fetch and send information to the BBB server. They are simple API calls, but the "fetch" methods check the response and store
-data from it, while the "send" methods just make the API call. You can, for example, use <tt>fetch_meeting_info</tt> to get information about the meeting
-(will trigger the API call <tt>getMeetingInfo</tt>). The data parsed from the response wil be stored in the model and can be accessed using it's attributes.
-
-All methods in the models that trigger any API call are documented with "Triggers API call" and the API functions that are called. Be aware that they
-can throw a BigBlueButtonException.
-
-=== RoomsController
-
-==== <tt>running</tt> and <tt>end</tt>
-
-These are pretty simple actions. <tt>running</tt> returns a json indicating if the conference is running or not, while <tt>end</tt> ends the meeting.
-
-==== <tt>join_mobile</tt>
-
-This is an action that simply renders a view with a {QR code}[http://code.google.com/apis/chart/image/docs/gallery/qr_codes.html] and a link to join the
-conference from a mobile device. The link and the QR code point to links using the protocol "bigbluebutton://", so it can be associated with a native mobile
-application that will open the conference (such as the {Android client for BigBlueButton}[https://github.com/mconf/mconf-mobile]).
-
-==== <tt>join</tt>, <tt>invite</tt> and <tt>auth</tt>
-
-The actions used to redirect a user to join a room are <tt>join</tt> and <tt>invite</tt>, while <tt>auth</tt> is used by <tt>invite</tt> to authenticate
-the user. Basic differences:
-
-* <tt>invite</tt> renders a view to ask for a user name and a password. It is used to enable <b>anonymous users</b> to join a room or
-  to define the user role using the <b>room password</b> instead of the <tt>bigbluebutton_role</tt> method.
-  * It first checks <tt>bigbluebutton_role</tt> to see if the current user already has a role in the target room.
-    * In case it has (see {controller_methods.rb}[https://github.com/mconf/bigbluebutton_rails/blob/master/lib/bigbluebutton_rails/controller_methods.rb] for more info), redirects to <tt>join</tt>.
-    * Otherwise:
-      * If there is a user logged, uses <tt>bigbluebutton_user().name</tt> as the user name. Otherwise, ask the user to type a name.
-* <tt>join</tt> requires a <b>logged user</b> and uses <tt>bigbluebutton_role</tt> to get the role for this user
-  * It redirects the user straight to the meeting if the join is successful.
-  * In case there's no role associated with the current user, falls back to <tt>invite</tt> to ask for a password.
-
-Internally, they use the same algorithm:
-
-* If the user is a moderator:
-  * If the room is not created yet, creates it.
-  * Redirects the user to the meeting as a moderator.
-* If the user is not a moderator (a normal attendee):
-  * If the meeting is running, redirects the user to the meeting as an attendee.
-  * Otherwise:
-    * <tt>join</tt> renders the join view, to wait for a moderator before joining the conference. The page will continuously pool the server to check if the meeting is running. When it starts, it redirects the user to the conference.
-    * <tt>invite</tt> renders the invite view again and shows a warning informing that the meeting is not running. The user must re-submit the form to try again.
-
 == Contributing/Development
 
 Fork this repository, clone your fork and start by installing the dependencies:
 
   bundle install
 
-Edit <tt>spec/integration_conf.yml.example</tt> and set values for an existent BigBlueButton server. Save it as <tt>spec/integration_conf.yml</tt>. You will need it to run the integration tests.
+Edit <tt>spec/rails_app/features/integration_conf.yml.example</tt> and set values for an existent BigBlueButton server. Save it as <tt>spec/integration_conf.yml</tt>. You will need it to run the integration tests. For more information see the page [Testing](https://github.com/mconf/bigbluebutton_rails/wiki/Testing) in our wiki.
 
 Prepare the rails_app used for tests: