📦 migrate company-users-rest-api from fond-of-spryker (#80)

.github/workflows/main.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  continous-integration:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: [ "8.0", "8.1", "8.2" ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - 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: mbstring, dom, fileinfo, pgsql, json
+          coverage: xdebug #optional
+      - name: Get composer cache directory
+        id: composercache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+      - name: Cache composer dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composercache.outputs.dir }}
+          # Use composer.json for key, if composer.lock is not committed.
+          # key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+      - name: Install dependencies and run ci tasks
+        run: make install ci

.gitignore

@@ -0,0 +1,9 @@
+.idea
+
+.DS_Store
+
+vendor
+composer.lock
+
+src/Generated
+src/Orm

LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present FOND OF GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,30 @@
+.PHONY: install
+install:
+	composer install
+
+.PHONY: phpcs
+phpcs:
+	./vendor/bin/phpcs --standard=./vendor/spryker/code-sniffer/Spryker/ruleset.xml ./src/FondOfImpala/* ./tests/*
+
+.PHONY: phpcbf
+phpcbf:
+	./vendor/bin/phpcbf --standard=./vendor/spryker/code-sniffer/Spryker/ruleset.xml ./src/FondOfImpala/* ./tests/*
+
+.PHONY: phpstan
+phpstan:
+	./vendor/bin/phpstan --memory-limit=-1 analyse ./src/FondOfImpala
+
+.PHONY: codeception
+codeception:
+	./vendor/bin/codecept run --env standalone
+
+.PHONY: ci
+ci: phpcs codeception phpstan
+
+.PHONY: clean
+clean:
+	rm -Rf composer.lock
+	rm -Rf ./vendor
+	find ./tests/_output/ -not -name .gitignore -delete
+	rm -Rf src/Generated/*
+	rm -Rf src/Orm/*

README.md

@@ -0,0 +1,9 @@
+# Company Users Rest Api Module
+[![CI](https://github.com/fond-of-impala/company-users-rest-api/actions/workflows/main.yml/badge.svg)](https://github.com/fond-of-impala/company-users-rest-api/actions/workflows/main.yml)
+[![license](https://img.shields.io/github/license/fond-of-impala/company-users-rest-api.svg)](https://packagist.org/packages/fond-of-impala/company-users-rest-api)
+
+## Installation
+
+```
+composer require fond-of-impala/company-users-rest-api
+```

codeception.yml

@@ -0,0 +1,43 @@
+namespace: fond-of-impala/company-users-rest-api
+
+suites:
+  unit:
+    path: .
+
+settings:
+  shuffle: true
+  lint: true
+
+bootstrap: _bootstrap.php
+
+paths:
+  tests: tests
+  output: tests/_output
+  support: tests/_support
+  data: tests/_data
+
+coverage:
+  enabled: true
+  include:
+    - src/*.php
+
+modules:
+  enabled:
+    - \FondOfCodeception\Module\Spryker
+  config:
+    \FondOfCodeception\Module\Spryker:
+      generate_transfer: false
+      generate_map_classes: false
+      generate_propel_classes: false
+      generate_ide_auto_completion: false
+
+env:
+  standalone:
+    modules:
+      config:
+        \FondOfCodeception\Module\Spryker:
+          generate_transfer: true
+          generate_map_classes: true
+          generate_propel_classes: true
+          generate_ide_auto_completion: true
+  monorepo:

composer.json

@@ -0,0 +1,58 @@
+{
+  "name": "fond-of-impala/company-users-rest-api",
+  "description": "Company users rest api module",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Daniel Rose",
+      "email": "daniel-rose@gmx.de"
+    },
+    {
+      "name": "Felix Pfister",
+      "email": "felix@pfister.de"
+    }
+  ],
+  "scripts": {
+    "ci": "make ci",
+    "codeception": "make codeception",
+    "phpcs": "make phpcs",
+    "phpstan": "make phpstan"
+  },
+  "require": {
+    "php": ">=8.0",
+    "fond-of-oryx/company-users-rest-api-extension": "^1.1.0 || ^2.0.0",
+    "fond-of-spryker/company-price-list": "dev-master",
+    "fond-of-spryker/company-user-reference": "dev-master",
+    "spryker/company": "^1.4.0",
+    "spryker/company-business-unit": "^1.0.0 || ^2.0.0",
+    "spryker/company-user": "^2.3.0",
+    "spryker/company-role": "^1.0.0",
+    "spryker/glue-application": "^1.0.0",
+    "spryker/permission": "^1.0.0"
+  },
+  "require-dev": {
+    "fond-of-codeception/spryker": "*",
+    "spryker/code-sniffer": "*",
+    "spryker-sdk/phpstan-spryker": "*"
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "autoload": {
+    "psr-4": {
+      "FondOfImpala\\": "src/FondOfImpala/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "FondOfImpala\\": "tests/FondOfImpala/",
+      "Generated\\": "src/Generated/",
+      "Orm\\Zed\\": "src/Orm/Zed/"
+    }
+  },
+  "config": {
+    "sort-packages": true,
+    "allow-plugins": {
+      "dealerdirect/phpcodesniffer-composer-installer": true
+    }
+  }
+}

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+    level: 5
+    reportUnmatchedIgnoredErrors: false
+    scanDirectories:
+        - src/Orm/Zed
+    ignoreErrors:
+        - '#.* on an unknown class Generated\\(Client|Glue|Service|Yves|Zed)\\.*#'

src/FondOfImpala/Client/CompanyUsersRestApi/CompanyUsersRestApiClient.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace FondOfImpala\Client\CompanyUsersRestApi;
+
+use Generated\Shared\Transfer\CompanyUserCollectionTransfer;
+use Generated\Shared\Transfer\CustomerTransfer;
+use Generated\Shared\Transfer\RestCompanyUsersRequestAttributesTransfer;
+use Generated\Shared\Transfer\RestCompanyUsersResponseTransfer;
+use Generated\Shared\Transfer\RestDeleteCompanyUserRequestTransfer;
+use Generated\Shared\Transfer\RestDeleteCompanyUserResponseTransfer;
+use Generated\Shared\Transfer\RestWriteCompanyUserRequestTransfer;
+use Generated\Shared\Transfer\RestWriteCompanyUserResponseTransfer;
+use Spryker\Client\Kernel\AbstractClient;
+
+/**
+ * @method \FondOfImpala\Client\CompanyUsersRestApi\CompanyUsersRestApiFactory getFactory()
+ */
+class CompanyUsersRestApiClient extends AbstractClient implements CompanyUsersRestApiClientInterface
+{
+    /**
+     * @param \Generated\Shared\Transfer\RestCompanyUsersRequestAttributesTransfer $restCompanyUsersRequestAttributesTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestCompanyUsersResponseTransfer
+     */
+    public function create(
+        RestCompanyUsersRequestAttributesTransfer $restCompanyUsersRequestAttributesTransfer
+    ): RestCompanyUsersResponseTransfer {
+        return $this->getFactory()
+            ->createZedCompanyUsersRestApiStub()
+            ->create($restCompanyUsersRequestAttributesTransfer);
+    }
+
+    /**
+     * @param \Generated\Shared\Transfer\CustomerTransfer $customerTransfer
+     *
+     * @return \Generated\Shared\Transfer\CompanyUserCollectionTransfer
+     */
+    public function findActiveCompanyUsersByCustomerReference(
+        CustomerTransfer $customerTransfer
+    ): CompanyUserCollectionTransfer {
+        return $this->getFactory()
+            ->createZedCompanyUsersRestApiStub()
+            ->findActiveCompanyUsersByCustomerReference($customerTransfer);
+    }
+
+    /**
+     * @param \Generated\Shared\Transfer\RestDeleteCompanyUserRequestTransfer $restDeleteCompanyUserRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestDeleteCompanyUserResponseTransfer
+     */
+    public function deleteCompanyUserByRestDeleteCompanyUserRequest(
+        RestDeleteCompanyUserRequestTransfer $restDeleteCompanyUserRequestTransfer
+    ): RestDeleteCompanyUserResponseTransfer {
+        return $this->getFactory()
+            ->createZedCompanyUsersRestApiStub()
+            ->deleteCompanyUserByRestDeleteCompanyUserRequest($restDeleteCompanyUserRequestTransfer);
+    }
+
+    /**
+     * @param \Generated\Shared\Transfer\RestWriteCompanyUserRequestTransfer $restWriteCompanyUserRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestWriteCompanyUserResponseTransfer
+     */
+    public function updateCompanyUserByRestDeleteCompanyUserRequest(
+        RestWriteCompanyUserRequestTransfer $restWriteCompanyUserRequestTransfer
+    ): RestWriteCompanyUserResponseTransfer {
+        return $this->getFactory()
+            ->createZedCompanyUsersRestApiStub()
+            ->updateCompanyUserByRestWriteCompanyUserRequest($restWriteCompanyUserRequestTransfer);
+    }
+}

