macaw_framework 1.3.0 → 1.3.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1488af601dcf17bdfabaad9407c4167ba3cfc9bc3913fc6e51a1905e575c905f
-  data.tar.gz: d2082dadd31530c82ce830b475299c8d4df17b9d600cf4b2e77a9257e3afb045
+  metadata.gz: 85d0826c8f583c5485bbd7d9be3868a407a065a8a7968efb1c2e6d60c100d79d
+  data.tar.gz: 7b1a1c9ab29d649ccf05e077ac347a7e1cbb9714bb65aea9b417a2139dca5a6a
 SHA512:
-  metadata.gz: e218e790fd300482efcdabb79149819859b5500f4a7e12d511ffecf4d9ca678731045d0defa46cc13893c0fd1367c25104ff10d34ceb73d42ee35ae61c6c32a5
-  data.tar.gz: 151ffbeecb5789abcabfc52af53228ecae894f45717ad8e257bb8ddbd193e1b61ce1458ce107c5c3e300746a37a63f9715d4d87d856ee61a469ed15d3b99c89d
+  metadata.gz: 7f04277f705c63685e6886e148f092694b445b4896b383783ea4cadfc1b266c158380af777a75dc791405a2ac2bd462d75a613c361e19da8e67ce284c134ddf9
+  data.tar.gz: e0dcbe81cbb9a26b289819e051d21b65d63f64ece3403da0e1c16aefadad1ac0e6a1e744da661d48bba623afe0aecdbe186d2ef9c4fe94131e7aac8bf4537a58

data/.rubocop.yml

@@ -1,16 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   SuggestExtensions: false
   NewCops: disable
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
 Layout/LineLength:
   Max: 120
 
@@ -31,3 +23,9 @@ Metrics/PerceivedComplexity:
 
 Metrics/ClassLength:
   Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/CHANGELOG.md

@@ -143,3 +143,11 @@
 - Fixed a bug where errors were being logged with level INFO
 - Improved error stack trace
 
+## [1.3.1]
+- 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

data/Gemfile

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "openssl"
-gem "prometheus-client", "~> 4.1"
+gem 'openssl'
+gem 'prometheus-client', '~> 4.1'
 
 group :test do
-  gem "minitest", "~> 5.0"
-  gem "rake", "~> 13.0"
-  gem "rubocop", "~> 1.21"
-  gem "simplecov", "~> 0.21.2"
-  gem "simplecov-json"
-  gem "simplecov_json_formatter", "~> 0.1.2"
+  gem 'minitest', '~> 5.0'
+  gem 'rake', '~> 13.0'
+  gem 'rubocop', '~> 1.21'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-json'
+  gem 'simplecov_json_formatter', '~> 0.1.2'
 end

data/README.md

