websocket-driver 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45f6962eb4b7b927eddff1e14c1368464227ef7f
-  data.tar.gz: 8e98a4638c104fce2ccc752f87eadd1269f8a643
+  metadata.gz: 0ddf5e80d9f5080fc8d494d3e93611cdd23eb759
+  data.tar.gz: 15ad3e7d961a9940971a76817ceb6ce0bba8a6f0
 SHA512:
-  metadata.gz: fcc93ef62b0bd24fb9f1687874591ff7747c0a02896d395195ff699381b9c3d4d1888c4fbe079e017442f8e79a8c908c514fdf4550f872303fef6351c7484bb2
-  data.tar.gz: 1f9215cc0926f4d7d6d083939dc2a8c83a6ca89e1eb30af2ae064ec16239936a12f69cd4a2dda12651358a2402a90fd59533b00b8d18e413d580269a418a2bc3
+  metadata.gz: 3655528c0e0533a75512fc1e69044b03506fdf9d751d0c41875b1efea98f0eae55024887e6445fa17a30fc8996b85d3ca808e89bb72631c1f7fc6ac99a39e227
+  data.tar.gz: 0d85ca3a28fcb776bcb292ad90886cd98e27ad84739bcab1478e37b36afe8c964475faf4fda0201fd35cbf3dc006106a89db4da808085585c7d292cac5821739

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.7.0 / 2017-09-11
+
+* Add `ping` and `pong` to the set of events users can listen to
+
 ### 0.6.5 / 2017-01-22
 
 * Provide a pure-Ruby fallback for the native unmasking code

data/LICENSE.md

@@ -1,6 +1,4 @@
-# License
-
-(The MIT License)
+# The MIT License
 
 Copyright (c) 2010-2017 James Coglan
 

data/README.md

@@ -295,6 +295,17 @@ describing the error.
 Adds a callback block to execute when the socket becomes closed. The `event`
 object has `code` and `reason` attributes.
 
+#### `driver.on :ping, -> (event) { }`
+
+Adds a callback block to execute when a ping is received. You do not need to
+handle this by sending a pong frame yourself; the driver handles this for you.
+
+#### `driver.on :pong, -> (event) { }`
+
+Adds a callback block to execute when a pong is received. If this was in
+response to a ping you sent, you can also handle this event via the
+`driver.ping(message) { ... }` callback.
+
 #### `driver.add_extension(extension)`
 
 Registers a protocol extension whose operation will be negotiated via the

data/lib/websocket/driver.rb

@@ -50,6 +50,8 @@ module WebSocket
     ConnectEvent = Struct.new(nil)
     OpenEvent    = Struct.new(nil)
     MessageEvent = Struct.new(:data)
+    PingEvent    = Struct.new(:data)
+    PongEvent    = Struct.new(:data)
     CloseEvent   = Struct.new(:code, :reason)
 
     ProtocolError      = Class.new(StandardError)

data/lib/websocket/driver/hybi.rb

@@ -368,12 +368,14 @@ module WebSocket
 
           when OPCODES[:ping] then
             frame(payload, :pong)
+            emit(:ping, PingEvent.new(payload))
 
           when OPCODES[:pong] then
             message = Driver.encode(payload, UNICODE)
             callback = @ping_callbacks[message]
             @ping_callbacks.delete(message)
             callback.call if callback
+            emit(:pong, PongEvent.new(payload))
         end
 
         emit_message if frame.final and MESSAGE_OPCODES.include?(opcode)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-22 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-extensions
@@ -91,7 +91,6 @@ files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
-- examples/tcp_server.rb
 - ext/websocket-driver/WebsocketMaskService.java
 - ext/websocket-driver/extconf.rb
 - ext/websocket-driver/websocket_mask.c
@@ -113,7 +112,7 @@ files:
 - lib/websocket/http/response.rb
 - lib/websocket/mask.rb
 - lib/websocket/websocket_mask.rb
-homepage: http://github.com/faye/websocket-driver-ruby
+homepage: https://github.com/faye/websocket-driver-ruby
 licenses:
 - MIT
 metadata: {}
@@ -137,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O

data/examples/tcp_server.rb

@@ -1,28 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'eventmachine'
-require 'websocket/driver'
-require 'permessage_deflate'
-
-module Connection
-  def initialize
-    @driver = WebSocket::Driver.server(self)
-    @driver.add_extension(PermessageDeflate)
-
-    @driver.on(:connect) { |e| @driver.start if WebSocket::Driver.websocket? @driver.env }
-    @driver.on(:message) { |e| @driver.frame(e.data) }
-    @driver.on(:close)   { |e| close_connection_after_writing }
-  end
-
-  def receive_data(data)
-    @driver.parse(data)
-  end
-
-  def write(data)
-    send_data(data)
-  end
-end
-
-EM.run {
-  EM.start_server('127.0.0.1', ARGV[0], Connection)
-}