Merge pull request #72 from php-api-clients/use-contracts-package-for-authentication-interface

Use contracts package auth header

Author: WyriHaximus

Makefile

@@ -0,0 +1,74 @@
+# set all to phony
+SHELL=bash
+
+.PHONY: *
+
+DOCKER_CGROUP:=$(shell cat /proc/1/cgroup | grep docker | wc -l)
+COMPOSER_CACHE_DIR=$(shell composer config --global cache-dir -q || echo ${HOME}/.composer/cache)
+
+ifneq ("$(wildcard /.dockerenv)","")
+    IN_DOCKER=TRUE
+else ifneq ("$(DOCKER_CGROUP)","0")
+	IN_DOCKER=TRUE
+else
+    IN_DOCKER=FALSe
+endif
+
+ifeq ("$(IN_DOCKER)","TRUE")
+	DOCKER_RUN=
+else
+	DOCKER_RUN=docker run --rm -it \
+		-v "`pwd`:`pwd`" \
+		-v "${COMPOSER_CACHE_DIR}:/home/app/.composer/cache" \
+		-w "`pwd`" \
+		"wyrihaximusnet/php:8.2-nts-alpine-slim-dev"
+endif
+
+all: ## Runs everything ###
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | xargs --open-tty $(MAKE)
+
+syntax-php: ## Lint PHP syntax
+	$(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor .
+
+cs-fix: ## Fix any automatically fixable code style issues
+	$(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc)
+
+cs: ## Check the code for code style issues
+	$(DOCKER_RUN) vendor/bin/phpcs --parallel=$(shell nproc)
+
+stan: ## Run static analysis (PHPStan)
+	$(DOCKER_RUN) vendor/bin/phpstan analyse src tests --level max --ansi -c phpstan.neon
+
+psalm: ## Run static analysis (Psalm)
+	$(DOCKER_RUN) vendor/bin/psalm --threads=$(shell nproc) --shepherd --stats
+
+unit: ## Run tests
+	$(DOCKER_RUN) vendor/bin/phpunit --colors=always -c phpunit.xml.dist --coverage-text --coverage-html covHtml --coverage-clover ./build/logs/clover.xml
+
+unit-ci: unit
+	if [ -f ./build/logs/clover.xml ]; then wget https://scrutinizer-ci.com/ocular.phar && sleep 3 && php ocular.phar code-coverage:upload --format=php-clover ./build/logs/clover.xml; fi
+
+infection: ## Run mutation testing
+	$(DOCKER_RUN) vendor/bin/infection --ansi --min-msi=100 --min-covered-msi=100 --threads=$(shell nproc)
+
+composer-require-checker: ## Ensure we require every package used in this package directly
+	$(DOCKER_RUN) vendor/bin/composer-require-checker --ignore-parse-errors --ansi -vvv --config-file=composer-require-checker.json
+
+composer-unused: ## Ensure we don't require any package we don't use in this package directly
+	$(DOCKER_RUN) composer unused --ansi
+
+backward-compatibility-check: ## Check code for backwards incompatible changes
+	$(DOCKER_RUN) vendor/bin/roave-backward-compatibility-check || true
+
+shell: ## Provides Shell access in the expected environment ###
+	$(DOCKER_RUN) ash
+
+task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ###
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]'
+
+help: ## Show this help ###
+	@printf "\033[33mUsage:\033[0m\n  make [target]\n\n\033[33mTargets:\033[0m\n"
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[32m%-32s\033[0m %s\n", $$1, $$2}' | tr -d '#'
+
+generate-clients:
+	ls ./etc/clients | xargs -I % ./vendor/bin/openapi-client-generator ./etc/clients/%

composer.json

@@ -19,7 +19,7 @@
         }
     },
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "cebe/php-openapi": "dev-openapi-31 as 1.6.0",
         "jawira/case-converter": "^3.4",
         "twig/twig": "^3.0",
@@ -31,7 +31,8 @@
         "wyrihaximus/hydrator": "dev-master",
         "league/openapi-psr7-validator": "^0.16",
         "react/http": "^1.8",
-        "reactivex/rxphp": "^2.0"
+        "reactivex/rxphp": "^2.0",
+        "api-clients/contracts": "dev-main"
     },
     "autoload": {
         "psr-4": {
@@ -46,7 +47,7 @@
     },
     "config": {
         "platform": {
-            "php": "8.1.99"
+            "php": "8.2.13"
         },
         "allow-plugins": {
             "wyrihaximus/composer-update-bin-autoload-path": true

composer.lock

@@ -177,10 +177,6 @@ private function all(string $namespace): iterable
             );
         }
 
-        yield from Authentication::generate(
-            $namespace,
-        );
-
         while ($schemaRegistry->hasUnknownSchemas()) {
             foreach ($schemaRegistry->unknownSchemas() as $schema) {
                 yield from Schema::generate(

src/Generator.php

@@ -2,6 +2,7 @@
 
 namespace ApiClients\Tools\OpenApiClientGenerator\Generator;
 
+use ApiClients\Contracts\HTTP\Headers\AuthenticationInterface;
 use ApiClients\Tools\OpenApiClientGenerator\File;
 use ApiClients\Tools\OpenApiClientGenerator\SchemaRegistry;
 use cebe\openapi\spec\Operation as OpenAPiOperation;
@@ -34,7 +35,7 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
         $stmt = $factory->namespace(rtrim($namespace, '\\'));
 
         $class = $factory->class('Client')->makeFinal()->addStmt(
-            $factory->property('authentication')->setType('\\' . $namespace . Authentication::INTERFACE_NAME)->makeReadonly()->makePrivate()
+            $factory->property('authentication')->setType('\\' . AuthenticationInterface::class)->makeReadonly()->makePrivate()
         )->addStmt(
             $factory->property('browser')->setType('\\' . Browser::class)->makeReadonly()->makePrivate()
         )->addStmt(
@@ -43,7 +44,7 @@ public static function generate(string $namespace, array $clients, SchemaRegistr
             $factory->property('responseSchemaValidator')->setType('\League\OpenAPIValidation\Schema\SchemaValidator')->makeReadonly()->makePrivate()
         )->addStmt(
             $factory->method('__construct')->makePublic()->addParam(
-                (new Param('authentication'))->setType('\\' . $namespace . Authentication::INTERFACE_NAME)
+                (new Param('authentication'))->setType('\\' . AuthenticationInterface::class)
             )->addStmt(
                 new Node\Expr\Assign(
                     new Node\Expr\PropertyFetch(

src/Generator/Authentication.php

@@ -98,7 +98,7 @@ private static function fillUpSchema(string $name, string $namespace, string $cl
             $propertyStmt = $factory->property($propertyName)->makePrivate();
             $propertyDocBlock = [];
             $methodDocBlock = [];
-            if (strlen($property->description) > 0) {
+            if (is_string($property->description) && strlen($property->description) > 0) {
                 $propertyDocBlock[] = $property->description;
                 $methodDocBlock[] = $property->description;
             }