macaw_framework 1.3.0 → 1.3.3

data/lib/macaw_framework.rb

@@ -1,233 +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 "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)
-      @port ||= 8080
-      @bind ||= "localhost"
-      @config ||= nil
-      @threads ||= 200
-      @endpoints_to_cache = []
-      @prometheus ||= nil
-      @prometheus_middleware ||= nil
-      @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 cron 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
-    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 apply_options(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)
-    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
-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.0
+  version: 1.3.3
 platform: ruby
 authors:
 - Aria Diniz
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-04 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
@@ -84,15 +84,14 @@ 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:
   - - ">="
     - !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: []