Version 5

.git_hooks/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+docker run --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix --config=/code/.php-cs-fixer.php /code/src

.github/workflows/coverage-diff.yml

@@ -0,0 +1,118 @@
+name: 'coverage-diff'
+on:
+  pull_request:
+
+jobs:
+  coverage-diff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          clean: false
+      - uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231
+        with:
+          php-version: 8.2
+          coverage: none
+          tools: composer:v2
+          extensions: xdebug
+      - name: Install Dependencies
+        run: composer install -q --profile --ignore-platform-reqs --no-interaction --no-ansi --no-scripts --no-suggest --prefer-dist
+      - uses: KengoTODA/actions-setup-docker-compose@4677f0d86d41e623c9c6e11e1d910976da297bc0
+        with:
+          version: '2.14.2'
+      - name: "Create Empty env File for Docker"
+        run: touch .env
+      - name: Clear previous coverage data
+        run: rm -f cov/xml/clover-pr.xml cov/xml/clover-base.xml cov/xml/clover.xml
+      - name: PHPUnit for PR
+        run: docker-compose run phpunit
+      - name: Create coverage report for PR
+        id: pr_coverage
+        run: |
+          php ./generate_coverage_report.php
+          COVERAGE_PR=$(jq -r '.total.statements.pct' cov/json/index.json)
+          echo "COVERAGE_PR=$COVERAGE_PR" >> $GITHUB_ENV
+      - name: Upload coverage report markdown
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-md
+          path: cov/markdown/coverage_report.md
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.base.ref }}
+          clean: false
+
+      - uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231
+        with:
+          php-version: 8.2
+          coverage: none
+          tools: composer:v2
+          extensions: xdebug
+      - name: Install Dependencies
+        run: composer install -q --profile --ignore-platform-reqs --no-interaction --no-ansi --no-scripts --no-suggest --prefer-dist
+      - uses: KengoTODA/actions-setup-docker-compose@4677f0d86d41e623c9c6e11e1d910976da297bc0
+        with:
+          version: '2.14.2'
+      - name: "Create Empty env File for Docker"
+        run: touch .env
+      - name: PHPUnit for Base
+        run: docker-compose run phpunit
+      - name: Create coverage report for Base
+        id: base_coverage
+        run: |
+          COVERAGE_BASE=0
+
+          if [ -f "./generate_coverage_report.php" ]; then
+            php ./generate_coverage_report.php
+          fi
+
+          if [ -f "cov/json/index.json" ]; then
+            COVERAGE_BASE=$(jq -r '.total.statements.pct' cov/json/index.json)
+          fi
+
+          echo "COVERAGE_BASE=$COVERAGE_BASE" >> $GITHUB_ENV
+
+      - name: Compare coverage
+        id: compare_coverage
+        run: |
+          COVERAGE_DIFF=$(echo "$COVERAGE_PR - $COVERAGE_BASE" | awk '{printf "%.2f", $0}')
+          echo "Coverage PR: $COVERAGE_PR%"
+          echo "Coverage Base: $COVERAGE_BASE%"
+          echo "Coverage Diff: $COVERAGE_DIFF%"
+
+          if (( $(echo "$COVERAGE_DIFF > 0" | awk '{print ($0 > 0)}') )); then
+            COVERAGE_MESSAGE=":green_circle: Coverage increased by $COVERAGE_DIFF%"
+          elif (( $(echo "$COVERAGE_DIFF < 0" | awk '{print ($0 < 0)}') )); then
+            COVERAGE_MESSAGE=":red_circle: Coverage decreased by ${COVERAGE_DIFF#-}%"
+          else
+            COVERAGE_MESSAGE=":yellow_circle: Coverage remained the same."
+          fi
+
+          echo "COVERAGE_MESSAGE=$COVERAGE_MESSAGE" >> $GITHUB_ENV
+
+      - name: Download coverage report markdown
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report-md
+          path: cov/markdown/
+
+      - name: Combine Coverage Message and Report
+        run: |
+          echo "${COVERAGE_MESSAGE}" > coverage_message.txt
+          cat cov/markdown/coverage_report.md >> coverage_message.txt
+          combined_message=$(cat coverage_message.txt)
+          echo "combined_message<<EOF" >> $GITHUB_ENV
+          echo "$combined_message" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Add comment with coverage report
+        uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31
+        with:
+          message: "${{ env.combined_message }}"
+      - name: Add coverage report to the job summary
+        run: |
+          {
+            echo "${{ env.combined_message }}" 
+          } >> $GITHUB_STEP_SUMMARY

.github/workflows/coverage-report.yml

