Cloud Integration (#5)

- Move repository files to root
- Move di.xml file to root of etc
- Move to factory pattern for Upward Conroller
- Move configuration to standard Magento configuration settings

Author: bbatsche

.gitignore

@@ -1 +1,3 @@
 .idea
+composer.lock
+vendor

app/code/Magento/UpwardConnector/Controller/Upward.php renamed to Controller/Upward.php

@@ -11,7 +11,6 @@
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\HTTP\PhpEnvironment\Response;
-use Magento\Upward\Controller as UpwardController;
 use Zend\Http\Response\Stream;
 
 class Upward implements FrontControllerInterface
@@ -22,20 +21,18 @@ class Upward implements FrontControllerInterface
     private $response;
 
     /**
-     * @var UpwardController
+     * @var UpwardControllerFactory
      */
-    private $upwardController;
+    private $upwardFactory;
 
     /**
      * @param Response $response
-     * @param UpwardController $upwardController
+     * @param UpwardControllerFactory $upwardFactory
      */
-    public function __construct(
-        Response $response,
-        UpwardController $upwardController
-    ) {
+    public function __construct(Response $response, UpwardControllerFactory $upwardFactory)
+    {
         $this->response = $response;
-        $this->upwardController = $upwardController;
+        $this->upwardFactory = $upwardFactory;
     }
 
     /**
@@ -47,11 +44,13 @@ public function __construct(
     public function dispatch(RequestInterface $request)
     {
         /** @var \Zend\Http\Response $upwardResponse */
-        $upwardResponse = ($this->upwardController)();
+        $upwardResponse = $this->upwardFactory->create($request)();
         $content = $upwardResponse instanceof Stream ? $upwardResponse->getBody() : $upwardResponse->getContent();
+
         $this->response->setHeaders($upwardResponse->getHeaders());
         $this->response->setStatusCode($upwardResponse->getStatusCode());
         $this->response->setContent($content);
+
         return $this->response;
     }
 }

Controller/UpwardControllerFactory.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\UpwardConnector\Controller;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Upward\Controller as UpwardController;
+
+class UpwardControllerFactory
+{
+    /**
+     * Config path where UPWARD config file path is found.
+     */
+    public const UPWARD_CONFIG_PATH = 'web/upward/path';
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $config;
+
+    /**
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * @param ObjectManagerInterface $objectManager
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(ObjectManagerInterface $objectManager, ScopeConfigInterface $scopeConfig)
+    {
+        $this->objectManager = $objectManager;
+        $this->config = $scopeConfig;
+    }
+
+    /**
+     * Create new UPWARD PHP controller for Request
+     *
+     * @param RequestInterface $request
+     *
+     * @return UpwardController
+     */
+    public function create(RequestInterface $request): UpwardController
+    {
+        $upwardConfig = $this->scopeConfig->getValue(
+            static::UPWARD_CONFIG_PATH,
+            ScopeConfigInterface::SCOPE_TYPE_DEFAULT
+        );
+
+        if (empty($upwardConfig)) {
+            throw new \RuntimeException('Path to UPWARD configuration file not set.');
+        }
+
+        return $this->objectManager->create(UpwardController::class, compact('request', 'upwardConfig'));
+    }
+}

app/code/Magento/UpwardConnector/LICENSE.txt renamed to LICENSE.txt

@@ -1 +1 @@
-# magento2-upward-connector
+Magento_UpwardConnector module used for correctly routing frontend requests through UPWARD-PHP.

app/code/Magento/UpwardConnector/LICENSE_AFL.txt renamed to LICENSE_AFL.txt

@@ -12,7 +12,7 @@
     },
     "require": {
         "php": "~7.1.3||~7.2.0",
-        "magento/framework": "*",
+        "magento/framework": "^102.0",
         "magento/upward": "dev-master"
     },
     "type": "magento2-module",

README.md

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="web">
+            <group id="upward" translate="label" type="text" sortOrder="300"
+                showInDefault="1" showInWebsite="0" showInStore="0">
+                <label>UPWARD Configuration</label>
+                <field id="config_path" type="text" translate="label,comment"
+                    sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0">
+                    <label>UPWARD Config File</label>
+                    <config_path>web/upward/path</config_path>
+                    <comment>Server path to YAML configuration file for UPWARD</comment>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>