minor changes regarding comments in data_models

Author: peiyush13

lib/data_models.rb

@@ -1,9 +1,9 @@
 require 'websocket-eventmachine-client'
 require 'json'
 
-require_relative './data_models'
 require_relative './socketclusterclient/emitter'
 require_relative './socketclusterclient/parser'
+require_relative './socketclusterclient/data_models'
 
 #
 # Class ScClient provides an interface to connect to the socketcluster server

lib/sc_client.rb

@@ -0,0 +1,120 @@
+require 'ostruct'
+
+# Module DataModels provides JSON format based serialized and deserialized
+# objects that ensures tight coupling
+# @author Piyush Wani <[email protected]>
+#
+module DataModels
+  # Returns a data model for an acknowledgment event
+  #
+  # @param [String] error An acknowledgment event
+  # @param [String] data A data object
+  # @param [Integer] cid A remote counter id
+  #
+  # @return [Hash] An acknowledgement object
+  #
+  def get_ack_object(error, data, cid)
+    OpenStruct.new(
+      cid: cid,
+      data: data,
+      error: error
+    ).to_h
+  end
+
+  # Returns data model for an emitter event
+  #
+  # @param [String] event An emit event
+  # @param [Hash] object The data to be sent
+  #
+  # @return [Hash] An emit object
+  #
+  def get_emit_object(event, object)
+    OpenStruct.new(
+      event: event,
+      data: object
+    ).to_h
+  end
+
+  # Returns data model for emitter acknowledgment event
+  #
+  # @param [String] event An emitter acknowledgment event
+  # @param [Hash] object The data to be sent
+  # @param [Integer] counter A counter
+  #
+  # @return [Hash] An emitter acknowledgment object
+  #
+  def get_emit_ack_object(event, object, counter)
+    OpenStruct.new(
+      event: event,
+      data: object,
+      c_id: counter
+    ).to_h
+  end
+
+  # Returns data model for handshake event
+  #
+  # @param [Integer] counter A counter for event
+  #
+  # @return [Hash] A handshake object
+  #
+  def get_handshake_object(counter)
+    OpenStruct.new(
+      cid: counter,
+      data: OpenStruct.new(
+        authToken: @auth_token
+      ).to_h,
+      event: '#handshake'
+    ).to_h
+  end
+
+  # Returns data model for publish and publish with acknowledgment event
+  #
+  # @param [String] channel A channel where data should be published
+  # @param [String] data The data to be published
+  # @param [Integer] counter A counter for event
+  #
+  # @return [Hash] A publisher object
+  #
+  def get_publisher_object(channel, data, counter)
+    OpenStruct.new(
+      cid: counter,
+      data: OpenStruct.new(
+        channel: channel,
+        data: data
+      ).to_h,
+      event: '#publish'
+    ).to_h
+  end
+
+  # Returns data model for subscribe and subscribe with acknowledgment event
+  #
+  # @param [String] channel A channel to subscribe
+  # @param [Integer] counter A counter for event
+  #
+  # @return [Hash] A subscribe object
+  #
+  def get_subscribe_object(channel, counter)
+    OpenStruct.new(
+      event: '#subscribe',
+      data: OpenStruct.new(
+        channel: channel
+      ).to_h,
+      cid: counter
+    ).to_h
+  end
+
+  # Returns data model for unsubscribe and unsubscribe with acknowledgment event
+  #
+  # @param [String] channel A channel to unsubscribe
+  # @param [Integer] counter A counter for event
+  #
+  # @return [Hash] A unsubscribe object
+  #
+  def get_unsubscribe_object(channel, counter)
+    OpenStruct.new(
+      event: '#unsubscribe',
+      data: channel,
+      cid: counter
+    ).to_h
+  end
+end