src/FondOfImpala/Client/CompanyUsersRestApi/CompanyUsersRestApiClientInterface.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace FondOfImpala\Client\CompanyUsersRestApi;
+
+use Generated\Shared\Transfer\CompanyUserCollectionTransfer;
+use Generated\Shared\Transfer\CustomerTransfer;
+use Generated\Shared\Transfer\RestCompanyUsersRequestAttributesTransfer;
+use Generated\Shared\Transfer\RestCompanyUsersResponseTransfer;
+use Generated\Shared\Transfer\RestDeleteCompanyUserRequestTransfer;
+use Generated\Shared\Transfer\RestDeleteCompanyUserResponseTransfer;
+use Generated\Shared\Transfer\RestWriteCompanyUserRequestTransfer;
+use Generated\Shared\Transfer\RestWriteCompanyUserResponseTransfer;
+
+interface CompanyUsersRestApiClientInterface
+{
+    /**
+     * @param \Generated\Shared\Transfer\RestCompanyUsersRequestAttributesTransfer $restCompanyUsersRequestAttributesTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestCompanyUsersResponseTransfer
+     */
+    public function create(
+        RestCompanyUsersRequestAttributesTransfer $restCompanyUsersRequestAttributesTransfer
+    ): RestCompanyUsersResponseTransfer;
+
+    /**
+     * @param \Generated\Shared\Transfer\CustomerTransfer $customerTransfer
+     *
+     * @return \Generated\Shared\Transfer\CompanyUserCollectionTransfer
+     */
+    public function findActiveCompanyUsersByCustomerReference(
+        CustomerTransfer $customerTransfer
+    ): CompanyUserCollectionTransfer;
+
+    /**
+     * @param \Generated\Shared\Transfer\RestDeleteCompanyUserRequestTransfer $restDeleteCompanyUserRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestDeleteCompanyUserResponseTransfer
+     */
+    public function deleteCompanyUserByRestDeleteCompanyUserRequest(
+        RestDeleteCompanyUserRequestTransfer $restDeleteCompanyUserRequestTransfer
+    ): RestDeleteCompanyUserResponseTransfer;
+
+    /**
+     * @param \Generated\Shared\Transfer\RestWriteCompanyUserRequestTransfer $restWriteCompanyUserRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestWriteCompanyUserResponseTransfer
+     */
+    public function updateCompanyUserByRestDeleteCompanyUserRequest(
+        RestWriteCompanyUserRequestTransfer $restWriteCompanyUserRequestTransfer
+    ): RestWriteCompanyUserResponseTransfer;
+}

src/FondOfImpala/Client/CompanyUsersRestApi/CompanyUsersRestApiDependencyProvider.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace FondOfImpala\Client\CompanyUsersRestApi;
+
+use FondOfImpala\Client\CompanyUsersRestApi\Dependency\Client\CompanyUsersRestApiToZedRequestClientBridge;
+use Spryker\Client\Kernel\AbstractDependencyProvider;
+use Spryker\Client\Kernel\Container;
+
+/**
+ * @codeCoverageIgnore
+ */
+class CompanyUsersRestApiDependencyProvider extends AbstractDependencyProvider
+{
+    /**
+     * @var string
+     */
+    public const CLIENT_ZED_REQUEST = 'CLIENT_ZED_REQUEST';
+
+    /**
+     * @param \Spryker\Client\Kernel\Container $container
+     *
+     * @return \Spryker\Client\Kernel\Container
+     */
+    public function provideServiceLayerDependencies(Container $container): Container
+    {
+        $container = parent::provideServiceLayerDependencies($container);
+
+        return $this->addZedRequestClient($container);
+    }
+
+    /**
+     * @param \Spryker\Client\Kernel\Container $container
+     *
+     * @return \Spryker\Client\Kernel\Container
+     */
+    protected function addZedRequestClient(Container $container): Container
+    {
+        $container[static::CLIENT_ZED_REQUEST] = static function (Container $container) {
+            return new CompanyUsersRestApiToZedRequestClientBridge(
+                $container->getLocator()->zedRequest()->client(),
+            );
+        };
+
+        return $container;
+    }
+}