bigbluebutton-api-ruby 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25726eaedf0a5b63156a7786a793f27a419e349a177419fdaecb0e0aac0295d6
-  data.tar.gz: 6e8ec707b2f53e06ba21163d2f5d34766436e49f852991434d3aa787a4108deb
+  metadata.gz: d0441812c16477d28d431e085349d9b41dbb2487fa2714658d0f4257bfbfc696
+  data.tar.gz: d6ef204678952d1890225b2e66dd17e7aafb2a20733ffd2733b6a99c3a9383f1
 SHA512:
-  metadata.gz: 810382ae7b2f54be6ac766e10db46a61f76a4120c84bb1a99600012266db562da53149d7ee0bde1c7a2b3939542398556a7faa85dd24153c669f04875ac90213
-  data.tar.gz: 229132ef71db18f0a972daefb0b5b0ad49c53c63655877923323a163f99d15b383d4f0ac7344ebba61a6b5961f3a08abc2dc50a9ef217d4eccf0fcbfc2fdc527
+  metadata.gz: 8a62b74b9922d8eae4ad5f28be54e5975c0bbc7e267a7da457f3c307ca3199a3bf82f6acc2361e419df9c7a3277882e66cf10ba9cd52f60f23f6a3a8a8e88faa
+  data.tar.gz: 8630d39007e82a5d3e0fd0ea623e51138a62726e1778170d03db1150220196906b7665d9caab3e4cf9b85eeebf11445ae7302670048ee8eee4fc7f7e2773235b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [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`.

data/Gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .
   specs:
-    bigbluebutton-api-ruby (1.8.0)
+    bigbluebutton-api-ruby (1.9.0)
       childprocess (>= 1.0.1)
       ffi (>= 1.9.24)
       json (>= 1.8.6)

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.8.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"

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'
@@ -68,13 +69,17 @@ 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, logger=nil)
+    # 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
       @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
@@ -680,7 +685,7 @@ module BigBlueButton
       # 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)
 
       if method == :setConfigXML
         params_string = "checksum=#{checksum}&#{params_string}"

data/spec/bigbluebutton_api_spec.rb

@@ -474,17 +474,34 @@ describe BigBlueButton::BigBlueButtonApi do
         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)[0] }
-          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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Mconf
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess