Dev changes (#26)

* Dev changes

* Workflow configurations

* Added ignore path

* Workflow fix

* Workflow fix

* Workflow fix

* Workflow fix

* Dev fixes

* Psalm fixes

Author: andrey18106

.github/CONTRIBUTING.md

@@ -19,7 +19,7 @@ Help us to maximize the effort we can spend fixing issues and adding new feature
 
 ## Contributing to Source Code
 
-Thanks for wanting to contribute source code to the Cloud_Py_API app. That's great!
+Thanks for wanting to contribute source code to the `cloud_py_api` app. That's great!
 
 ## Translations
 

.github/FUNDING.yml

@@ -1,12 +1,12 @@
 # These are supported funding model platforms
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: mediadc
+patreon:
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
+liberapay: cloud_py_api
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom:
+custom: ['https://www.paypal.com/donate?hosted_button_id=H5PLJJMWLDNJQ']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -9,9 +9,8 @@ A clear and concise description of what the bug is.
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+2. Perform some actions '...'
+3. See error
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
@@ -22,12 +21,11 @@ If applicable, add screenshots to help explain your problem.
 **Desktop (please complete the following information):**
  - OS [e.g. Ubuntu]
  - CPU [architecture x86, ARM]
- - Browser [e.g. chrome, firefox, safari]
- - Nextcloud version [e.g. 23]
+ - Nextcloud version [e.g. 25.x.x]
  - Database configuration [e.g. mysql 8.0.27, without sensitive information]
- - Python version [e.g. 3.9.1]
- - Cloud_Py_API version [e.g. 0.1.0]
- - Cloud_Py_API config and admin settings
+ - app version, that using `cloud_py_api`
+ - `cloud_py_api` version [e.g. 0.1.0]
+ - `cloud_py_api` config and admin settings (can be obtained in bug report admin settings section)
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation.md

@@ -3,9 +3,9 @@ name: Documentation Issue
 about: Typo fix or additions to our Wiki
 ---
 
-The MediaDC Wiki is open to anyone to edit. If you find something inaccurate,
+The `cloud_py_api` Wiki is open to anyone to edit. If you find something inaccurate,
 missing or that can be improved, please feel free to contribute to it.
 
-https://github.com/andrey18106/mediadc/wiki
+https://github.com/cloud-py-api/cloud_py_api/wiki
 
 Thank you!

.github/ISSUE_TEMPLATE/question.md

@@ -3,16 +3,14 @@ name: Support Question
 about: Do NOT ask here - Use the forum or Telegram chat
 ---
 
-Thanks for reporting issues back to MediaDC!
+Thanks for reporting issues back to `cloud_py_api`!
 
 # DO NOT ASK QUESTIONS, USE THE FORUMS
 
-We use GitHub issues only to discuss about MediaDC bugs and new features.
+We use GitHub issues only to discuss about `cloud_py_api` bugs and new features.
 
-MediaDC and its extras are explained in the [wiki](https://github.com/andrey18106/mediadc/wiki).
+`cloud_py_api` and its extras are explained in the [wiki](https://github.com/cloud-py-api/cloud_py_api/wiki).
 
-For any other question or comment, please use the official Telegram support [chat](https://t.me/mediadc_support).
-
-Note that quite probably your question has an answer in the [FAQ](https://github.com/andrey18106/mediadc/wiki/FAQ).
+Note that quite probably your question has an answer in the [FAQ](https://github.com/cloud-py-api/cloud_py_api/wiki/FAQ).
 
 Thank you!

.github/ISSUE_TEMPLATE/security.md

@@ -5,8 +5,10 @@ about: Important security issue or bug
 
 ⚠ PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW.
 
-If you have found a security issue in MediaDC, please type to one of administrators
-in our official Telegram support [chat](https://t.me/mediadc_support)
-and don't disclose it publicly until we can provide a fix for it.
+If you have found a security issue in `cloud_py_api`, please type to one of administrators
+email, that are listed below and don't disclose it publicly until we can provide a fix for it.
+
+- Alexander Piskun <[email protected]>
+- Andrey Borysenko <[email protected]>
 
 Thank you!

.github/workflows/create-release-draft.yml

@@ -49,11 +49,50 @@ jobs:
       - name: Package app
         run: krankerl package
 
-      - uses: actions/upload-artifact@v3
+      - name: Get nextcloud-min-version from appinfo
+        id: appinfo
+        uses: skjnldsv/xpath-action@master
         with:
-          name: tarball
-          path: build/artifacts/${{ env.APP_NAME }}.tar.gz
-          if-no-files-found: error
+          filename: ${{ env.APP_NAME }}/appinfo/info.xml
+          expression: "//info//dependencies//nextcloud/@min-version"
+
+      - name: Cache nextcloud server
+        id: nextcloud_setup
+        uses: actions/cache@v3
+        with:
+          path: nextcloud-${{ fromJSON(steps.appinfo.outputs.result).nextcloud.min-version }}.zip
+          key: ${{ fromJSON(steps.appinfo.outputs.result).nextcloud.min-version }}
+
+      - name: Download nextcloud${{ fromJSON(steps.appinfo.outputs.result).nextcloud.min-version }}
+        if: steps.nextcloud_setup.outputs.cache-hit != 'true'
+        continue-on-error: true
+        id: server-checkout
+        run: |
+          NCVERSION=${{ fromJSON(steps.appinfo.outputs.result).nextcloud.min-version }}
+          wget --quiet https://download.nextcloud.com/server/releases/latest-$NCVERSION.zip
+          unzip latest-$NCVERSION.zip
+
+      - name: Checkout server master fallback
+        uses: actions/checkout@v3
+        if: ${{ steps.server-checkout.outcome != 'success' }}
+        with:
+          repository: nextcloud/server
+          path: nextcloud
+
+      - name: Sign app
+        run: |
+          # Extracting release
+          cd ${{ env.APP_NAME }}/build/artifacts
+          tar -xvf ${{ env.APP_NAME }}.tar.gz
+          cd ../../../
+          # Setting up keys
+          echo "${{ secrets.APP_PRIVATE_KEY }}" > ${{ env.APP_NAME }}.key
+          echo "${{ secrets.APP_PUBLIC_CRT }}" > ${{ env.APP_NAME.key }}
+          # Signing
+          php nextcloud/occ integrity:sign-app --privateKey=../${{ env.APP_NAME }}.key --certificate=../${{ env.APP_NAME }}.crt --path=../${{ env.APP_NAME }}/build/artifacts/${{ env.APP_NAME }}
+          # Rebuilding archive
+          cd ${{ env.APP_NAME }}/build/artifacts
+          tar -zcvf ${{ env.APP_NAME }}.tar.gz ${{ env.APP_NAME }}
 
       - name: Create release draft
         uses: ncipollo/[email protected]

.github/workflows/lint.yml

@@ -1,11 +1,27 @@
 name: Lint
 
 on:
-  # pull_request:
-  #   branches: [main, dev]
-  #   types: [opened, reopened, edited, synchronize]
-  # push:
-  #   branches: [dev, main]
+  pull_request:
+    branches: [main]
+    types: [opened, reopened, edited, synchronize]
+    paths:
+      - 'appinfo/*.*'
+      - 'lib/**'
+      - 'src/**'
+      - 'templates/*.*'
+      - 'tests/Unit/**'
+      - 'tests/Integration/**'
+      - 'tests/javascript/**'
+  push:
+    branches: [main]
+    paths:
+      - 'appinfo/*.*'
+      - 'lib/*.*'
+      - 'src/*.*'
+      - 'templates/*.*'
+      - 'tests/Unit/**'
+      - 'tests/Integration/**'
+      - 'tests/javascript/**'
   workflow_dispatch:
 
 jobs:

.github/workflows/test.yml

@@ -1,18 +1,32 @@
 name: Test
 
 on:
-  # pull_request:
-  #   branches: [main, dev]
-  #   types: [opened, reopened, edited, synchronize]
-  # push:
-  #   branches: [dev, main]
+  pull_request:
+    branches: [main]
+    types: [opened, reopened, edited, synchronize]
+    paths:
+      - 'lib/*.*'
+      - 'src/*.*'
+      - 'templates/*.*'
+      - 'tests/Unit/**'
+      - 'tests/Integration/**'
+      - 'tests/javascript/**'
+  push:
+    branches: [main]
+    paths:
+      - 'lib/*.*'
+      - 'src/*.*'
+      - 'templates/*.*'
+      - 'tests/Unit/**'
+      - 'tests/Integration/**'
+      - 'tests/javascript/**'
   workflow_dispatch:
 
 env:
   # Location of the phpunit.xml and phpunit.integration.xml files
   PHPUNIT_CONFIG: ./tests/phpunit.xml
   PHPUNIT_INTEGRATION_CONFIG: ./tests/phpunit.integration.xml
-  APP_NAME: mediadc
+  APP_NAME: cloud_py_api
 
 jobs:
   phpunit-mysql:
@@ -33,16 +47,6 @@ jobs:
         options: --health-cmd="mysqladmin ping" --health-interval 5s --health-timeout 2s --health-retries 5
 
     steps:
-      - name: Set app env
-        run: |
-          # Split and keep last
-          echo "APP_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV
-
-      - name: Enable ONLY_FULL_GROUP_BY MySQL option
-        run: |
-          echo "SET GLOBAL sql_mode=(SELECT CONCAT(@@sql_mode,',ONLY_FULL_GROUP_BY'));" | mysql -h 127.0.0.1 -P 4444 -u root -prootpassword
-          echo "SELECT @@sql_mode;" | mysql -h 127.0.0.1 -P 4444 -u root -prootpassword
-
       - name: Checkout server
         uses: actions/checkout@v3
         with:
@@ -122,11 +126,6 @@ jobs:
         options: --health-cmd pg_isready --health-interval 5s --health-timeout 2s --health-retries 5
 
     steps:
-      - name: Set app env
-        run: |
-          # Split and keep last
-          echo "APP_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV
-
       - name: Checkout server
         uses: actions/checkout@v3
         with:
@@ -188,87 +187,6 @@ jobs:
         working-directory: apps/${{ env.APP_NAME }}
         run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_INTEGRATION_CONFIG }}
 
-  # phpunit-oci:
-  #   runs-on: ubuntu-20.04
-
-  #   strategy:
-  #     matrix:
-  #       php-versions: ["8.0"]
-  #       server-versions: ["master"]
-
-  #   services:
-  #     oracle:
-  #       image: deepdiver/docker-oracle-xe-11g # 'wnameless/oracle-xe-11g-r2'
-  #       ports:
-  #         - 1521:1521/tcp
-
-  #   steps:
-  #     - name: Set app env
-  #       run: |
-  #         # Split and keep last
-  #         echo "APP_NAME=${GITHUB_REPOSITORY##*/}" >> $GITHUB_ENV
-
-  #     - name: Checkout server
-  #       uses: actions/checkout@v3
-  #       with:
-  #         submodules: true
-  #         repository: nextcloud/server
-  #         ref: ${{ matrix.server-versions }}
-
-  #     - name: Checkout app
-  #       uses: actions/checkout@v3
-  #       with:
-  #         path: apps/${{ env.APP_NAME }}
-
-  #     - name: Set up php ${{ matrix.php-versions }}
-  #       uses: shivammathur/setup-php@v2
-  #       with:
-  #         php-version: ${{ matrix.php-versions }}
-  #         extensions: mbstring, fileinfo, intl, sqlite, pdo_sqlite, oci8
-  #         tools: phpunit
-  #         coverage: none
-
-  #     - name: Set up PHPUnit
-  #       working-directory: apps/${{ env.APP_NAME }}
-  #       run: composer i
-
-  #     - name: Set up Nextcloud
-  #       env:
-  #         DB_PORT: 1521
-  #       run: |
-  #         mkdir data
-  #         ./occ maintenance:install --verbose --database=oci --database-name=XE --database-host=127.0.0.1 --database-port=$DB_PORT --database-user=autotest --database-pass=owncloud --admin-user admin --admin-pass admin
-  #         ./occ app:enable ${{ env.APP_NAME }}
-
-  #     - name: Check PHPUnit config file existence
-  #       id: check_phpunit
-  #       uses: andstor/file-existence-action@v2
-  #       with:
-  #         files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_CONFIG }}
-
-  #     - name: PHPUnit
-  #       # Only run if phpunit config file exists
-  #       if: steps.check_phpunit.outputs.files_exists == 'true'
-  #       working-directory: apps/${{ env.APP_NAME }}
-  #       run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_CONFIG }}
-
-  #     - name: Check PHPUnit integration config file existence
-  #       id: check_integration
-  #       uses: andstor/file-existence-action@v2
-  #       with:
-  #         files: apps/${{ env.APP_NAME }}/${{ env.PHPUNIT_INTEGRATION_CONFIG }}
-
-  #     - name: Run Nextcloud
-  #       # Only run if phpunit integration config file exists
-  #       if: steps.check_integration.outputs.files_exists == 'true'
-  #       run: php -S localhost:8080 &
-
-  #     - name: PHPUnit integration
-  #       # Only run if phpunit integration config file exists
-  #       if: steps.check_integration.outputs.files_exists == 'true'
-  #       working-directory: apps/${{ env.APP_NAME }}
-  #       run: ./vendor/phpunit/phpunit/phpunit -c ${{ env.PHPUNIT_INTEGRATION_CONFIG }}
-
   phpunit-summary:
     runs-on: ubuntu-latest
     needs: [phpunit-mysql, phpunit-pgsql]
@@ -285,13 +203,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Checkout app
+        uses: actions/checkout@v3
+        with:
+          path: apps/${{ env.APP_NAME }}
+
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version: 16.x
 
       - name: Install dependencies
+        working-directory: apps/${{ env.APP_NAME }}
         run: npm ci
 
       - name: Run unit tests
+        working-directory: apps/${{ env.APP_NAME }}
         run: npm run test

CHANGELOG.md

@@ -1,4 +1,4 @@
-_# Changelog
+# Changelog
 
 All notable changes to this project will be documented in this file.
 
@@ -30,4 +30,4 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
-### Fixed_
+### Fixed