class Ably::Models::MessageEncoders::Base

Base interface for an Ably Encoder

Attributes

client[R]
options[R]

Public Class Methods

new(client, options = {}) click to toggle source
# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 20
def initialize(client, options = {})
  @client = client
  @options = options
end

Public Instance Methods

add_encoding_to_message(encoding, message) click to toggle source

Add encoding to the message Hash. Ensures that encoding delimeter is used where required i.e utf-8/cipher+aes-128-cbc/base64

@param [Hash] message the message as a Hash object received directly from Ably. @param [String] encoding encoding to add to the current encoding

@return [void]

# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 65
def add_encoding_to_message(encoding, message)
  message[:encoding] = [message[:encoding], encoding].compact.join('/')
end
current_encoding_part(message) click to toggle source

Returns the right most encoding form a meessage encoding, and nil if none exists i.e. current_encoding_part(‘utf-8/cipher+aes-128-cbc/base64’) => ‘base64’

@return [String,nil]

# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 74
def current_encoding_part(message)
  if message[:encoding]
    message[:encoding].split('/')[-1]
  end
end
decode(message, channel_options) click to toggle source

decode is called once for every encoding step i.e. if message encoding arrives with ‘utf-8/cipher+aes-128-cbc/base64’

the decoder will call #decode once for each encoding part such as 'base64', then 'cipher+aes-128-cbc', and finally 'utf-8'

It is the responsibility of the decode method to detect the current encoding part and modify the :data & :encoding properties of the message object.

@param [Hash] message the message as a Hash object received directly from Ably.

The message contains properties :name, :data, :encoding, :timestamp, and optionally :id and :client_id.
This #encode method should modify the message Hash if any decoding action is to be taken

@param [Hash] channel_options the options used to initialize the channel that this message was received on

@return [void]

# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 53
def decode(message, channel_options)
  raise "Not yet implemented"
end
encode(message, channel_options) click to toggle source

encode is called once before a message is sent to Ably

It is the responsibility of the encode method to detect the intended encoding and modify the :data & :encoding properties of the message object.

@param [Hash] message the message as a Hash object received directly from Ably.

The message contains properties :name, :data, :encoding, :timestamp, and optionally :id and :client_id.
This #encode method should modify the message Hash if any encoding action is to be taken

@param [Hash] channel_options the options used to initialize the channel that this message was received on

@return [void]

# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 36
def encode(message, channel_options)
  raise "Not yet implemented"
end
is_empty?(message) click to toggle source

True of the message data payload is empty

@param [Hash] message the message as a Hash object received directly from Ably.

@return [Boolean]

# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 101
def is_empty?(message)
  message[:data].nil? || message[:data] == ''
end
strip_current_encoding_part(message) click to toggle source

Strip the current encoding part within the message Hash.

For example, calling this method on an :encoding value of ‘utf-8/cipher+aes-128-cbc/base64’ would update the attribute :encoding to ‘utf-8/cipher+aes-128-cbc’

@param [Hash] message the message as a Hash object received directly from Ably.

@return [void]

# File lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb, line 89
def strip_current_encoding_part(message)
  raise "Cannot strip encoding when there is no encoding for this message" unless message[:encoding]
  message[:encoding] = message[:encoding].split('/')[0...-1].join('/')
  message[:encoding] = nil if message[:encoding].empty?
end