socketclusterclient 0.1.0

data/lib/socketclusterclient.rb

@@ -0,0 +1,11 @@
+require 'socketclusterclient/version'
+
+require_relative './sc_client'
+
+#
+# Module SocketclusterClient provides an interface for Socketcluster Client
+#
+# @author Maanav Shah <shahmaanav07@gmail.com>
+#
+module Socketclusterclient
+end

data/lib/socketclusterclient/data_models.rb

@@ -0,0 +1,120 @@
+require 'ostruct'
+
+# Module DataModels provides JSON format based serialized and deserialized
+# objects that ensures tight coupling
+# @author Piyush Wani <piyushwww13@gmail.com>
+#
+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 An acknowledgement object
+  #
+  def get_ack_object(error, data, cid)
+    OpenStruct.new(
+      cid: cid,
+      data: data,
+      error: error
+    ).to_h
+  end
+
+  # Returns a data model for an emitter event
+  #
+  # @param [String] event An emit event
+  # @param [Hash] object A data object
+  #
+  # @return An emit object
+  #
+  def get_emit_object(event, object)
+    OpenStruct.new(
+      event: event,
+      data: object
+    ).to_h
+  end
+
+  # Returns a data model for an emitter acknowledgment event
+  #
+  # @param [String] event An emitter acknowledgment event
+  # @param [Hash] object A data object
+  # @param [Integer] counter A counter for a particular event
+  #
+  # @return 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 a data model for a handshake event
+  #
+  # @param [Integer] counter A counter for a particular event
+  #
+  # @return 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 a data model for publish and publish with acknowledgment event
+  #
+  # @param [String] channel A channel for publishing data
+  # @param [String] data A data object
+  # @param [Integer] counter A counter for a particular event
+  #
+  # @return A publish object
+  #
+  def get_publish_object(channel, data, counter)
+    OpenStruct.new(
+      cid: counter,
+      data: OpenStruct.new(
+        channel: channel,
+        data: data
+      ).to_h,
+      event: '#publish'
+    ).to_h
+  end
+
+  # Returns a data model for subscribe and subscribe with acknowledgment event
+  #
+  # @param [String] channel A channel to subscribe
+  # @param [Integer] counter A counter for a particular event
+  #
+  # @return 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 a data model for unsubscribe and unsubscribe with acknowledgment event
+  #
+  # @param [String] channel A channel to unsubscribe
+  # @param [Integer] counter A counter for a particular event
+  #
+  # @return An unsubscribe object
+  #
+  def get_unsubscribe_object(channel, counter)
+    OpenStruct.new(
+      event: '#unsubscribe',
+      data: channel,
+      cid: counter
+    ).to_h
+  end
+end

data/lib/socketclusterclient/emitter.rb

@@ -0,0 +1,91 @@
+#
+# Module Emitter provides interface to execute events and acknowledgments
+#
+# @author Maanav Shah <shahmaanav07@gmail.com>
+#
+module Emitter
+  #
+  # Initiarizes events and acks in emitter
+  #
+  #
+  #
+  #
+  def initialize_emitter
+    @events = {}
+    @events_ack = {}
+  end
+
+  #
+  # Adds a handler for a particular event
+  #
+  # @param [String] key An index to insert handler in events
+  # @param [Lambda] function A block to execute on event
+  #
+  #
+  #
+  def on(key, function)
+    @events[key] = function
+  end
+
+  #
+  # Adds a handler for a particular channel event
+  #
+  # @param [String] key An index to insert handler in events
+  # @param [Lambda] function A block to execute on event
+  #
+  #
+  #
+  def onchannel(key, function)
+    @events[key] = function
+  end
+
+  #
+  # Adds an acknowledgment handler for a particular event
+  #
+  # @param [String] key An index to insert handler in acknowledgment
+  # @param [Lambda] function An acknowledgment block to execute on event
+  #
+  #
+  #
+  def onack(key, function)
+    @events_ack[key] = function
+  end
+
+  #
+  # Executes a handler for a particular event
+  #
+  # @param [String] key An index to insert handler in events
+  # @param [Hash] object Data received from ScServer
+  #
+  #
+  #
+  def execute(key, object)
+    function = @events[key] if @events.key?(key)
+    function.call(key, object) if function
+  end
+
+  #
+  # Checks acknowledgment for an event
+  #
+  # @param [String] key An index to retrieve handler from events
+  #
+  #
+  #
+  def haseventack(key)
+    @events_ack[key]
+  end
+
+  #
+  # Executes a handler and an acknowledgment for a particular event
+  #
+  # @param [String] key An index to retrieve handler from events
+  # @param [Hash] object Data received from ScServer
+  # @param [Lambda] ack A block to execute as acknowledgment
+  #
+  #
+  #
+  def executeack(key, object, ack)
+    function = @events_ack[key] if @events_ack.key?(key)
+    function.call(key, object, ack) if function
+  end
+end

data/lib/socketclusterclient/log.rb

@@ -0,0 +1,47 @@
+#
+# Module Logger provides an interface to log events
+#
+# @author Maanav Shah <shahmaanav07@gmail.com>
+#
+module Log
+  #
+  # Initializes logger instance and sets logger level
+  #
+  #
+  #
+  #
+  def initialize_logger
+    @logger = Logger.new(STDOUT)
+  end
+
+  #
+  # Method to get the logger instance
+  #
+  #
+  # @return [Logger] An instance of logger
+  #
+  def logger
+    initialize_logger unless @logger
+    @logger
+  end
+
+  #
+  # Method to disable logging
+  #
+  #
+  #
+  #
+  def disable_logging
+    @logger = nil
+  end
+
+  #
+  # Method to enable logging
+  #
+  #
+  #
+  #
+  def enable_logging
+    initialize_logger
+  end
+end

data/lib/socketclusterclient/parser.rb

@@ -0,0 +1,39 @@
+#
+# Module Parser returns the event to be executed
+#
+# @author Maanav Shah <shahmaanav07@gmail.com>
+#
+module Parser
+  CHECK_AUTHENTICATION  = 1
+  PUBLISH               = 2
+  REMOVE_AUTHENTICATION = 3
+  SET_AUTHENTICATION    = 4
+  EVENT                 = 5
+  ACKNOWLEDGEMENT       = 6
+
+  #
+  # Provides a handler for a particular event
+  #
+  # @param [String] event An event to execute
+  # @param [Integer] rid An id received from ScServer
+  #
+  # @return [Enum] Result of parsing event and rid
+  #
+  def self.parse(event, rid)
+    if event.to_s != ''
+      if event == '#publish'
+        PUBLISH
+      elsif event == '#removeAuthToken'
+        REMOVE_AUTHENTICATION
+      elsif event == '#setAuthToken'
+        SET_AUTHENTICATION
+      else
+        EVENT
+      end
+    elsif rid == 1
+      CHECK_AUTHENTICATION
+    else
+      ACKNOWLEDGEMENT
+    end
+  end
+end

data/lib/socketclusterclient/reconnect.rb

@@ -0,0 +1,47 @@
+#
+# Module Reconnect provides Reconnection Support
+#
+# @author Piyush Wani <piyushwww13@gmail.com>
+#
+module Reconnect
+  #
+  # Initializes Reconnection related entities
+  #
+  #
+  #
+  #
+  def initialize_reconnect
+    @reconnect_interval = 2000
+    @max_reconnect_interval = 30_000
+    @max_attempts = nil # unlimited reconnection attempt
+    @attempts_made = 0
+  end
+
+  #
+  # Adds a handler for Reconnection
+  #
+  # @param [Integer] reconnect_interval A interval for reconnection attempt( in milliseconds  )
+  # @param [Integer] max_reconnect_interval A max Limit for reconnection interval (in milliseconds)
+  # @param [Integer] max_attempts A max number of Reconnection Attempts allowed
+  #
+  #
+  #
+  def set_reconnection_listener(reconnect_interval, max_reconnect_interval, max_attempts = @max_attempts)
+    @reconnect_interval = reconnect_interval > max_reconnect_interval ? max_reconnect_interval : reconnect_interval
+    @max_reconnect_interval = max_reconnect_interval
+    @max_attempts = max_attempts
+    @attempts_made = 0
+  end
+
+  private
+
+  #
+  # Check for reconnection to server
+  #
+  #
+  # @return [Boolean] Allow reconnection
+  #
+  def should_reconnect
+    @enable_reconnection && (@max_attempts.nil? || (@attempts_made < @max_attempts))
+  end
+end

data/lib/socketclusterclient/version.rb

@@ -0,0 +1,3 @@
+module Socketclusterclient
+  VERSION = '0.1.0'
+end

data/socketclusterclient.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'socketclusterclient/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'socketclusterclient'
+  spec.version     = Socketclusterclient::VERSION
+  spec.authors     = ['Maanav Shah', 'Piyush Wani', 'Sachin Shinde']
+  spec.email       = %w[shahmaanav07@gmail.com piyushwww13@gmail.com sachinshinde7676@gmail.com]
+
+  spec.platform    = Gem::Platform::RUBY
+  spec.licenses    = ['MIT']
+
+  spec.summary     = 'Ruby client for socketcluster'
+  spec.description = 'A socketcluster client designed in ruby'
+  spec.homepage    = 'https://socketcluster.io/'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency('bundler', '~> 1.16')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency('rspec', '~> 3.0')
+  spec.add_development_dependency('simplecov', '~> 0.16')
+  spec.add_dependency('websocket-eventmachine-client', '~> 1.2')
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: socketclusterclient
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maanav Shah
+- Piyush Wani
+- Sachin Shinde
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A socketcluster client designed in ruby
+email:
+- shahmaanav07@gmail.com
+- piyushwww13@gmail.com
+- sachinshinde7676@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/authentication.rb
+- examples/channel.rb
+- examples/emitter.rb
+- examples/receiver.rb
+- examples/reconnection.rb
+- examples/ssl_connect.rb
+- lib/sc_client.rb
+- lib/socketclusterclient.rb
+- lib/socketclusterclient/data_models.rb
+- lib/socketclusterclient/emitter.rb
+- lib/socketclusterclient/log.rb
+- lib/socketclusterclient/parser.rb
+- lib/socketclusterclient/reconnect.rb
+- lib/socketclusterclient/version.rb
+- socketclusterclient.gemspec
+homepage: https://socketcluster.io/
+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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Ruby client for socketcluster
+test_files: []