Merge remote-tracking branch 'origin/master' into sync-upstream

Author: FelixJacobi

.env

@@ -0,0 +1 @@
+# This file must exist to enable loading .env.local but is currently not used.

.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/contributing.md

@@ -0,0 +1,50 @@
+# Contributing to the best PHP API for BBB
+
+:+1::tada: First off, thanks for taking the time to contribute!
+
+There are plenty of ways to give something back to the open source community.
+Following you find a couple of them for this PHP API and no matter which
+you choose, we appreciate every help :clap:.
+
+## :bug: Reporting a bug
+Every application depends on people who are testing it in different environments
+and reporting misbehavior or options to enhance the application further. To help
+developers to fix your issue faster, please [open a new issue] for every bug or
+feature request and follow the guidelines below:
+
+- A issue should be self contained, so that everyone can keep track of changes
+  and discussions.
+- Provide as many information as you can.
+- Please be kind. Remember that most developers are working in there free time
+  to make this code better.
+
+## :page_facing_up: Contribute code
+Every code contribution is considered valuable, independent from there size and
+small changes can also be contributed directly via Github:
+
+1. Browse to the desired file via
+   [Github](https://github.com/littleredbutton/bigbluebutton-api-php).
+2. Click on the :pencil2: on the top right corner of the file.
+3. Make your changes.
+4. Add a meaning full commit message.
+5. Submit your changes.
+
+If you want to contribute larger changes, we recommend the following approach
+which requires basic git knowledge.
+
+1. Fork the repository.
+2. Install all dependencies with `composer install`.
+3. Create a local branch for your fix or feature (e.g. `fix-recording`).
+4. Run our tests with `vendor/bin/phpunit`.
+5. Commit your changes and push your created branch to your fork.
+6. Open a new pull request into our master branch.
+
+We use a git hooks, which should mention any issues preventing the merge of your
+pull request.
+
+## :loudspeaker: Promote
+You like this API and you use a blog, Twitter, Facebook or any other social
+network? It would be great if you could write a small post about this fork.
+
+
+[open a new issue]: https://github.com/littleredbutton/bigbluebutton-api-php/issues

.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+  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
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.2','7.3','7.4','8.0']
+        experimental: [false]
+        include:
+          - php-versions: '8.1'
+            experimental: true
+
+    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
+      if: ${{ matrix.php-versions == '7.2' }}
+      run: composer update phpunit/phpunit -W
+    - name: Install php dependencies
+      run: composer install --dev --no-interaction
+      continue-on-error: ${{ matrix.experimental }}
+    - name: Execute code style check via php-cs-fixer
+      run: vendor/bin/php-cs-fixer fix --dry-run
+      continue-on-error: ${{ matrix.experimental }}
+    - name: Execute tests with coverage
+      if: ${{ !matrix.experimental }}
+      run: |
+        mkdir -p build/logs
+        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.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

.gitignore

@@ -1,6 +1,5 @@
 composer.phar
 /vendor/
-composer.lock
 .DS_Store
 
 ## Directory-based project format:
@@ -9,3 +8,14 @@ composer.lock
 
 # PHP CS Fixer cache file
 .php_cs.cache
+cghooks.lock
+
+# PHPUnit reports (for convenience when working locally)
+reports
+
+# PHPUnit result cache
+.phpunit.result.cache
+
+# Local environment variables
+/.env.local
+/.env.*.local

.php_cs

@@ -10,7 +10,7 @@ $finder = \PhpCsFixer\Finder::create()
 
 return PhpCsFixer\Config::create()
     ->setUsingCache(false)
-    ->setRules(array(
+    ->setRules([
         'psr4'                               => true,
         'encoding'                           => true,
         'full_opening_tag'                   => true,
@@ -49,5 +49,6 @@ return PhpCsFixer\Config::create()
             'align_double_arrow' => true,
             'align_equals'       => true,
         ]
-    ))
+    ])
+    ->setRiskyAllowed(true)
     ->setFinder($finder);