bigbluebutton_rails 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44ffb5fae34d7b736ebf6c372c512b2b37d8f41f
-  data.tar.gz: 3446e484579e743d3f58b40bcfc06168f8062ac7
+  metadata.gz: 88081dab1ee2f637c46993cd9b6f655cc4516afb
+  data.tar.gz: 791d30eb4d1873e75834754aed5c43b4b4a1c3f2
 SHA512:
-  metadata.gz: 81ccfdd0a387e03d5d54ae67175eb77a1904e524e3f33b13b53a248f5bd7baebb6c0e4fa40317b50d776082fcf3f2ed0b23d33a7cb263f4630995a48bc8a40e6
-  data.tar.gz: c608a39eef0b90ce899f344f05b0d07433010375924de85ba19260d39ca11cacc0f7c365f8c6fb078706a985c0710a90921d1684bef7d444ecec18481c165894
+  metadata.gz: 69a370e8996753af92fdf67be6d6c6172fd02938f1a9b9a2c23960a0f2cb2d656ba70a67f3a87bd830c7a9b7246cf53d8c7f75b7c4cbcf2a735c79cf18a40899
+  data.tar.gz: 2adec10068e736881b444dbf584b5427ef83d7661a0fafed7e0b5037b0762e5faf4b5323a360c4b8d5e64357e5b6c8592b410b1a2e019af93c8e3c3658d4eefa

data/.travis.yml

@@ -2,6 +2,8 @@ sudo: false
 language: ruby
 services:
   - redis-server
+before_install:
+  - gem install bundler
 bundler_args: "--without production development"
 before_script:
   - "cp spec/rails_app/config/database.yml.travis spec/rails_app/config/database.yml"
@@ -11,6 +13,4 @@ before_script:
 cache: bundler
 script: "bundle exec rake rails_app:install rails_app:db spec"
 rvm:
-  - 2.1.2
-  - 2.2.0
-  - 1.9.3
+  - 2.2

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Change Log
 
