Merge pull request #17 from ker0x/develop

Develop
ker0x · Jan 21, 2017 · 29ebcba · 29ebcba
2 parents fecf7f4 + f036352
commit 29ebcba
Show file tree

Hide file tree

Showing 10 changed files with 267 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -18,10 +18,8 @@ A PHP libray to send message and configure thread to [Facebook Messenger](https:
 To install this plugin, run `composer require kerox/messenger` or add this snippet in your project’s composer.json.
 
 ```json
-{
-    "require": {
-        "kerox/messenger": "~1.0"
-    }
+"require": {
+    "kerox/messenger": "~1.0"
 }
 ```
 
@@ -42,7 +40,7 @@ To be able to send messages to an user, you need to configure a webhook in your
 Once your webhook is configured, you need to validate the callback URL
 
 ```php
-if ($messenger->webhook()->isValidToken()) {
+if (!$messenger->webhook()->isValidToken()) {
     // Display an error
 }
 
@@ -59,7 +57,7 @@ if (!$messenger->webhook()->isValidCallback()) {
     header("HTTP/1.1 400 Invalid Request");
 }
 
-$events = $this->messenger->webhook()->getCallbackEvents();
+$events = $messenger->webhook()->getCallbackEvents();
 foreach ($events as $event) {
     if ($event instance of MessageEvent) {
         $message = $event->getMessage();

diff --git a/composer.json b/composer.json
@@ -2,6 +2,7 @@
   "name": "kerox/messenger",
   "type": "library",
   "description": "PHP Library for Facebook Messenger",
+  "keywords": ["facebook", "messenger", "facebook messenger", "bot messenger", "api"],
   "homepage": "https://github.com/ker0x/messenger",
   "license": "MIT",
   "authors": [

diff --git a/src/Event/CheckoutUpdateEvent.php b/src/Event/CheckoutUpdateEvent.php
@@ -0,0 +1,60 @@
+<?php
+namespace Kerox\Messenger\Event;
+
+use Kerox\Messenger\Model\Callback\CheckoutUpdate;
+
+class CheckoutUpdateEvent extends AbstractEvent
+{
+
+    const NAME = 'checkout_update';
+
+    /**
+     * @var int
+     */
+    protected $timestamp;
+
+    /**
+     * @var \Kerox\Messenger\Model\Callback\CheckoutUpdate
+     */
+    protected $checkoutUpdate;
+
+    /**
+     * CheckoutUpdateEvent constructor.
+     *
+     * @param string $senderId
+     * @param string $recipientId
+     * @param int $timestamp
+     * @param \Kerox\Messenger\Model\Callback\CheckoutUpdate $checkoutUpdate
+     */
+    public function __construct(string $senderId, string $recipientId, int $timestamp, CheckoutUpdate $checkoutUpdate)
+    {
+        parent::__construct($senderId, $recipientId);
+
+        $this->timestamp = $timestamp;
+        $this->checkoutUpdate = $checkoutUpdate;
+    }
+
+    /**
+     * @return int
+     */
+    public function getTimestamp(): int
+    {
+        return $this->timestamp;
+    }
+
+    /**
+     * @return \Kerox\Messenger\Model\Callback\CheckoutUpdate
+     */
+    public function getCheckoutUpdate(): CheckoutUpdate
+    {
+        return $this->checkoutUpdate;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName(): string
+    {
+        return self::NAME;
+    }
+}
diff --git a/src/Event/EventFactory.php b/src/Event/EventFactory.php
@@ -3,6 +3,7 @@
 
 use Kerox\Messenger\Helper\UtilityTrait;
 use Kerox\Messenger\Model\Callback\AccountLinking;
+use Kerox\Messenger\Model\Callback\CheckoutUpdate;
 use Kerox\Messenger\Model\Callback\Delivery;
 use Kerox\Messenger\Model\Callback\Message;
 use Kerox\Messenger\Model\Callback\MessageEcho;
@@ -24,6 +25,7 @@ class EventFactory
         'delivery',
         'read',
         'payment',
+        'checkout_update',
     ];
 
     /**
@@ -146,7 +148,11 @@ public static function createReadEvent($payload): ReadEvent
         return new ReadEvent($senderId, $recipientId, $timestamp, $read);
     }
 
-    public static function createPaymentEvent(array $payload)
+    /**
+     * @param array $payload
+     * @return \Kerox\Messenger\Event\PaymentEvent
+     */
+    public static function createPaymentEvent(array $payload): PaymentEvent
     {
         $senderId = $payload['sender']['id'];
         $recipientId = $payload['recipient']['id'];
@@ -155,4 +161,18 @@ public static function createPaymentEvent(array $payload)
 
         return new PaymentEvent($senderId, $recipientId, $timestamp, $payment);
     }
+
+    /**
+     * @param array $payload
+     * @return \Kerox\Messenger\Event\CheckoutUpdateEvent
+     */
+    public static function createCheckoutUpdateEvent(array $payload)
+    {
+        $senderId = $payload['sender']['id'];
+        $recipientId = $payload['recipient']['id'];
+        $timestamp = $payload['timestamp'];
+        $checkoutUpdate = CheckoutUpdate::create($payload['checkout_update']);
+
+        return new CheckoutUpdateEvent($senderId, $recipientId, $timestamp, $checkoutUpdate);
+    }
 }
diff --git a/src/Model/Callback/CheckoutUpdate.php b/src/Model/Callback/CheckoutUpdate.php
@@ -0,0 +1,57 @@
+<?php
+namespace Kerox\Messenger\Model\Callback;
+
+use Kerox\Messenger\Model\Common\Address;
+
+class CheckoutUpdate
+{
+
+    /**
+     * @var string
+     */
+    protected $payload;
+
+    /**
+     * @var \Kerox\Messenger\Model\Common\Address
+     */
+    protected $shippingAddress;
+
+    /**
+     * CheckoutUpdate constructor.
+     *
+     * @param string $payload
+     * @param \Kerox\Messenger\Model\Common\Address $shippingAddress
+     */
+    public function __construct(string $payload, Address $shippingAddress)
+    {
+        $this->payload = $payload;
+        $this->shippingAddress = $shippingAddress;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPayload(): string
+    {
+        return $this->payload;
+    }
+
+    /**
+     * @return \Kerox\Messenger\Model\Common\Address
+     */
+    public function getShippingAddress(): Address
+    {
+        return $this->shippingAddress;
+    }
+
+    /**
+     * @param array $payload
+     * @return static
+     */
+    public static function create(array $payload)
+    {
+        $shippingAddress = Address::create($payload['shipping_address']);
+
+        return new static($payload['payload'], $shippingAddress);
+    }
+}
diff --git a/src/Model/Common/Address.php b/src/Model/Common/Address.php
@@ -34,6 +34,11 @@ class Address implements \JsonSerializable
      */
     protected $country;
 
+    /**
+     * @var null|int
+     */
+    protected $id;
+
     /**
      * Address constructor.
      *
@@ -116,6 +121,25 @@ public function getCountry(): string
         return $this->country;
     }
 
+    /**
+     * @param int $id
+     * @return Address
+     */
+    public function setId(int $id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    /**
+     * @return null|int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
     /**
      * @return array
      */
@@ -128,6 +152,7 @@ public function jsonSerialize(): array
             'postal_code' => $this->postalCode,
             'state' => $this->state,
             'country' => $this->country,
+            'id' => $this->id,
         ];
 
         return array_filter($json);
@@ -145,6 +170,10 @@ public static function create(array $payload)
             $address->setAdditionalStreet($payload['street_2']);
         }
 
+        if (isset($payload['id'])) {
+            $address->setId($payload['id']);
+        }
+
         return $address;
     }
 }
diff --git a/tests/Mocks/Event/checkout_update.json b/tests/Mocks/Event/checkout_update.json
@@ -0,0 +1,21 @@
+{
+  "recipient": {
+    "id": "PAGE_ID"
+  },
+  "timestamp": 1473204787206,
+  "sender": {
+    "id": "USER_ID"
+  },
+  "checkout_update": {
+    "payload": "DEVELOPER_DEFINED_PAYLOAD",
+    "shipping_address": {
+      "id": 10105655000959552,
+      "country": "US",
+      "city": "MENLO PARK",
+      "street_1": "1 Hacker Way",
+      "street_2": "",
+      "state": "CA",
+      "postal_code": "94025"
+    }
+  }
+}
diff --git a/tests/TestCase/Event/EventFactoryTest.php b/tests/TestCase/Event/EventFactoryTest.php
@@ -2,6 +2,7 @@
 namespace Kerox\Messenger\Test\TestCase\Event;
 
 use Kerox\Messenger\Event\AccountLinkingEvent;
+use Kerox\Messenger\Event\CheckoutUpdateEvent;
 use Kerox\Messenger\Event\EventFactory;
 use Kerox\Messenger\Event\DeliveryEvent;
 use Kerox\Messenger\Event\MessageEchoEvent;
@@ -12,6 +13,7 @@
 use Kerox\Messenger\Event\RawEvent;
 use Kerox\Messenger\Event\ReadEvent;
 use Kerox\Messenger\Model\Callback\AccountLinking;
+use Kerox\Messenger\Model\Callback\CheckoutUpdate;
 use Kerox\Messenger\Model\Callback\Delivery;
 use Kerox\Messenger\Model\Callback\Message;
 use Kerox\Messenger\Model\Callback\MessageEcho;
@@ -122,4 +124,15 @@ public function testPaymentEvent()
 
         $this->assertEquals($expectedEvent, $event);
     }
+
+    public function testCheckoutEvent()
+    {
+        $json = file_get_contents(__DIR__ . '/../../Mocks/Event/checkout_update.json');
+        $array = json_decode($json, true);
+
+        $expectedEvent = new CheckoutUpdateEvent('USER_ID', 'PAGE_ID', 1473204787206, CheckoutUpdate::create($array['checkout_update']));
+        $event = EventFactory::create($array);
+
+        $this->assertEquals($expectedEvent, $event);
+    }
 }
diff --git a/tests/TestCase/Event/EventTest.php b/tests/TestCase/Event/EventTest.php
@@ -2,6 +2,7 @@
 namespace Kerox\Messenger\Test\TestCase\Callback;
 
 use Kerox\Messenger\Event\AccountLinkingEvent;
+use Kerox\Messenger\Event\CheckoutUpdateEvent;
 use Kerox\Messenger\Event\DeliveryEvent;
 use Kerox\Messenger\Event\MessageEchoEvent;
 use Kerox\Messenger\Event\MessageEvent;
@@ -10,6 +11,7 @@
 use Kerox\Messenger\Event\PostbackEvent;
 use Kerox\Messenger\Event\ReadEvent;
 use Kerox\Messenger\Model\Callback\AccountLinking;
+use Kerox\Messenger\Model\Callback\CheckoutUpdate;
 use Kerox\Messenger\Model\Callback\Delivery;
 use Kerox\Messenger\Model\Callback\Message;
 use Kerox\Messenger\Model\Callback\MessageEcho;
@@ -116,4 +118,16 @@ public function testPaymentEvent()
         $this->assertEquals($mockedPayment, $event->getPayment());
         $this->assertEquals('payment', $event->getName());
     }
+
+    public function testCheckoutUpdate()
+    {
+        $mockedCheckoutUpdate = $this->createMock(CheckoutUpdate::class);
+        $event = new CheckoutUpdateEvent('sender_id', 'recipient_id', 123456, $mockedCheckoutUpdate);
+
+        $this->assertEquals('sender_id', $event->getSenderId());
+        $this->assertEquals('recipient_id', $event->getRecipientId());
+        $this->assertEquals(123456, $event->getTimestamp());
+        $this->assertEquals($mockedCheckoutUpdate, $event->getCheckoutUpdate());
+        $this->assertEquals('checkout_update', $event->getName());
+    }
 }