@@ -0,0 +1,42 @@
+name: 'coverage-report'
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+jobs:
+  coverage-report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231
+        with:
+          php-version: 8.2
+          coverage: none
+          tools: composer:v2
+          extensions: xdebug
+      - name: Install Dependencies
+        run: composer install -q --profile --ignore-platform-reqs --no-interaction --no-ansi --no-scripts --no-suggest --prefer-dist
+      - uses: KengoTODA/actions-setup-docker-compose@4677f0d86d41e623c9c6e11e1d910976da297bc0
+        with:
+          version: '2.14.2'
+      - name: "Create Empty env File for Docker"
+        run: touch .env
+      - name: PHPUnit
+        run: docker-compose run --user "$(id -u):$(id -g)" phpunit
+      - name: "Parse Coverage"
+        run: "php ./generate_coverage_report.php"
+      - name: Create Coverage Badges
+        uses: jaywcjlove/coverage-badges-cli@df58615045079f1c827de7867044bbab3ec22b43
+        with:
+          source: cov/json/index.json
+          output: cov/html/coverage.svg
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@920cbb300dcd3f0568dbc42700c61e2fd9e6139c
+        with:
+          branch: gh-pages
+          folder: cov/html
+          clean-exclude: |
+            .nojekyll

.github/workflows/functional.yml

@@ -22,7 +22,7 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231
         with:
           php-version: "${{ matrix.php_version }}"
           coverage: none

.github/workflows/test.yml

@@ -17,14 +17,14 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@c541c155eee45413f5b09a52248675b1a2575231
         with:
           php-version: "${{ matrix.php_version }}"
           coverage: none
           tools: composer:v2
       - name: Install Dependencies
         run: composer install -q --profile --ignore-platform-reqs --no-interaction --no-ansi --no-scripts --no-suggest --prefer-dist
-      - uses: php-actions/phpunit@v3
+      - uses: php-actions/phpunit@aed47a6852905dbd05b7c1a47c526b38fcc4bc17
         with:
           php_version: "${{ matrix.php_version }}"
           bootstrap: vendor/autoload.php

.gitignore

@@ -6,4 +6,7 @@
 .vscode
 .env
 release/yarn-error.log
-release/node_modules
+release/node_modules
+.php-cs-fixer.cache
+cov/**/*.*
+!cov/**/.gitkeep

.php-cs-fixer.php

@@ -0,0 +1,21 @@
+<?php
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        '@PhpCsFixer' => true,
+        'array_indentation' => true,
+        'trailing_comma_in_multiline' => ['elements' => ['arrays']],
+        'no_whitespace_before_comma_in_array' => true,
+        'whitespace_after_comma_in_array' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'binary_operator_spaces' => [
+            'default' => 'single_space',
+            'operators' => ['=>' => null],
+        ],
+        'multiline_whitespace_before_semicolons' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__)
+    );

.swagger-codegen-ignore

@@ -3,4 +3,6 @@ src/phpunit.xml.dist
 src/.travis.yml
 src/.php_cs
 src/git_push.sh
-src/test/**
+src/test/**
+src/HeaderSelector.php
+src/ObjectSerializer.php

CHANGELOG.md

@@ -1,3 +1,38 @@
+## [5.0.0-develop.1](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/compare/v4.1.0...v5.0.0-develop.1) (2024-09-04)
+
+
+### ⚠ BREAKING CHANGES
+
+* Renamed Error Response Model Names
+`ErrorEvent403ResponseError` → `Common403ErrorResponse`
+`ManyRequestsResponse` → `TooManyRequestsResponse`
+* Webhook `tag` field is now optional
+* API Methods now throws `SerializationException`
+* API Methods returns tuple instead of models
+* API Methods removed other than `getModel`
+* Upgraded minimum php version to 8.1
+* Request logic is rewritten, Upgraded minimum php version to 8.1
+
+### Features
+
+* add `remoteControl`, `velocity` and `developerTools` signals ([5bf9368](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/5bf9368fb1bb5abbfa72366fe6c66fe32352ad54))
+* add delete visitor data endpoint ([a00f325](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/a00f325706af38cc20e4c387db44dfa83c7a7a22))
+* add retry after policy to api exception ([64e0510](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/64e05100a2c20c8d1f8e5f9719ee5292c59761c2))
+* add support for validating webhook signatures inter-768 ([6a4cbd6](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/6a4cbd6e2a521a209806337d90ae8f7e291a534b))
+* add update event endpoint (PUT) ([cb21d0b](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/cb21d0b4c48b7b94f4e9a7de1ab74313fe339e5f))
+* change api to return tuple instead of serialized model ([62e4ad3](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/62e4ad3020425667f45e3beeb166b4095a437ab5))
+* introduce rawResponse for getVisits and getEvent methods ([9b01ba6](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/9b01ba65e7ac794c77afedc155823baef2c80b17))
+* introduce serialization exception ([bfea23a](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/bfea23a50b61152d4fc65d290c730d0e3fcb6123))
+* only generate models and docs from swagger codegen ([26e984f](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/26e984ffd01dc9f21af3dd4da75fcb7e4309961f))
+* remove raw response and introduce with http info ([ce2fedf](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/ce2fedfcd94f5f1459049ba49eff75e2d3b8620c))
+* rewrite request logic ([0016822](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/001682270fd4370484b25062550a65bd375b9372))
+* upgrade min php version to 8 ([5698871](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/5698871fa497ee4ad50b2941d39769b45f15dfc2))
+
+
+### Bug Fixes
+
+* serializaiton problem on sealed results ([29cb26c](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/commit/29cb26c3f50bfa035ca750948bb92a2299f579bd))
+
 ## [4.1.0](https://github.com/fingerprintjs/fingerprint-pro-server-api-php-sdk/compare/v4.0.0...v4.1.0) (2024-03-26)