Api 3.0, PHP7.4 and PHP8 compatability (#44)

Author: hyperized

.github/dependabot.yml

@@ -1,8 +1,9 @@
+---
 version: 2
 updates:
-- package-ecosystem: composer
-  directory: "/"
-  schedule:
-    interval: weekly
-    time: "04:00"
-  open-pull-requests-limit: 10
+  - package-ecosystem: composer
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "08:00"
+    open-pull-requests-limit: 10

.github/workflows/main.yml

@@ -1,3 +1,4 @@
+---
 name: Run tests
 
 on:
@@ -9,9 +10,9 @@ jobs:
       fail-fast: false
       matrix:
         php:
-          - 7.2
-          - 7.3
           - 7.4
+          - 8.0
+          - 8.1
         dependency-version:
           - prefer-lowest
           - prefer-stable
@@ -26,12 +27,11 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v1
       - name: Setup PHP
-        uses: shivammathur/setup-php@v1
+        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: curl, json
-          tools: prestissimo
-          coverage: xdebug
+          coverage: pcov
       - name: Composer self-update
         run: |
           composer self-update
@@ -40,4 +40,4 @@ jobs:
           composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
       - name: Composer ${{ matrix.test }}-${{ matrix.os }}
         run: |
-          composer ${{ matrix.test }}
+          composer ${{ matrix.test }}

.gitignore

@@ -1,4 +1,4 @@
 /vendor/
 /.idea/
-composer.lock
 clover.xml
+.phpunit.result.cache

.mergify.yml

@@ -1,8 +1,8 @@
 pull_request_rules:
-  - name: automatic merge on new dependency
+  - name: automatic merge on depenabot pull requests
     conditions:
       - author=dependabot[bot]
-      - status-success=continuous-integration/travis-ci/pr
+      - check-success=Run tests
     actions:
       merge:
         method: merge

.phan/config.php

@@ -1,41 +1,49 @@
-# Hostfact API 2.7 for Laravel 5+
+# Hostfact API 3.0 for Laravel
 
-[![Build Status](https://travis-ci.org/hyperized/hostfact.svg?branch=master)](https://travis-ci.org/hyperized/hostfact)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fhyperized%2Fhostfact.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fhyperized%2Fhostfact?ref=badge_shield)
 
 Official documentation:
 -----------------------
 
-* [Hostfact API 2.7](https://www.hostfact.nl/hostfact-hosting/apiv2/)
-* [Official API examples](https://www.hostfact.nl/hostfact-hosting/apiv2/)
+* [Hostfact API documentation](https://www.hostfact.nl/developer/api/)
 
 Installation
 ------------
 
 Install using composer:
+
 ```bash
 composer require hyperized/hostfact
 ```
 
-This package supports Package Auto-Discovery (Laravel 5.5+) so it doesn't require you to manually add the ServiceProvider and alias.
+This package supports Package Auto-Discovery (Laravel 5.5+) so it doesn't require you to manually add the
+ServiceProvider and alias.
 
-If you are using a lower version of Laravel or not using Auto-Discovery you can add the Hostfact Service Provider to the `config/app.php` file 
+If you are using a lower version of Laravel or not using Auto-Discovery you can add the Hostfact Service Provider to
+the `config/app.php` file
 
 ```php
 Hyperized\Hostfact\HostfactServiceProvider::class,
 ```
-Register a alias for Hostfact, also in `config/app.php`:
+
+Register an alias for Hostfact, also in `config/app.php`:
 
 ```php
 'Hostfact'    => Hyperized\Hostfact\HostfactServiceProvider::class,
 ```
+
 Now publish the Hostfact package into your installation:
+
 ```bash
 php artisan vendor:publish --provider="Hyperized\Hostfact\HostfactServiceProvider" --tag="config"
 ```
-This should give you a message like: `Copied File [/vendor/hyperized/hostfact/src/config/Hostfact.php] To [/config/Hostfact.php]`
 
-It's possible to edit your configuration variables in the `config/Hostfact.php` file or you can use the `HOSTFACT_URL` and `HOSTFACT_KEY` environment variables to store sensitive information in the `.env` file 
+This should give you a message
+like: `Copied File [/vendor/hyperized/hostfact/config/Hostfact.php] To [/config/Hostfact.php]`
+
+It's possible to edit your configuration variables in the `config/Hostfact.php` file or you can use the `HOSTFACT_URL`
+and `HOSTFACT_KEY` environment variables to store sensitive information in the `.env` file
+
 ```php
 // config/Hostfact.php
 'api_v2_url'		=> env('HOSTFACT_URL', 'https://yoursite.tld/Pro/apiv2/api.php'),
@@ -48,32 +56,40 @@ HOSTFACT_KEY=token
 HOSTFACT_TIMEOUT=20
 ```
 
-Example code:
-```php
-// Direct use
-$product = new Hyperized\Hostfact\Types\Product();
-$productParams = [
-    'searchfor' => 'invoice'
-];
-$output = $product->list($productParams);
-
-// Use in Controllers
-use Hyperized\Hostfact\Types\Product;
-
-class MyController extends Controller {
-    public function getProducts()
-    {
-        $product = new Product();
-        $productParams = [
-            'searchfor' => 'invoice'
-        ];
-        return $product->list($productParams);
-    }
-}
-```
+Functionality
+---------
+
+When writing code for this Hostfact package, consider that this package has been written as a basic interface.
 
+This package _will_ do the following:
 
+* Provide an easy way to communicate with Hostfact API controllers;
+* Document the available API controller endpoints with methods;
+* Transport layer (HTTP/HTTPS) error catching;
+* Basic error parsing;
 
+This package _will not_:
+
+* Parameter / input validation;
+* Output validation;
+
+You will need to consult the [Hostfact API documentation](https://www.hostfact.nl/developer/api/) to understand the
+acceptable input and output for each of the API controllers.
+
+Examples
+--------
+
+Example code:
+
+```php
+use \Hyperized\Hostfact\Api\Controllers\Product;
+
+$products = Product::new()
+                ->list([
+                    'searchfor' => 'invoice'
+                ]);
+```
 
 ## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fhyperized%2Fhostfact.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fhyperized%2Fhostfact?ref=badge_large)
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fhyperized%2Fhostfact.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fhyperized%2Fhostfact?ref=badge_large)

README.md

@@ -1,9 +1,10 @@
 {
   "name": "hyperized/hostfact",
-  "description": "Hostfact 2.7 API Implementation",
+  "description": "Hostfact 3.0 API Implementation for Laravel",
   "keywords": [
+    "hyperized",
     "hostfact",
-    "hostfact-api"
+    "api"
   ],
   "type": "library",
   "minimum-stability": "stable",
@@ -15,21 +16,19 @@
     }
   ],
   "require": {
-    "php": "^7.2.5",
-    "illuminate/support": "^7.2|^8.0",
-    "ext-curl": "*",
-    "ext-json": "*"
+    "php": "^7.4|^8.0|^8.1",
+    "guzzlehttp/guzzle": "^7.4",
+    "hyperized/value-objects": "^0.3.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.0",
-    "squizlabs/php_codesniffer": "^3.5",
-    "povils/phpmnd": "^2.0",
-    "bmitch/churn-php": "^1.0.3",
-    "phan/phan": "^3.0 || ^5.0",
-    "phpstan/phpstan": "^0.12.0 || ^1.0.0",
-    "phpmd/phpmd": "^2.8",
-    "infection/infection": "^0.15.0",
-    "vimeo/psalm": "^3.8 || ^4.0"
+    "phpunit/phpunit": "^9.5",
+    "phpmd/phpmd": "^2.10",
+    "vimeo/psalm": "^4.13",
+    "orchestra/testbench": "^6.23",
+    "phpstan/phpstan": "^1.2",
+    "squizlabs/php_codesniffer": "^3.6",
+    "povils/phpmnd": "^2.4",
+    "infection/infection": "^0.25.3"
   },
   "autoload": {
     "psr-4": {
@@ -44,42 +43,41 @@
   "extra": {
     "laravel": {
       "providers": [
-        "Hyperized\\Hostfact\\HostfactServiceProvider"
+        "Hyperized\\Hostfact\\Providers\\HostfactServiceProvider"
       ],
       "aliases": {
-        "Hostfact": "Hyperized\\Hostfact\\HostfactServiceProvider"
+        "Hostfact": "Hyperized\\Hostfact\\Providers\\HostfactServiceProvider"
       }
     }
   },
   "scripts": {
+    "test": [
+      "@phpmd",
+      "@psalm",
+      "@phpstan",
+      "@phpcbf",
+      "@phpcs",
+      "@phpmnd",
+      "@phpunit",
+      "@infection"
+    ],
+    "test-github": [
+      "@test"
+    ],
     "phpunit": "vendor/phpunit/phpunit/phpunit --configuration phpunit.xml.dist",
-    "phan": "vendor/bin/phan --allow-polyfill-parser",
     "phpmd": "vendor/bin/phpmd --strict src text cyclomatic.xml",
+    "psalm": "vendor/bin/psalm",
+    "phpstan": "vendor/bin/phpstan analyse",
     "phpcs": "vendor/bin/phpcs src --standard=PSR2 || true",
     "phpcbf": "vendor/bin/phpcbf src",
     "phpmnd": "vendor/bin/phpmnd src",
-    "churn": "vendor/bin/churn run src",
-    "phpstan": "vendor/bin/phpstan --level=7  analyse src tests",
-    "infection": "vendor/bin/infection",
-    "psalm": "vendor/bin/psalm",
-    "test-github": [
-      "@phpunit",
-      "@phpmd",
-      "@phpmnd",
-      "@churn",
-      "@infection"
+    "infection": "vendor/bin/infection || true",
+    "major": [
+      "composer update",
+      "@update-major",
+      "@update-major-dev"
     ],
-    "test": [
-      "@phpunit",
-      "@phan",
-      "@phpmd",
-      "@phpcbf",
-      "@phpcs",
-      "@phpmnd",
-      "@churn",
-      "@phpstan",
-      "@infection",
-      "@psalm"
-    ]
+    "update-major": "jq -r '.require | keys[]' composer.json | xargs composer require --update-with-all-dependencies",
+    "update-major-dev": "jq -r '.\"require-dev\" | keys[]' composer.json | xargs composer require --dev --update-with-all-dependencies"
   }
 }