Updated files for release 1.8.3

Author: XolphinIvo

.gitignore

@@ -1,7 +1,2 @@
-.idea
-xolphin-api-php.iml
-vendor
-test.php
-composer.lock
-/sample.pdf
-/cert.crt
+vendor/
+.idea/

CHANGELOG.md

@@ -1,5 +1,16 @@
-# Change Log
-All notable changes to this project will be documented in this file.
+# Changelog
+All notable changes to the wrapper will be documented in this file.
+
+## [1.8.3]
+### Added
+- Added support for SSLCheck
+- Added support for Invoices
+- Added support for scheduling validation calls
+
+### Updated
+- Updated Client with remaining request count
+- Added sa_email and referenceOrderNr to Request (Pull request #12)
+- Deprecated sendComodoSAEmail, replaced by sendSectigoSAEmail
 
 ## [1.6.2]
 ### Updated
@@ -10,7 +21,7 @@ All notable changes to this project will be documented in this file.
 - Error handling in Client (pull request #5)
 - Correct extra domain and price information for MDC in support/products
 
-## [1.6.0] - 2017-07-06
+## [1.6.0]
 ### Added
 - Compatability with Xolphin REST Api v1.6.0
 - Support for the new Comodo DCV method

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "xolphin/xolphin-api-php",
-  "version": "1.6.1",
+  "version": "1.8.3",
   "description": "Xolphin API module for PHP",
   "license": "MIT",
   "keywords": [
@@ -14,16 +14,21 @@
       "email": "info@xolphin.nl"
     },
     {
-      "name": "Roman Ragimoff",
-      "email": "roma.ragimoff@gmail.com"
+      "name": "Ivo Geersen",
+      "email": "ivo@xolphin.nl"
+    },
+    {
+      "name": "Bart van Kalmthout",
+      "email": "bart@xolphin.nl"
     }
   ],
   "support": {
     "email": "api@xolphin.com"
   },
   "require": {
     "php": ">=5.6.0",
-    "guzzlehttp/guzzle": "~6"
+    "guzzlehttp/guzzle": "~6",
+    "ext-json": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^5.3"

readme.md

@@ -30,6 +30,20 @@ require 'vendor/autoload.php';
 $client = new Xolphin\Client('<username>', '<password>');
 ```
 
+### Rate Limiting
+
+#### Current limit
+```php
+$limit = $client->getLimit();
+echo $limit . "\n";
+```
+
+#### Requests remaining for limit
+```php
+$requestsRemaining = $client->getRequestsRemaining();
+echo $requestsRemaining . "\n";
+```
+
 ### Requests
 
 #### Get list of requests

src/Client.php

@@ -3,20 +3,29 @@
 namespace Xolphin;
 
 use GuzzleHttp\Exception\RequestException;
+use Psr\Http\Message\StreamInterface;
 use Xolphin\Endpoint\Certificate;
+use Xolphin\Endpoint\Invoice;
 use Xolphin\Endpoint\Request;
 use Xolphin\Endpoint\Support;
+use Xolphin\Exception\XolphinRequestException;
 
 class Client {
     const BASE_URI = 'https://api.xolphin.com/v%d/';
     const BASE_URI_TEST = 'https://test-api.xolphin.com/v%d/';
     const API_VERSION = 1;
-    const VERSION = '1.6.0';
+    const VERSION = '1.8.3';
 
     private $username = '';
     private $password = '';
     private $guzzle;
 
+    /** @var int */
+    private $limit;
+
+    /** @var int */
+    private $requestsRemaining;
+
     /**
      * Client constructor.
      * @param string $username
@@ -27,6 +36,9 @@ function __construct($username, $password, $test=false) {
         $this->username = $username;
         $this->password = $password;
 
+        $this->limit = 1;
+        $this->requestsRemaining = 1;
+
         $options = [
             'base_uri' => sprintf(($test ? Client::BASE_URI_TEST : Client::BASE_URI), Client::API_VERSION),
             'auth' => [$this->username, $this->password],
@@ -42,6 +54,22 @@ function __construct($username, $password, $test=false) {
         $this->guzzle = new \GuzzleHttp\Client($options);
     }
 
+    /**
+     * @return int
+     */
+    public function getLimit()
+    {
+        return $this->limit;
+    }
+
+    /**
+     * @return int
+     */
+    public function getRequestsRemaining()
+    {
+        return $this->requestsRemaining;
+    }
+
     /**
      * @param string $method
      * @param array $data
@@ -51,18 +79,10 @@ function __construct($username, $password, $test=false) {
     public function get($method, $data = []) {
         try {
             $result = $this->guzzle->get($method, ['query' => $data]);
+            $this->updateLimitAndRemaining($result->getHeader('X-RateLimit-Limit')[0], $result->getHeader('X-RateLimit-Remaining')[0]);
             return json_decode($result->getBody());
         } catch (RequestException $e) {
-            $data = json_decode($e->getResponse()->getBody());
-            if($data == NULL) {
-                throw new \Exception($e->getResponse()->getBody());
-            } else {
-                if(isset($data->message) || isset($data->errors)) {
-                    throw new \Exception(json_encode($data), $e->getCode());
-                } else {
-                    throw new \Exception($e->getMessage(), $e->getCode());
-                }
-            }
+            throw XolphinRequestException::createFromRequestException($e);
         }
     }
 
@@ -91,34 +111,35 @@ public function post($method, $data = []) {
             }
 
             $result = $this->guzzle->post($method, ['multipart' => $mp]);
+            $this->updateLimitAndRemaining($result->getHeader('X-RateLimit-Limit')[0], $result->getHeader('X-RateLimit-Remaining')[0]);
             return json_decode($result->getBody());
         } catch (RequestException $e) {
-            $data = json_decode($e->getResponse()->getBody());
-            if($data == NULL) {
-                throw new \Exception($e->getResponse()->getBody());
-            } else {
-                throw new \Exception(json_encode($data), $e->getCode());
-            }
+            throw XolphinRequestException::createFromRequestException($e);
         }
     }
 
+    /**
+     * @param $limit
+     * @param $remaining
+     */
+    public function updateLimitAndRemaining($limit, $remaining) {
+        $this->limit = $limit;
+        $this->requestsRemaining = $remaining;
+    }
+
     /**
      * @param string $method
      * @param array $data
-     * @return \Psr\Http\Message\StreamInterface
+     * @return StreamInterface
      * @throws \Exception
      */
     public function download($method, $data = []) {
         try {
             $result = $this->guzzle->get($method, ['query' => $data]);
+            $this->updateLimitAndRemaining($result->getHeader('X-RateLimit-Limit')[0], $result->getHeader('X-RateLimit-Remaining')[0]);
             return $result->getBody();
         } catch (RequestException $e) {
-            try {
-                $data = json_decode($e->getResponse()->getBody());
-                throw new \Exception($data->message);
-            } catch (\Exception $ex) {
-                throw new \Exception($e->getResponse()->getBody());
-            }
+            throw XolphinRequestException::createFromRequestException($e);
         }
     }
 
@@ -142,4 +163,11 @@ public function certificate() {
     public function support() {
         return new Support($this);
     }
+
+    /**
+     * @return Invoice
+     */
+    public function invoice() {
+        return new Invoice($this);
+    }
 }

src/Endpoint/Certificate.php

@@ -2,11 +2,12 @@
 
 namespace Xolphin\Endpoint;
 
+use Exception;
 use Xolphin\Client;
 use Xolphin\Requests\Reissue;
 use Xolphin\Requests\Renew;
 use Xolphin\Responses\Base;
-use Xolphin\Responses\Request as RequestResponse;
+use Xolphin\Responses\Request;
 
 class Certificate {
     /**
@@ -24,6 +25,7 @@ function __construct($client) {
 
     /**
      * @return \Xolphin\Responses\Certificate[]
+     * @throws Exception
      */
     public function all() {
         $certificates = [];
@@ -44,6 +46,7 @@ public function all() {
     /**
      * @param int $id
      * @return \Xolphin\Responses\Certificate
+     * @throws Exception
      */
     public function get($id) {
         return new \Xolphin\Responses\Certificate($this->client->get('certificates/' . $id));
@@ -53,6 +56,7 @@ public function get($id) {
      * @param int $id
      * @param string $format
      * @return mixed
+     * @throws Exception
      */
     public function download($id, $format = 'CRT') {
         return $this->client->download('certificates/' . $id . '/download', [
@@ -63,19 +67,21 @@ public function download($id, $format = 'CRT') {
     /**
      * @param int $id
      * @param Reissue $request
-     * @return RequestResponse
+     * @return Request
+     * @throws Exception
      */
     public function reissue($id, $request) {
-        return new RequestResponse($this->client->post('certificates/' . $id . '/reissue', $request->getArray()));
+        return new Request($this->client->post('certificates/' . $id . '/reissue', $request->getArray()));
     }
 
     /**
      * @param int $id
      * @param Renew $request
-     * @return RequestResponse
+     * @return Request
+     * @throws Exception
      */
     public function renew($id, $request) {
-        return new RequestResponse($this->client->post('certificates/' . $id . '/renew', $request->getArray()));
+        return new Request($this->client->post('certificates/' . $id . '/renew', $request->getArray()));
     }
 
     public function cancel($id, $reason, $revoke = FALSE) {

src/Endpoint/Invoice.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Xolphin\Endpoint;
+
+use Exception;
+use Xolphin\Client;
+use Xolphin\Responses\Invoices;
+
+class Invoice {
+    /**
+     * @var Client
+     */
+    private $client;
+
+    /**
+     * Requests constructor.
+     * @param Client $client
+     */
+    function __construct($client) {
+        $this->client = $client;
+    }
+
+    /**
+     * @return \Xolphin\Responses\Invoice[]
+     * @throws Exception
+     */
+    public function all() {
+        $invoices = [];
+
+        $result = new Invoices($this->client->get('invoices', ['page' => 1]));
+        if(!$result->isError()) {
+            $invoices = $result->invoices;
+            while($result->page < $result->pages) {
+                $result = new Invoices($this->client->get('invoices', ['page' => $result->page + 1]));
+                if($result->isError()) break;
+                $invoices = array_merge($invoices, $result->invoices);
+            }
+        }
+
+        return $invoices;
+    }
+
+    /**
+     * @param $id
+     * @return \Xolphin\Responses\Invoice
+     * @throws Exception
+     */
+    public function get($id) {
+        return new \Xolphin\Responses\Invoice($this->client->get('invoices/' . $id));
+    }
+
+    /**
+     * @param $id
+     * @param string $format
+     * @return mixed
+     * @throws Exception
+     */
+    public function download($id, $format = 'PDF') {
+        return $this->client->get('invoices/' . $id . '/download?type=' . $format);
+    }
+}