Removal of major deprecations (#301) (#304)

* Removal of major deprecations (#301)

* Removed call module, depreciated in favour of Voice module

* Remove user module.

* Modify Keypair to allow tests to fetch the input key, test basic creation of JWT

* Drop support for 7.2 and 7.3

* Add php core return type will change annotations for PHP8.1 compatibility. These will be removed anyway later due to deprecations.

* Depreciated methods removal for talk

* Marked Application and talk deprecations

* Removed callback and message objects marked for deletion

* Removed Filter and finally the IterableServiceShimTrait.php to let Iterable API collections handle that rather than service layer

* Feature/further removals (#305)

* Depreciated methods removal for talk

* Marked Application and talk deprecations

* Removed callback and message objects marked for deletion

* bump container, min required PHP74 which is the same for library anyway

* migrate phpunit schema

* Feature/array access deprecations (#307)

* Array access removals

* Almost all array access removed

* Remove array access tests

* Final test cleanup

* Minor readme tweaks

Author: SecondeJK

CHANGELOG.md

@@ -7,7 +7,7 @@
 ### Changed
 
 * Maintainer and Contribution documents changed to reflect current ownership
-* All test cases now extend off a the new `VonageTestCase` class that implements the `ProphesizeTrait`
+* All test cases now extend off the new `VonageTestCase` class that implements the `ProphesizeTrait`
 
 # 2.9.3
 

README.md

@@ -8,7 +8,7 @@ Client Library for PHP
 
 <img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />
 
-*This library requires a minimum PHP version of 7.2*
+*This library requires a minimum PHP version of 7.4*
 
 This is the PHP client library for use Vonage's API. To use this, you'll need a Vonage account. Sign up [for free at 
 nexmo.com][signup].
@@ -30,6 +30,10 @@ To install the PHP client library to your project, we recommend using [Composer]
 composer require vonage/client
 ```
 
+> Note that this actually points to a wrapper library that includes an HTTP client -and- this core library. You can
+> install this library directly from Composer if you wish, with the ability to choose the HTTP client your project
+> uses.
+
 > You don't need to clone this repository to use this library in your own projects. Use Composer to install it from Packagist.
 
 If you're new to Composer, here are some resources that you may find useful:
@@ -111,7 +115,7 @@ The [send example][send_example] also has full working examples.
 
 ### Receiving a Message
 
-Inbound messages are [sent to your application as a webhook][doc_inbound], and the client library provides a way to 
+Inbound messages are [sent to your application as a webhook][doc_inbound]. The Client library provides a way to 
 create an inbound message object from a webhook:
 
 ```php
@@ -274,7 +278,7 @@ $outboundCall = new \Vonage\Voice\OutboundCall(
 );
 $ncco = new NCCO();
 
-//ADD ACTIONS TO THE NCCO OBJECT HERE
+// ADD ACTIONS TO THE NCCO OBJECT HERE
 
 $outboundCall->setNCCO($ncco);
 
@@ -423,7 +427,7 @@ foreach($client->search($filter) as $call){
 
 ### Creating an Application
 
-Application are configuration containers. You can create one using a simple array structure:
+Application are configuration containers. You can create one using an array structure:
 
 ```php
 $application = new \Vonage\Application\Application();
@@ -476,7 +480,7 @@ $client->applications()->create($application);
 You can also pass the client an application object:
 
 ```php
-$a = new Vonage\Application\Application;
+$a = new Vonage\Application\Application();
 
 $a->setName('PHP Client Example');
 $a->getVoiceConfig()->setWebhook('answer_url', 'https://example.com/answer', 'GET');

composer.json

@@ -12,19 +12,19 @@
     }
   ],
   "require": {
-    "php": ">=7.2",
+    "php": "~7.4 || ~8.0 || ~8.1",
     "ext-json": "*",
     "ext-mbstring": "*",
     "laminas/laminas-diactoros": "^2.4",
     "lcobucci/jwt": "^3.4|^4.0",
     "composer/package-versions-deprecated": "^1.11",
-    "psr/container": "^1.0",
+    "psr/container": "^2.0",
     "psr/http-client-implementation": "^1.0",
     "vonage/nexmo-bridge": "^0.1.0",
     "psr/log": "^1.1|^2.0"
   },
   "require-dev": {
-    "php": ">=7.4",
+    "php": "~7.4 || ~8.0 || ~8.1",
     "guzzlehttp/guzzle": ">=6",
     "helmich/phpunit-json-assert": "^3.3",
     "php-http/mock-client": "^1.4",
@@ -53,7 +53,8 @@
   "scripts": {
     "cs-check": "phpcs",
     "cs-fix": "phpcbf",
-    "test": "phpunit"
+    "test": "phpunit",
+    "phpstan": "phpstan analyse -l 2 src"
   },
   "support": {
     "email": "[email protected]",

phpunit.xml.dist

@@ -1,14 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
-    <testsuites>
-        <testsuite name="default">
-            <directory>test</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="default">
+      <directory>test</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

phpunit.xml.dist.bak

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>test</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Account/Balance.php

@@ -11,36 +11,16 @@
 
 namespace Vonage\Account;
 
-use ArrayAccess;
-use JsonSerializable;
-use Vonage\Client\Exception\Exception as ClientException;
 use Vonage\Entity\Hydrator\ArrayHydrateInterface;
-use Vonage\Entity\JsonSerializableInterface;
-use Vonage\Entity\JsonUnserializableInterface;
 
-use function get_class;
-use function trigger_error;
-
-/**
- * This class will no longer be accessible via array keys past v2
- *
- * @todo Have the JSON unserialize/serialize keys match with $this->data keys
- */
 class Balance implements
-    JsonSerializable,
-    JsonSerializableInterface,
-    JsonUnserializableInterface,
-    ArrayAccess,
     ArrayHydrateInterface
 {
     /**
      * @var array
      */
-    protected $data;
+    protected array $data;
 
-    /**
-     * @todo Have these take null values, since we offer an unserialize option to populate
-     */
     public function __construct($balance, $autoReload)
     {
         $this->data['balance'] = $balance;
@@ -57,57 +37,6 @@ public function getAutoReload()
         return $this->data['auto_reload'];
     }
 
-    public function jsonUnserialize(array $json): void
-    {
-        trigger_error(
-            get_class($this) . "::jsonUnserialize is deprecated, please fromArray() instead",
-            E_USER_DEPRECATED
-        );
-
-        $this->fromArray($json);
-    }
-
-    public function jsonSerialize(): array
-    {
-        return $this->data;
-    }
-
-    public function offsetExists($offset): bool
-    {
-        trigger_error(
-            "Array access for " . get_class($this) . " is deprecated, please use getter methods",
-            E_USER_DEPRECATED
-        );
-
-        return isset($this->data[$offset]);
-    }
-
-    public function offsetGet($offset)
-    {
-        trigger_error(
-            "Array access for " . get_class($this) . " is deprecated, please use getter methods",
-            E_USER_DEPRECATED
-        );
-
-        return $this->data[$offset];
-    }
-
-    /**
-     * @throws ClientException
-     */
-    public function offsetSet($offset, $value): void
-    {
-        throw new ClientException('Balance is read only');
-    }
-
-    /**
-     * @throws ClientException
-     */
-    public function offsetUnset($offset): void
-    {
-        throw new ClientException('Balance is read only');
-    }
-
     public function fromArray(array $data): void
     {
         $this->data = [
@@ -120,21 +49,4 @@ public function toArray(): array
     {
         return $this->data;
     }
-
-    /**
-     * @noinspection MagicMethodsValidityInspection
-     */
-    public function __get($key): ?array
-    {
-        if ($key === 'data') {
-            trigger_error(
-                "Direct access to " . get_class($this) . "::data is deprecated, please use getter to toArray() methods",
-                E_USER_DEPRECATED
-            );
-
-            return $this->data;
-        }
-
-        return null;
-    }
 }

src/Account/Config.php

@@ -11,22 +11,11 @@
 
 namespace Vonage\Account;
 
-use ArrayAccess;
-use JsonSerializable;
-use Vonage\Client\Exception\Exception as ClientException;
 use Vonage\Entity\Hydrator\ArrayHydrateInterface;
-use Vonage\Entity\JsonSerializableInterface;
-use Vonage\Entity\JsonUnserializableInterface;
 
-use function get_class;
 use function is_null;
-use function trigger_error;
 
 class Config implements
-    JsonSerializable,
-    JsonSerializableInterface,
-    JsonUnserializableInterface,
-    ArrayAccess,
     ArrayHydrateInterface
 {
     /**
@@ -101,16 +90,6 @@ public function getMaxCallsPerSecond()
         return $this->data['max_calls_per_second'];
     }
 
-    public function jsonUnserialize(array $json): void
-    {
-        trigger_error(
-            get_class($this) . "::jsonUnserialize is deprecated, please fromArray() instead",
-            E_USER_DEPRECATED
-        );
-
-        $this->fromArray($json);
-    }
-
     public function fromArray(array $data): void
     {
         $this->data = [
@@ -122,66 +101,8 @@ public function fromArray(array $data): void
         ];
     }
 
-    public function jsonSerialize(): array
-    {
-        return $this->toArray();
-    }
-
     public function toArray(): array
     {
         return $this->data;
     }
-
-    public function offsetExists($offset): bool
-    {
-        trigger_error(
-            "Array access for " . get_class($this) . " is deprecated, please use getter methods",
-            E_USER_DEPRECATED
-        );
-
-        return isset($this->data[$offset]);
-    }
-
-    public function offsetGet($offset)
-    {
-        trigger_error(
-            "Array access for " . get_class($this) . " is deprecated, please use getter methods",
-            E_USER_DEPRECATED
-        );
-
-        return $this->data[$offset];
-    }
-
-    /**
-     * @throws ClientException
-     */
-    public function offsetSet($offset, $value): void
-    {
-        throw new ClientException('Balance is read only');
-    }
-
-    /**
-     * @throws ClientException
-     */
-    public function offsetUnset($offset): void
-    {
-        throw new ClientException('Balance is read only');
-    }
-
-    /**
-     * @noinspection MagicMethodsValidityInspection
-     */
-    public function __get($key): ?array
-    {
-        if ($key === 'data') {
-            trigger_error(
-                "Direct access to " . get_class($this) . "::data is deprecated, please use getter to toArray() methods",
-                E_USER_DEPRECATED
-            );
-
-            return $this->data;
-        }
-
-        return null;
-    }
 }