logstruct 0.1.0 → 0.1.1

data/lib/log_struct/log/security.rb

@@ -1,79 +1,49 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "interfaces/common_fields"
-require_relative "interfaces/additional_data_field"
-require_relative "interfaces/message_field"
-require_relative "interfaces/request_fields"
-require_relative "shared/add_request_fields"
-require_relative "shared/merge_additional_data_fields"
-require_relative "shared/serialize_common"
-require_relative "../enums/event"
-require_relative "../enums/level"
-require_relative "../enums/source"
-require_relative "../log_keys"
+# AUTO-GENERATED: DO NOT EDIT
+# Generated by scripts/generate_structs.rb
+# Schemas dir: schemas/log_sources/
+# Template: tools/codegen/templates/sorbet/source_parent.rb.erb
+
+require_relative "security/ip_spoof"
+require_relative "security/csrf_violation"
+require_relative "security/blocked_host"
 
 module LogStruct
   module Log
-    # Security log entry for structured logging of security-related events
-    class Security < T::Struct
-      extend T::Sig
-
-      include Interfaces::CommonFields
-      include Interfaces::AdditionalDataField
-      include Interfaces::MessageField
-      include Interfaces::RequestFields
-      include SerializeCommon
-      include AddRequestFields
-      include MergeAdditionalDataFields
-
-      SecurityEvent = T.type_alias {
-        T.any(
-          Event::IPSpoof,
-          Event::CSRFViolation,
-          Event::BlockedHost
-        )
-      }
-
-      # Common fields
-      const :source, Source::Security, default: T.let(Source::Security, Source::Security)
-      const :event, SecurityEvent
-      const :timestamp, Time, factory: -> { Time.now }
-      const :level, Level, default: T.let(Level::Error, Level)
-
-      # Security-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
-      const :client_ip, T.nilable(String), default: nil
-      const :x_forwarded_for, T.nilable(String), default: nil
-
-      # Additional data (merged into hash)
-      const :additional_data, T::Hash[Symbol, T.untyped], default: {}
-
-      # Common request fields
-      const :path, T.nilable(String), default: nil
-      const :http_method, T.nilable(String), default: nil, name: "method"
-      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)
-        merge_additional_data_fields(hash)
-
-        # Add security-specific fields
-        hash[LOG_KEYS.fetch(:message)] = message if message
-        hash[LOG_KEYS.fetch(:blocked_host)] = blocked_host if blocked_host
-        hash[LOG_KEYS.fetch(:blocked_hosts)] = blocked_hosts if blocked_hosts
-        hash[LOG_KEYS.fetch(:client_ip)] = client_ip if client_ip
-        hash[LOG_KEYS.fetch(:x_forwarded_for)] = x_forwarded_for if x_forwarded_for
-
-        hash
+    class Security
+      class BaseFields < T::Struct
+        extend T::Sig
+        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
+
+        Kwargs = T.type_alias do
+          {
+            path: T.nilable(String),
+            http_method: T.nilable(String),
+            source_ip: T.nilable(String),
+            user_agent: T.nilable(String),
+            referer: T.nilable(String),
+            request_id: T.nilable(String)
+          }
+        end
+
+        sig { returns(Kwargs) }
+        def to_kwargs
+          {
+            path: path,
+            http_method: http_method,
+            source_ip: source_ip,
+            user_agent: user_agent,
+            referer: referer,
+            request_id: request_id
+          }
+        end
       end
     end
   end

data/lib/log_struct/log/shared/add_request_fields.rb

@@ -1,29 +1,4 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../log_keys"
-require_relative "../interfaces/request_fields"
-
-module LogStruct
-  module Log
-    # Common log serialization method
-    module AddRequestFields
-      extend T::Sig
-      extend T::Helpers
-
-      requires_ancestor { Interfaces::RequestFields }
-
-      # Helper method to serialize request fields
-      sig { params(hash: T::Hash[Symbol, T.untyped]).void }
-      def add_request_fields(hash)
-        # Add request-specific fields if they're present
-        hash[LOG_KEYS.fetch(:path)] = path if path
-        hash[LOG_KEYS.fetch(:http_method)] = http_method if http_method # Use `method` in JSON
-        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
-      end
-    end
-  end
-end
+require "log_struct/shared/shared/add_request_fields"

data/lib/log_struct/log/shared/merge_additional_data_fields.rb

@@ -1,25 +1,4 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../log_keys"
-require_relative "../interfaces/additional_data_field"
-
-module LogStruct
-  module Log
-    # Helper module for merging additional data into serialized logs
-    module MergeAdditionalDataFields
-      extend T::Sig
-      extend T::Helpers
-
-      requires_ancestor { T::Struct }
-      requires_ancestor { Interfaces::AdditionalDataField }
-
-      sig { params(hash: T::Hash[Symbol, T.untyped]).void }
-      def merge_additional_data_fields(hash)
-        additional_data.each do |key, value|
-          hash[key.to_sym] = value
-        end
-      end
-    end
-  end
-end
+require "log_struct/shared/shared/merge_additional_data_fields"

data/lib/log_struct/log/shared/serialize_common.rb

@@ -1,36 +1,4 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../log_keys"
-require_relative "../interfaces/common_fields"
-
-module LogStruct
-  module Log
-    # Common log serialization method
-    module SerializeCommon
-      extend T::Sig
-      extend T::Helpers
-
-      requires_ancestor { Interfaces::CommonFields }
-
-      # Convert the log entry to a hash for serialization.
-      # (strict param is unused, but need same signature as default T::Struct.serialize)
-      sig { params(strict: T::Boolean).returns(T::Hash[Symbol, T.untyped]) }
-      def serialize_common(strict = true)
-        {
-          LOG_KEYS.fetch(:source) => source.serialize.to_s,
-          LOG_KEYS.fetch(:event) => event.serialize.to_s,
-          LOG_KEYS.fetch(:level) => level.serialize.to_s,
-          LOG_KEYS.fetch(:timestamp) => timestamp.iso8601(3)
-        }
-      end
-
-      # Override as_json to use our custom serialize method instead of default T::Struct serialization
-      sig { params(options: T.untyped).returns(T::Hash[String, T.untyped]) }
-      def as_json(options = nil)
-        # Convert symbol keys to strings for JSON
-        serialize.transform_keys(&:to_s)
-      end
-    end
-  end
-end
+require "log_struct/shared/shared/serialize_common"

data/lib/log_struct/log/shared/serialize_common_public.rb

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-require_relative "../../log_keys"
+require_relative "../../enums/log_field"
 require_relative "../interfaces/public_common_fields"
 
 module LogStruct
@@ -20,18 +20,18 @@ module LogStruct
           raise ArgumentError, "Public log struct must define #source and #event"
         end
 
-        src_val = T.unsafe(self).source
-        evt_val = T.unsafe(self).event
-        src = src_val.respond_to?(:serialize) ? T.unsafe(src_val).serialize.to_s : src_val.to_s
-        evt = evt_val.respond_to?(:serialize) ? T.unsafe(evt_val).serialize.to_s : evt_val.to_s
+        src_val = public_send(:source)
+        evt_val = public_send(:event)
+        src = src_val.respond_to?(:serialize) ? src_val.public_send(:serialize).to_s : src_val.to_s
+        evt = evt_val.respond_to?(:serialize) ? evt_val.public_send(:serialize).to_s : evt_val.to_s
         lvl = level.serialize.to_s
         ts = timestamp.iso8601(3)
 
         {
-          LOG_KEYS.fetch(:source) => src,
-          LOG_KEYS.fetch(:event) => evt,
-          LOG_KEYS.fetch(:level) => lvl,
-          LOG_KEYS.fetch(:timestamp) => ts
+          LogField::Source.serialize => src,
+          LogField::Event.serialize => evt,
+          LogField::Level.serialize => lvl,
+          LogField::Timestamp.serialize => ts
         }
       end
 

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

