✨ Trade fair representative (#398)

📦 add package structure for RepresentativeCompanyUserTradeFairRestApi
📦 add package structure for RepresentativeCompanyUserTradeFair

Co-authored-by: Jozsef Geng <jozsef.geng@fondof.de>
Co-authored-by: Julian Hyatt <dev@jzit.de>

.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,6 @@
+.idea
+
+.DS_Store
+
+vendor
+composer.lock

LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 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,22 @@
+.PHONY: install
+install:
+	composer install
+
+.PHONY: phpcs
+phpcs:
+	./vendor/bin/phpcs --standard=./vendor/spryker/code-sniffer/Spryker/ruleset.xml ./src/FondOfOryx/* ./tests/*
+
+.PHONY: phpcbf
+phpcbf:
+	./vendor/bin/phpcbf --standard=./vendor/spryker/code-sniffer/Spryker/ruleset.xml ./src/FondOfOryx/* ./tests/*
+
+.PHONY: phpstan
+phpstan:
+	./vendor/bin/phpstan --memory-limit=-1 analyse ./src/FondOfOryx ./tests
+
+.PHONY: codeception
+codeception:
+	./vendor/bin/codecept run --env standalone
+
+.PHONY: ci
+ci: phpcs codeception phpstan

README.md

@@ -0,0 +1,8 @@
+# Representative Company User Trade Fair Rest Api
+[![CI](https://github.com/fond-of-oryx/representative-company-user-trade-fair-rest-api/actions/workflows/main.yml/badge.svg)](https://github.com/fond-of-oryx/representative-company-user-trade-fair-rest-api/actions/workflows/main.yml)
+[![license](https://img.shields.io/github/license/fond-of-oryx/representative-company-user-trade-fair-rest-api.svg)](https://packagist.org/packages/fond-of-oryx/representative-company-user-trade-fair-rest-api)
+
+## Installation
+```
+composer require fond-of-oryx/representative-company-user-trade-fair-rest-api
+```

codeception.yml

@@ -0,0 +1,43 @@
+namespace: fond-of-oryx/representative-company-user-trade-fair-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,42 @@
+{
+  "name": "fond-of-oryx/representative-company-user-trade-fair-rest-api",
+  "description": "Representative Company User Trade Fair Rest Api",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Julian Hyatt",
+      "email": "dev@jzit.de"
+    }
+  ],
+  "require": {
+    "php": ">=8.0",
+    "fond-of-oryx/representative-company-user-trade-fair": "^1.0.0",
+    "fond-of-spryker/company-type": "dev-master",
+    "spryker/glue-application": "*"
+  },
+  "require-dev": {
+    "fond-of-codeception/spryker": "*",
+    "spryker/code-sniffer": "*",
+    "spryker-sdk/phpstan-spryker": "*"
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "autoload": {
+    "psr-4": {
+      "FondOfOryx\\": "src/FondOfOryx/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "FondOfOryx\\": "tests/FondOfOryx/",
+      "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/FondOfOryx/Client/RepresentativeCompanyUserTradeFairRestApi/Dependency/Client/RepresentativeCompanyUserTradeFairRestApiToZedRequestClientBridge.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace FondOfOryx\Client\RepresentativeCompanyUserTradeFairRestApi\Dependency\Client;
+
+use Spryker\Client\ZedRequest\ZedRequestClientInterface;
+use Spryker\Shared\Kernel\Transfer\TransferInterface;
+
+class RepresentativeCompanyUserTradeFairRestApiToZedRequestClientBridge implements RepresentativeCompanyUserTradeFairRestApiToZedRequestClientInterface
+{
+    /**
+     * @var \Spryker\Client\ZedRequest\ZedRequestClientInterface
+     */
+    protected $zedRequestClient;
+
+    /**
+     * @param \Spryker\Client\ZedRequest\ZedRequestClientInterface $zedRequestClient
+     */
+    public function __construct(ZedRequestClientInterface $zedRequestClient)
+    {
+        $this->zedRequestClient = $zedRequestClient;
+    }
+
+    /**
+     * @param string $url
+     * @param \Spryker\Shared\Kernel\Transfer\TransferInterface $object
+     * @param array|null $requestOptions
+     *
+     * @return \Spryker\Shared\Kernel\Transfer\TransferInterface
+     */
+    public function call(string $url, TransferInterface $object, ?array $requestOptions = null): TransferInterface
+    {
+        return $this->zedRequestClient->call($url, $object, $requestOptions);
+    }
+}

src/FondOfOryx/Client/RepresentativeCompanyUserTradeFairRestApi/Dependency/Client/RepresentativeCompanyUserTradeFairRestApiToZedRequestClientInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace FondOfOryx\Client\RepresentativeCompanyUserTradeFairRestApi\Dependency\Client;
+
+use Spryker\Shared\Kernel\Transfer\TransferInterface;
+
+interface RepresentativeCompanyUserTradeFairRestApiToZedRequestClientInterface
+{
+    /**
+     * @param string $url
+     * @param \Spryker\Shared\Kernel\Transfer\TransferInterface $object
+     * @param array|null $requestOptions
+     *
+     * @return \Spryker\Shared\Kernel\Transfer\TransferInterface
+     */
+    public function call(string $url, TransferInterface $object, ?array $requestOptions = null): TransferInterface;
+}

src/FondOfOryx/Client/RepresentativeCompanyUserTradeFairRestApi/RepresentativeCompanyUserTradeFairRestApiClient.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace FondOfOryx\Client\RepresentativeCompanyUserTradeFairRestApi;
+
+use Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer;
+use Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer;
+use Spryker\Client\Kernel\AbstractClient;
+
+/**
+ * @method \FondOfOryx\Client\RepresentativeCompanyUserTradeFairRestApi\RepresentativeCompanyUserTradeFairRestApiFactory getFactory()
+ */
+class RepresentativeCompanyUserTradeFairRestApiClient extends AbstractClient implements RepresentativeCompanyUserTradeFairRestApiClientInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function addTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer {
+        return $this->getFactory()->createZedRepresentativeCompanyUserTradeFairRestApiStub()->addTradeFairRepresentation($restRepresentativeCompanyUserTradeFairRequestTransfer);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function getTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer {
+        return $this->getFactory()->createZedRepresentativeCompanyUserTradeFairRestApiStub()->getTradeFairRepresentation($restRepresentativeCompanyUserTradeFairRequestTransfer);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function patchTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer {
+        return $this->getFactory()->createZedRepresentativeCompanyUserTradeFairRestApiStub()->patchTradeFairRepresentation($restRepresentativeCompanyUserTradeFairRequestTransfer);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function deleteTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer {
+        return $this->getFactory()->createZedRepresentativeCompanyUserTradeFairRestApiStub()->deleteTradeFairRepresentation($restRepresentativeCompanyUserTradeFairRequestTransfer);
+    }
+}

src/FondOfOryx/Client/RepresentativeCompanyUserTradeFairRestApi/RepresentativeCompanyUserTradeFairRestApiClientInterface.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace FondOfOryx\Client\RepresentativeCompanyUserTradeFairRestApi;
+
+use Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer;
+use Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer;
+
+interface RepresentativeCompanyUserTradeFairRestApiClientInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function addTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function getTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function patchTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * @param \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+     *
+     * @return \Generated\Shared\Transfer\RestRepresentativeCompanyUserTradeFairResponseTransfer
+     */
+    public function deleteTradeFairRepresentation(
+        RestRepresentativeCompanyUserTradeFairRequestTransfer $restRepresentativeCompanyUserTradeFairRequestTransfer
+    ): RestRepresentativeCompanyUserTradeFairResponseTransfer;
+}