2.0.0 gm (#69)

* gm * add license * docs * unmask ping, fixes #49 * fix typo
vapor · Mar 30, 2020 · f46778e · f46778e
1 parent aac4624
commit f46778e
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 3 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Qutheory, LLC
+
+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.
diff --git a/Sources/WebSocketKit/WebSocket.swift b/Sources/WebSocketKit/WebSocket.swift
@@ -140,8 +140,13 @@ public final class WebSocket {
             }
         case .ping:
             if frame.fin {
+                var frameData = frame.data
+                let maskingKey = frame.maskKey
+                if let maskingKey = maskingKey {
+                    frameData.webSocketUnmask(maskingKey)
+                }
                 self.send(
-                    raw: frame.data.readableBytesView,
+                    raw: frameData.readableBytesView,
                     opcode: .pong,
                     fin: true,
                     promise: nil

diff --git a/Sources/WebSocketKit/WebSocketHandler.swift b/Sources/WebSocketKit/WebSocketHandler.swift
@@ -49,7 +49,6 @@ private final class WebSocketHandler: ChannelInboundHandler {
         self.webSocket = webSocket
     }
 
-    /// See `ChannelInboundHandler`.
     func channelRead(context: ChannelHandlerContext, data: NIOAny) {
         let frame = self.unwrapInboundIn(data)
         self.webSocket.handle(incoming: frame)

diff --git a/...ketKitTests/NIOWebSocketClientTests.swift → ...WebSocketKitTests/WebSocketKitTests.swift b/...ketKitTests/NIOWebSocketClientTests.swift → ...WebSocketKitTests/WebSocketKitTests.swift
@@ -4,7 +4,7 @@ import NIOHTTP1
 import NIOWebSocket
 @testable import WebSocketKit
 
-final class NIOWebSocketClientTests: XCTestCase {
+final class WebSocketKitTests: XCTestCase {
     func testWebSocketEcho() throws {
         let promise = elg.next().makePromise(of: String.self)
         WebSocket.connect(to: "ws://echo.websocket.org", on: elg) { ws in