├── registration.php
├── composer.json
├── etc
    ├── events.xml
    ├── module.xml
    ├── config.xml
    └── adminhtml
    │   └── system.xml
├── Test
    └── Unit
    │   └── Model
    │       └── ConfigTest.php
├── README.md
├── Model
    └── Config.php
└── Observer
    └── Notify.php


/registration.php:
--------------------------------------------------------------------------------
1 | <?php
2 | \Magento\Framework\Component\ComponentRegistrar::register(
3 |     \Magento\Framework\Component\ComponentRegistrar::MODULE,
4 |     'Staempfli_Slack',
5 |     __DIR__
6 | );
7 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "staempfli/magento2-module-slack",
 3 |   "description": "Magento 2 Slack",
 4 |   "require": {
 5 |     "php": "~7.0.0",
 6 |     "staempfli/magento2-module-chat-connector": "~1.1",
 7 |     "league/html-to-markdown": "~4.4"
 8 |   },
 9 |   "type": "magento2-module",
10 |   "license": [
11 |     "OSL-3.0",
12 |     "AFL-3.0"
13 |   ],
14 |   "autoload": {
15 |     "files": [
16 |       "registration.php"
17 |     ],
18 |     "psr-4": {
19 |       "Staempfli\\Slack\\": ""
20 |     }
21 |   }
22 | }
23 | 


--------------------------------------------------------------------------------
/etc/events.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * @category  Staempfli
 5 |  * @package   Staempfli_Slack
 6 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 7 |  * @author    marcel.hauri@staempfli.com
 8 |  */
 9 | -->
10 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
11 |     <event name="chatconnector_notification">
12 |         <observer name="notify_slack" instance="Staempfli\Slack\Observer\Notify"/>
13 |     </event>
14 | </config>
15 | 


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * @category  Staempfli
 5 |  * @package   Staempfli_Slack
 6 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 7 |  * @author    marcel.hauri@staempfli.com
 8 |  */
 9 | -->
10 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
11 |     <module name="Staempfli_Slack" setup_version="1.0.0" >
12 |         <sequence>
13 |             <module name="Staempfli_ChatConnector"/>
14 |         </sequence>
15 |     </module>
16 | </config>


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * @category  Staempfli
 5 |  * @package   Staempfli_Slack
 6 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 7 |  * @author    marcel.hauri@staempfli.com
 8 |  */
 9 | -->
10 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
11 |     <default>
12 |         <chatconnector>
13 |             <slack>
14 |                 <url/>
15 |                 <channel>general</channel>
16 |                 <username>Magento 2</username>
17 |                 <icon>rocket</icon>
18 |             </slack>
19 |         </chatconnector>
20 |     </default>
21 | </config>


--------------------------------------------------------------------------------
/Test/Unit/Model/ConfigTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @category  Staempfli
 4 |  * @package   Staempfli_Slack
 5 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 6 |  * @author    marcel.hauri@staempfli.com
 7 |  */
 8 | namespace Staempfli\Slack\Test\Unit\Model;
 9 | 
