bigbluebutton-api-ruby 1.9.0 → 2.0.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0441812c16477d28d431e085349d9b41dbb2487fa2714658d0f4257bfbfc696
-  data.tar.gz: d6ef204678952d1890225b2e66dd17e7aafb2a20733ffd2733b6a99c3a9383f1
+  metadata.gz: 73e3f2e22efb6a7e8f2be83e23828e02bef1d0decdd8f72816919394246bf258
+  data.tar.gz: 0767cb9303dc6b4366000deb1b99dea54e7fefee9cf2bb721a7a6970208be38d
 SHA512:
-  metadata.gz: 8a62b74b9922d8eae4ad5f28be54e5975c0bbc7e267a7da457f3c307ca3199a3bf82f6acc2361e419df9c7a3277882e66cf10ba9cd52f60f23f6a3a8a8e88faa
-  data.tar.gz: 8630d39007e82a5d3e0fd0ea623e51138a62726e1778170d03db1150220196906b7665d9caab3e4cf9b85eeebf11445ae7302670048ee8eee4fc7f7e2773235b
+  metadata.gz: a0bf29d614bc58bff39c12bd8ebc747ff1b47e231154ebe9654a59b22dc33539271dbeffee6f8e2e413367fb3fecc3b548975b74f82f072687b69349ad04f67d
+  data.tar.gz: da0034f9d53e5984b596073b0f3827a6a2e8d88978c900be982ab5333bfec1c010f8cb97fb853864cb5ddb73d0265918749ed381d4ec9c50975ef64b229ae7b3

data/.github/workflows/publish-gem-on-tag-push.yml

@@ -0,0 +1,20 @@
+name: Publish gem on tag push
+on:
+  push:
+    tags:
+      - 'v*' 
+      - '!v**-mconf*'
+# Tags that will trigger: v1.9.0; v1.9.0-beta1
+# Tags excluded (with the '!'): v1.9.0-mconf; v1.9.0-mconf-beta1
+
+jobs:
+  publish-gem:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Publish
+        uses: dawidd6/action-publish-gem@v1.2.0
+        with:
+          # Optional, will publish to RubyGems if specified
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.4.5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [1.9.1] - 2023-03-31
+* [#60] Prevent problems with double slashes on API calls [thanks to [@farhatahmad](https://github.com/farhatahmad)]
+
+[#60]: https://github.com/mconf/bigbluebutton-api-ruby/pull/60
+[1.9.1]: https://github.com/mconf/bigbluebutton-api-ruby/compare/v1.9.0...v1.9.1
+
 ## [1.9.0] - 2022-05-03
 * [#56] Add support for checksum using SHA256
 

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM ruby:2.6.5
+FROM ruby:3.4.5
 
-ENV app /usr/src/app
+ENV app=/usr/src/app
 
 # Create app directory
 RUN mkdir -p $app
@@ -9,5 +9,9 @@ WORKDIR $app
 # Bundle app source
 COPY . $app
 
+# Set the app directory as safe in Git, to avoid 'detected dubious ownership in repository' errors
+RUN git config --global --add safe.directory ${app}
+
 # Install app dependencies
+RUN gem install bundler -v 2.6.9
 RUN bundle install

data/Gemfile

@@ -1,16 +1,11 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gemspec
+ruby file: '.ruby-version'
 
-group :developement do
-  gem 'rake', '>= 0.9'
-  gem 'rdoc', '3.12.1'
-end
+gemspec
 
 group :development, :test do
-  gem 'rspec', '~> 2.10'
-  gem 'cucumber-rails'
+  gem 'rspec'
   gem 'forgery'
-  gem 'bbbot-ruby', :git => 'https://github.com/mconf/bbbot-ruby.git'
-  # gem 'rails_best_practices'
+  gem 'rake'
 end

data/Gemfile.lock

@@ -1,97 +1,45 @@
-GIT
-  remote: https://github.com/mconf/bbbot-ruby.git
-  revision: fcfd8c4c71371653335a46d7462ee14a9301f546
-  specs:
-    bbbot-ruby (0.0.1)
-
 PATH
   remote: .
   specs:
-    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)
+    bigbluebutton-api-ruby (2.0.0.pre.rc.1)
+      base64 (>= 0.1.0)
       xml-simple (~> 1.1)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.2.8)
-    builder (3.0.0)
-    capybara (1.1.2)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (1.0.1)
-      rake (< 13.0)
-    cucumber (1.1.9)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (~> 2.9.0)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.6)
-    cucumber-rails (1.3.0)
-      capybara (>= 1.1.2)
-      cucumber (>= 1.1.8)
-      nokogiri (>= 1.5.0)
-    diff-lcs (1.1.3)
-    ffi (1.9.24)
+    base64 (0.3.0)
+    diff-lcs (1.6.2)
     forgery (0.5.0)
