feat: Add image aspect ratio to generic template

Author: CasperLaiTW

src/Messages/GenericTemplate.php

@@ -17,6 +17,20 @@
  */
 class GenericTemplate extends Template
 {
+    /**
+     * Horizontal image
+     */
+    const IMAGE_HORIZONTAL = 'horizontal';
+    /**
+     * Square image
+     */
+    const IMAGE_SQUARE = 'square';
+
+    /**
+     * @var string
+     */
+    private $imageRatio = self::IMAGE_HORIZONTAL;
+
     /**
      * Generic constructor.
      *
@@ -42,6 +56,28 @@ public function toData()
         return parent::toData();
     }
 
+    /**
+     * Set image aspect ratio
+     *
+     * @param $value
+     * @return $this
+     */
+    public function setImageRatio($value)
+    {
+        $this->imageRatio = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get image ratio
+     * @return string
+     */
+    public function getImageRatio()
+    {
+        return $this->imageRatio;
+    }
+
     /**
      * @return mixed
      */

src/Transformers/GenericTransformer.php

@@ -8,6 +8,7 @@
 namespace Casperlaitw\LaravelFbMessenger\Transformers;
 
 use Casperlaitw\LaravelFbMessenger\Contracts\Messages\Template;
+use Casperlaitw\LaravelFbMessenger\Messages\GenericTemplate;
 
 /**
  * Class GenericTransformer
@@ -18,14 +19,15 @@ class GenericTransformer implements StructuredTransformer
     /**
      * Transform payload
      *
-     * @param Template $message
+     * @param Template|GenericTemplate $message
      *
      * @return array
      */
     public function transform(Template $message)
     {
         return [
             'template_type' => 'generic',
+            'image_aspect_ratio' => $message->getImageRatio(),
             'elements' => $message->getCollections()->toData()
         ];
     }

tests/Messages/GenericTemplateTest.php

@@ -39,9 +39,10 @@ public function test_to_data()
                     'type' => 'template',
                     'payload' => [
                         'template_type' => 'generic',
-                        'elements' => $elementExpected
+                        'elements' => $elementExpected,
+                        'image_aspect_ratio' => 'horizontal',
                     ],
-                ]
+                ],
             ],
         ];
 
@@ -67,8 +68,9 @@ public function test_disable_share()
                         'template_type' => 'generic',
                         'elements' => $elementExpected,
                         'sharable' => false,
+                        'image_aspect_ratio' => 'horizontal',
                     ],
-                ]
+                ],
             ],
         ];
 
@@ -77,4 +79,32 @@ public function test_disable_share()
 
         $this->assertEquals($expected, $actual->toData());
     }
+
+    public function test_image_ratio()
+    {
+        $elementExpected = [];
+        foreach ($this->case as $case) {
+            $elementExpected[] = $case->toData();
+        }
+        $expected = [
+            'recipient' => [
+                'id' => $this->sender,
+            ],
+            'message' => [
+                'attachment' => [
+                    'type' => 'template',
+                    'payload' => [
+                        'template_type' => 'generic',
+                        'elements' => $elementExpected,
+                        'image_aspect_ratio' => 'square',
+                    ],
+                ],
+            ],
+        ];
+
+        $actual = new GenericTemplate($this->sender, $this->case);
+        $actual->setImageRatio(GenericTemplate::IMAGE_SQUARE);
+        
+        $this->assertEquals($expected, $actual->toData());
+    }
 }

tests/Transformers/GenericTransformerTest.php

@@ -31,6 +31,7 @@ public function test_transform()
 
         $expected = [
             'template_type' => 'generic',
+            'image_aspect_ratio' => 'horizontal',
             'elements' => $expectedCase,
         ];
 
@@ -46,6 +47,7 @@ private function createMessageMock($testCase, $testSender)
         $message = m::mock(Template::class)
             ->shouldReceive('getSender')->andReturn($testSender)
             ->shouldReceive('getCollections')->andReturn($elements)
+            ->shouldReceive('getImageRatio')->andReturn('horizontal')
             ->getMock();
 
         return $message;