@@ -0,0 +1,85 @@
+# 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 Shrine
+      class Delete < T::Struct
+        # typed: strict
+        # frozen_string_literal: true
+
+        extend T::Sig
+
+        extend T::Sig
+
+        # Shared/common fields
+        const :source, Source::Shrine, default: Source::Shrine
+        const :event, Event, default: Event::Delete
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        # Event-specific fields
+        const :storage, String
+        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
+          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
+end

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

@@ -0,0 +1,90 @@
+# 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 Shrine
+      class Download < T::Struct
+        # typed: strict
+        # frozen_string_literal: true
+
+        extend T::Sig
+
+        extend T::Sig
+
+        # Shared/common fields
+        const :source, Source::Shrine, default: Source::Shrine
+        const :event, Event, default: Event::Download
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        # Event-specific fields
+        const :storage, String
+        const :location, String
+        const :download_options, T.nilable(T::Hash[Symbol, T.untyped]), 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)
+
+        # 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,
+            download_options: T.untyped,
+            additional_data: T.untyped,
+            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
+        }
+        def self.build(storage:,
+          location:,
+          download_options: nil,
+          additional_data: nil,
+          timestamp: Time.now)
+          h = base_hash
+          h[LogField::Storage] = storage
+          h[LogField::Location] = location
+          h[LogField::DownloadOptions] = download_options unless download_options.nil?
+          h
+        end
+
+        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+        def to_h
+          self.class.build(
+            storage: storage,
+            location: location,
+            download_options: download_options,
+            additional_data: additional_data,
+            timestamp: timestamp
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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 Shrine
+      class Exist < T::Struct
+        # typed: strict
+        # frozen_string_literal: true
+
+        extend T::Sig
+
+        extend T::Sig
+
+        # Shared/common fields
+        const :source, Source::Shrine, default: Source::Shrine
+        const :event, Event, default: Event::Exist
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        # Event-specific fields
+        const :storage, String
+        const :location, String
+        const :exist, T.nilable(T::Boolean), 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)
+
+        # 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,
+            exist: T.untyped,
+            additional_data: T.untyped,
+            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
+        }
+        def self.build(storage:,
+          location:,
+          exist: nil,
+          additional_data: nil,
+          timestamp: Time.now)
+          h = base_hash
+          h[LogField::Storage] = storage
+          h[LogField::Location] = location
+          h[LogField::Exist] = exist unless exist.nil?
+          h
+        end
+
+        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+        def to_h
+          self.class.build(
+            storage: storage,
+            location: location,
+            exist: exist,
+            additional_data: additional_data,
+            timestamp: timestamp
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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 Shrine
+      class Metadata < T::Struct
+        # typed: strict
+        # frozen_string_literal: true
+
+        extend T::Sig
+
+        extend T::Sig
+
+        # Shared/common fields
+        const :source, Source::Shrine, default: Source::Shrine
+        const :event, Event, default: Event::Metadata
+        const :timestamp, Time, factory: -> { Time.now }
+        const :level, Level, default: Level::Info
+
+        # Event-specific fields
+        const :storage, String
+        const :location, String
+        const :metadata, T.nilable(T::Hash[String, T.untyped]), 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)
+
+        # 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,
+            metadata: T.untyped,
+            additional_data: T.untyped,
+            timestamp: T.untyped).returns(T::Hash[LogStruct::LogField, T.untyped])
+        }
+        def self.build(storage:,
+          location:,
+          metadata: nil,
+          additional_data: nil,
+          timestamp: Time.now)
+          h = base_hash
+          h[LogField::Storage] = storage
+          h[LogField::Location] = location
+          h[LogField::Metadata] = metadata unless metadata.nil?
+          h
+        end
+
+        sig { returns(T::Hash[LogStruct::LogField, T.untyped]) }
+        def to_h
+          self.class.build(
+            storage: storage,
+            location: location,
+            metadata: metadata,
+            additional_data: additional_data,
+            timestamp: timestamp
+          )
+        end
+      end
+    end
+  end
+end