Unit Test cases RSpec and Licence Change and Logger Addition (#15)

* Change in Licence

Change repository licence MIT to OpenSocket

* Minor changes in library

change in reconnection instance method

* Add Specs

Add Specs for reconnection instance methods and SocketCluster Client instance methods

* Update README.md

Add Reconnection documentation in README.md

* Changes in ScClient Class and Reconnect module

Remove reconnect_decay from Reconnection handler
Fix Max attempts for reconnection when auto reconnection is enabled

* Add Logger

added logger methods and messages along with specs

* Update initial release, reconnection and logger

Updated the initial release version to 0.1.0, added ssl connection provision, added reconnection and logging

Author: maanavshah

CHANGELOG.md

@@ -1,5 +1,5 @@
 # Changelog
 
-## 1.0.0
+## 0.1.0
 
 - initial release

Gemfile

@@ -7,5 +7,5 @@ gemspec
 
 gem 'websocket-eventmachine-client'
 
-gem 'rspec', :require => false, :group => :test
-gem 'simplecov', :require => false, :group => :test
+gem 'rspec', require: false, group: :test
+gem 'simplecov', require: false, group: :test

Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    socketclusterclient (0.1.0)
+      websocket-eventmachine-client (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.1)
+    eventmachine (1.2.7)
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    websocket (1.2.8)
+    websocket-eventmachine-base (1.2.0)
+      eventmachine (~> 1.0)
+      websocket (~> 1.0)
+      websocket-native (~> 1.0)
+    websocket-eventmachine-client (1.2.0)
+      websocket-eventmachine-base (~> 1.0)
+    websocket-native (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec
+  simplecov
+  socketclusterclient!
+  websocket-eventmachine-client
+
+BUNDLED WITH
+   1.16.1

LICENSE

@@ -1,4 +1,4 @@
-MIT License
+OpenSocket License
 
 Copyright (c) 2018 Maanav Shah
 

README.md

@@ -85,7 +85,14 @@ Create instance of `Socket` class by passing url of socketcluster-server end-poi
     socket.connect
 ```
 
-- By default reconnection to server is enabled, so to configure delay for connection
+- By default reconnection to server is disabled, so to enable automatic reconnection
+
+```ruby
+    # This will set automatic-reconnection to socketcluster-server repeat it infinitely
+    socket.set_reconnection(true)
+```
+
+- To set delay of reconnecting to server
 
 ```ruby
     # This will set automatic-reconnection to socketcluster-server with delay of 2 seconds and repeat it infinitely
@@ -100,6 +107,37 @@ Create instance of `Socket` class by passing url of socketcluster-server end-poi
     socket.set_reconnection(false)
 ```
 
+- For reconnection to the server you need to set reconnection strategy
+
+```ruby
+    # This will set the reconnection strategy
+    socket.set_reconnection_listener(reconnect_interval, max_reconnect_interval, max_attempts)
+
+    # default reconnection strategy
+    socket.set_reconnection_listener(2000, 30_000, nil)
+```
+
+For example,
+```ruby
+    socket.set_reconnection_listener(3000, 30_000, 10)  # (reconnect_inverval, max_reconnect_interval, max_attempts)
+    socket.set_reconnection_listener(3000, 30_000)  # (reconnect_inverval, max_reconnect_interval)
+```
+
+- You can set reconnect_interval, max_reconnect_interval and max_attempts directly as well
+```ruby
+    socket.reconnect_interval = 2000
+    socket.max_reconnect_interval = 20_000
+    socket.max_attempts = 10
+```
+
+- To allow reconnection to server, you need to reconnect
+
+```ruby
+    # This will set automatic-reconnection to socketcluster-server with delay of 2 seconds and repeat it till the maximum attempts are finished
+    socket.connect
+```
+
+
 Emitting and listening to events
 --------------------------------
 
@@ -227,6 +265,30 @@ Implementing Pub-Sub via channels
     end
 ```
 
+Logger
+------
+
+#### Disabling logger
+
+- To get logger for logging of events
+
+```ruby
+    socket.logger.info("Some information")
+    socket.logger.warn("Some warning")
+```
+
+- To disable logging of events
+
+```ruby
+    socket.disable_logging
+```
+
+- To enable logging of events
+
+```ruby
+    socket.enable_logging
+```
+
 Development
 -----------
 

examples/reconnection.rb

@@ -18,6 +18,8 @@
 socket = ScClient.new('ws://localhost:8000/socketcluster/')
 socket.set_basic_listener(on_connect, on_disconnect, on_connect_error)
 socket.set_authentication_listener(on_set_authentication, on_authentication)
-socket.set_reconnection(false) # default reconnection is true
-socket.max_attempts = 5
-socket.reconnect
+socket.set_reconnection_listener(3000, 30_000) # (reconnect_inverval, max_reconnect_interval)
+socket.set_reconnection_listener(3000, 30_000, 10) # (reconnect_inverval, max_reconnect_interval, max_attempts)
+socket.set_reconnection(true) # to allow reconnection, default reconnection is disabled
+socket.max_attempts = 5 # set maximum attempts allowed
+socket.connect

examples/ssl_connect.rb

@@ -0,0 +1,12 @@
+require 'socketclusterclient'
+
+on_connect = -> { puts 'on connect got called' }
+
+on_disconnect = -> { puts 'on disconnect got called' }
+
+on_connect_error = -> { puts 'on connect error got called' }
+
+# connection to ssl server at websocket.org
+socket = ScClient.new('wss://echo.websocket.org/')
+socket.set_basic_listener(on_connect, on_disconnect, on_connect_error)
+socket.connect

lib/sc_client.rb

@@ -6,6 +6,7 @@
 require_relative './socketclusterclient/parser'
 require_relative './socketclusterclient/data_models'
 require_relative './socketclusterclient/reconnect'
+require_relative './socketclusterclient/log'
 
 #
 # Class ScClient provides an interface to connect to the socketcluster server
@@ -16,8 +17,9 @@ class ScClient
   include Emitter
   include DataModels
   include Reconnect
+  include Log
 
-  attr_accessor :reconnect_interval, :max_reconnect_interval, :reconnect_decay, :max_attempts, :attempts_made
+  attr_accessor :reconnect_interval, :max_reconnect_interval, :max_attempts
 
   #
   # Initializes instance variables in socketcluster client
@@ -30,12 +32,11 @@ def initialize(url)
     @url = url
     @acks = {}
     @channels = []
-    @enable_reconnection = true
+    @enable_reconnection = false
     @delay = 3
     initialize_emitter
     initialize_reconnect
-    @logger = Logger.new(STDOUT)
-    @logger.level = Logger::WARN
+    initialize_logger
   end
 
   #
@@ -112,7 +113,7 @@ def ack_block(cid)
   end
 
   #
-  # Connect to the ScServer
+  # Connects to the ScServer
   #
   #
   #
@@ -121,8 +122,16 @@ def connect
     EM.epoll
 
     EM.run do
-      trap('TERM') { stop }
-      trap('INT')  { stop }
+      trap('TERM') do
+        @enable_reconnection = false
+        disconnect
+      end
+
+      trap('INT') do
+        @enable_reconnection = false
+        disconnect
+      end
+
       @ws = WebSocket::EventMachine::Client.connect(uri: @url)
 
       @ws.onopen do
@@ -132,6 +141,7 @@ def connect
       end
 
       @ws.onmessage do |message, _type|
+        @logger.info("Message received : #{message}") if @logger
         if message == '#1'
           @ws.send('#2')
         else
@@ -176,9 +186,12 @@ def connect
       end
 
       @ws.onclose do
-        @on_disconnected.call if @on_disconnected
-        if @enable_reconnection
-          reconnect
+        if should_reconnect
+          @reconnect_interval = @max_reconnect_interval if @reconnect_interval > @max_reconnect_interval
+          sleep(@reconnect_interval / 1000)
+          @attempts_made += 1
+          @logger.info("Attempting to reconnect : #{@attempts_made}") if @logger
+          connect
         else
           stop
         end
@@ -219,6 +232,7 @@ def set_reconnection(enable)
   #
   #
   def disconnect
+    @on_disconnected.call if @on_disconnected
     @enable_reconnection = false
     @ws.close
   end
@@ -314,13 +328,13 @@ def publish(channel, data)
   end
 
   #
-  #  Publish data to the specified channel name
+  # Publish data to the specified channel name
   #
   # @param [String] channel A channel name
   # @param [String] data Data to be published on the channel
   # @param [Lambda] ack Block to execute on publish acknowledgment
   #
-  # @return [<type>] <description>
+  #
   #
   def publishack(channel, data, ack)
     @ws.send(get_publish_object(channel, data, increment_cnt).to_json)

lib/socketclusterclient/log.rb

@@ -0,0 +1,47 @@
+#
+# Module Logger provides an interface to log events
+#
+# @author Maanav Shah <[email protected]>
+#
+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