minato_error_handler 0.1.2.pre.4 → 0.1.2.pre.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 933cd1db1433ec311e9444e98083fdd941533d15caf2c9a47a50eea92db8458b
-  data.tar.gz: 0135162f0cfd82a5774e53eefb28516068316ea41fca125078496087def6f94c
+  metadata.gz: 7035563235faf487222e2a1855529723e471792d6c240d0d330c9c154d588486
+  data.tar.gz: db60393aee3af5c2e98f1f41b425cbc8a4af4714b1605b5adf28eb847e6bec2a
 SHA512:
-  metadata.gz: 38ab27987d1a5238ef906ea0d206eb4ef9709128185a22d0ca1f33a3084f7fa006171dc13b8a3b93966bf7ed7ded9ba906e6a29849c43aa12af7b41c1cc80576
-  data.tar.gz: 26ae1501716ab8e63be2c027e4c5c8ee58382a1f89acd30b04c978d448ec04e7bb31dc1d8a51f9bd4c85ce9f18e87213292d34398a1185ef8c1b0eb1aa729884
+  metadata.gz: cd80168c81486fe42c3e4a2aa8b33947f07b8eb73afba84be1aba07958db97b17b676e2e5078448e1b39d56c6c6fd1aa2477e44dbf687f36cdecd583eeed799e
+  data.tar.gz: f010f34b1391d4ba48436546bd1bcc8064f8310e52676769f4daf3721ff7b7436b7db257943215ebfa209737b4bbaf49db48f4a1b4b0d49b1638b285b1441a8f

data/lib/minato_error_handler/error_handler.rb

@@ -14,18 +14,22 @@ module MinatoErrorHandler
 
     def handle(exception)
       error = parse_error(exception)
-      report_error(error)
-      render json: { errors: [error.as_json] }, status: error.status_code
+      report_error error
+      render_error error
     end
 
     def parse_error(error)
-      return error if error.is_a?(MinatoErrorHandler::MinatoError)
+      if error.is_a?(MinatoErrorHandler::Errors::MinatoError)
+        error.http_request = request if error.http_request.nil?
+        return error
+      end
 
-      error_class = self.class.default_error_class || MinatoErrorHandler::UnknowError
+      error_class = self.class.default_error_class || MinatoErrorHandler::Errors::UnknowError
 
       minato_error = error_class.new
       minato_error.caused_by = error.full_message
-      minato_error.set_backtrace(error.backtrace)
+      minato_error.backtrace = error.backtrace
+      minato_error.http_request = request
       minato_error
     end
 
@@ -33,6 +37,10 @@ module MinatoErrorHandler
       Rails.logger.error(error.as_json)
     end
 
+    def render_error(error)
+      render json: { errors: [error.json_response] }, status: error.status_code
+    end
+
     module ClassMethods
       def default_error(klass)
         # rubocop:disable Style/ClassVars

data/lib/minato_error_handler/errors/minato_error.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "json"
+
+module MinatoErrorHandler
+  module Errors
+    class MinatoError < StandardError
+      attr_accessor :details, :caused_by
+      attr_reader :http_request
+
+      def message
+        raise_method_not_implemented_error __method__
+      end
+
+      def status_code
+        raise_method_not_implemented_error __method__
+      end
+
+      def code
+        self.class.name
+      end
+
+      def backtrace=(backtrace)
+        set_backtrace(backtrace)
+      end
+
+      def unique_identfier
+        @unique_identfier ||= SecureRandom.uuid
+      end
+
+      def to_json(*_args)
+        serialized_hash(serializable_methods_to_log).to_json
+      end
+
+      def as_json
+        serialized_hash(serializable_methods_to_log).as_json
+      end
+
+      def json_response
+        serialized_hash(serializable_methods_to_response).as_json
+      end
+
+      def http_request=(req)
+        return if req.nil?
+
+        @http_request = { headers: parse_http_request_headers(req.headers), host: req.host,
+                          method: req.request_method, path: req.path, query: req.query_parameters,
+                          remote: req.remote_ip, scheme: req.scheme }
+      end
+
+      def stack_trace
+        backtrace
+      end
+
+      private
+
+      def serializable_methods_to_log
+        %i[caused_by code details message http_request status_code unique_identfier stack_trace]
+      end
+
+      def serializable_methods_to_response
+        methods_to_exclude = %i[http_request stack_trace]
+        serializable_methods_to_log.reject { |m| methods_to_exclude.include? m }
+      end
+
+      def serialized_hash(methods)
+        data = {}
+        methods.each do |method|
+          data[method] = send(method)
+        end
+        data
+      end
+
+      def parse_http_request_headers(headers)
+        selected_headers = headers.env.filter { |k, _v| k.upcase.start_with? "HTTP" }
+        selected_headers.transform_keys! { |k| k.gsub(/\bHTTP_/, "").downcase }
+        selected_headers
+      end
+
+      def raise_method_not_implemented_error(method_name)
+        raise "You must define \"#{method_name}\" in your concrete class."
+      end
+    end
+  end
+end

