feat: Initial Commit

Author: clivewalkden

.github/workflows/main.yml

@@ -0,0 +1,79 @@
+name: m2-test
+
+on: [push]
+
+env:
+  MODULE: Sozo_Feedbucket
+
+jobs:
+  magento2-build:
+    runs-on: ubuntu-latest
+    container: ubuntu
+    name: 'Magento 2 Build and Test'
+    services:
+      mysql:
+        image: docker://mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: magento
+          MYSQL_DATABASE: magento
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+      elasticsearch:
+        image: docker://elasticsearch:7.1.0
+        ports:
+          - 9200:9200
+        options: -e="discovery.type=single-node" --health-cmd="curl http://localhost:9200/_cluster/health" --health-interval=10s --health-timeout=5s --health-retries=10
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          path: ${{ env.MODULE }}
+
+      - name: 'Install fresh Magento instance'
+        uses: MAD-I-T/magento-actions@master
+        env:
+          COMPOSER_AUTH: ${{secrets.COMPOSER_AUTH}}
+        with:
+          process: 'install-magento'
+          magento_version: '2.4.6'
+          no_push: 1 ## add this arg to not push to the repo ideal for quick test on specific version
+
+      - name: 'Launch Magento 2 Unit Test'
+        if: always()
+        uses: MAD-I-T/magento-actions@master
+        env:
+          COMPOSER_AUTH: ${{secrets.COMPOSER_AUTH}}
+        with:
+          process: 'unit-test'
+          unit_test_config: 'dev/tests/unit/phpunit.xml.dist'
+          unit_test_subset_path: "../${{ env.MODULE }}/"
+
+      - name: 'phpstan'
+        if: always()
+        uses: MAD-I-T/magento-actions@master
+        env:
+          COMPOSER_AUTH: ${{secrets.COMPOSER_AUTH}}
+        with:
+          process: 'phpstan'
+          exec_path: "../${{ env.MODULE }}/"
+
+      - name: 'Mess Detector'
+        if: always()
+        uses: MAD-I-T/magento-actions@master
+        env:
+          COMPOSER_AUTH: ${{secrets.COMPOSER_AUTH}}
+        with:
+          process: 'mess-detector'
+          md_src_path: "../${{ env.MODULE }}/"
+
+      - name: 'Magento coding standard checking'
+        if: always()
+        uses: MAD-I-T/magento-actions@master
+        env:
+          COMPOSER_AUTH: ${{secrets.COMPOSER_AUTH}}
+        with:
+          process: 'phpcs-test'
+          extension: ${{ env.MODULE }}
+          severity: 10
+          standard: 'Magento2'

.gitignore

@@ -0,0 +1,37 @@
+# Created by .ignore support plugin (hsz.mobi)
+
+### SublimeText template
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+/.idea
+
+/.github/workflows/secrets/

.scrutinizer.yml

@@ -0,0 +1,20 @@
+checks:
+  php:
+    code_rating: true
+    duplication: true
+    excluded_dependencies:
+      - magento/framework
+
+filter:
+  excluded_paths:
+    - "Test/"
+
+build:
+  dependencies:
+    before:
+      - 'echo "{\"http-basic\":{\"repo.magento.com\":{\"username\":\"${MAGENTO_COMPOSER_USERNAME}\",\"password\":\"${MAGENTO_COMPOSER_PASSWORD}\"}}}" > auth.json'
+      - 'composer config allow-plugins true'
+
+  environment:
+    php:
+      version: 7.4.33

.styleci.yml

@@ -0,0 +1,11 @@
+risky: false
+version: 7.4
+preset: psr12
+tab-width: 4
+use-tabs: false
+finder:
+  exclude:
+    - "vendor"
+  name: "*.php"
+  not-name:
+    - "*.phtml"

Block/Backend.php