-    gherkin (2.9.3)
-      json (>= 1.4.6)
-    json (1.8.6)
-    libwebsocket (0.1.3)
-      addressable
-    mime-types (1.18)
-    mini_portile2 (2.4.0)
-    multi_json (1.3.4)
-    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.1)
-      json (~> 1.4)
-    rexml (3.2.5)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.0)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.0)
-    rubyzip (1.3.0)
-    selenium-webdriver (2.21.2)
-      childprocess (>= 0.2.5)
-      ffi (~> 1.0)
-      libwebsocket (~> 0.1.3)
-      multi_json (~> 1.0)
-      rubyzip
-    term-ansicolor (1.0.7)
+    rake (12.3.3)
+    rexml (3.4.2)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.5)
     xml-simple (1.1.9)
       rexml
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bbbot-ruby!
   bigbluebutton-api-ruby!
-  cucumber-rails
   forgery
-  rake (>= 0.9)
-  rdoc (= 3.12.1)
-  rspec (~> 2.10)
+  rake
+  rspec
+
+RUBY VERSION
+   ruby 3.4.5p51
 
 BUNDLED WITH
-   1.17.3
+   2.6.9

data/Rakefile

@@ -2,34 +2,12 @@ require 'rubygems'
 require 'rdoc/task'
 require 'rubygems/package_task'
 require 'rspec/core/rake_task'
-require 'cucumber/rake/task'
 
 desc 'Default: run tests.'
-# task :default => [:spec, :cucumber]
 task :default => :spec
 
 RSpec::Core::RakeTask.new(:spec)
 
-Cucumber::Rake::Task.new do |t|
-
-  # Disable all features that need the bot. It isn't working since BigBlueButton 0.81.
-  prepend = "--tags ~@need-bot"
-
-  # in jruby the class BigBlueButtonBot doesn't work (it uses fork)
-  if defined?(RUBY_ENGINE) and RUBY_ENGINE == 'jruby'
-    puts "Jruby detected, ignoring features with @need-bot"
-    prepend = "--tags ~@need-bot"
-  end
-
-  # defaults to the latest version, that runs all tests
-  # if set to 0.8 only, won't run tests for newer versions
-  if ENV["V"] == "0.8" or ENV["VERSION"] == "0.8"
-    t.cucumber_opts = "--format pretty --tags ~@wip --tags @version-all #{prepend}"
-  else
-    t.cucumber_opts = "--format pretty --tags ~@wip --tags @version-all,@version-081 #{prepend}"
-  end
-end
-
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include('README.md', 'LICENSE', 'LICENSE_003', 'CHANGELOG.md', 'lib/**/*.rb')
   rdoc.main = "README.md"

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.9.0"
+  s.version          = "2.0.0-rc.1"
   s.licenses         = ["MIT"]
   s.extra_rdoc_files = ["README.md", "LICENSE", "LICENSE_003", "CHANGELOG.md"]
   s.summary          = "BigBlueButton integration for ruby"
@@ -13,12 +13,8 @@ Gem::Specification.new do |s|
   s.bindir           = "bin"
   s.files            = `git ls-files`.split("\n")
   s.require_paths    = ["lib"]
+  s.required_ruby_version = '>= 3.2.0'
 
-  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')
+  s.add_runtime_dependency('base64', '>= 0.1.0')
 end

data/features/step_definitions/check_status_steps.rb

@@ -1,11 +1,11 @@
 When /^the method isMeetingRunning informs that the meeting is running$/ do
   @req.response = @api.is_meeting_running?(@req.id)
-  @req.response.should be_true
+  @req.response.should be true
 end
 
 When /^the method isMeetingRunning informs that the meeting is not running$/i do
   @req.response = @api.is_meeting_running?(@req.id)
-  @req.response.should be_false
+  @req.response.should be false
 end
 
 When /^calling the method get_meetings$/ do
@@ -29,8 +29,8 @@ When /^the created meeting should be listed in the response with proper informat
   found[:attendeePW].should be_a(String)
   found[:attendeePW].should_not be_empty
   found[:moderatorPW].should == @req.mod_pass
-  found[:hasBeenForciblyEnded].should be_false
-  found[:running].should be_false
+  found[:hasBeenForciblyEnded].should be false
+  found[:running].should be false
   if @api.version >= "0.8"
     found[:meetingName].should == @req.id
     found[:createTime].should be_a(Numeric)
@@ -40,8 +40,8 @@ end
 When /^it shows all the information of the meeting that was created$/ do
   @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
   @req.response[:meetingID].should == @req.id