data/lib/minato_error_handler/errors/network_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MinatoErrorHandler
+  module Errors
+    class NetworkError < MinatoErrorHandler::Errors::MinatoError
+      attr_accessor :response
+
+      def message
+        "A network error has occurred!"
+      end
+
+      def status_code
+        503
+      end
+    end
+  end
+end

data/lib/minato_error_handler/errors/unknow_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MinatoErrorHandler
+  module Errors
+    class UnknowError < MinatoError
+      def message
+        "An unknow error has occurred! See more details in caused_by field."
+      end
+
+      def status_code
+        500
+      end
+    end
+  end
+end

data/lib/minato_error_handler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MinatoErrorHandler
-  VERSION = "0.1.2-4"
+  VERSION = "0.1.2-6"
 end

data/lib/minato_error_handler.rb

@@ -2,7 +2,7 @@
 
 require "minato_error_handler/railtie"
 require "minato_error_handler/version"
-require "minato_error_handler/minato_error"
-require "minato_error_handler/network_error"
-require "minato_error_handler/unknow_error"
+require "minato_error_handler/errors/minato_error"
+require "minato_error_handler/errors/network_error"
+require "minato_error_handler/errors/unknow_error"
 require "minato_error_handler/error_handler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minato_error_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.2.pre.4
+  version: 0.1.2.pre.6
 platform: ruby
 authors:
 - Ferreri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,10 +43,10 @@ files:
 - compose.yml
 - lib/minato_error_handler.rb
 - lib/minato_error_handler/error_handler.rb
-- lib/minato_error_handler/minato_error.rb
-- lib/minato_error_handler/network_error.rb
+- lib/minato_error_handler/errors/minato_error.rb
+- lib/minato_error_handler/errors/network_error.rb
+- lib/minato_error_handler/errors/unknow_error.rb
 - lib/minato_error_handler/railtie.rb
-- lib/minato_error_handler/unknow_error.rb
 - lib/minato_error_handler/version.rb
 - minato_error_handler.gemspec
 - sig/minato_error_handler.rbs

data/lib/minato_error_handler/minato_error.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "securerandom"
-require "json"
-
-module MinatoErrorHandler
-  class MinatoError < StandardError
-    attr_accessor :details, :caused_by, :request
-
-    def message
-      raise_method_not_implemented_error __method__
-    end
-
-    def status_code
-      raise_method_not_implemented_error __method__
-    end
-
-    def serializable_methods
-      raise_method_not_implemented_error __method__
-    end
-
-    def code
-      self.class.name
-    end
-
-    def unique_identfier
-      @unique_identfier ||= SecureRandom.uuid
-    end
-
-    def to_json(*_args)
-      serialized_hash.to_json
-    end
-
-    def as_json
-      serialized_hash.as_json
-    end
-
-    protected
-
-    def default_serializable_methods
-      %i[caused_by code details message request status_code unique_identfier]
-    end
-
-    def serialized_hash
-      data = {}
-      serializable_methods.each do |method|
-        data[method] = send(method)
-      end
-      data
-    end
-
-    def raise_method_not_implemented_error(method_name)
-      raise "You must define \"#{method_name}\" in your concrete class."
-    end
-  end
-end

data/lib/minato_error_handler/network_error.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module MinatoErrorHandler
-  class NetworkError < MinatoErrorHandler::MinatoError
-    attr_accessor :response
-
-    def message
-      "A network error has occurred!"
-    end
-
-    def status_code
-      503
-    end
-
-    def serializable_methods
-      default_serializable_methods.push(:response)
-    end
-  end
-end

data/lib/minato_error_handler/unknow_error.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module MinatoErrorHandler
-  class UnknowError < MinatoError
-    def message
-      "An unknow error has occurred! See more details in caused_by field."
-    end
-
-    def status_code
-      500
-    end
-
-    def serializable_methods
-      default_serializable_methods
-    end
-  end
-end