macaw_framework 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 512b14576a1be6337300fc758b7be6acf48603fa605c0d60c21d494b2d411a10
-  data.tar.gz: 29f0115f9e93539c740e56834515d7d66dd768a2b5a8c5ef2668beb82d403fa5
+  metadata.gz: 8d6b667252e1efbbe7114b4450c894f15e33721d7686c2455108e99a7211e385
+  data.tar.gz: 07f927d324da0be33031108bc85c564f1a62bd42de7b5a017cf3bfca05dee992
 SHA512:
-  metadata.gz: aa4dd23ceaa6579ab7f0b77caa42b8745fb48f830aa8f5db9eb713bff5330d1879653209781e888c873b071c45b11afd5744282401d77c9c7609c0ed9f721e4b
-  data.tar.gz: 2cc30aff12830763c3e9a19c8597fa4cd5f8e8ec7bfc1201f5c367883e93c480cef243d2590725084b62922538e6e27798f53840df0660b8872e09be01336f8a
+  metadata.gz: db686066c7e051021c0d088b715a9509bc65f08ea07d53bf7790c786c2da6c27c85f6a47b2bf7f4c39521f78e9439a63152aa077108cc708e6758205dc2931fa
+  data.tar.gz: 64e5602bab74ed50d94da1935222c9d86a4c7fce04026061d7ac2585ba146959eb9b108b2db142d15a4f658de8aa67f8cdeca3577096bad1add1192015f7f592

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +11,9 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 35

data/CHANGELOG.md

@@ -14,3 +14,13 @@
 - Adding logs to the framework activity
 - Removing undefined Status Codes from http_status_code hash
 - Moving methods from Macaw class to RequestDataFiltering module, respecting SOLID
+
+## [0.1.3] - 2022-12-13
+
+- Adding logger gem to Macaw class to fix a bug on the application start
+
+## [0.1.4] - 2023-04-09
+
+- Adding log by aspect on endpoint calls to improve observability
+- Moving the server for a new separate class to respect single responsibility
+- Improved the data filtering middleware to sanitize inputs

data/README.md

@@ -1,7 +1,8 @@
 # MacawFramework
 
 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. Anyone who wishes to contribute is welcome.
+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.
 
 ## Installation
 
@@ -24,7 +25,8 @@ in the same directory of the script that will start the application with the fol
 ```json
 {
   "macaw": {
-    "port": 80
+    "port": 8080,
+    "bind": "localhost"
   }
 }
 ```

data/lib/macaw_framework/aspects/logging_aspect.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "logger"
+
+##
+# This Aspect is responsible for logging
+# the input and output of every endpoint called
+# in the framework.
+module LoggingAspect
+  def call_endpoint(logger, *args)
+    logger.info("Input of #{args[0]}: #{args}")
+    response = super(*args)
+    logger.info("Output of #{args[0]} #{response}")
+    response
+  end
+end

