action_cable_client 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d277286f584837f71576421701bae3c0975e4eb7
-  data.tar.gz: 78a1268989c024534d62f7518bca9ef7138f8c50
+  metadata.gz: 9df9f344f461e4863351dd7c78b1174923e9686c
+  data.tar.gz: 9e0ee80e83d868a1b86b16bf7ab23edc108ba6ca
 SHA512:
-  metadata.gz: 167fbe1af85644521eeacd4cf5236a7970c237b929a31090ba0e39bbb79de3d99248bba8bd09bad2b6e651c293188c802eaaffaf293798c23debf69fe48e19ea
-  data.tar.gz: d543bf29866e065d3313d0dc03f7f28061aaf3be6676a2b6c7d61b82c10f840892d421ea0bc432270830bbd77f79b5f243d9d78c1829a884c4e7646c75565ef7
+  metadata.gz: 803df93ecb11cb0cee7125b90bfe77ca16b44792b4b6fdebf857929208a106d57a7acfb1afccf8cd3ccc3c87d9cd3cfec094c7d22429ffdd91710be0f9117332
+  data.tar.gz: a1ed9a6dfc18d3845190c395aab13812300a868891a65024be39238485d5823cfd1c511522a337ff80f4131d43808394c8379fc202ed77a1fff7ab13f49f12cb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
+## 1.2.6
+* 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
+
 ## 1.2.4
-* Support Ruby 2.2.2
+* [#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

data/README.md

@@ -42,6 +42,7 @@ This example is compatible with [this version of a small Rails app with Action C
 The available hooks to tie in to are:
  - `disconnected {}`
  - `connected {}`
+ - `subscribed {}`
  - `errored { |msg| }`
  - `received { |msg }`
 

data/lib/action_cable_client.rb

@@ -21,13 +21,10 @@ class ActionCableClient
   attr_reader :_message_factory
   # The queue should store entries in the format:
   # [ action, data ]
-  attr_accessor :message_queue, :subscribed
-
-  alias subscribed? subscribed
+  attr_accessor :message_queue, :_subscribed, :_subscribed_callaback
 
   def_delegator :_websocket_client, :disconnect, :disconnected
   def_delegator :_websocket_client, :errback, :errored
-  def_delegator :_websocket_client, :connection_completed, :connected?
   def_delegator :_websocket_client, :send_msg, :send_msg
 
   # @param [String] uri - e.g.: ws://domain:port
@@ -40,7 +37,7 @@ class ActionCableClient
     @_uri = uri
     @_queued_send = queued_send
     @message_queue = []
-    @subscribed = false
+    @_subscribed = false
 
     @_message_factory = MessageFactory.new(channel)
     # NOTE:
@@ -95,6 +92,28 @@ class ActionCableClient
     end
   end
 
+  # callback when the client receives a confirm_subscription message
+  # from the action_cable server.
+  # This is only called once, and signifies that you can now send
+  # messages on the channel
+  #
+  # @param [Proc] block - code to run after subscribing to the channel is confirmed
+  #
+  # @example
+  #   client = ActionCableClient.new(uri, 'RoomChannel')
+  #   client.connected {}
+  #   client.subscribed do
+  #     # do things after successful subscription confirmation
+  #   end
+  def subscribed(&block)
+    self._subscribed_callaback = block
+  end
+
+  # @return [Boolean] is the client subscribed to the channel?
+  def subscribed?
+    _subscribed
+  end
+
   private
 
   # @param [WebSocket::Frame::Incoming::Client] message - the websockt message object
@@ -147,7 +166,10 @@ class ActionCableClient
   # {"identifier" => "_ping","type" => "confirm_subscription"}
   def check_for_subscribe_confirmation(message)
     message_type = message[Message::TYPE_KEY]
-    self.subscribed = true if Message::TYPE_CONFIRM_SUBSCRIPTION == message_type
+    if Message::TYPE_CONFIRM_SUBSCRIPTION == message_type
+      self._subscribed = true
+      _subscribed_callaback.call if _subscribed_callaback
+    end
   end
 
   # {"identifier" => "_ping","message" => 1460201942}
@@ -177,7 +199,8 @@ class ActionCableClient
     # can't send messages if we aren't subscribed
     if subscribed?
       msg = _message_factory.create(Commands::MESSAGE, action, data)
-      send_msg(msg.to_json)
+      json = msg.to_json
+      send_msg(json)
     end
   end
 end

data/lib/action_cable_client/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class ActionCableClient
-  VERSION = '1.2.4'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_client
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,6 +129,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: ActionCableClient-1.2.4
+summary: ActionCableClient-1.3.0
 test_files: []
 has_rdoc: