action_cable_client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2061444f2909753d47a8f603b54d8be3009b298e
-  data.tar.gz: c52360502fc6582d1e46e7c2433a08fc3b6dd8da
+  metadata.gz: bf3e80558eb6d0f95a7231691b4418cf8db5477f
+  data.tar.gz: 86148eae1c47b441775874811d55a9b330482e88
 SHA512:
-  metadata.gz: 2244aa969d7c82bbb46e2f945ebe4499e556ffa70c43914579cb48333308b04e13ab92a2857df11d23c41bfac27978e6ccd0a2fe03f10f927f5456004cfc5d93
-  data.tar.gz: e79ce50f3b82c328b2af3d7076bdef524e8ceab8100638f3c8246000b2479043e768f7319cad71b8369bf3ef3e65952c6ca771d5837ebd04ea70d1f3121f8084
+  metadata.gz: 8a681d1dd7de3ca8530f36a2998ceab0cf6fbbdc890f914ccb81db8670535dd28520cda5ced1a80fdd3f54702819c23b664835e753669bcca9e2a71f3d4ea64c
+  data.tar.gz: 0b5170f14d921eaaf7d244806b9b8083fc58563fd7f382257c1aee936a4b77a94c9734f8794c139550ebe668375cff8145ec960af2d6471ec1ff37f2777748b0

data/CHANGELOG.md

@@ -1,2 +1,5 @@
-* 1.0 Release
-* Initial Work 
+## 1.1.0
+* Made message queuing optional, off by default. This allows for near-instant message sending
+
+## 1.0
+* Initial Work

data/README.md

@@ -53,6 +53,35 @@ Action Cable Client Demo on YouTube (1:41)
 
 [Here is a set of files in a gist](https://gist.github.com/NullVoxPopuli/edfcbbe91a7877e445cbde84c7f05b37) that demonstrate how different `action_cable_client`s can communicate with eachother.
 
+## The Action Cable Protocol
+
+There really isn't that much to this gem. :-)
+
+1. Connect to the Action Cable URL
+2. After the connection succeeds, send a subscribe message
+  - The subscribe message JSON should look like this
+    - `{"command":"subscribe","identifier":"{\"channel\":\"MeshRelayChannel\"}"}`
+  - You should receive a message like this:
+    - `{"identifier"=>"{\"channel\":\"MeshRelayChannel\"}", "type"=>"confirm_subscription"}`
+3. Once subscribed, you can send messages.
+  - Make sure that the command string matches the data-handling method name on your ActionCable server.
+  - Your message JSON should look like this:
+    - `{"command":"message","identifier":"{\"channel\":\"MeshRelayChannel\"}","data":"{\"to\":\"user1\",\"message\":\"hello from user2\",\"action\":\"chat\"}"}`
+    - Received messages should look about the same
+
+4. Notes:
+  - Every message sent to the server has a `command` and `identifier` key. 
+  - The channel value must match the `name` of the channel class on the ActionCable server.
+  - `identifier` and `data` are redundantly jsonified. So, for example (in ruby):
+```ruby
+payload = {
+  command: 'command text',
+  identifier: { channel: 'MeshRelayChannel' }.to_json,
+  data: { to: 'user', message: 'hi' }.to_json
+}.to_json
+```
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/NullVoxPopuli/action_cable_client/fork )

data/lib/action_cable_client.rb

@@ -75,17 +75,9 @@ class ActionCableClient
   #   end
   def received(skip_pings = true)
     _websocket_client.stream do |message|
-      string = message.data
-      json = JSON.parse(string)
-
-      if is_ping?(json)
-        check_for_subscribe_confirmation(json) unless subscribed?
-        yield(json) unless skip_pings
-      else
+      handle_received_message(message, skip_pings) do |json|
         yield(json)
       end
-
-      deplete_queue if _queued_send
     end
   end
 
@@ -105,6 +97,53 @@ 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 [Boolean] skip_pings - by default, messages
+  #        with the identifier '_ping' are skipped
+  def handle_received_message(message, skip_pings = true)
+    string = message.data
+    json = JSON.parse(string)
+
+    if is_ping?(json)
+      check_for_subscribe_confirmation(json) unless subscribed?
+      yield(json) unless skip_pings
+    else
+      # TODO: do we want to yield any additional things?
+      #       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]
@@ -120,7 +159,7 @@ class ActionCableClient
 
   def subscribe
     msg = _message_factory.create(Commands::SUBSCRIBE)
-    _websocket_client.send_msg(msg.to_json)
+    send_msg(msg.to_json)
   end
 
   def deplete_queue

data/lib/action_cable_client/version.rb

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

metadata

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