init

Author: ytake

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,3 @@
+composer.phar
+composer.lock
+vendor/

.hhconfig

@@ -0,0 +1,4 @@
+assume_php=false
+enable_experimental_tc_features = no_fallback_in_namespaces
+safe_array=true
+safe_vector_array=true

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yuuki Takezawa
+
+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

@@ -1,2 +1,52 @@
-# http-request-handler
-for Hack
+# HTTP Server Request Handlers
+
+PSR-15 Like HTTP Server Request Handlers Interface For Hack
+
+## Require
+
+HHVM 3.30.0 and above.  
+required [hsl-experimental](https://github.com/hhvm/hsl-experimental)
+
+## Install
+
+```bash
+$ hhvm $(which composer) require ytake/hack-http-server-request-handlers-interfaces
+```
+
+## Usage
+
+Golang style
+
+```go
+func middleware(next http.HandlerFunc) http.HandlerFunc {
+  return func(w http.ResponseWriter, r *http.Request) {
+		log.Printf("Hello World, %s", r.RequestURI)
+		next.ServeHTTP(w, r)
+	}
+}
+```
+
+For Hack
+
+```hack
+<?hh // strict
+
+namespace Acme\Middleware;
+
+use type HH\Lib\Experimental\IO\WriteHandle;
+use type Facebook\Experimental\Http\Message\ResponseInterface;
+use type Facebook\Experimental\Http\Message\ServerRequestInterface;
+use type Nazg\Http\Server\MiddlewareInterface;
+use type Nazg\Http\Server\RequestHandlerInterface;
+
+final class ExampleMiddleware implements MiddlewareInterface {
+
+  public function process(
+    WriteHandle $writeHandle,
+    ServerRequestInterface $request,
+    RequestHandlerInterface $handler,
+  ): ResponseInterface {
+    return $handler->handle($write, $request);
+  }
+}
+```

composer.json

@@ -0,0 +1,37 @@
+{
+  "name": "nazg/http-server-request-handler",
+  "description": "PSR-15 like HTTP Server Request Handler Interface",
+  "keywords": [
+    "hhvm",
+    "hack",
+    "http-handlers",
+    "request",
+    "server",
+    "middleware"
+  ],
+  "homepage": "https://github.com/nazg-hack/http-server-request-handler",
+  "license": [
+    "MIT"
+  ],
+  "authors": [
+    {
+      "name": "Yuuki Takezawa",
+      "email": "[email protected]"
+    }
+  ],
+  "require": {
+    "hhvm": ">=3.30.0",
+    "hhvm/hhvm-autoload": "^1.7",
+    "hhvm/hsl-experimental": "^3.30.0",
+    "facebook/hack-http-request-response-interfaces": "^0.1"
+  },
+  "require-dev": {
+    "hhvm/hhast": "^3.30.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Nazg\\Http\\Server\\": "src/"
+    }
+  },
+  "minimum-stability": "stable"
+}

hh_autoload.json

@@ -0,0 +1,6 @@
+{
+  "roots": [
+    "src/"
+  ],
+  "devRoots": []
+}

hhast-lint.json

@@ -0,0 +1,8 @@
+{
+	"roots": [
+		"src/"
+	],
+	"namespaceAliases": {
+		"HHAST": "Facebook\\HHAST\\Linters"
+	}
+}

src/MiddlewareInterface.php

@@ -0,0 +1,45 @@
+<?hh // strict
+
+/**
+ * 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.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ *
+ * Copyright (c) 2018 Yuuki Takezawa
+ *
+ */
+namespace Nazg\Http\Server;
+
+use type HH\Lib\Experimental\IO\WriteHandle;
+use type Facebook\Experimental\Http\Message\ResponseInterface;
+use type Facebook\Experimental\Http\Message\ServerRequestInterface;
+
+/**
+ * An HTTP middleware component participates in processing an HTTP message,
+ * either by acting on the request or the response. This interface defines the
+ * methods required to use the middleware.
+ */
+interface MiddlewareInterface {
+
+  /**
+   * Process an incoming server request and return a response, optionally delegating
+   * response creation to a handler.
+   *
+   * @param WriteHandle $handler
+   * @param ServerRequestInterface $request
+   * @param RequestHandlerInterface $handler
+   * @return ResponseInterface
+   */
+  public function process(
+    WriteHandle $writeHandle,
+    ServerRequestInterface $request,
+    RequestHandlerInterface $handler
+  ): ResponseInterface;
+}

src/RequestHandlerInterface.php

@@ -0,0 +1,41 @@
+<?hh // strict
+
+/**
+ * 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.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ *
+ * Copyright (c) 2018 Yuuki Takezawa
+ *
+ */
+namespace Nazg\Http\Server;
+
+use type HH\Lib\Experimental\IO\WriteHandle;
+use type Facebook\Experimental\Http\Message\ResponseInterface;
+use type Facebook\Experimental\Http\Message\ServerRequestInterface;
+
+/**
+ * An HTTP request handler process a HTTP request and produces an HTTP response.
+ * This interface defines the methods require to use the request handler.
+ */
+interface RequestHandlerInterface {
+
+  /**
+   * Handle the request and return a response.
+   * @param WriteHandle $writeHandle
+   * @param ServerRequestInterface $request
+   *
+   * @return ResponseInterface
+   */
+  public function handle(
+    WriteHandle $writeHandle,
+    ServerRequestInterface $request
+  ): ResponseInterface;
+}