Merge pull request #123 from PrestaShop/dev

Release 0.2.0

Author: jolelievre

.github/workflows/integration.yml

@@ -17,8 +17,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [ '8.1', '8.2', '8.3' ]
+        php: [ '8.1', '8.2', '8.3', '8.4', '8.5' ]
         prestashop_version: ['develop', '9.0.x']
+        exclude:
+          # 9.0.x doesn't support PHP 8.5
+          - php: '8.5'
+            prestashop_version: '9.0.x'
       fail-fast: false
     steps:
       - name: Checkout module code
@@ -33,6 +37,7 @@ jobs:
           path: prestashop
           ref: ${{ matrix.prestashop_version }}
       - name: Build Docker
+        timeout-minutes: 15
         env:
           VERSION: ${{ matrix.php }}-apache
         run: |

.github/workflows/php.yml

@@ -24,6 +24,9 @@ jobs:
             - name: PHP syntax checker 8.4
               uses: prestashop/github-action-php-lint/8.4@master
 
+            - name: PHP syntax checker 8.5
+              uses: prestashop/github-action-php-lint/8.5@master
+
     # Check the PHP code follow the coding standards
     php-cs-fixer:
         name: PHP-CS-Fixer
@@ -72,3 +75,51 @@ jobs:
 
         - name: Run header-stamp
           run: php vendor/bin/header-stamp --license=vendor/prestashop/header-stamp/assets/afl.txt --exclude=vendor --dry-run
+
+    phpunit:
+      name: PHPUnit Tests
+      runs-on: ubuntu-latest
+      steps:
+        - name: Setup PHP
+          uses: shivammathur/setup-php@v2
+          with:
+            php-version: '8.1'
+
+        - name: Checkout
+          uses: actions/checkout@v4
+
+        - name: Cache dependencies
+          uses: actions/cache@v3
+          with:
+            path: vendor
+            key: php-${{ hashFiles('composer.lock') }}
+
+        - name: Install dependencies
+          run: composer install
+
+        - name: Run PHPUnit tests
+          run: php vendor/bin/phpunit -c tests/Unit/phpunit.xml
+
+    rector:
+      name: Rector Dry Run
+      runs-on: ubuntu-latest
+      steps:
+        - name: Setup PHP
+          uses: shivammathur/setup-php@v2
+          with:
+            php-version: '8.1'
+
+        - name: Checkout
+          uses: actions/checkout@v4
+
+        - name: Cache dependencies
+          uses: actions/cache@v3
+          with:
+            path: vendor
+            key: php-${{ hashFiles('composer.lock') }}
+
+        - name: Install dependencies
+          run: composer install
+
+        - name: Run Rector dry-run
+          run: composer rector

README.md

@@ -10,6 +10,14 @@ This module contains no code only some resource files that are automatically sca
 
 You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue].
 
+## Under development
+
+Please be aware that this module is still under development, that is why its version is only `0.*`, we didn't release a major version `1.0` yet because we anticipate some breaking changes may happen while we add all the missing endpoints.
+
+We try to maintain retro compatibility as much as possible and always refrain from adding breaking changes, but we also want this API contract to be a fixed standard once it's finalized, so we prefer to polish and improve it before a major version is released.
+
+After the `1.0` version is released it won't include other breaking changes, any breaking change will require a new major version (`2.0`) and will follow semver convention.
+
 ## Requirements
 
 Required only for development:
@@ -51,6 +59,10 @@ composer setup-local-tests -- [arguments]
 
 Example:
 ```bash
+# To test with 9.0.x branch
+composer setup-local-tests -- --force --core-branch=9.0.x
+
+# To test with a branch from your fork (in this example fork: jolelievre branch: product-api)
 composer setup-local-tests -- --force --core-branch=jolelievre:product-api
 ```
 
@@ -73,6 +85,6 @@ Just make sure to follow our [contribution guidelines][contribution-guidelines].
 This module is released under the [Academic Free License 3.0][AFL-3.0]
 
 [report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose
-[prestashop]: https://www.prestashop.com/
-[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/
+[prestashop]: https://www.prestashop-project.org/
+[contribution-guidelines]: https://devdocs.prestashop-project.org/9/contribute/contribution-guidelines/project-modules/
 [AFL-3.0]: https://opensource.org/licenses/AFL-3.0

composer.json

@@ -16,7 +16,9 @@
         "prestashop/php-dev-tools": "^4.3",
         "czproject/git-php": "^4.2",
         "phpunit/phpunit": "^10",
-        "friendsofphp/php-cs-fixer": "^v3"
+        "friendsofphp/php-cs-fixer": "^v3",
+        "rector/rector": "^2.0",
+        "doctrine/inflector": "^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -47,7 +49,10 @@
             "@composer setup-local-tests -- --build-db"
         ],
         "run-module-tests": "@php -d date.timezone=UTC ./vendor/bin/phpunit -c tests/Integration/phpunit-local.xml",
-        "setup-local-tests": "PsApiResourcesTest\\EnvironmentBuilder::setupLocalTests"
+        "run-unit-tests": "@php -d date.timezone=UTC ./vendor/bin/phpunit -c tests/Unit/phpunit.xml",
+        "setup-local-tests": "PsApiResourcesTest\\EnvironmentBuilder::setupLocalTests",
+        "rector": "vendor/bin/rector process --clear-cache --dry-run",
+        "rector-fix": "vendor/bin/rector process"
     },
     "type": "prestashop-module",
     "author": "PrestaShop"

composer.lock

@@ -2,7 +2,7 @@
 <module>
     <name>ps_apiresources</name>
     <displayName><![CDATA[PrestaShop API Resources]]></displayName>
-    <version><![CDATA[0.1.0]]></version>
+    <version><![CDATA[0.2.0]]></version>
     <description><![CDATA[Includes the resources allowing using the API for the PrestaShop domain, all endpoints are based on CQRS commands/queries from the Core and we APIPlatform framework is used as a base.]]></description>
     <author><![CDATA[PrestaShop]]></author>
     <tab><![CDATA[administration]]></tab>