data/lib/macaw_framework/{endpoint_not_mapped_error.rb → 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/{request_data_filtering.rb → middlewares/request_data_filtering.rb}

@@ -6,19 +6,27 @@ module RequestDataFiltering
   ##
   # Method responsible for extracting information
   # provided by the client like Headers and Body
-  def self.extract_client_info(client)
-    path, parameters = extract_url_parameters(client.gets.gsub('HTTP/1.1', ''))
-    method_name = path.gsub('/', '_').strip!.downcase
-    method_name.gsub!(' ', '')
+  def self.parse_request_data(client)
+    path, parameters = extract_url_parameters(client.gets.gsub("HTTP/1.1", ""))
+    method_name = sanitize_method_name(path)
     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
 
+  ##
+  # 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
+  end
+
   ##
   # 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
 
   ##
@@ -27,8 +35,8 @@ module RequestDataFiltering
     header = client.gets.delete("\n").delete("\r")
     headers = {}
     while header.match(%r{[a-zA-Z0-9\-/*]*: [a-zA-Z0-9\-/*]})
-      split_header = header.split(':')
-      headers[split_header[0]] = split_header[1][1..]
+      split_header = header.split(":")
+      headers[split_header[0].strip] = split_header[1].strip
       header = client.gets.delete("\n").delete("\r")
     end
     [header, headers]
@@ -46,15 +54,28 @@ 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[0] => split_item[1].gsub("\n", '').gsub("\r", '').gsub("\s", '') }
+      split_item = item.split("=")
+      { sanitize_parameter_name(split_item[0]) => sanitize_parameter_value(split_item[1]) }
     end
     parameters = {}
     parameters_array.each { |item| parameters.merge!(item) }
     [path, parameters]
   end
+
+  ##
+  # Method responsible for sanitizing the parameter name
+  def self.sanitize_parameter_name(name)
+    name.gsub(/[^\w\s]/, "")
+  end
+
+  ##
+  # Method responsible for sanitizing the parameter value
+  def self.sanitize_parameter_value(value)
+    value.gsub(/[^\w\s]/, "")
+    value.gsub(/[\r\n\s]/, "")
+  end
 end

data/lib/macaw_framework/middlewares/server.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "../aspects/logging_aspect"
+require_relative "../utils/http_status_code"
+
+##
+# Class responsible for providing a default
+# webserver.
+class Server
+  prepend LoggingAspect
+  include HttpStatusCode
+
+  ##
+  # Create a new instance of Server.
+  # @param {Macaw} macaw
+  # @param {Logger} logger
+  # @param {Integer} port
+  # @param {String} bind
+  # @return {Server}
+  def initialize(macaw, logger, port, bind)
+    @port = port
+    @bind = bind
+    @macaw = macaw
+    @macaw_log = logger
+  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)
+
+        @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
+    end
+  end
+
+  ##
+  # Method Responsible for closing the TCP server.
+  def close
+    @server.close
+  end
+
+  private
+
+  def call_endpoint(name, *arg_array)
+    @macaw.send(name.to_sym, *arg_array)
+  end
+end

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "macaw_framework/endpoint_not_mapped_error"
-require_relative "macaw_framework/request_data_filtering"
-require_relative "macaw_framework/http_status_code"
+require_relative "macaw_framework/errors/endpoint_not_mapped_error"
+require_relative "macaw_framework/middlewares/request_data_filtering"
+require_relative "macaw_framework/middlewares/server"
 require_relative "macaw_framework/version"
+require "logger"
 require "socket"
 require "json"
 
@@ -12,18 +13,20 @@ module MacawFramework
   # Class responsible for creating endpoints and
   # starting the web server.
   class Macaw
-    include(HttpStatusCode)
     ##
     # @param {Logger} custom_log
-    def initialize(custom_log = nil)
+    def initialize(custom_log: nil, server: Server)
       begin
-        config = JSON.parse(File.read('application.json'))
-        @port = config['macaw']['port']
-      rescue StandardError
-        @port ||= 8080
+        @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"]
+      rescue StandardError => e
+        @macaw_log.error(e.message)
       end
       @port ||= 8080
-      @macaw_log ||= custom_log.nil? ? Logger.new($stdout) : custom_log
+      @bind ||= "localhost"
+      @server = server.new(self, @macaw_log, @port, @bind)
     end
 
     ##
@@ -33,9 +36,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {Integer, String}
     def get(path, &block)
-      path_clean = RequestDataFiltering.extract_path(path)
-      @macaw_log.info("Defining GET endpoint at #{path_clean}")
-      map_new_endpoint('get', path_clean, &block)
+      map_new_endpoint("get", path, &block)
     end
 
     ##
@@ -45,9 +46,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def post(path, &block)
-      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      @macaw_log.info("Defining POST endpoint at #{path_clean}")
-      map_new_endpoint('post', path_clean, &block)
+      map_new_endpoint("post", path, &block)
     end
 
     ##
@@ -57,9 +56,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def put(path, &block)
-      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      @macaw_log.info("Defining PUT endpoint at #{path_clean}")
-      map_new_endpoint('put', path_clean, &block)
+      map_new_endpoint("put", path, &block)
     end
 
     ##
@@ -69,9 +66,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def patch(path, &block)
-      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      @macaw_log.info("Defining PATCH endpoint at #{path_clean}")
-      map_new_endpoint('patch', path_clean, &block)
+      map_new_endpoint("patch", path, &block)
     end
 
     ##
@@ -81,9 +76,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def delete(path, &block)
-      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      @macaw_log.info("Defining DELETE endpoint at #{path_clean}")
-      map_new_endpoint('delete', path_clean, &block)
+      map_new_endpoint("delete", path, &block)
     end
 
     ##
@@ -91,38 +84,24 @@ module MacawFramework
     def start!
       @macaw_log.info("Starting server at port #{@port}")
       time = Time.now
-      server = TCPServer.open(@port)
       @macaw_log.info("Server started in #{Time.now - time} seconds.")
-      loop do
-        Thread.start(server.accept) do |client|
-          path, method_name, headers, body, parameters = RequestDataFiltering.extract_client_info(client)
-          raise EndpointNotMappedError unless respond_to?(method_name)
-
-          @macaw_log.info("Running #{path.gsub("\n", '').gsub("\r", '')}")
-          message, status = send(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
-      end
+      server_loop(@server)
     rescue Interrupt
-      @macaw_log.info('Stopping server')
-      server.close
-      @macaw_log.info('Macaw stop flying for some seeds...')
+      @macaw_log.info("Stopping server")
+      @server.close
+      @macaw_log.info("Macaw stop flying for some seeds...")
     end
 
     private
 
+    def server_loop(server)
+      server.run
+    end
+
     def map_new_endpoint(prefix, path, &block)
-      define_singleton_method("#{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)
     end
   end
 end

data/sig/logging_aspect.rbs

@@ -0,0 +1,3 @@
+module LoggingAspect
+  def call_endpoint: -> Array[untyped]
+end

data/sig/macaw_framework/macaw.rbs

@@ -1,7 +1,11 @@
 module MacawFramework
   class Macaw
+    @bind: string
+    @macaw_log: Logger
     @port: int
 
+    @server: Server
+
     def delete: -> nil
 
     def get: -> nil

data/sig/server.rbs

@@ -0,0 +1,16 @@
+class Server
+  @bind: String
+  @macaw: MacawFramework::Macaw
+  @macaw_log: Logger
+  @port: Integer
+
+  @server: TCPServer
+
+  def close: -> nil
+
+  def run: -> nil
+
+  private
+
+  def call_endpoint: -> Array[untyped]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-11 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies: []
 description: A project started for study purpose that I intend to keep working on.
 email:
@@ -25,13 +25,17 @@ files:
 - README.md
 - Rakefile
 - lib/macaw_framework.rb
-- lib/macaw_framework/endpoint_not_mapped_error.rb
-- lib/macaw_framework/http_status_code.rb
-- lib/macaw_framework/request_data_filtering.rb
+- lib/macaw_framework/aspects/logging_aspect.rb
+- lib/macaw_framework/errors/endpoint_not_mapped_error.rb
+- lib/macaw_framework/middlewares/request_data_filtering.rb
+- lib/macaw_framework/middlewares/server.rb
+- lib/macaw_framework/utils/http_status_code.rb
 - lib/macaw_framework/version.rb
 - sig/http_status_code.rbs
+- sig/logging_aspect.rbs
 - sig/macaw_framework.rbs
 - sig/macaw_framework/macaw.rbs
+- sig/server.rbs
 homepage: https://github.com/ariasdiniz/macaw_framework
 licenses:
 - MIT
@@ -54,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A web framework still in development.