bigbluebutton-api-ruby 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 473e9baacfe50dd02c2de2799d1f9ef36d7fa086
-  data.tar.gz: f8a35a9a314631bb3386382322fa2d5bee8c3a17
+  metadata.gz: 281b4e206ec398cc651d0525256a68dd048d3db3
+  data.tar.gz: 4c6a8bddc03d8c5289926fab24d589442bc16095
 SHA512:
-  metadata.gz: af669d4c0ea78a687001e1b0d1449da3a820f76c846ca3535942f2c56c86c1854cc3cd2d4d2614408b3cd1a3c233f2ef42683bd9bc9c7345cbeefd80dc4fbc99
-  data.tar.gz: 283b0c7fd0d864f7b674372c3f85887fd6b4d67eab6e7ba686abb1b4c017740b94289b2f84e1e20fe35d82efe2396f9b9c19704a751dab7c7130b9e7ed662f1b
+  metadata.gz: 2a2105c7f2d8f6b03a82e0f2bc42052f932e75de76318bcb7885d72e75b492696bd279dbc33e6bc537d37ed2a18e7d444e34ec4b2abe58d2e7e73421b4061164
+  data.tar.gz: 130aa32c3945507d661ef188dd158f545a0755be304ee3b1a55cdfc1bcd57ef168f41b5fd9e5a5488f62bf0b636566a6347ff85708dc32e35d2e3c87a8241bc3

data/.rspec

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

data/CHANGELOG.md

@@ -9,6 +9,18 @@ To find them, search for their description or ID in the new issue tracker.
 ------------------------------------
 
 
+## [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
 
 * Add 1.0 as a supported version of BigBlueButton.
@@ -141,6 +153,8 @@ were different in cases when they were not.
     (instead of browser URL). This call currently does not work as
     documented.
 
+[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/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    bigbluebutton-api-ruby (1.6.0)
+    bigbluebutton-api-ruby (1.7.0)
       xml-simple (~> 1.1)
 
 GEM

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.7.0"
   s.licenses         = ["MIT"]
   s.extra_rdoc_files = ["README.md", "LICENSE", "LICENSE_003", "CHANGELOG.md"]
   s.summary          = "BigBlueButton integration for ruby"

data/lib/bigbluebutton_api.rb

@@ -226,7 +226,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.
@@ -468,6 +469,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,6 +624,11 @@ 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
@@ -623,11 +653,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 +666,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)
 
-      # 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 +698,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?
@@ -711,7 +750,7 @@ module BigBlueButton
           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
+          opts = { 'Content-Type' => 'application/x-www-form-urlencoded' }.merge @request_headers
           response = http.post(url_parsed.request_uri, data, opts)
         end
         puts "BigBlueButtonAPI: URL response = #{response.body}" if @debug

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
 

data/spec/bigbluebutton_api_spec.rb

@@ -226,7 +226,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,6 +340,15 @@ 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) }
 
@@ -400,14 +409,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,35 +435,54 @@ 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/
+            if params.map{ |k,v| k }.join =~ /^param1/
               "67882ae54f49600f56f358c10d24697ef7d8c6b2"
             else
               "85a54e28e4ec18bfdcb214a73f74d35b09a84176"
             end
           }
-          subject { api.get_url(:join, params) }
+          subject { api.get_url(:join, params)[0] }
           it { subject.should match(/checksum=#{checksum}$/) }
         end
       end
@@ -461,7 +496,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
@@ -551,7 +586,7 @@ describe BigBlueButton::BigBlueButtonApi do
         let(:data) { "any data" }
         before {
           path = "/res?param1=value1&checksum=12345"
-          opts = { 'Content-Type' => 'text/xml' }
+          opts = { 'Content-Type' => 'application/x-www-form-urlencoded' }
           @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
         }
         it {
@@ -573,7 +608,7 @@ describe BigBlueButton::BigBlueButtonApi do
         let(:data) { "any data" }
         before {
           path = "/res?param1=value1&checksum=12345"
-          opts = { 'Content-Type' => 'text/xml', :anything => "anything" }
+          opts = { 'Content-Type' => 'application/x-www-form-urlencoded', :anything => "anything" }
           @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
         }
         it {
@@ -755,4 +790,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Mconf
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple