macaw_framework 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d6b667252e1efbbe7114b4450c894f15e33721d7686c2455108e99a7211e385
-  data.tar.gz: 07f927d324da0be33031108bc85c564f1a62bd42de7b5a017cf3bfca05dee992
+  metadata.gz: d900a18480da4792dfa03608ca8c85c0d0ba4084a3430c39008f4ca026ae784c
+  data.tar.gz: e3bc35f7b78bc0a6e995c0abd906879dda434e4c12306d3d55713c35dc45065c
 SHA512:
-  metadata.gz: db686066c7e051021c0d088b715a9509bc65f08ea07d53bf7790c786c2da6c27c85f6a47b2bf7f4c39521f78e9439a63152aa077108cc708e6758205dc2931fa
-  data.tar.gz: 64e5602bab74ed50d94da1935222c9d86a4c7fce04026061d7ac2585ba146959eb9b108b2db142d15a4f658de8aa67f8cdeca3577096bad1add1192015f7f592
+  metadata.gz: 6ac4eb646bb2510fbc67ddec9ccfca45bea8dfcb6833f9e55b60f0f18d5edebaf392645c53dae7745eec797c926af1700c273516682bd6f10e66c2b018f1cea6
+  data.tar.gz: 0ecb2e16a9f1762833751bb403d824e04571c4f3b79f01355ffb6f1f29eb29c234befc759c7d76d7b939f05d5f9f3c252d8a5828198e9c7674b7854fe2edcdf1

data/.rubocop.yml

@@ -17,3 +17,6 @@ Metrics/MethodLength:
 
 Metrics/AbcSize:
   Max: 35
+
+Metrics/CyclomaticComplexity:
+  Max: 10

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "simplecov", "~> 0.22.0"

data/README.md

@@ -1,5 +1,7 @@
 # MacawFramework
 
+<img src="macaw_logo.png" alt= “” style="width: 30%;height: 30%;margin-left: 35%">
+
 This is a framework for developing web applications. Please have in mind that this is still a work in progress and
 it is strongly advised to not use it for production purposes for now. Actualy it supports only HTTP. HTTPS and SSL
 support will be implemented soon. Anyone who wishes to contribute is welcome.
