action_cable_client 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4efe4e0d3cbf2308ee5deebf64db87704a4518c
-  data.tar.gz: f72fa641ad54554816874825eb0f924eaa033cef
+  metadata.gz: 4085894ce47fa6d116953ecdaf16770f7849cb27
+  data.tar.gz: 654c166304ca757a36fd0c4d3755ee132fdbe497
 SHA512:
-  metadata.gz: a8ccddc722216d3ac5533734f4ac42e6541d74eb4c7c668ac0774f702674d813057cd39679a1ba0e11b14a7baa7f185a213f0c3a171b889f29ae8384b5567f62
-  data.tar.gz: 6fe25aeb39115aebed3e2caaa76b796e6ec766af521fd323e98cf770168de83a5edf1219e3ca0868fe1590c69b4be49ddff620b1a54bd09c0a6f5cc9b9e7a3d4
+  metadata.gz: 368ca003b9182f912b7b81b3b4d5715d33c33cb047f16d3b6ae29a38a722e13494f60837e1aa05c7608a8628311aa585c2769407664557a735e14af4513430d8
+  data.tar.gz: c99816b5ede4d23cf3442b00bf9eb7feadf26a0a3c811c63c65ca8e48ecd1997858a8cedfda6376c6de17882e986003f08b791610a9a48cd0b77b83ace70d077

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 2.0 - Unreleased
+## 2.0.1
+
+**General**
+
+* [#22](https://github.com/NullVoxPopuli/action_cable_client/pull/22) Removed ActiveSupport Dependency (@srabuini)
+
+## 2.0
 
 **General**
 

data/README.md

@@ -5,10 +5,7 @@
 [![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.
-
-This gem is a wrapper around [em-websocket-client](https://github.com/mwylde/em-websocket-client/), and supports the Rails Action Cable protocol.
+This gem is a wrapper around [websocket-eventmachine-client](https://github.com/imanel/websocket-eventmachine-client), and supports the Rails Action Cable protocol.
 
 ## Usage
 
@@ -29,8 +26,7 @@ EventMachine.run do
     puts message
   end
 
-  # adds to a queue that is purged upon receiving of
-  # a ping from the server
+  # Sends a message to the sever, with the 'action', 'speak'
   client.perform('speak', { message: 'hello from amc' })
 end
 ```
@@ -45,23 +41,23 @@ The available hooks to tie in to are:
  - `subscribed {}`
  - `errored { |msg| }`
  - `received { |msg }`
+ - `pinged { |msg| }`
 
 
 #### Connecting on initialization is also configurable.
 
 ```ruby
-client = ActionCableClient.new(uri, 'RoomChannel', connect_on_start: false)
-client.connect!
+client = ActionCableClient.new(uri, 'RoomChannel', false)
+client.connect!(headers = {})
 ```
 
-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
+client.pinged do |_data|
+  # 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.
 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,
 
@@ -84,6 +80,16 @@ then on the server end, in your Channel, `params` will give you:
 }
 ```
 
+#### Using Headers
+
+
+```ruby
+params = { channel: 'RoomChannel', favorite_color: 'blue' }
+client = ActionCableClient.new(uri, params, true, {
+  'Authorization' => 'Bearer token'
+})
+```
+
 
 ## Demo
 
@@ -111,8 +117,6 @@ There really isn't that much to this gem. :-)
 
 4. Notes:
   - Every message sent to the server has a `command` and `identifier` key.
-  - Ping messages from the action cable server look like:
-    - `{ "type" => "ping", "message" =>  1461845503 }`
   - 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

data/lib/action_cable_client.rb

@@ -3,7 +3,6 @@
 # required gems
 require 'websocket-eventmachine-client'
 require 'forwardable'
-require 'active_support/core_ext/string'
 require 'json'
 
 # local files
@@ -23,7 +22,7 @@ class ActionCableClient
   attr_reader :_message_factory
   # The queue should store entries in the format:
   # [ action, data ]
-  attr_accessor :message_queue, :_subscribed, :_subscribed_callaback
+  attr_accessor :message_queue, :_subscribed, :_subscribed_callaback, :_pinged_callback
 
   def_delegator :_websocket_client, :onerror, :errored
   def_delegator :_websocket_client, :send, :send_msg
@@ -70,18 +69,15 @@ class ActionCableClient
   # callback for received messages as well as
   # what triggers depleting the message queue
   #
-  # @param [Boolean] skip_pings - by default, messages
-  #        with the identifier '_ping' are skipped
-  #
   # @example
   #   client = ActionCableClient.new(uri, 'RoomChannel')
   #   client.received do |message|
   #     # the received message will be JSON
   #     puts message
   #   end
-  def received(skip_pings = true)
+  def received
     _websocket_client.onmessage do |message, _type|
-      handle_received_message(message, skip_pings) do |json|
+      handle_received_message(message) do |json|
         yield(json)
       end
     end
@@ -138,17 +134,19 @@ class ActionCableClient
     end
   end
 
+  def pinged(&block)
+    self._pinged_callback = block
+  end
+
   private
 
   # @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)
+  def handle_received_message(message)
     return if message.empty?
     json = JSON.parse(message)
 
     if is_ping?(json)
-      yield(json) unless skip_pings
+      _pinged_callback&.call(json)
     elsif !subscribed?
       check_for_subscribe_confirmation(json)
     else

data/lib/action_cable_client/message.rb

@@ -26,9 +26,20 @@ class ActionCableClient
         identifier: _identifier.to_json
       }
 
-      hash[:data] = _data.to_json if _data.present?
+      hash[:data] = _data.to_json if present?(_data)
 
       hash.to_json
     end
+
+    private
+
+    def present?(data)
+      case data
+      when String
+        !(data.empty? || /\A[[:space:]]*\z/.match(data))
+      else
+        data.respond_to?(:empty?) ? !data.empty? : !!data
+      end
+    end
   end
 end

data/lib/action_cable_client/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: action_cable_client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-22 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.beta4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.beta4
 - !ruby/object:Gem::Dependency
   name: websocket-eventmachine-client
   requirement: !ruby/object:Gem::Requirement
@@ -128,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: ActionCableClient-2.0.0
+summary: ActionCableClient-2.0.1
 test_files: []
-has_rdoc: