macaw_framework 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 512b14576a1be6337300fc758b7be6acf48603fa605c0d60c21d494b2d411a10
-  data.tar.gz: 29f0115f9e93539c740e56834515d7d66dd768a2b5a8c5ef2668beb82d403fa5
+  metadata.gz: 46f8af6ed22b7980942f7ec3def269395d1e65e9c7bfd06a96d161c31666997d
+  data.tar.gz: 258e71f4b693c410c325e7a7751f8a2702e3b2db814752d0de39566fa1b94576
 SHA512:
-  metadata.gz: aa4dd23ceaa6579ab7f0b77caa42b8745fb48f830aa8f5db9eb713bff5330d1879653209781e888c873b071c45b11afd5744282401d77c9c7609c0ed9f721e4b
-  data.tar.gz: 2cc30aff12830763c3e9a19c8597fa4cd5f8e8ec7bfc1201f5c367883e93c480cef243d2590725084b62922538e6e27798f53840df0660b8872e09be01336f8a
+  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

@@ -14,3 +14,7 @@
 - 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/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/request_data_filtering.rb

@@ -7,18 +7,18 @@ 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!(' ', '')
+    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)
+    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('/', '_')
+    path[0] == "/" ? path[1..].gsub("/", "_") : path.gsub("/", "_")
   end
 
   ##
@@ -27,7 +27,7 @@ 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(':')
+      split_header = header.split(":")
       headers[split_header[0]] = split_header[1][1..]
       header = client.gets.delete("\n").delete("\r")
     end
@@ -46,12 +46,12 @@ 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("=")
+      { split_item[0] => split_item[1].gsub("\n", "").gsub("\r", "").gsub("\s", "") }
     end
     parameters = {}
     parameters_array.each { |item| parameters.merge!(item) }

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -4,6 +4,7 @@ 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"
 
@@ -17,8 +18,8 @@ module MacawFramework
     # @param {Logger} custom_log
     def initialize(custom_log = nil)
       begin
-        config = JSON.parse(File.read('application.json'))
-        @port = config['macaw']['port']
+        config = JSON.parse(File.read("application.json"))
+        @port = config["macaw"]["port"]
       rescue StandardError
         @port ||= 8080
       end
@@ -33,9 +34,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 +44,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 +54,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 +64,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 +74,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
 
     ##
@@ -93,15 +84,25 @@ module MacawFramework
       time = Time.now
       server = TCPServer.open(@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|
           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", '')}")
+          @macaw_log.info("Running #{path.gsub("\n", "").gsub("\r", "")}")
           message, status = send(method_name, headers, body, parameters)
           status ||= 200
-          message ||= 'Ok'
+          message ||= "Ok"
           client.puts "HTTP/1.1 #{status} #{HTTP_STATUS_CODE_MAP[status]} \r\n\r\n#{message}"
           client.close
         rescue EndpointNotMappedError
@@ -113,16 +114,12 @@ module MacawFramework
           client.close
         end
       end
-    rescue Interrupt
-      @macaw_log.info('Stopping server')
-      server.close
-      @macaw_log.info('Macaw stop flying for some seeds...')
     end
 
-    private
-
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Aria Diniz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-11 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: