action_cable_client 1.3.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 977e65342bdaa2a92cb204a207032d2da9b5a120
-  data.tar.gz: 079643bcac126fcc798ff4a2b0ec26fd59d5fe35
+  metadata.gz: f4efe4e0d3cbf2308ee5deebf64db87704a4518c
+  data.tar.gz: f72fa641ad54554816874825eb0f924eaa033cef
 SHA512:
-  metadata.gz: 23371f7113817938517a3c26c6dcb58cf71a37e14e3f511856f6cfd1c867cf9b13eb650ee27fd975b19ed2f6b90a73fd25bd3cb288b70f3b7e6f9cb982575de9
-  data.tar.gz: a183f2bad40d90a8a7db310037ef9aa3784f188f7c9e0fb4a58cb11f07b56820758a883a008a3565446566284f647212cfd2146249f08bbe2d14e35b43151543
+  metadata.gz: a8ccddc722216d3ac5533734f4ac42e6541d74eb4c7c668ac0774f702674d813057cd39679a1ba0e11b14a7baa7f185a213f0c3a171b889f29ae8384b5567f62
+  data.tar.gz: 6fe25aeb39115aebed3e2caaa76b796e6ec766af521fd323e98cf770168de83a5edf1219e3ca0868fe1590c69b4be49ddff620b1a54bd09c0a6f5cc9b9e7a3d4

data/CHANGELOG.md

