Merge branch 'master' into add-parameter-typehints

Author: sualko

.gitattributes

@@ -0,0 +1,8 @@
+.gitattributes export-ignore
+.gitignore export-ignore
+/.github export-ignore
+codeception.yml export-ignore
+.php_cs export-ignore
+phpunit.xml.dist export-ignore
+psalm.xml export-ignore
+/tests export-ignore

.github/workflows/ci.yml

@@ -5,6 +5,33 @@ on:
   pull_request:
 
 jobs:
+  PHP_Lowest:
+    name: PHP wth lowest dependencies
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.2']
+        experimental: [false]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup PHP, with composer and extensions
+      uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+      with:
+        php-version: ${{ matrix.php-versions }}
+        extensions: bcmath, ctype, fileinfo, json, mbstring, dom, ldap, pdo, tokenizer, xml, mysql, sqlite
+        coverage: xdebug
+    - name: Downgrade phpunit for php7.2
+      run: composer update phpunit/phpunit -W
+    - name: Update to lowest php dependencies
+      run: composer update --prefer-lowest
+    - name: Install php dependencies
+      run: composer install --dev --no-interaction
+    - name: Execute tests without coverage
+      run: vendor/bin/phpunit --testsuite="BigBlueButton unit test suite,BigBlueButton integration test suite"
+   
   PHP:
     name: PHP ${{ matrix.php-versions }}
     runs-on: ubuntu-latest
@@ -39,27 +66,13 @@ jobs:
       if: ${{ !matrix.experimental }}
       run: |
         mkdir -p build/logs
-        vendor/bin/phpunit --coverage-clover=build/logs/coverage.xml --testsuite="BigBlueButton test suite"
+        vendor/bin/phpunit --coverage-clover=build/logs/coverage.xml --testsuite="BigBlueButton unit test suite,BigBlueButton integration test suite"
     - name: Execute tests without coverage
       if: ${{ matrix.experimental }}
       run: vendor/bin/phpunit --testsuite="BigBlueButton test suite"
       continue-on-error: true
     - name: Coveralls
       env:
-        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
+        COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       if: ${{ matrix.php-versions == '7.2' && env.COVERALLS_REPO_TOKEN != null }}
       run: vendor/bin/php-coveralls --coverage_clover=build/logs/coverage.xml -v
-
-
-  HHVM:
-    name: HHVM
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: azjezz/setup-hhvm@v1
-        with:
-          version: 'latest'
-      - run: composer install --dev --no-interaction
-        continue-on-error: true
-      - run: hhvm vendor/bin/phpunit
-        continue-on-error: true

.gitignore

@@ -10,6 +10,10 @@ composer.phar
 .php_cs.cache
 cghooks.lock
 
+# PHPUnit reports (for convenience when working locally)
+reports
+
+# PHPUnit result cache
 .phpunit.result.cache
 
 # Local environment variables

README.md

@@ -1,11 +1,11 @@
 # :tada: Best BigBlueButton API for PHP
 
 The unofficial and easiest to use **BigBlueButton API for PHP**, makes easy for
