Merge remote-tracking branch 'anroots/feature/fleep'

Conflicts:
	README.mdown

README.mdown

@@ -123,6 +123,7 @@ Handlers
 - _FlowdockHandler_: Logs records to a [Flowdock](https://www.flowdock.com/) account.
 - _SlackHandler_: Logs records to a [Slack](https://www.slack.com/) account.
 - _MandrillHandler_: Sends emails via the Mandrill API using a [`Swift_Message`](http://swiftmailer.org/) instance.
+- _FleepHookHandler_: Logs records to a [Fleep](https://fleep.io/) conversation using Webhooks.
 
 ### Log specific servers and networked logging
 

src/Monolog/Handler/FleepHookHandler.php

@@ -0,0 +1,132 @@
+<?php
+
+/*
+ * This file is part of the Monolog package.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Monolog\Handler;
+
+use Monolog\Formatter\LineFormatter;
+use Monolog\Logger;
+
+/**
+ * Sends logs to Fleep.io using Webhook integrations
+ *
+ * You'll need a Fleep.io account to use this handler.
+ *
+ * @see https://fleep.io/integrations/webhooks/ Fleep Webhooks Documentation
+ * @author Ando Roots <ando@sqroot.eu>
+ */
+class FleepHookHandler extends SocketHandler
+{
+
+    const FLEEP_HOST = 'fleep.io';
+
+    const FLEEP_HOOK_URI = '/hook/';
+
+    /**
+     * @var string Webhook token (specifies the conversation where logs are sent)
+     */
+    protected $token;
+
+    /**
+     * Construct a new Fleep.io Handler.
+     *
+     * For instructions on how to create a new web hook in your conversations
+     * see https://fleep.io/integrations/webhooks/
+     *
+     * @param string $token Webhook token
+     * @param bool|int $level The minimum logging level at which this handler will be triggered
+     * @param bool $bubble Whether the messages that are handled can bubble up the stack or not
+     * @throws MissingExtensionException
+     */
+    public function __construct($token, $level = Logger::DEBUG, $bubble = true)
+    {
+        if (!extension_loaded('openssl')) {
+            throw new MissingExtensionException('The OpenSSL PHP extension is required to use the FleepHookHandler');
+        }
+
+        $this->token = $token;
+
+        $connectionString = 'ssl://' . self::FLEEP_HOST . ':443';
+        parent::__construct($connectionString, $level, $bubble);
+    }
+
+    /**
+     * Returns the default formatter to use with this handler
+     *
+     * Overloaded to remove empty context and extra arrays from the end of the log message.
+     *
+     * @return LineFormatter
+     */
+    protected function getDefaultFormatter()
+    {
+        return new LineFormatter(null, null, true, true);
+
+    }
+
+    /**
+     * Handles a log record
+     *
+     * @param array $record
+     */
+    public function write(array $record)
+    {
+        parent::write($record);
+        $this->closeSocket();
+    }
+
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  array $record
+     * @return string
+     */
+    protected function generateDataStream($record)
+    {
+        $content = $this->buildContent($record);
+
+        return $this->buildHeader($content) . $content;
+    }
+
+
+    /**
+     * Builds the header of the API Call
+     *
+     * @param  string $content
+     * @return string
+     */
+    private function buildHeader($content)
+    {
+        $header = "POST " . self::FLEEP_HOOK_URI . $this->token . " HTTP/1.1\r\n";
+        $header .= "Host: " . self::FLEEP_HOST . "\r\n";
+        $header .= "Content-Type: application/x-www-form-urlencoded\r\n";
+        $header .= "Content-Length: " . strlen($content) . "\r\n";
+        $header .= "\r\n";
+
+        return $header;
+    }
+
+
+    /**
+     * Builds the body of API call
+     *
+     * @param  array $record
+     * @return string
+     */
+    private function buildContent($record)
+    {
+        $dataArray = array(
+            'message' => $record['formatted']
+        );
+
+        return http_build_query($dataArray);
+    }
+
+}

tests/Monolog/Handler/FleepHookHandlerTest.php

@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * This file is part of the Monolog package.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Monolog\Handler;
+
+use Monolog\Formatter\LineFormatter;
+use Monolog\Logger;
+use Monolog\TestCase;
+
+/**
+ * Unit tests for the FleepHookHandler
+ *
+ * @author Ando Roots <ando@sqroot.eu>
+ * @coversDefaultClass \Monolog\Handler\FleepHookHandler
+ */
+class FleepHookHandlerTest extends TestCase
+{
+    /**
+     * Default token to use in tests
+     */
+    const TOKEN = '123abc';
+
+    /**
+     * @var FleepHookHandler
+     */
+    private $handler;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        if (!extension_loaded('openssl')) {
+            $this->markTestSkipped('This test requires openssl extension to run');
+        }
+
+        // Create instances of the handler and logger for convenience
+        $this->handler = new FleepHookHandler(self::TOKEN);
+    }
+
+    /**
+     * @covers ::__construct
+     */
+    public function testConstructorSetsExpectedDefaults()
+    {
+        $this->assertEquals(Logger::DEBUG, $this->handler->getLevel());
+        $this->assertEquals(true, $this->handler->getBubble());
+    }
+
+    /**
+     * @covers ::getDefaultFormatter
+     */
+    public function testHandlerUsesLineFormatterWhichIgnoresEmptyArrays()
+    {
+        $record = array(
+            'message' => 'msg',
+            'context' => array(),
+            'level' => Logger::DEBUG,
+            'level_name' => Logger::getLevelName(Logger::DEBUG),
+            'channel' => 'channel',
+            'datetime' => new \DateTime(),
+            'extra' => array(),
+        );
+
+        $expectedFormatter = new LineFormatter(null, null, true, true);
+        $expected = $expectedFormatter->format($record);
+
+        $handlerFormatter = $this->handler->getFormatter();
+        $actual = $handlerFormatter->format($record);
+
+        $this->assertEquals($expected, $actual, 'Empty context and extra arrays should not be rendered');
+
+    }
+
+    /**
+     * @covers ::__construct
+     */
+    public function testConnectionStringisConstructedCorrectly()
+    {
+        $this->assertEquals('ssl://' . FleepHookHandler::FLEEP_HOST . ':443', $this->handler->getConnectionString());
+    }
+
+}