macaw_framework 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2934b530ed442004aaecbd13430dc250fe2fde52c2b9abf2e0f95eed6c606a
-  data.tar.gz: 8989aaff7cf4be554e18edb4cee3928b918c263b35cbb9886f9df94ef8a5b0f9
+  metadata.gz: 46f8af6ed22b7980942f7ec3def269395d1e65e9c7bfd06a96d161c31666997d
+  data.tar.gz: 258e71f4b693c410c325e7a7751f8a2702e3b2db814752d0de39566fa1b94576
 SHA512:
-  metadata.gz: 04ac3f80610994da626fef59bd5554bc2535c693357bca3fe8891170478cdf7b65af4552c83b8532c40ae704e6d50fafe9457afa2c03b6177080742e15e11611
-  data.tar.gz: 245ef53c503e22eea1c2f5a3e4a8a8ccf48a7444cba36c393fed048973415d1ff4dea8bba53c3bb5dd892422898e0284ca8a6d3b3f70ddaed0c3823d191df792
+  metadata.gz: cc2b8fbd4d25b795df95a47025b7465b3cfb6bd340008bebdfe527232a009bad959e25f9c4528b7eb4ce98f14f6148a47dd44e56b19b4d4c23187a2b4a24b56c
+  data.tar.gz: 0d0f265ea93a3467718cbccd2ed93d85d0d98f9c84e53a821d3071b20243ca251e7670a788bd6e848f6381cee213c16ee8164dd27a32a2a28b77de5979a23326

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

@@ -4,6 +4,17 @@
 
 - Initial release
 
-## [0.1.0] - 2022-12-06
+## [0.1.1] - 2022-12-06
 
 - Adding support for headers and body
+
+## [0.1.2] - 2022-12-10
+
+- Adding support to URL parameters
+- 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

data/README.md

@@ -37,7 +37,7 @@ require 'json'
 
 m = MacawFramework::Macaw.new
 
-m.get('/hello_world') do |headers, body|
+m.get('/hello_world') do |headers, body, parameters|
   return JSON.pretty_generate({ hello_message: 'Hello World!' }), 200
 end
 

data/lib/macaw_framework/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/http_status_code.rb

