chore: add specs for @sha256 flag

Author: wpramio

lib/bigbluebutton_api.rb

@@ -69,7 +69,7 @@ class BigBlueButtonApi
     # 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
-    # logger::
+    # 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']
@@ -79,6 +79,7 @@ def initialize(url, secret, version=nil, logger=nil, sha256=false)
       @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

spec/bigbluebutton_api_spec.rb

@@ -474,17 +474,34 @@
         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