macaw_framework 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faee0746cfa34d7020272e9c6a3d24f12bff1c88ef3a5f8bf1f65be5dc7de8b2
-  data.tar.gz: f3dfa0a71a12df9d0fdf07fcedcf9fe8cc29db81c20aa003482f5a465a330648
+  metadata.gz: f5ce341c22fbc784508cd3678e12b800d9313bb3966ca933d4970798fc5d8d14
+  data.tar.gz: 7a4d3d9926365062786b919e7114c16d09e14ae9e1a6828f49322985fb9d8f9e
 SHA512:
-  metadata.gz: 92b61e93524104407eba6c9d2621990a7cc6b68e0733a78fedc75cff6fc248601410344aa421dec9e79f77a52b391d7f2e102cb54f639a127ebeaf4b00c5f2fb
-  data.tar.gz: 3eb62e30474e588dd0200f981aaa847ddf2725d7092d9c4387a0a5c63c2870f2ae87bd7f7998d0149dd00c592d144d0d6188464de6a473334ec94733967aef3d
+  metadata.gz: 92d923dfa4e841177186a4b6c35c7a41a543c19b2d0036fc7caa7fd9194f39479d602b8083966ad19930d9992aba88b9f678d78f1cc63b20be715df07e79f848
+  data.tar.gz: 65221f77161d6c3903c4d71c7dd2146371f4f846aa49419cedd457377c955805dbbda9de1f8e554966c36e44f974c236a395f6bb8e338b78891a433dc1b2fb56

data/.rubocop.yml

@@ -29,3 +29,9 @@ Metrics/ModuleLength:
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CHANGELOG.md

@@ -147,3 +147,13 @@
 - 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

@@ -4,11 +4,13 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'logger', '~> 1.7'
 gem 'openssl'
 gem 'prometheus-client', '~> 4.1'
 
 group :test do
   gem 'minitest', '~> 5.0'
+  gem 'ostruct', '~> 0.6.3'
   gem 'rake', '~> 13.0'
   gem 'rubocop', '~> 1.21'
   gem 'simplecov', '~> 0.21.2'

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/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

@@ -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/macaw.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+require_relative 'errors/endpoint_not_mapped_error'
+require_relative 'middlewares/prometheus_middleware'
+require_relative 'data_filters/request_data_filtering'
+require_relative 'middlewares/memory_invalidation_middleware'
+require_relative 'core/cron_runner'
+require_relative 'core/thread_server'
+require_relative 'version'
+require 'prometheus/client'
+require 'securerandom'
+require 'singleton'
+require 'pathname'
+require 'logger'
+require 'socket'
+require 'json'
+
+##
+# Main module for all Macaw classes
+module MacawFramework; end
+
+##
+# Class responsible for creating endpoints and
+# starting the web server.
+class MacawFramework::Macaw
+  attr_reader :routes, :macaw_log, :config, :jobs, :cached_methods, :secure_header, :session
+  attr_accessor :port, :bind, :threads
+
+  ##
+  # Initialize Macaw Class
+  # @param {Logger} custom_log
+  # @param {ThreadServer} server
+  # @param {String?} dir
+  def initialize(custom_log: Logger.new($stdout), server: ThreadServer, dir: nil)
+    apply_options(custom_log)
+    create_endpoint_public_files(dir)
+    setup_default_configs
+    @server_class = server
+  end
+
+  ##
+  # Creates a GET endpoint associated
+  # 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
+  ##
+  def get(path, cache: [], &block)
+    map_new_endpoint('get', cache, path, &block)
+  end
+
+  ##
+  # Creates a POST endpoint associated
+  # with the respective path.
+  # @param {String} path
+  # @param {Boolean} cache
+  # @param {Proc} block
+  # @example
+  #
+  #   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)
+  end
+
+  ##
+  # Creates a PUT endpoint associated
+  # with the respective path.
+  # @param {String} path
+  # @param {Proc} block
+  # @example
+  #
+  #   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)
+  end
+
+  ##
+  # Creates a PATCH endpoint associated
+  # with the respective path.
+  # @param {String} path
+  # @param {Proc} block
+  # @example
+  #
+  #   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)
+  end
+
+  ##
+  # Creates a DELETE endpoint associated
+  # with the respective path.
+  # @param {String} path
+  # @param {Proc} block
+  # @example
+  #
+  #   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)
+  end
+
+  ##
+  # 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 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 ||= []
+    @cron_runner.start_cron_job_thread(interval, start_delay, job_name, &block)
+    @jobs << job_name
+  end
+
+  ##
+  # Starts the web server
+  def start!
+    if @macaw_log.nil?
+      puts('---------------------------------')
+      puts("Starting server at port #{@port}")
+      puts("Number of threads: #{@threads}")
+      puts('---------------------------------')
+    else
+      @macaw_log.info('---------------------------------')
+      @macaw_log.info("Starting server at port #{@port}")
+      @macaw_log.info("Number of threads: #{@threads}")
+      @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.shutdown
+      puts('Macaw stop flying for some seeds...')
+    else
+      @macaw_log.info('Stopping server')
+      @server.shutdown
+      @macaw_log.info('Macaw stop flying for some seeds...')
+    end
+  end
+
+  ##
+  # This method is intended to start the framework
+  # without an web server. This can be useful when
+  # 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')
+    loop { sleep(3600) }
+  rescue Interrupt
+    @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'
+    @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)
+    server.run
+  end
+
+  def map_new_endpoint(prefix, cache, path, &block)
+    @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] == '/' ? '' : '/'
+    @macaw_log&.info("Defining #{prefix.upcase} endpoint at #{slash}#{path}")
+    define_singleton_method("#{prefix}.#{path_clean}", block || lambda {
+      |context = { headers: {}, body: '', params: {} }|
+    })
+    @routes << "#{prefix}.#{path_clean}"
+  end
+
+  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?)
+    file_paths.map { |path| "public/#{path.relative_path_from(folder_path)}" }
+  end
+
+  def create_endpoint_public_files(dir)
+    get_files_public_folder(dir).each do |file|
+      get(file) { |_context| return File.read(file).to_s, 200, {} }
+    end
+  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.3'
 end

