From de13ff66ce92f74929a671ddf204bd4e18a5bfbc Mon Sep 17 00:00:00 2001
From: Tobias Nyholm <tobias.nyholm@gmail.com>
Date: Wed, 7 Dec 2016 19:03:50 +0100
Subject: [PATCH] Added Event API with pagination (#245)

* Added Event API with pagination

* code style

* code style
---
 src/Mailgun/Api/Event.php                     |  78 +++
 src/Mailgun/Api/Pagination.php                |  42 ++
 src/Mailgun/Mailgun.php                       |   8 +
 src/Mailgun/Resource/Api/Event/Event.php      | 505 ++++++++++++++++++
 .../Resource/Api/Event/EventResponse.php      |  56 ++
 .../Resource/Api/PaginationResponse.php       |  69 +++
 6 files changed, 758 insertions(+)
 create mode 100644 src/Mailgun/Api/Event.php
 create mode 100644 src/Mailgun/Api/Pagination.php
 create mode 100644 src/Mailgun/Resource/Api/Event/Event.php
 create mode 100644 src/Mailgun/Resource/Api/Event/EventResponse.php
 create mode 100644 src/Mailgun/Resource/Api/PaginationResponse.php

diff --git a/src/Mailgun/Api/Event.php b/src/Mailgun/Api/Event.php
new file mode 100644
index 0000000..32add8a
--- /dev/null
+++ b/src/Mailgun/Api/Event.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * Copyright (C) 2013-2016 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Api;
+
+use Mailgun\Assert;
+use Mailgun\Resource\Api\Event\EventResponse;
+
+/**
+ * {@link https://documentation.mailgun.com/api-events.html}.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class Event extends HttpApi
+{
+    use Pagination;
+
+    /**
+     * @param string $domain
+     * @param array  $params
+     *
+     * @return EventResponse
+     */
+    public function get($domain, array $params = [])
+    {
+        Assert::stringNotEmpty($domain);
+
+        $response = $this->httpGet(sprintf('/v3/%s/events', $domain), $params);
+
+        return $this->safeDeserialize($response, EventResponse::class);
+    }
+
+    /**
+     * @param EventResponse $eventResponse
+     *
+     * @return EventResponse|null
+     */
+    public function getPaginationNext(EventResponse $eventResponse)
+    {
+        return $this->getPaginationUrl($eventResponse->getNextUrl(), EventResponse::class);
+    }
+
+    /**
+     * @param EventResponse $eventResponse
+     *
+     * @return EventResponse|null
+     */
+    public function getPaginationPrevious(EventResponse $eventResponse)
+    {
+        return $this->getPaginationUrl($eventResponse->getPreviousUrl(), EventResponse::class);
+    }
+
+    /**
+     * @param EventResponse $eventResponse
+     *
+     * @return EventResponse|null
+     */
+    public function getPaginationFirst(EventResponse $eventResponse)
+    {
+        return $this->getPaginationUrl($eventResponse->getPreviousUrl(), EventResponse::class);
+    }
+
+    /**
+     * @param EventResponse $eventResponse
+     *
+     * @return EventResponse|null
+     */
+    public function getPaginationLast(EventResponse $eventResponse)
+    {
+        return $this->getPaginationUrl($eventResponse->getPreviousUrl(), EventResponse::class);
+    }
+}
diff --git a/src/Mailgun/Api/Pagination.php b/src/Mailgun/Api/Pagination.php
new file mode 100644
index 0000000..16f5abd
--- /dev/null
+++ b/src/Mailgun/Api/Pagination.php
@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * Copyright (C) 2013-2016 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Api;
+
+use Mailgun\Assert;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+trait Pagination
+{
+    abstract protected function httpGet($path, array $parameters = [], array $requestHeaders = []);
+
+    abstract protected function safeDeserialize(ResponseInterface $response, $className);
+
+    /**
+     * @param string $url
+     * @param string $class
+     *
+     * @return mixed|null
+     */
+    public function getPaginationUrl($url, $class)
+    {
+        Assert::stringNotEmpty($class);
+
+        if (empty($url)) {
+            return;
+        }
+
+        $response = $this->httpGet($url);
+
+        return $this->safeDeserialize($response, $class);
+    }
+}
diff --git a/src/Mailgun/Mailgun.php b/src/Mailgun/Mailgun.php
index 72b63fe..f9a4c48 100644
--- a/src/Mailgun/Mailgun.php
+++ b/src/Mailgun/Mailgun.php
@@ -268,4 +268,12 @@ class Mailgun
     {
         return new Api\Domain($this->httpClient, $this->requestBuilder, $this->deserializer);
     }
+
+    /**
+     * @return Api\Event
+     */
+    public function event()
+    {
+        return new Api\Event($this->httpClient, $this->requestBuilder, $this->deserializer);
+    }
 }
diff --git a/src/Mailgun/Resource/Api/Event/Event.php b/src/Mailgun/Resource/Api/Event/Event.php
new file mode 100644
index 0000000..badb123
--- /dev/null
+++ b/src/Mailgun/Resource/Api/Event/Event.php
@@ -0,0 +1,505 @@
+<?php
+
+/*
+ * Copyright (C) 2013-2016 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Resource\Api\Event;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class Event
+{
+    /**
+     * @var string status
+     */
+    private $event;
+
+    /**
+     * @var string
+     */
+    private $id;
+
+    /**
+     * @var float
+     */
+    private $timestamp;
+
+    /**
+     * A \DateTime representation of $timestamp.
+     *
+     * @var \DateTime
+     */
+    private $eventDate;
+
+    /**
+     * @var array|string[]
+     */
+    private $tags = [];
+
+    /**
+     * @var string
+     */
+    private $url;
+
+    /**
+     * @var string
+     */
+    private $severity;
+
+    /**
+     * @var array
+     */
+    private $envelope = [];
+
+    /**
+     * @var array
+     */
+    private $deliveryStatus;
+
+    /**
+     * @var array|string[]
+     */
+    private $campaigns = [];
+
+    /**
+     * @var string
+     */
+    private $ip;
+
+    /**
+     * @var array
+     */
+    private $clientInfo = [];
+
+    /**
+     * @var string
+     */
+    private $reason;
+
+    /**
+     * @var array
+     */
+    private $userVariables = [];
+
+    /**
+     * @var array key=>bool
+     */
+    private $flags = [];
+
+    /**
+     * @var array multi dimensions
+     */
+    private $routes = [];
+
+    /**
+     * @var array multi dimensions
+     */
+    private $message = [];
+
+    /**
+     * @var string
+     */
+    private $recipient;
+
+    /**
+     * @var array
+     */
+    private $geolocation = [];
+
+    /**
+     * @var array
+     */
+    private $storage = [];
+
+    /**
+     * @var string
+     */
+    private $method;
+
+    /**
+     * @param string $event
+     * @param string $id
+     * @param float  $timestamp
+     */
+    public function __construct($event, $id, $timestamp)
+    {
+        $this->event = $event;
+        $this->id = $id;
+        $this->timestamp = $timestamp;
+        $this->eventDate = new \DateTime();
+        $this->eventDate->setTimestamp((int) $timestamp);
+    }
+
+    /**
+     * @param array $data
+     *
+     * @return Event
+     */
+    public static function create(array $data)
+    {
+        $event = new self($data['event'], $data['id'], $data['timestamp']);
+
+        if (isset($data['tags'])) {
+            $event->setTags($data['tags']);
+        }
+        if (isset($data['envelope'])) {
+            $event->setEnvelope($data['envelope']);
+        }
+        if (isset($data['campaigns'])) {
+            $event->setCampaigns($data['campaigns']);
+        }
+        if (isset($data['user-variables'])) {
+            $event->setUserVariables($data['user-variables']);
+        }
+        if (isset($data['flags'])) {
+            $event->setFlags($data['flags']);
+        }
+        if (isset($data['routes'])) {
+            $event->setRoutes($data['routes']);
+        }
+        if (isset($data['message'])) {
+            $event->setMessage($data['message']);
+        }
+        if (isset($data['recipient'])) {
+            $event->setRecipient($data['recipient']);
+        }
+        if (isset($data['method'])) {
+            $event->setMethod($data['method']);
+        }
+        if (isset($data['delivery-status'])) {
+            $event->setDeliveryStatus($data['delivery-status']);
+        }
+        if (isset($data['severity'])) {
+            $event->setSeverity($data['severity']);
+        }
+        if (isset($data['reason'])) {
+            $event->setReason($data['reason']);
+        }
+        if (isset($data['geolocation'])) {
+            $event->setGeolocation($data['geolocation']);
+        }
+        if (isset($data['ip'])) {
+            $event->setIp($data['ip']);
+        }
+        if (isset($data['client-info'])) {
+            $event->setClientInfo($data['client-info']);
+        }
+        if (isset($data['url'])) {
+            $event->setUrl($data['url']);
+        }
+        if (isset($data['storage'])) {
+            $event->setStorage($data['storage']);
+        }
+
+        return $event;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEvent()
+    {
+        return $this->event;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return float
+     */
+    public function getTimestamp()
+    {
+        return $this->timestamp;
+    }
+
+    /**
+     * @return \DateTime
+     */
+    public function getEventDate()
+    {
+        return $this->eventDate;
+    }
+
+    /**
+     * @return array|\string[]
+     */
+    public function getTags()
+    {
+        return $this->tags;
+    }
+
+    /**
+     * @param array|\string[] $tags
+     */
+    private function setTags($tags)
+    {
+        $this->tags = $tags;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl()
+    {
+        return $this->url;
+    }
+
+    /**
+     * @param string $url
+     */
+    private function setUrl($url)
+    {
+        $this->url = $url;
+    }
+
+    /**
+     * @return array
+     */
+    public function getEnvelope()
+    {
+        return $this->envelope;
+    }
+
+    /**
+     * @param array $envelope
+     */
+    private function setEnvelope($envelope)
+    {
+        $this->envelope = $envelope;
+    }
+
+    /**
+     * @return array
+     */
+    public function getDeliveryStatus()
+    {
+        return $this->deliveryStatus;
+    }
+
+    /**
+     * @param array $deliveryStatus
+     */
+    private function setDeliveryStatus($deliveryStatus)
+    {
+        $this->deliveryStatus = $deliveryStatus;
+    }
+
+    /**
+     * @return array|\string[]
+     */
+    public function getCampaigns()
+    {
+        return $this->campaigns;
+    }
+
+    /**
+     * @param array|\string[] $campaigns
+     */
+    private function setCampaigns($campaigns)
+    {
+        $this->campaigns = $campaigns;
+    }
+
+    /**
+     * @return string
+     */
+    public function getIp()
+    {
+        return $this->ip;
+    }
+
+    /**
+     * @param string $ip
+     */
+    private function setIp($ip)
+    {
+        $this->ip = $ip;
+    }
+
+    /**
+     * @return array
+     */
+    public function getClientInfo()
+    {
+        return $this->clientInfo;
+    }
+
+    /**
+     * @param array $clientInfo
+     */
+    private function setClientInfo($clientInfo)
+    {
+        $this->clientInfo = $clientInfo;
+    }
+
+    /**
+     * @return string
+     */
+    public function getReason()
+    {
+        return $this->reason;
+    }
+
+    /**
+     * @param string $reason
+     */
+    private function setReason($reason)
+    {
+        $this->reason = $reason;
+    }
+
+    /**
+     * @return array
+     */
+    public function getUserVariables()
+    {
+        return $this->userVariables;
+    }
+
+    /**
+     * @param array $userVariables
+     */
+    private function setUserVariables($userVariables)
+    {
+        $this->userVariables = $userVariables;
+    }
+
+    /**
+     * @return array
+     */
+    public function getFlags()
+    {
+        return $this->flags;
+    }
+
+    /**
+     * @param array $flags
+     */
+    private function setFlags($flags)
+    {
+        $this->flags = $flags;
+    }
+
+    /**
+     * @return array
+     */
+    public function getRoutes()
+    {
+        return $this->routes;
+    }
+
+    /**
+     * @param array $routes
+     */
+    private function setRoutes($routes)
+    {
+        $this->routes = $routes;
+    }
+
+    /**
+     * @return array
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+
+    /**
+     * @param array $message
+     */
+    private function setMessage($message)
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRecipient()
+    {
+        return $this->recipient;
+    }
+
+    /**
+     * @param string $recipient
+     */
+    private function setRecipient($recipient)
+    {
+        $this->recipient = $recipient;
+    }
+
+    /**
+     * @return array
+     */
+    public function getGeolocation()
+    {
+        return $this->geolocation;
+    }
+
+    /**
+     * @param array $geolocation
+     */
+    private function setGeolocation($geolocation)
+    {
+        $this->geolocation = $geolocation;
+    }
+
+    /**
+     * @return array
+     */
+    public function getStorage()
+    {
+        return $this->storage;
+    }
+
+    /**
+     * @param array $storage
+     */
+    private function setStorage($storage)
+    {
+        $this->storage = $storage;
+    }
+
+    /**
+     * @return string
+     */
+    public function getMethod()
+    {
+        return $this->method;
+    }
+
+    /**
+     * @param string $method
+     */
+    private function setMethod($method)
+    {
+        $this->method = $method;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSeverity()
+    {
+        return $this->severity;
+    }
+
+    /**
+     * @param string $severity
+     */
+    private function setSeverity($severity)
+    {
+        $this->severity = $severity;
+    }
+}
diff --git a/src/Mailgun/Resource/Api/Event/EventResponse.php b/src/Mailgun/Resource/Api/Event/EventResponse.php
new file mode 100644
index 0000000..1be8b59
--- /dev/null
+++ b/src/Mailgun/Resource/Api/Event/EventResponse.php
@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * Copyright (C) 2013-2016 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Resource\Api\Event;
+
+use Mailgun\Resource\Api\PaginationResponse;
+use Mailgun\Resource\ApiResponse;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class EventResponse implements ApiResponse
+{
+    use PaginationResponse;
+
+    /**
+     * @var Event[]
+     */
+    private $items;
+
+    /**
+     * @param Event[] $items
+     * @param array   $paging
+     */
+    public function __construct(array $items, array $paging)
+    {
+        $this->items = $items;
+        $this->paging = $paging;
+    }
+
+    public static function create(array $data)
+    {
+        $events = [];
+        if (isset($data['items'])) {
+            foreach ($data['items'] as $item) {
+                $events[] = Event::create($item);
+            }
+        }
+
+        return new self($events, $data['paging']);
+    }
+
+    /**
+     * @return Event[]
+     */
+    public function getItems()
+    {
+        return $this->items;
+    }
+}
diff --git a/src/Mailgun/Resource/Api/PaginationResponse.php b/src/Mailgun/Resource/Api/PaginationResponse.php
new file mode 100644
index 0000000..197eb75
--- /dev/null
+++ b/src/Mailgun/Resource/Api/PaginationResponse.php
@@ -0,0 +1,69 @@
+<?php
+
+/*
+ * Copyright (C) 2013-2016 Mailgun
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+
+namespace Mailgun\Resource\Api;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+trait PaginationResponse
+{
+    /**
+     * @var array
+     */
+    protected $paging;
+
+    /**
+     * @return string
+     */
+    public function getNextUrl()
+    {
+        if (!isset($this->paging['next'])) {
+            return;
+        }
+
+        return $this->paging['next'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getPreviousUrl()
+    {
+        if (!isset($this->paging['previous'])) {
+            return;
+        }
+
+        return $this->paging['previous'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getFistUrl()
+    {
+        if (!isset($this->paging['first'])) {
+            return;
+        }
+
+        return $this->paging['first'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getLastUrl()
+    {
+        if (!isset($this->paging['last'])) {
+            return;
+        }
+
+        return $this->paging['last'];
+    }
+}