Merge branch 'release/1.1.0'

Author: brandonkelly

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release Notes for Webhooks for Craft CMS
 
+## 1.1.0 - 2018-12-13
+
+### Added
+- Added support for webhooks that send GET requests.
+- Webhook names and group names can now contain emojis, even if using MySQL.
+- Typing `->` or `=>` into a webhook’s Name field now creates a ➡️.  
+
 ## 1.0.1 - 2018-12-13
 
 ### Fixed

README.md

@@ -2,7 +2,7 @@
 
 <h1 align="center">Webhooks for Craft CMS</h1>
 
-This plugin adds the ability to manage “webhooks” in Craft CMS, which will create POST requests when certain events occur.
+This plugin adds the ability to manage “webhooks” in Craft CMS, which will send GET or POST requests when certain events occur.
 
 It can be used to integrate your Craft project with task automation tools like [Zapier](https://zapier.com) and [IFTTT](https://ifttt.com).
 
@@ -55,7 +55,7 @@ See [Integrating with Task Automation Tools](#integrating-with-task-automation-t
 
 ![Screenshot of the Edit Webhook page](./screenshot.png)
 
-Webhooks will send a POST request with a JSON body, containing the following keys:
+Webhooks can either send a GET request, or a POST request with a JSON body containing the following keys:
 
 - `time` – an ISO-8601-formatted timestamp of the exact moment the event was triggered. (Webhooks are sent via the queue so there will be a slight delay between the time the event was triggered and the webhook was sent.)
 - `user` – an object representing the logged-in user at the time the event was triggered.
@@ -67,7 +67,7 @@ Webhooks will send a POST request with a JSON body, containing the following key
 
 #### Sending More Data
 
-If you need more data than what’s in the default payload, you can fill in the “Extra User Attributes”, “Extra Sender Attributes”, and “Extra Event Attributes” fields.
+If you need more data than what’s in the default POST request payload, you can fill in the “Extra User Attributes”, “Extra Sender Attributes”, and “Extra Event Attributes” fields.
 
 The attributes listed here (separated by newlines) will be passed to the `$extraFields` argument of the user/sender/event-property’s [toArray()](https://www.yiiframework.com/doc/api/2.0/yii-base-arrayabletrait#toArray()-detail) method (if it has one).
 

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "craftcms/webhooks",
   "description": "Post webhooks when events are triggered in Craft CMS.",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "craft-plugin",
   "keywords": [
     "html",

src/Plugin.php

@@ -28,6 +28,11 @@ class Plugin extends \craft\base\Plugin
      */
     public $hasCpSection = true;
 
+    /**
+     * @inheritdoc
+     */
+    public $schemaVersion = '1.1.0';
+
     // Public Methods
     // =========================================================================
 
@@ -47,25 +52,35 @@ public function init()
         $this->set('webhookManager', $manager);
 
         // Register webhook events
-        foreach ($manager->getEnabledWebhooks() as $webhook) {
+        try {
+            $webhooks = $manager->getEnabledWebhooks();
+        } catch (\Throwable $e) {
+            Craft::error('Unable to fetch enabled webhooks: ' . $e->getMessage(), __METHOD__);
+            Craft::$app->getErrorHandler()->logException($e);
+            $webhooks = [];
+        }
+
+        foreach ($webhooks as $webhook) {
             Event::on($webhook->class, $webhook->event, function(Event $e) use ($webhook) {
-                // Build out the body data
-                $user = Craft::$app->getUser()->getIdentity();
-                $data = [
-                    'time' => (new \DateTime())->format(\DateTime::ATOM),
-                    'user' => $user ? $this->toArray($user, $webhook->getUserAttributes()) : null,
-                    'name' => $e->name,
-                    'senderClass' => get_class($e->sender),
-                    'sender' => $this->toArray($e->sender, $webhook->getSenderAttributes()),
-                    'eventClass' => get_class($e),
-                    'event' => [],
-                ];
-
-                $eventAttributes = $webhook->getEventAttributes();
-                foreach ((new \ReflectionObject($e))->getProperties() as $property) {
-                    if ($property->isPublic() && $property->getDeclaringClass()->getName() !== Event::class) {
-                        $name = $property->getName();
-                        $data['event'][$name] = $this->toArray($e->$name, $eventAttributes[$name] ?? []);
+                if ($webhook->type === 'post') {
+                    // Build out the body data
+                    $user = Craft::$app->getUser()->getIdentity();
+                    $data = [
+                        'time' => (new \DateTime())->format(\DateTime::ATOM),
+                        'user' => $user ? $this->toArray($user, $webhook->getUserAttributes()) : null,
+                        'name' => $e->name,
+                        'senderClass' => get_class($e->sender),
+                        'sender' => $this->toArray($e->sender, $webhook->getSenderAttributes()),
+                        'eventClass' => get_class($e),
+                        'event' => [],
+                    ];
+
+                    $eventAttributes = $webhook->getEventAttributes();
+                    foreach ((new \ReflectionObject($e))->getProperties() as $property) {
+                        if ($property->isPublic() && $property->getDeclaringClass()->getName() !== Event::class) {
+                            $name = $property->getName();
+                            $data['event'][$name] = $this->toArray($e->$name, $eventAttributes[$name] ?? []);
+                        }
                     }
                 }
 
@@ -74,8 +89,9 @@ public function init()
                     'description' => Craft::t('webhooks', 'Sending webhook “{name}”', [
                         'name' => $webhook->name,
                     ]),
+                    'type' => $webhook->type,
                     'url' => $webhook->url,
-                    'data' => $data,
+                    'data' => $data ?? null,
                 ]));
             });
         }

src/SendWebhookJob.php

@@ -14,13 +14,18 @@
  */
 class SendWebhookJob extends BaseJob
 {
+    /**
+     * @var string The request type ('get' or 'post')
+     */
+    public $type = 'post';
+
     /**
      * @var string The URL to send a request to
      */
     public $url;
 
     /**
-     * @var array The data to send in the request
+     * @var array|null The data to send in the request
      */
     public $data;
 
@@ -37,9 +42,12 @@ public function defaultDescription()
      */
     public function execute($queue)
     {
+        $options = [];
+        if ($this->type === 'post' && $this->data !== null) {
+            $options[RequestOptions::JSON] = $this->data;
+        }
+
         $client = Craft::createGuzzleClient();
-        $client->post($this->url, [
-            RequestOptions::JSON => $this->data,
-        ]);
+        $client->request($this->type, $this->url, $options);
     }
 }

src/Webhook.php

@@ -46,6 +46,11 @@ class Webhook extends Model
      */
     public $event;
 
+    /**
+     * @var string
+     */
+    public $type = 'post';
+
     /**
      * @var string
      */
@@ -80,10 +85,11 @@ public function rules()
                     return trim($value, ' \\');
                 }, 'skipOnArray' => true
             ],
-            [['name', 'class', 'event', 'url'], 'required'],
+            [['name', 'class', 'event', 'type', 'url'], 'required'],
             [['name'], UniqueValidator::class, 'targetClass' => WebhookRecord::class],
             [['groupId'], 'number'],
             [['enabled'], 'boolean'],
+            [['type'], 'in', 'range' => ['get', 'post']],
             [['url'], 'url'],
             [
                 ['class'],

src/WebhookManager.php

@@ -4,6 +4,7 @@
 
 use Craft;
 use craft\db\Query;
+use craft\helpers\StringHelper;
 use yii\base\InvalidArgumentException;
 
 /**
@@ -31,8 +32,13 @@ public function getAllGroups(): array
             ->all();
 
         $groups = [];
+        $isMysql = Craft::$app->getDb()->getIsMysql();
 
         foreach ($results as $result) {
+            if ($isMysql) {
+                $result['name'] = html_entity_decode($result['name'], ENT_QUOTES | ENT_HTML5);
+            }
+
             $groups[] = new Group($result);
         }
 
@@ -55,18 +61,24 @@ public function saveGroup(Group $group, bool $runValidation = true): bool
 
         $db = Craft::$app->getDb();
 
+        if ($db->getIsMysql()) {
+            $name = StringHelper::encodeMb4($group->name);
+        } else {
+            $name = $group->name;
+        }
+
         if ($group->id) {
             $db->createCommand()
                 ->update('{{%webhookgroups}}', [
-                    'name' => $group->name,
+                    'name' => $name,
                 ], [
                     'id' => $group->id,
                 ])
                 ->execute();
         } else {
             $db->createCommand()
                 ->insert('{{%webhookgroups}}', [
-                    'name' => $group->name,
+                    'name' => $name,
                 ])
                 ->execute();
 
@@ -153,7 +165,7 @@ public function getWebhookById(int $id): Webhook
             throw new InvalidArgumentException('Invalid webhook ID: ' . $id);
         }
 
-        return new Webhook($result);
+        return $this->_createWebhook($result);
     }
 
     /**
@@ -170,20 +182,27 @@ public function saveWebhook(Webhook $webhook, bool $runValidation = true): bool
             return false;
         }
 
+        $db = Craft::$app->getDb();
+
+        if ($db->getIsMysql()) {
+            $name = StringHelper::encodeMb4($webhook->name);
+        } else {
+            $name = $webhook->name;
+        }
+
         $data = [
             'groupId' => $webhook->groupId,
             'enabled' => (bool)$webhook->enabled,
-            'name' => $webhook->name,
+            'name' => $name,
             'class' => $webhook->class,
             'event' => $webhook->event,
+            'type' => $webhook->type,
             'url' => $webhook->url,
             'userAttributes' => $webhook->userAttributes,
             'senderAttributes' => $webhook->senderAttributes,
             'eventAttributes' => $webhook->eventAttributes,
         ];
 
-        $db = Craft::$app->getDb();
-
         if ($webhook->id) {
             $db->createCommand()
                 ->update('{{%webhooks}}', $data, ['id' => $webhook->id])
@@ -216,20 +235,35 @@ public function deleteWebhookById(int $id)
     private function _createWebhookQuery(): Query
     {
         return (new Query())
-            ->select(['id', 'groupId', 'enabled', 'name', 'class', 'event', 'url', 'userAttributes', 'senderAttributes', 'eventAttributes'])
+            ->select(['id', 'groupId', 'enabled', 'name', 'class', 'event', 'type', 'url', 'userAttributes', 'senderAttributes', 'eventAttributes'])
             ->from(['{{%webhooks}}']);
     }
 
+    /**
+     * @param array $result
+     * @param bool|null $isMysql
+     * @return Webhook
+     */
+    private function _createWebhook(array $result, bool $isMysql = null): Webhook
+    {
+        if ($isMysql ?? Craft::$app->getDb()->getIsMysql()) {
+            $result['name'] = html_entity_decode($result['name'], ENT_QUOTES | ENT_HTML5);
+        }
+
+        return new Webhook($result);
+    }
+
     /**
      * @param array
      * @return Webhook[]
      */
     private function _createWebhooks(array $results): array
     {
         $webhooks = [];
+        $isMysql = Craft::$app->getDb()->getIsMysql();
 
         foreach ($results as $result) {
-            $webhooks[] = new Webhook($result);
+            $webhooks[] = $this->_createWebhook($result, $isMysql);
         }
 
         return $webhooks;

src/assets/edit/EditAsset.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license MIT
+ */
+
+namespace craft\webhooks\assets\edit;
+
+use craft\web\AssetBundle;
+use craft\web\assets\cp\CpAsset;
+use craft\web\View;
+
+/**
+ * Webhooks index asset bundle
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ * @since 1.0
+ */
+class EditAsset extends AssetBundle
+{
+    public $sourcePath = __DIR__ . '/dist';
+
+    public $depends = [
+        CpAsset::class,
+    ];
+
+    public $js = [
+        'js/EditWebhook.js',
+    ];
+}

src/assets/edit/dist/js/EditWebhook.js

@@ -0,0 +1,33 @@
+(function($) {
+    /** global: Craft */
+    /** global: Garnish */
+    var EditWebhook = Garnish.Base.extend(
+        {
+            $nameInput: null,
+
+            init: function() {
+                this.$nameInput = $('#name');
+
+                this.addListener(this.$nameInput, 'change, keyup', 'handleTextChange');
+            },
+
+            handleTextChange: function() {
+                var input = this.$nameInput.get(0);
+
+                // does it look like they just typed -> or => ?
+                if (typeof input.selectionStart !== 'undefined' && input.selectionStart === input.selectionEnd) {
+                    var pos = input.selectionStart;
+                    var last2 = input.value.substring(pos - 2, pos);
+                    if (last2 === '->' || last2 === '=>') {
+                        input.value = input.value.substring(0, pos - 2) + '➡️' + input.value.substring(pos);
+                        input.setSelectionRange(pos, pos);
+                    }
+                }
+            }
+        })
+
+
+    Garnish.$doc.ready(function() {
+        new EditWebhook();
+    });
+})(jQuery);

src/controllers/WebhooksController.php

@@ -5,6 +5,7 @@
 use Craft;
 use craft\helpers\UrlHelper;
 use craft\web\Controller as BaseController;
+use craft\webhooks\assets\edit\EditAsset;
 use craft\webhooks\Plugin;
 use craft\webhooks\Webhook;
 use yii\base\InvalidArgumentException;
@@ -91,6 +92,8 @@ public function actionEdit(int $id = null, int $groupId = null, Webhook $webhook
             }
         }
 
+        Craft::$app->getView()->registerAssetBundle(EditAsset::class);
+
         return $this->renderTemplate('webhooks/_edit', compact(
             'groupOptions',
             'webhook',