@@ -7,69 +7,66 @@ module HttpStatusCode
   ##
   # Http Status Code Map
   HTTP_STATUS_CODE_MAP = {
-    100 => 'Continue',
-    101 => 'Switching Protocols',
-    102 => 'Processing',
-    103 => 'Early Hints',
-    200 => 'OK',
-    201 => 'Created',
-    202 => 'Accepted',
-    203 => 'Non-Authoritative Information',
-    204 => 'No Content',
-    205 => 'Reset Content',
-    206 => 'Partial Content',
-    207 => 'Multi-Status',
-    208 => 'Already Reported',
-    226 => 'IM Used',
-    300 => 'Multiple Choices',
-    301 => 'Moved Permanently',
-    302 => 'Found',
-    303 => 'See Other',
-    304 => 'Not Modified',
-    305 => 'Use Proxy',
-    307 => 'Temporary Redirect',
-    308 => 'Permanent Redirect',
-    400 => 'Bad Request',
-    401 => 'Unauthorized',
-    402 => 'Payment Required',
-    403 => 'Forbidden',
-    404 => 'Not Found',
-    405 => 'Method Not Allowed',
-    406 => 'Not Acceptable',
-    407 => 'Proxy Authentication Required',
-    408 => 'Request Timeout',
-    409 => 'Conflict',
-    410 => 'Gone',
-    411 => 'Length Required',
-    412 => 'Precondition Failed',
-    413 => 'Content Too Large',
-    414 => 'URI Too Long',
-    415 => 'Unsupported Media Type',
-    416 => 'Range Not Satisfiable',
-    417 => 'Expectation Failed',
-    421 => 'Misdirected Request',
-    422 => 'Unprocessable Content',
-    423 => 'Locked',
-    424 => 'Failed Dependency',
-    425 => 'Too Early',
-    426 => 'Upgrade Required',
-    427 => 'Unassigned',
-    428 => 'Precondition Required',
-    429 => 'Too Many Requests',
-    430 => 'Unassigned',
-    431 => 'Request Header Fields Too Large',
-    451 => 'Unavailable For Legal Reasons',
-    500 => 'Internal Server Error',
-    501 => 'Not Implemented',
-    502 => 'Bad Gateway',
-    503 => 'Service Unavailable',
-    504 => 'Gateway Timeout',
-    505 => 'HTTP Version Not Supported',
-    506 => 'Variant Also Negotiates',
-    507 => 'Insufficient Storage',
-    508 => 'Loop Detected',
-    509 => 'Unassigned',
-    510 => 'Not Extended (OBSOLETED)',
-    511 => 'Network Authentication Required'
+    100 => "Continue",
+    101 => "Switching Protocols",
+    102 => "Processing",
+    103 => "Early Hints",
+    200 => "OK",
+    201 => "Created",
+    202 => "Accepted",
+    203 => "Non-Authoritative Information",
+    204 => "No Content",
+    205 => "Reset Content",
+    206 => "Partial Content",
+    207 => "Multi-Status",
+    208 => "Already Reported",
+    226 => "IM Used",
+    300 => "Multiple Choices",
+    301 => "Moved Permanently",
+    302 => "Found",
+    303 => "See Other",
+    304 => "Not Modified",
+    305 => "Use Proxy",
+    307 => "Temporary Redirect",
+    308 => "Permanent Redirect",
+    400 => "Bad Request",
+    401 => "Unauthorized",
+    402 => "Payment Required",
+    403 => "Forbidden",
+    404 => "Not Found",
+    405 => "Method Not Allowed",
+    406 => "Not Acceptable",
+    407 => "Proxy Authentication Required",
+    408 => "Request Timeout",
+    409 => "Conflict",
+    410 => "Gone",
+    411 => "Length Required",
+    412 => "Precondition Failed",
+    413 => "Content Too Large",
+    414 => "URI Too Long",
+    415 => "Unsupported Media Type",
+    416 => "Range Not Satisfiable",
+    417 => "Expectation Failed",
+    421 => "Misdirected Request",
+    422 => "Unprocessable Content",
+    423 => "Locked",
+    424 => "Failed Dependency",
+    425 => "Too Early",
+    426 => "Upgrade Required",
+    428 => "Precondition Required",
+    429 => "Too Many Requests",
+    431 => "Request Header Fields Too Large",
+    451 => "Unavailable For Legal Reasons",
+    500 => "Internal Server Error",
+    501 => "Not Implemented",
+    502 => "Bad Gateway",
+    503 => "Service Unavailable",
+    504 => "Gateway Timeout",
+    505 => "HTTP Version Not Supported",
+    506 => "Variant Also Negotiates",
+    507 => "Insufficient Storage",
+    508 => "Loop Detected",
+    510 => "Not Extended (OBSOLETED)",
+    511 => "Network Authentication Required"
   }.freeze
 end

data/lib/macaw_framework/request_data_filtering.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+##
+# Module containing methods to filter Strings
+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!(" ", "")
+    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
+
+  ##
+  # Method responsible for extracting the path from URI
+  def self.extract_path(path)
+    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")
+    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..]
+      header = client.gets.delete("\n").delete("\r")
+    end
+    [header, headers]
+  end
+
+  ##
+  # Method responsible for extracting the body from request
+  def self.extract_body(client, body_first_line, content_length)
+    body = client.read(content_length)
+    body_first_line << body.to_s
+  end
+
+  ##
+  # Method responsible for extracting the parameters from URI
+  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 = "#{path_and_parameters[0]} "
+    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", "") }
+    end
+    parameters = {}
+    parameters_array.each { |item| parameters.merge!(item) }
+    [path, parameters]
+  end
+end

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -1,8 +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/version"
+require "logger"
 require "socket"
 require "json"
 
@@ -12,7 +14,9 @@ module MacawFramework
   # starting the web server.
   class Macaw
     include(HttpStatusCode)
