bigbluebutton_rails 1.4.0 → 2.0.0

data/CHANGELOG.rdoc

@@ -1,111 +0,0 @@
-== 1.4.0
-
-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
-
-* 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 <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 (<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
-
-* Updated ruby to 1.9.3-194.
-* Support to BigBlueButton 0.8 rc1.
-* Updated bigbluebutton-api-ruby to 1.1.0.
-
-== 1.1.0
-
-* Rooms are now decoupled from servers:
-  * A room can exist without a server;
-  * Everytime a 'send_create' is called in a room, the method 'select_server' is called to select a server where the meeting will be held. The room is saved if the server changed;
-  * The method 'select_server' by default selects the server with less rooms;
-  * The routes for rooms are not nested with servers anymore ('/bigbluebutton/rooms' instead of '/bigbluebutton/server/:id/rooms').
-    * Because of this change all path helpers for rooms <b>must be updated!</b>
-* rooms/external now receives a parameter "server_id" to indicate the server in which the external rooms is running. The views were updated.
-* "bigbluebutton_routes :room_matchers" now generates all routes available for rooms, not only a selected set as before.
-
-== 1.0.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.
-* New action to join external rooms (rooms that are not in the DB but exist in the BBB server).
-* Fixed some errors and warnings for Ruby 1.8.
-* Some changes in the logic of RoomsController#auth to enable a user to join a room that has a blank password.
-* Improvements in the mobile_join view to show a link that includes user authentication. But the QR code is still a bare link to the BBB server.
-* Made some improvements based on tips by rails_best_practices and increased the test coverage to 100% for almost all classes.
-
-== 0.0.5
-
-* URLs for both servers and rooms are now defined with a string attribute (called "param") instead of the model ID.
-* New return values for bigbluebutton_role: :password and nil.
-* Private rooms now require a password to be valid.
-* New action "join_mobile" for rooms that renders a QR code to join the conference using the protocol "bigbluebutton://".
-* New action "activity" for servers that shows a view to monitors a BBB server.
-* Added json responses for most of the actions.
-* logout_url can be an incomplete url and it will be completed with the current domain/protocol when a room is created in the BBB server.
-* The generator bigbluebutton_rails:public was removed. It's features are now inside bigbluebutton_rails:install.
-* After fetch_meetings all rooms are automatically stored in the DB if they are not there yet.
-
-== 0.0.4
-
-* A random voice_bridge with 5 digits (recommended) is set when a room is created.
-* Routes generators now allow specifying custom controllers instead of the defaults Bigbluebutton::ServersController and Bigbluebutton::RoomsController.
-* Some bug fixes (including fixes for ruby 1.8).
-
-== 0.0.3
-
-* Rooms can be public or private
-* New route RoomsController#invite used to request a password to join a room or to allow anonymous users to join.
-* Room's "meeting_id" attribute renamed to "meetingid".
-* A room can have it's meetingid randomly generated for each "send_create" call if randomize_meetingid is set.
-* New attributes for rooms: logout_url, dial_number, voice_bridge and max_participant.
-
-== 0.0.2
-
-* New "fetch" and "send" methods in BigbluebuttonRooms to fetch info about meetings from BBB and store in the model.
-* New class BigbluebuttonAttendee to store attendee information returned by BBB in get_meeting_info.
-* New class BigbluebuttonMeeting to store meeting information returned by BBB in get_meetings.
-
-== 0.0.1
-
-* First version
-* DB models for BigBlueButton servers and rooms
-* Controller to access servers and rooms
-* rooms_controller interacts with a BBB server using bigbluebutton-api-ruby

data/README.rdoc

@@ -1,319 +0,0 @@
-= BigBlueButton on 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 <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.
-* 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 (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 <tt>all</tt> the following versions of BigBlueButton:
-
-* 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.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 <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:
-
-  gem install bigbluebutton_rails
-
-Or simply add the following line in your Gemfile:
-
-  gem "bigbluebutton_rails"
-
-After installing, you need to run the generator:
-
-  rails generate bigbluebutton_rails:install
-
-This generator will create the files needed to setup the gem in your application.
-You should take some time to open all the files generated and analyze them.
-
-By default the gem will use the views it provides, <b>but it is strongly recommended that you adapt them for your needs!</b>
-The views provided are just an example of how they can be implemented in your application and
-they depend on jQuery (use the gem <tt>jquery-rails</tt>) and on a css file provided by this gem.
-You can easily generate the views and the css file in your application to later customize them with:
-
-  rails generate bigbluebutton_rails:views
-
-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:
-
-  bigbluebutton_routes :default
-
-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/my-server/new
-  /bigbluebutton/servers/my-server/rooms
-  /bigbluebutton/rooms
-  /bigbluebutton/rooms/my-room/join
-
-You can also make the routes use custom controllers:
-
-  bigbluebutton_routes :default, :controllers => {
-    :servers => 'custom_servers',
-    :rooms => 'custom_rooms',
-    :recordings => 'custom_recordings'
-  }
-
-To generate routes for a single controller:
-
-  bigbluebutton_routes :default, :only => 'servers'
-
-You may also want shorter routes to access conference rooms. For that, use the option <tt>room_matchers</tt>:
-
-  resources :users do
-    bigbluebutton_routes :room_matchers
-  end
-
-It creates routes to the actions used to access a conference room, so you can allow access to webconference rooms using URLs such as:
-
-  http://myserver.com/my-community/room-name/join
-  http://myserver.com/user-name/room-name/join
-
-For more information see:
-
-* {How to: Routes}[https://github.com/mconf/bigbluebutton_rails/wiki/How-to:-Routes]
-
-=== Basic configuration
-
-There are some basic assumptions made by BigbluebuttonRails:
-
-* You have a method called <tt>current_user</tt> that returns the current user;
-* The <tt>current_user</tt> has an attribute or method called "name" that returns
-  his/her fullname and an attribute or method "id" that returns the ID.
-
-If you don't, you can change this behaviour easily, keep reading.
-
-BigbluebuttonRails uses the methods <tt>bigbluebutton_user</tt> and <tt>bigbluebutton_role(room)</tt> to get the current user and to get the permission that the current
-user has in the <tt>room</tt>, respectively. These methods are defined in {lib/bigbluebutton_rails/controller_methods.rb}[https://github.com/mconf/bigbluebutton_rails/blob/master/lib/bigbluebutton_rails/controller_methods.rb]
-and you can reimplement them in your application controller to change their behaviour as shown below.
-
-  class ApplicationController < ActionController::Base
-
-    # overriding bigbluebutton_rails function
-    def bigbluebutton_user
-      current_user && current_user.is_a?(User) ? current_user : nil
-    end
-
-    def bigbluebutton_role(room)
-      ...
-    end
-
-  end
-
-
-=== Updating the recordings
-
-Since this task can consume quite some time if your server has a lot of recordings,
-it is recommended to run it periodically in the background. To do that, you can use the
-gem {whenever}[https://github.com/javan/whenever] (that uses {cron}[http://en.wikipedia.org/wiki/Cron]
-underneath).
-
-This gem provides a rake task to fetch the recordings from the webconference servers and
-update the application database. This task can be triggered from whenever/cron to update the entire
-recordings database.
-
-The command below will fetch recordings for <b>all servers</b> and update the database
-with all recordings found:
-
-  rake bigbluebutton_rails:recordings:update
-
-To set up whenever, first add it to your application Gemfile:
-
-  gem 'whenever', :require => false
-
-When you ran the generator <tt>:install</tt> previously, it created a file at
-<tt>config/schedule.rb</tt> inside your application. This file is used to configure whenever.
-Once this file is in place, running the following command will update your cron tab
-to update the recordings periodically.
-
-  whenever --update-crontab
-
-Check {whenever}[https://github.com/javan/whenever] page to learn more about it.
-
-
-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,
-check out the test application at <tt>spec/rails_app/</tt>!
-
-
-==== See also
-
-* {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]
-
-== Contributing/Development
-
-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, optional
-
-Run the tests:
-
-  rake spec
-  rake cucumber SERVER=my-server
-
-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:
-
-  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:
-
-  rake spec
-
-Run it and look at the file <tt>coverage/index.html</tt>.
-
-=== Best Practices
-
-We use the gem <tt>rails_best_practices</tt> to get some nice tips on how to improve the code.
-
-Run:
-
-  rake best_practices
-
-And look at the file <tt>rails_best_practices_output.html</tt> to see the tips.
-
-== License
-
-Distributed under The MIT License (MIT). See {LICENSE}[https://github.com/mconf/bigbluebutton_rails/blob/master/LICENSE].
-
-== Contact
-
-This project is developed as part of Mconf (http://mconf.org). Contact:
-
-* Mconf: A scalable opensource multiconference system for web and mobile devices
-* PRAV Labs - UFRGS - Porto Alegre - Brazil
-* http://www.inf.ufrgs.br/prav/gtmconf

data/TODO.rdoc

@@ -1,16 +0,0 @@
-TODO:
-* Pre-upload of slides
-* 'userID' argument in 'join' and in the respone of 'getMeetingInfo'.
-* 'createTime' argument in 'join' and in the response of 'create'.
-* New return values (e.g). 'createTime'.
-* We don't need to randomize the meeting_id anymore (to confirm)
-* Options 'redirectClient' and 'clientURL' on 'create'
-* Options 'configToken' and 'avatarURL' on 'join'
-* 'getDefaultConfigXML' and 'setConfigXML'. They are already used when a user joins a meeting,
-  to set the custom options configured in the target room. But these API methods cannot be called
-  individually yet.
-
-See:
-* https://code.google.com/p/bigbluebutton/wiki/API#Updates_to_API_in_BigBlueButton_0.81
-* http://code.google.com/p/bigbluebutton/wiki/API#Version_0.80
-* http://groups.google.com/group/bigbluebutton-dev/browse_thread/thread/c214cbe9bdb2268a?pli=1

data/config/schedule.rb

@@ -1,7 +0,0 @@
-every 30.minutes do
-  rake "bigbluebutton_rails:recordings:update"
-end
-
-every 30.minutes do
-  rake "bigbluebutton_rails:meetings:finish"
-end