action_cable_client 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef3930c35f391add154d196da2d779e1e51aab9e710c97e138f743cf8aac8be7
-  data.tar.gz: 81e73f0c6aa96c39d2aafac68e03f08f3c15f7920bba10449711dc28cb21bddd
+  metadata.gz: fa0c15dc6f8b9a9a6c0643090cac82c9ee0f2f36522b0a086433f3c852396c65
+  data.tar.gz: 0b0dc2baf9515ff563ecd9f2b2b66b35b29afb2ae33f428ab79b91109d5aa1a9
 SHA512:
-  metadata.gz: 3a8835181f1d80da858441ad174571642791b5491cb734cdb9c9c660248d0d02b611000c18d456a1c20a6dab0502986226b30931e52bd2c1c7948c3242d7b00b
-  data.tar.gz: 4c5135c08c26bf4bb12dc3289b5bc024b03efa962b0617f6a21493b44683bec046dc8007971c5eb4cc76a21b69a14b3df996ee09b5fb5becbd0818f02eab9fef
+  metadata.gz: f51b7a5e089987b064c7ea136b0521749ea65ce44fa3b90d9a72cf75e3ca2f07defc8f3e6c773837764dae257c4d61765fdbc991f1fb44ec6cd7e9bed6751106
+  data.tar.gz: 3961a4a422c32d0e3464942aed22659a5326ccb4346b05532e4344bfe98c47ed941f212d9cd62950c081488bc1de98312c0e508d13b60f3265be7a28878e0520

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 3.0.1
 
-* [#27](https://github.com/NullVoxPopuli/action_cable_client/pull/27)
+* [#27](https://github.com/NullVoxPopuli/action_cable_client/pull/27) ([@neomilium](https://github.com/neomilium))
   * Implement reconnect
   * Fix issue with subscribing only working on initial connection
   * Additional Tests
@@ -8,13 +8,13 @@
 
 ## 2.0.2
 
-* [#24](https://github.com/NullVoxPopuli/action_cable_client/pull/24) Fix bug where action cable client is too fast for the server and doesn't wait for the server's welcome message before initiating a channel subscription (@wpp)
+* [#24](https://github.com/NullVoxPopuli/action_cable_client/pull/24) Fix bug where action cable client is too fast for the server and doesn't wait for the server's welcome message before initiating a channel subscription ([@wpp](https://github.com/wpp))
 
 ## 2.0.1
 
 **General**
 
-* [#22](https://github.com/NullVoxPopuli/action_cable_client/pull/22) Removed ActiveSupport Dependency (@srabuini)
+* [#22](https://github.com/NullVoxPopuli/action_cable_client/pull/22) Removed ActiveSupport Dependency ([@srabuini](https://github.com/srabuini))
 
 ## 2.0
 

data/README.md

@@ -88,6 +88,16 @@ client = ActionCableClient.new(uri, params, true, {
 })
 ```
 
+#### Using TLS
+
+Example given for client certificate authentication. See EventMachine::Connection#start_tls documentation for other options. 
+
+```ruby
+params = { channel: 'RoomChannel', favorite_color: 'blue' }
+tls = {cert_chain_file: 'user.crt', private_key_file: 'user.key'}
+client = ActionCableClient.new(uri, params, true, nil, tls)
+```
+
 
 ## Demo
 

data/lib/action_cable_client.rb

@@ -35,17 +35,18 @@ class ActionCableClient
   # @param [Boolean] connect_on_start - connects on init when true
   #                                   - otherwise manually call `connect!`
   # @param [Hash] headers - HTTP headers to use in the handshake
-  def initialize(uri, params = '', connect_on_start = true, headers = {})
+  # @param [Hash] tls - TLS options hash to be passed to EM start_tls
+  def initialize(uri, params = '', connect_on_start = true, headers = {}, tls = {})
     @_uri = uri
     @message_queue = []
     @_subscribed = false
 
     @_message_factory = MessageFactory.new(params)
 
-    connect!(headers) if connect_on_start
+    connect!(headers, tls) if connect_on_start
   end
 
-  def connect!(headers = {})
+  def connect!(headers = {}, tls = {})
     # Quick Reference for WebSocket::EM::Client's api
     # - onopen - called after successfully connecting
     # - onclose - called after closing connection
@@ -58,7 +59,7 @@ class ActionCableClient
     # - close - closes the connection and optionally sends close frame to server. `close(code, data)`
     # - ping - sends a ping
     # - pong - sends a pong
-    @_websocket_client = WebSocket::EventMachine::Client.connect(uri: @_uri, headers: headers)
+    @_websocket_client = WebSocket::EventMachine::Client.connect(uri: @_uri, headers: headers, tls: tls)
 
     @_websocket_client.onclose do
       self._subscribed = false

data/lib/action_cable_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ActionCableClient
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_client
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2019-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-eventmachine-client
@@ -113,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: ActionCableClient-3.0.1
+summary: ActionCableClient-3.1.0
 test_files: []