-    def initialize
+    ##
+    # @param {Logger} custom_log
+    def initialize(custom_log = nil)
       begin
         config = JSON.parse(File.read("application.json"))
         @port = config["macaw"]["port"]
@@ -20,6 +24,7 @@ module MacawFramework
         @port ||= 8080
       end
       @port ||= 8080
+      @macaw_log ||= custom_log.nil? ? Logger.new($stdout) : custom_log
     end
 
     ##
@@ -29,8 +34,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {Integer, String}
     def get(path, &block)
-      path_clean = path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
-      define_singleton_method("get_#{path_clean}", block)
+      map_new_endpoint("get", path, &block)
     end
 
     ##
@@ -40,8 +44,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def post(path, &block)
-      path_clean = path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
-      define_singleton_method("post_#{path_clean}", block)
+      map_new_endpoint("post", path, &block)
     end
 
     ##
@@ -51,8 +54,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def put(path, &block)
-      path_clean = path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
-      define_singleton_method("put_#{path_clean}", block)
+      map_new_endpoint("put", path, &block)
     end
 
     ##
@@ -62,8 +64,7 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def patch(path, &block)
-      path_clean = path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
-      define_singleton_method("patch_#{path_clean}", block)
+      map_new_endpoint("patch", path, &block)
     end
 
     ##
@@ -73,22 +74,33 @@ module MacawFramework
     # @param {Proc} block
     # @return {String, Integer}
     def delete(path, &block)
-      path_clean = path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
-      define_singleton_method("delete_#{path_clean}", block)
+      map_new_endpoint("delete", path, &block)
     end
 
     ##
     # Starts the web server
     def start!
+      @macaw_log.info("Starting server at port #{@port}")
+      time = Time.now
       server = TCPServer.open(@port)
-      puts "Starting server at port #{@port}"
+      @macaw_log.info("Server started in #{Time.now - time} seconds.")
+      server_loop(server)
+    rescue Interrupt
+      @macaw_log.info("Stopping server")
+      server.close
+      @macaw_log.info("Macaw stop flying for some seeds...")
+    end
+
+    private
+
+    def server_loop(server)
       loop do
         Thread.start(server.accept) do |client|
-          client.select
-          method_name, headers, body = extract_client_info(client)
+          path, method_name, headers, body, parameters = RequestDataFiltering.extract_client_info(client)
           raise EndpointNotMappedError unless respond_to?(method_name)
 
-          message, status = send(method_name, headers, body)
+          @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}"
@@ -96,44 +108,18 @@ module MacawFramework
         rescue EndpointNotMappedError
           client.print "HTTP/1.1 404 Not Found\r\n\r\n"
           client.close
-        rescue StandardError
+        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
-    rescue Interrupt
-      puts "Macaw stop flying for some seeds..."
-    end
-
-    private
-
-    ##
-    # Method responsible for extracting information
-    # provided by the client like Headers and Body
-    def extract_client_info(client)
-      method_name = client.gets.gsub("HTTP/1.1", "").gsub("/", "_").strip!.downcase
-      method_name.gsub!(" ", "")
-      body_first_line, headers = extract_headers(client)
-      body = extract_body(client, body_first_line, headers["Content-Length"].to_i)
-      [method_name, headers, body]
-    end
-
-    ##
-    # Extract application headers
-    def extract_headers(client)
-      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..]
-        header = client.gets.delete("\n").delete("\r")
-      end
-      [header, headers]
     end
 
-    def extract_body(client, body_first_line, content_length)
-      body = client.read(content_length)
-      body_first_line << body.to_s
+    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)
     end
   end
 end

data/sig/http_status_code.rbs

@@ -0,0 +1,3 @@
+module HttpStatusCode
+  HTTP_STATUS_CODE_MAP: Hash[Integer, String]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies: []
 description: A project started for study purpose that I intend to keep working on.
 email:
@@ -27,7 +27,9 @@ files:
 - 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/version.rb
+- sig/http_status_code.rbs
 - sig/macaw_framework.rbs
 - sig/macaw_framework/macaw.rbs
 homepage: https://github.com/ariasdiniz/macaw_framework