bigbluebutton_rails 1.3.0 → 1.4.0.beta1

data/.gitignore

@@ -5,6 +5,8 @@ pkg
 log
 *.gem
 spec/rails_app/features/config.yml
+spec/rails_app/config/database.yml
 coverage/
 rails_best_practices_output.html
 bot.log
+.bundle/

data/.rspec

@@ -1,2 +1,2 @@
---format progress
---color
+--format documentation
+--color

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p194
+1.9.3-p484

data/CHANGELOG.rdoc

@@ -1,16 +1,41 @@
+== 1.4.0 (in development)
+
+To learn how to migrate to 1.4.0 see: https://github.com/mconf/bigbluebutton_rails/wiki/Migrate-to-1.4.0
+
+* New dependencies:
+  * resque: To keep track of meetings that happened.
+  * strong_parameters: To allow controllers to decide which parameters can be modified and which can't. Default in Rails 4, should also be used in Rails 3.
+* With strong_parameters in all controllers now the application can decide which parameters can be accessed and which can't. You can have different logics for different types of users.
+* Use <tt>params[:redir_url]</tt> (if present) to redirect the user to a custom URL in all actions where possible. This can be set by the application to redirect the user to a custom location after updating a model, for instance.
+* Register meetings that happened: new model <tt>BigbluebuttonMeeting</tt> that stores instances of meetings that happened in a room. Uses resque to monitor when meetings started. They are also associated with recordings, so the application can show a registry of meetings that happened and their respective recording.
+* MySQL as a default database (was sqlite).
+* First logic layout to set a custom config.xml when joining a room:
+  * Every room has an associated BigbluebuttonRoomOptions model;
+  * This model contains custom options that will be set in the config.xml when a user joins the associated room;
+  * When the user joins, the library will get the default config.xml from the server, modify it according to the BigbluebuttonRoomOptions, and set it on the server to use it in the <tt>join</tt> API call;
+  * Currently the only parameters that can be customized are: <tt>default layout</tt>, <tt>presenter_share_only</tt>, <tt>auto_start_audio</tt>, and <tt>auto_start_video</tt>.
+* Fixed the mobile urls generated in <tt>join_mobile</tt>.
+* Updated ruby to 1.9.3-p484.
+* New controller method <tt>bigbluebutton_create_options</tt>. Can return a hash of parameters that will override the parameters in the database when sending a create call. Can be used to force some options when creating a meeting without needing to save it to the database.
+* Removed the routes to join external rooms. This feature was never really used, so was just consuming space and time. Removed the actions <tt>RoomsController#external</tt> and <tt>RoomsController#external_auth</tt>. The flag <tt>external</tt> in <tt>BigbluebuttonRoom</tt> is still there, since it is used to identify external meetings when fetching the meetings from a server.
+* New logic to join meetings from mobile devices: now there's no specific page to join from a mobile. Once /join is called, if the user is in a mobile device (detected using the user's "user-agent") then a page will be rendered and the user will be automatically redirected to the conference using the mobile client. This page has also more information just in case the user is not properly redirected (if the mobile client is not installed, for example).
+* Removed the login via QR Code.
+
 == 1.3.0
 
-* To learn how to migrate to 1.3.0 see: https://github.com/mconf/bigbluebutton_rails/wiki/Migrate-to-1.3.0
+To learn how to migrate to 1.3.0 see: https://github.com/mconf/bigbluebutton_rails/wiki/Migrate-to-1.3.0
 
+* New dependency:
+  * whenever: To configure cron to trigger resque.
 * Support for recordings. Details at https://github.com/mconf/bigbluebutton_rails/wiki/How-Recordings-Work. #459.
 * Updated most of the dependencies to their latest version.
 * Tested against Rails 3.2 (was Rails 3.0).