10 | use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
11 | 
12 | class ConfigTest extends \PHPUnit_Framework_TestCase
13 | {
14 |     private $objectManagerHelper;
15 |     private $scopeConfigInterface;
16 |     private $config;
17 | 
18 |     protected function setUp()
19 |     {
20 |         $this->scopeConfigInterface = $this->getMockBuilder('Magento\Framework\App\Config\ScopeConfigInterface')
21 |             ->getMockForAbstractClass();
22 |         $this->objectManagerHelper = new ObjectManagerHelper($this);
23 |         $this->config = $this->objectManagerHelper->getObject(
24 |             'Staempfli\Slack\Model\Config',
25 |             [
26 |                 'scopeConfig' => $this->scopeConfigInterface,
27 |             ]
28 |         );
29 |     }
30 | 
31 |     public function testGetMessageFormat()
32 |     {
33 |         $this->assertSame('mrkdwn', $this->config->getMessageFormat(), 'Message Format should be \'mrkdwn\' by default');
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 | /**
 4 |  * @category  Staempfli
 5 |  * @package   Staempfli_Slack
 6 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 7 |  * @author    marcel.hauri@staempfli.com
 8 |  */
 9 | -->
10 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
11 |     <system>
12 |         <section id="chatconnector">
13 |             <group id="slack" translate="label" type="text" sortOrder="300" showInDefault="1" showInWebsite="1" showInStore="1">
14 |                 <label>Slack</label>
15 |                 <field id="url" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
16 |                     <label>Webhook Url</label>
17 |                     <comment>https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX</comment>
18 |                 </field>
19 |                 <field id="channel" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
20 |                     <label>Channel</label>
21 |                 </field>
22 |                 <field id="username" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
23 |                     <label>Username</label>
24 |                 </field>
25 |                 <field id="icon" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
26 |                     <label>Icon</label>
27 |                 </field>
28 |             </group>
29 |         </section>
30 |     </system>
31 | </config>


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Magento 2 Slack
 2 | 
 3 | Magento 2 Module to send Notifications to a Slack Channel via Webhook.
 4 | 
 5 | [![Codacy](https://api.codacy.com/project/badge/Grade/f7797be796714384a2dc1eb1b7c0e780)](https://www.codacy.com/app/Staempfli/magento2-module-slack?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=staempfli/magento2-module-slack&amp;utm_campaign=Badge_Grade)
 6 | [![Code Climate](https://codeclimate.com/github/staempfli/magento2-module-slack/badges/gpa.svg)](https://codeclimate.com/github/staempfli/magento2-module-slack)
 7 | [![Issue Count](https://codeclimate.com/github/staempfli/magento2-module-slack/badges/issue_count.svg)](https://codeclimate.com/github/staempfli/magento2-module-slack)
 8 | 
 9 | Requirements
10 | ------------
11 | - PHP >= 7.0.*
12 | - Magento >= 2.1.*
13 | - [staempfli/magento2-module-chat-connector](https://github.com/staempfli/magento2-module-chat-connector) ~1.0
14 | - [league/html-to-markdown](https://github.com/thephpleague/html-to-markdown/) ~4.4
15 | 
16 | Compatibility
17 | -------------
18 | - Magento >= 2.1
19 | 
20 | ## Installation
21 | 
22 | ```
23 | $ composer require "staempfli/magento2-module-slack":"~1.1"
24 | ```
25 | 
26 | Support
27 | -------
28 | If you have any issues with this extension, open an issue on [GitHub](https://github.com/staempfli/magento2-module-slack/issues).
29 | 
30 | Contribution
31 | ------------
32 | Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
33 | 
34 | Developer
35 | ---------
36 | Staempfli Webteam, and all other [contributors](https://github.com/staempfli/magento2-module-slack/contributors)
37 | 
38 | License
39 | -------
40 | [Open Software License ("OSL") v. 3.0](https://opensource.org/licenses/OSL-3.0)
41 | 
42 | Copyright
43 | ---------
44 | (c) 2017, Stämpfli AG


--------------------------------------------------------------------------------
/Model/Config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @category  Staempfli
 4 |  * @package   Staempfli_Slack
 5 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 6 |  * @author    marcel.hauri@staempfli.com
 7 |  */
 8 | namespace Staempfli\Slack\Model;
 9 | 
10 | use Magento\Framework\App\Config\ScopeConfigInterface;
11 | use Magento\Store\Model\ScopeInterface;
12 | 
13 | class Config
14 | {
15 |     const MESSAGE_FORMAT = 'mrkdwn';
16 |     const XML_PATH_SLACK_URL = 'chatconnector/slack/url';
17 |     const XML_PATH_SLACK_CHANNEL = 'chatconnector/slack/channel';
18 |     const XML_PATH_SLACK_USERNAME = 'chatconnector/slack/username';
19 |     const XML_PATH_SLACK_ICON = 'chatconnector/slack/icon';
20 | 
21 |     /**
22 |      * @var ScopeConfigInterface
23 |      */
24 |     private $scopeConfig;
25 | 
26 |     /**
27 |      * Config constructor.
28 |      * @param ScopeConfigInterface $scopeConfig
29 |      */
30 |     public function __construct(
31 |         ScopeConfigInterface $scopeConfig
32 |     ) {
33 |         $this->scopeConfig = $scopeConfig;
34 |     }
35 | 
36 |     /**
37 |      * @return mixed
38 |      */
39 |     public function getUrl()
40 |     {
41 |         $url = $this->scopeConfig->getValue(self::XML_PATH_SLACK_URL, ScopeInterface::SCOPE_STORE);
42 |         $url = rtrim($url, '/');
43 |         return $url;
44 |     }
45 | 
46 |     /**
47 |      * @return mixed
48 |      */
49 |     public function getChannel()
50 |     {
51 |         $channel = $this->scopeConfig->getValue(self::XML_PATH_SLACK_CHANNEL, ScopeInterface::SCOPE_STORE);
52 |         return sprintf('#%s', ltrim($channel, '#'));
53 |     }
54 | 
55 |     /**
56 |      * @return mixed
57 |      */
58 |     public function getUsername()
59 |     {
60 |         return $this->scopeConfig->getValue(self::XML_PATH_SLACK_USERNAME, ScopeInterface::SCOPE_STORE);
61 |     }
62 | 
63 |     /**
64 |      * @return mixed
65 |      */
66 |     public function getIcon()
67 |     {
68 |         $icon = trim($this->scopeConfig->getValue(self::XML_PATH_SLACK_ICON, ScopeInterface::SCOPE_STORE), ':');
69 |         return sprintf(':%s:', $icon);
70 |     }
71 | 
72 |     /**
73 |      * @return string
74 |      */
75 |     public function getMessageFormat()
76 |     {
77 |         return self::MESSAGE_FORMAT;
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/Observer/Notify.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @category  Staempfli
 4 |  * @package   Staempfli_Slack
 5 |  * @copyright Copyright © Stämpfli AG. All rights reserved.
 6 |  * @author    marcel.hauri@staempfli.com
 7 |  */
 8 | 
 9 | namespace Staempfli\Slack\Observer;
10 | 
11 | use League\HTMLToMarkdown\HtmlConverter;
12 | use Magento\Framework\Event\Observer;
13 | use Magento\Framework\Event\ObserverInterface;
14 | use Staempfli\ChatConnector\Api\Data\MessageInterface;
15 | use Staempfli\ChatConnector\Api\MessageManagementInterface;
16 | use Staempfli\Slack\Model\Config;
17 | 
18 | class Notify implements ObserverInterface
19 | {
20 |     const MESSAGE_LIMIT = 10000;
21 |     /**
22 |      * @var MessageInterface
23 |      */
24 |     private $message;
25 |     /**
26 |      * @var MessageManagementInterface
27 |      */
28 |     private $messageManagement;
29 |     /**
30 |      * @var Config
31 |      */
32 |     private $config;
33 |     /**
34 |      * @var HtmlConverter
35 |      */
36 |     private $converter;
37 | 
38 |     /**
39 |      * Notify constructor.
40 |      * @param MessageInterface $message
41 |      * @param MessageManagementInterface $messageManagement
42 |      * @param Config $config
43 |      * @param HtmlConverter $converter
44 |      */
45 |     public function __construct(
46 |         MessageInterface $message,
47 |         MessageManagementInterface $messageManagement,
48 |         Config $config
49 |     ) {
50 |         $this->message = $message;
51 |         $this->messageManagement = $messageManagement;
52 |         $this->config = $config;
53 |         $this->converter = new HtmlConverter();
54 |     }
55 | 
56 |     /**
57 |      * @param Observer $observer
58 |      * @return void
59 |      */
60 |     public function execute(\Magento\Framework\Event\Observer $observer)
61 |     {
62 |         $data = [];
63 |         $data['text'] = strip_tags($observer->getMessage());
64 | 
65 |         if ($this->config->getMessageFormat() === 'mrkdwn') {
66 |             $this->converter->getConfig()->setOption('bold_style', '*');
67 |             $this->converter->getConfig()->setOption('italic_style', '_');
68 |             $this->converter->getConfig()->setOption('strike_style', '~');
69 |             $this->converter->getConfig()->setOption('code_style', "`");
70 |             $data['text'] = substr($this->converter->convert(nl2br($observer->getMessage())), 0, self::MESSAGE_LIMIT);
71 |             $data['mrkdwn'] = true;
72 |             $data['mrkdwn_in'] = 'text';
73 |         }
74 | 
75 |         $data['channel'] = $this->config->getChannel();
76 |         $data['username'] = $this->config->getUsername();
77 |         $data['icon_emoji'] = $this->config->getIcon();
78 |         $message = $this->message
79 |             ->setUrl($this->config->getUrl())
80 |             ->setEvent($observer->getEvent())
81 |             ->setMessageData($data);
82 |         $this->messageManagement->send($message);
83 |     }
84 | }
85 | 


--------------------------------------------------------------------------------