data/lib/macaw_framework.rb

@@ -1,348 +1,8 @@
 # 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 'singleton'
-require 'pathname'
-require 'logger'
-require 'socket'
-require 'json'
+##
+# Main module for all Macaw classes
+module MacawFramework; end
 
-module MacawFramework
-  ##
-  # Class responsible for creating endpoints and
-  # starting the web server.
-  class Macaw
-    attr_reader :routes, :macaw_log, :config, :jobs, :cached_methods, :secure_header, :session
-    attr_accessor :port, :bind, :threads
-
-    ##
-    # Initialize Macaw Class
-    # @param {Logger} custom_log
-    # @param {ThreadServer} server
-    # @param {String?} dir
-    def initialize(custom_log: Logger.new($stdout), server: ThreadServer, dir: nil)
-      apply_options(custom_log)
-      create_endpoint_public_files(dir)
-      setup_default_configs
-      @server_class = server
-    end
-
-    ##
-    # Creates a GET endpoint associated
-    # 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
-    ##
-    def get(path, cache: [], &block)
-      map_new_endpoint('get', cache, path, &block)
-    end
-
-    ##
-    # Creates a POST endpoint associated
-    # with the respective path.
-    # @param {String} path
-    # @param {Boolean} cache
-    # @param {Proc} block
-    # @example
-    #
-    #   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)
-    end
-
-    ##
-    # Creates a PUT endpoint associated
-    # with the respective path.
-    # @param {String} path
-    # @param {Proc} block
-    # @example
-    #
-    #   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)
-    end
-
-    ##
-    # Creates a PATCH endpoint associated
-    # with the respective path.
-    # @param {String} path
-    # @param {Proc} block
-    # @example
-    #
-    #   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)
-    end
-
-    ##
-    # Creates a DELETE endpoint associated
-    # with the respective path.
-    # @param {String} path
-    # @param {Proc} block
-    # @example
-    #
-    #   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)
-    end
-
-    ##
-    # 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 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 ||= []
-      @cron_runner.start_cron_job_thread(interval, start_delay, job_name, &block)
-      @jobs << job_name
-    end
-
-    ##
-    # Starts the web server
-    def start!
-      if @macaw_log.nil?
-        puts('---------------------------------')
-        puts("Starting server at port #{@port}")
-        puts("Number of threads: #{@threads}")
-        puts('---------------------------------')
-      else
-        @macaw_log.info('---------------------------------')
-        @macaw_log.info("Starting server at port #{@port}")
-        @macaw_log.info("Number of threads: #{@threads}")
-        @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...')
-      else
-        @macaw_log.info('Stopping server')
-        @server.close
-        @macaw_log.info('Macaw stop flying for some seeds...')
-      end
-    end
-
-    ##
-    # This method is intended to start the framework
-    # without an web server. This can be useful when
-    # 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')
-      loop { sleep(3600) }
-    rescue Interrupt
-      @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'
-      @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)
-      server.run
-    end
-
-    def map_new_endpoint(prefix, cache, path, &block)
-      @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] == '/' ? '' : '/'
-      @macaw_log&.info("Defining #{prefix.upcase} endpoint at #{slash}#{path}")
-      define_singleton_method("#{prefix}.#{path_clean}", block || lambda {
-        |context = { headers: {}, body: '', params: {} }|
-      })
-      @routes << "#{prefix}.#{path_clean}"
-    end
-
-    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?)
-      file_paths.map { |path| "public/#{path.relative_path_from(folder_path)}" }
-    end
-
-    def create_endpoint_public_files(dir)
-      get_files_public_folder(dir).each do |file|
-        get(file) { |_context| return File.read(file).to_s, 200, {} }
-      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
+require_relative 'macaw_framework/macaw'
+require_relative 'macaw_framework/cache'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Aria Diniz
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -46,6 +45,7 @@ files:
 - lib/macaw_framework/aspects/cache_aspect.rb
 - lib/macaw_framework/aspects/logging_aspect.rb
 - lib/macaw_framework/aspects/prometheus_aspect.rb
+- lib/macaw_framework/cache.rb
 - lib/macaw_framework/core/common/server_base.rb
 - lib/macaw_framework/core/cron_runner.rb
 - lib/macaw_framework/core/thread_server.rb
@@ -54,6 +54,7 @@ files:
 - lib/macaw_framework/data_filters/response_data_filter.rb
 - lib/macaw_framework/errors/endpoint_not_mapped_error.rb
 - lib/macaw_framework/errors/too_many_requests_error.rb
+- lib/macaw_framework/macaw.rb
 - lib/macaw_framework/middlewares/memory_invalidation_middleware.rb
 - lib/macaw_framework/middlewares/prometheus_middleware.rb
 - lib/macaw_framework/middlewares/rate_limiter_middleware.rb
@@ -76,7 +77,6 @@ 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: 
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A lightweight back-end web framework
 test_files: []