@@ -18,7 +18,7 @@ provides developers with the essential tools to quickly build and deploy their a
         + [Configuration: Customize various aspects of the framework through the application.json configuration file, such as rate limiting, SSL support, and Prometheus integration](#configuration-customize-various-aspects-of-the-framework-through-the-applicationjson-configuration-file-such-as-rate-limiting-ssl-support-and-prometheus-integration)
         + [Monitoring: Easily monitor your application performance and metrics with built-in Prometheus support](#monitoring-easily-monitor-your-application-performance-and-metrics-with-built-in-prometheus-support)
         + [Routing for "public" Folder: Serve Static Assets](#routing-for-public-folder-serve-static-assets)
-        + [Cron Jobs](#cron-jobs)
+        + [Periodic Jobs](#periodic-jobs)
         + [Tips](#tips)
     * [Contributing](#contributing)
     * [License](#license)
@@ -51,7 +51,7 @@ We evaluated MacawFramework (Version 1.2.0) to assess its ability to handle simu
 
 MacawFramework is built to be highly compatible, since it uses only native Ruby code:
 
-- **MRI**: MacawFramework is compatible with Matz's Ruby Interpreter (MRI), version 2.7.0 and onwards. If you are using this version or a more recent one, you should not encounter any compatibility issues.
+- **MRI**: MacawFramework is compatible with Matz's Ruby Interpreter (MRI), version 3.0.0 and onwards. If you are using this version or a more recent one, you should not encounter any compatibility issues.
 
 - **TruffleRuby**: TruffleRuby is another Ruby interpreter that is fully compatible with MacawFramework. This provides developers with more flexibility in their choice of Ruby interpreter.
 
@@ -104,6 +104,8 @@ m.start!
 ### Caching: Improve performance by caching responses and configuring cache invalidation
 
 ```ruby
+m = MacawFramework::Macaw.new
+
 m.get('/cached_data', cache: ["header_to_cache", "query_param_to_cache"]) do |context|
   # Retrieve data
 end
@@ -111,6 +113,17 @@ end
 
 *Observation: To activate caching, you also have to set its properties in the `application.json` file. If you don't, the caching strategy will not work. See the Configuration section below for more details.*
 
+Another method of cache is the manual cache via the `MacawFramework::Cache` class. You can manually
+call the `read` and `write` methods of this singleton to save and recover values inside your methods.
+
+```ruby
+MacawFramework::Cache.write(:name, 'Maria', expires_in: 1800)
+# Your code
+MacawFramework::Cache.read(:name) # Maria
+```
+
+Manual cache does not need any additional configuration.
+
 ### Session management: Handle user sessions with server-side in-memory storage
 
 Session will only be enabled if it's configurations exists in the `application.json` file.
@@ -123,6 +136,8 @@ a session id in the HTTP request. In the case of the client sending an ID of an
 the framework will return a new session with a new ID.
 
 ```ruby
+m = MacawFramework::Macaw.new
+
 m.get('/login') do |context|
   # Authenticate user
   context[:client][:user_id] = user_id
@@ -195,17 +210,19 @@ be accessible at http://yourdomain.com/img/logo.png without any additional confi
 
 #### Caution: This is incompatible with most non-unix systems, such as Windows. If you are using a non-unix system, you will need to manually configure the "public" folder and use dir as nil to avoid problems.
 
-### Cron Jobs
+### Periodic Jobs
 
-Macaw Framework supports the declaration of cron jobs right in your application code. This feature allows developers to
+Macaw Framework supports the declaration of periodic jobs right in your application code. This feature allows developers to
 define tasks that run at set intervals, starting after an optional delay. Each job runs in a separate thread, meaning
-your cron jobs can execute in parallel without blocking the rest of your application.
+your periodic jobs can execute in parallel without blocking the rest of your application.
 
-Here's an example of how to declare a cron job:
+Here's an example of how to declare a periodic job:
 
 ```ruby
+m = MacawFramework::Macaw.new
+
 m.setup_job(interval: 5, start_delay: 5, job_name: "cron job 1") do
-  puts "i'm a cron job that runs every 5 secs!"
+  puts "i'm a periodic job that runs every 5 secs!"
 end
 ```
 

data/Rakefile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/macaw_framework/aspects/logging_aspect.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: false
 
-require "logger"
-require_relative "../data_filters/log_data_filter"
+require 'logger'
+require_relative '../data_filters/log_data_filter'
 
 ##
 # This Aspect is responsible for logging
@@ -11,9 +11,6 @@ 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]}]")
-
     begin
       response = super(*args)
     rescue StandardError => e

data/lib/macaw_framework/aspects/prometheus_aspect.rb

@@ -13,7 +13,7 @@ module PrometheusAspect
     ensure
       duration = (Time.now - start_time) * 1_000
 
-      endpoint_name = args[2].split(".").join("/")
+      endpoint_name = args[2].split('.').join('/')
 
       prometheus_middleware.request_duration_milliseconds.with_labels(endpoint: endpoint_name).observe(duration)
       prometheus_middleware.request_count.with_labels(endpoint: endpoint_name).increment

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "../../middlewares/memory_invalidation_middleware"
-require_relative "../../middlewares/rate_limiter_middleware"
-require_relative "../../data_filters/response_data_filter"
-require_relative "../../errors/too_many_requests_error"
-require_relative "../../utils/supported_ssl_versions"
-require_relative "../../aspects/prometheus_aspect"
-require_relative "../../aspects/logging_aspect"
-require_relative "../../aspects/cache_aspect"
-require "securerandom"
+require_relative '../../middlewares/memory_invalidation_middleware'
+require_relative '../../middlewares/rate_limiter_middleware'
+require_relative '../../data_filters/response_data_filter'
+require_relative '../../errors/too_many_requests_error'
+require_relative '../../utils/supported_ssl_versions'
+require_relative '../../aspects/prometheus_aspect'
+require_relative '../../aspects/logging_aspect'
+require_relative '../../aspects/cache_aspect'
+require 'securerandom'
 
 ##
 # Base module for Server classes. It contains
@@ -29,7 +29,7 @@ module ServerBase
         headers: client_data[:headers],
         body: client_data[:body],
         params: client_data[:params],
-        client: @session[session_id][0]
+        client: @session&.dig(session_id)&.dig(0)
       }
     )
   end
@@ -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 ||= {}
@@ -80,44 +79,46 @@ module ServerBase
   end
 
   def set_rate_limiting
-    return unless @macaw.config&.dig("macaw", "rate_limiting")
+    return unless @macaw.config&.dig('macaw', 'rate_limiting')
 
     @rate_limit = RateLimiterMiddleware.new(
-      @macaw.config["macaw"]["rate_limiting"]["window"].to_i || 1,
-      @macaw.config["macaw"]["rate_limiting"]["max_requests"].to_i || 60
+      @macaw.config['macaw']['rate_limiting']['window'].to_i || 1,
+      @macaw.config['macaw']['rate_limiting']['max_requests'].to_i || 60
     )
   end
 
   def set_ssl
-    ssl_config = @macaw.config["macaw"]["ssl"] if @macaw.config&.dig("macaw", "ssl")
+    ssl_config = @macaw.config['macaw']['ssl'] if @macaw.config&.dig('macaw', 'ssl')
     ssl_config ||= nil
     unless ssl_config.nil?
-      version_config = { min: ssl_config["min"], max: ssl_config["max"] }
+      version_config = { min: ssl_config['min'], max: ssl_config['max'] }
       @context = OpenSSL::SSL::SSLContext.new
       @context.min_version = SupportedSSLVersions::VERSIONS[version_config[:min]] unless version_config[:min].nil?
       @context.max_version = SupportedSSLVersions::VERSIONS[version_config[:max]] unless version_config[:max].nil?
-      @context.cert = OpenSSL::X509::Certificate.new(File.read(ssl_config["cert_file_name"]))
+      @context.cert = OpenSSL::X509::Certificate.new(File.read(ssl_config['cert_file_name']))
 
-      if ssl_config["key_type"] == "RSA" || ssl_config["key_type"].nil?
-        @context.key = OpenSSL::PKey::RSA.new(File.read(ssl_config["key_file_name"]))
-      elsif ssl_config["key_type"] == "EC"
-        @context.key = OpenSSL::PKey::EC.new(File.read(ssl_config["key_file_name"]))
+      if ssl_config['key_type'] == 'RSA' || ssl_config['key_type'].nil?
+        @context.key = OpenSSL::PKey::RSA.new(File.read(ssl_config['key_file_name']))
+      elsif ssl_config['key_type'] == 'EC'
+        @context.key = OpenSSL::PKey::EC.new(File.read(ssl_config['key_file_name']))
       else
-        raise ArgumentError, "Unsupported SSL/TLS key type: #{ssl_config["key_type"]}"
+        raise ArgumentError, "Unsupported SSL/TLS key type: #{ssl_config['key_type']}"
       end
     end
     @context ||= nil
   rescue IOError => e
-    @macaw_log&.error("It was not possible to read files #{@macaw.config["macaw"]["ssl"]["cert_file_name"]} and
-#{@macaw.config["macaw"]["ssl"]["key_file_name"]}. Please assure the files exist and their names are correct.")
+    @macaw_log&.error("It was not possible to read files #{@macaw.config['macaw']['ssl']['cert_file_name']} and
+#{@macaw.config['macaw']['ssl']['key_file_name']}. Please assure the files exist and their names are correct.")
     @macaw_log&.error(e.backtrace)
     raise e
   end
 
   def set_session
+    return unless @macaw.session
+
     @session ||= {}
-    inv = if @macaw.config&.dig("macaw", "session", "invalidation_time")
-            MemoryInvalidationMiddleware.new(@macaw.config["macaw"]["session"]["invalidation_time"])
+    inv = if @macaw.config&.dig('macaw', 'session', 'invalidation_time')
+            MemoryInvalidationMiddleware.new(@macaw.config['macaw']['session']['invalidation_time'])
           else
             MemoryInvalidationMiddleware.new
           end
@@ -127,7 +128,7 @@ module ServerBase
   def set_features
     @is_shutting_down = false
     set_rate_limiting
-    set_session if @macaw.session
+    set_session
     set_ssl
   end
 end

data/lib/macaw_framework/core/thread_server.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "common/server_base"
-require "openssl"
+require_relative 'common/server_base'
+require 'openssl'
 
 ##
 # Class responsible for providing a default
@@ -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/log_data_filter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: false
 
-require "json"
+require 'json'
 
 ##
 # Module responsible for sanitizing log data
@@ -10,7 +10,7 @@ module LogDataFilter
 
   def self.config
     @config ||= begin
-      file_path = "application.json"
+      file_path = 'application.json'
       config = {
         max_length: DEFAULT_MAX_LENGTH,
         sensitive_fields: DEFAULT_SENSITIVE_FIELDS
@@ -19,10 +19,10 @@ module LogDataFilter
       if File.exist?(file_path)
         json = JSON.parse(File.read(file_path))
 
-        if json["macaw"] && json["macaw"]["log"]
-          log_config = json["macaw"]["log"]
-          config[:max_length] = log_config["max_length"] if log_config["max_length"]
-          config[:sensitive_fields] = log_config["sensitive_fields"] if log_config["sensitive_fields"]
+        if json['macaw'] && json['macaw']['log']
+          log_config = json['macaw']['log']
+          config[:max_length] = log_config['max_length'] if log_config['max_length']
+          config[:sensitive_fields] = log_config['sensitive_fields'] if log_config['sensitive_fields']
         end
       end
 
@@ -31,11 +31,11 @@ module LogDataFilter
   end
 
   def self.sanitize_for_logging(data, sensitive_fields: config[:sensitive_fields])
-    return "" if data.nil?
+    return '' if data.nil?
 
-    data = data.to_s.force_encoding("UTF-8")
+    data = data.to_s.force_encoding('UTF-8')
     data = data.slice(0, config[:max_length])
-    data = data.gsub("\\", "")
+    data = data.gsub('\\', '')
 
     sensitive_fields.each do |field|
       next unless data.include?(field.to_s)

data/lib/macaw_framework/data_filters/request_data_filtering.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "../errors/endpoint_not_mapped_error"
+require_relative '../errors/endpoint_not_mapped_error'
 
 ##
 # Module containing methods to filter Strings
 module RequestDataFiltering
-  VARIABLE_PATTERN = %r{:[^/]+}.freeze
+  VARIABLE_PATTERN = %r{:[^/]+}
 
   ##
   # 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)
     method_name = select_path(method_name, routes, parameters)
     body_first_line, headers = extract_headers(client)
-    body = extract_body(client, body_first_line, headers["Content-Length"].to_i)
+    body = extract_body(client, body_first_line, headers['Content-Length'].to_i)
     [path, method_name, headers, body, parameters]
   end
 
@@ -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)
-    path[0] == "/" ? path[1..].gsub("/", ".") : path.gsub("/", ".")
+    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\-/*]})
-      split_header = header.split(":")
+    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
 
@@ -92,11 +94,11 @@ module RequestDataFiltering
   def self.extract_url_parameters(http_first_line)
     return http_first_line, nil unless http_first_line =~ /\?/
 
-    path_and_parameters = http_first_line.split("?", 2)
+    path_and_parameters = http_first_line.split('?', 2)
     path = "#{path_and_parameters[0]} "
-    parameters_array = path_and_parameters[1].split("&")
+    parameters_array = path_and_parameters[1].split('&')
     parameters_array.map! do |item|
-      split_item = item.split("=")
+      split_item = item.split('=')
       { sanitize_parameter_name(split_item[0]) => sanitize_parameter_value(split_item[1]) }
     end
     parameters = {}
@@ -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/data_filters/response_data_filter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../utils/http_status_code"
+require_relative '../utils/http_status_code'
 
 ##
 # Module responsible to filter and mount HTTP responses
@@ -19,9 +19,9 @@ module ResponseDataFilter
   end
 
   def self.mount_response_headers(headers)
-    return "" if headers.nil?
+    return '' if headers.nil?
 
-    response = ""
+    response = ''
     headers.each do |key, value|
       response += "#{key}: #{value}\r\n"
     end

data/lib/macaw_framework/errors/endpoint_not_mapped_error.rb

@@ -4,7 +4,7 @@
 # Error raised when the client calls
 # for a path that doesn't exist.
 class EndpointNotMappedError < StandardError
-  def initialize(msg = "Undefined endpoint")
+  def initialize(msg = 'Undefined endpoint')
     super
   end
 end

data/lib/macaw_framework/middlewares/prometheus_middleware.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "prometheus/client"
-require "prometheus/client/formats/text"
+require 'prometheus/client'
+require 'prometheus/client/formats/text'
 
 ##
 # Middleware responsible to configure prometheus
@@ -14,20 +14,20 @@ class PrometheusMiddleware
 
     @request_duration_milliseconds = Prometheus::Client::Histogram.new(
       :request_duration_milliseconds,
-      docstring: "The duration of each request in milliseconds",
+      docstring: 'The duration of each request in milliseconds',
       labels: [:endpoint],
       buckets: (100..1000).step(100).to_a + (2000..10_000).step(1000).to_a
     )
 
     @request_count = Prometheus::Client::Counter.new(
       :request_count,
-      docstring: "The total number of requests received",
+      docstring: 'The total number of requests received',
       labels: [:endpoint]
     )
 
     @response_count = Prometheus::Client::Counter.new(
       :response_count,
-      docstring: "The total number of responses sent",
+      docstring: 'The total number of responses sent',
       labels: %i[endpoint status]
     )
 
@@ -40,9 +40,9 @@ class PrometheusMiddleware
   private
 
   def prometheus_endpoint(prometheus_registry, configurations, macaw)
-    endpoint = configurations["macaw"]["prometheus"]["endpoint"] || "/metrics"
+    endpoint = configurations['macaw']['prometheus']['endpoint'] || '/metrics'
     macaw.get(endpoint) do |_context|
-      [Prometheus::Client::Formats::Text.marshal(prometheus_registry), 200, { "Content-Type" => "plaintext" }]
+      [Prometheus::Client::Formats::Text.marshal(prometheus_registry), 200, { 'Content-Type' => 'plaintext' }]
     end
   end
 end

data/lib/macaw_framework/utils/http_status_code.rb

@@ -7,66 +7,66 @@ module HttpStatusCode
   ##
   # Http Status Code Map
   HTTP_STATUS_CODE_MAP = {
-    100 => "Continue",
-    101 => "Switching Protocols",
-    102 => "Processing",
-    103 => "Early Hints",
-    200 => "OK",
-    201 => "Created",
-    202 => "Accepted",
-    203 => "Non-Authoritative Information",
-    204 => "No Content",
-    205 => "Reset Content",
-    206 => "Partial Content",
-    207 => "Multi-Status",
-    208 => "Already Reported",
-    226 => "IM Used",
-    300 => "Multiple Choices",
-    301 => "Moved Permanently",
-    302 => "Found",
-    303 => "See Other",
-    304 => "Not Modified",
-    305 => "Use Proxy",
-    307 => "Temporary Redirect",
-    308 => "Permanent Redirect",
-    400 => "Bad Request",
-    401 => "Unauthorized",
-    402 => "Payment Required",
-    403 => "Forbidden",
-    404 => "Not Found",
-    405 => "Method Not Allowed",
-    406 => "Not Acceptable",
-    407 => "Proxy Authentication Required",
-    408 => "Request Timeout",
-    409 => "Conflict",
-    410 => "Gone",
-    411 => "Length Required",
-    412 => "Precondition Failed",
-    413 => "Content Too Large",
-    414 => "URI Too Long",
-    415 => "Unsupported Media Type",
-    416 => "Range Not Satisfiable",
-    417 => "Expectation Failed",
-    421 => "Misdirected Request",
-    422 => "Unprocessable Content",
-    423 => "Locked",
-    424 => "Failed Dependency",
-    425 => "Too Early",
-    426 => "Upgrade Required",
-    428 => "Precondition Required",
-    429 => "Too Many Requests",
-    431 => "Request Header Fields Too Large",
-    451 => "Unavailable For Legal Reasons",
-    500 => "Internal Server Error",
-    501 => "Not Implemented",
-    502 => "Bad Gateway",
-    503 => "Service Unavailable",
-    504 => "Gateway Timeout",
-    505 => "HTTP Version Not Supported",
-    506 => "Variant Also Negotiates",
-    507 => "Insufficient Storage",
-    508 => "Loop Detected",
-    510 => "Not Extended (OBSOLETED)",
-    511 => "Network Authentication Required"
+    100 => 'Continue',
+    101 => 'Switching Protocols',
+    102 => 'Processing',
+    103 => 'Early Hints',
+    200 => 'OK',
+    201 => 'Created',
+    202 => 'Accepted',
+    203 => 'Non-Authoritative Information',
+    204 => 'No Content',
+    205 => 'Reset Content',
+    206 => 'Partial Content',
+    207 => 'Multi-Status',
+    208 => 'Already Reported',
+    226 => 'IM Used',
+    300 => 'Multiple Choices',
+    301 => 'Moved Permanently',
+    302 => 'Found',
+    303 => 'See Other',
+    304 => 'Not Modified',
+    305 => 'Use Proxy',
+    307 => 'Temporary Redirect',
+    308 => 'Permanent Redirect',
+    400 => 'Bad Request',
+    401 => 'Unauthorized',
+    402 => 'Payment Required',
+    403 => 'Forbidden',
+    404 => 'Not Found',
+    405 => 'Method Not Allowed',
+    406 => 'Not Acceptable',
+    407 => 'Proxy Authentication Required',
+    408 => 'Request Timeout',
+    409 => 'Conflict',
+    410 => 'Gone',
+    411 => 'Length Required',
+    412 => 'Precondition Failed',
+    413 => 'Content Too Large',
+    414 => 'URI Too Long',
+    415 => 'Unsupported Media Type',
+    416 => 'Range Not Satisfiable',
+    417 => 'Expectation Failed',
+    421 => 'Misdirected Request',
+    422 => 'Unprocessable Content',
+    423 => 'Locked',
+    424 => 'Failed Dependency',
+    425 => 'Too Early',
+    426 => 'Upgrade Required',
+    428 => 'Precondition Required',
+    429 => 'Too Many Requests',
+    431 => 'Request Header Fields Too Large',
+    451 => 'Unavailable For Legal Reasons',
+    500 => 'Internal Server Error',
+    501 => 'Not Implemented',
+    502 => 'Bad Gateway',
+    503 => 'Service Unavailable',
+    504 => 'Gateway Timeout',
+    505 => 'HTTP Version Not Supported',
+    506 => 'Variant Also Negotiates',
+    507 => 'Insufficient Storage',
+    508 => 'Loop Detected',
+    510 => 'Not Extended (OBSOLETED)',
+    511 => 'Network Authentication Required'
   }.freeze
 end

data/lib/macaw_framework/utils/supported_ssl_versions.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "openssl"
+require 'openssl'
 
 module SupportedSSLVersions
   VERSIONS = {
-    "SSL2" => OpenSSL::SSL::SSL2_VERSION,
-    "SSL3" => OpenSSL::SSL::SSL3_VERSION,
-    "TLS1.1" => OpenSSL::SSL::TLS1_1_VERSION,
-    "TLS1.2" => OpenSSL::SSL::TLS1_2_VERSION,
-    "TLS1.3" => OpenSSL::SSL::TLS1_3_VERSION
+    'SSL2' => OpenSSL::SSL::SSL2_VERSION,
+    'SSL3' => OpenSSL::SSL::SSL3_VERSION,
+    'TLS1.1' => OpenSSL::SSL::TLS1_1_VERSION,
+    'TLS1.2' => OpenSSL::SSL::TLS1_2_VERSION,
+    'TLS1.3' => OpenSSL::SSL::TLS1_3_VERSION
   }.freeze
 end

data/lib/macaw_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MacawFramework
-  VERSION = "1.3.0"
+  VERSION = '1.3.21'
 end

data/lib/macaw_framework.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "macaw_framework/errors/endpoint_not_mapped_error"
-require_relative "macaw_framework/middlewares/prometheus_middleware"
-require_relative "macaw_framework/data_filters/request_data_filtering"
-require_relative "macaw_framework/middlewares/memory_invalidation_middleware"
-require_relative "macaw_framework/core/cron_runner"
-require_relative "macaw_framework/core/thread_server"
-require_relative "macaw_framework/version"
-require "prometheus/client"
-require "securerandom"
-require "pathname"
-require "logger"
-require "socket"
-require "json"
+require_relative 'macaw_framework/errors/endpoint_not_mapped_error'
+require_relative 'macaw_framework/middlewares/prometheus_middleware'
+require_relative 'macaw_framework/data_filters/request_data_filtering'
+require_relative 'macaw_framework/middlewares/memory_invalidation_middleware'
+require_relative 'macaw_framework/core/cron_runner'
+require_relative 'macaw_framework/core/thread_server'
+require_relative 'macaw_framework/version'
+require 'prometheus/client'
+require 'securerandom'
+require 'singleton'
+require 'pathname'
+require 'logger'
+require 'socket'
+require 'json'
 
 module MacawFramework
   ##
@@ -30,13 +31,7 @@ module MacawFramework
     def initialize(custom_log: Logger.new($stdout), server: ThreadServer, dir: nil)
       apply_options(custom_log)
       create_endpoint_public_files(dir)
-      @port ||= 8080
-      @bind ||= "localhost"
-      @config ||= nil
-      @threads ||= 200
-      @endpoints_to_cache = []
-      @prometheus ||= nil
-      @prometheus_middleware ||= nil
+      setup_default_configs
       @server_class = server
     end
 
@@ -45,14 +40,15 @@ module MacawFramework
     # with the respective path.
     # @param {String} path
     # @param {Proc} block
-    # @example
     #
-    # macaw = MacawFramework::Macaw.new
-    # macaw.get("/hello") do |context|
-    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
-    # end
+    # @example
+    #   macaw = MacawFramework::Macaw.new
+    #   macaw.get("/hello") do |context|
+    #     return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    #   end
+    ##
     def get(path, cache: [], &block)
-      map_new_endpoint("get", cache, path, &block)
+      map_new_endpoint('get', cache, path, &block)
     end
 
     ##
@@ -63,12 +59,13 @@ module MacawFramework
     # @param {Proc} block
     # @example
     #
-    # macaw = MacawFramework::Macaw.new
-    # macaw.post("/hello") do |context|
-    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
-    # end
+    #   macaw = MacawFramework::Macaw.new
+    #   macaw.post("/hello") do |context|
+    #     return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    #   end
+    ##
     def post(path, cache: [], &block)
-      map_new_endpoint("post", cache, path, &block)
+      map_new_endpoint('post', cache, path, &block)
     end
 
     ##
@@ -78,12 +75,13 @@ module MacawFramework
     # @param {Proc} block
     # @example
     #
-    # macaw = MacawFramework::Macaw.new
-    # macaw.put("/hello") do |context|
-    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
-    # end
+    #   macaw = MacawFramework::Macaw.new
+    #   macaw.put("/hello") do |context|
+    #     return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    #   end
+    ##
     def put(path, cache: [], &block)
-      map_new_endpoint("put", cache, path, &block)
+      map_new_endpoint('put', cache, path, &block)
     end
 
     ##
@@ -93,12 +91,13 @@ module MacawFramework
     # @param {Proc} block
     # @example
     #
-    # macaw = MacawFramework::Macaw.new
-    # macaw.patch("/hello") do |context|
-    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
-    # end
+    #   macaw = MacawFramework::Macaw.new
+    #   macaw.patch("/hello") do |context|
+    #     return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    #   end
+    ##
     def patch(path, cache: [], &block)
-      map_new_endpoint("patch", cache, path, &block)
+      map_new_endpoint('patch', cache, path, &block)
     end
 
     ##
@@ -108,26 +107,28 @@ module MacawFramework
     # @param {Proc} block
     # @example
     #
-    # macaw = MacawFramework::Macaw.new
-    # macaw.delete("/hello") do |context|
-    #   return "Hello World!", 200, { "Content-Type" => "text/plain" }
-    # end
+    #   macaw = MacawFramework::Macaw.new
+    #   macaw.delete("/hello") do |context|
+    #     return "Hello World!", 200, { "Content-Type" => "text/plain" }
+    #   end
+    ##
     def delete(path, cache: [], &block)
-      map_new_endpoint("delete", cache, path, &block)
+      map_new_endpoint('delete', cache, path, &block)
     end
 
     ##
-    # Spawn and start a thread running the defined cron job.
+    # Spawn and start a thread running the defined periodic job.
     # @param {Integer} interval
     # @param {Integer?} start_delay
     # @param {String} job_name
     # @param {Proc} block
     # @example
     #
-    # macaw = MacawFramework::Macaw.new
-    # macaw.setup_job(interval: 60, start_delay: 60, job_name: "job 1") do
-    #   puts "I'm a cron job that runs every minute"
-    # end
+    #   macaw = MacawFramework::Macaw.new
+    #   macaw.setup_job(interval: 60, start_delay: 60, job_name: "job 1") do
+    #     puts "I'm a periodic job that runs every minute"
+    #   end
+    ##
     def setup_job(interval: 60, start_delay: 0, job_name: "job_#{SecureRandom.uuid}", &block)
       @cron_runner ||= CronRunner.new(self)
       @jobs ||= []
@@ -139,27 +140,27 @@ module MacawFramework
     # Starts the web server
     def start!
       if @macaw_log.nil?
-        puts("---------------------------------")
+        puts('---------------------------------')
         puts("Starting server at port #{@port}")
         puts("Number of threads: #{@threads}")
-        puts("---------------------------------")
+        puts('---------------------------------')
       else
-        @macaw_log.info("---------------------------------")
+        @macaw_log.info('---------------------------------')
         @macaw_log.info("Starting server at port #{@port}")
         @macaw_log.info("Number of threads: #{@threads}")
-        @macaw_log.info("---------------------------------")
+        @macaw_log.info('---------------------------------')
       end
       @server = @server_class.new(self, @endpoints_to_cache, @cache, @prometheus, @prometheus_middleware)
       server_loop(@server)
     rescue Interrupt
       if @macaw_log.nil?
-        puts("Stopping server")
-        @server.close
-        puts("Macaw stop flying for some seeds...")
+        puts('Stopping server')
+        @server.shutdown
+        puts('Macaw stop flying for some seeds...')
       else
-        @macaw_log.info("Stopping server")
-        @server.close
-        @macaw_log.info("Macaw stop flying for some seeds...")
+        @macaw_log.info('Stopping server')
+        @server.shutdown
+        @macaw_log.info('Macaw stop flying for some seeds...')
       end
     end
 
@@ -169,35 +170,63 @@ module MacawFramework
     # you just want to keep cron jobs running, without
     # mapping any HTTP endpoints.
     def start_without_server!
-      @macaw_log.nil? ? puts("Application starting") : @macaw_log.info("Application starting")
+      @macaw_log.nil? ? puts('Application starting') : @macaw_log.info('Application starting')
       loop { sleep(3600) }
     rescue Interrupt
-      @macaw_log.nil? ? puts("Macaw stop flying for some seeds.") : @macaw_log.info("Macaw stop flying for some seeds.")
+      @macaw_log.nil? ? puts('Macaw stop flying for some seeds.') : @macaw_log.info('Macaw stop flying for some seeds.')
     end
 
     private
 
+    def setup_default_configs
+      @port ||= 8080
+      @bind ||= 'localhost'
+      @config ||= nil
+      @threads ||= 200
+      @endpoints_to_cache = []
+      @prometheus ||= nil
+      @prometheus_middleware ||= nil
+    end
+
     def apply_options(custom_log)
+      setup_basic_config(custom_log)
+      setup_session
+      setup_cache
+      setup_prometheus
+    rescue StandardError => e
+      @macaw_log&.warn(e.message)
+    end
+
+    def setup_cache
+      return if @config['macaw']['cache'].nil?
+
+      @cache = MemoryInvalidationMiddleware.new(@config['macaw']['cache']['cache_invalidation'].to_i || 3_600)
+    end
+
+    def setup_session
+      @session = false
+      return if @config['macaw']['session'].nil?
+
+      @session = true
+      @secure_header = @config['macaw']['session']['secure_header'] || 'X-Session-ID'
+    end
+
+    def setup_basic_config(custom_log)
       @routes = []
       @cached_methods = {}
       @macaw_log ||= custom_log
-      @config = JSON.parse(File.read("application.json"))
-      @port = @config["macaw"]["port"] || 8080
-      @bind = @config["macaw"]["bind"] || "localhost"
-      @session = false
-      unless @config["macaw"]["session"].nil?
-        @session = true
-        @secure_header = @config["macaw"]["session"]["secure_header"] || "X-Session-ID"
-      end
-      @threads = @config["macaw"]["threads"] || 200
-      unless @config["macaw"]["cache"].nil?
-        @cache = MemoryInvalidationMiddleware.new(@config["macaw"]["cache"]["cache_invalidation"].to_i || 3_600)
-      end
-      @prometheus = Prometheus::Client::Registry.new if @config["macaw"]["prometheus"]
-      @prometheus_middleware = PrometheusMiddleware.new if @config["macaw"]["prometheus"]
-      @prometheus_middleware.configure_prometheus(@prometheus, @config, self) if @config["macaw"]["prometheus"]
-    rescue StandardError => e
-      @macaw_log&.warn(e.message)
+      @config = JSON.parse(File.read('application.json'))
+      @port = @config['macaw']['port'] || 8080
+      @bind = @config['macaw']['bind'] || 'localhost'
+      @threads = @config['macaw']['threads'] || 200
+    end
+
+    def setup_prometheus
+      return unless @config['macaw']['prometheus']
+
+      @prometheus = Prometheus::Client::Registry.new
+      @prometheus_middleware = PrometheusMiddleware.new
+      @prometheus_middleware&.configure_prometheus(@prometheus, @config, self)
     end
 
     def server_loop(server)
@@ -208,10 +237,10 @@ module MacawFramework
       @endpoints_to_cache << "#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}" unless cache.empty?
       @cached_methods["#{prefix}.#{RequestDataFiltering.sanitize_method_name(path)}"] = cache unless cache.empty?
       path_clean = RequestDataFiltering.extract_path(path)
-      slash = path[0] == "/" ? "" : "/"
+      slash = path[0] == '/' ? '' : '/'
       @macaw_log&.info("Defining #{prefix.upcase} endpoint at #{slash}#{path}")
       define_singleton_method("#{prefix}.#{path_clean}", block || lambda {
-        |context = { headers: {}, body: "", params: {} }|
+        |context = { headers: {}, body: '', params: {} }|
       })
       @routes << "#{prefix}.#{path_clean}"
     end
@@ -219,8 +248,8 @@ module MacawFramework
     def get_files_public_folder(dir)
       return [] if dir.nil?
 
-      folder_path = Pathname.new(File.expand_path("public", dir))
-      file_paths = folder_path.glob("**/*").select(&:file?)
+      folder_path = Pathname.new(File.expand_path('public', dir))
+      file_paths = folder_path.glob('**/*').select(&:file?)
       file_paths.map { |path| "public/#{path.relative_path_from(folder_path)}" }
     end
 
@@ -230,4 +259,90 @@ module MacawFramework
       end
     end
   end
+
+  ##
+  # This singleton class allows to manually cache
+  # parameters and other data.
+  class Cache
+    include Singleton
+
+    attr_accessor :invalidation_frequency
+
+    ##
+    # Write a value to Cache memory.
+    # Can be called statically or from an instance.
+    # @param {String} tag
+    # @param {Object} value
+    # @param {Integer} expires_in Defaults to 3600.
+    # @return nil
+    #
+    # @example
+    #   MacawFramework::Cache.write("name", "Maria", expires_in: 7200)
+    def self.write(tag, value, expires_in: 3600)
+      MacawFramework::Cache.instance.write(tag, value, expires_in: expires_in)
+    end
+
+    ##
+    # Write a value to Cache memory.
+    # Can be called statically or from an instance.
+    # @param {String} tag
+    # @param {Object} value
+    # @param {Integer} expires_in Defaults to 3600.
+    # @return nil
+    #
+    # @example
+    #   MacawFramework::Cache.write("name", "Maria", expires_in: 7200)
+    def write(tag, value, expires_in: 3600)
+      if read(tag).nil?
+        @mutex.synchronize do
+          @cache.store(tag, { value: value, expires_in: Time.now + expires_in })
+        end
+      else
+        @cache[tag][:value] = value
+        @cache[tag][:expires_in] = Time.now + expires_in
+      end
+    end
+
+    ##
+    # Read the value with the specified tag.
+    # Can be called statically or from an instance.
+    # @param {String} tag
+    # @return {String|nil}
+    #
+    # @example
+    #   MacawFramework::Cache.read("name") # Maria
+    def self.read(tag) = MacawFramework::Cache.instance.read(tag)
+
+    ##
+    # Read the value with the specified tag.
+    # Can be called statically or from an instance.
+    # @param {String} tag
+    # @return {String|nil}
+    #
+    # @example
+    #   MacawFramework::Cache.read("name") # Maria
+    def read(tag) = @cache.dig(tag, :value)
+
+    private
+
+    def initialize
+      @cache = {}
+      @mutex = Mutex.new
+      @invalidation_frequency = 60
+      invalidate_cache
+    end
+
+    def invalidate_cache
+      @invalidator = Thread.new(&method(:invalidation_process))
+    end
+
+    def invalidation_process
+      loop do
+        sleep @invalidation_frequency
+        @mutex.synchronize do
+          @cache.delete_if { |_, v| v[:expires_in] < Time.now }
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.21
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-04 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -84,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="