Merge pull request #3 from basekit/php_8_upgrade

Upgrade guzzle client to V7 for PHP 8 compatibility

Author: RhydianJenkins

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Lint and Test
+run-name: ${{ github.actor }} is linting and testing 🚀
+
+on: [push]
+
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: 💅 Lint
+        run: |
+          make lint
+  Test:
+    strategy:
+      matrix:
+        php-versions: ['8.0', '8.1', '8.2']
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Set up PHP ${{ matrix.php-versions }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+      - name: 🧪 Test
+        run: |
+          make test

.gitignore

@@ -1,2 +1,4 @@
 vendor
 tmp
+
+.phpunit.result.cache

.travis.yml

@@ -1,8 +1,8 @@
 build: lint test
 
 lint: vendor
-	./vendor/bin/phpcs  --standard=PSR2 src/
-	./vendor/bin/phpcs  --standard=PSR2 tests/
+	./vendor/bin/phpcs  --standard=PSR12 src/
+	./vendor/bin/phpcs  --standard=PSR12 tests/
 
 test: vendor
 	./vendor/bin/phpunit

Makefile

@@ -1,75 +1,75 @@
-BaseKit REST API Client
-=======================
+# BaseKit REST API Client
 
-[![Build Status](https://secure.travis-ci.org/basekit/php-api-client.png)](http://travis-ci.org/basekit/php-api-client)
-[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/basekit/php-api-client/badges/quality-score.png?s=1ebfb26b984131090693ffca1ba26ede5354a037)](https://scrutinizer-ci.com/g/basekit/php-api-client/)
+A PHP client for [BaseKit](http://basekit.com/)'s REST API. This client will provide documentation of the services available from the BaseKit API, describing URIs, HTTP methods and input parameters.
 
-A PHP client for [BaseKit]'s REST API. This client will provide documentation of
-the services available from the BaseKit API, describing URIs, HTTP methods and
-input parameters.
+## Installation
 
-Installation
-------------
+The recommended way of including this package in your project is by using Composer. Add it to the `require` section of your project's `composer.json`.
 
-The recommended way of including this package in your project is by using
-Composer. Add it to the `require` section of your project's `composer.json`.
-
-    "basekit/php-api-client": "1.2.1"
+```bash
+composer require basekit/php-api-client
+```
 
-Usage
------
+## Usage
 
 ```php
-<?php
-
-require 'vendor/autoload.php';
-use BaseKit\Api\Client;
-
-$client = Client::factory(
-    array(
-        'base_url'        => 'http://api.example.org',
-        'consumer_key'    => '1234567890',
-        'consumer_secret' => 'qwertyuiop',
-        'token'           => 'asdfghjkl',
-        'token_secret'    => 'zxcvbnm',
-    )
+use BaseKit\Api\AuthType;
+use BaseKit\Api\ClientFactory;
+
+$client = ClientFactory::create(
+    [
+        'base_uri' => 'http://api.testing.com',
+        'username' => 'foo',
+        'password' => 'bar',
+    ],
+    AuthType::BASIC, // defaults to basic auth
 );
 
 $createSite = $client->getCommand(
     'CreateSite',
-    array(
+    [
         'accountHolderRef' => 123,
-        'brandRef' => 456,
+        'brandRef' => 789,
         'domain' => 'test.example.org',
-    )
+    ]
 );
-$response = $createSite->execute();
-print_r($response);
+
+$client->execute($createSite);
 ```
 
-Contributing
-------------
+## Testing
 
-This project adheres to the [PSR2] coding style guide. Checking your
-contribution's correctness is easy.
+Feed an optional `handler` into the config of `clientFactory` to control the responses from the http client.
 
-```bash
-$ make lint
-```
+```php
+use BaseKit\Api\ClientFactory;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\Psr7\Response;
+
+$client = ClientFactory::create([
+    'base_uri' => 'https://api.testing.com',
+    'username' => 'foo',
+    'password' => 'bar',
+    'handler' => HandlerStack::create(
+        new MockHandler([
+            new Response(404, [], 'Hello, World! This is a test response.'),
+        ])
+    ) ,
+]);
 
-There's a very small unit test suite, using [PHPUnit]. Making sure you haven't
-broken any tests is easy too.
+$createSite = $client->getCommand(
+    'CreateSite',
+    [
+        'accountHolderRef' => 123,
+        'brandRef' => 789,
+        'domain' => 'test.example.org',
+    ]
+);
 
-```bash
-$ make test
+$client->execute($createSite); // Throws a 404 CommandClientException
 ```
 
-License
--------
-
-This software is released under the [MIT License].
+## License
 
-[BaseKit]: http://basekit.com/
-[PHPUnit]: http://phpunit.de/
-[PSR2]: http://www.php-fig.org/psr/psr-2/
-[MIT License]: http://www.opensource.org/licenses/MIT
+This software is released under the [MIT License](http://www.opensource.org/licenses/MIT).

README.md

@@ -1,8 +1,6 @@
 {
-
     "name": "basekit/php-api-client",
     "description": "BaseKit PHP API client.",
-
     "authors": [
         {
             "name": "Simon Best",
@@ -13,26 +11,25 @@
             "email": "adrian.slade@basekit.com"
         }
     ],
-
     "minimum-stability": "dev",
-
     "autoload": {
         "psr-4": {
             "BaseKit\\Api\\": "src/"
         }
     },
-
     "require": {
-        "guzzle/guzzle": ">=v3.7.4"
+        "guzzlehttp/guzzle": "7.*",
+        "guzzlehttp/guzzle-services": "1.3.*",
+        "guzzlehttp/command": "1.2.*",
+        "guzzlehttp/oauth-subscriber": "0.6.*"
     },
-
     "require-dev": {
         "squizlabs/php_codesniffer": "3.*",
-        "phpunit/phpunit": "3.7.*@dev"
+        "phpunit/phpunit": "^9.5"
     },
     "config": {
         "platform": {
-            "php": "5.6"
+            "php": "8.0.0"
         }
     }
 }