-  @req.response[:running].should be_false
-  @req.response[:hasBeenForciblyEnded].should be_false
+  @req.response[:running].should be false
+  @req.response[:hasBeenForciblyEnded].should be false
   @req.response[:startTime].should be_nil
   @req.response[:endTime].should be_nil
   @req.response[:participantCount].should == 0
@@ -70,7 +70,7 @@ When /^it shows all the information of the meeting that was created$/ do
 
     @req.opts.has_key?(:record) ?
       (@req.response[:recording].should == @req.opts[:record]) :
-      (@req.response[:recording].should be_false)
+      (@req.response[:recording].should be false)
     @req.opts.has_key?(:maxParticipants) ?
       (@req.response[:maxUsers].should == @req.opts[:maxParticipants]) :
       (@req.response[:maxUsers].should == 20)
@@ -98,9 +98,9 @@ Then /^it shows the (\d+) attendees in the list$/ do |count|
   @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
   participants = count.to_i
 
-  @req.response[:running].should be_true
+  @req.response[:running].should be true
   @req.response[:moderatorCount].should > 0
-  @req.response[:hasBeenForciblyEnded].should be_false
+  @req.response[:hasBeenForciblyEnded].should be false
   @req.response[:participantCount].should == participants
   @req.response[:attendees].size.should == 2
 

data/features/step_definitions/common_steps.rb

@@ -57,11 +57,11 @@ When /^the response is an error with the key "(.*)"$/ do |key|
 end
 
 When /^the response is successful$/ do
-  @req.response[:returncode].should be_true
+  @req.response[:returncode].should be true
 end
 
 When /^the response is successful with no messages$/ do
-  @req.response[:returncode].should be_true
+  @req.response[:returncode].should be true
   @req.response[:messageKey].should == ""
   @req.response[:message].should == ""
 end
@@ -83,9 +83,9 @@ When /^the response is successful and well formatted$/ do
 end
 
 When /^the response to the create method is successful and well formatted$/ do
-  @req.response[:returncode].should be_true
+  @req.response[:returncode].should be true
   @req.response[:meetingID].should == @req.id
-  @req.response[:hasBeenForciblyEnded].should be_false
+  @req.response[:hasBeenForciblyEnded].should be false
   @req.response[:messageKey].should == ""
   @req.response[:message].should == ""
 
@@ -111,12 +111,12 @@ When /^the response to the create method is successful and well formatted$/ do
 end
 
 When /^the response to the end method is successful and well formatted$/ do
-  @req.response[:returncode].should be_true
+  @req.response[:returncode].should be true
   @req.response[:messageKey].should == "sentEndMeetingRequest"
   @req.response[:message].should_not be_empty
 end
 
 When /^the response to the get_recordings method is successful and well formatted$/ do
-  @req.response[:returncode].should be_true
+  @req.response[:returncode].should be true
   @req.response[:recordings].should == []
 end

data/features/step_definitions/end_meetings_steps.rb

@@ -24,7 +24,7 @@ When /^the meeting should be ended$/ do
 end
 
 When /^the flag hasBeenForciblyEnded should be set$/ do
-  @req.response[:hasBeenForciblyEnded].should be_true
+  @req.response[:hasBeenForciblyEnded].should be true
 end
 
 When /^the information returned by get_meeting_info is correct$/ do
@@ -32,8 +32,8 @@ When /^the information returned by get_meeting_info is correct$/ do
   # the rest is checked in other scenarios
 
   @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
-  @req.response[:running].should be_false
-  @req.response[:hasBeenForciblyEnded].should be_true
+  @req.response[:running].should be false
+  @req.response[:hasBeenForciblyEnded].should be true
   @req.response[:participantCount].should == 0
   @req.response[:moderatorCount].should == 0
   @req.response[:attendees].should == []

data/features/step_definitions/recordings_steps.rb

@@ -11,8 +11,8 @@ end
 
 When /^the meeting is set to be recorded$/ do
   @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
-  @req.response[:returncode].should be_true
-  @req.response[:recording].should be_true
+  @req.response[:returncode].should be true
+  @req.response[:recording].should be true
 end
 
 When /^the user creates a meeting without the record flag$/ do
@@ -28,8 +28,8 @@ end
 
 When /^the meeting is not set to be recorded$/i do
   @req.response = @api.get_meeting_info(@req.id, @req.mod_pass)
-  @req.response[:returncode].should be_true
-  @req.response[:recording].should be_false
+  @req.response[:returncode].should be true
+  @req.response[:recording].should be false
 end
 
 When /^the user calls the get_recordings method$/ do

data/lib/bigbluebutton_api.rb

@@ -1,5 +1,4 @@
 require 'net/http'
-require 'cgi'
 require 'rexml/document'
 require 'digest/sha1'
 require 'digest/sha2'
