Merge pull request #17 from Oefenweb/cs-fixes

URL changes from HTTP to HTTPS

Author: tersmitten

.travis.yml

@@ -3,32 +3,36 @@ language: php
 sudo: false
 
 php:
-  - 7.0
   - 7.1
+  - 7.2
+  - 7.3
+  - 7.4
 
 env:
   global:
-    - CAKE_VERSION=^3.0.0
-
-  matrix:
-    - CAKE_VERSION=~3.4.0
-    - CAKE_VERSION=~3.5.0
+    - CAKE_VERSION=^3.8.0
 
 matrix:
   include:
-    - php: 7.1
+    - php: 7.2
       env:
         - PHP_SYNTAX=1
-    - php: 7.1
+    - php: 7.2
       env:
         - PHP_CS=1
-    - php: 7.1
+    - php: 7.2
       env:
         - PHP_CPD=1
-    - php: 7.1
+    - php: 7.2
       env:
         - PHP_MD=1
-    - php: 7.1
+    - php: 7.2
+      env:
+        - PHP_STAN=1
+    - php: 7.2
+      env:
+        - PHP_PHAN=1
+    - php: 7.2
       env:
         - PHP_COVERAGE=1
 
@@ -39,16 +43,10 @@ branches:
     - 3.x
 
 before_script:
-  - travis_wait ./.travis/before-script.sh
+  - ./.travis/before-script.sh
 
 script:
   - ./.travis/script.sh
 
 after_success:
   - ./.travis/after-success.sh
-
-notifications:
-  email: false
-  hipchat:
-    rooms:
-      secure: B46Xvke4nkoN+ivLs0Ubn64rAKOQplqDwLoE9KZDJ6O0XxiAZIZoNXcrGovP+qAB8LHRbGZvOUG4u+YZt9I41bgBAuCM2wZTFJe85IzLjROLxlSXwKDH4tey31omYTSYFKm7Tg9Gi2a6hyGN/YDytiUlmJqUvElcN0EUfkXzxS4=

.travis/before-script.sh

@@ -17,6 +17,11 @@ elif [ "${PHP_CPD}" = '1' ]; then
     exit 0;
 elif [ "${PHP_MD}" = '1' ]; then
     exit 0;
+elif [ "${PHP_STAN}" = '1' ]; then
+    exit 0;
+elif [ "${PHP_PHAN}" = '1' ]; then
+    pecl install ast;
+    exit 0;
 fi
 
 composer require "cakephp/cakephp:${CAKE_VERSION}"  --dev --no-ansi --no-progress --no-interaction;

.travis/script.sh

@@ -30,6 +30,10 @@ elif [ "${PHP_MD}" = '1' ]; then
     excludePathsJoined=${excludePathsJoined:1};
 
     vendor/bin/phpmd . text phpmd.xml --suffixes php --exclude "${excludePathsJoined}";
+elif [ "${PHP_STAN}" = '1' ]; then
+    vendor/bin/phpstan analyse -c phpstan.neon -l 7 src/;
+elif [ "${PHP_PHAN}" = '1' ]; then
+    vendor/bin/phan;
 elif [ "${PHP_COVERAGE}" = '1' ]; then
     vendor/bin/phpunit --coverage-clover=clover.xml;
 else

composer.json

@@ -14,29 +14,38 @@
         }
     ],
     "require": {
-        "php": ">=7.0.0",
+        "php": ">=7.1",
+        "cakephp/cakephp": "^3.8",
+        "ext-soap": "*",
         "composer/installers": "~1.0"
     },
     "require-dev": {
         "oefenweb/cakephp-codesniffer": "^3.0.0",
-        "phpunit/phpunit": "^5.7|^6.0",
         "phpmd/phpmd": "^2.6",
-        "sebastian/phpcpd": "^3.0"
-    },
-    "support": {
-        "source": "https://github.com/Oefenweb/cakephp-vat-number-check",
-        "issues": "https://github.com/Oefenweb/cakephp-vat-number-check/issues"
+        "phpstan/phpstan": "^0.12",
+        "phpunit/phpunit": "^5.7.14|^6.0",
+        "psy/psysh": "@stable",
+        "sebastian/phpcpd": "^3.0",
+        "phan/phan": "^1.3"
     },
     "autoload": {
         "psr-4": {
-            "VatNumberCheck\\": "src"
+            "VatNumberCheck\\": "src",
+            "VatNumberCheck\\Test\\Fixture\\": "tests/Fixture/"
         }
     },
     "autoload-dev": {
         "psr-4": {
+            "VatNumberCheck\\Test\\TestApp\\": "tests/test_app/TestApp",
             "VatNumberCheck\\Test\\": "tests",
-            "VatNumberCheck\\Test\\TestApp\\": "tests/test_app/src",
             "Cake\\Test\\": "./vendor/cakephp/cakephp/tests"
         }
+    },
+    "support": {
+        "issues": "https://github.com/Oefenweb/cakephp-vat-number-check/issues",
+        "source": "https://github.com/Oefenweb/cakephp-vat-number-check"
+    },
+    "extra": {
+        "installer-name": "VatNumberCheck"
     }
 }

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    autoload_files:
+        - tests/bootstrap.php
+    ignoreErrors:
+        - message: '#Cannot cast array\|string\|null to string.#'
+          path: src/Controller/VatNumberChecksController.php

