Merge pull request #79 from buckaroo-it/develop

Develop

.github/index.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License (AFL 3.0)
+ * It is available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/afl-3.0.php
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade this file
+ *
+ *  @author    Buckaroo.nl <[email protected]>
+ *  @copyright Copyright (c) Buckaroo B.V.
+ *  @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ */
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;

.github/workflows/index.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License (AFL 3.0)
+ * It is available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/afl-3.0.php
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade this file
+ *
+ *  @author    Buckaroo.nl <[email protected]>
+ *  @copyright Copyright (c) Buckaroo B.V.
+ *  @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ */
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;

.github/workflows/sonarqube.yml

@@ -0,0 +1,21 @@
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - 'releases/**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+name: SonarQube PR Analysis
+jobs:
+  sonarqube:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: SonarQube Scan
+        uses: sonarsource/sonarqube-scan-action@master
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

.gitignore

@@ -1,2 +1,7 @@
-certificate/BuckarooPrivateKey.pem
-/api/log
+/api/log
+composer.lock
+.php-cs-fixer.cache
+var
+tools
+dev/node_modules
+.idea

.php-cs-fixer.dist.php

@@ -0,0 +1,48 @@
+<?php
+
+ini_set('memory_limit','256M');
+
+$finder = PhpCsFixer\Finder::create()->in([
+    __DIR__,
+])->notPath([
+    'vendor',
+    'dev'
+]);
+
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'array_indentation' => true,
+        'cast_spaces' => [
+            'space' => 'single',
+        ],
+        'combine_consecutive_issets' => true,
+        'concat_space' => [
+            'spacing' => 'one',
+        ],
+        'error_suppression' => [
+            'mute_deprecation_error' => false,
+            'noise_remaining_usages' => false,
+            'noise_remaining_usages_exclude' => [],
+        ],
+        'function_to_constant' => false,
+        'method_chaining_indentation' => true,
+        'no_alias_functions' => false,
+        'no_superfluous_phpdoc_tags' => false,
+        'non_printable_character' => [
+            'use_escape_sequences_in_strings' => true,
+        ],
+        'phpdoc_summary' => false,
+        'protected_to_private' => false,
+        'psr_autoloading' => false,
+        'self_accessor' => false,
+        'yoda_style' => false,
+        'single_line_throw' => false,
+        'no_alias_language_construct_call' => false,
+        'phpdoc_align' => [
+            'align' => 'vertical',
+        ],
+    ])
+    ->setFinder($finder)
+    ->setCacheFile(__DIR__.'/var/.php_cs.cache');

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contribution Guidelines
+
+### Repository setup:
+- Fork the repository to your account.
+- More details about [how to fork a repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) can be found [here](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo).
+
+### Making changes:
+- Create a branch from the develop branch.
+- The name of the branch should be something like: `feature/GITHUB-ISSUE-ID-slug` (eg: `feature/50-configprovider-update`)
+- Your code changes should follow the PrestaShop coding standard.
+- Including unit tests is encouraged.
+
+### Pull Request:
+- Open the PR to develop branch.
+- If there is no issue referenced, add a description about the problem and the way it is being solved.
+- Allow edits from maintainers.

README.md

@@ -1,21 +1,66 @@
-# Buckaroo PrestaShop Extension
+<p align="center">
+  <img src="https://www.buckaroo.nl/media/3474/prestashop_icon.png" width="200px" position="center">
+</p>
 
-### Installation & Configuration 
+# Buckaroo PrestaShop Payments Plugin
+[![Latest release](https://badgen.net/github/release/buckaroo-it/PrestaShop)](https://github.com/buckaroo-it/PrestaShop/releases)
 
-Below you will find a link to the installation and configuration manual of the Buckaroo PrestaShop extension. This will provide you a step-by-step description of how you can install the extension on your environment.
+### Index
+- [About](#about)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Contribute](#contribute)
+- [Versioning](#versioning)
+- [Additional information](#additional-information)
+---
 
-https://support.buckaroo.nl/categorieen/plugins/prestashop
+### About
 
-### Additional information
+PrestaShop started in 2005 as a student project. It was originally named phpOpenStore.
+Between May 2010 and April 2012, PrestaShop grew from 17 employees to more than a hundred. As of April 2016, PrestaShop has over 120 employees and offices in 6 countries.
+PrestaShop is currently used by more then 300,000 shops worldwide and it is available in 60 different languages.
+
+The Buckaroo PrestaShop Payments Plugin ([Dutch](https://support.buckaroo.nl/categorieen/plugins/prestashop) or [English](https://support.buckaroo.eu/categories/plugins)) is convenient and works like a charm, it's easy to install and takes all the trouble out of your hands. It is a plugin with many different payment methods, all of which are SEPA proof. Last but not least the plugin is completely free to download as well.
+
+### Requirements
+
+To use the Buckaroo plugin, please be aware of the following minimum requirements:
+- A Buckaroo account ([Dutch](https://www.buckaroo.nl/start) or [English](https://www.buckaroo.eu/solutions/request-form))
+- PrestaShop 1.7.x or 8.1.2
+- PHP 7.4 or higher
+
+### Installation
 
-Release notes:
+1.  Go to our  [PrestaShop Github repository](https://github.com/buckaroo-it/PrestaShop)  and go to →  [Releases](https://github.com/buckaroo-it/PrestaShop/releases).
+2.  Click on the latest  **Buckaroo plugin version**  and download the →  **.ZIP file**.
+3.  Now login to your  **PrestaShop backend**  and go to →  **Modules**  →  **Module Manager**  →  **Upload Module**  → and select the downloaded .ZIP file of the Buckaroo plugin to upload it (the installation will start automatically.)
+4.  The Buckaroo plugin will be visible once the installation is completed.
+In your  **Plugin Manager**  tab it will appear at the  **Payment**  section.
 
-https://support.buckaroo.nl/categorie%C3%ABn/plugins/prestashop/release-notes
+### Configuration
 
-Knowledge base & FAQ:
+For the configuration of the plugin, please refer to our [Dutch](https://support.buckaroo.nl/categorieen/plugins/prestashop) or [English](https://support.buckaroo.eu/categories/plugins) support website. You'll find all the needed information there.
+You can also contact our [technical support department](mailto:[email protected]) if you still have some unanswered questions.
 
-https://support.buckaroo.nl/categorie%C3%ABn/plugins/prestashop
+### Contribute
 
-Support:
+We really appreciate it when developers contribute to improve the Buckaroo plugins.
+If you want to contribute as well, then please follow our [Contribution Guidelines](CONTRIBUTING.md).
+
+### Versioning 
+<p align="left">
+  <img src="https://www.buckaroo.nl/media/3483/prestashop_versioning.png" width="500px" position="center">
+</p>
+
+- **MAJOR:** Breaking changes that require additional testing/caution.
+- **MINOR:** Changes that should not have a big impact.
+- **PATCHES:** Bug and hotfixes only.
+
+### Additional information
+- **Knowledge base & FAQ:** Available in [Dutch](https://support.buckaroo.nl/categorieen/plugins/prestashop) or [English](https://support.buckaroo.eu/categories/plugins).
+- **Support:** https://support.buckaroo.eu/contact
+- **Contact:** [[email protected]](mailto:[email protected]) or [+31 (0)30 711 50 50](tel:+310307115050)
 
-https://support.buckaroo.nl/contact
+<b>Please note:</b><br>
+This file has been prepared with the greatest possible care and is subject to language and/or spelling errors.