macaw_framework 1.3.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1488af601dcf17bdfabaad9407c4167ba3cfc9bc3913fc6e51a1905e575c905f
-  data.tar.gz: d2082dadd31530c82ce830b475299c8d4df17b9d600cf4b2e77a9257e3afb045
+  metadata.gz: f5ce341c22fbc784508cd3678e12b800d9313bb3966ca933d4970798fc5d8d14
+  data.tar.gz: 7a4d3d9926365062786b919e7114c16d09e14ae9e1a6828f49322985fb9d8f9e
 SHA512:
-  metadata.gz: e218e790fd300482efcdabb79149819859b5500f4a7e12d511ffecf4d9ca678731045d0defa46cc13893c0fd1367c25104ff10d34ceb73d42ee35ae61c6c32a5
-  data.tar.gz: 151ffbeecb5789abcabfc52af53228ecae894f45717ad8e257bb8ddbd193e1b61ce1458ce107c5c3e300746a37a63f9715d4d87d856ee61a469ed15d3b99c89d
+  metadata.gz: 92d923dfa4e841177186a4b6c35c7a41a543c19b2d0036fc7caa7fd9194f39479d602b8083966ad19930d9992aba88b9f678d78f1cc63b20be715df07e79f848
+  data.tar.gz: 65221f77161d6c3903c4d71c7dd2146371f4f846aa49419cedd457377c955805dbbda9de1f8e554966c36e44f974c236a395f6bb8e338b78891a433dc1b2fb56

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,15 @@ Metrics/PerceivedComplexity:
 
 Metrics/ClassLength:
   Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CHANGELOG.md

@@ -143,3 +143,17 @@
 - 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
+
+## [1.3.22]
+- Fixing error with tests on Ruby 3.4.x due to splash operator
+
+## [1.3.3]
+- Add missing dependencies for Ruby 4.x

data/Gemfile

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "openssl"
-gem "prometheus-client", "~> 4.1"
+gem 'logger', '~> 1.7'
+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 'ostruct', '~> 0.6.3'
+  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

@@ -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)
@@ -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)
@@ -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
 
@@ -51,7 +52,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 +105,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 +114,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 +137,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 +211,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/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

@@ -1,18 +1,15 @@
 # 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
 # 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
 
@@ -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/cache.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+##
+# Main module for all Macaw classes
+module MacawFramework; end
+
+##
+# This singleton class allows to manually cache
+# parameters and other data.
+class MacawFramework::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

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)