Renamed salt to secret.

GhaziTriki · GhaziTriki · commit df3da4850618 · 2018-08-01T18:27:52.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -21,7 +21,7 @@ matrix:
 
 env:
   global:
-    - BBB_SECURITY_SALT=8cd8ef52e8e101574e400365b55e11a6
+    - BBB_SECRET=8cd8ef52e8e101574e400365b55e11a6
     - BBB_SERVER_BASE_URL=http://test-install.blindsidenetworks.com/bigbluebutton/
 
 before_script:
diff --git a/README.md b/README.md
@@ -23,30 +23,30 @@ The official and easy to use **BigBlueButton API for PHP**, makes easy for devel
 - mbstring library installed.
 - Xml library installed.
 
-BigBlueButton API for PHP is also tested to work with HHVM and fully compatible with PHP 7.1.
+BigBlueButton API for PHP is also tested to work with HHVM and fully compatible with PHP 7.0 and above.
 
 
 ## Installation
 
 **bigbluebutton-api-php** can be installed via [Composer][composer] CLI
 
 ```
-composer require bigbluebutton/bigbluebutton-api-php:dev-master
+composer require bigbluebutton/bigbluebutton-api-php:~2.0.0
 ```
 
 or by editing [Composer][composer].json
 
 ```json
 {
     "require": {
-        "bigbluebutton/bigbluebutton-api-php": "dev-master"
+        "bigbluebutton/bigbluebutton-api-php": "~2.0.0"
     }
 }
 ```
 
 ## Usage
 
-You should have environment variables ```BBB_SECURITY_SALT``` and ```BBB_SERVER_BASE_URL``` defined in your sever.
+You should have environment variables ```BBB_SECRET``` and ```BBB_SERVER_BASE_URL``` defined in your sever.
 \*if you are using Laravel you can add it in your .env
 
 The you will be able to call BigBlueButton API of your server. A simple usage example for create meeting looks like:
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -13,8 +13,8 @@
          syntaxCheck="false">
 
     <php>
-        <!-- Specify the value of your BigBlueButton security salt -->
-        <env name="BBB_SECURITY_SALT" value="8cd8ef52e8e101574e400365b55e11a6"/>
+        <!-- Specify the value of your BigBlueButton secret -->
+        <env name="BBB_SECRET" value="8cd8ef52e8e101574e400365b55e11a6"/>
         <!-- Specify the Server Base URL of your BigBlueButton -->
         <env name="BBB_SERVER_BASE_URL" value="http://test-install.blindsidenetworks.com/bigbluebutton/"/>
     </php>
diff --git a/src/BigBlueButton.php b/src/BigBlueButton.php
@@ -50,15 +50,16 @@
  */
 class BigBlueButton
 {
-    protected $securitySalt;
+    protected $securitySecret;
     protected $bbbServerBaseUrl;
     protected $urlBuilder;
 
     public function __construct()
     {
-        $this->securitySalt     = getenv('BBB_SECURITY_SALT');
+        // Keeping backward compatibility with older deployed versions
+        $this->securitySecret   = (getenv('BBB_SECURITY_SALT') === false) ? getenv('BBB_SECRET') : $this->securitySecret   = getenv('BBB_SECURITY_SALT');
         $this->bbbServerBaseUrl = getenv('BBB_SERVER_BASE_URL');
-        $this->urlBuilder       = new UrlBuilder($this->securitySalt, $this->bbbServerBaseUrl);
+        $this->urlBuilder       = new UrlBuilder($this->securitySecret, $this->bbbServerBaseUrl);
     }
 
     /**
diff --git a/src/Util/UrlBuilder.php b/src/Util/UrlBuilder.php
@@ -36,12 +36,12 @@ class UrlBuilder
     /**
      * UrlBuilder constructor.
      *
-     * @param $salt
+     * @param $secret
      * @param $serverBaseUrl
      */
-    public function __construct($salt, $serverBaseUrl)
+    public function __construct($secret, $serverBaseUrl)
     {
-        $this->securitySalt     = $salt;
+        $this->securitySalt     = $secret;
         $this->bbbServerBaseUrl = $serverBaseUrl;
     }
 
diff --git a/tests/BigBlueButtonTest.php b/tests/BigBlueButtonTest.php
@@ -44,7 +44,7 @@ public function setUp()
     {
         parent::setUp();
 
-        foreach (['BBB_SECURITY_SALT', 'BBB_SERVER_BASE_URL'] as $k) {
+        foreach (['BBB_SECRET', 'BBB_SERVER_BASE_URL'] as $k) {
             if (!getenv($k)) {
                 $this->fail('$_SERVER[\'' . $k . '\'] not set in '
                     . 'phpunit.xml');

Original file line number	Diff line number	Diff line change
`@@ -50,15 +50,16 @@`
`50`	`50`	`*/`
`51`	`51`	`class BigBlueButton`
`52`	`52`	`{`
`53`		`- protected $securitySalt;`
	`53`	`+ protected $securitySecret;`
`54`	`54`	`protected $bbbServerBaseUrl;`
`55`	`55`	`protected $urlBuilder;`
`56`	`56`
`57`	`57`	`public function __construct()`
`58`	`58`	`{`
`59`		`- $this->securitySalt = getenv('BBB_SECURITY_SALT');`
	`59`	`+ // Keeping backward compatibility with older deployed versions`
	`60`	`+ $this->securitySecret = (getenv('BBB_SECURITY_SALT') === false) ? getenv('BBB_SECRET') : $this->securitySecret = getenv('BBB_SECURITY_SALT');`
`60`	`61`	`$this->bbbServerBaseUrl = getenv('BBB_SERVER_BASE_URL');`
`61`		`- $this->urlBuilder = new UrlBuilder($this->securitySalt, $this->bbbServerBaseUrl);`
	`62`	`+ $this->urlBuilder = new UrlBuilder($this->securitySecret, $this->bbbServerBaseUrl);`
`62`	`63`	`}`
`63`	`64`
`64`	`65`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -36,12 +36,12 @@ class UrlBuilder`
`36`	`36`	`/**`
`37`	`37`	`* UrlBuilder constructor.`
`38`	`38`	`*`
`39`		`- * @param $salt`
	`39`	`+ * @param $secret`
`40`	`40`	`* @param $serverBaseUrl`
`41`	`41`	`*/`
`42`		`- public function __construct($salt, $serverBaseUrl)`
	`42`	`+ public function __construct($secret, $serverBaseUrl)`
`43`	`43`	`{`
`44`		`- $this->securitySalt = $salt;`
	`44`	`+ $this->securitySalt = $secret;`
`45`	`45`	`$this->bbbServerBaseUrl = $serverBaseUrl;`
`46`	`46`	`}`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function setUp()`
`44`	`44`	`{`
`45`	`45`	`parent::setUp();`
`46`	`46`
`47`		`- foreach (['BBB_SECURITY_SALT', 'BBB_SERVER_BASE_URL'] as $k) {`
	`47`	`+ foreach (['BBB_SECRET', 'BBB_SERVER_BASE_URL'] as $k) {`
`48`	`48`	`if (!getenv($k)) {`
`49`	`49`	`$this->fail('$_SERVER[\'' . $k . '\'] not set in '`
`50`	`50`	`. 'phpunit.xml');`