@@ -8,8 +7,6 @@ require 'bigbluebutton_hash_to_xml'
 require 'bigbluebutton_exception'
 require 'bigbluebutton_formatter'
 require 'bigbluebutton_modules'
-require 'bigbluebutton_config_xml'
-require 'bigbluebutton_config_layout'
 require 'logger'
 
 module BigBlueButton
@@ -73,7 +70,7 @@ module BigBlueButton
     # 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
+      @url = url.chomp('/')
       @secret = secret
       @timeout = 10         # default timeout for api requests
       @request_headers = {} # http headers sent in all requests
@@ -550,88 +547,10 @@ module BigBlueButton
       send_api_request(:deleteRecordings, params)
     end
 
-
-    #
-    # API calls since 0.81
-    #
-
-    # Retrieves the default config.xml file from the server.
-    # Returns the XML as a string by default, but if `asObject` is set to true, returns the XML
-    # parsed as an XmlSimple object ().
-    # asObject (Hash)::       If true, returns the XML parsed as an XmlSimple object, using:
-    #                           data = XmlSimple.xml_in(response, { 'ForceArray' => false, 'KeepRoot' => true })
-    #                         You can then parse it back into an XML string using:
-    #                           XmlSimple.xml_out(data, { 'RootName' => nil, 'XmlDeclaration' => true })
-    #                         If set to false, returns the XML as a string.
-    # 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.
-    def get_default_config_xml(asObject=false, options={})
-      response = send_api_request(:getDefaultConfigXML, options, nil, true)
-      if asObject
-        XmlSimple.xml_in(response, { 'ForceArray' => false, 'KeepRoot' => true })
-      else
-        response
-      end
-    end
-
-    # Sets a config.xml file in the server.
-    # Returns the token returned by the server (that can be later used in a 'join' call) in case
-    # of success.
-    # meeting_id (string)::                   The ID of the meeting where this config.xml will be used.
-    # xml (string|BigBlueButtonConfigXml)::   The XML that should be sent as a config.xml.
-    #                                         It will usually be an edited output of the default config.xml:
-    #                                           xml = api.get_default_config_xml
-    #                                         Or you can use directly a BigBlueButtonConfigXml object:
-    #                                           BigBlueButtonConfigXml.new(xml)
-    # 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.
-    # TODO: Right now we are sending the configXML parameters in the URL and in the body of the POST
-    #   request. It works if left only in the URL, but the documentation of the API claims that it has
-    #   to be in the body of the request. So it's no clear yet and this might change in the future.
-    def set_config_xml(meeting_id, xml, options={})
-      if xml.instance_of?(BigBlueButton::BigBlueButtonConfigXml)
-        data = xml.as_string
-      else
-        data = xml
-      end
-      params = { :meetingID => meeting_id, :configXML => data }.merge(options)
-      response = send_api_request(:setConfigXML, params, data)
-      response[:configToken]
-    end
-
-
     #
     # Helper functions
     #
 
-    # Returns an array with the name of all layouts available in the server.
-    # Will fetch the config.xml file (unless passed in the arguments), fetch the
-    # layout definition file, and return the layouts.
-    # If something goes wrong, returns nil. Otherwise returns the list of layout
-    # names or an empty array if there's no layout defined.
-    def get_available_layouts(config_xml=nil)
-      config_xml = get_default_config_xml if config_xml.nil?
-      config_xml = BigBlueButton::BigBlueButtonConfigXml.new(config_xml)
-      layout_config = config_xml.get_attribute("LayoutModule", "layoutConfig", true)
-      unless layout_config.nil?
-        response = send_request(layout_config)
-        layout_config = BigBlueButton::BigBlueButtonConfigLayout.new(response.body)
-        layout_config.get_available_layouts
-      else
-        nil
-      end
-    end
-
-    # Returns an array with the layouts that exist by default in a BigBlueButton
-    # server. If you want to query the server to get a real list of layouts, use
-    # <tt>get_available_layouts</tt>.
-    def get_default_layouts
-      # this is the list for BigBlueButton 0.81
-      ["Default", "Video Chat", "Meeting", "Webinar", "Lecture assistant", "Lecture"]
-    end
-
     # Make a simple request to the server to test the connection.
     def test_connection
       response = send_api_request(:index)
@@ -687,15 +606,10 @@ module BigBlueButton
       checksum_param = method.to_s + checksum_param
       checksum = @sha256 ? Digest::SHA256.hexdigest(checksum_param) : Digest::SHA1.hexdigest(checksum_param)
 
-      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
+      url = "#{@url}/#{method}?"
+      url += "#{params_string}&" unless params_string.empty?
+      url += "checksum=#{checksum}"
+      return url, nil
     end
 
     # Performs an API call.