-developers to use [BigBlueButton API] v2.2 for **PHP 7.2+**.
+developers to use [BigBlueButton API] v2.2+ for **PHP 7.2+**.
 
 ![Build Status](https://github.com/littleredbutton/bigbluebutton-api-php/workflows/CI/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/littleredbutton/bigbluebutton-api-php/badge.svg?branch=master)](https://coveralls.io/github/littleredbutton/bigbluebutton-api-php?branch=master)
-![PHP from Travis config](https://img.shields.io/travis/php-v/littleredbutton/bigbluebutton-api-php.svg)
+![PHP from Packagist](https://img.shields.io/packagist/php-v/littleredbutton/bigbluebutton-api-php)
 <!-- [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/littleredbutton/bigbluebutton-api-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/littleredbutton/bigbluebutton-api-php/?branch=master) -->
 
 **This API uses BigBlueButton and is not endorsed or certified by BigBlueButton
@@ -91,6 +91,8 @@ $bbb = new BigBlueButton($apiUrl, $apiSecret);
 
 If you didn't use composer before, make sure that you include `vendor/autoload.php`.
 
+In general the usage is closly related to the official [API description](https://docs.bigbluebutton.org/dev/api.html). This means to create a room, you have to create a `CreateMeetingParameters` object and set all required parameters via the related setter method. This means to set the `attendeePW`, you have to call `setAttendeePW` and so on.
+
 #### Test if API url and secret are valid
 ```php
 use BigBlueButton\Parameters\IsMeetingRunningParameters;
@@ -126,8 +128,8 @@ $version = $bbb->getApiVersion()->getVersion();
 use BigBlueButton\Parameters\CreateMeetingParameters;
 
 $createMeetingParams = new CreateMeetingParameters($meetingID, $meetingName);
-$createMeetingParams->setAttendeePassword($attendee_password);
-$createMeetingParams->setModeratorPassword($moderator_password);
+$createMeetingParams->setAttendeePW($attendee_password);
+$createMeetingParams->setModeratorPW($moderator_password);
 
 $createMeetingResponse = $bbb->createMeeting($createMeetingParams);
 
@@ -157,7 +159,7 @@ $createMeetingParams->setGuestPolicyAlwaysAcceptAuth();
 use BigBlueButton\Parameters\JoinMeetingParameters;
 
 $joinMeetingParams = new JoinMeetingParameters($room->uid, $displayname, $password);
-$joinMeetingParams->setCreationTime($createMeetingResponse->getCreationTime());
+$joinMeetingParams->setCreateTime($createMeetingResponse->getCreationTime());
 $joinMeetingParams->setJoinViaHtml5(true);
 $joinMeetingParams->setRedirect(true);
 
@@ -253,7 +255,7 @@ if ($response->failed()) {
 use BigBlueButton\Parameters\GetRecordingsParameters;
 
 $recordingParams = new GetRecordingsParameters();
-$recordingParams->setRecordId($recordId); // omit to get a list of all recordings
+$recordingParams->setRecordID($recordId); // omit to get a list of all recordings
 $recordingParams->setState('any');
 
 $response = $bbb->getRecordings($recordingParams);
@@ -496,7 +498,7 @@ The integration requires additional setup as there are using a real BigBlueButto
 You need to create a `.env.local` file to configure which server to use and the proper credentials:
 
 ```shell
-echo "BBB_SERVER_BASE_URL=https://bbb.example/bigbluebutton/" > env.local
+echo "BBB_SERVER_BASE_URL=https://bbb.example/bigbluebutton/" > .env.local
 echo "BBB_SECRET=S3cr3t" >> .env.local
 ```
 

composer.json

@@ -94,9 +94,15 @@
       "BigBlueButton\\": ["src", "tests/integration"]
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "BigBlueButton\\Tests\\Functional\\": ["tests/functional"]
+    }
+  },
   "scripts": {
-    "test": "vendor/bin/phpunit",
-    "test-integration": "vendor/bin/phpunit --testsuite=\"BigBlueButton integration test suite\" --exclude-group=integration-legacy",
+    "test": "vendor/bin/phpunit  --testsuite=\"BigBlueButton unit test suite\"",
+    "test-integration": "vendor/bin/phpunit  --testsuite=\"BigBlueButton integration test suite\"",
+    "test-functional": "vendor/bin/phpunit --testsuite=\"BigBlueButton functional test suite\" --exclude-group=functional-legacy",
     "cs-fix": "vendor/bin/php-cs-fixer fix --allow-risky=yes",
     "cs-test": "vendor/bin/php-cs-fixer fix --dry-run --allow-risky=yes",
     "psalm": "psalm --threads=1",
@@ -111,7 +117,7 @@
         "vendor/bin/php-cs-fixer fix --dry-run --allow-risky=yes"
       ],
       "pre-push": [
-        "vendor/bin/phpunit --testsuite=\"BigBlueButton test suite\"",
+        "vendor/bin/phpunit --testsuite=\"BigBlueButton unit test suite,BigBlueButton integration test suite\"",
         "vendor/bin/psalm --threads=1"
       ],
       "post-merge": "composer install",

phpunit-integration.xml.dist

@@ -18,12 +18,15 @@
     </filter>
 
     <testsuites>
-        <testsuite name="BigBlueButton test suite">
+        <testsuite name="BigBlueButton unit test suite">
             <directory>./tests/unit/</directory>
         </testsuite>
         <testsuite name="BigBlueButton integration test suite">
             <directory>./tests/integration/</directory>
         </testsuite>
+        <testsuite name="BigBlueButton functional test suite">
+            <directory>./tests/functional/</directory>
+        </testsuite>
     </testsuites>
 
 </phpunit>

phpunit.xml.dist

@@ -58,7 +58,7 @@ class Attendee
     /**
      * @var array
      */
-    private $customData;
+    private $customData = [];
 
     /**
      * @var string

src/Core/Attendee.php

@@ -375,6 +375,36 @@ public function getAttendees()
         return $this->attendees;
     }
 
+    /**
+     * Moderators of Meeting - Subset of Attendees
+     * @return Attendee[]
+     */
+    public function getModerators(): array
+    {
+        $attendees = $this->getAttendees();
+
+        $moderators = array_filter($attendees, function ($attendee) {
+            return $attendee->getRole() === 'MODERATOR';
+        });
+
+        return array_values($moderators);
+    }
+
+    /**
+     * Viewers of Meeting - Subset of Attendees
+     * @return Attendee[]
+     */
+    public function getViewers(): array
+    {
+        $attendees = $this->getAttendees();
+
+        $viewers = array_filter($attendees, function ($attendee) {
+            return $attendee->getRole() === 'VIEWER';
+        });
+
+        return array_values($viewers);
+    }
+
     /**
      * @return array
      */

src/Core/Meeting.php

@@ -22,7 +22,7 @@
 
 use BigBlueButton\Exceptions\NetworkException;
 use BigBlueButton\Exceptions\RuntimeException;
-use BigBlueButton\Http\SetCookie;
+use BigBlueButton\Http\Transport\Cookie;
 use BigBlueButton\Http\Transport\TransportInterface;
 use BigBlueButton\Http\Transport\TransportRequest;
 use BigBlueButton\Http\Transport\TransportResponse;
@@ -130,23 +130,8 @@ public function request(TransportRequest $request): TransportResponse
             throw new NetworkException('Bad response.', $psrResponse->getStatusCode());
         }
 
-        $jsessionCookie = null;
-
-        foreach ($psrResponse->getHeader('Set-Cookie') as $headerValue) {
-            $cookie = SetCookie::fromString($headerValue);
-
-            if ($cookie->getName() === 'JSESSIONID') {
-                $value = $cookie->getValue();
-
-                if ('' === $value) {
-                    break;
-                }
-
-                $jsessionCookie = $value;
-
-                break;
-            }
-        }
+        $headerValues   = $psrResponse->getHeader('Set-Cookie');
+        $jsessionCookie = Cookie::extractJsessionId($headerValues);
 
         return new TransportResponse($psrResponse->getBody()->getContents(), $jsessionCookie);
     }