macaw_framework 1.3.1 → 1.3.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faee0746cfa34d7020272e9c6a3d24f12bff1c88ef3a5f8bf1f65be5dc7de8b2
-  data.tar.gz: f3dfa0a71a12df9d0fdf07fcedcf9fe8cc29db81c20aa003482f5a465a330648
+  metadata.gz: 6884907c34b2719e0166f6a3c7fc5992e277126ec738a6a08e3fbaa71c427b0a
+  data.tar.gz: 554b0671565902d395fa289ae970cb7b149f0b61f9dcebdfdd9947bc277807fa
 SHA512:
-  metadata.gz: 92b61e93524104407eba6c9d2621990a7cc6b68e0733a78fedc75cff6fc248601410344aa421dec9e79f77a52b391d7f2e102cb54f639a127ebeaf4b00c5f2fb
-  data.tar.gz: 3eb62e30474e588dd0200f981aaa847ddf2725d7092d9c4387a0a5c63c2870f2ae87bd7f7998d0149dd00c592d144d0d6188464de6a473334ec94733967aef3d
+  metadata.gz: bde5aa848d982a6cd112c9f8eb57b84c39aaf30463f0a21e8ce79dfee2b54bc6711598da4abd3c0287a32f502123a48715700c68f937118fe0cdbb2c045733cd
+  data.tar.gz: 2248a9ea06a53f7602d366fdc2524a7c40866042102ec84fb6b1a724e9617175f2278bf2075fd6b9b7f9bc36626b64824f6cd0baee25ce6346f554bba9e76fd1

data/CHANGELOG.md

@@ -147,3 +147,10 @@
 - Fixing bug where missing session configuration on `application.json` break the application
 - Including a Cache module for manual caching.
 
+## [1.3.21]
+- Refactoring shutdown method
+- Fixing a bug where a HTTP call without client data broke the parser
+- Removing logs registering new HTTP connections to reduce log bloat
+
+## [1.3.3]
+- Fixing error with tests on Ruby 3.4.x due to splash operator

data/README.md

@@ -2,8 +2,8 @@
 # MacawFramework
 
 MacawFramework is a lightweight, easy-to-use web framework for Ruby designed to simplify the development of small to 
