Merge pull request #240 from EasyPost/php_versions

chore: drop 7.3, add 8.2

Author: Justintime50

.github/workflows/ci.yml

@@ -8,28 +8,30 @@ on:
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v3
       - name: set up php
         uses: shivammathur/setup-php@v2
         with:
-          php-version: "8.1"
+          php-version: "8.2"
       - name: install dependencies
         run: make install
       - name: lint
         run: make lint
   run-tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        phpversion: ["7.3", "7.4", "8.0", "8.1"]
+        # TODO: We are getting segfaults on PHP 8.2 when running the test suite. This needs to be investigated before enabling
+        phpversion: ["7.4", "8.0", "8.1"]
     steps:
       - uses: actions/checkout@v3
       - name: set up php
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.phpversion }}
+          coverage: xdebug
       - name: get composer cache directory
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"

Makefile

@@ -9,7 +9,7 @@ clean:
 ## coverage - Runs the test suite and generates a coverage report
 coverage:
 	composer coverage
-	bin/coverage-check build/logs/clover.xml 86 --only-percentage
+	bin/coverage-check build/logs/clover.xml 82 --only-percentage
 
 ## docs - Generate documentation for the library
 docs:

README.md

@@ -71,7 +71,7 @@ Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_G
 
 ## Development
 
-**NOTE:** Recording VCR cassettes only works with PHP 7.3 or 7.4. Once recorded, tests can be run on PHP 7 or 8.
+**NOTE:** Recording VCR cassettes only works with PHP 7.4. Once recorded, tests can be run on PHP 7.4 or 8.0+.
 
 ```bash
 # Install dependencies

composer.json

@@ -19,7 +19,7 @@
   ],
   "require": {
     "ext-json": "*",
-    "php": ">=7.3",
+    "php": ">=7.4",
     "guzzlehttp/guzzle": "^7.5"
   },
   "require-dev": {

composer.lock

@@ -5,6 +5,7 @@
 use EasyPost\Constant\Constants;
 use EasyPost\Exception\Error;
 use EasyPost\Service\AddressService;
+use EasyPost\Service\BaseService;
 use EasyPost\Service\BatchService;
 use EasyPost\Service\BillingService;
 use EasyPost\Service\CarrierAccountService;
@@ -52,8 +53,36 @@
  * @property UserService $user;
  * @property WebhookService $webhook;
  */
-class EasyPostClient extends Service\BaseService
+class EasyPostClient extends BaseService
 {
+    // Client properties
+    private $apiKey;
+    private $timeout;
+    private $apiBase;
+
+    // Services
+    public $address;
+    public $batch;
+    public $billing;
+    public $carrierAccount;
+    public $customsInfo;
+    public $customsItem;
+    public $endShipper;
+    public $event;
+    public $insurance;
+    public $order;
+    public $parcel;
+    public $pickup;
+    public $rate;
+    public $referralCustomer;
+    public $refund;
+    public $report;
+    public $scanForm;
+    public $shipment;
+    public $tracker;
+    public $user;
+    public $webhook;
+
     /**
      * Constructor for an EasyPostClient.
      *
@@ -63,14 +92,13 @@ class EasyPostClient extends Service\BaseService
      */
     public function __construct($apiKey, $timeout = Constants::TIMEOUT, $apiBase = Constants::API_BASE)
     {
-        // TODO: Make these all read only when we support PHP >= 8.1
-
         // Client properties
         $this->apiKey = $apiKey;
         $this->timeout = $timeout;
         $this->apiBase = $apiBase;
 
-        // Service
+        // Services
+        // TODO: Make these all read only when we support PHP >= 8.1
         $this->address = new AddressService($this);
         $this->batch = new BatchService($this);
         $this->billing = new BillingService($this);
@@ -97,4 +125,34 @@ public function __construct($apiKey, $timeout = Constants::TIMEOUT, $apiBase = C
             throw new Error('No API key provided. See https://www.easypost.com/docs for details, or contact ' . Constants::SUPPORT_EMAIL . ' for assistance.');
         }
     }
+
+    /**
+     * Get the API key of an EasyPostClient.
+     *
+     * @return string
+     */
+    public function getApiKey()
+    {
+        return $this->apiKey;
+    }
+
+    /**
+     * Get the timeout of an EasyPostClient.
+     *
+     * @return float
+     */
+    public function getTimeout()
+    {
+        return $this->timeout;
+    }
+
+    /**
+     * Get the API Base URL of an EasyPostClient.
+     *
+     * @return string
+     */
+    public function getApiBase()
+    {
+        return $this->apiBase;
+    }
 }

lib/EasyPost/EasyPostClient.php

@@ -10,6 +10,14 @@
  */
 class Error extends \Exception
 {
+    private $httpBody;
+    private $httpStatus;
+    private $jsonBody;
+    public $code;
+    public $ecode;
+    public $errors;
+    public $message;
+
     /**
      * Constructor.
      *

lib/EasyPost/Exception/Error.php

@@ -3,35 +3,27 @@
 namespace EasyPost\Http;
 
 use EasyPost\Constant\Constants;
+use EasyPost\EasyPostClient;
 use EasyPost\EasypostObject;
 use EasyPost\Exception\Error;
 use GuzzleHttp\Client;
 
 class Requestor
 {
-    /**
-     * Constructor.
-     *
-     * @param EasyPostClient $client
-     */
-    public function __construct($client)
-    {
-        $this->client = $client;
-    }
-
     /**
      * Get the API URL.
      *
+     * @param EasyPostClient $client
      * @param string $url
      * @param bool $beta
      * @return string
      */
-    private function absoluteUrl($url = '', $beta = false)
+    private static function absoluteUrl($client, $url = '', $beta = false)
     {
         if ($beta) {
             $apiBase = Constants::API_BASE . '/' . Constants::BETA_API_VERSION;
         } else {
-            $apiBase = $this->client->apiBase . '/' . Constants::API_VERSION;
+            $apiBase = $client->getApiBase() . '/' . Constants::API_VERSION;
         }
 
         return "{$apiBase}{$url}";
@@ -120,37 +112,39 @@ public static function urlEncode($arr, $prefix = null)
     /**
      * Make a request to the EasyPost API.
      *
+     * @param EasyPostClient $client
      * @param string $method
      * @param string $url
      * @param mixed $params
      * @param bool $beta
      * @return array
      * @throws \EasyPost\Exception\Error
      */
-    public function request($method, $url, $params = null, $beta = false)
+    public static function request($client, $method, $url, $params = null, $beta = false)
     {
-        list($responseBody, $httpStatus) = $this->requestRaw($method, $url, $params, $beta);
-        $httpBody = $this->interpretResponse($responseBody, $httpStatus);
+        list($responseBody, $httpStatus) = self::requestRaw($client, $method, $url, $params, $beta);
+        $httpBody = self::interpretResponse($responseBody, $httpStatus);
 
         return $httpBody;
     }
 
     /**
      * Internal logic required to make a request to the EasyPost API.
      *
+     * @param EasyPostClient $client
      * @param string $method
      * @param string $url
      * @param mixed $params
      * @param bool $beta
      * @return array
      * @throws \EasyPost\Exception\Error
      */
-    private function requestRaw($method, $url, $params, $beta = false)
+    private static function requestRaw($client, $method, $url, $params, $beta = false)
     {
-        $absoluteUrl = $this->absoluteUrl($url, $beta);
+        $absoluteUrl = self::absoluteUrl($client, $url, $beta);
         $requestOptions = [
             'http_errors' => false, // we set this false here so we can do our own error handling
-            'timeout' => $this->client->timeout,
+            'timeout' => $client->getTimeout(),
         ];
         $params = self::encodeObjects($params);
         if (in_array(strtolower($method), ['get', 'delete'])) {
@@ -166,7 +160,7 @@ private function requestRaw($method, $url, $params, $beta = false)
 
         $headers = [
             'Accept' => 'application/json',
-            'Authorization' => "Bearer {$this->client->apiKey}",
+            'Authorization' => "Bearer {$client->getApiKey()}",
             'Content-Type' => 'application/json',
             'User-Agent' => 'EasyPost/v2 PhpClient/' . Constants::LIBRARY_VERSION . " PHP/$phpVersion OS/$osType OSVersion/$osVersion OSArch/$osArch",
         ];
@@ -176,7 +170,7 @@ private function requestRaw($method, $url, $params, $beta = false)
         try {
             $response = $guzzleClient->request($method, $absoluteUrl, $requestOptions);
         } catch (\GuzzleHttp\Exception\ConnectException $error) {
-            $message = "Unexpected error communicating with EasyPost. If this problem persists please let us know at {$this->supportEmail}. {$error->getMessage()}";
+            $message = 'Unexpected error communicating with EasyPost. If this problem persists please let us know at ' . Constants::SUPPORT_EMAIL . ".{$error->getMessage()}";
             throw new Error($message, null, null);
         }
 
@@ -199,7 +193,7 @@ private function requestRaw($method, $url, $params, $beta = false)
      * @return mixed
      * @throws \EasyPost\Exception\Error
      */
-    public function interpretResponse($httpBody, $httpStatus)
+    public static function interpretResponse($httpBody, $httpStatus)
     {
         try {
             $response = json_decode($httpBody, true);
@@ -208,7 +202,7 @@ public function interpretResponse($httpBody, $httpStatus)
         }
 
         if ($httpStatus < 200 || $httpStatus >= 300) {
-            $this->handleApiError($httpBody, $httpStatus, $response);
+            self::handleApiError($httpBody, $httpStatus, $response);
         }
 
         return $response;
@@ -222,7 +216,7 @@ public function interpretResponse($httpBody, $httpStatus)
      * @param array $response
      * @throws \EasyPost\Exception\Error
      */
-    public function handleApiError($httpBody, $httpStatus, $response)
+    public static function handleApiError($httpBody, $httpStatus, $response)
     {
         if (!is_array($response) || !isset($response['error'])) {
             throw new Error("Invalid response object from API: HTTP Status: ({$httpStatus}) {$httpBody})", $httpStatus, $httpBody);