Initial commit

Author: jeremeamia

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+/.idea/
+/.php-cs-fixer.cache

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jeremy Lindblom
+
+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,55 @@
+# Slack PHP – Socket Mode
+
+This package provides a slack-php `AppServer` implementation that allows an application written for the
+[Slack App Framework for PHP][1] to be run in [Socket Mode][2]. Socket Mode uses the websocket protocol to communicate
+with Slack, and allows you to run an app (even locally) without having to expose it via a public HTTP endpoint. This can
+be very useful for testing Slack apps in a way that does not violate most work-related firewall restrictions.
+
+**This package should be used for testing only, and is not designed for production use.**
+
+> This Socket Mode implementation uses the [`amphp/websocket-client`][3] package from [Amp][4], an awesome collection of
+PHP packages that make async and event loop style programming in PHP possible. Check it out sometime.
+
+## Installation
+
+- Requires PHP 7.4+
+- Use Composer to install: `composer require slack-php/slack-socket-mode`
+
+## Usage
+
+When using Socket Mode, there is no web server serving your app. When you run an app configured for Socket Mode, it
+establishes a connection to Slack as a websocket client. It maintains that connection to listen for Slack events until
+it is explicitly terminated (e.g., via `CTRL+C`), Socket Mode is disabled in your app configuration, or an unrecoverable
+error occurs. This is a different way of running PHP than many are used to, so please pay close attention.
+
+When running an app in Slack Mode, you need an "App Token" instead of the typical "Signing Secret". The App Token is
+specially purposed for making the web socket connection. You can read more about [Socket Mode][2] in the Slack
+documentation to learn how to get an App Token.
+
+### Example
+
+This small app responds to the `/cool` slash command.
+
+> Assumptions:
+>
+> - You have required the Composer autoloader to enable autoloading of the framework files.
+> - You have set `SLACK_APP_TOKEN` in the environment (e.g., `putenv("SLACK_APP_TOKEN=foo");`)
+
+```php
+<?php
+
+use SlackPhp\Framework\App;
+use SlackPhp\Framework\Context;
+use SlackPhp\SocketMode\SocketServer;
+
+App::new()
+    ->command('cool', function (Context $ctx) {
+        $ctx->ack(':thumbsup: That is so cool!');
+    })
+    ->run(new SocketServer());
+```
+
+[1]: https://github.com/slack-php/slack-php-app-framework
+[2]: https://api.slack.com/apis/connections/socket
+[3]: https://amphp.org/websocket-client/
+[4]: https://amphp.org/

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "slack-php/slack-socket-mode",
+    "type": "library",
+    "license": "MIT",
+    "description": "Provides a a slack-php Socket Mode implementation",
+    "authors": [
+        {
+            "name": "Jeremy Lindblom",
+            "email": "jeremeamia@gmail.com"
+        }
+    ],
+    "config": {
+        "sort-packages": true,
+        "platform": {
+            "php": "7.4"
+        }
+    },
+    "require": {
+        "amphp/websocket-client": "^1.0",
+        "slack-php/slack-app-framework": "^0.4.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "SlackPhp\\SocketMode\\": "src/"
+        }
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^0.12.90"
+    },
+    "scripts": {
+        "style": "php-cs-fixer fix --dry-run --verbose --show-progress=none src",
+        "style-fix": "php-cs-fixer fix src",
+        "stan": "phpstan analyse --level=5 src",
+        "qa": ["@style", "@stan"]
+    }
+}