Initial commit

Author: GrahamCampbell

FactoryInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of NotifyMe.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace NotifyMeHQ\Contracts;
+
+interface FactoryInterface
+{
+    /**
+     * Create a new gateway instance.
+     *
+     * @param string[] $config
+     *
+     * @return \NotifyMeHQ\Contracts\GatewayInterface
+     */
+    public function make(array $config);
+}

GatewayInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of NotifyMe.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace NotifyMeHQ\Contracts;
+
+interface GatewayInterface
+{
+    /**
+     * Send a notification.
+     *
+     * @param string $to
+     * @param string $message
+     *
+     * @return \NotifyMeHQ\Contracts\ResponseInterface
+     */
+    public function notify($to, $message);
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alt Three Services Limited
+
+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.

ManagerInterface.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of NotifyMe.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace NotifyMeHQ\Contracts;
+
+interface ManagerInterface
+{
+    /**
+     * Get a connection instance.
+     *
+     * @param string|null $name
+     *
+     * @return \NotifyMeHQ\Contracts\GatewayInterface
+     */
+    public function connection($name = null);
+
+    /**
+     * Reconnect to the given connection.
+     *
+     * @param string|null $name
+     *
+     * @return \NotifyMeHQ\Contracts\GatewayInterface
+     */
+    public function reconnect($name = null);
+
+    /**
+     * Disconnect from the given connection.
+     *
+     * @param string|null $name
+     *
+     * @return void
+     */
+    public function disconnect($name = null);
+
+    /**
+     * Get the configuration for a connection.
+     *
+     * @param string $name
+     *
+     * @return array
+     */
+    public function getConnectionConfig($name);
+
+    /**
+     * Get the default connection name.
+     *
+     * @return string
+     */
+    public function getDefaultConnection();
+
+    /**
+     * Set the default connection name.
+     *
+     * @param string $name
+     *
+     * @return void
+     */
+    public function setDefaultConnection($name);
+
+    /**
+     * Return all of the created connections.
+     *
+     * @return \NotifyMeHQ\Contracts\GatewayInterface[]
+     */
+    public function getConnections();
+}

ResponseInterface.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of NotifyMe.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace NotifyMeHQ\Contracts;
+
+interface ResponseInterface
+{
+    /**
+     * Determine if the message has been sent by the gateway.
+     *
+     * @return bool
+     */
+    public function isSent();
+
+    /**
+     * Get the response message from the gateway.
+     *
+     * @return string
+     */
+    public function message();
+
+    /**
+     * Get the raw data from the gateway.
+     *
+     * @return array
+     */
+    public function raw();
+
+    /**
+     * Set the raw response array from the gateway.
+     *
+     * @param array $response
+     *
+     * @return \NotifyMeHQ\Contracts\ResponseInterface
+     */
+    public function setRaw(array $response);
+
+    /**
+     * Map the given array onto the response's properties.
+     *
+     * @param array $attributes
+     *
+     * @return \NotifyMeHQ\Contracts\ResponseInterface
+     */
+    public function map(array $attributes);
+}

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "notifymehq/contracts",
+    "description": "Provides a common interface for notification services",
+    "license": "MIT",
+    "keywords": ["notifymehq", "notifyme", "notifications", "integrations"],
+    "authors": [
+        {
+            "name": "James Brooks",
+            "email": "james@alt-three.com"
+        },
+        {
+            "name": "Graham Campbell",
+            "email": "graham@alt-three.com"
+        },
+        {
+            "name": "Joseph Cohen",
+            "email": "joe@alt-three.com"
+        }
+    ],
+    "require": {
+        "php": ">=5.5.9"
+    },
+    "autoload": {
+        "psr-4": {
+            "NotifyMeHQ\\Contracts\\": ""
+        }
+    },
+    "config": {
+        "preferred-install": "dist"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}