+## [2.3.0] - 2019-11-14
+
+* [#136] Improve matching between recordings and meetings and migrate old recordings to
+  always (when possible) have a meeting associated.
+* Add new worker to fetch recordings after meetings are ended to improve the speed with which
+  recordings are found after meetings
+* Fix setting the `recorded` attributes in newly created meetings, it was always using the
+  attributes from model, without considering that it is possible to override these attributes when
+  making a "create" call (which is exactly what Mconf-Web does).
+* First version of a JSON API that applications can use to list and join meetings created
+  by this gem. All calls are authenticated by a secret configure in
+  `BigbluebuttonRails.configuration.api_secret`.
+* Remove old unnecessary json responses. Most routes had it but most were not used.
+* Add docker configs to run the gem in development and to run tests.
+* Set the `finish_time` on meetings when setting them as ended.
+* Add options to set dynamic options when creating and joining conferences. See
+  `get_create_options` and `get_join_options`.
+* Make it easier for apps to customize the config.xml in a join call.
+* Add support for `<recordingUsers>` returned by getRecordings.
+* Add option to run on/off the authentication in playback URLs. When on, it will call
+  `getRecordingToken` on the server holding the recording and use the proper parameters
+  when redirecting the user to the playback URL.
+  See `BigbluebuttonRails.configuration.playback_url_authentication`.
+* Add option to show recording playback pages inside an iframe. Optional and off by default.
+  If turned on all playback formats that are *not* downloadable will be shown inside an
+  iframe. See `BigbluebuttonRails.configuration.playback_iframe`.
+* Increase the limit in the name of rooms from 150 to 250 chars.
+* Speed up recording sync by using batch imports (`activerecord-import`) and preventing
+  unchanged recordings from being updated when syncing.
+* Fix errors when trying to playback a recording that doesn't exist.
+
+
 ## [2.2.0] - 2017-10-04
 
 * Make only description editable in recordings, since all other attributes are taken from
@@ -287,6 +319,8 @@ https://github.com/mconf/bigbluebutton_rails/wiki/Migrate-to-1.3.0
 * Controller to access servers and rooms
 * rooms_controller interacts with a BBB server using bigbluebutton-api-ruby
 
+[2.2.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.2.0...v2.3.0
+[2.3.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.1.0...v2.2.0
 [2.1.0]: https://github.com/mconf/bigbluebutton_rails/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/mconf/bigbluebutton_rails/compare/v1.4.0...v2.0.0
 [1.4.0]: https://github.com/mconf/bigbluebutton_rails/compare/v1.3.0...v1.4.0

data/Dockerfile

@@ -0,0 +1,23 @@
+FROM ruby:2.2.0
+
+RUN apt-get update && \
+  apt-get install -y qt5-default libqt5webkit5-dev gstreamer1.0-plugins-base gstreamer1.0-tools gstreamer1.0-x
+
+ENV app /usr/src/app
+
+# Create app directory
+RUN mkdir -p $app
+WORKDIR $app
+
+# Bundle app source
+COPY . $app
+
+# Install app dependencies
+RUN bundle install
+
+# dumb-init
+ADD dumb-init_1.2.0 /usr/bin/dumb-init
+RUN chmod +x /usr/bin/dumb-init
+
+ENTRYPOINT ["/usr/bin/dumb-init", "--"]
+CMD [ "bundle", "exec", "rails", "server" ]

data/Gemfile

@@ -5,6 +5,8 @@ gemspec
 gem 'mysql2'
 gem "jquery-rails"
 gem "forgery"
+gem 'rabl'
+gem 'activerecord-import'
 
 group :development do
   gem "rdoc"
@@ -31,6 +33,7 @@ group :test do
   gem "capybara-webkit" # best option found for js
   gem "launchy"
   gem "webmock"
+  gem "timecop"
 
   # to use redis in-memory and clean it in-between tests, used for resque
   gem "fakeredis", :require => "fakeredis/rspec"

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    bigbluebutton_rails (2.2.0)
+    bigbluebutton_rails (2.3.0)
+      activerecord-import (~> 1.0)
       bigbluebutton-api-ruby (~> 1.6)
       browser (~> 0.8.0)
       rails (>= 4.0.0)
@@ -31,6 +32,8 @@ GEM
       activemodel (= 4.1.4)
       activesupport (= 4.1.4)
       arel (~> 5.0.0)
+    activerecord-import (1.0.2)
+      activerecord (>= 3.2)
     activesupport (4.1.4)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
@@ -40,7 +43,7 @@ GEM
     addressable (2.3.6)
     arel (5.0.1.20140414130214)
     awesome_print (1.2.0)
-    bigbluebutton-api-ruby (1.6.0)
+    bigbluebutton-api-ruby (1.7.0)
       xml-simple (~> 1.1)
     browser (0.8.0)
     builder (3.2.2)
@@ -141,8 +144,10 @@ GEM
     nokogiri (1.6.2.1-java)
     ntlm-http (0.1.1)
     polyglot (0.3.5)
+    rabl (0.10.1)
+      activesupport (>= 2.3.14)
     rack (1.5.2)
-    rack-protection (1.5.3)
+    rack-protection (1.5.5)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -175,8 +180,8 @@ GEM
     rdoc (4.1.1)
       json (~> 1.4)
     redis (3.1.0)
-    redis-namespace (1.5.3)
-      redis (~> 3.0, >= 3.0.4)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
     ref (1.0.5)
     require_all (1.3.2)
     resque (1.25.2)
@@ -249,6 +254,7 @@ GEM
     thread_safe (0.3.4)
     thread_safe (0.3.4-java)
     tilt (1.4.1)
+    timecop (0.9.1)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
@@ -276,6 +282,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord-import
   bigbluebutton_rails!
   capybara (~> 2.2.0)
   capybara-mechanize
@@ -291,6 +298,7 @@ DEPENDENCIES
   launchy
   minitest
   mysql2
+  rabl
   rails_best_practices
   rdoc
   rspec-activemodel-mocks
@@ -299,5 +307,6 @@ DEPENDENCIES
   shoulda-matchers (~> 2.6.1)
   simplecov (>= 0.4.0)
   therubyracer (~> 0.12.0)
+  timecop
   uglifier (>= 1.0.3)
   webmock

data/README.md

@@ -280,30 +280,37 @@ The list of meetings is also periodically synchronized using Resque-scheduler
 ### Associating rooms and servers
 
 Rooms must be associated with a server to function. When a meeting is created,
-it is created in the server that's associated with the room. The association
-is done using the `server_id` attribute in `BigbluebuttonRoom`. So
-applications that use this gem can manage all the associations by simply
-setting this attribute.
-
+it is created in the server that's associated with the room.
 By default, this gem automatically selects a server **if one is needed and the
-room has no server yet**. If a room already has a server, the gem will never
-change it.
+room has no server yet**.
 
-To change this behavior, applications can override the method
-`{BigbluebuttonRoom#select_server}[https://github.com/mconf/bigbluebutton_rail
-s/blob/5decf3fa7767002303cf8bda524dcbeca0a9146c/app/models/bigbluebutton_room.
-rb#L413]`. This method is called by all methods that trigger API calls,
+To change this behavior, applications can override the configuration
+`BigbluebuttonRails.configuration.select_server`. This attribute receives a
+function that will be called inside all methods that trigger API calls,
 methods that need a server to work properly. It receives a parameter that
-indicates which API call will be sent to the server.
-
-If the method returns a server, the server will be associated with the room.
-If the method returns `nil`, the room will maintain the server it had
-previously (if any).
+indicates which API call will be sent to the server and expects the function
+to return a `BigbluebuttonServer`.
 
 One common use would be to override this method to always select a new server
 when a meeting is created (when the argument received is `:create`). This
 would allow the implementation of a simple load balancing mechanism.
 
+To configure it, add a code like the one below to one initializer in your
+application:
+
+```ruby
+BigbluebuttonRails.configure do |config|
+  config.select_server = Proc.new do |room, api_method=nil|
+    if room.name == 'special-room'
+      BigbluebuttonServer.find_by(name: 'special-server')
+    else
+      BigbluebuttonServer.first
+    end
+  end
+end
+```
+
+
 ### Example application
 
 If you need more help to set up the gem or just want to see an example of it
@@ -317,61 +324,37 @@ working, check out the test application at `spec/rails_app/`!
 
 ## Contributing/Development
 
-Fork this repository, clone your fork and start by installing the
-dependencies:
-
-    bundle install
-
-Note: if you're getting an error installing `capybara-webkit`, most likely you
-need to install QT, see:
-https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling
--capybara-webkit
-
-First copy `spec/rails_app/config/database.yml.example` to
+To setup an environment, first copy `spec/rails_app/config/database.yml.example` to
 `spec/rails_app/config/database.yml`. 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 `spec/rails_app/features/config.yml.example` as
-`spec/rails_app/features/config.yml` 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.
+recommended for the applications that use this gem.
 
-Prepare the `rails_app` used for tests:
+You can start the example application (from `spec/rails_app`) with:
 
-    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
+    docker-compose up dev
 
-Run the tests:
+It will probably not work straight away, because you need to setup the application first.
+Do so with:
 
-    rake spec
-    rake cucumber SERVER=my-server
+    docker-compose run dev rake rails_app:install
+    docker-compose run dev rake rails_app:db
 
-Or simply:
+    # optionally:
+    docker-compose run dev rake rails_app:populate # to create fake data
 
-    rake SERVER=my-server
-
-If you're adding migrations to the gem, test them with:
+Then try the `up dev` command again and it should open up a server. Access `localhost:3000`
+to see it.
 
-    rake spec:migrations
+To run the tests the process is exactly the same, just replace the `dev` target with `test`:
 
-Note: If you don't set the SERVER variable, the first server in `config.yml`
-will be used.
+    docker-compose up test
 
-You can also start the test application and navigate to `localhost:3000` to
-check it:
+If you're adding migrations to the gem, test them with:
 
-    cd spec/rails_app/
-    rails server
+    docker-compose run test rake spec:migrations
 
 If you need to keep track of meetings, run the resque workers with:
 
-    rake resque:work QUEUE='bigbluebutton_rails'
-
-Develop. :)
+    docker-compose run dev rake resque:work QUEUE='bigbluebutton_rails'
 
 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.
@@ -383,7 +366,7 @@ create a branch with your modifications and submit a pull request.
 
 Coverage is analyzed by default when you run:
 
-    rake spec
+    docker-compose up test
 
 Run it and look at the file `coverage/index.html`.
 
@@ -394,7 +377,7 @@ the code.
 
 Run:
 
-    rake best_practices
+    docker-compose run dev rake best_practices
 
 And look at the file `rails_best_practices_output.html` to see the tips.
 

data/Rakefile

@@ -39,8 +39,7 @@ namespace :rails_app do
   desc 'Setup the db in the rails app used in tests.'
   task :db do
     cd File.join(File.dirname(__FILE__), "spec", "rails_app")
-    sh "bundle exec rake db:drop db:create db:migrate db:seed RAILS_ENV=development"
-    sh "bundle exec rake db:drop db:create db:migrate db:seed RAILS_ENV=test"
+    sh "bundle exec rake db:drop db:create db:migrate db:seed"
     cd File.dirname(__FILE__)
   end
 
@@ -86,17 +85,21 @@ namespace :spec do
     sh "bundle exec rails generate bigbluebutton_rails:install 1.3.0 --migration-only --force"
     sh "bundle exec rails generate bigbluebutton_rails:install 1.4.0 --migration-only --force"
     sh "bundle exec rails generate bigbluebutton_rails:install 2.0.0 --migration-only --force"
+    sh "bundle exec rails generate bigbluebutton_rails:install 2.1.0 --migration-only --force"
+    sh "bundle exec rails generate bigbluebutton_rails:install 2.2.0 --migration-only --force"
 
     sh "bundle exec rake db:drop RAILS_ENV=test"
     sh "bundle exec rake db:create RAILS_ENV=test"
     sh "bundle exec rake db:migrate RAILS_ENV=test"
-    sh "bundle exec rake db:test:prepare RAILS_ENV=test"
+    sh "bundle exec rake db:seed RAILS_ENV=test"
 
     cd "../.."
     Rake::Task["spec"].invoke
     # Rake::Task["cucumber"].invoke
 
     cd "spec/rails_app/"
+    sh "bundle exec rails destroy bigbluebutton_rails:install 2.2.0 --migration-only"
+    sh "bundle exec rails destroy bigbluebutton_rails:install 2.1.0 --migration-only"
     sh "bundle exec rails destroy bigbluebutton_rails:install 2.0.0 --migration-only"
     sh "bundle exec rails destroy bigbluebutton_rails:install 1.4.0 --migration-only"
     sh "bundle exec rails destroy bigbluebutton_rails:install 1.3.0 --migration-only"

data/app/controllers/bigbluebutton/api/rooms_controller.rb

@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+require 'bigbluebutton_api'
+
+class Bigbluebutton::Api::RoomsController < ApplicationController
+  include BigbluebuttonRails::APIControllerMethods
+
+  skip_before_filter :verify_authenticity_token
+  before_filter :authenticate_api
+
+  before_filter :validate_pagination, only: :index
+
+  before_filter :find_room, only: [:running, :join]
+
+  before_filter :join_user_params, only: :join
+
+  # only for the ones that trigger API calls
+  before_filter :set_request_headers, only: [:join, :running]
+  before_filter :set_content_type
+
+  respond_to :json
+
+  def index
+    query = BigbluebuttonRoom
+
+    # Search
+    search_terms = map_search(params[:filter])
+    query = query.search_by_terms(search_terms) unless search_terms.blank?
+
+    # Sort
+    sort_str = map_sort(params[:sort], 'name ASC', ['activity', 'name'])
+    if sort_str.match(/activity/) # if requested activity ignore the rest
+      activity_order = sort_str.match(/activity ASC/) ? 'DESC' : 'ASC' # yes, inverse logic!
+      query = query.order_by_activity(activity_order)
+    else
+      query = query.order(sort_str)
+    end
+
+    # Limits and pagination
+    limit, offset, page = map_pagination(params[:page], 10)
+    query = query.limit(limit).offset(offset)
+    @pagination_links = map_pagination_links(page)
+
+    @rooms = query
+    respond_with(@rooms)
+  end
+
+  def running
+    check_is_running
+  end
+
+  def join
+    error_room_not_running unless check_is_running
+
+    # map "meta[_-]" to "userdata-"
+    options = params.select{ |k,v| k.match(/^meta[-_]/) }
+    unless options.blank?
+      options = options.map{ |k,v| { k.gsub(/^meta[-_]/, 'userdata-') => v } }.reduce(:merge)
+    end
+
+    @url = @room.parameterized_join_url(@user_name, @user_role, nil, options)
+  end
+
+  protected
+
+  def find_room
+    @room ||= BigbluebuttonRoom.find_by(param: params[:id])
+    error_room_not_found if @room.nil?
+  end
+
+  def join_user_params
+    if BigbluebuttonRails.configuration.guest_support
+      guest_role = :guest
+    else
+      guest_role = :attendee
+    end
+
+    @user_name = params[:name]
+    return error_missing_params if @user_name.blank?
+
+    if @room.private
+      key = params[:key]
+      return error_missing_params if key.blank?
+      @user_role = @room.user_role(key)
+      return error_invalid_key if @user_role.blank?
+    else
+      @user_role = guest_role
+    end
+  end
+
+  def check_is_running
+    begin
+      @room.fetch_is_running?
+    rescue StandardError => e
+      @errors = [BigbluebuttonRails::APIError.new(e.to_s, 500)]
+      render 'bigbluebutton/api/error'
+    end
+    @room.is_running?
+  end
+
+  def set_content_type
+    self.content_type = 'application/vnd.api+json'
+  end
+
+  def set_request_headers
+    @room.request_headers["x-forwarded-for"] = request.remote_ip if @room.present?
+  end
+
+  def authenticate_api
+    authorization = request.headers["Authorization"]
+    secret = authorization.gsub(/^Bearer /, '') if authorization.present?
+    server_secret = BigbluebuttonRails.configuration.api_secret
+    if server_secret != '' &&
+       (server_secret.nil? || secret.blank? || secret != server_secret)
+      error_forbidden
+    end
+  end
+end