@@ -0,0 +1,98 @@
+<?php
+/*
+ * SOZO Design Ltd
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.
+ * It is also available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ *
+ * @category    SOZO Design Ltd
+ * @package     Sozo_Feedbucket
+ * @copyright   Copyright (c) SOZO Design Ltd (https://sozodesign.co.uk)
+ * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Sozo\Feedbucket\Block;
+
+use Sozo\Feedbucket\Model\ConfigProvider;
+use Sozo\Feedbucket\Service\IpCheckerService;
+use Magento\Backend\Model\Auth\Session;
+use Magento\Framework\App\State;
+use Magento\Framework\View\Element\Template\Context;
+
+class Backend extends Display
+{
+    /**
+     * @var Session
+     */
+    private $authSession;
+
+    /**
+     * @param Context $context
+     * @param ConfigProvider $configProvider
+     * @param IpCheckerService $ipCheckerService
+     * @param State $state
+     * @param Session $authSession
+     * @param array $data
+     */
+    public function __construct(
+        Context $context,
+        ConfigProvider $configProvider,
+        IpCheckerService $ipCheckerService,
+        State $state,
+        Session $authSession,
+        array $data = []
+    ) {
+        parent::__construct($context, $configProvider, $ipCheckerService, $state, $data);
+        $this->authSession = $authSession;
+    }
+
+    /**
+     * Return current admin user information
+     *
+     * @return \Magento\User\Model\User|null
+     */
+    protected function getCurrentUser(): ?\Magento\User\Model\User
+    {
+        return $this->authSession->getUser();
+    }
+
+    /**
+     * @inheritdoc
+     *
+     * @return array|array[]
+     */
+    public function prepareConfig(): array
+    {
+        $config = parent::prepareConfig();
+        if ($this->getCurrentUser() && $this->configProvider->isBackendCaptureUserData()) {
+            $config['reporter'] = [
+                'name' => $this->getCurrentUser()->getName(),
+                'email' => $this->getCurrentUser()->getEmail(),
+            ];
+
+            $config['reporter']['token'] = $this->configProvider->getUserHash($config['reporter']);
+        }
+
+        return $this->jsConfig = array_merge($this->jsConfig, $config);
+    }
+
+    /**
+     * @inheritdoc
+     *
+     * @return string
+     */
+    public function _toHtml(): string
+    {
+        if ($this->configProvider->isBackendEnabled()) {
+            return parent::_toHtml();
+        }
+
+        return '';
+    }
+}

Block/Display.php

@@ -0,0 +1,120 @@
+<?php
+/*
+ * SOZO Design Ltd
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.
+ * It is also available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ *
+ * @category    SOZO Design Ltd
+ * @package     Sozo_Feedbucket
+ * @copyright   Copyright (c) SOZO Design Ltd (https://sozodesign.co.uk)
+ * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Sozo\Feedbucket\Block;
+
+use Sozo\Feedbucket\Model\ConfigProvider;
+use Sozo\Feedbucket\Service\IpCheckerService;
+use Magento\Framework\App\State;
+use Magento\Framework\View\Element\Template;
+use Magento\Framework\View\Element\Template\Context;
+
+class Display extends Template
+{
+    /**
+     * @var ConfigProvider
+     */
+    protected $configProvider;
+
+    /**
+     * @var IpCheckerService
+     */
+    protected $ipChecker;
+    /**
+     * @var State
+     */
+    private $state;
+
+    /**
+     * @var array
+     */
+    protected $jsConfig = [];
+
+    /**
+     * @param Context $context
+     * @param ConfigProvider $configProvider
+     * @param IpCheckerService $ipCheckerService
+     * @param State $state
+     * @param array $data
+     */
+    public function __construct(
+        Context $context,
+        ConfigProvider $configProvider,
+        IpCheckerService $ipCheckerService,
+        State $state,
+        array $data = []
+    ) {
+        $this->configProvider = $configProvider;
+        $this->ipChecker = $ipCheckerService;
+        $this->state = $state;
+
+        parent::__construct($context, $data);
+    }
+
+    /**
+     * Get the Widget ID
+     *
+     * @return string|null
+     */
+    public function getSecret(): ?string
+    {
+        return $this->configProvider->getSecret();
+    }
+
+    /**
+     * Prepare the api configuration
+     *
+     * @return array[]
+     */
+    public function prepareConfig(): array
+    {
+        $config = [
+            'custom' => [
+                'capturedBy' => 'Magento 2 Feedbucket Module: ' . $this->configProvider->getExtensionVersion(),
+                'magentoDeployMode' => $this->state->getMode()
+            ]
+        ];
+
+        return $this->jsConfig = $config;
+    }
+
+    /**
+     * Return the JSON encoded api configuration
+     *
+     * @return string
+     */
+    public function getJsConfig(): string
+    {
+        $this->prepareConfig();
+        return json_encode($this->jsConfig, JSON_FORCE_OBJECT);
+    }
+
+    /**
+     * Generate the Feedbucket output
+     *
+     * @return string
+     */
+    public function _toHtml(): string
+    {
+        $enabled = $this->configProvider->isEnabled();
+        $ipAllowed = $this->ipChecker->checkAllowed();
+
+        return ($enabled && $ipAllowed) ? parent::_toHtml() : '';
+    }
+}