-medium-sized web applications. With support for various HTTP methods, caching, and session management, MacawFramework 
-provides developers with the essential tools to quickly build and deploy their applications.
+medium-sized web applications. Weighting less than 26Kb with support for various HTTP methods, caching, and session management,
+MacawFramework provides developers with the essential tools to quickly build and deploy their applications.
 
 - [MacawFramework](#macawframework)
     * [Features](#features)
@@ -31,7 +31,8 @@ provides developers with the essential tools to quickly build and deploy their a
 - Session management with server-side in-memory storage
 - Basic rate limiting and SSL support
 - Prometheus integration for monitoring and metrics
-- Lightweight and easy to learn
+- Less than 26Kb
+- Easy to learn
 
 ## Installation
 

data/lib/macaw_framework/aspects/cache_aspect.rb

@@ -3,15 +3,15 @@
 ##
 # Aspect that provide cache for the endpoints.
 module CacheAspect
-  def call_endpoint(cache, *args)
-    return super(*args) unless !cache[:cache].nil? && cache[:endpoints_to_cache]&.include?(args[0])
+  def call_endpoint(cache, *args, **kwargs)
+    return super(*args, **kwargs) unless !cache[:cache].nil? && cache[:endpoints_to_cache]&.include?(args[0])
 
     cache_filtered_name = cache_name_filter(args[1], cache[:cached_methods][args[0]])
 
     cache[:cache].mutex.synchronize do
       return cache[:cache].cache[cache_filtered_name][0] unless cache[:cache].cache[cache_filtered_name].nil?
 
-      response = super(*args)
+      response = super(*args, **kwargs)
       cache[:cache].cache[cache_filtered_name] = [response, Time.now] if should_cache_response?(response[1])
       response
     end

data/lib/macaw_framework/aspects/logging_aspect.rb

@@ -8,11 +8,8 @@ require_relative '../data_filters/log_data_filter'
 # the input and output of every endpoint called
 # in the framework.
 module LoggingAspect
-  def call_endpoint(logger, *args)
-    return super(*args) if logger.nil?
-
-    endpoint_name = args[1].split('.')[1..].join('/')
-    logger.info("Request received for [#{endpoint_name}] from [#{args[-1]}]")
+  def call_endpoint(logger, *args, **kwargs)
+    return super(*args, **kwargs) if logger.nil?
 
     begin
       response = super(*args)

data/lib/macaw_framework/aspects/prometheus_aspect.rb

@@ -3,8 +3,8 @@
 ##
 # Aspect that provides application metrics using prometheus.
 module PrometheusAspect
-  def call_endpoint(prometheus_middleware, *args)
-    return super(*args) if prometheus_middleware.nil?
+  def call_endpoint(prometheus_middleware, *args, **kwargs)
+    return super(*args, **kwargs) if prometheus_middleware.nil?
 
     start_time = Time.now
 

data/lib/macaw_framework/core/common/server_base.rb

@@ -39,14 +39,13 @@ module ServerBase
   end
 
   def handle_client(client)
-    path, method_name, headers, body, parameters = RequestDataFiltering.parse_request_data(client, @macaw.routes)
+    _path, method_name, headers, body, parameters = RequestDataFiltering.parse_request_data(client, @macaw.routes)
     raise EndpointNotMappedError unless @macaw.respond_to?(method_name)
     raise TooManyRequestsError unless @rate_limit.nil? || @rate_limit.allow?(client.peeraddr[3])
 
     client_data = get_client_data(body, headers, parameters)
     session_id = declare_client_session(client_data[:headers], @macaw.secure_header) if @macaw.session
 
-    @macaw_log&.info("Running #{path.gsub("\n", '').gsub("\r", '')}")
     message, status, response_headers = call_endpoint(@prometheus_middleware, @macaw_log, @cache,
                                                       method_name, client_data, session_id, client.peeraddr[3])
     response_headers ||= {}

data/lib/macaw_framework/core/thread_server.rb

@@ -74,8 +74,17 @@ class ThreadServer
 
   ##
   # Method Responsible for closing the TCP server.
-  def close
-    shutdown
+  def shutdown
+    @is_shutting_down = true
+    loop do
+      break if @work_queue.empty?
+
+      sleep 0.1
+    end
+
+    @num_threads.times { @work_queue << :shutdown }
+    @workers.each(&:join)
+    @server.close
   end
 
   private
@@ -107,17 +116,4 @@ class ThreadServer
       end
     end
   end
-
-  def shutdown
-    @is_shutting_down = true
-    loop do
-      break if @work_queue.empty?
-
-      sleep 0.1
-    end
-
-    @num_threads.times { @work_queue << :shutdown }
-    @workers.each(&:join)
-    @server.close
-  end
 end

data/lib/macaw_framework/data_filters/request_data_filtering.rb

@@ -11,7 +11,7 @@ module RequestDataFiltering
   # Method responsible for extracting information
   # provided by the client like Headers and Body
   def self.parse_request_data(client, routes)
-    path, parameters = extract_url_parameters(client.gets.gsub('HTTP/1.1', ''))
+    path, parameters = extract_url_parameters(client.gets&.gsub('HTTP/1.1', ''))
     parameters = {} if parameters.nil?
 
     method_name = sanitize_method_name(path)
@@ -26,15 +26,15 @@ module RequestDataFiltering
 
     selected_route = nil
     routes.each do |route|
-      split_route = route.split('.')
-      split_name = method_name.split('.')
+      split_route = route&.split('.')
+      split_name = method_name&.split('.')
 
-      next unless split_route.length == split_name.length
+      next unless split_route&.length == split_name&.length
       next unless match_path_with_route(split_name, split_route)
 
       selected_route = route
-      split_route.each_with_index do |var, index|
-        parameters[var[1..].to_sym] = split_name[index] if var =~ VARIABLE_PATTERN
+      split_route&.each_with_index do |var, index|
+        parameters[var[1..].to_sym] = split_name&.dig(index) if var =~ VARIABLE_PATTERN
       end
       break
     end
@@ -45,7 +45,7 @@ module RequestDataFiltering
   end
 
   def self.match_path_with_route(split_path, split_route)
-    split_route.each_with_index do |var, index|
+    split_route&.each_with_index do |var, index|
       return false if var != split_path[index] && !var.match?(VARIABLE_PATTERN)
     end
 
@@ -56,26 +56,28 @@ module RequestDataFiltering
   # Method responsible for sanitizing the method name
   def self.sanitize_method_name(path)
     path = extract_path(path)
-    method_name = path.gsub('/', '.').strip.downcase
-    method_name.gsub!(' ', '')
+    method_name = path&.gsub('/', '.')&.strip&.downcase
+    method_name&.gsub!(' ', '')
     method_name
   end
 
   ##
   # Method responsible for extracting the path from URI
   def self.extract_path(path)
+    return path if path.nil?
+
     path[0] == '/' ? path[1..].gsub('/', '.') : path.gsub('/', '.')
   end
 
   ##
   # Method responsible for extracting the headers from request
   def self.extract_headers(client)
-    header = client.gets.delete("\n").delete("\r")
+    header = client.gets&.delete("\n")&.delete("\r")
     headers = {}
-    while header.match(%r{[a-zA-Z0-9\-/*]*: [a-zA-Z0-9\-/*]})
+    while header&.match(%r{[a-zA-Z0-9\-/*]*: [a-zA-Z0-9\-/*]})
       split_header = header.split(':')
       headers[split_header[0].strip] = split_header[1].strip
-      header = client.gets.delete("\n").delete("\r")
+      header = client.gets&.delete("\n")&.delete("\r")
     end
     [header, headers]
   end
@@ -83,7 +85,7 @@ module RequestDataFiltering
   ##
   # Method responsible for extracting the body from request
   def self.extract_body(client, body_first_line, content_length)
-    body = client.read(content_length)
+    body = client&.read(content_length)
     body_first_line << body.to_s
   end
 
@@ -107,13 +109,13 @@ module RequestDataFiltering
   ##
   # Method responsible for sanitizing the parameter name
   def self.sanitize_parameter_name(name)
-    name.gsub(/[^\w\s]/, '')
+    name&.gsub(/[^\w\s]/, '')
   end
 
   ##
   # Method responsible for sanitizing the parameter value
   def self.sanitize_parameter_value(value)
-    value.gsub(/[^\w\s]/, '')
-    value.gsub(/\s/, '')
+    value&.gsub(/[^\w\s]/, '')
+    value&.gsub(/\s/, '')
   end
 end

data/lib/macaw_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MacawFramework
-  VERSION = '1.3.1'
+  VERSION = '1.3.22'
 end

data/lib/macaw_framework.rb

@@ -155,11 +155,11 @@ module MacawFramework
     rescue Interrupt
       if @macaw_log.nil?
         puts('Stopping server')
-        @server.close
+        @server.shutdown
         puts('Macaw stop flying for some seeds...')
       else
         @macaw_log.info('Stopping server')
-        @server.close
+        @server.shutdown
         @macaw_log.info('Macaw stop flying for some seeds...')
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.22
 platform: ruby
 authors:
 - Aria Diniz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -76,7 +76,7 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/macaw_framework
   homepage_uri: https://github.com/ariasdiniz/macaw_framework
   source_code_uri: https://github.com/ariasdiniz/macaw_framework
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A lightweight back-end web framework
 test_files: []