Rename BigBlueButtonApi#salt to #secret

Something that was already done in BigBlueButton a few years ago.

Author: daronco

examples/prepare.rb

@@ -34,5 +34,5 @@ def prepare
   puts server.inspect
   puts
 
-  @api = BigBlueButton::BigBlueButtonApi.new(server['url'], server['salt'], server['version'].to_s, true)
+  @api = BigBlueButton::BigBlueButtonApi.new(server['url'], server['secret'], server['version'].to_s, true)
 end

features/config.yml.example

@@ -11,8 +11,8 @@ timeout_bot_start: 60
 
 servers:
   test-install:
-    salt: '8cd8ef52e8e101574e400365b55e11a6'
     url: 'http://test-install.blindsidenetworks.com/bigbluebutton/api'
+    secret: '8cd8ef52e8e101574e400365b55e11a6'
   bbb-other:
-    salt: 'lka98f52e8akdlsoie400365b55e98s7'
     url: 'http://yourserver.com/bigbluebutton/api'
+    secret: 'lka98f52e8akdlsoie400365b55e98s7'

features/step_definitions/common_steps.rb

@@ -2,7 +2,7 @@
 
 When /^the default BigBlueButton server$/ do
   @api = BigBlueButton::BigBlueButtonApi.new(@config_server['url'],
-                                             @config_server['salt'],
+                                             @config_server['secret'],
                                              @config_server['version'].to_s,
                                              @config['debug'])
   @api.timeout = @config['timeout_req']
@@ -48,8 +48,7 @@
 end
 
 When /^the meeting is running with (\d+) attendees$/ do |count|
-  mobile_salt = @config_server.has_key?('mobile_salt') ? @config_server['mobile_salt'] : ""
-  BigBlueButtonBot.new(@api, @req.id, mobile_salt, count.to_i, @config['timeout_bot_start'])
+  BigBlueButtonBot.new(@api, @req.id, nil, count.to_i, @config['timeout_bot_start'])
 end
 
 When /^the response is an error with the key "(.*)"$/ do |key|

lib/bigbluebutton_api.rb

@@ -44,8 +44,8 @@ class BigBlueButtonApi
     # URL to a BigBlueButton server (e.g. http://demo.bigbluebutton.org/bigbluebutton/api)
     attr_accessor :url
 
-    # Secret salt for this server
-    attr_accessor :salt
+    # Shared secret for this server
+    attr_accessor :secret
 
     # API version e.g. 0.81
     attr_accessor :version
@@ -65,12 +65,12 @@ class BigBlueButtonApi
 
     # Initializes an instance
     # url::       URL to a BigBlueButton server (e.g. http://demo.bigbluebutton.org/bigbluebutton/api)
-    # salt::      Secret salt for this server
+    # secret::    Shared secret for this server
     # version::   API version e.g. 0.81
-    def initialize(url, salt, version=nil, debug=false)
+    def initialize(url, secret, version=nil, debug=false)
       @supported_versions = ['0.8', '0.81', '0.9', '1.0']
       @url = url
-      @salt = salt
+      @secret = secret
       @debug = debug
       @timeout = 10         # default timeout for api requests
       @request_headers = {} # http headers sent in all requests
@@ -602,7 +602,7 @@ def test_connection
     # API's are equal if all the following attributes are equal.
     def ==(other)
       r = true
-      [:url, :supported_versions, :salt, :version, :debug].each do |param|
+      [:url, :supported_versions, :secret, :version, :debug].each do |param|
         r = r && self.send(param) == other.send(param)
       end
       r
@@ -638,7 +638,7 @@ def get_url(method, params={})
       params_string = params.map{ |k,v| "#{k}=" + CGI::escape(v.to_s) unless k.nil? || v.nil? }.join("&")
 
       # checksum calc
-      checksum_param = params_string + @salt
+      checksum_param = params_string + @secret
       checksum_param = method.to_s + checksum_param
       checksum = Digest::SHA1.hexdigest(checksum_param)
 

spec/bigbluebutton_api_0.81_spec.rb

@@ -5,10 +5,10 @@
 
   # default variables and API object for all tests
   let(:url) { "http://server.com" }
-  let(:salt) { "1234567890abcdefghijkl" }
+  let(:secret) { "1234567890abcdefghijkl" }
   let(:version) { "0.81" }
   let(:debug) { false }
-  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, salt, version, debug) }
+  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
 
   describe "#get_default_config_xml" do
     let(:response) { "<response><returncode>1</returncode></response>" }

spec/bigbluebutton_api_0.9_spec.rb

@@ -5,10 +5,10 @@
 
   # default variables and API object for all tests
   let(:url) { "http://server.com" }
-  let(:salt) { "1234567890abcdefghijkl" }
+  let(:secret) { "1234567890abcdefghijkl" }
   let(:version) { "0.9" }
   let(:debug) { false }
-  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, salt, version, debug) }
+  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
 
   describe "#create_meeting" do
     context "accepts the new parameters" do

spec/bigbluebutton_api_spec.rb

@@ -8,15 +8,15 @@
 
     # default variables and API object for all tests
     let(:url) { "http://server.com" }
-    let(:salt) { "1234567890abcdefghijkl" }
+    let(:secret) { "1234567890abcdefghijkl" }
     let(:debug) { false }
-    let(:api) { BigBlueButton::BigBlueButtonApi.new(url, salt, version, debug) }
+    let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
 
     describe "#initialize" do
       context "standard initialization" do
-        subject { BigBlueButton::BigBlueButtonApi.new(url, salt, version, debug) }
+        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
         it { subject.url.should == url }
-        it { subject.salt.should == salt }
+        it { subject.secret.should == secret }
         it { subject.version.should == version }
         it { subject.debug.should == debug }
         it { subject.timeout.should == 10 }
@@ -28,39 +28,39 @@
 
       context "when the version is not informed, get it from the BBB server" do
         before { BigBlueButton::BigBlueButtonApi.any_instance.should_receive(:get_api_version).and_return("0.8") }
-        subject { BigBlueButton::BigBlueButtonApi.new(url, salt, nil) }
+        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, nil) }
         it { subject.version.should == "0.8" }
       end
 
       context "when the version informed is empty, get it from the BBB server" do
         before { BigBlueButton::BigBlueButtonApi.any_instance.should_receive(:get_api_version).and_return("0.8") }
-        subject { BigBlueButton::BigBlueButtonApi.new(url, salt, "  ") }
+        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, "  ") }
         it { subject.version.should == "0.8" }
       end
 
       it "when the version is lower than the lowest supported, raise exception" do
         expect {
-          BigBlueButton::BigBlueButtonApi.new(url, salt, "0.1", nil)
+          BigBlueButton::BigBlueButtonApi.new(url, secret, "0.1", nil)
         }.to raise_error(BigBlueButton::BigBlueButtonException)
       end
 
       it "when the version is higher than thew highest supported, use the highest supported" do
-        BigBlueButton::BigBlueButtonApi.new(url, salt, "5.0", nil).version.should eql('1.0')
+        BigBlueButton::BigBlueButtonApi.new(url, secret, "5.0", nil).version.should eql('1.0')
       end
 
       it "compares versions in the format 'x.xx' properly" do
         expect {
           # if not comparing properly, 0.61 would be bigger than 0.9, for example
           # comparing the way BBB does, it is lower, so will raise an exception
-          BigBlueButton::BigBlueButtonApi.new(url, salt, "0.61", nil)
+          BigBlueButton::BigBlueButtonApi.new(url, secret, "0.61", nil)
         }.to raise_error(BigBlueButton::BigBlueButtonException)
       end
 
       context "current supported versions" do
         before {
           BigBlueButton::BigBlueButtonApi.any_instance.should_receive(:get_api_version).and_return("0.9")
         }
-        subject { BigBlueButton::BigBlueButtonApi.new(url, salt) }
+        subject { BigBlueButton::BigBlueButtonApi.new(url, secret) }
         it { subject.supported_versions.should == ["0.8", "0.81", "0.9", "1.0"] }
       end
     end
@@ -341,7 +341,7 @@
     end
 
     describe "#==" do
-      let(:api2) { BigBlueButton::BigBlueButtonApi.new(url, salt, version, debug) }
+      let(:api2) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
 
       context "compares attributes" do
         it { api.should == api2 }
@@ -352,8 +352,8 @@
         it { api.should_not == api2 }
       end
 
-      context "differs #salt" do
-        before { api2.salt = api.salt + "x" }
+      context "differs #secret" do
+        before { api2.secret = api.secret + "x" }
         it { api.should_not == api2 }
       end