javonet-ruby-sdk 2.6.4 → 2.6.6

data/lib/javonet-ruby-sdk/sdk/javonet.rb

@@ -1,106 +1,106 @@
-require_relative './runtime_factory'
-require_relative './config_runtime_factory'
-require_relative './../utils/connection_type'
-require_relative './../utils/runtime_logger'
-require_relative './../core/transmitter/transmitter'
-require_relative './tools/sdk_message_helper'
-require 'fileutils'
-
-# The Javonet class is a singleton class that serves as the entry point for interacting with Javonet.
-# It provides methods to activate and initialize the Javonet SDK.
-# It supports both in-memory and TCP connections.
-# @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/javonet-static-class article on Javonet Guides}
-class Javonet
-
-  SdkMessageHelper.send_message_to_app_insights("SdkMessage", "Javonet SDK initialized")
-
-  # Initializes Javonet using an in-memory channel on the same machine.
-  # @return [RuntimeFactory] A RuntimeFactory instance configured for an in-memory connection.
-  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/in-memory-channel article on Javonet Guides}
-  def self.in_memory
-    RuntimeFactory.new(ConnectionType::IN_MEMORY, nil)
-  end
-
-  # Initializes Javonet with a TCP connection to a remote machine.
-  # @param address [TcpConnectionData] The address of the remote machine.
-  # @return [RuntimeFactory] A RuntimeFactory instance configured for a TCP connection.
-  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/tcp-channel article on Javonet Guides}
-  def self.tcp(tcp_connection_data)
-    RuntimeFactory.new(ConnectionType::TCP, tcp_connection_data)
-  end
-
-  # Initializes Javonet with a WebSocket connection to a remote machine.
-  # @param ws_connection_data [WsConnectionData] The address of the remote machine.
-  # @return [RuntimeFactory] A RuntimeFactory instance configured for a WebSocket connection.
-  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/websocket-channel article on Javonet Guides}
-  def self.web_socket(ws_connection_data)
-    RuntimeFactory.new(ConnectionType::WEB_SOCKET, ws_connection_data)
-  end
-
-  # Initializes Javonet with a custom configuration file.
-  # @param path [String] Path to a configuration file.
-  # @return [ConfigRuntimeFactory] A ConfigRuntimeFactory instance configured with configuration data
-  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/configure-channel article on Javonet Guides}
-  def self.with_config(path)
-    begin
-      ConfigRuntimeFactory.new(path)
-    rescue Exception => e
-      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
-      raise e
-    end
-
-  end
-
-  # Activates Javonet with the provided license key and optionally with proxy data.
-  # @param license_key [String] The license key to activate Javonet.
-  # @return [Integer] The activation status code.
-  # @see https://www.javonet.com/guides/v2/ruby/getting-started/activating-javonet Activating Javonet Guide
-  def self.activate(license_key)
-    begin
-      if license_key != ActivationHelper.temporary_license_key
-        ActivationHelper.temporary_license_key = license_key
-        SdkMessageHelper.send_message_to_app_insights("SdkMessage", "Activation")
-      end
-
-      ActivationHelper.temporary_license_key = license_key
-      return Transmitter.activate(license_key)
-    rescue Exception => e
-      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
-      raise e
-    end
-  end
-
-  # Sets the configuration source for the Javonet SDK.
-  # @param config_source [String] The configuration source.
-  def self.set_config_source(config_source)
-    begin
-      Transmitter.set_config_source(config_source)
-    rescue Exception => e
-      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
-      raise e
-    end
-  end
-
-  # Sets the working directory for the Javonet SDK.
-  # @param path [String] The working directory path.
-  def self.set_javonet_working_directory(path)
-    begin
-      path.gsub!("\\", "/")
-      path += "/" unless path.end_with?("/")
-      FileUtils.mkdir_p(path, mode: 0700)
-      ActivationHelper.working_directory = path
-      Transmitter.set_javonet_working_directory(path)
-    rescue Exception => e
-      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
-      raise e
-    end
-  end
-
-  # Gets information about the current runtime.
-  # @param get_loaded_modules [Boolean] Whether to include loaded modules in the runtime information.
-  # @return [String] Information about the current runtime.
-  def self.get_runtime_info(get_loaded_modules)
-    RuntimeLogger.get_runtime_info(get_loaded_modules)
-  end
-
-end
+require_relative './runtime_factory'
+require_relative './config_runtime_factory'
+require_relative './../utils/connection_type'
+require_relative './../utils/runtime_logger'
+require_relative './../core/transmitter/transmitter'
+require_relative './tools/sdk_message_helper'
+require 'fileutils'
+
+# The Javonet class is a singleton class that serves as the entry point for interacting with Javonet.
+# It provides methods to activate and initialize the Javonet SDK.
+# It supports both in-memory and TCP connections.
+# @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/javonet-static-class article on Javonet Guides}
+class Javonet
+
+  SdkMessageHelper.send_message_to_app_insights("SdkMessage", "Javonet SDK initialized")
+
+  # Initializes Javonet using an in-memory channel on the same machine.
+  # @return [RuntimeFactory] A RuntimeFactory instance configured for an in-memory connection.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/in-memory-channel article on Javonet Guides}
+  def self.in_memory
+    RuntimeFactory.new(ConnectionType::IN_MEMORY, nil)
+  end
+
+  # Initializes Javonet with a TCP connection to a remote machine.
+  # @param address [TcpConnectionData] The address of the remote machine.
+  # @return [RuntimeFactory] A RuntimeFactory instance configured for a TCP connection.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/tcp-channel article on Javonet Guides}
+  def self.tcp(tcp_connection_data)
+    RuntimeFactory.new(ConnectionType::TCP, tcp_connection_data)
+  end
+
+  # Initializes Javonet with a WebSocket connection to a remote machine.
+  # @param ws_connection_data [WsConnectionData] The address of the remote machine.
+  # @return [RuntimeFactory] A RuntimeFactory instance configured for a WebSocket connection.
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/websocket-channel article on Javonet Guides}
+  def self.web_socket(ws_connection_data)
+    RuntimeFactory.new(ConnectionType::WEB_SOCKET, ws_connection_data)
+  end
+
+  # Initializes Javonet with a custom configuration file.
+  # @param path [String] Path to a configuration file.
+  # @return [ConfigRuntimeFactory] A ConfigRuntimeFactory instance configured with configuration data
+  # @see Refer to this {https://www.javonet.com/guides/v2/ruby/foundations/configure-channel article on Javonet Guides}
+  def self.with_config(path)
+    begin
+      ConfigRuntimeFactory.new(path)
+    rescue Exception => e
+      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
+      raise e
+    end
+
+  end
+
+  # Activates Javonet with the provided license key and optionally with proxy data.
+  # @param license_key [String] The license key to activate Javonet.
+  # @return [Integer] The activation status code.
+  # @see https://www.javonet.com/guides/v2/ruby/getting-started/activating-javonet Activating Javonet Guide
+  def self.activate(license_key)
+    begin
+      if license_key != ActivationHelper.temporary_license_key
+        ActivationHelper.temporary_license_key = license_key
+        SdkMessageHelper.send_message_to_app_insights("SdkMessage", "Activation")
+      end
+
+      ActivationHelper.temporary_license_key = license_key
+      return Transmitter.activate(license_key)
+    rescue Exception => e
+      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
+      raise e
+    end
+  end
+
+  # Sets the configuration source for the Javonet SDK.
+  # @param config_source [String] The configuration source.
+  def self.set_config_source(config_source)
+    begin
+      Transmitter.set_config_source(config_source)
+    rescue Exception => e
+      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
+      raise e
+    end
+  end
+
+  # Sets the working directory for the Javonet SDK.
+  # @param path [String] The working directory path.
+  def self.set_javonet_working_directory(path)
+    begin
+      path.gsub!("\\", "/")
+      path += "/" unless path.end_with?("/")
+      FileUtils.mkdir_p(path, mode: 0700)
+      ActivationHelper.working_directory = path
+      Transmitter.set_javonet_working_directory(path)
+    rescue Exception => e
+      SdkMessageHelper.send_message_to_app_insights("SdkException", e.message)
+      raise e
+    end
+  end
+
+  # Gets information about the current runtime.
+  # @param get_loaded_modules [Boolean] Whether to include loaded modules in the runtime information.
+  # @return [String] Information about the current runtime.
+  def self.get_runtime_info(get_loaded_modules)
+    RuntimeLogger.get_runtime_info(get_loaded_modules)
+  end
+
+end