macaw_framework 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20f895377b3f0eea2494e091fab22b81734f6625d840ed2414c557db4db29ac2
-  data.tar.gz: 0ce55bbbbb41a5da4ab1622c72ced7300bfc4cb8b75091702fffb21822415ce2
+  metadata.gz: 512b14576a1be6337300fc758b7be6acf48603fa605c0d60c21d494b2d411a10
+  data.tar.gz: 29f0115f9e93539c740e56834515d7d66dd768a2b5a8c5ef2668beb82d403fa5
 SHA512:
-  metadata.gz: 033b20344e924fb6cf66a75df40dd18fcee89967738392529b7f6dbab02e7301af275156d81a5601222428a03ae9796af751b048ab09632debfe87fcc5c86516
-  data.tar.gz: c2c09a27334e8904f2b7e714a6ac71df95140fe7e088ddcf23e71a29a125c0cc72cce2395939ce18d2e5ebb3998fb28c8a8a0a912de99c9e070004a0b78483a9
+  metadata.gz: aa4dd23ceaa6579ab7f0b77caa42b8745fb48f830aa8f5db9eb713bff5330d1879653209781e888c873b071c45b11afd5744282401d77c9c7609c0ed9f721e4b
+  data.tar.gz: 2cc30aff12830763c3e9a19c8597fa4cd5f8e8ec7bfc1201f5c367883e93c480cef243d2590725084b62922538e6e27798f53840df0660b8872e09be01336f8a

data/CHANGELOG.md

@@ -3,3 +3,14 @@
 ## [0.1.0] - 2022-12-05
 
 - Initial release
+
+## [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

data/README.md

@@ -35,9 +35,9 @@ Example of usage:
 require 'macaw_framework'
 require 'json'
 
-m = Macaw.new
+m = MacawFramework::Macaw.new
 
-m.get('/hello_world') do
+m.get('/hello_world') do |headers, body, parameters|
   return JSON.pretty_generate({ hello_message: 'Hello World!' }), 200
 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.0"
+  VERSION = "0.1.2"
 end

data/lib/macaw_framework.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'macaw_framework/endpoint_not_mapped_error'
-require_relative 'macaw_framework/http_status_code'
-require_relative 'macaw_framework/version'
-require 'socket'
-require 'json'
+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 "socket"
+require "json"
 
 module MacawFramework
   ##
@@ -12,7 +13,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 +23,7 @@ module MacawFramework
         @port ||= 8080
       end
       @port ||= 8080
+      @macaw_log ||= custom_log.nil? ? Logger.new($stdout) : custom_log
     end
 
     ##
@@ -29,8 +33,9 @@ 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)
+      path_clean = RequestDataFiltering.extract_path(path)
+      @macaw_log.info("Defining GET endpoint at #{path_clean}")
+      map_new_endpoint('get', path_clean, &block)
     end
 
     ##
@@ -41,7 +46,8 @@ module MacawFramework
     # @return {String, Integer}
     def post(path, &block)
       path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      define_singleton_method("post_#{path_clean}", block)
+      @macaw_log.info("Defining POST endpoint at #{path_clean}")
+      map_new_endpoint('post', path_clean, &block)
     end
 
     ##
@@ -52,7 +58,8 @@ module MacawFramework
     # @return {String, Integer}
     def put(path, &block)
       path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      define_singleton_method("put_#{path_clean}", block)
+      @macaw_log.info("Defining PUT endpoint at #{path_clean}")
+      map_new_endpoint('put', path_clean, &block)
     end
 
     ##
@@ -63,7 +70,8 @@ module MacawFramework
     # @return {String, Integer}
     def patch(path, &block)
       path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      define_singleton_method("patch_#{path_clean}", block)
+      @macaw_log.info("Defining PATCH endpoint at #{path_clean}")
+      map_new_endpoint('patch', path_clean, &block)
     end
 
     ##
@@ -74,20 +82,24 @@ module MacawFramework
     # @return {String, Integer}
     def delete(path, &block)
       path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
-      define_singleton_method("delete_#{path_clean}", block)
+      @macaw_log.info("Defining DELETE endpoint at #{path_clean}")
+      map_new_endpoint('delete', path_clean, &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.")
       loop do
         Thread.start(server.accept) do |client|
-          method_name = 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)
+          @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}"
@@ -95,23 +107,22 @@ 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
+      @macaw_log.info('Stopping server')
+      server.close
+      @macaw_log.info('Macaw stop flying for some seeds...')
     end
 
     private
 
-    ##
-    # Method for extracting headers and body from client request
-    # STILL IN DEVELOPMENT
-    # @todo finish implementation
-    def extract_client_info(client)
-      method_name = client.gets.gsub('HTTP/1.1', '').gsub('/', '_').strip!.downcase
-      method_name.gsub!(' ', '')
-      method_name
+    def map_new_endpoint(prefix, path, &block)
+      define_singleton_method("#{prefix}_#{path}", block)
     end
   end
 end

data/sig/http_status_code.rbs

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

data/sig/macaw_framework/macaw.rbs

@@ -16,6 +16,10 @@ module MacawFramework
 
     private
 
+    def extract_body: -> string
+
     def extract_client_info: -> nil
+
+    def extract_headers: -> string
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies: []
 description: A project started for study purpose that I intend to keep working on.
 email:
@@ -27,13 +27,16 @@ 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
 licenses:
 - MIT
 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: 
@@ -44,7 +47,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="