src/Controller/AppController.php

@@ -1,22 +1,23 @@
 <?php
 namespace VatNumberCheck\Controller;
 
+use Cake\Controller\Controller as BaseController;
 use Cake\Event\Event;
-use Cake\Network\Exception\InternalErrorException;
+use Cake\Http\Exception\InternalErrorException;
 use VatNumberCheck\Utility\Model\VatNumberCheck;
 
 /**
  * VatNumberChecks Controller.
  *
  * @property \Cake\Controller\Component\RequestHandlerComponent $RequestHandler
- * @property \TextRenderers\Utility\Model\VatNumberCheck $VatNumberCheck
+ * @property \VatNumberCheck\Utility\Model\VatNumberCheck $VatNumberCheck
  */
-class VatNumberChecksController extends AppController
+class VatNumberChecksController extends BaseController
 {
     /**
      * An array of names of components to load.
      *
-     * @var array
+     * @var array<int,string>
      */
     public $components = ['RequestHandler'];
 
@@ -36,14 +37,13 @@ public function initialize()
      * Before action logic.
      *
      * @param \Cake\Event\Event $event The beforeRender event.
-     * @return \Cake\Network\Response|null|void
-     * @throws \Cake\Network\Exception\BadRequestException
+     * @return \Cake\Http\Response|void
      */
     public function beforeFilter(Event $event)
     {
         parent::beforeFilter($event);
 
-        if (in_array($this->request->action, ['check'], true)) {
+        if (in_array($this->request->getParam('action'), ['check'], true)) {
             // Disable Security, Csrf component checks
             if ($this->components()->has('Security')) {
                 $this->components()->unload('Security');
@@ -53,7 +53,7 @@ public function beforeFilter(Event $event)
             }
             // Allow action without authentication
             if ($this->components()->has('Auth')) {
-                $this->Auth->allow($this->request->action);
+                $this->Auth->allow($this->request->getParam('action'));
             }
         }
     }
@@ -65,7 +65,7 @@ public function beforeFilter(Event $event)
      */
     public function check()
     {
-        $vatNumber = (string)$this->request->data('vatNumber');
+        $vatNumber = (string)$this->request->getData('vatNumber');
         $normalizeVatNumber = $this->VatNumberCheck->normalize($vatNumber);
 
         $jsonData = array_merge(compact('vatNumber'), ['status' => 'failure']);
@@ -75,7 +75,7 @@ public function check()
                 $jsonData = array_merge(compact('vatNumber'), ['status' => 'ok']);
             }
         } catch (InternalErrorException $e) {
-            $this->response->statusCode(503);
+            $this->response = $this->response->withStatus(503);
         }
 
         $this->set(compact('jsonData'));

src/Controller/VatNumberChecksController.php

@@ -0,0 +1,11 @@
+<?php
+namespace VatNumberCheck;
+
+use Cake\Core\BasePlugin;
+
+/**
+ * Plugin for VatNumberCheck
+ */
+class Plugin extends BasePlugin
+{
+}

src/Plugin.php

@@ -3,20 +3,19 @@
 
 use Cake\Core\Configure;
 use Cake\Http\Client;
-use Cake\Network\Exception\InternalErrorException;
-use VatNumberCheck\Utility\Model\App;
+use Cake\Http\Exception\InternalErrorException;
 
 /**
  * VatNumberCheck Model.
  *
  */
-class VatNumberCheck extends App
+class VatNumberCheck
 {
     /**
      * Url to check vat numbers.
      *
      */
-    const CHECK_URL = 'http://ec.europa.eu/taxation_customs/vies/vatResponse.html';
+    const CHECK_URL = 'https://ec.europa.eu/taxation_customs/vies/vatResponse.html';
 
     /**
      * Normalizes a VAT number.
@@ -33,7 +32,7 @@ public function normalize(string $vatNumber): string
      * Splits a VAT number into query string (data) parameters.
      *
      * @param string $vatNumber A VAT number
-     * @return array Query string parameters
+     * @return array<string,string> Query string parameters
      */
     public function toQueryString(string $vatNumber): array
     {
@@ -61,8 +60,8 @@ public function toQueryString(string $vatNumber): array
      * Downloads a given url.
      *
      * @param string $url An url
-     * @param string $data POST data
-     * @return bool|string Request body on success (string) otherwise false (boolean)
+     * @param array<string,string> $data POST data
+     * @return false|string Request body on success (string) otherwise false
      */
     public function getUrlContent(string $url, array $data)
     {
@@ -73,9 +72,9 @@ public function getUrlContent(string $url, array $data)
             $response = $HttpSocket->post($url, $data);
 
             if ($response->isOk()) {
-                return $response->body;
+                return $response->getStringBody();
             }
-        } catch (Exception $e) {
+        } catch (\Exception $e) {
         }
 
         return false;
@@ -86,7 +85,7 @@ public function getUrlContent(string $url, array $data)
      *
      * @param string $vatNumber A VAT number
      * @return bool Valid or not
-     * @throws \Cake\Network\Exception\InternalErrorException
+     * @throws \Cake\Http\Exception\InternalErrorException
      */
     public function check(string $vatNumber): bool
     {
@@ -95,7 +94,7 @@ public function check(string $vatNumber): bool
 
         $urlContent = $this->getUrlContent($url, $data);
         if ($urlContent) {
-            return (strpos($urlContent, 'Yes, valid VAT number') !== false);
+            return strpos($urlContent, 'Yes, valid VAT number') !== false;
         }
 
         throw new InternalErrorException(__d('vat_number_check', 'Service unavailable'));

src/Utility/Model/App.php

@@ -6,17 +6,17 @@
 /**
  * VatNumberCheck Helper.
  *
- * @property Cake\View\Helper\FormHelper $Form
- * @property Cake\View\Helper\HtmlHelper $Html
- * @property Cake\View\Helper\UrlHelper $Url
+ * @property \Cake\View\Helper\FormHelper $Form
+ * @property \Cake\View\Helper\HtmlHelper $Html
+ * @property \Cake\View\Helper\UrlHelper $Url
  */
 class VatNumberCheckHelper extends Helper
 {
 
     /**
      * An array of names of helpers to load.
      *
-     * @var array
+     * @var array<int,string>
      */
     public $helpers = ['Html', 'Form', 'Url'];
 
@@ -40,7 +40,7 @@ class VatNumberCheckHelper extends Helper
      *  See `FormHelper::input`.
      *
      * @param string $fieldName This should be `Modelname.fieldname`
-     * @param array $options Each type of input takes different options
+     * @param array<string,mixed> $options Each type of input takes different options
      * @return string Html output for a form field
      */
     public function input(string $fieldName, array $options = []): string
@@ -59,7 +59,7 @@ public function input(string $fieldName, array $options = []): string
             $options['class'] = sprintf('%s %s', $options['class'], $class);
         }
 
-        return $this->Form->input($fieldName, $options);
+        return $this->Form->control($fieldName, $options);
     }
 
     /**
@@ -70,7 +70,10 @@ public function input(string $fieldName, array $options = []): string
     protected function _addJs()
     {
         $checkUrl = $this->Url->build([
-            'plugin' => 'VatNumberCheck', 'controller' => 'VatNumberChecks', 'action' => 'check', '_ext' => 'json'
+            'plugin' => 'VatNumberCheck',
+            'controller' => 'VatNumberChecks',
+            'action' => 'check',
+            '_ext' => 'json',
         ]);
         $checkImages = [
             'ok' => $this->Url->build('/vat_number_check/img/ok.png'),
@@ -95,7 +98,9 @@ protected function _addJs()
         ";
 
         $this->Html->script([
-            'VatNumberCheck.jquery.min', 'VatNumberCheck.klass.min', 'VatNumberCheck.vat_number_check'
+            'VatNumberCheck.jquery.min',
+            'VatNumberCheck.klass.min',
+            'VatNumberCheck.vat_number_check',
         ], ['inline' => false, 'once' => true]);
         $this->Html->scriptBlock($script, ['inline' => false]);
     }