action_cable_client 1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5764cc7e98e88de5996d3ea6e32633b72aa97e15
-  data.tar.gz: 99d9baa73bed7eb3b7288021e38ce01494bef4f7
+  metadata.gz: 2061444f2909753d47a8f603b54d8be3009b298e
+  data.tar.gz: c52360502fc6582d1e46e7c2433a08fc3b6dd8da
 SHA512:
-  metadata.gz: 5dea9401dfe69bcab3d7da3c20576ef1beca22517fdd8c4b4afbf920279ecab7a6f2f55cccf48d1f90b6c6814b65173759c1e7a0aad54c6512909508a7429f01
-  data.tar.gz: a4defa4899914dbcb0c55cb331585d382b19e63eb62dbec73d6b8b611bda04118dc79c28da9e2d5bb100dcea139591c889bd998e6395b2dc372f02d6203fe612
+  metadata.gz: 2244aa969d7c82bbb46e2f945ebe4499e556ffa70c43914579cb48333308b04e13ab92a2857df11d23c41bfac27978e6ccd0a2fe03f10f927f5456004cfc5d93
+  data.tar.gz: e79ce50f3b82c328b2af3d7076bdef524e8ceab8100638f3c8246000b2479043e768f7319cad71b8369bf3ef3e65952c6ca771d5837ebd04ea70d1f3121f8084

data/CHANGELOG.md

@@ -1 +1,2 @@
+* 1.0 Release
 * Initial Work 

data/README.md

@@ -1,7 +1,10 @@
 # Action Cable Client
+[![Gem Version](https://badge.fury.io/rb/action_cable_client.svg)](https://badge.fury.io/rb/action_cable_client)
 [![Build Status](https://travis-ci.org/NullVoxPopuli/action_cable_client.svg?branch=master)](https://travis-ci.org/NullVoxPopuli/action_cable_client)
 [![Code Climate](https://codeclimate.com/github/NullVoxPopuli/action_cable_client/badges/gpa.svg)](https://codeclimate.com/github/NullVoxPopuli/action_cable_client)
 [![Test Coverage](https://codeclimate.com/github/NullVoxPopuli/action_cable_client/badges/coverage.svg)](https://codeclimate.com/github/NullVoxPopuli/action_cable_client/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/NullVoxPopuli/action_cable_client.svg)](https://gemnasium.com/github.com/NullVoxPopuli/action_cable_client)
+
 
 There are quite a few WebSocket Servers out there. The popular ones seem to be: [faye-websocket-ruby](https://github.com/faye/faye-websocket-ruby), [em-websockets](https://github.com/igrigorik/em-websocket). The client-only websocket gems are kinda hard to find, and are only raw websocket support. Rails has a thin layer on top of web sockets to help manage subscribing to channels and send/receive on channels.
 
@@ -34,8 +37,26 @@ end
 
 This example is compatible with [this version of a small Rails app with Action Cable](https://github.com/NullVoxPopuli/mesh-relay/tree/2ed88928d91d82b88b7878fcb97e3bd81977cfe8)
 
+
+
 The available hooks to tie in to are:
  - `disconnected {}`
  - `connected {}`
  - `errored { |msg| }`
  - `received { |msg }`
+
+## Demo
+
+[![Live Demo](http://img.youtube.com/vi/x9D1wWsVHMY/mqdefault.jpg)](http://www.youtube.com/watch?v=x9D1wWsVHMY&hd=1)
+
+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.
+
+## Contributing
+
+1. Fork it ( https://github.com/NullVoxPopuli/action_cable_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/action_cable_client.rb

@@ -17,13 +17,13 @@ class ActionCableClient
     MESSAGE = 'message'
   end
 
-  attr_reader :_websocket_client, :_uri, :_channel_name
+  attr_reader :_websocket_client, :_uri, :_channel_name, :_queued_send
   attr_reader :_message_factory
   # The queue should store entries in the format:
   # [ action, data ]
   attr_accessor :message_queue, :subscribed
 
-  alias_method :subscribed?, :subscribed
+  alias subscribed? subscribed
 
   def_delegator :_websocket_client, :disconnect, :disconnected
   def_delegator :_websocket_client, :errback, :errored
@@ -33,9 +33,12 @@ class ActionCableClient
   # @param [String] uri - e.g.: ws://domain:port
   # @param [String] channel - the name of the channel on the Rails server
   #                           e.g.: RoomChannel
-  def initialize(uri, channel = '')
+  # @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
     @_uri = uri
+    @_queued_send = queued_send
     @message_queue = []
     @subscribed = false
 
@@ -51,7 +54,11 @@ class ActionCableClient
   # @param [String] action - how the message is being sent
   # @param [Hash] data - the message to be sent to the channel
   def perform(action, data)
-    message_queue.push([action, data])
+    if _queued_send
+      message_queue.push([action, data])
+    else
+      dispatch_message(action, data)
+    end
   end
 
   # callback for received messages as well as
@@ -67,7 +74,7 @@ class ActionCableClient
   #     puts message
   #   end
   def received(skip_pings = true)
-    _websocket_client.stream do | message |
+    _websocket_client.stream do |message|
       string = message.data
       json = JSON.parse(string)
 
@@ -77,7 +84,8 @@ class ActionCableClient
       else
         yield(json)
       end
-      deplete_queue if subscribed?
+
+      deplete_queue if _queued_send
     end
   end
 
@@ -100,9 +108,7 @@ class ActionCableClient
   # {"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
-    end
+    self.subscribed = true if Message::TYPE_CONFIRM_SUBSCRIPTION == message_type
   end
 
   # {"identifier" => "_ping","message" => 1460201942}
@@ -118,8 +124,19 @@ class ActionCableClient
   end
 
   def deplete_queue
-    while (message_queue.size > 0)
-      action, data = message_queue.pop
+    # 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)
       send_msg(msg.to_json)
     end

data/lib/action_cable_client/message.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 class ActionCableClient
   class Message
-    IDENTIFIER_KEY = 'identifier'.freeze
-    IDENTIFIER_PING = '_ping'.freeze
+    IDENTIFIER_KEY = 'identifier'
+    IDENTIFIER_PING = '_ping'
     # Type is never sent, but is received
     # TODO: find a better place for this constant
-    TYPE_KEY = 'type'.freeze
-    TYPE_CONFIRM_SUBSCRIPTION = 'confirm_subscription'.freeze
-
+    TYPE_KEY = 'type'
+    TYPE_CONFIRM_SUBSCRIPTION = 'confirm_subscription'
 
     attr_reader :_command, :_identifier, :_data
 

data/lib/action_cable_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_client
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.0
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-09 00:00:00.000000000 Z
+date: 2016-04-18 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.0
+summary: ActionCableClient-1.1.0
 test_files: []