bigbluebutton-api-ruby 1.6.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 473e9baacfe50dd02c2de2799d1f9ef36d7fa086
-  data.tar.gz: f8a35a9a314631bb3386382322fa2d5bee8c3a17
+SHA256:
+  metadata.gz: d0441812c16477d28d431e085349d9b41dbb2487fa2714658d0f4257bfbfc696
+  data.tar.gz: d6ef204678952d1890225b2e66dd17e7aafb2a20733ffd2733b6a99c3a9383f1
 SHA512:
-  metadata.gz: af669d4c0ea78a687001e1b0d1449da3a820f76c846ca3535942f2c56c86c1854cc3cd2d4d2614408b3cd1a3c233f2ef42683bd9bc9c7345cbeefd80dc4fbc99
-  data.tar.gz: 283b0c7fd0d864f7b674372c3f85887fd6b4d67eab6e7ba686abb1b4c017740b94289b2f84e1e20fe35d82efe2396f9b9c19704a751dab7c7130b9e7ed662f1b
+  metadata.gz: 8a62b74b9922d8eae4ad5f28be54e5975c0bbc7e267a7da457f3c307ca3199a3bf82f6acc2361e419df9c7a3277882e66cf10ba9cd52f60f23f6a3a8a8e88faa
+  data.tar.gz: 8630d39007e82a5d3e0fd0ea623e51138a62726e1778170d03db1150220196906b7665d9caab3e4cf9b85eeebf11445ae7302670048ee8eee4fc7f7e2773235b

data/.gitignore

@@ -5,4 +5,5 @@ features/config.yml
 logs/bbb.log
 rdoc/
 logs/*
-.bundle/
+.bundle/
+.volumes/

data/.rspec

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

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.6.5

data/CHANGELOG.md

@@ -1,13 +1,44 @@
 # Change Log
 
-
-------------------------------------
-
-All tickets below use references to IDs in our old issue tracking system.
-To find them, search for their description or ID in the new issue tracker.
-
-------------------------------------
-
+## [1.9.0] - 2022-05-03
+* [#56] Add support for checksum using SHA256
+
+[#56]: https://github.com/mconf/bigbluebutton-api-ruby/pull/56
+[1.9.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.8.0...v1.9.0
+
+## [1.8.0] - 2021-12-06
+* [#43] Add keys to every `BigBlueButtonException`, to better identify them.
+* [#42] Change `BigBlueButtonException` to inherit from `StandardError` instead of `Exception`.
+* [#50] [BREAKING-CHANGE] Replace `debug` flag with a optional Logger. The application using the
+  gem can pass its own logger as argument for the `BigBlueButtonApi` initialization.
+  If none is passed, the gem will use its own default logger on `STDOUT` with `INFO` level.
+* [#40] Fix issue preventing documents from being preuploaded using the create call.
+* Fix parse of recordings with invalid times. It would break at `getRecordings` if one
+  of them had an empty `startTime` or `endTime`.
+* Add a Dockerfile and compose to help run tests.
+* Fix deprecated `TimeoutError` constant.
+* [#35] Make `get_recordings` accept multiple `state` params.
+* [#34] Update `rubyzip` gem to the newest version with no vulnerability, from 1.2.2 to 1.3.0
+* [#33] Upgrade dependencies:
+  - `childprocess` from 0.3.2 to 1.0.1
+  - `ffi` from 1.0.11 to 1.9.24
+  - `json` from 1.8.3 to 1.8.6
+  - `nokogiri` from 1.6.6.2 to 1.10.4
+  - `rack` from 1.4.1 to 1.6.11
+  - `rdoc` from 3.12 to 3.12.1
+  - `rubyzip` from 0.9.8 to 1.2.2
+
+## [1.7.0] - 2018-08-17
+
+* [#29] Add support to the API call `updateRecordings` introduced in BigBlueButton 1.1.
+* [#31] Fixed issue with length=nil breaking multiple recording formats.
+* Call `setConfigXML` via POST and change encoding method. Fixes issues with special
+  characters (such as `*`) in the config.xml.
+* Add method to return the URL to `/check`.
+
+## [1.6.0] - 2016-06-15
+
+* Rename BigBlueButtonApi#salt to #secret
 
 ## [1.5.0] - 2016-04-07
 
@@ -141,6 +172,21 @@ were different in cases when they were not.
     (instead of browser URL). This call currently does not work as
     documented.
 
+<!-- PRs -->
+[#50]: https://github.com/mconf/bigbluebutton-api-ruby/pull/50
+[#43]: https://github.com/mconf/bigbluebutton-api-ruby/pull/43
+[#42]: https://github.com/mconf/bigbluebutton-api-ruby/pull/42
+[#40]: https://github.com/mconf/bigbluebutton-api-ruby/pull/40
+[#35]: https://github.com/mconf/bigbluebutton-api-ruby/pull/35
+[#34]: https://github.com/mconf/bigbluebutton-api-ruby/pull/34
+[#33]: https://github.com/mconf/bigbluebutton-api-ruby/pull/33
+[#31]: https://github.com/mconf/bigbluebutton-api-ruby/pull/31
+[#29]: https://github.com/mconf/bigbluebutton-api-ruby/pull/29
+
+<!-- Versions -->
+[1.8.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.7.0...v1.8.0
+[1.7.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.6.0...v1.7.0
+[1.6.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.4.0...v1.5.0
 [1.4.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.2.0...v1.3.0

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:2.6.5
+
+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

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :developement do
   gem 'rake', '>= 0.9'
-  gem 'rdoc'
+  gem 'rdoc', '3.12.1'
 end
 
 group :development, :test do

data/Gemfile.lock

@@ -7,7 +7,13 @@ GIT
 PATH
   remote: .
   specs:
-    bigbluebutton-api-ruby (1.6.0)
+    bigbluebutton-api-ruby (1.9.0)
+      childprocess (>= 1.0.1)
+      ffi (>= 1.9.24)
+      json (>= 1.8.6)
+      nokogiri (>= 1.10.4)
+      rack (>= 1.6.11)
+      rubyzip (>= 1.3.0)
       xml-simple (~> 1.1)
 
 GEM
@@ -22,8 +28,8 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    childprocess (0.3.2)
-      ffi (~> 1.0.6)
+    childprocess (1.0.1)
+      rake (< 13.0)
     cucumber (1.1.9)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
@@ -35,24 +41,25 @@ GEM
       cucumber (>= 1.1.8)
       nokogiri (>= 1.5.0)
     diff-lcs (1.1.3)
-    ffi (1.0.11)
+    ffi (1.9.24)
     forgery (0.5.0)
     gherkin (2.9.3)
       json (>= 1.4.6)
-    json (1.8.3)
+    json (1.8.6)
     libwebsocket (0.1.3)
       addressable
     mime-types (1.18)
-    mini_portile (0.6.2)
+    mini_portile2 (2.4.0)
     multi_json (1.3.4)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    rack (1.4.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rack (1.6.11)
     rack-test (0.6.1)
       rack (>= 1.0)
     rake (0.9.2.2)
-    rdoc (3.12)
+    rdoc (3.12.1)
       json (~> 1.4)
+    rexml (3.2.5)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
       rspec-expectations (~> 2.10.0)
@@ -61,7 +68,7 @@ GEM
     rspec-expectations (2.10.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.10.0)
-    rubyzip (0.9.8)
+    rubyzip (1.3.0)
     selenium-webdriver (2.21.2)
       childprocess (>= 0.2.5)
       ffi (~> 1.0)
@@ -69,7 +76,8 @@ GEM
       multi_json (~> 1.0)
       rubyzip
     term-ansicolor (1.0.7)
-    xml-simple (1.1.5)
+    xml-simple (1.1.9)
+      rexml
     xpath (0.1.4)
       nokogiri (~> 1.3)
 
@@ -82,5 +90,8 @@ DEPENDENCIES
   cucumber-rails
   forgery
   rake (>= 0.9)
-  rdoc
+  rdoc (= 3.12.1)
   rspec (~> 2.10)
+
+BUNDLED WITH
+   1.17.3

data/Rakefile

@@ -5,7 +5,8 @@ require 'rspec/core/rake_task'
 require 'cucumber/rake/task'
 
 desc 'Default: run tests.'
-task :default => [:spec, :cucumber]
+# task :default => [:spec, :cucumber]
+task :default => :spec
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bigbluebutton-api-ruby.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name             = "bigbluebutton-api-ruby"
-  s.version          = "1.6.0"
+  s.version          = "1.9.0"
   s.licenses         = ["MIT"]
   s.extra_rdoc_files = ["README.md", "LICENSE", "LICENSE_003", "CHANGELOG.md"]
   s.summary          = "BigBlueButton integration for ruby"
@@ -14,5 +14,11 @@ Gem::Specification.new do |s|
   s.files            = `git ls-files`.split("\n")
   s.require_paths    = ["lib"]
 
-  s.add_runtime_dependency("xml-simple", "~> 1.1")
+  s.add_runtime_dependency('childprocess', '>= 1.0.1')
+  s.add_runtime_dependency('ffi', '>= 1.9.24')
+  s.add_runtime_dependency('json', '>= 1.8.6')
+  s.add_runtime_dependency('nokogiri', '>= 1.10.4')
+  s.add_runtime_dependency('rack', '>= 1.6.11')
+  s.add_runtime_dependency('rubyzip', '>= 1.3.0')
+  s.add_runtime_dependency('xml-simple', '~> 1.1')
 end

data/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '2'
+services:
+
+  test:
+    build: .
+    tty: true
+    volumes:
+      - $PWD:/usr/src/app
+      - .volumes/bundle/:/usr/local/bundle
+    command: bundle exec rake

data/features/config.yml.example

@@ -1,4 +1,4 @@
-debug: false
+logger: nil
 
 # maximum wait for a response to any API request (secs)
 timeout_req: 60

data/features/step_definitions/common_steps.rb

@@ -4,7 +4,7 @@ When /^the default BigBlueButton server$/ do
   @api = BigBlueButton::BigBlueButtonApi.new(@config_server['url'],
                                              @config_server['secret'],
                                              @config_server['version'].to_s,
-                                             @config['debug'])
+                                             @config['logger'])
   @api.timeout = @config['timeout_req']
 end
 

data/lib/bigbluebutton_api.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'cgi'
 require 'rexml/document'
 require 'digest/sha1'
+require 'digest/sha2'
 require 'rubygems'
 require 'bigbluebutton_hash_to_xml'
 require 'bigbluebutton_exception'
@@ -9,6 +10,7 @@ require 'bigbluebutton_formatter'
 require 'bigbluebutton_modules'
 require 'bigbluebutton_config_xml'
 require 'bigbluebutton_config_layout'
+require 'logger'
 
 module BigBlueButton
 
@@ -50,8 +52,8 @@ module BigBlueButton
     # API version e.g. 0.81
     attr_accessor :version
 
-    # Flag to turn on/off debug mode
-    attr_accessor :debug
+    # logger to log reponses and infos
+    attr_accessor :logger
 
     # Maximum wait time for HTTP requests (secs)
     attr_accessor :timeout
@@ -67,21 +69,29 @@ module BigBlueButton
     # url::       URL to a BigBlueButton server (e.g. http://demo.bigbluebutton.org/bigbluebutton/api)
     # secret::    Shared secret for this server
     # version::   API version e.g. 0.81
-    def initialize(url, secret, version=nil, debug=false)
+    # logger::    Logger object to log actions (so apps can use their own loggers)
+    # sha256::    Flag to use sha256 when hashing url contents for checksum
+    def initialize(url, secret, version=nil, logger=nil, sha256=false)
       @supported_versions = ['0.8', '0.81', '0.9', '1.0']
       @url = url
       @secret = secret
-      @debug = debug
       @timeout = 10         # default timeout for api requests
       @request_headers = {} # http headers sent in all requests
-
+      @logger = logger
+      @sha256 = sha256
+      # If logger is not informed, it defaults to STDOUT with INFO level
+      if logger.nil?
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
+      end
+      
       version = nil if version && version.strip.empty?
       @version = nearest_version(version || get_api_version)
       unless @supported_versions.include?(@version)
-        puts "BigBlueButtonAPI: detected unsupported version, using the closest one that is supported (#{@version})"
+        @logger.warn("BigBlueButtonAPI: detected unsupported version, using the closest one that is supported (#{@version})")
       end
 
-      puts "BigBlueButtonAPI: Using version #{@version}" if @debug
+      @logger.debug("BigBlueButtonAPI: Using version #{@version}")
     end
 
     # Creates a new meeting. Returns the hash with the response or throws BigBlueButtonException
@@ -226,7 +236,8 @@ module BigBlueButton
     #                         in this hash and they will be added to the API call.
     def join_meeting_url(meeting_id, user_name, password, options={})
       params = { :meetingID => meeting_id, :password => password, :fullName => user_name }.merge(options)
-      get_url(:join, params)
+      url, data = get_url(:join, params)
+      url
     end
 
     # Returns a hash object containing the information of a meeting.
@@ -460,6 +471,10 @@ module BigBlueButton
         options[:meetingID] = options[:meetingID].join(",") if options[:meetingID].instance_of?(Array)
       end
 
+      if options.has_key?(:state)
+        options[:state] = options[:state].join(",") if options[:state].instance_of?(Array)
+      end
+
       response = send_api_request(:getRecordings, options)
 
       formatter = BigBlueButtonFormatter.new(response)
@@ -468,6 +483,30 @@ module BigBlueButton
       response
     end
 
+    # Available since BBB v1.1
+    # Update metadata (or other attributes depending on the API implementation) for a given recordID (or set of record IDs).
+    # recordIDs (string, Array)::  ID or IDs of the target recordings.
+    #                              Any of the following values are accepted:
+    #                                "id1"
+    #                                "id1,id2,id3"
+    #                                ["id1"]
+    #                                ["id1", "id2", "id3"]
+    # meta (String)::         Pass one or more metadata values to be update (format is the same as in create call)
+    # options (Hash)::        Hash with additional parameters. This method doesn't accept additional
+    #                         parameters, but if you have a custom API with more parameters, you
+    #                         can simply pass them in this hash and they will be added to the API call.
+    #
+    # === Example responses
+    #
+    #   { :returncode => success, :updated => true }      
+    #
+    def update_recordings(recordIDs, meta=nil, options={})
+       recordIDs = recordIDs.join(",") if recordIDs.instance_of?(Array) # ["id1", "id2"] becomes "id1,id2"
+       params = { :recordID => recordIDs, :meta => meta }.merge(options)
+       send_api_request(:updateRecordings, params)
+    end
+
+
     # Publish and unpublish recordings for a given recordID (or set of record IDs).
     # recordIDs (string, Array)::  ID or IDs of the target recordings.
     #                              Any of the following values are accepted:
@@ -599,10 +638,15 @@ module BigBlueButton
       response[:returncode]
     end
 
+    def check_url
+      url, data = get_url(:check)
+      url
+    end
+
     # API's are equal if all the following attributes are equal.
     def ==(other)
       r = true
-      [:url, :supported_versions, :secret, :version, :debug].each do |param|
+      [:url, :supported_versions, :secret, :version, :logger].each do |param|
         r = r && self.send(param) == other.send(param)
       end
       r
@@ -623,11 +667,12 @@ module BigBlueButton
     # params (Hash)::    The parameters to be passed in the URL
     def get_url(method, params={})
       if method == :index
-        return @url
+        return @url, nil
+      elsif method == :check
+        baseurl = URI.join(@url, "/").to_s
+        return "#{baseurl}check", nil
       end
 
-      url = "#{@url}/#{method}?"
-
       # stringify and escape all params
       params.delete_if { |k, v| v.nil? } unless params.nil?
       # some API calls require the params to be sorted
@@ -635,16 +680,22 @@ module BigBlueButton
       params = params.inject({}){ |memo,(k,v)| memo[k.to_sym] = v; memo }
       params = Hash[params.sort]
       params_string = ""
-      params_string = params.map{ |k,v| "#{k}=" + CGI::escape(v.to_s) unless k.nil? || v.nil? }.join("&")
+      params_string = params.map{ |k,v| "#{k}=" + URI.encode_www_form_component(v.to_s) unless k.nil? || v.nil? }.join("&")
 
       # checksum calc
       checksum_param = params_string + @secret
       checksum_param = method.to_s + checksum_param
-      checksum = Digest::SHA1.hexdigest(checksum_param)
+      checksum = @sha256 ? Digest::SHA256.hexdigest(checksum_param) : Digest::SHA1.hexdigest(checksum_param)
 
-      # final url
-      url += "#{params_string}&" unless params_string.empty?
-      url += "checksum=#{checksum}"
+      if method == :setConfigXML
+        params_string = "checksum=#{checksum}&#{params_string}"
+        return "#{@url}/#{method}", params_string
+      else
+        url = "#{@url}/#{method}?"
+        url += "#{params_string}&" unless params_string.empty?
+        url += "checksum=#{checksum}"
+        return url, nil
+      end
     end
 
     # Performs an API call.
@@ -661,7 +712,9 @@ module BigBlueButton
     # raw (boolean)::    If true, returns the data as it was received. Will not parse it into a Hash,
     #                    check for errors or throw exceptions.
     def send_api_request(method, params={}, data=nil, raw=false)
-      url = get_url(method, params)
+      # if the method returns a body, use it as the data in the post request
+      url, body = get_url(method, params)
+      data = body if body
 
       @http_response = send_request(url, data)
       return {} if @http_response.body.empty?
@@ -700,7 +753,7 @@ module BigBlueButton
     # Otherwise uses GET
     def send_request(url, data=nil)
       begin
-        puts "BigBlueButtonAPI: URL request = #{url}" if @debug
+        @logger.debug("BigBlueButtonAPI: URL request = #{url}")
         url_parsed = URI.parse(url)
         http = Net::HTTP.new(url_parsed.host, url_parsed.port)
         http.open_timeout = @timeout
@@ -710,17 +763,22 @@ module BigBlueButton
         if data.nil?
           response = http.get(url_parsed.request_uri, @request_headers)
         else
-          puts "BigBlueButtonAPI: Sending as a POST request with data.size = #{data.size}" if @debug
-          opts = { 'Content-Type' => 'text/xml' }.merge @request_headers
+          @logger.debug("BigBlueButtonAPI: Sending as a POST request with data.size = #{data.size}")
+          opts = { 'Content-Type' => 'application/xml' }.merge @request_headers
           response = http.post(url_parsed.request_uri, data, opts)
         end
-        puts "BigBlueButtonAPI: URL response = #{response.body}" if @debug
+        @logger.info("BigBlueButtonAPI: request=#{url} response_status=#{response.class.name} response_code=#{response.code}  message_key=#{response.message}")
+        @logger.debug("BigBlueButtonAPI: URL response = #{response.body}")
 
-      rescue TimeoutError => error
-        raise BigBlueButtonException.new("Timeout error. Your server is probably down: \"#{@url}\". Error: #{error}")
+      rescue Timeout::Error => error
+        exception = BigBlueButtonException.new("Timeout error. Your server is probably down: \"#{@url}\". Error: #{error}")
+        exception.key = 'TimeoutError'
+        raise exception
 
       rescue Exception => error
-        raise BigBlueButtonException.new("Connection error. Your URL is probably incorrect: \"#{@url}\". Error: #{error}")
+        exception = BigBlueButtonException.new("Connection error. Your URL is probably incorrect: \"#{@url}\". Error: #{error}")
+        exception.key = 'IncorrectUrlError'
+        raise exception
       end
 
       response
@@ -736,7 +794,9 @@ module BigBlueButton
 
       # we don't allow older versions than the one supported, use an old version of the gem for that
       if Gem::Version.new(version) < Gem::Version.new(@supported_versions[0])
-        raise BigBlueButtonException.new("BigBlueButton error: Invalid API version #{version}. Supported versions: #{@supported_versions.join(', ')}")
+        exception = BigBlueButtonException.new("BigBlueButton error: Invalid API version #{version}. Supported versions: #{@supported_versions.join(', ')}")
+        exception.key = 'APIVersionError'
+        raise exception
 
       # allow newer versions by using the newest one we support
       elsif Gem::Version.new(version) > Gem::Version.new(@supported_versions.last)

data/lib/bigbluebutton_config_layout.rb

@@ -29,7 +29,9 @@ module BigBlueButton
       begin
         @xml = XmlSimple.xml_in(xml, opts)
       rescue Exception => e
-        raise BigBlueButton::BigBlueButtonException.new("Error parsing the layouts XML. Error: #{e.message}")
+        exception = BigBlueButton::BigBlueButtonException.new("Error parsing the layouts XML. Error: #{e.message}")
+        exception.key = 'XMLParsingError'
+        raise exception
       end
     end
 

data/lib/bigbluebutton_config_xml.rb

@@ -33,7 +33,9 @@ module BigBlueButton
           @xml = XmlSimple.xml_in(xml, opts)
           @original_string = self.as_string.clone
         rescue Exception => e
-          raise BigBlueButton::BigBlueButtonException.new("Error parsing the config XML. Error: #{e.message}")
+          exception = BigBlueButton::BigBlueButtonException.new("Error parsing the config XML. Error: #{e.message}")
+          exception.key = 'XMLParsingError'
+          raise exception
         end
       end
     end

data/lib/bigbluebutton_exception.rb

@@ -1,6 +1,6 @@
 module BigBlueButton
 
-  class BigBlueButtonException < Exception
+  class BigBlueButtonException < StandardError
     attr_accessor :key
 
     def to_s

data/lib/bigbluebutton_formatter.rb

@@ -22,7 +22,7 @@ module BigBlueButton
       unless @hash.has_key?(key)
         0
       else
-        @hash[key] = @hash[key].to_i
+        @hash[key] = @hash[key].to_i rescue 0
       end
     end
 
@@ -49,7 +49,9 @@ module BigBlueButton
         if value.is_a?(Numeric)
           result = value == 0 ? nil : DateTime.parse(Time.at(value/1000.0).to_s)
         else
-          if value.downcase == "null"
+          if (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
+            result = nil
+          elsif value.is_a?(String) && (value.empty? || value.downcase == 'null')
             result = nil
           else
             # note: just in case the value comes as a string in the format: "Thu Sep 01 17:51:42 UTC 2011"

data/lib/bigbluebutton_hash_to_xml.rb

@@ -10,7 +10,9 @@ module BigBlueButton
           hash = XmlSimple.xml_in(xml_io, opts)
           return symbolize_keys(hash)
         rescue Exception => e
-          raise BigBlueButtonException.new("Impossible to convert XML to hash. Error: #{e.message}")
+          exception = BigBlueButtonException.new("Impossible to convert XML to hash. Error: #{e.message}")
+          exception.key = 'XMLConversionError'  
+          raise exception
         end
       end
 

data/spec/bigbluebutton_api_0.81_spec.rb

@@ -7,8 +7,7 @@ describe BigBlueButton::BigBlueButtonApi do
   let(:url) { "http://server.com" }
   let(:secret) { "1234567890abcdefghijkl" }
   let(:version) { "0.81" }
-  let(:debug) { false }
-  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version) }
 
   describe "#get_default_config_xml" do
     let(:response) { "<response><returncode>1</returncode></response>" }

data/spec/bigbluebutton_api_0.9_spec.rb

@@ -7,8 +7,7 @@ describe BigBlueButton::BigBlueButtonApi do
   let(:url) { "http://server.com" }
   let(:secret) { "1234567890abcdefghijkl" }
   let(:version) { "0.9" }
-  let(:debug) { false }
-  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version) }
 
   describe "#create_meeting" do
     context "accepts the new parameters" do

data/spec/bigbluebutton_api_spec.rb

@@ -9,16 +9,17 @@ describe BigBlueButton::BigBlueButtonApi do
     # default variables and API object for all tests
     let(:url) { "http://server.com" }
     let(:secret) { "1234567890abcdefghijkl" }
-    let(:debug) { false }
-    let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+    let(:logger) { Logger.new(STDOUT) }
+    let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger) }
+    before { logger.level = Logger::INFO }
 
     describe "#initialize" do
       context "standard initialization" do
-        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger) }
         it { subject.url.should == url }
         it { subject.secret.should == secret }
         it { subject.version.should == version }
-        it { subject.debug.should == debug }
+        it { subject.logger.should == logger }
         it { subject.timeout.should == 10 }
         it { subject.supported_versions.should include("0.8") }
         it { subject.supported_versions.should include("0.81") }
@@ -226,7 +227,7 @@ describe BigBlueButton::BigBlueButtonApi do
             :userID => "id123", :webVoiceConf => 12345678, :createTime => 9876543 }
         }
 
-        before { api.should_receive(:get_url).with(:join, params).and_return("test-url") }
+        before { api.should_receive(:get_url).with(:join, params).and_return(["test-url", nil]) }
         it {
           options = { :userID => "id123", :webVoiceConf => 12345678, :createTime => 9876543 }
           api.join_meeting_url("meeting-id", "Name", "pw", options).should == "test-url"
@@ -340,15 +341,24 @@ describe BigBlueButton::BigBlueButtonApi do
       end
     end
 
+    describe "#check_url" do
+      context "when method = :check" do
+        it {
+          api.url = 'http://my-test-server.com/bigbluebutton/api'
+          api.check_url.should == 'http://my-test-server.com/check'
+        }
+      end
+    end
+
     describe "#==" do
-      let(:api2) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+      let(:api2) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger) }
 
       context "compares attributes" do
         it { api.should == api2 }
       end
 
-      context "differs #debug" do
-        before { api2.debug = !api.debug }
+      context "differs #logger" do
+        before { api2.logger = !api.logger }
         it { api.should_not == api2 }
       end
 
@@ -400,14 +410,21 @@ describe BigBlueButton::BigBlueButtonApi do
     describe "#get_url" do
 
       context "when method = :index" do
-        it { api.get_url(:index).should == api.url }
+        it { api.get_url(:index).should == [api.url, nil] }
+      end
+
+      context "when method = :check" do
+        it {
+          api.url = 'http://my-test-server.com/bigbluebutton/api'
+          api.get_url(:check).should == ['http://my-test-server.com/check', nil]
+        }
       end
 
       context "when method != :index" do
         context "validates the entire url" do
           context "with params" do
             let(:params) { { :param1 => "value1", :param2 => "value2" } }
-            subject { api.get_url(:join, params) }
+            subject { api.get_url(:join, params)[0] }
             it {
               # the hash can be sorted differently depending on the ruby version
               if params.map{ |k,v| "#{k}" }.join =~ /^param1/
@@ -419,36 +436,72 @@ describe BigBlueButton::BigBlueButtonApi do
           end
 
           context "without params" do
-            subject { api.get_url(:join) }
+            subject { api.get_url(:join)[0] }
             it { subject.should match(/#{url}\/join\?[^&]/) }
           end
         end
 
+        context "when method = :setConfigXML" do
+          it {
+            api.url = 'http://my-test-server.com/bigbluebutton/api'
+            response = api.get_url(:setConfigXML, { param1: 1, param2: 2 })
+            response[0].should eql('http://my-test-server.com/bigbluebutton/api/setConfigXML')
+            response[1].should match(/checksum=.*&param1=1&param2=2/)
+          }
+        end
+
         context "discards params with nil value" do
           let(:params) { { :param1 => "value1", :param2 => nil } }
-          subject { api.get_url(:join, params) }
+          subject { api.get_url(:join, params)[0] }
           it { subject.should_not match(/param2=/) }
         end
 
         context "escapes all params" do
           let(:params) { { :param1 => "value with spaces", :param2 => "@$" } }
-          subject { api.get_url(:join, params) }
+          subject { api.get_url(:join, params)[0] }
           it { subject.should match(/param1=value\+with\+spaces/) }
           it { subject.should match(/param2=%40%24/) }
         end
 
+        [ [' ', '+'],
+          ['*', '*']
+        ].each do |values|
+          context "escapes #{values[0].inspect} as #{values[1].inspect}" do
+            let(:params) { { param1: "before#{values[0]}after" } }
+            subject { api.get_url(:join, params)[0] }
+            it { subject.should match(/param1=before#{Regexp.quote(values[1])}after/) }
+          end
+        end
+
         context "includes the checksum" do
-          let(:params) { { :param1 => "value1", :param2 => "value2" } }
-          let(:checksum) {
-            # the hash can be sorted differently depending on the ruby version
-            if params.map{ |k,v| "#{k}" }.join =~ /^param1/
-              "67882ae54f49600f56f358c10d24697ef7d8c6b2"
-            else
-              "85a54e28e4ec18bfdcb214a73f74d35b09a84176"
-            end
-          }
-          subject { api.get_url(:join, params) }
-          it { subject.should match(/checksum=#{checksum}$/) }
+          context "when @sha256 is false or nil" do
+            let(:params) { { param1: "value1", param2: "value2" } }
+            let(:checksum) {
+              # the hash can be sorted differently depending on the ruby version
+              if params.map{ |k, v| k }.join =~ /^param1/
+                "67882ae54f49600f56f358c10d24697ef7d8c6b2"
+              else
+                "85a54e28e4ec18bfdcb214a73f74d35b09a84176"
+              end
+            }
+            subject { api.get_url(:join, params)[0] }
+            it('uses SHA1') { subject.should match(/checksum=#{checksum}$/) }
+          end
+
+          context "when @sha256 flag is true" do
+            let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger, true) }
+            let(:params) { { param1: "value1", param2: "value2" } }
+            let(:checksum) {
+              # the hash can be sorted differently depending on the ruby version
+              if params.map{ |k,v| k }.join =~ /^param1/
+                "0e7b1611809fad890a114dddae1a37fecf14c28971afc10ee3eac432da5b8b41"
+              else
+                "21bf2d24c27251c4b2b2f0d5dd4b966a2f16fbfc7882e102b44c6d67f728f0c8"
+              end
+            }
+            subject { api.get_url(:join, params)[0] }
+            it('uses SHA256') { subject.should match(/checksum=#{checksum}$/) }
+          end
         end
       end
     end
@@ -461,7 +514,7 @@ describe BigBlueButton::BigBlueButtonApi do
       let(:make_request) { api.send_api_request(method, params, data) }
       let(:response_mock) { mock() } # mock of what send_request() would return
 
-      before { api.should_receive(:get_url).with(method, params).and_return(url) }
+      before { api.should_receive(:get_url).with(method, params).and_return([url, nil]) }
 
       context "returns an empty hash if the response body is empty" do
         before do
@@ -524,17 +577,19 @@ describe BigBlueButton::BigBlueButtonApi do
     describe "#send_request" do
       let(:url) { "http://test-server:8080/res?param1=value1&checksum=12345" }
       let(:url_parsed) { URI.parse(url) }
+      let(:res) { Net::HTTPResponse.new(1.0, '200', 'OK') }
 
       before do
         @http_mock = mock(Net::HTTP)
         @http_mock.should_receive(:"open_timeout=").with(api.timeout)
         @http_mock.should_receive(:"read_timeout=").with(api.timeout)
         Net::HTTP.should_receive(:new).with("test-server", 8080).and_return(@http_mock)
+        res.stub(:body) { "ok" }
       end
 
       context "standard case" do
-        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", {}).and_return("ok") }
-        it { api.send(:send_request, url).should == "ok" }
+        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", {}).and_return(res) }
+        it { api.send(:send_request, url).should == res }
       end
 
       context "handles a TimeoutError" do
@@ -551,20 +606,20 @@ describe BigBlueButton::BigBlueButtonApi do
         let(:data) { "any data" }
         before {
           path = "/res?param1=value1&checksum=12345"
-          opts = { 'Content-Type' => 'text/xml' }
-          @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
+          opts = { 'Content-Type' => 'application/xml' }
+          @http_mock.should_receive(:post).with(path, data, opts).and_return(res)
         }
         it {
-          api.send(:send_request, url, data).should == "ok"
+          api.send(:send_request, url, data).should == res
         }
       end
 
       context "get with headers" do
         let(:headers_hash) { { :anything => "anything" } }
-        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", headers_hash).and_return("ok") }
+        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", headers_hash).and_return(res) }
         it {
           api.request_headers = headers_hash
-          api.send(:send_request, url).should == "ok"
+          api.send(:send_request, url).should == res
         }
       end
 
@@ -573,12 +628,12 @@ describe BigBlueButton::BigBlueButtonApi do
         let(:data) { "any data" }
         before {
           path = "/res?param1=value1&checksum=12345"
-          opts = { 'Content-Type' => 'text/xml', :anything => "anything" }
-          @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
+          opts = { 'Content-Type' => 'application/xml', :anything => "anything" }
+          @http_mock.should_receive(:post).with(path, data, opts).and_return(res)
         }
         it {
           api.request_headers = headers_hash
-          api.send(:send_request, url, data).should == "ok"
+          api.send(:send_request, url, data).should == res
         }
       end
     end
@@ -755,4 +810,5 @@ describe BigBlueButton::BigBlueButtonApi do
   it_should_behave_like "BigBlueButtonApi", "0.8"
   it_should_behave_like "BigBlueButtonApi", "0.81"
   it_should_behave_like "BigBlueButtonApi", "0.9"
+  it_should_behave_like "BigBlueButtonApi", "1.0"
 end

data/spec/bigbluebutton_formatter_spec.rb

@@ -100,14 +100,43 @@ describe BigBlueButton::BigBlueButtonFormatter do
     it { hash[:param7].should == nil }
     it { hash[:param8].should == nil }
 
-    context "returns nil if the param doesn't exists" do
-      subject { BigBlueButton::BigBlueButtonFormatter.new({ :param => 1}) }
-      it { subject.to_datetime(:inexistent).should == nil }
-    end
+    context "returns nil if" do
+      context "the param doesn't exists" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ :param => 1}) }
+        it { subject.to_datetime(:inexistent).should == nil }
+      end
 
-    context "returns nil if the hash is nil" do
-      subject { BigBlueButton::BigBlueButtonFormatter.new(nil) }
-      it { subject.to_datetime(:inexistent).should == nil }
+      context "the hash is nil" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new(nil) }
+        it { subject.to_datetime(:inexistent).should == nil }
+      end
+
+      context "the value is an empty string" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: '' }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      context "the value is nil" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: nil }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      context "the value is an empty hash" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: {} }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      context "the value is an empty array" do
+        subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: [] }) }
+        it { subject.to_datetime(:param1).should == nil }
+      end
+
+      ['null', 'NULL'].each do |v|
+        context "the value is '#{v}'" do
+          subject { BigBlueButton::BigBlueButtonFormatter.new({ param1: v }) }
+          it { subject.to_datetime(:param1).should == nil }
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Mconf
@@ -9,8 +9,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.11
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +127,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -50,6 +135,7 @@ files:
 - README.md
 - Rakefile
 - bigbluebutton-api-ruby.gemspec
+- docker-compose.yml
 - examples/config_xml.rb
 - examples/create.rb
 - examples/get_version_example.rb
@@ -113,8 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: BigBlueButton integration for ruby