-* New option `:as` in router helpers (more at https://github.com/mconf/bigbluebutton_rails/wiki/How-to%3A-Routes)
-* New option `:only` in router helpers (more at https://github.com/mconf/bigbluebutton_rails/wiki/How-to%3A-Routes)
-* Set the HTTP header "x-forwarded-for" with the IP of the client so servers can know who is creating/joining a meeting, for example.
+* New option <tt>:as</tt> in router helpers (more at https://github.com/mconf/bigbluebutton_rails/wiki/How-to%3A-Routes)
+* New option <tt>:only</tt> in router helpers (more at https://github.com/mconf/bigbluebutton_rails/wiki/How-to%3A-Routes)
+* Set the HTTP header <tt>x-forwarded-for</tt> with the IP of the client so servers can know who is creating/joining a meeting, for example.
 * Removed assets (jquery, image) from the generator and from the gem.
-* Removed the option to randomize meeting IDs, now they are fixed and generated as a globally unique meeting ID (`#{SecureRandom.uuid}-#{Time.now.to_i}`). #734, #735.
-* Added logic to control who can create meetings (method called `bigbluebutton_can_create?`).
+* Removed the option to randomize meeting IDs, now they are fixed and generated as a globally unique meeting ID (<tt>"#{SecureRandom.uuid}-#{Time.now.to_i}"</tt>). #734, #735.
+* Added logic to control who can create meetings (method called <tt>bigbluebutton_can_create?</tt>).
 
 == 1.2.0
 

data/Gemfile

@@ -2,11 +2,15 @@ source "http://rubygems.org"
 
 gemspec
 
+gem "strong_parameters"
+gem "resque"
+gem "browser"
+
 group :development do
-  gem "sqlite3-ruby"
   gem "forgery"
   gem "rdoc"
   gem "rails_best_practices"
+  gem "spork-rails"
 end
 
 group :test do
@@ -22,18 +26,24 @@ group :test do
   gem "rspec-rails"
   gem "bbbot-ruby", :git => "git://github.com/mconf/bbbot-ruby.git"
 
-  gem "capybara-mechanize" # for remote requests
-  gem "launchy"
+  # to use redis in-memory and clean it in-between tests, used for resque
+  gem "fakeredis", :require => "fakeredis/rspec"
+
+  gem "capybara", "~> 2.0.0"
+  gem "capybara-mechanize", "~> 1.0.0" # for remote requests
   gem "capybara-webkit" # best option found for js
+  gem "launchy"
 end
 
 # Gems used by the test application
 group :assets do
   gem 'sass-rails', '~> 3.2.3'
   gem 'coffee-rails', '~> 3.2.1'
+  gem 'therubyracer', '~> 0.12.0'
   gem 'uglifier', '>= 1.0.3'
 end
 group :development do
+  gem 'mysql2'
   gem "jquery-rails"
   gem "whenever"
 end

data/Gemfile.lock

@@ -1,15 +1,18 @@
 GIT
   remote: git://github.com/mconf/bbbot-ruby.git
-  revision: 5ec55fa1e7bdbc67aa82fa244f5e852497aaf29b
+  revision: 506444359a5c2921718ccb13c7786ebe7e9109b2
   specs:
     bbbot-ruby (0.0.1)
 
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (1.3.0)
-      bigbluebutton-api-ruby (~> 1.2.0)
+    bigbluebutton_rails (1.4.0.beta1)
+      bigbluebutton-api-ruby (~> 1.3.0)
+      browser (~> 0.5.0)
       rails (>= 3.0.0)
+      resque (~> 1.25.1)
+      strong_parameters (~> 0.2.0)
 
 GEM
   remote: http://rubygems.org/
@@ -44,8 +47,9 @@ GEM
     addressable (2.3.2)
     arel (3.0.2)
     awesome_print (1.1.0)
-    bigbluebutton-api-ruby (1.2.0)
+    bigbluebutton-api-ruby (1.3.0)
       xml-simple (>= 1.1.1)
+    browser (0.5.0)
     builder (3.0.4)
     capybara (2.0.3)
       mime-types (>= 1.16)
@@ -54,14 +58,14 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
       xpath (~> 1.0.0)
-    capybara-mechanize (0.3.0)
+    capybara-mechanize (1.0.1)
       capybara (~> 2.0, >= 2.0.1)
       mechanize (~> 2.5)
     capybara-webkit (0.14.2)
       capybara (~> 2.0, >= 2.0.2)
       json
-    childprocess (0.3.6)
-      ffi (~> 1.0, >= 1.0.6)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
     chronic (0.9.0)
     code_analyzer (0.3.0)
       sexp_processor
@@ -73,35 +77,40 @@ GEM
       execjs
     coffee-script-source (1.4.0)
     colored (1.2)
-    cucumber (1.2.1)
+    cucumber (1.3.2)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
-    cucumber-rails (1.3.0)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.3)
+    cucumber-rails (1.4.0)
       capybara (>= 1.1.2)
-      cucumber (>= 1.1.8)
+      cucumber (>= 1.2.0)
       nokogiri (>= 1.5.0)
+      rails (>= 3.0.0)
     database_cleaner (0.9.1)
     diff-lcs (1.1.3)
-    domain_name (0.5.4)
-      unf (~> 0.0.3)
+    domain_name (0.5.13)
+      unf (>= 0.0.5, < 1.0.0)
     erubis (2.7.0)
     execjs (1.4.0)
       multi_json (~> 1.0)
     factory_girl (4.1.0)
       activesupport (>= 3.0.0)
+    fakeredis (0.4.2)
+      redis (~> 3.0.0)
     ffi (1.1.5)
     ffi (1.1.5-java)
     forgery (0.5.0)
     generator_spec (0.8.7)
       activerecord (>= 3.0, < 4.0)
       railties (>= 3.0, < 4.0)
-    gherkin (2.11.5)
-      json (>= 1.4.6)
-    gherkin (2.11.5-java)
-      json (>= 1.4.6)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    gherkin (2.12.1-java)
+      multi_json (~> 1.3)
     hike (1.2.1)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
     i18n (0.6.1)
     journey (1.0.4)
     jquery-rails (2.1.4)
@@ -115,24 +124,28 @@ GEM
       addressable (~> 2.3)
       ffi (~> 1.1.1)
       spoon (~> 0.0.1)
+    libv8 (3.16.14.3)
     libwebsocket (0.1.5)
       addressable
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mechanize (2.5.1)
+    mechanize (2.7.2)
       domain_name (~> 0.5, >= 0.5.1)
+      http-cookie (~> 1.0.0)
       mime-types (~> 1.17, >= 1.17.2)
       net-http-digest_auth (~> 1.1, >= 1.1.1)
       net-http-persistent (~> 2.5, >= 2.5.2)
       nokogiri (~> 1.4)
       ntlm-http (~> 0.1, >= 0.1.1)
-      webrobots (~> 0.0, >= 0.0.9)
+      webrobots (>= 0.0.9, < 0.2)
     mime-types (1.19)
+    mono_logger (1.1.0)
     multi_json (1.3.7)
-    net-http-digest_auth (1.2.1)
-    net-http-persistent (2.8)
+    mysql2 (0.3.13)
+    net-http-digest_auth (1.4)
+    net-http-persistent (2.9)
     nokogiri (1.5.5)
     nokogiri (1.5.5-java)
     ntlm-http (0.1.1)
@@ -141,6 +154,8 @@ GEM
     rack (1.4.1)
     rack-cache (1.2)
       rack (>= 0.4)
+    rack-protection (1.5.0)
+      rack
     rack-ssl (1.3.2)
       rack
     rack-test (0.6.2)
@@ -171,44 +186,66 @@ GEM
     rake (10.0.1)
     rdoc (3.12)
       json (~> 1.4)
-    rspec-core (2.12.0)
-    rspec-expectations (2.12.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    rspec-rails (2.12.0)
+    redis (3.0.5)
+    redis-namespace (1.3.1)
+      redis (~> 3.0.0)
+    ref (1.0.5)
+    resque (1.25.1)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.2)
+    rspec-rails (2.14.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
     rubyzip (0.9.9)
     sass (3.2.5)
     sass-rails (3.2.6)
       railties (~> 3.2.0)
       sass (>= 3.1.10)
       tilt (~> 1.3)
-    selenium-webdriver (2.26.0)
+    selenium-webdriver (2.35.1)
       childprocess (>= 0.2.5)
       libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)
       rubyzip
     sexp_processor (4.1.2)
-    shoulda-matchers (1.4.1)
+    shoulda-matchers (2.2.0)
       activesupport (>= 3.0.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    sinatra (1.3.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
     spoon (0.0.1)
+    spork (1.0.0rc3)
+    spork-rails (3.2.1)
+      rails (>= 3.0.0, < 3.3.0)
+      spork (>= 1.0rc0)
     sprockets (2.2.1)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    sqlite3-ruby (1.3.3)
-      sqlite3 (>= 1.3.3)
+    strong_parameters (0.2.1)
+      actionpack (~> 3.0)
+      activemodel (~> 3.0)
+      railties (~> 3.0)
+    therubyracer (0.12.0)
+      libv8 (~> 3.16.14.0)
+      ref
     thor (0.16.0)
     tilt (1.3.3)
     treetop (1.4.14)
@@ -218,15 +255,17 @@ GEM
     uglifier (1.3.0)
       execjs (>= 0.3.0)
       multi_json (~> 1.0, >= 1.0.2)
-    unf (0.0.5)
+    unf (0.1.2)
       unf_ext
-    unf (0.0.5-java)
-    unf_ext (0.0.5)
-    webrobots (0.0.13)
+    unf (0.1.2-java)
+    unf_ext (0.0.6)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    webrobots (0.1.1)
     whenever (0.8.2)
       activesupport (>= 2.3.4)
       chronic (>= 0.6.3)
-    xml-simple (1.1.2)
+    xml-simple (1.1.3)
     xpath (1.0.0)
       nokogiri (~> 1.3)
 
@@ -237,22 +276,29 @@ PLATFORMS
 DEPENDENCIES
   bbbot-ruby!
   bigbluebutton_rails!
-  capybara-mechanize
+  browser
+  capybara (~> 2.0.0)
+  capybara-mechanize (~> 1.0.0)
   capybara-webkit
   coffee-rails (~> 3.2.1)
   cucumber-rails
   database_cleaner
   factory_girl
+  fakeredis
   forgery
   generator_spec
   jquery-rails
   launchy
+  mysql2
   rails_best_practices
   rdoc
+  resque
   rspec-rails
   sass-rails (~> 3.2.3)
   shoulda-matchers
   simplecov (>= 0.4.0)
-  sqlite3-ruby
+  spork-rails
+  strong_parameters
+  therubyracer (~> 0.12.0)
   uglifier (>= 1.0.3)
   whenever

data/README.rdoc

@@ -1,46 +1,54 @@
 = BigBlueButton on Rails
-{<img src="https://secure.travis-ci.org/mconf/bigbluebutton_rails.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mconf/bigbluebutton_rails]
 
 {BigBlueButton}[http://bigbluebutton.org] integration for Ruby on Rails 3.
 
 Features:
 * Allows multiple servers and multiple conference rooms.
 * Full API access using {bigbluebutton-api-ruby}[https://github.com/mconf/bigbluebutton-api-ruby].
-* Easy way to join conferences: simply create a room and call the "join" action.
-* Easy integration with authentication and authorization mechanisms, such as Devise and CanCan.
+* Easy way to join conferences: simply create a room and call the <tt>join</tt> action.
+* Easy integration with authentication and authorization mechanisms, such as {Devise}[https://github.com/plataformatec/devise] and {CanCan}[https://github.com/ryanb/cancan].
 * Support for recordings: meetings can be recorded, the list of recordings retrieved and recordings can be played.
 * Possibility to create private rooms, that require a password to join.
 * Deals with visitors (users that are not logged), allowing (or forbidding) them to join rooms.
-* Random meeting IDs to avoid problems with "end", timeouts and reuse of URLs.
-* Server activity monitor.
-* "On-the-fly" server selection when a meeting is started.
+* Uses static meeting IDs generated as a globally unique identifier (e.g. "36mskja87-029i-lsk9-b96e-98278407e145-1365703324").
+* Server activity monitor that shows what's happening in the server.
+* Stores a registry of meetings that happened and associates them with the recording that was generated for it (if any).
+* Allows rooms to be configured dynamically using the <tt>{config.xml}[https://code.google.com/p/bigbluebutton/wiki/ClientConfiguration]</tt> feature.
 
 Possible future features:
 * Limit the number of users per room and rooms per server.
-* Server administration (modify config.xml, use bbb-conf, etc.).
+* Server administration (use bbb-conf, etc.).
 * Pre-upload of slides.
+* See {TODO.rdoc}[https://github.com/mconf/bigbluebutton_rails/blob/master/TODO.rdoc].
 
 == Supported versions
 
 === BigBlueButton
 
-The current version of this gem supports *all* the following versions of BigBlueButton:
+The current version of this gem supports <tt>all</tt> the following versions of BigBlueButton:
 
-* 0.8: Altough not all features are supported yet, such as pre-upload of slides. See {TODO_08}[https://github.com/mconf/bigbluebutton_rails/blob/master/TODO_08].
+* 0.81: Altough not all features are supported yet. (See {TODO.rdoc}[https://github.com/mconf/bigbluebutton_rails/blob/master/TODO.rdoc].)
+* 0.8: Altough not all features are supported yet, such as pre-upload of slides. (See {TODO.rdoc}[https://github.com/mconf/bigbluebutton_rails/blob/master/TODO.rdoc].)
 * 0.7: Including 0.7, 0.71 and 0.71a.
 
 === Ruby
 
 Tested in rubies:
 
-* ruby-1.9.2
-* ruby-1.9.3
+* ruby-1.9.3 (p484) *recommended*
+* ruby-1.9.2 (p290)
+
+Use these versions to be sure it will work. Other patches of 1.9.2 and 1.9.3 should work as well.
 
 === Rails
 
-To be used with *Rails 3* only (should work on 3.0, 3.1 and 3.2).
+To be used with <b>Rails 3</b> only (should work on 3.0, 3.1 and 3.2).
 Tested mainly with Rails 3.2.
 
+=== Database
+
+We recommend the use of MySQL in your application, since this gem is developed and tested using it.
+
 == Installation
 
 You can install the latest version of BigbluebuttonRails using RubyGems:
@@ -67,6 +75,29 @@ You can easily generate the views and the css file in your application to later
 
 To now more about the generators see {How to: Generators}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Generators]
 
+==== Dependencies
+
+Notice: Since version 1.4.0, new dependencies were added to applications that use this gem.
+
+Include the following gems in your Gemfile:
+
+  gem 'whenever'
+  gem 'strong_parameters'
+  gem 'resque'
+
+{whenever}[https://github.com/javan/whenever] is used to schedule cron jobs from the application. Cron jobs are used in BigbluebuttonRails
+to update the list of recordings periodically.
+
+{strong_parameters}[https://github.com/rails/strong_parameters] is used to validate which parameters can be updated in a model. With
+it you can, for example, allow admins to update anything on a web conference rooms while normal users can only update the rooms name.
+This gem is used by default in Rails 4.
+
+{resque}[https://github.com/defunkt/resque] is used to schedule workers that will control the list of meetings. A meeting is a model that is
+created whenever a meeting is held in a room. We need workers to run these tasks in background and check when meetings start and stop.
+
+Read more about some of these dependencies below.
+
+
 === Routes
 
 The routes to BigbluebuttonRails can be generated with the helper <tt>bigbluebutton_routes</tt>. See the example below:
@@ -108,7 +139,7 @@ For more information see:
 
 * {How to: Routes}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Routes]
 
-=== Basic configurations
+=== Basic configuration
 
 There are some basic assumptions made by BigbluebuttonRails:
 
@@ -170,6 +201,24 @@ For more information see:
 
 * {How recordings work}[https://github.com/mconf/bigbluebutton_rails/wiki/How-Recordings-Work]
 
+
+=== Updating the list of meetings
+
+Meetings (<tt>BigbluebuttonMeeting</tt> models) in BigbluebuttonRails are instances of meetings that were held in web conference rooms. A meeting is created whenever
+the application detects that a user joined a room and that he's the first user. Meetings are never removed, they are kept as a registry of
+what happened in the web conference servers connected to BigbluebuttonRails.
+
+The creating of these objects is done in background using a gem called {resque}[https://github.com/defunkt/resque]. Whenever a user
+clicks in the button to join a meeting, a resque worker is scheduled. This worker will wait for a while until the meeting is created and
+running in the web conference server, and will then create the correponding <tt>BigbluebuttonMeeting</tt> object.
+
+To keep track of meetings, you have to run the resque workers (this is needed both in development and in production):
+
+  rake resque:work QUEUE='bigbluebutton_rails'
+
+The list of meetings is also periodically synchronized using cron tasks, as is done for the list of recordings (see the section above).
+
+
 === Example application
 
 If you need more help to set up the gem or just want to see an example of it working,
@@ -186,16 +235,18 @@ check out the test application at <tt>spec/rails_app/</tt>!
 Fork this repository, clone your fork and start by installing the dependencies:
 
   bundle install
-  
+
 Note: if you're getting an error installing <tt>capybara-webkit</tt>, most likely you need to install QT, see: https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit
 
+First copy <tt>spec/rails_app/config/database.yml.example</tt> to <tt>spec/rails_app/config/database.yml</tt>. It uses MySQL since this is the database recommended for the applications that use this gem. You have to set the appropriate password for your MySQL user.
+
 Save <tt>spec/rails_app/features/config.yml.example</tt> as <tt>spec/rails_app/features/config.yml</tt> and edit it to set values for an existent BigBlueButton server. 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 <tt>rails_app</tt> used for tests:
 
   rake rails_app:install
   rake rails_app:db SERVER=my-server # select a server you defined in 'config.yml'
-  rake rails_app:populate            # to create fake data
+  rake rails_app:populate            # to create fake data, optional
 
 Run the tests:
 
@@ -206,6 +257,10 @@ Or simply:
 
   rake SERVER=my-server
 
+If you're adding migrations to the gem, test them with:
+
+  rake spec:migrations
+
 Note: If you don't set the SERVER variable, the first server in <tt>config.yml</tt> will be used.
 
 You can also start the test application and navigate to <tt>localhost:3000</tt> to check it:
@@ -213,12 +268,26 @@ You can also start the test application and navigate to <tt>localhost:3000</tt>
   cd spec/rails_app/
   rails server
 
+If you need to keep track of meetings, run the resque workers with:
+
+  rake resque:work QUEUE='bigbluebutton_rails'
+
 Develop. :)
 
 If you want your code to be integrated in this repository, please fork it, create a branch with your modifications and submit a pull request.
 
 * See more about testing {in our wiki page}[https://github.com/mconf/bigbluebutton_rails/wiki/Testing].
 
+=== Spork
+
+{Spork}[https://github.com/sporkrb/spork-rails] allows you to run tests faster. Run this in a terminal to start spork:
+
+  bundle exec spork
+
+Then run the tests with:
+
+  bundle exec rspec -X spec/
+
 === Test Coverage
 
 Coverage is analyzed by default when you run: