lanet 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fa5904938004f84fe7b8d599da632140a532925cd0a0c48d5986d44443c0987
-  data.tar.gz: f039a015dcd75704b7fe80f2a84afbd758505048e78bc86001b9821c1be7a353
+  metadata.gz: 72df8bd31304f1648109a036a7035f8cfb40ff478b1a46d8bed0252d306f4bd2
+  data.tar.gz: db6c6b0a46129375815d6f60d7374aa074b1439950bb99781ce4ff08a76f77ee
 SHA512:
-  metadata.gz: ac7892c9bd9179483ea9ebb796fb567a11f79aab6197b1c49a11d2797167e91c59be5da17e861a3e08069bc4ff745eae8534e8cdcda516739906a8011ab9ffc8
-  data.tar.gz: ef408dedc43f2461c69d0a00ae207f4bd139e06f171cb5cfd0fd6f40e58d2e0aa1bc59403428587f6982a378418ff241fecb1805254b37ea63d1a39ccc8116e3
+  metadata.gz: 3e12a7b08354fd83f239dda0ee40097e8c2b9bee826a4b1935036e91940adbae468d17b3f2a1d002159825edf1fd81a8eb37cec829ec2c9cb4fc334c79842e35
+  data.tar.gz: 61c354041de57ef4c017bdfc9ad2b6aac5f1162ef8e81e55c928aea89f99700d5638dc8761b0609ab6ca908c0877eeb2842876e4869634f70a60cea5c2ae77b6

data/CHANGELOG.md

@@ -5,6 +5,57 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2025-10-19
+
+### 🎉 Major Release - Architectural Improvements
+
+This is a major milestone release focused on code quality, maintainability, and architectural improvements while maintaining 100% backward compatibility.
+
+### Added
+- **Configuration Management**: New centralized `Config` class for managing all application constants and settings
+- **Transfer State Management**: New `TransferState` class for better file transfer state handling
+- **Enhanced Error Handling**: Custom exception classes (`SendError`, `ReceiveError`) with detailed context
+- **Resource Management**: Proper cleanup methods (`close`, `closed?`) for network resources
+- **Logging Infrastructure**: Centralized logger configuration via `Config.logger`
+- **Health Monitoring**: Added `healthy?` and `stats` methods to Mesh network for monitoring
+- **Documentation**: Comprehensive refactoring reports (`REFACTORING_REPORT.md`, `REFACTORING_SUMMARY.md`)
+
+### Changed
+- **Encryptor Refactoring**: Split monolithic methods into focused, single-purpose methods
+  - Reduced cyclomatic complexity from 12+ to 2-3 per method
+  - Extracted `prepare_plaintext`, `prepare_encrypted`, `prepare_signed_plaintext`, `prepare_signed_encrypted`
+  - Improved message type parsing with `MessageType` enumeration
+- **Sender Class**: Enhanced with input validation, error handling, and lifecycle management
+- **Receiver Class**: Added graceful shutdown, configurable buffer sizes, and proper cleanup
+- **FileTransfer**: Refactored using `TransferState` for cleaner state management
+  - Reduced complexity by extracting state logic
+  - Improved progress tracking and checksum verification
+- **Code Organization**: Better separation of concerns across all modules
+- **Constants Management**: Migrated all constants to centralized `Config` class
+
+### Improved
+- **Code Quality Metrics**:
+  - 60% reduction in average method length (from 20-30 lines to 5-10 lines)
+  - 75% reduction in cyclomatic complexity (critical components)
+  - Better error messages with context-specific exceptions
+- **Resource Management**: Eliminated resource leak risks with ensure blocks
+- **Test Coverage**: All 96 tests passing with maintained backward compatibility
+- **Memory Management**: Automatic cleanup of temporary files and network resources
+- **Error Recovery**: More robust failure handling throughout the codebase
+
+### Fixed
+- Resource leaks in socket handling (proper cleanup in all scenarios)
+- Potential memory issues in file transfer (proper temp file cleanup)
+- Port conflict detection and reporting (clearer error messages)
+
+### Technical Details
+For detailed information about the architectural improvements and refactoring:
+- See `REFACTORING_REPORT.md` for comprehensive analysis with metrics
+- See `REFACTORING_SUMMARY.md` for technical implementation details
+
+### Backward Compatibility
+✅ **100% Backward Compatible** - All public APIs remain unchanged. No migration needed.
+
 ## [0.5.1] - 2025-03-20
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lanet (0.5.1)
+    lanet (1.0.0)
       thor (~> 1.2)
 
 GEM

data/README.md

@@ -369,6 +369,8 @@ lanet traceroute --host github.com --protocol tcp --max-hops 20 --timeout 2 --qu
 
 You can also use Lanet programmatically in your Ruby applications:
 
+#### Basic Usage
+
 ```ruby
 require 'lanet'
 
@@ -377,6 +379,22 @@ scanner = Lanet.scanner
 active_ips = scanner.scan('192.168.1.0/24')
 puts "Found devices: #{active_ips.join(', ')}"
 
+# Send a message to a specific IP
+sender = Lanet.sender
+sender.send_to('192.168.1.5', 'Hello from Ruby!')
+sender.close  # Proper cleanup (new in v1.0.0)
+
+# Listen for incoming messages
+receiver = Lanet.receiver
+receiver.listen do |data, ip|
+  puts "Received from #{ip}: #{data}"
+end
+receiver.close  # Proper cleanup (new in v1.0.0)
+```
+
+#### Advanced Features
+
+```ruby
 # Scan with verbose option for detailed output
 detailed_hosts = scanner.scan('192.168.1.0/24', 1, 32, true)
 detailed_hosts.each do |host|
@@ -387,23 +405,19 @@ end
 # Customize scanning performance with timeout and thread count
 active_ips = scanner.scan('192.168.1.0/24', 0.5, 16)  # 0.5 second timeout, 16 threads
 
-# Send a message to a specific IP
-sender = Lanet.sender
-sender.send_to('192.168.1.5', 'Hello from Ruby!')
-
 # Broadcast a message to all devices
+sender = Lanet.sender
 sender.broadcast('Announcement to all devices!')
-
-# Listen for incoming messages
-receiver = Lanet.receiver
-receiver.listen do |data, ip|
-  puts "Received from #{ip}: #{data}"
-end
+sender.close
 
 # Work with encrypted messages
 encrypted = Lanet.encrypt('Secret message', 'my_encryption_key')
 decrypted = Lanet.decrypt(encrypted, 'my_encryption_key')
+```
+
+#### Network Monitoring
 
+```ruby
 # Ping a specific host
 pinger = Lanet.pinger
 result = pinger.ping_host('192.168.1.5')
@@ -418,11 +432,6 @@ result = pinger.ping_host('192.168.1.5', true) # true enables real-time output
 pinger = Lanet.pinger
 pinger.ping_host('192.168.1.5', true, true) # true, true enables real-time continuous output
 
-# Ping without real-time output (for programmatic use)
-result = pinger.ping_host('192.168.1.5')
-puts "Host reachable: #{result[:status]}"
-puts "Response time: #{result[:response_time]}ms"
-
 # Check if a host is reachable
 if pinger.reachable?('192.168.1.5')
   puts "Host is up!"
@@ -439,14 +448,20 @@ end
 
 # Ping multiple hosts continuously
 pinger.ping_hosts(['192.168.1.5', '192.168.1.6'], true, true)
+```
+
+#### Secure File Transfers
 
-# Work with secure file transfers
+```ruby
+# Work with secure file transfers (improved in v1.0.0)
 file_transfer = Lanet.file_transfer
+
+# Send file with progress tracking
 file_transfer.send_file('192.168.1.5', 'document.pdf', 'encryption_key') do |progress, bytes, total|
   puts "Progress: #{progress}% (#{bytes}/#{total} bytes)"
 end
 
-# Receive files
+# Receive files with event handling
 file_transfer.receive_file('./downloads', 'encryption_key') do |event, data|
   case event
   when :start
@@ -455,9 +470,15 @@ file_transfer.receive_file('./downloads', 'encryption_key') do |event, data|
     puts "Progress: #{data[:progress]}%"
   when :complete
     puts "File saved to: #{data[:file_path]}"
+  when :error
+    puts "Error: #{data[:error]}"
   end
 end
+```
 
+#### Mesh Networking
+
+```ruby
 # Mesh Networking
 mesh = Lanet.mesh_network
 mesh.start  # Start the mesh node and discovery service
@@ -472,9 +493,19 @@ mesh.connections.each do |node_id, info|
   puts "  #{node_id} (#{info[:ip]})"
 end
 
+# Check mesh health (new in v1.0.0)
+if mesh.healthy?
+  stats = mesh.stats
+  puts "Mesh is healthy: #{stats[:connections]} connections, #{stats[:processed_messages]} messages processed"
+end
+
 # Properly stop the mesh node
 mesh.stop
+```
 
+#### Network Path Analysis
+
+```ruby
 # Trace route to a host with different protocols
 tracer = Lanet.traceroute(protocol: :udp)
 hops = tracer.trace('github.com')
@@ -487,6 +518,28 @@ tcp_tracer = Lanet.traceroute(protocol: :tcp, max_hops: 15, timeout: 2)
 tcp_tracer.trace('google.com')
 ```
 
+#### Configuration (New in v1.0.0)
+
+```ruby
+# Access centralized configuration
+require 'lanet'
+
+# View default settings
+puts "Default port: #{Lanet::Config::DEFAULT_PORT}"
+puts "File transfer port: #{Lanet::Config::FILE_TRANSFER_PORT}"
+puts "Mesh port: #{Lanet::Config::MESH_PORT}"
+puts "Chunk size: #{Lanet::Config::CHUNK_SIZE}"
+
+# Configure custom logger
+Lanet::Config.configure do |config|
+  config.logger = Logger.new('lanet.log')
+  config.logger.level = Logger::DEBUG
+end
+
+# Use the configured logger
+Lanet::Config.logger.info("Starting Lanet application")
+```
+
 ## Mesh Network
 
 The mesh networking feature provides decentralized communication capabilities: