action_cable_client 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5764cc7e98e88de5996d3ea6e32633b72aa97e15
+  data.tar.gz: 99d9baa73bed7eb3b7288021e38ce01494bef4f7
+SHA512:
+  metadata.gz: 5dea9401dfe69bcab3d7da3c20576ef1beca22517fdd8c4b4afbf920279ecab7a6f2f55cccf48d1f90b6c6814b65173759c1e7a0aad54c6512909508a7429f01
+  data.tar.gz: a4defa4899914dbcb0c55cb331585d382b19e63eb62dbec73d6b8b611bda04118dc79c28da9e2d5bb100dcea139591c889bd998e6395b2dc372f02d6203fe612

data/CHANGELOG.md

@@ -0,0 +1 @@
+* Initial Work 

data/README.md

@@ -0,0 +1,41 @@
+# 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)
+
+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.
+
+## Usage
+
+```ruby
+require 'action_cable_client'
+
+EventMachine.run do
+
+  uri = "ws://localhost:3000/cable/"
+  client = ActionCableClient.new(uri, 'RoomChannel')
+  # the connected callback is required, as it triggers
+  # the actual subscribing to the channel but it can just be
+  # client.connected {}
+  client.connected { puts 'successfully connected.' }
+
+  # called whenever a message is received from the server
+  client.received do | message |
+    puts message
+  end
+
+  # adds to a queue that is purged upon receiving of
+  # a ping from the server
+  client.perform('speak', { message: 'hello from amc' })
+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 }`

data/lib/action_cable_client.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+# required gems
+require 'em-websocket-client'
+require 'forwardable'
+require 'active_support/core_ext/string'
+require 'json'
+
+# local files
+require 'action_cable_client/message_factory'
+require 'action_cable_client/message'
+
+class ActionCableClient
+  extend Forwardable
+
+  class Commands
+    SUBSCRIBE = 'subscribe'
+    MESSAGE = 'message'
+  end
+
+  attr_reader :_websocket_client, :_uri, :_channel_name
+  attr_reader :_message_factory
+  # The queue should store entries in the format:
+  # [ action, data ]
+  attr_accessor :message_queue, :subscribed
+
+  alias_method :subscribed?, :subscribed
+
+  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
+  # @param [String] channel - the name of the channel on the Rails server
+  #                           e.g.: RoomChannel
+  def initialize(uri, channel = '')
+    @_channel_name = channel
+    @_uri = uri
+    @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)
+  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)
+    message_queue.push([action, data])
+  end
+
+  # 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)
+    _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
+        yield(json)
+      end
+      deplete_queue if subscribed?
+    end
+  end
+
+  # callback when the client connects to the server
+  #
+  # @example
+  #   client = ActionCableClient.new(uri, 'RoomChannel')
+  #   client.connected do
+  #     # do things after the client is connected to the server
+  #   end
+  def connected
+    _websocket_client.callback do
+      subscribe
+      yield
+    end
+  end
+
+  private
+
+  # {"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
+  end
+
+  # {"identifier" => "_ping","message" => 1460201942}
+  # {"identifier" => "_ping","type" => "confirm_subscription"}
+  def is_ping?(message)
+    message_identifier = message[Message::IDENTIFIER_KEY]
+    Message::IDENTIFIER_PING == message_identifier
+  end
+
+  def subscribe
+    msg = _message_factory.create(Commands::SUBSCRIBE)
+    _websocket_client.send_msg(msg.to_json)
+  end
+
+  def deplete_queue
+    while (message_queue.size > 0)
+      action, data = message_queue.pop
+      msg = _message_factory.create(Commands::MESSAGE, action, data)
+      send_msg(msg.to_json)
+    end
+  end
+end

data/lib/action_cable_client/message.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+class ActionCableClient
+  class Message
+    IDENTIFIER_KEY = 'identifier'.freeze
+    IDENTIFIER_PING = '_ping'.freeze
+    # 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
+
+
+    attr_reader :_command, :_identifier, :_data
+
+    # @param [String] command - the type of message that this is
+    # @param [Hash] identifier - the channel we are subscribed to
+    # @param [Hash] data - the data to be sent in this message
+    def initialize(command, identifier, data)
+      @_command = command
+      @_identifier = identifier
+      @_data = data
+    end
+
+    def to_json
+      hash = {
+        command: _command,
+        identifier: _identifier.to_json
+      }
+
+      hash[:data] = _data.to_json if _data.present?
+
+      hash.to_json
+    end
+  end
+end

data/lib/action_cable_client/message_factory.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+class ActionCableClient
+  class MessageFactory
+    attr_reader :_channel
+
+    # @param [String] channel - the name of the subscribed channel
+    def initialize(channel)
+      @_channel = channel
+    end
+
+    # @param [String] command - the type of message that this is
+    # @param [String] action - the action that is performed to send this message
+    # @param [Hash] message - the data to send
+    def create(command, action = '', message = nil)
+      data = build_data(action, message)
+      Message.new(command, identifier, data)
+    end
+
+    # @param [String] action - the action that is performed to send this message
+    # @param [Hash] message - the data to send
+    # @return [Hash] The data that will be included in the message
+    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

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: action_cable_client
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- L. Preston Sego III
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby client for interacting with Rails' ActionCable
+email: LPSego3+dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/action_cable_client.rb
+- lib/action_cable_client/message.rb
+- lib/action_cable_client/message_factory.rb
+- lib/action_cable_client/version.rb
+homepage: https://github.com/NullVoxPopuli/action_cable_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ActionCableClient-1.0
+test_files: []