@@ -1,26 +1,41 @@
+## 2.0 - Unreleased
+
+**General**
+
+* [#18](https://github.com/NullVoxPopuli/action_cable_client/pull/18) Added the ability to reconnect (@NullVoxPopuli)
+* [#19](https://github.com/NullVoxPopuli/action_cable_client/pull/19) Allow for additional params via the identifier (@mcary, @NullVoxPopuli)
+* Support ruby-2.4.x
+* [#20](https://github.com/NullVoxPopuli/action_cable_client/pull/20) Change underlying websocket gem to [websocket-eventmachine-client](https://github.com/imanel/websocket-eventmachine-client)
+  * enables SSL
+  * allows header usage on handshake
+
+**Breaking**
+* [#19](https://github.com/NullVoxPopuli/action_cable_client/pull/19) Removed queued_send in initializer - this allows for a action_cable_client to be simpler, and stay an true to real-time communication as possible -- also it wasn't being used.  (@NullVoxPopuli)
+* Drop Support for ruby-2.2.x
+
 ## 1.3.4
 * [#7](https://github.com/NullVoxPopuli/action_cable_client/pull/7) Avoid crashing on empty JSON data (@MikeAski)
 
 ## 1.3.2
-* Getting disconnected from the server will now set the result of subscribed? to false
+* Getting disconnected from the server will now set the result of subscribed? to false (@NullVoxPopuli)
 
 ## 1.3.0
-* subscribed now is a callback instead of a boolean
-* subscribed? tells whether or not the client is subscribed to the channel
-* added subscribed callback which signifies when the client can start sending messages on the channel
+* subscribed now is a callback instead of a boolean (@NullVoxPopuli)
+* subscribed? tells whether or not the client is subscribed to the channel (@NullVoxPopuli)
+* added subscribed callback which signifies when the client can start sending messages on the channel (@NullVoxPopuli)
 
 ## 1.2.4
 * [#3](https://github.com/NullVoxPopuli/action_cable_client/pull/3) Support Ruby 2.2.2 (@NullVoxPopuli)
 
 ## 1.2.3
-* The ping message received from the action cable server changed from being identity: _ping to type: ping
-* Fixed an issue where subscribing sometimes didn't work.
+* The ping message received from the action cable server changed from being identity: \_ping to type: ping (@NullVoxPopuli)
+* Fixed an issue where subscribing sometimes didn't work. (@NullVoxPopuli)
 
 ## 1.2.0
-* Made the handling of received messages not all happen in one method. This allows for easier overriding of what is yielded, in case someone wants to also yield the URL for example.
+* Made the handling of received messages not all happen in one method. This allows for easier overriding of what is yielded, in case someone wants to also yield the URL for example. (@NullVoxPopuli)
 
 ## 1.1.0
-* Made message queuing optional, off by default. This allows for near-instant message sending
+* Made message queuing optional, off by default. This allows for near-instant message sending (@NullVoxPopuli)
 
 ## 1.0
-* Initial Work
+* Initial Work (@NullVoxPopuli)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 L. Preston Sego III
+
+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.

data/README.md

@@ -46,6 +46,45 @@ The available hooks to tie in to are:
  - `errored { |msg| }`
  - `received { |msg }`
 
+
+#### Connecting on initialization is also configurable.
+
+```ruby
+client = ActionCableClient.new(uri, 'RoomChannel', connect_on_start: false)
+client.connect!
+```
+
+this way if you also enable ping receiving via
+```ruby
+client.received(false) do |json|
+  # now pings will be here as well, because skip_pings is set to false
+end
+```
+
+you could track the time since you last received a ping, if you haven't received one in a while, it could be that your client is disconnected.
+
+To reconnect,
+
+```ruby
+client.connect!
+```
+
+#### Sending additional params
+
+```ruby
+params = { channel: 'RoomChannel', favorite_color: 'blue' }
+client = ActionCableClient.new(uri, params)
+```
+
+then on the server end, in your Channel, `params` will give you:
+```
+{
+       "channel" => "RoomChannel",
+"favorite_color" => "blue"
+}
+```
+
+
 ## Demo
 
 [![Live Demo](http://img.youtube.com/vi/x9D1wWsVHMY/mqdefault.jpg)](http://www.youtube.com/watch?v=x9D1wWsVHMY&hd=1)

data/lib/action_cable_client.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
+
 # required gems
-require 'em-websocket-client'
+require 'websocket-eventmachine-client'
 require 'forwardable'
 require 'active_support/core_ext/string'
 require 'json'
 
 # local files
+require 'action_cable_client/errors'
 require 'action_cable_client/message_factory'
 require 'action_cable_client/message'
 
@@ -17,44 +19,52 @@ class ActionCableClient
     MESSAGE = 'message'
   end
 
-  attr_reader :_websocket_client, :_uri, :_channel_name, :_queued_send
+  attr_reader :_websocket_client, :_uri
   attr_reader :_message_factory
   # The queue should store entries in the format:
   # [ action, data ]
   attr_accessor :message_queue, :_subscribed, :_subscribed_callaback
 
-  def_delegator :_websocket_client, :errback, :errored
-  def_delegator :_websocket_client, :send_msg, :send_msg
+  def_delegator :_websocket_client, :onerror, :errored
+  def_delegator :_websocket_client, :send, :send_msg
 
   # @param [String] uri - e.g.: ws://domain:port
-  # @param [String] channel - the name of the channel on the Rails server
+  # @param [String] params - the name of the channel on the Rails server
+  #                          or params. This gets sent with every request.
   #                           e.g.: RoomChannel
-  # @param [Boolean] queued_send - optionally send messages after a ping
-  #                                is received, rather than instantly
-  def initialize(uri, channel = '', queued_send = false)
-    @_channel_name = channel
+  # @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 = {})
     @_uri = uri
-    @_queued_send = queued_send
     @message_queue = []
     @_subscribed = false
 
-    @_message_factory = MessageFactory.new(channel)
-    # NOTE:
-    #   EventMachine::WebSocketClient
-    #      https://github.com/mwylde/em-websocket-client/blob/master/lib/em-websocket-client.rb
-    #   is a subclass of
-    #      https://github.com/eventmachine/eventmachine/blob/master/lib/em/connection.rb
-    @_websocket_client = EventMachine::WebSocketClient.connect(_uri)
+    @_message_factory = MessageFactory.new(params)
+
+    connect!(headers) if connect_on_start
+  end
+
+  def connect!(headers = {})
+    # Quick Reference for WebSocket::EM::Client's api
+    # - onopen - called after successfully connecting
+    # - onclose - called after closing connection
+    # - onmessage - called when client recives a message. on `message do |msg, type (text or binary)|``
+    #             - also called when a ping is received
+    # - onerror - called when client encounters an error
+    # - onping - called when client receives a ping from the server
+    # - onpong - called when client receives a pong from the server
+    # - send - sends a message to the server (and also disables any metaprogramming shenanigans :-/)
+    # - 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)
   end
 
   # @param [String] action - how the message is being sent
   # @param [Hash] data - the message to be sent to the channel
   def perform(action, data)
-    if _queued_send
-      message_queue.push([action, data])
-    else
-      dispatch_message(action, data)
-    end
+    dispatch_message(action, data)
   end
 
   # callback for received messages as well as
@@ -70,7 +80,7 @@ class ActionCableClient
   #     puts message
   #   end
   def received(skip_pings = true)
-    _websocket_client.stream do |message|
+    _websocket_client.onmessage do |message, _type|
       handle_received_message(message, skip_pings) do |json|
         yield(json)
       end
@@ -85,7 +95,7 @@ class ActionCableClient
   #     # do things after the client is connected to the server
   #   end
   def connected
-    _websocket_client.callback do
+    _websocket_client.onopen do
       subscribe
       yield
     end
@@ -122,7 +132,7 @@ class ActionCableClient
   #     # cleanup after the server disconnects from the client
   #   end
   def disconnected
-    _websocket_client.disconnect do
+    _websocket_client.onclose do
       self._subscribed = false
       yield
     end
@@ -130,40 +140,12 @@ class ActionCableClient
 
   private
 
-  # @param [WebSocket::Frame::Incoming::Client] message - the websockt message object
-  #        This object is from the websocket-ruby gem:
-  #         https://github.com/imanel/websocket-ruby/blob/master/lib/websocket/frame/incoming/client.rb
-  #
-  #   [9] pry(#<ActionCableClient>)> ap message.methods - Object.instance_methods
-  #
-  #     [ 0]                     <<(data)  WebSocket::Frame::Incoming::Client (WebSocket::Frame::Incoming)
-  #     [ 1]                   code()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [ 2]                  code=(arg1)  WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [ 3]                   data()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [ 4]                  data=(arg1)  WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [ 5]               decoded?()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Incoming)
-  #     [ 6]                  error()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [ 7]                 error=(arg1)  WebSocket::Frame::Incoming::Client (WebSocket::ExceptionHandler)
-  #     [ 8]                 error?()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [ 9]      incoming_masking?()      WebSocket::Frame::Incoming::Client
-  #     [10] initialize_with_rescue(*args) WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [11]                   next(*args) WebSocket::Frame::Incoming::Client (WebSocket::Frame::Incoming)
-  #     [12]       next_with_rescue(*args) WebSocket::Frame::Incoming::Client (WebSocket::Frame::Incoming)
-  #     [13]    next_without_rescue()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Incoming)
-  #     [14]      outgoing_masking?()      WebSocket::Frame::Incoming::Client
-  #     [15]          support_type?()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [16]       supported_frames()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [17]                   type()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #     [18]                version()      WebSocket::Frame::Incoming::Client (WebSocket::Frame::Base)
-  #
-  # None of this really seems that importont, other than `data`
-  #
+  # @param [String] message - the websockt message object
   # @param [Boolean] skip_pings - by default, messages
   #        with the identifier '_ping' are skipped
   def handle_received_message(message, skip_pings = true)
-    string = message.data
-    return if string.empty?
-    json = JSON.parse(string)
+    return if message.empty?
+    json = JSON.parse(message)
 
     if is_ping?(json)
       yield(json) unless skip_pings
@@ -174,17 +156,15 @@ class ActionCableClient
       #       maybe just make it extensible?
       yield(json)
     end
-
-    deplete_queue if _queued_send
   end
 
   # {"identifier" => "_ping","type" => "confirm_subscription"}
   def check_for_subscribe_confirmation(message)
     message_type = message[Message::TYPE_KEY]
-    if Message::TYPE_CONFIRM_SUBSCRIPTION == message_type
-      self._subscribed = true
-      _subscribed_callaback.call if _subscribed_callaback
-    end
+    return unless  Message::TYPE_CONFIRM_SUBSCRIPTION == message_type
+
+    self._subscribed = true
+    _subscribed_callaback&.call
   end
 
   # {"identifier" => "_ping","message" => 1460201942}
@@ -199,23 +179,12 @@ class ActionCableClient
     send_msg(msg.to_json)
   end
 
-  def deplete_queue
-    # if we haven't yet subscribed, don't deplete the queue
-    if subscribed?
-      # only try to send if we have messages to send
-      until message_queue.empty?
-        action, data = message_queue.pop
-        dispatch_message(action, data)
-      end
-    end
-  end
-
   def dispatch_message(action, data)
     # can't send messages if we aren't subscribed
-    if subscribed?
-      msg = _message_factory.create(Commands::MESSAGE, action, data)
-      json = msg.to_json
-      send_msg(json)
-    end
+    return unless subscribed?
+
+    msg = _message_factory.create(Commands::MESSAGE, action, data)
+    json = msg.to_json
+    send_msg(json)
   end
 end

data/lib/action_cable_client/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ActionCableClient
+  module Errors
+    class ChannelNotSpecified < StandardError; end
+  end
+end

data/lib/action_cable_client/message.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class ActionCableClient
   class Message
     IDENTIFIER_KEY = 'identifier'

data/lib/action_cable_client/message_factory.rb

@@ -1,11 +1,23 @@
 # frozen_string_literal: true
+
 class ActionCableClient
   class MessageFactory
-    attr_reader :_channel
+    attr_reader :channel, :identifier
 
-    # @param [String] channel - the name of the subscribed channel
+    # @param [String or Hash] channel - the name of the subscribed channel, or
+    #   a hash that includes the :channel key and any other params to send.
     def initialize(channel)
-      @_channel = channel
+      # the ending result should look like
+      # "{"channel":"RoomChannel"}" but that's up to
+      # the Mesage to format it
+      @channel = channel
+      @identifier =
+        case channel
+        when String then { channel: channel }
+        when Hash then channel
+        else
+          raise ActionCableClient::Errors::ChannelNotSpecified, 'channel is invalid'
+        end
     end
 
     # @param [String] command - the type of message that this is
@@ -22,12 +34,5 @@ class ActionCableClient
     def build_data(action, message)
       message.merge(action: action) if message.is_a?(Hash)
     end
-
-    # the ending result should look like
-    # "{"channel":"RoomChannel"}" but that's up to
-    # the Mesage to format it
-    def identifier
-      { channel: _channel }
-    end
   end
 end

data/lib/action_cable_client/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class ActionCableClient
-  VERSION = '1.3.4'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_client
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 2.0.0
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2017-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0.beta4
 - !ruby/object:Gem::Dependency
-  name: em-websocket-client
+  name: websocket-eventmachine-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,8 +101,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
 - README.md
 - lib/action_cable_client.rb
+- lib/action_cable_client/errors.rb
 - lib/action_cable_client/message.rb
 - lib/action_cable_client/message_factory.rb
 - lib/action_cable_client/version.rb
@@ -126,8 +128,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: ActionCableClient-1.3.4
+summary: ActionCableClient-2.0.0
 test_files: []
+has_rdoc: