logstruct 0.1.2 → 0.1.4

data/lib/log_struct/log/puma/start.rb

@@ -9,9 +9,9 @@
 require "log_struct/shared/interfaces/common_fields"
 require "log_struct/shared/interfaces/additional_data_field"
 require "log_struct/shared/interfaces/request_fields"
-require "log_struct/shared/shared/serialize_common"
-require "log_struct/shared/shared/merge_additional_data_fields"
-require "log_struct/shared/shared/add_request_fields"
+require "log_struct/shared/serialize_common"
+require "log_struct/shared/merge_additional_data_fields"
+require "log_struct/shared/add_request_fields"
 require_relative "../../enums/source"
 require_relative "../../enums/event"
 require_relative "../../enums/level"
@@ -21,11 +21,6 @@ module LogStruct
   module Log
     class Puma
       class Start < T::Struct
-        # typed: strict
-        # frozen_string_literal: true
-
-        extend T::Sig
-
         extend T::Sig
 
         # Shared/common fields
@@ -50,42 +45,13 @@ module LogStruct
         const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
         include LogStruct::Log::Shared::MergeAdditionalDataFields
 
-        # Request fields (optional)
-
         # Serialize shared fields
         include LogStruct::Log::Interfaces::CommonFields
         include LogStruct::Log::Shared::SerializeCommon
 
         sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def self.base_hash
-          {}
-        end
-
-        sig {
-          params(mode: T.untyped,
-            puma_version: T.untyped,
-            puma_codename: T.untyped,
-            ruby_version: T.untyped,
-            min_threads: T.untyped,
-            max_threads: T.untyped,
-            environment: T.untyped,
-            process_id: T.untyped,
-            listening_addresses: T.untyped,
-            additional_data: T.untyped,
-            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.build(mode: nil,
-          puma_version: nil,
-          puma_codename: nil,
-          ruby_version: nil,
-          min_threads: nil,
-          max_threads: nil,
-          environment: nil,
-          process_id: nil,
-          listening_addresses: nil,
-          additional_data: nil,
-          timestamp: Time.now)
-          h = base_hash
+        def to_h
+          h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
           h[LogField::Mode] = mode unless mode.nil?
           h[LogField::PumaVersion] = puma_version unless puma_version.nil?
           h[LogField::PumaCodename] = puma_codename unless puma_codename.nil?
@@ -97,23 +63,6 @@ module LogStruct
           h[LogField::ListeningAddresses] = listening_addresses unless listening_addresses.nil?
           h
         end
-
-        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def to_h
-          self.class.build(
-            mode: mode,
-            puma_version: puma_version,
-            puma_codename: puma_codename,
-            ruby_version: ruby_version,
-            min_threads: min_threads,
-            max_threads: max_threads,
-            environment: environment,
-            process_id: process_id,
-            listening_addresses: listening_addresses,
-            additional_data: additional_data,
-            timestamp: timestamp
-          )
-        end
       end
     end
   end

data/lib/log_struct/log/request.rb

@@ -9,9 +9,9 @@
 require "log_struct/shared/interfaces/common_fields"
 require "log_struct/shared/interfaces/additional_data_field"
 require "log_struct/shared/interfaces/request_fields"
-require "log_struct/shared/shared/serialize_common"
-require "log_struct/shared/shared/merge_additional_data_fields"
-require "log_struct/shared/shared/add_request_fields"
+require "log_struct/shared/serialize_common"
+require "log_struct/shared/merge_additional_data_fields"
+require "log_struct/shared/add_request_fields"
 require_relative "../enums/source"
 require_relative "../enums/event"
 require_relative "../enums/level"
@@ -20,11 +20,6 @@ require_relative "../enums/log_field"
 module LogStruct
   module Log
     class Request < T::Struct
-      # typed: strict
-      # frozen_string_literal: true
-
-      extend T::Sig
-
       extend T::Sig
 
       # Shared/common fields
@@ -41,7 +36,7 @@ module LogStruct
       const :request_id, T.nilable(String), default: nil
 
       # Event-specific fields
-      const :format, T.nilable(String), default: nil
+      const :format, T.nilable(Symbol), default: nil
       const :controller, T.nilable(String), default: nil
       const :action, T.nilable(String), default: nil
       const :status, T.nilable(Integer), default: nil
@@ -50,8 +45,6 @@ module LogStruct
       const :database, T.nilable(Float), default: nil
       const :params, T.nilable(T::Hash[Symbol, T.untyped]), default: nil
 
-      # Additional data
-
       # Request fields (optional)
       include LogStruct::Log::Interfaces::RequestFields
 
@@ -60,70 +53,15 @@ module LogStruct
       include LogStruct::Log::Shared::SerializeCommon
       include LogStruct::Log::Shared::AddRequestFields
 
-      sig {
-        params(path: T.untyped,
-          http_method: T.untyped,
-          source_ip: T.untyped,
-          user_agent: T.untyped,
-          referer: T.untyped,
-          request_id: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-      }
-      def self.base_hash(path: nil,
-        http_method: nil,
-        source_ip: nil,
-        user_agent: nil,
-        referer: nil,
-        request_id: nil)
-        h = {}
+      sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+      def to_h
+        h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
         h[LogField::Path] = path unless path.nil?
         h[LogField::HttpMethod] = http_method unless http_method.nil?
         h[LogField::SourceIp] = source_ip unless source_ip.nil?
         h[LogField::UserAgent] = user_agent unless user_agent.nil?
         h[LogField::Referer] = referer unless referer.nil?
         h[LogField::RequestId] = request_id unless request_id.nil?
-        h
-      end
-
-      sig {
-        params(path: T.untyped,
-          http_method: T.untyped,
-          source_ip: T.untyped,
-          user_agent: T.untyped,
-          referer: T.untyped,
-          request_id: T.untyped,
-          format: T.untyped,
-          controller: T.untyped,
-          action: T.untyped,
-          status: T.untyped,
-          duration_ms: T.untyped,
-          view: T.untyped,
-          database: T.untyped,
-          params: T.untyped,
-          additional_data: T.untyped,
-          timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-      }
-      def self.build(path: nil,
-        http_method: nil,
-        source_ip: nil,
-        user_agent: nil,
-        referer: nil,
-        request_id: nil,
-        format: nil,
-        controller: nil,
-        action: nil,
-        status: nil,
-        duration_ms: nil,
-        view: nil,
-        database: nil,
-        params: nil,
-        additional_data: nil,
-        timestamp: Time.now)
-        h = base_hash(path: path,
-          http_method: http_method,
-          source_ip: source_ip,
-          user_agent: user_agent,
-          referer: referer,
-          request_id: request_id)
         h[LogField::Format] = format unless format.nil?
         h[LogField::Controller] = controller unless controller.nil?
         h[LogField::Action] = action unless action.nil?
@@ -134,27 +72,6 @@ module LogStruct
         h[LogField::Params] = params unless params.nil?
         h
       end
-
-      sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-      def to_h
-        self.class.build(
-          path: path,
-          http_method: http_method,
-          source_ip: source_ip,
-          user_agent: user_agent,
-          referer: referer,
-          request_id: request_id,
-          format: format,
-          controller: controller,
-          action: action,
-          status: status,
-          duration_ms: duration_ms,
-          view: view,
-          database: database,
-          params: params,
-          timestamp: timestamp
-        )
-      end
     end
   end
 end

data/lib/log_struct/log/security/blocked_host.rb

@@ -9,9 +9,9 @@
 require "log_struct/shared/interfaces/common_fields"
 require "log_struct/shared/interfaces/additional_data_field"
 require "log_struct/shared/interfaces/request_fields"
-require "log_struct/shared/shared/serialize_common"
-require "log_struct/shared/shared/merge_additional_data_fields"
-require "log_struct/shared/shared/add_request_fields"
+require "log_struct/shared/serialize_common"
+require "log_struct/shared/merge_additional_data_fields"
+require "log_struct/shared/add_request_fields"
 require_relative "../../enums/source"
 require_relative "../../enums/event"
 require_relative "../../enums/level"
@@ -21,11 +21,6 @@ module LogStruct
   module Log
     class Security
       class BlockedHost < T::Struct
-        # typed: strict
-        # frozen_string_literal: true
-
-        extend T::Sig
-
         extend T::Sig
 
         # Shared/common fields
@@ -45,6 +40,9 @@ module LogStruct
         const :message, T.nilable(String), default: nil
         const :blocked_host, T.nilable(String), default: nil
         const :blocked_hosts, T.nilable(T::Array[String]), default: nil
+        const :x_forwarded_for, T.nilable(String), default: nil
+        const :allowed_hosts, T.nilable(T::Array[String]), default: nil
+        const :allow_ip_hosts, T.nilable(T::Boolean), default: nil
 
         # Additional data
         include LogStruct::Log::Interfaces::AdditionalDataField
@@ -59,82 +57,23 @@ module LogStruct
         include LogStruct::Log::Shared::SerializeCommon
         include LogStruct::Log::Shared::AddRequestFields
 
-        sig {
-          params(path: T.untyped,
-            http_method: T.untyped,
-            source_ip: T.untyped,
-            user_agent: T.untyped,
-            referer: T.untyped,
-            request_id: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.base_hash(path: nil,
-          http_method: nil,
-          source_ip: nil,
-          user_agent: nil,
-          referer: nil,
-          request_id: nil)
-          h = {}
+        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+        def to_h
+          h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
           h[LogField::Path] = path unless path.nil?
           h[LogField::HttpMethod] = http_method unless http_method.nil?
           h[LogField::SourceIp] = source_ip unless source_ip.nil?
           h[LogField::UserAgent] = user_agent unless user_agent.nil?
           h[LogField::Referer] = referer unless referer.nil?
           h[LogField::RequestId] = request_id unless request_id.nil?
-          h
-        end
-
-        sig {
-          params(path: T.untyped,
-            http_method: T.untyped,
-            source_ip: T.untyped,
-            user_agent: T.untyped,
-            referer: T.untyped,
-            request_id: T.untyped,
-            message: T.untyped,
-            blocked_host: T.untyped,
-            blocked_hosts: T.untyped,
-            additional_data: T.untyped,
-            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.build(path: nil,
-          http_method: nil,
-          source_ip: nil,
-          user_agent: nil,
-          referer: nil,
-          request_id: nil,
-          message: nil,
-          blocked_host: nil,
-          blocked_hosts: nil,
-          additional_data: nil,
-          timestamp: Time.now)
-          h = base_hash(path: path,
-            http_method: http_method,
-            source_ip: source_ip,
-            user_agent: user_agent,
-            referer: referer,
-            request_id: request_id)
           h[LogField::Message] = message unless message.nil?
           h[LogField::BlockedHost] = blocked_host unless blocked_host.nil?
           h[LogField::BlockedHosts] = blocked_hosts unless blocked_hosts.nil?
+          h[LogField::XForwardedFor] = x_forwarded_for unless x_forwarded_for.nil?
+          h[LogField::AllowedHosts] = allowed_hosts unless allowed_hosts.nil?
+          h[LogField::AllowIpHosts] = allow_ip_hosts unless allow_ip_hosts.nil?
           h
         end
-
-        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def to_h
-          self.class.build(
-            path: path,
-            http_method: http_method,
-            source_ip: source_ip,
-            user_agent: user_agent,
-            referer: referer,
-            request_id: request_id,
-            message: message,
-            blocked_host: blocked_host,
-            blocked_hosts: blocked_hosts,
-            additional_data: additional_data,
-            timestamp: timestamp
-          )
-        end
       end
     end
   end

data/lib/log_struct/log/security/csrf_violation.rb

@@ -9,9 +9,9 @@
 require "log_struct/shared/interfaces/common_fields"
 require "log_struct/shared/interfaces/additional_data_field"
 require "log_struct/shared/interfaces/request_fields"
-require "log_struct/shared/shared/serialize_common"
-require "log_struct/shared/shared/merge_additional_data_fields"
-require "log_struct/shared/shared/add_request_fields"
+require "log_struct/shared/serialize_common"
+require "log_struct/shared/merge_additional_data_fields"
+require "log_struct/shared/add_request_fields"
 require_relative "../../enums/source"
 require_relative "../../enums/event"
 require_relative "../../enums/level"
@@ -21,11 +21,6 @@ module LogStruct
   module Log
     class Security
       class CSRFViolation < T::Struct
-        # typed: strict
-        # frozen_string_literal: true
-
-        extend T::Sig
-
         extend T::Sig
 
         # Shared/common fields
@@ -57,74 +52,18 @@ module LogStruct
         include LogStruct::Log::Shared::SerializeCommon
         include LogStruct::Log::Shared::AddRequestFields
 
-        sig {
-          params(path: T.untyped,
-            http_method: T.untyped,
-            source_ip: T.untyped,
-            user_agent: T.untyped,
-            referer: T.untyped,
-            request_id: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.base_hash(path: nil,
-          http_method: nil,
-          source_ip: nil,
-          user_agent: nil,
-          referer: nil,
-          request_id: nil)
-          h = {}
+        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+        def to_h
+          h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
           h[LogField::Path] = path unless path.nil?
           h[LogField::HttpMethod] = http_method unless http_method.nil?
           h[LogField::SourceIp] = source_ip unless source_ip.nil?
           h[LogField::UserAgent] = user_agent unless user_agent.nil?
           h[LogField::Referer] = referer unless referer.nil?
           h[LogField::RequestId] = request_id unless request_id.nil?
-          h
-        end
-
-        sig {
-          params(path: T.untyped,
-            http_method: T.untyped,
-            source_ip: T.untyped,
-            user_agent: T.untyped,
-            referer: T.untyped,
-            request_id: T.untyped,
-            message: T.untyped,
-            additional_data: T.untyped,
-            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.build(path: nil,
-          http_method: nil,
-          source_ip: nil,
-          user_agent: nil,
-          referer: nil,
-          request_id: nil,
-          message: nil,
-          additional_data: nil,
-          timestamp: Time.now)
-          h = base_hash(path: path,
-            http_method: http_method,
-            source_ip: source_ip,
-            user_agent: user_agent,
-            referer: referer,
-            request_id: request_id)
           h[LogField::Message] = message unless message.nil?
           h
         end
-
-        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def to_h
-          self.class.build(
-            path: path,
-            http_method: http_method,
-            source_ip: source_ip,
-            user_agent: user_agent,
-            referer: referer,
-            request_id: request_id,
-            message: message,
-            additional_data: additional_data,
-            timestamp: timestamp
-          )
-        end
       end
     end
   end

data/lib/log_struct/log/security/ip_spoof.rb

@@ -9,9 +9,9 @@
 require "log_struct/shared/interfaces/common_fields"
 require "log_struct/shared/interfaces/additional_data_field"
 require "log_struct/shared/interfaces/request_fields"
-require "log_struct/shared/shared/serialize_common"
-require "log_struct/shared/shared/merge_additional_data_fields"
-require "log_struct/shared/shared/add_request_fields"
+require "log_struct/shared/serialize_common"
+require "log_struct/shared/merge_additional_data_fields"
+require "log_struct/shared/add_request_fields"
 require_relative "../../enums/source"
 require_relative "../../enums/event"
 require_relative "../../enums/level"
@@ -21,11 +21,6 @@ module LogStruct
   module Log
     class Security
       class IPSpoof < T::Struct
-        # typed: strict
-        # frozen_string_literal: true
-
-        extend T::Sig
-
         extend T::Sig
 
         # Shared/common fields
@@ -59,82 +54,20 @@ module LogStruct
         include LogStruct::Log::Shared::SerializeCommon
         include LogStruct::Log::Shared::AddRequestFields
 
-        sig {
-          params(path: T.untyped,
-            http_method: T.untyped,
-            source_ip: T.untyped,
-            user_agent: T.untyped,
-            referer: T.untyped,
-            request_id: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.base_hash(path: nil,
-          http_method: nil,
-          source_ip: nil,
-          user_agent: nil,
-          referer: nil,
-          request_id: nil)
-          h = {}
+        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+        def to_h
+          h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
           h[LogField::Path] = path unless path.nil?
           h[LogField::HttpMethod] = http_method unless http_method.nil?
           h[LogField::SourceIp] = source_ip unless source_ip.nil?
           h[LogField::UserAgent] = user_agent unless user_agent.nil?
           h[LogField::Referer] = referer unless referer.nil?
           h[LogField::RequestId] = request_id unless request_id.nil?
-          h
-        end
-
-        sig {
-          params(path: T.untyped,
-            http_method: T.untyped,
-            source_ip: T.untyped,
-            user_agent: T.untyped,
-            referer: T.untyped,
-            request_id: T.untyped,
-            message: T.untyped,
-            client_ip: T.untyped,
-            x_forwarded_for: T.untyped,
-            additional_data: T.untyped,
-            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.build(path: nil,
-          http_method: nil,
-          source_ip: nil,
-          user_agent: nil,
-          referer: nil,
-          request_id: nil,
-          message: nil,
-          client_ip: nil,
-          x_forwarded_for: nil,
-          additional_data: nil,
-          timestamp: Time.now)
-          h = base_hash(path: path,
-            http_method: http_method,
-            source_ip: source_ip,
-            user_agent: user_agent,
-            referer: referer,
-            request_id: request_id)
           h[LogField::Message] = message unless message.nil?
           h[LogField::ClientIp] = client_ip unless client_ip.nil?
           h[LogField::XForwardedFor] = x_forwarded_for unless x_forwarded_for.nil?
           h
         end
-
-        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def to_h
-          self.class.build(
-            path: path,
-            http_method: http_method,
-            source_ip: source_ip,
-            user_agent: user_agent,
-            referer: referer,
-            request_id: request_id,
-            message: message,
-            client_ip: client_ip,
-            x_forwarded_for: x_forwarded_for,
-            additional_data: additional_data,
-            timestamp: timestamp
-          )
-        end
       end
     end
   end

data/lib/log_struct/log/shrine/delete.rb

@@ -9,9 +9,9 @@
 require "log_struct/shared/interfaces/common_fields"
 require "log_struct/shared/interfaces/additional_data_field"
 require "log_struct/shared/interfaces/request_fields"
-require "log_struct/shared/shared/serialize_common"
-require "log_struct/shared/shared/merge_additional_data_fields"
-require "log_struct/shared/shared/add_request_fields"
+require "log_struct/shared/serialize_common"
+require "log_struct/shared/merge_additional_data_fields"
+require "log_struct/shared/add_request_fields"
 require_relative "../../enums/source"
 require_relative "../../enums/event"
 require_relative "../../enums/level"
@@ -21,11 +21,6 @@ module LogStruct
   module Log
     class Shrine
       class Delete < T::Struct
-        # typed: strict
-        # frozen_string_literal: true
-
-        extend T::Sig
-
         extend T::Sig
 
         # Shared/common fields
@@ -35,50 +30,20 @@ module LogStruct
         const :level, Level, default: Level::Info
 
         # Event-specific fields
-        const :storage, String
+        const :storage, Symbol
         const :location, String
 
-        # Additional data
-        include LogStruct::Log::Interfaces::AdditionalDataField
-        const :additional_data, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]), default: nil
-        include LogStruct::Log::Shared::MergeAdditionalDataFields
-
-        # Request fields (optional)
-
         # Serialize shared fields
         include LogStruct::Log::Interfaces::CommonFields
         include LogStruct::Log::Shared::SerializeCommon
 
         sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def self.base_hash
-          {}
-        end
-
-        sig {
-          params(storage: T.untyped,
-            location: T.untyped,
-            additional_data: T.untyped,
-            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
-        }
-        def self.build(storage:,
-          location:,
-          additional_data: nil,
-          timestamp: Time.now)
-          h = base_hash
+        def to_h
+          h = T.let({}, T::Hash[LogStruct::LogField, T.untyped])
           h[LogField::Storage] = storage
           h[LogField::Location] = location
           h
         end
-
-        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
-        def to_h
-          self.class.build(
-            storage: storage,
-            location: location,
-            additional_data: additional_data,
-            timestamp: timestamp
-          )
-        end
       end
     end
   end