[fix #44] Add support for last_ad_referral in UserResponse

ker0x · Apr 23, 2017 · d9b0035 · d9b0035
1 parent 4e5fa53
commit d9b0035
Show file tree

Hide file tree

Showing 19 changed files with 164 additions and 27 deletions.
diff --git a/src/Model/Callback/AccountLinking.php b/src/Model/Callback/AccountLinking.php
@@ -53,9 +53,9 @@ public function getAuthorizationCode()
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\AccountLinking
      */
-    public static function create(array $payload)
+    public static function create(array $payload): AccountLinking
     {
         $authorizationCode = $payload['authorization_code'] ?? null;
 

diff --git a/src/Model/Callback/CheckoutUpdate.php b/src/Model/Callback/CheckoutUpdate.php
@@ -47,9 +47,9 @@ public function getShippingAddress(): Address
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\CheckoutUpdate
      */
-    public static function create(array $payload)
+    public static function create(array $payload): CheckoutUpdate
     {
         $shippingAddress = Address::create($payload['shipping_address']);
 

diff --git a/src/Model/Callback/Delivery.php b/src/Model/Callback/Delivery.php
@@ -60,9 +60,9 @@ public function getMessageIds(): array
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Delivery
      */
-    public static function create(array $payload)
+    public static function create(array $payload): Delivery
     {
         $messageIds = $payload['mids'] ?? [];
 

diff --git a/src/Model/Callback/Entry.php b/src/Model/Callback/Entry.php
@@ -62,9 +62,9 @@ public function getEvents(): array
 
     /**
      * @param array $entry
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Entry
      */
-    public static function create(array $entry)
+    public static function create(array $entry): Entry
     {
         $events = [];
         foreach ($entry['messaging'] as $event) {

diff --git a/src/Model/Callback/Message.php b/src/Model/Callback/Message.php
@@ -119,7 +119,7 @@ public function hasAttachments(): bool
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Message
      */
     public static function create(array $payload)
     {

diff --git a/src/Model/Callback/MessageEcho.php b/src/Model/Callback/MessageEcho.php
@@ -75,7 +75,7 @@ public function getMetadata()
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\MessageEcho
      */
     public static function create(array $payload)
     {

diff --git a/src/Model/Callback/Optin.php b/src/Model/Callback/Optin.php
@@ -30,9 +30,9 @@ public function getRef(): string
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Optin
      */
-    public static function create(array $payload)
+    public static function create(array $payload): Optin
     {
         return new static($payload['ref']);
     }

diff --git a/src/Model/Callback/Payment.php b/src/Model/Callback/Payment.php
@@ -115,9 +115,9 @@ public function getShippingOptionId(): string
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Payment
      */
-    public static function create(array $payload)
+    public static function create(array $payload): Payment
     {
         $requestedUserInfo = RequestedUserInfo::create($payload['requested_user_info']);
         $paymentCredential = PaymentCredential::create($payload['payment_credential']);

diff --git a/src/Model/Callback/Payment/PaymentCredential.php b/src/Model/Callback/Payment/PaymentCredential.php
@@ -126,9 +126,9 @@ public function getFbPaymentId(): string
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Payment\PaymentCredential
      */
-    public static function create(array $payload)
+    public static function create(array $payload): PaymentCredential
     {
         $tokenizedCard = $payload['tokenized_card'] ?? null;
         $tokenizedCvv = $payload['tokenized_cvv'] ?? null;

diff --git a/src/Model/Callback/Payment/RequestedUserInfo.php b/src/Model/Callback/Payment/RequestedUserInfo.php
@@ -77,9 +77,9 @@ public function getContactPhone(): string
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Payment\RequestedUserInfo
      */
-    public static function create(array $payload)
+    public static function create(array $payload): RequestedUserInfo
     {
         $shippingAddress = Address::create($payload['shipping_address']);
 

diff --git a/src/Model/Callback/Postback.php b/src/Model/Callback/Postback.php
@@ -53,9 +53,9 @@ public function getReferral()
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Postback
      */
-    public static function create(array $payload)
+    public static function create(array $payload): Postback
     {
         $referral = isset($payload['referral']) ? Referral::create($payload['referral']) : null;
 

diff --git a/src/Model/Callback/PreCheckout.php b/src/Model/Callback/PreCheckout.php
@@ -79,9 +79,9 @@ public function getAmount()
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\PreCheckout
      */
-    public static function create(array $payload)
+    public static function create(array $payload): PreCheckout
     {
         $requestedUserInfo = RequestedUserInfo::create($payload['requested_user_info']);
 

diff --git a/src/Model/Callback/Read.php b/src/Model/Callback/Read.php
@@ -45,9 +45,9 @@ public function getSequence(): int
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Read
      */
-    public static function create(array $payload)
+    public static function create(array $payload): Read
     {
         return new static($payload['watermark'], $payload['seq']);
     }

diff --git a/src/Model/Callback/Referral.php b/src/Model/Callback/Referral.php
@@ -60,9 +60,9 @@ public function getType(): string
 
     /**
      * @param array $payload
-     * @return static
+     * @return \Kerox\Messenger\Model\Callback\Referral
      */
-    public static function create(array $payload)
+    public static function create(array $payload): Referral
     {
         return new static($payload['ref'], $payload['source'], $payload['type']);
     }

diff --git a/src/Model/Referral.php b/src/Model/Referral.php
@@ -0,0 +1,98 @@
+<?php
+
+namespace Kerox\Messenger\Model;
+
+class Referral
+{
+
+    /**
+     * @var string
+     */
+    protected $source;
+
+    /**
+     * @var string
+     */
+    protected $type;
+
+    /**
+     * @var string
+     */
+    protected $adId;
+
+    /**
+     * @var null|string
+     */
+    protected $ref;
+
+    /**
+     * Referral constructor.
+     *
+     * @param string $source
+     * @param string $type
+     * @param string $adId
+     */
+    public function __construct(string $source, string $type, string $adId)
+    {
+        $this->source = $source;
+        $this->type = $type;
+        $this->adId = $adId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSource(): string
+    {
+        return $this->source;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAdId(): string
+    {
+        return $this->adId;
+    }
+
+    /**
+     * @return null|string
+     */
+    public function getRef()
+    {
+        return $this->ref;
+    }
+
+    /**
+     * @param string $ref
+     * @return \Kerox\Messenger\Model\Referral
+     */
+    public function setRef(string $ref): Referral
+    {
+        $this->ref = $ref;
+
+        return $this;
+    }
+
+    /**
+     * @param array $referral
+     * @return \Kerox\Messenger\Model\Referral
+     */
+    public static function create(array $referral): Referral
+    {
+        $self = new static($referral['source'], $referral['type'], $referral['ad_id']);
+        if (isset($referral['ref'])) {
+            $self->setRef($referral['ref']);
+        }
+
+        return $self;
+    }
+}
diff --git a/src/Response/UserResponse.php b/src/Response/UserResponse.php
@@ -2,6 +2,7 @@
 
 namespace Kerox\Messenger\Response;
 
+use Kerox\Messenger\Model\Referral;
 use Kerox\Messenger\UserInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -43,6 +44,11 @@ class UserResponse extends AbstractResponse implements UserInterface
      */
     protected $isPaymentEnabled;
 
+    /**
+     * @var null|\Kerox\Messenger\Model\Referral
+     */
+    protected $lastAdReferral;
+
     /**
      * UserProfileResponse constructor.
      *
@@ -66,6 +72,7 @@ protected function parseResponse(array $response)
         $this->setTimezone($response);
         $this->setGender($response);
         $this->setIsPaymentEnabled($response);
+        $this->setLastAdReferral($response);
     }
 
     /**
@@ -200,4 +207,23 @@ private function setIsPaymentEnabled(array $response)
             $this->isPaymentEnabled = $response[self::IS_PAYMENT_ENABLED];
         }
     }
+
+    /**
+     * @return null|\Kerox\Messenger\Model\Referral
+     */
+    public function getLastAdReferral()
+    {
+        return $this->lastAdReferral;
+    }
+
+    /**
+     * @param array $response
+     * @return void
+     */
+    private function setLastAdReferral(array $response)
+    {
+        if (isset($response[self::LAST_AD_REFERRAL])) {
+            $this->lastAdReferral = Referral::create($response[self::LAST_AD_REFERRAL]);
+        }
+    }
 }
diff --git a/src/UserInterface.php b/src/UserInterface.php
@@ -12,4 +12,5 @@ interface UserInterface
     const TIMEZONE = 'timezone';
     const GENDER = 'gender';
     const IS_PAYMENT_ENABLED = 'is_payment_enabled';
+    const LAST_AD_REFERRAL = 'last_ad_referral';
 }
diff --git a/tests/Mocks/Response/User/user.json b/tests/Mocks/Response/User/user.json
@@ -5,5 +5,11 @@
   "locale": "en_US",
   "timezone": -7,
   "gender": "male",
-  "is_payment_enabled": true
+  "is_payment_enabled": true,
+  "last_ad_referral": {
+    "source": "ADS",
+    "type": "OPEN_THREAD",
+    "ad_id": "6045246247433",
+    "ref": "myparam"
+  }
 }
diff --git a/tests/TestCase/Response/UserResponseTest.php b/tests/TestCase/Response/UserResponseTest.php
@@ -2,6 +2,7 @@
 namespace Kerox\Messenger\Test\TestCase\Response;
 
 use GuzzleHttp\Psr7\Response;
+use Kerox\Messenger\Model\Referral;
 use Kerox\Messenger\Response\UserResponse;
 use Kerox\Messenger\Test\TestCase\AbstractTestCase;
 
@@ -22,5 +23,10 @@ public function testUserResponse()
         $this->assertEquals(-7, $userResponse->getTimezone());
         $this->assertEquals('male', $userResponse->getGender());
         $this->assertTrue($userResponse->getIsPaymentEnabled());
+        $this->assertInstanceOf(Referral::class, $userResponse->getLastAdReferral());
+        $this->assertEquals('ADS', $userResponse->getLastAdReferral()->getSource());
+        $this->assertEquals('OPEN_THREAD', $userResponse->getLastAdReferral()->getType());
+        $this->assertEquals('6045246247433', $userResponse->getLastAdReferral()->getAdId());
+        $this->assertEquals('myparam', $userResponse->getLastAdReferral()->getRef());
     }
 }