NETRAVE/lib/Gemfile

# frozen_string_literal: true

source "https://rubygems.org"

# gem "rails"

gem "curses", "~> 1.4"
gem 'console'

gem "rubocop", "~> 1.52"

gem "solargraph", "~> 0.49.0"

gem "sequel", "~> 5.69"

gem "mysql2", "~> 0.5.5"

gem "yaml", "~> 0.2.1"

gem "gtk3", "~> 4.1"

gem "reek", "~> 6.1"
Add files via upload Signed-off-by: VetheonGames <76892542+VetheonGames@users.noreply.github.com> 2023-06-03 10:25:27 -06:00			`# frozen_string_literal: true`

			`source "https://rubygems.org"`

			`# gem "rails"`

			`gem "curses", "~> 1.4"`
			`gem 'console'`
Add Rubocop 2023-06-03 10:35:25 -06:00
			`gem "rubocop", "~> 1.52"`
Create First Run TUI skeleton 2023-06-03 12:35:00 -06:00
			`gem "solargraph", "~> 0.49.0"`
Enhance First Run Setup and User Interaction 1. Added a method to ask for the default mode (TUI, GUI, or WebApp) during the first run setup. 2. Implemented a method to validate the input mode. 3. Improved the database connection test method to handle exceptions and return a boolean value. 4. Added a method to ask for database details (username, password, and database name). 5. Enhanced the user interface by adding Curses.clear before each question to make the interface cleaner. 6. Improved the password input process by disabling echo to hide the input from the screen. 7. Added validation for uplink and downlink speeds. 8. Added a method to ask for services the system should be aware of. 2023-06-03 13:38:30 -06:00
			`gem "sequel", "~> 5.69"`

			`gem "mysql2", "~> 0.5.5"`
Refactoring for Modularity, Code Reuse, and Security Considerations In this commit, we have undertaken a significant refactoring of the codebase to improve modularity, promote code reuse, and consider security aspects. Modularity and Code Reuse: We introduced classes and modules to better organize the code and facilitate code reuse. Specifically, we created a new Utilities module to hold common methods that are used across different parts of the application. This module includes methods such as convert_speed_to_mbps, services_to_hash, and calculate_total_bandwidth. By placing these methods in a module, we can include this module in any class that needs these methods, thereby promoting code reuse and reducing duplication. We also created two new classes, SystemInformationGather and DatabaseManager. The SystemInformationGather class is responsible for gathering system information, such as uplink and downlink speed, and services. The DatabaseManager class handles database operations, including testing the database connection, creating the system information table, and storing system information in the database. By encapsulating these responsibilities within their respective classes, we have made the code more organized and easier to maintain. Database Connection Details: We made a decision to store the database connection details in a config file (config.yml) instead of the database itself. This decision was made for security reasons, as storing these details in the database could expose them to potential security risks. Storing these details in a config file allows us to better control access to these details. Database Encryption: We discussed the possibility of encrypting the database for additional security. While we have not implemented this feature in this commit, we have laid the groundwork for it by discussing potential libraries/gems that could be used for this purpose. This is an area that we will revisit in the future. System Information Gathering: We wrote methods to gather system information, such as uplink and downlink speed, and services, and store this information in the database. This information will be useful for monitoring system performance and for making decisions about resource allocation. This refactoring effort has made the codebase more organized, easier to maintain, and more secure. It also aligns with our project goals and roadmap. However, it's important to note that with any refactoring effort, there may be potential issues or trade-offs. We will need to thoroughly test the refactored code to ensure that it works as expected and that there are no unintended side effects. 2023-06-04 14:41:12 -06:00
			`gem "yaml", "~> 0.2.1"`
Enhancing User Experience by Streamlining Database Connection Setup In this commit, we have made significant improvements to the user experience of the NETRAVE project by streamlining the process of setting up the database connection. This was achieved by modifying the first_run_setup method in the FirstRunInit class to intelligently handle the presence or absence of a configuration file (config.yml). The key changes include: Checking for the existence of config.yml: Before prompting the user for database details, the program now checks if a config.yml file already exists. This file holds the necessary details for connecting to the database. Reading and using existing configuration: If a config.yml file is found, the program attempts to connect to the database using the details from the file. This eliminates the need for the user to re-enter database details every time the program runs, thereby improving the user experience. Handling unsuccessful connections: If the connection attempt using the details from config.yml is unsuccessful, the program prompts the user for new database details. These new details are then used to overwrite the existing config.yml file. This ensures that the program can recover from changes in the database setup, such as a change in password. Creating config.yml if it does not exist: If no config.yml file is found, the program creates one and then prompts the user for the database details. This makes the initial setup process smoother for new users. These changes have several benefits: Improved User Experience: By avoiding unnecessary prompts for database details, the program becomes more user-friendly. Efficient Onboarding: The streamlined process makes onboarding new users more efficient. Cost Savings: By reducing the number of requests for help with database details, we can potentially save on support staff time. Employee Satisfaction: Improving user experience can lead to greater employee satisfaction and advocacy for the product. Ethical Considerations: These changes respect the rights of the users by giving them control over their personal data and ensuring transparency in how their data is handled. This commit represents a significant step forward in making the NETRAVE project more user-friendly and efficient. We believe these changes will improve the usage and adoption of the product while also respecting the rights of the users. 2023-06-07 13:16:49 -06:00
			`gem "gtk3", "~> 4.1"`

			`gem "reek", "~> 6.1"`