@@ -26,7 +28,8 @@ in the same directory of the script that will start the application with the fol
 {
   "macaw": {
     "port": 8080,
-    "bind": "localhost"
+    "bind": "localhost",
+    "threads": 10
   }
 }
 ```
@@ -39,7 +42,10 @@ require 'json'
 
 m = MacawFramework::Macaw.new
 
-m.get('/hello_world') do |headers, body, parameters|
+m.get('/hello_world') do |context|
+  context[:body] # Returns the request body as string
+  context[:params] # Returns query parameters and path variables as a hash
+  context[:headers] # Returns headers as a hash
   return JSON.pretty_generate({ hello_message: 'Hello World!' }), 200
 end
 

data/lib/macaw_framework/middlewares/request_data_filtering.rb

@@ -1,24 +1,62 @@
 # frozen_string_literal: true
 
+require_relative "../errors/endpoint_not_mapped_error"
+
 ##
 # Module containing methods to filter Strings
 module RequestDataFiltering
+  VARIABLE_PATTERN = %r{:[^/]+}.freeze
+
   ##
   # Method responsible for extracting information
   # provided by the client like Headers and Body
-  def self.parse_request_data(client)
+  def self.parse_request_data(client, routes)
     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)
     [path, method_name, headers, body, parameters]
   end
 
+  def self.select_path(method_name, routes, parameters)
+    return method_name if routes.include?(method_name)
+
+    selected_route = nil
+    routes.each do |route|
+      split_route = route.split(".")
+      split_name = method_name.split(".")
+
+      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
+      end
+      break
+    end
+
+    raise EndpointNotMappedError if selected_route.nil?
+
+    selected_route
+  end
+
+  def self.match_path_with_route(split_path, split_route)
+    split_route.each_with_index do |var, index|
+      return false if var != split_path[index] && !var.match?(VARIABLE_PATTERN)
+    end
+
+    true
+  end
+
   ##
   # 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 = path.gsub("/", ".").strip.downcase
     method_name.gsub!(" ", "")
     method_name
   end
@@ -26,7 +64,7 @@ module RequestDataFiltering
   ##
   # Method responsible for extracting the path from URI
   def self.extract_path(path)
-    path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
+    path[0] == "/" ? path[1..].gsub("/", ".") : path.gsub("/", ".")
   end
 
   ##

data/lib/macaw_framework/middlewares/server.rb

@@ -16,49 +16,70 @@ class Server
   # @param {Logger} logger
   # @param {Integer} port
   # @param {String} bind
+  # @param {Integer} num_threads
   # @return {Server}
-  def initialize(macaw, logger, port, bind)
+  def initialize(macaw, logger, port, bind, num_threads)
     @port = port
     @bind = bind
     @macaw = macaw
     @macaw_log = logger
+    @num_threads = num_threads
+    @work_queue = Queue.new
+    @workers = []
   end
 
   ##
   # Start running the webserver.
   def run
     @server = TCPServer.new(@bind, @port)
-    loop do
-      Thread.start(@server.accept) do |client|
-        path, method_name, headers, body, parameters = RequestDataFiltering.parse_request_data(client)
-        raise EndpointNotMappedError unless @macaw.respond_to?(method_name)
+    @num_threads.times do
+      @workers << Thread.new do
+        loop do
+          client = @work_queue.pop
+          break if client == :shutdown
 
-        @macaw_log.info("Running #{path.gsub("\n", "").gsub("\r", "")}")
-        message, status = call_endpoint(@macaw_log, method_name, headers, body, parameters)
-        status ||= 200
-        message ||= "Ok"
-        client.puts "HTTP/1.1 #{status} #{HTTP_STATUS_CODE_MAP[status]} \r\n\r\n#{message}"
-        client.close
-      rescue EndpointNotMappedError
-        client.print "HTTP/1.1 404 Not Found\r\n\r\n"
-        client.close
-      rescue StandardError => e
-        client.print "HTTP/1.1 500 Internal Server Error\r\n\r\n"
-        @macaw_log.info("Error: #{e}")
-        client.close
+          handle_client(client)
+        end
       end
     end
+
+    loop do
+      @work_queue << @server.accept
+    rescue IOError, Errno::EBADF
+      break
+    end
   end
 
   ##
   # Method Responsible for closing the TCP server.
   def close
     @server.close
+    @num_threads.times { @work_queue << :shutdown }
+    @workers.each(&:join)
   end
 
   private
 
-  def call_endpoint(name, *arg_array)
-    @macaw.send(name.to_sym, *arg_array)
+  def handle_client(client)
+    path, method_name, headers, body, parameters = RequestDataFiltering.parse_request_data(client, @macaw.routes)
+    raise EndpointNotMappedError unless @macaw.respond_to?(method_name)
+
+    @macaw_log.info("Running #{path.gsub("\n", "").gsub("\r", "")}")
+    message, status = call_endpoint(@macaw_log, method_name, headers, body, parameters)
+    status ||= 200
+    message ||= "Ok"
+    client.puts "HTTP/1.1 #{status} #{HTTP_STATUS_CODE_MAP[status]} \r\n\r\n#{message}"
+    client.close
+  rescue EndpointNotMappedError
+    client.print "HTTP/1.1 404 Not Found\r\n\r\n"
+    client.close
+  rescue StandardError => e
+    client.print "HTTP/1.1 500 Internal Server Error\r\n\r\n"
+    @macaw_log.info("Error: #{e}")
+    client.close
+  end
+
+  def call_endpoint(name, headers, body, parameters)
+    @macaw.send(name.to_sym, { headers: headers, body: body, params: parameters })
   end
 end

data/lib/macaw_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MacawFramework
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/macaw_framework.rb

@@ -13,20 +13,27 @@ module MacawFramework
   # Class responsible for creating endpoints and
   # starting the web server.
   class Macaw
+    ##
+    # Array containing the routes defined in the application
+    attr_reader :routes
+
     ##
     # @param {Logger} custom_log
     def initialize(custom_log: nil, server: Server)
       begin
+        @routes = []
         @macaw_log ||= custom_log.nil? ? Logger.new($stdout) : custom_log
         config = JSON.parse(File.read("application.json"))
         @port = config["macaw"]["port"]
         @bind = config["macaw"]["bind"]
+        @threads = config["macaw"]["threads"].to_i
       rescue StandardError => e
         @macaw_log.error(e.message)
       end
       @port ||= 8080
       @bind ||= "localhost"
-      @server = server.new(self, @macaw_log, @port, @bind)
+      @threads ||= 5
+      @server = server.new(self, @macaw_log, @port, @bind, @threads)
     end
 
     ##
@@ -82,9 +89,10 @@ module MacawFramework
     ##
     # Starts the web server
     def start!
+      @macaw_log.info("---------------------------------")
       @macaw_log.info("Starting server at port #{@port}")
-      time = Time.now
-      @macaw_log.info("Server started in #{Time.now - time} seconds.")
+      @macaw_log.info("Number of threads: #{@threads}")
+      @macaw_log.info("---------------------------------")
       server_loop(@server)
     rescue Interrupt
       @macaw_log.info("Stopping server")
@@ -101,7 +109,10 @@ module MacawFramework
     def map_new_endpoint(prefix, path, &block)
       path_clean = RequestDataFiltering.extract_path(path)
       @macaw_log.info("Defining #{prefix.upcase} endpoint at /#{path}")
-      define_singleton_method("#{prefix}_#{path_clean}", block)
+      define_singleton_method("#{prefix}.#{path_clean}", block || lambda {
+        |context = { headers: {}, body: "", params: {} }|
+                                                         })
+      @routes << "#{prefix}.#{path_clean}"
     end
   end
 end

data/sig/macaw_framework/macaw.rbs

@@ -6,6 +6,10 @@ module MacawFramework
 
     @server: Server
 
+    @threads: Integer
+
+    attr_reader routes: Array[String]
+
     def delete: -> nil
 
     def get: -> nil

data/sig/request_data_filtering.rbs

@@ -0,0 +1,3 @@
+module RequestDataFiltering
+  VARIABLE_PATTERN: Regexp
+end

data/sig/server.rbs

@@ -2,10 +2,17 @@ class Server
   @bind: String
   @macaw: MacawFramework::Macaw
   @macaw_log: Logger
+  @num_threads: Integer
   @port: Integer
 
   @server: TCPServer
 
+  @threads: Integer
+
+  @work_queue: Thread::Queue
+
+  @workers: Array[Thread]
+
   def close: -> nil
 
   def run: -> nil
@@ -13,4 +20,6 @@ class Server
   private
 
   def call_endpoint: -> Array[untyped]
+
+  def handle_client: -> nil
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies: []
 description: A project started for study purpose that I intend to keep working on.
 email:
@@ -31,10 +31,12 @@ files:
 - lib/macaw_framework/middlewares/server.rb
 - lib/macaw_framework/utils/http_status_code.rb
 - lib/macaw_framework/version.rb
+- macaw_logo.png
 - sig/http_status_code.rbs
 - sig/logging_aspect.rbs
 - sig/macaw_framework.rbs
 - sig/macaw_framework/macaw.rbs
+- sig/request_data_filtering.rbs
 - sig/server.rbs
 homepage: https://github.com/ariasdiniz/macaw_framework
 licenses: