logstruct 0.0.2 → 0.1.1

data/lib/log_struct/log/request.rb

@@ -1,75 +1,159 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "interfaces/common_fields"
-require_relative "interfaces/request_fields"
-require_relative "shared/serialize_common"
-require_relative "shared/add_request_fields"
+# AUTO-GENERATED: DO NOT EDIT
+# Generated by scripts/generate_structs.rb
+# Schemas dir: schemas/log_sources/
+# Template: tools/codegen/templates/sorbet/event.rb.erb
+
+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_relative "../enums/source"
 require_relative "../enums/event"
 require_relative "../enums/level"
-require_relative "../log_keys"
+require_relative "../enums/log_field"
 
 module LogStruct
   module Log
-    # Request log entry for structured logging
     class Request < T::Struct
-      extend T::Sig
+      # typed: strict
+      # frozen_string_literal: true
 
-      include Interfaces::CommonFields
-      include Interfaces::RequestFields
-      include SerializeCommon
-      include AddRequestFields
+      extend T::Sig
 
-      RequestEvent = T.type_alias {
-        Event::Request
-      }
+      extend T::Sig
 
-      # Common fields
-      const :source, Source::Rails, default: T.let(Source::Rails, Source::Rails)
-      const :event, RequestEvent, default: T.let(Event::Request, RequestEvent)
+      # Shared/common fields
+      const :source, Source::Rails, default: Source::Rails
+      const :event, Event, default: Event::Request
       const :timestamp, Time, factory: -> { Time.now }
-      const :level, Level, default: T.let(Level::Info, Level)
+      const :level, Level, default: Level::Info
 
-      # Request-specific fields
-      # NOTE: `method` is a reserved word, so we use `http_method`
-      # prop while setting `method` in the serialized output
-      const :http_method, T.nilable(String), default: nil
       const :path, T.nilable(String), default: nil
+      const :http_method, T.nilable(String), default: nil
+      const :source_ip, T.nilable(String), default: nil
+      const :user_agent, T.nilable(String), default: nil
+      const :referer, T.nilable(String), default: nil
+      const :request_id, T.nilable(String), default: nil
+
+      # Event-specific fields
       const :format, T.nilable(String), default: nil
       const :controller, T.nilable(String), default: nil
       const :action, T.nilable(String), default: nil
       const :status, T.nilable(Integer), default: nil
-      const :duration, T.nilable(Float), default: nil
+      const :duration_ms, T.nilable(Float), default: nil
       const :view, T.nilable(Float), default: nil
-      const :db, T.nilable(Float), default: nil
+      const :database, T.nilable(Float), default: nil
       const :params, T.nilable(T::Hash[Symbol, T.untyped]), default: nil
-      const :source_ip, T.nilable(String), default: nil
-      const :user_agent, T.nilable(String), default: nil
-      const :referer, T.nilable(String), default: nil
-      const :request_id, T.nilable(String), default: nil
 
-      # Convert the log entry to a hash for serialization
-      sig { override.params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
-      def serialize(strict = true)
-        hash = serialize_common(strict)
-        add_request_fields(hash)
-        hash[LOG_KEYS.fetch(:http_method)] = http_method if http_method
-        hash[LOG_KEYS.fetch(:path)] = path if path
-        hash[LOG_KEYS.fetch(:format)] = format if format
-        hash[LOG_KEYS.fetch(:controller)] = controller if controller
-        hash[LOG_KEYS.fetch(:action)] = action if action
-        hash[LOG_KEYS.fetch(:status)] = status if status
-        hash[LOG_KEYS.fetch(:duration)] = duration if duration
-        hash[LOG_KEYS.fetch(:view)] = view if view
-        hash[LOG_KEYS.fetch(:db)] = db if db
-        hash[LOG_KEYS.fetch(:params)] = params if params
-        hash[LOG_KEYS.fetch(:source_ip)] = source_ip if source_ip
-        hash[LOG_KEYS.fetch(:user_agent)] = user_agent if user_agent
-        hash[LOG_KEYS.fetch(:referer)] = referer if referer
-        hash[LOG_KEYS.fetch(:request_id)] = request_id if request_id
+      # Additional data
+
+      # Request fields (optional)
+      include LogStruct::Log::Interfaces::RequestFields
+
+      # Serialize shared fields
+      include LogStruct::Log::Interfaces::CommonFields
+      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 = {}
+        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?
+        h[LogField::Status] = status unless status.nil?
+        h[LogField::DurationMs] = duration_ms unless duration_ms.nil?
+        h[LogField::View] = view unless view.nil?
+        h[LogField::Database] = database unless database.nil?
+        h[LogField::Params] = params unless params.nil?
+        h
+      end
 
-        hash
+      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

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

@@ -0,0 +1,141 @@
+# typed: strict
+# frozen_string_literal: true
+
+# AUTO-GENERATED: DO NOT EDIT
+# Generated by scripts/generate_structs.rb
+# Schemas dir: schemas/log_sources/
+# Template: tools/codegen/templates/sorbet/event.rb.erb
+
+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_relative "../../enums/source"
+require_relative "../../enums/event"
+require_relative "../../enums/level"
+require_relative "../../enums/log_field"
+
+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
+        const :source, Source::Security, default: Source::Security
+        const :event, Event, default: Event::BlockedHost
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        const :path, T.nilable(String), default: nil
+        const :http_method, T.nilable(String), default: nil
+        const :source_ip, T.nilable(String), default: nil
+        const :user_agent, T.nilable(String), default: nil
+        const :referer, T.nilable(String), default: nil
+        const :request_id, T.nilable(String), default: nil
+
+        # Event-specific fields
+        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
+
+        # 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)
+        include LogStruct::Log::Interfaces::RequestFields
+
+        # Serialize shared fields
+        include LogStruct::Log::Interfaces::CommonFields
+        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 = {}
+          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
+        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
+end

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

@@ -0,0 +1,131 @@
+# typed: strict
+# frozen_string_literal: true
+
+# AUTO-GENERATED: DO NOT EDIT
+# Generated by scripts/generate_structs.rb
+# Schemas dir: schemas/log_sources/
+# Template: tools/codegen/templates/sorbet/event.rb.erb
+
+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_relative "../../enums/source"
+require_relative "../../enums/event"
+require_relative "../../enums/level"
+require_relative "../../enums/log_field"
+
+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
+        const :source, Source::Security, default: Source::Security
+        const :event, Event, default: Event::CSRFViolation
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        const :path, T.nilable(String), default: nil
+        const :http_method, T.nilable(String), default: nil
+        const :source_ip, T.nilable(String), default: nil
+        const :user_agent, T.nilable(String), default: nil
+        const :referer, T.nilable(String), default: nil
+        const :request_id, T.nilable(String), default: nil
+
+        # Event-specific fields
+        const :message, T.nilable(String), default: nil
+
+        # 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)
+        include LogStruct::Log::Interfaces::RequestFields
+
+        # Serialize shared fields
+        include LogStruct::Log::Interfaces::CommonFields
+        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 = {}
+          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
+end

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

@@ -0,0 +1,141 @@
+# typed: strict
+# frozen_string_literal: true
+
+# AUTO-GENERATED: DO NOT EDIT
+# Generated by scripts/generate_structs.rb
+# Schemas dir: schemas/log_sources/
+# Template: tools/codegen/templates/sorbet/event.rb.erb
+
+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_relative "../../enums/source"
+require_relative "../../enums/event"
+require_relative "../../enums/level"
+require_relative "../../enums/log_field"
+
+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
+        const :source, Source::Security, default: Source::Security
+        const :event, Event, default: Event::IPSpoof
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        const :path, T.nilable(String), default: nil
+        const :http_method, T.nilable(String), default: nil
+        const :source_ip, T.nilable(String), default: nil
+        const :user_agent, T.nilable(String), default: nil
+        const :referer, T.nilable(String), default: nil
+        const :request_id, T.nilable(String), default: nil
+
+        # Event-specific fields
+        const :message, T.nilable(String), default: nil
+        const :client_ip, T.nilable(String), default: nil
+        const :x_forwarded_for, T.nilable(String), default: nil
+
+        # 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)
+        include LogStruct::Log::Interfaces::RequestFields
+
+        # Serialize shared fields
+        include LogStruct::Log::Interfaces::CommonFields
+        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 = {}
+          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
+end