♻️ fond-of-spryker navision bundles migration (#189)

* ♻️ migrate fond-of-spryker/navision-company
* ♻️ migrate fond-of-spryker/navision-company-business-unit
* ♻️ migrate fond-of-spryker/navision-company-rest-api
* ♻️ migrate fond-of-spryker/navision-company-uni-address
* ♻️ migrate fond-of-spryker/navision-company-user

.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,11 @@
+# Navision Compoany Module
+[![CI](https://github.com/fond-of-impala/navision-company/actions/workflows/main.yml/badge.svg)](https://github.com/fond-of-impala/navision-company/actions/workflows/main.yml)
+[![license](https://img.shields.io/github/license/fond-of-impala/navision-company.svg)](https://packagist.org/packages/fond-of-impala/navision-company)
+
+Package was migrated from `fond-of-spryker/navision-company`
+
+## Installation
+
+```
+composer require fond-of-impala/navision-company
+```

codeception.yml

@@ -0,0 +1,43 @@
+namespace: fond-of-impala/navision-company
+
+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,48 @@
+{
+  "name": "fond-of-impala/navision-company",
+  "description": "Navision company module",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Daniel Rose",
+      "email": "daniel-rose@gmx.de"
+    }
+  ],
+  "scripts": {
+    "ci": "make ci",
+    "codeception": "make codeception",
+    "phpcs": "make phpcs",
+    "phpstan": "make phpstan"
+  },
+  "require": {
+    "php": ">=8.0",
+    "spryker/checkout-extension": "^1.2.0",
+    "spryker/company-extension": "^1.0.0",
+    "spryker/quote-extension": "^1.2.0",
+    "spryker/zed-request": "^3.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\\": "src/Orm/"
+    }
+  },
+  "config": {
+    "allow-plugins": {
+      "dealerdirect/phpcodesniffer-composer-installer": true
+    }
+  }
+}

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    level: 5
+    reportUnmatchedIgnoredErrors: false
+    scanDirectories:
+        - src/Orm/Zed

src/FondOfImpala/Client/NavisionCompany/Dependency/Client/NavisionCompanyToZedRequestClientBridge.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace FondOfImpala\Client\NavisionCompany\Dependency\Client;
+
+use Spryker\Shared\Kernel\Transfer\TransferInterface;
+
+class NavisionCompanyToZedRequestClientBridge implements NavisionCompanyToZedRequestClientInterface
+{
+    /**
+     * @var \Spryker\Client\ZedRequest\ZedRequestClientInterface
+     */
+    protected $zedRequestClient;
+
+    /**
+     * @param \Spryker\Client\ZedRequest\ZedRequestClientInterface $zedRequestClient
+     */
+    public function __construct($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/FondOfImpala/Client/NavisionCompany/Dependency/Client/NavisionCompanyToZedRequestClientInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace FondOfImpala\Client\NavisionCompany\Dependency\Client;
+
+use Spryker\Shared\Kernel\Transfer\TransferInterface;
+
+interface NavisionCompanyToZedRequestClientInterface
+{
+    /**
+     * @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/FondOfImpala/Client/NavisionCompany/NavisionCompanyClient.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace FondOfImpala\Client\NavisionCompany;
+
+use Generated\Shared\Transfer\CompanyResponseTransfer;
+use Generated\Shared\Transfer\CompanyTransfer;
+use Spryker\Client\Kernel\AbstractClient;
+
+/**
+ * @method \FondOfImpala\Client\NavisionCompany\NavisionCompanyFactory getFactory()
+ */
+class NavisionCompanyClient extends AbstractClient implements NavisionCompanyClientInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @api
+     *
+     * {@internal will work if external reference field is provided.}
+     *
+     * @param \Generated\Shared\Transfer\CompanyTransfer $companyTransfer
+     *
+     * @return \Generated\Shared\Transfer\CompanyResponseTransfer
+     */
+    public function findCompanyByExternalReference(CompanyTransfer $companyTransfer): CompanyResponseTransfer
+    {
+        return $this->getFactory()->createZedNavisionCompanyStub()
+            ->findCompanyByExternalReference($companyTransfer);
+    }
+}

src/FondOfImpala/Client/NavisionCompany/NavisionCompanyClientInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace FondOfImpala\Client\NavisionCompany;
+
+use Generated\Shared\Transfer\CompanyResponseTransfer;
+use Generated\Shared\Transfer\CompanyTransfer;
+
+interface NavisionCompanyClientInterface
+{
+    /**
+     * Specification:
+     * - Finds a company by external reference.
+     * - Makes zed request.
+     * - Requires external reference field to be set in CompanyTransfer taken as parameter.
+     *
+     * @api
+     *
+     * {@internal will work if external reference field is provided.}
+     *
+     * @param \Generated\Shared\Transfer\CompanyTransfer $companyTransfer
+     *
+     * @return \Generated\Shared\Transfer\CompanyResponseTransfer
+     */
+    public function findCompanyByExternalReference(CompanyTransfer $companyTransfer): CompanyResponseTransfer;
+}

src/FondOfImpala/Client/NavisionCompany/NavisionCompanyDependencyProvider.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace FondOfImpala\Client\NavisionCompany;
+
+use FondOfImpala\Client\NavisionCompany\Dependency\Client\NavisionCompanyToZedRequestClientBridge;
+use Spryker\Client\Kernel\AbstractDependencyProvider;
+use Spryker\Client\Kernel\Container;
+
+class NavisionCompanyDependencyProvider 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 fn (Container $container): NavisionCompanyToZedRequestClientBridge => new NavisionCompanyToZedRequestClientBridge($container->getLocator()->zedRequest()->client());
+
+        return $container;
+    }
+}

src/FondOfImpala/Client/NavisionCompany/NavisionCompanyFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace FondOfImpala\Client\NavisionCompany;
+
+use FondOfImpala\Client\NavisionCompany\Dependency\Client\NavisionCompanyToZedRequestClientInterface;
+use FondOfImpala\Client\NavisionCompany\Zed\NavisionCompanyStub;
+use FondOfImpala\Client\NavisionCompany\Zed\NavisionCompanyStubInterface;
+use Spryker\Client\Kernel\AbstractFactory;
+
+class NavisionCompanyFactory extends AbstractFactory
+{
+    /**
+     * @return \FondOfImpala\Client\NavisionCompany\Zed\NavisionCompanyStubInterface
+     */
+    public function createZedNavisionCompanyStub(): NavisionCompanyStubInterface
+    {
+        return new NavisionCompanyStub($this->getZedRequestClient());
+    }
+
+    /**
+     * @return \FondOfImpala\Client\NavisionCompany\Dependency\Client\NavisionCompanyToZedRequestClientInterface
+     */
+    protected function getZedRequestClient(): NavisionCompanyToZedRequestClientInterface
+    {
+        return $this->getProvidedDependency(NavisionCompanyDependencyProvider::CLIENT_ZED_REQUEST);
+    }
+}