Initial commit

Author: mremi

.gitignore

@@ -0,0 +1,3 @@
+composer.lock
+phpunit.xml
+vendor

.travis.yml

@@ -0,0 +1,8 @@
+language: php
+
+php:
+  - 5.3
+  - 5.4
+  - 5.5
+
+before_script: composer install --dev --prefer-source

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2014 Rémi Marseille <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+Flowdock library
+================
+
+This library allows you to interact with the Flowdock API.
+
+**Basic Docs**
+
+* [Installation](#installation)
+* [Push API](#push-api)
+* [Contribution](#contribution)
+
+<a name="installation"></a>
+
+## Installation
+
+Only 1 step:
+
+### Download Flowdock using composer
+
+Add Flowdock in your composer.json:
+
+```js
+{
+    "require": {
+        "mremi/flowdock": "dev-master"
+    }
+}
+```
+
+Now tell composer to download the library by running the command:
+
+``` bash
+$ php composer.phar update mremi/flowdock
+```
+
+Composer will install the library to your project's `vendor/mremi` directory.
+
+<a name="push-api"></a>
+
+## Push API
+
+### Chat
+
+```php
+<?php
+
+use Mremi\Flowdock\Api\Push\Chat\Chat;
+use Mremi\Flowdock\Api\Push\Chat\Message;
+
+$message = new Message;
+$message
+    ->setContent('This message has been sent with mremi/flowdock PHP library')
+    ->setExternalUserName('mremi')
+    ->addTag('#hello-world');
+
+$chat = new Chat('your_flow_api_token');
+
+if (!$chat->sendMessage($message)) {
+    // handle errors...
+    $message->getErrors();
+}
+```
+
+<a name="contribution"></a>
+
+## Contribution
+
+Any question or feedback? Open an issue and I will try to reply quickly.
+
+A feature is missing here? Feel free to create a pull request to solve it!
+
+I hope this has been useful and has helped you. If so, share it and recommend
+it! :)
+
+[@mremitsme](https://twitter.com/mremitsme)

composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "mremi/flowdock",
+    "type": "library",
+    "description": "A PHP5 library to interact with the Flowdock API",
+    "keywords": ["flowdock", "api"],
+    "homepage": "https://github.com/mremi/Flowdock",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Rémi Marseille",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.3",
+        "guzzle/guzzle": "~3.7"
+    },
+    "require-dev":{
+        "phpunit/phpunit": "~4.1"
+    },
+    "autoload": {
+        "psr-0": { "Mremi\\Flowdock": "src" }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false"
+         bootstrap="vendor/autoload.php"
+>
+    <testsuites>
+        <testsuite name="Flowdock Test Suite">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>./src</directory>
+            <exclude>
+                <directory>./tests</directory>
+                <directory>./vendor</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+
+</phpunit>

src/Mremi/Flowdock/Api/Push/BaseMessage.php

@@ -0,0 +1,108 @@
+<?php
+
+/*
+ * This file is part of the Mremi\Flowdock library.
+ *
+ * (c) Rémi Marseille <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Mremi\Flowdock\Api\Push;
+
+/**
+ * Base push message class
+ *
+ * @author Rémi Marseille <[email protected]>
+ */
+abstract class BaseMessage implements BaseMessageInterface
+{
+    /**
+     * @var string
+     */
+    protected $content;
+
+    /**
+     * @var array
+     */
+    protected $tags = array();
+
+    /**
+     * @var array
+     */
+    protected $errors = array();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setContent($content)
+    {
+        $this->content = $content;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContent()
+    {
+        return $this->content;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addTag($tag)
+    {
+        $this->tags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTags()
+    {
+        return $this->tags;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addError($error)
+    {
+        $this->errors[] = $error;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getErrors()
+    {
+        return $this->errors;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasErrors()
+    {
+        return count($this->errors) > 0;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toArray()
+    {
+        return array(
+            'content' => $this->content,
+            'tags'    => $this->tags,
+        );
+    }
+}

src/Mremi/Flowdock/Api/Push/BaseMessageInterface.php

@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of the Mremi\Flowdock library.
+ *
+ * (c) Rémi Marseille <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Mremi\Flowdock\Api\Push;
+
+/**
+ * Base push message interface
+ *
+ * @author Rémi Marseille <[email protected]>
+ */
+interface BaseMessageInterface
+{
+    /**
+     * Sets the content of the message
+     *
+     * @param string $content
+     *
+     * @return BaseMessageInterface
+     */
+    public function setContent($content);
+
+    /**
+     * Gets the content of the message
+     *
+     * @return string
+     */
+    public function getContent();
+
+    /**
+     * Adds a tag to the message
+     *
+     * @param string $tag
+     *
+     * @return BaseMessageInterface
+     */
+    public function addTag($tag);
+
+    /**
+     * Gets the message tags
+     *
+     * @return array
+     */
+    public function getTags();
+
+    /**
+     * Adds an error to the message
+     *
+     * @param string $error
+     *
+     * @return BaseMessageInterface
+     */
+    public function addError($error);
+
+    /**
+     * Gets the message errors
+     *
+     * @return array
+     */
+    public function getErrors();
+
+    /**
+     * Returns TRUE whether the message has some errors
+     *
+     * @return boolean
+     */
+    public function hasErrors();
+
+    /**
+     * Returns an array representation of the message
+     *
+     * @return array
+     */
+    public function toArray();
+}