datadog-json_logger 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25aa55fc996314835493e0d134ffdf5c44080a36a27a3b82d21977d19623c565
-  data.tar.gz: 49c7e190cafd5dd5291afdb8f9baf0d0b655179e45763920fe188590f9692693
+  metadata.gz: 7120de0085ceee8323c41cc80a7743e111818bb30662d9dbd7f1be4c4feb4a6c
+  data.tar.gz: 4fa8c5501f35a9794ec44763ac4a7f41ae2cc80b0f72c1326497f0bdaabcafe9
 SHA512:
-  metadata.gz: 9c8c19712e5653add057734e39f22c6266fd60649868cb297ac5e79aa179c695645c12111b0a1d072af24707907472720d7618872a18278926c18ab5f5bd31ef
-  data.tar.gz: 8975469ccdefd6b762ef0605f8c1baa0923d3a6a5d8e15f24eaa1b8bd27fd2be3b93d453fa9c23e1340c44d399a06e2dceacfd9725f26b4cea216163facba413
+  metadata.gz: 5d7549654631f0ea56c684d81607c49fd3fa0d65e8c60073e511cbc2169d13c89bb29d0d50e9b4aef44ab62213cb859b4b612faa0b23fd2ccedb4a2eaabf29d0
+  data.tar.gz: d463571ab78f6baf7a44640db5b0df3d4049fa9ddd05f734e74398b2530fdeadda4d6b53498aa82ab79dcbe8b4fdeadcae5d95f47b79a8cf4f12da2cfa1d24f2

data/.rubocop.yml

@@ -28,6 +28,8 @@ Metrics/MethodLength:
 
 Metrics/BlockLength:
   Max: 100
+  Exclude:
+    - 'spec/**/*'
 
 Metrics/ParameterLists:
   Max: 6

data/CHANGELOG.md

@@ -1,5 +1,35 @@
-## [Unreleased]
+## v0.1.5 (2024-02-02)
 
-## [0.0.1] - 2023-11-20
+### New feature:
 
-- Initial release
+- Add better log message (#5)([`2e8e49e`](https://github.com/buyco/datadog-json-logger/commit/2e8e49e37903de85858a1ffa54f52ee8a145592c)) (by Eth3rnit3)
+
+## v0.1.4 (2023-12-19)
+
+### New feature:
+
+- add option to raise error on request or not (#4)([`e98dea0`](https://github.com/buyco/datadog-json-logger/commit/e98dea065fba1623811749f551d2cc4505ea468e)) (by Eth3rnit3)
+
+## v0.1.3 (2023-12-11)
+
+### New feature:
+
+- make error tracking compatible (#3)([`7397780`](https://github.com/buyco/datadog-json-logger/commit/7397780e48bdb829d1eda4e90834cb5a3f069183)) (by Eth3rnit3)
+- add rbs (#2)([`3b08f16`](https://github.com/buyco/datadog-json-logger/commit/3b08f1667de534b1eb4598110b8421a326e2c346)) (by Eth3rnit3)
+- add nexus workflow([`7107c69`](https://github.com/buyco/datadog-json-logger/commit/7107c6909e9c755ea29ad09c4b67f31c585666b1)) (by Eth3rnit3)
+
+## v0.1.0 (2023-11-22)
+
+### New feature:
+
+- improve middleware and specs([`b7cc576`](https://github.com/buyco/datadog-json-logger/commit/b7cc576111a33192379472202e4a1a881a7167e5)) (by Eth3rnit3)
+- improve formatter and specs([`7b0b9e1`](https://github.com/buyco/datadog-json-logger/commit/7b0b9e174e70872c7bf58e914502a7e70e52b020)) (by Eth3rnit3)
+- rename and improve readme([`2b6a367`](https://github.com/buyco/datadog-json-logger/commit/2b6a367a3e474d4be1fd9a0908e9ff6f4cc9521c)) (by Eth3rnit3)
+- improve setup([`ba11412`](https://github.com/buyco/datadog-json-logger/commit/ba114125fac37f0c6ba8a8129825a6c47591c252)) (by Eth3rnit3)
+- improve specs([`776323c`](https://github.com/buyco/datadog-json-logger/commit/776323c7a8eb19087d9c7b68d844b1f0d9f638aa)) (by Eth3rnit3)
+- add json logger and sinatra middleware([`8910067`](https://github.com/buyco/datadog-json-logger/commit/89100678d9aa3c2f81ac42bfeed46ac070c974a4)) (by Eth3rnit3)
+
+### Bugs fixed:
+
+- use rack-test gem([`94080f0`](https://github.com/buyco/datadog-json-logger/commit/94080f0d4a117a5aae2ab09db46654ac7f7bcbe7)) (by Eth3rnit3)
+- add missing rack gem for spec([`85f7881`](https://github.com/buyco/datadog-json-logger/commit/85f7881cf48e9946855095f854eb86028d0b2f1c)) (by Eth3rnit3)

data/README.md

@@ -1,7 +1,8 @@
 # Datadog::JSONLogger
 
-[![Rubocop and Rspec](https://github.com/Eth3rnit3/datadog-json_logger/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/Eth3rnit3/datadog-json_logger/actions/workflows/main.yml)
-[![Nexus upload](https://github.com/buyco/datadog-json-logger/actions/workflows/nexus.yml/badge.svg)](https://github.com/buyco/datadog-json-logger/actions/workflows/nexus.yml)
+[![CodeQL](https://github.com/buyco/datadog-json-logger/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/buyco/datadog-json-logger/actions/workflows/github-code-scanning/codeql)
+[![Rubocop and Rspec](https://github.com/buyco/datadog-json-logger/actions/workflows/main.yml/badge.svg)](https://github.com/buyco/datadog-json-logger/actions/workflows/main.yml)
+[![Publish on RubyGems](https://github.com/buyco/datadog-json-logger/actions/workflows/gem-push.yml/badge.svg)](https://github.com/buyco/datadog-json-logger/actions/workflows/gem-push.yml)
 
 `Datadog::JSONLogger` is a Ruby gem designed to seamlessly integrate Ruby applications with Datadog's logging and tracing services. This gem allows your Ruby application to format its output as JSON, including necessary correlation IDs and other details for optimal Datadog functionality.
 
@@ -39,6 +40,13 @@ gem install datadog-json_logger
 # Example in Sinatra (app.rb)
 require 'datadog/json_logger'
 
+Datadog::JSONLogger.configure do |config|
+  config.current_user = ->(env) { { email: env['warned'].user.email } } # Log user on each request
+  config.controller_key = "sinatra.controller_name"
+  config.resource_key   = "sinatra.resource_name"
+  config.action_key     = "sinatra.action_name"
+end
+
 def logger
   @logger ||= Datadog::JSONLogger.new
 end
@@ -102,9 +110,9 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eth3rnit3/datadog-json_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/eth3rnit3/datadog-json_logger/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/buyco/datadog-json-logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/buyco/datadog-json-logger/blob/main/CODE_OF_CONDUCT.md).
 
-1. Fork the repository (https://github.com/eth3rnit3/datadog-json_logger/fork)
+1. Fork the repository (https://github.com/buyco/datadog-json-logger/fork)
 2. Create your feature branch (`git checkout -b feature/my_feature`)
 3. Commit your changes (`git commit -am 'Add a new feature'`)
 4. Push the branch (`git push origin feature/my_feature`)
@@ -116,4 +124,4 @@ This gem is available as open source under the terms of the [MIT License](https:
 
 ## Code of Conduct
 
-Everyone interacting in the Datadog::JSONLogger project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/eth3rnit3/datadog-json_logger/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Datadog::JSONLogger project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/buyco/datadog-json-logger/blob/main/CODE_OF_CONDUCT.md).

data/datadog-json_logger.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Connect your ruby application to Datadog logging and tracing."
   spec.description = "This gem provides easy integration for connecting a ruby application to Datadog's logging and tracing services."
-  spec.homepage = "https://github.com/eth3rnit3/datadog-json_logger"
+  spec.homepage = "https://github.com/buyco/datadog-json-logger"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0"
 
@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
 
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/eth3rnit3/datadog-json_logger"
-  spec.metadata["changelog_uri"] = "https://github.com/eth3rnit3/datadog-json_logger/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/buyco/datadog-json-logger"
+  spec.metadata["changelog_uri"] = "https://github.com/buyco/datadog-json-logger/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/datadog/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Datadog
+  class Configuration
+    attr_accessor :current_user, :controller_key, :resource_key, :action_key
+
+    # @param current_user [Lambda] A lambda that returns the current user
+    # e.g. ->(env) { env["current_user"] }
+
+    # @return [Datadog::Configuration]
+    def initialize
+      @current_user   = nil
+      @controller_key = "sinatra.controller_name"
+      @resource_key   = "sinatra.resource_name"
+      @action_key     = "sinatra.action_name"
+    end
+
+    def log_current_user?
+      @current_user ? true : false
+    end
+  end
+end

data/lib/datadog/json_logger.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "logger"
+require_relative "configuration"
 require_relative "loggers/json_formatter"
 require_relative "loggers/version"
 
@@ -8,11 +9,18 @@ module Datadog
   class Error < StandardError; end
 
   class JSONLogger < Logger
+    attr_accessor :config
+
     def initialize(output = default_output)
-      super(output)
+      super
       @default_formatter = ::Datadog::Loggers::JSONFormatter
     end
 
+    def self.configure
+      self.config ||= Configuration.new
+      yield(config)
+    end
+
     private
 
     def default_output

data/lib/datadog/loggers/version.rb

@@ -2,6 +2,6 @@
 
 module Datadog
   module Loggers
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/lib/datadog/sinatra_middleware.rb

@@ -51,16 +51,12 @@ module Datadog
     def log_request(request, env, status, headers, start_time, end_time)
       log_data = {
         request: true,
-        request_ip: request.ip,
-        method: request.request_method,
-        controller: env["sinatra.controller_name"],
-        resource: env["sinatra.resource_name"] || env["sinatra.controller_name"],
-        action: env["sinatra.action_name"],
-        path: request.path,
         params: parse_query(request.query_string),
         status: status,
         format: headers["Content-Type"],
-        duration: calculate_duration(start_time, end_time)
+        duration: calculate_duration(start_time, end_time),
+        **aggregate_logs(request, env),
+        **current_user(env)
       }
 
       log_data[:message] = message(log_data)
@@ -92,5 +88,29 @@ module Datadog
 
       raise(exception)
     end
+
+    def config
+      @logger.config
+    end
+
+    def aggregate_logs(request, env)
+      hash = {}
+      hash[:request_ip]   = request.ip
+      hash[:method]       = request.request_method
+      hash[:path]         = request.path
+      hash[:controller]   = env[config.controller_key.to_s] if config.controller_key
+      hash[:action]       = env[config.action_key.to_s] if config.action_key
+      hash[:resource]     = env[config.resource_key.to_s] if config.resource_key
+
+      hash
+    end
+
+    def current_user(env)
+      return {} unless config.log_current_user?
+
+      {
+        user: config.current_user.call(env)
+      }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-json_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Eth3rnit3
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ddtrace
@@ -44,27 +44,23 @@ files:
 - Rakefile
 - Steepfile
 - datadog-json_logger.gemspec
+- lib/datadog/configuration.rb
 - lib/datadog/json_logger.rb
 - lib/datadog/loggers/json_formatter.rb
 - lib/datadog/loggers/version.rb
 - lib/datadog/sinatra_middleware.rb
 - nexus_release.sh
-- sig/datadog/json_logger.rbs
-- sig/datadog/loggers/json_formatter.rbs
-- sig/datadog/loggers/version.rbs
-- sig/datadog/sinatra_middleware.rbs
-- sig/datadog/tracing.rbs
-- sig/rack/request.rbs
-homepage: https://github.com/eth3rnit3/datadog-json_logger
+- sig/.keep
+homepage: https://github.com/buyco/datadog-json-logger
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/eth3rnit3/datadog-json_logger
-  source_code_uri: https://github.com/eth3rnit3/datadog-json_logger
-  changelog_uri: https://github.com/eth3rnit3/datadog-json_logger/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/buyco/datadog-json-logger
+  source_code_uri: https://github.com/buyco/datadog-json-logger
+  changelog_uri: https://github.com/buyco/datadog-json-logger/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -80,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Connect your ruby application to Datadog logging and tracing.
 test_files: []

data/sig/datadog/json_logger.rbs

@@ -1,14 +0,0 @@
-module Datadog
-  class Error < StandardError
-  end
-
-  class JSONLogger < Logger
-    @default_formatter: singleton(Loggers::JSONFormatter)
-
-    def initialize: (?IO | StringIO | File | NilClass output) -> void
-
-    private
-
-    def default_output: () -> IO
-  end
-end

data/sig/datadog/loggers/json_formatter.rbs

@@ -1,29 +0,0 @@
-module Datadog
-  module Loggers
-    class JSONFormatter < Logger::Formatter
-      def self.call: (String severity, DateTime datetime, String progname, untyped msg) ?{ (untyped) -> untyped } -> ::String
-
-      def self.base_log_hash: (String severity, DateTime datetime, String progname) -> { dd: Hash[untyped, untyped], timestamp: String, severity: String, progname: String }
-
-      def self.formatter_for: ((String | Hash[Symbol, untyped] | Exception) msg) -> untyped
-
-      def self.correlation_hash: () -> { trace_id: Integer, span_id: Integer, env: String, service: String, version: String | Integer }
-
-      module HashFormatter
-        def self?.format: (Hash[Symbol, untyped] log_hash, Hash[untyped, untyped] msg) -> untyped
-      end
-
-      module ExceptionFormatter
-        def self?.format: (Hash[Symbol, untyped] log_hash, Exception exception) -> untyped
-      end
-
-      module StringFormatter
-        def self?.format: (Hash[Symbol, untyped] log_hash, String msg) -> untyped
-      end
-
-      module DefaultFormatter
-        def self?.format: (Hash[Symbol, untyped] log_hash, untyped msg) -> untyped
-      end
-    end
-  end
-end

data/sig/datadog/loggers/version.rbs

@@ -1,5 +0,0 @@
-module Datadog
-  module Loggers
-    VERSION: String
-  end
-end

data/sig/datadog/sinatra_middleware.rbs

@@ -1,34 +0,0 @@
-module Rack
-  class CommonLogger
-    def log: (untyped _env, untyped _status, untyped _response_headers, untyped _began_at) -> nil
-  end
-end
-
-module Datadog
-  class SinatraMiddleware
-    @app: untyped
-    @logger: Logger
-    @raise_exceptions: bool
-
-    attr_reader app: untyped
-    attr_reader logger: Logger
-
-    def initialize: (untyped app, Logger logger, ?Hash[Symbol, untyped] opt) -> void
-
-    def call: (untyped env) -> untyped
-
-    private
-
-    def safely_process_request: (untyped env) -> untyped
-
-    def log_request: (Rack::Request request, untyped env, String status, Hash[String, String] headers, Time start_time, Time end_time) -> untyped
-                   
-    def message: (Hash[Symbol, untyped] log_data) -> String
-
-    def calculate_duration: (Time start_time, Time end_time) -> Integer
-
-    def parse_query: (String query_string) -> Hash[String, String]
-
-    def handle_exception: (Exception exception) -> Exception
-  end
-end

data/sig/datadog/tracing.rbs

@@ -1,90 +0,0 @@
-module Datadog
-  # Datadog APM tracing public API.
-  #
-  # The Datadog team ensures that public methods in this module
-  # only receive backwards compatible changes, and breaking changes
-  # will only occur in new major versions releases.
-  # @public_api
-  module Tracing
-    # (see Datadog::Tracing::Tracer#trace)
-    # @public_api
-    def self.trace: (untyped name, ?continue_from: untyped?, **untyped span_options) { () -> untyped } -> untyped
-
-    # (see Datadog::Tracing::Tracer#continue_trace!)
-    # @public_api
-    def self.continue_trace!: (untyped digest) { () -> untyped } -> untyped
-
-    # The tracer's internal logger instance.
-    # All tracing log output is handled by this object.
-    #
-    # The logger can be configured through {.configure},
-    # through {Datadog::Core::Configuration::Settings::DSL::Logger} options.
-    #
-    # @!attribute [r] logger
-    # @public_api
-    def self.logger: () -> untyped
-
-    # (see Datadog::Tracing::Tracer#active_trace)
-    # @public_api
-    def self.active_trace: () -> (nil | untyped)
-
-    # (see Datadog::Tracing::Tracer#active_span)
-    # @public_api
-    def self.active_span: () -> (nil | untyped)
-
-    # (see Datadog::Tracing::TraceSegment#keep!)
-    # If no trace is active, no action is taken.
-    # @public_api
-    def self.keep!: () -> untyped
-
-    # (see Datadog::Tracing::TraceSegment#reject!)
-    # If no trace is active, no action is taken.
-    # @public_api
-    def self.reject!: () -> untyped
-
-    # (see Datadog::Tracing::Tracer#active_correlation)
-    # @public_api
-    def self.correlation: () -> (nil | untyped)
-
-    # Textual representation of {.correlation}, which can be
-    # added to individual log lines in order to correlate them with the active
-    # trace.
-    #
-    # Example:
-    #
-    # ```
-    # MyLogger.log("#{Datadog::Tracing.log_correlation}] My message")
-    # # dd.env=prod dd.service=auth dd.version=13.8 dd.trace_id=5458478252992251 dd.span_id=7117552347370098 My message
-    # ```
-    #
-    # @return [String] correlation information
-    # @public_api
-    def self.log_correlation: () -> untyped
-
-    # Gracefully shuts down the tracer.
-    #
-    # The public tracing API will still respond to method calls as usual
-    # but might not internally perform the expected internal work after shutdown.
-    #
-    # This avoids errors being raised across the host application
-    # during shutdown while allowing for the graceful decommission of resources.
-    #
-    # {.shutdown!} cannot be reversed.
-    # @public_api
-    def self.shutdown!: () -> (nil | untyped)
-
-    # (see Datadog::Tracing::Pipeline.before_flush)
-    def self.before_flush: (*untyped processors) { () -> untyped } -> untyped
-
-    # Is the tracer collecting telemetry data in this process?
-    # @return [Boolean] `true` if the tracer is collecting data in this process, otherwise `false`.
-    def self.enabled?: () -> (false | untyped)
-
-    private
-
-    # DEV: components hosts both tracing and profiling inner objects today
-    def self.components: () -> untyped
-
-    def self.tracer: () -> untyped
-  end
-end

data/sig/rack/request.rbs

@@ -1,362 +0,0 @@
-module Rack
-  class Request
-    self.@forwarded_priority: untyped
-
-    self.@x_forwarded_proto_priority: untyped
-
-    @env: untyped
-
-    @params: untyped
-
-    attr_accessor self.ip_filter: untyped
-
-    # The priority when checking forwarded headers. The default
-    # is <tt>[:forwarded, :x_forwarded]</tt>, which means, check the
-    # +Forwarded+ header first, followed by the appropriate
-    # <tt>X-Forwarded-*</tt> header.  You can revert the priority by
-    # reversing the priority, or remove checking of either
-    # or both headers by removing elements from the array.
-    #
-    # This should be set as appropriate in your environment
-    # based on what reverse proxies are in use.  If you are not
-    # using reverse proxies, you should probably use an empty
-    # array.
-    attr_accessor self.forwarded_priority: untyped
-
-    # The priority when checking either the <tt>X-Forwarded-Proto</tt>
-    # or <tt>X-Forwarded-Scheme</tt> header for the forwarded protocol.
-    # The default is <tt>[:proto, :scheme]</tt>, to try the
-    # <tt>X-Forwarded-Proto</tt> header before the
-    # <tt>X-Forwarded-Scheme</tt> header.  Rack 2 had behavior
-    # similar to <tt>[:scheme, :proto]</tt>.  You can remove either or
-    # both of the entries in array to ignore that respective header.
-    attr_accessor self.x_forwarded_proto_priority: untyped
-
-    ALLOWED_SCHEMES: ::Array["https" | "http" | "wss" | "ws"]
-
-    def initialize: (untyped env) -> void
-
-    def params: () -> untyped
-
-    def update_param: (untyped k, untyped v) -> untyped
-
-    def delete_param: (untyped k) -> untyped
-
-    module Env
-      @env: untyped
-
-      # The environment of the request.
-      attr_reader env: untyped
-
-      def initialize: (untyped env) -> void
-
-      # Predicate method to test to see if `name` has been set as request
-      # specific data
-      def has_header?: (untyped name) -> untyped
-
-      # Get a request specific value for `name`.
-      def get_header: (untyped name) -> untyped
-
-      # If a block is given, it yields to the block if the value hasn't been set
-      # on the request.
-      def fetch_header: (untyped name) { () -> untyped } -> untyped
-
-      # Loops through each key / value pair in the request specific data.
-      def each_header: () { () -> untyped } -> untyped
-
-      # Set a request specific value for `name` to `v`
-      def set_header: (untyped name, untyped v) -> untyped
-
-      # Add a header that may have multiple values.
-      #
-      # Example:
-      #   request.add_header 'Accept', 'image/png'
-      #   request.add_header 'Accept', '*/*'
-      #
-      #   assert_equal 'image/png,*/*', request.get_header('Accept')
-      #
-      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
-      def add_header: (untyped key, untyped v) -> untyped
-
-      # Delete a request specific value for `name`.
-      def delete_header: (untyped name) -> untyped
-
-      def initialize_copy: (untyped other) -> untyped
-    end
-
-    module Helpers
-      # The set of form-data media-types. Requests that do not indicate
-      # one of the media types present in this list will not be eligible
-      # for form-data / param parsing.
-      FORM_DATA_MEDIA_TYPES: ::Array["application/x-www-form-urlencoded" | "multipart/form-data"]
-
-      # The set of media-types. Requests that do not indicate
-      # one of the media types present in this list will not be eligible
-      # for param parsing like soap attachments or generic multiparts
-      PARSEABLE_DATA_MEDIA_TYPES: ::Array["multipart/related" | "multipart/mixed"]
-
-      # Default ports depending on scheme. Used to decide whether or not
-      # to include the port in a generated URI.
-      DEFAULT_PORTS: ::Hash[::String, 80 | 443]
-
-      # The address of the client which connected to the proxy.
-      HTTP_X_FORWARDED_FOR: "HTTP_X_FORWARDED_FOR"
-
-      # The contents of the host/:authority header sent to the proxy.
-      HTTP_X_FORWARDED_HOST: "HTTP_X_FORWARDED_HOST"
-
-      HTTP_FORWARDED: "HTTP_FORWARDED"
-
-      # The value of the scheme sent to the proxy.
-      HTTP_X_FORWARDED_SCHEME: "HTTP_X_FORWARDED_SCHEME"
-
-      # The protocol used to connect to the proxy.
-      HTTP_X_FORWARDED_PROTO: "HTTP_X_FORWARDED_PROTO"
-
-      # The port used to connect to the proxy.
-      HTTP_X_FORWARDED_PORT: "HTTP_X_FORWARDED_PORT"
-
-      # Another way for specifying https scheme was used.
-      HTTP_X_FORWARDED_SSL: "HTTP_X_FORWARDED_SSL"
-
-      def body: () -> untyped
-
-      def script_name: () -> untyped
-
-      def script_name=: (untyped s) -> untyped
-
-      def path_info: () -> untyped
-
-      def path_info=: (untyped s) -> untyped
-
-      def request_method: () -> untyped
-
-      def query_string: () -> untyped
-
-      def content_length: () -> untyped
-
-      def logger: () -> untyped
-
-      def user_agent: () -> untyped
-
-      # the referer of the client
-      def referer: () -> untyped
-
-      alias referrer referer
-
-      def session: () -> untyped
-
-      def session_options: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type DELETE
-      def delete?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type GET
-      def get?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type HEAD
-      def head?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type OPTIONS
-      def options?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type LINK
-      def link?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type PATCH
-      def patch?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type POST
-      def post?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type PUT
-      def put?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type TRACE
-      def trace?: () -> untyped
-
-      # Checks the HTTP request method (or verb) to see if it was of type UNLINK
-      def unlink?: () -> untyped
-
-      def scheme: () -> ("https" | "https" | untyped)
-
-      # The authority of the incoming request as defined by RFC3976.
-      # https://tools.ietf.org/html/rfc3986#section-3.2
-      #
-      # In HTTP/1, this is the `host` header.
-      # In HTTP/2, this is the `:authority` pseudo-header.
-      def authority: () -> untyped
-
-      # The authority as defined by the `SERVER_NAME` and `SERVER_PORT`
-      # variables.
-      def server_authority: () -> (nil | untyped)
-
-      def server_name: () -> untyped
-
-      def server_port: () -> untyped
-
-      def cookies: () -> untyped
-
-      def content_type: () -> untyped
-
-      def xhr?: () -> untyped
-
-      # The `HTTP_HOST` header.
-      def host_authority: () -> untyped
-
-      def host_with_port: (?untyped authority) -> untyped
-
-      # Returns a formatted host, suitable for being used in a URI.
-      def host: () -> untyped
-
-      # Returns an address suitable for being to resolve to an address.
-      # In the case of a domain name or IPv4 address, the result is the same
-      # as +host+. In the case of IPv6 or future address formats, the square
-      # brackets are removed.
-      def hostname: () -> untyped
-
-      def port: () -> untyped
-
-      def forwarded_for: () -> (untyped | nil)
-
-      def forwarded_port: () -> (untyped | nil)
-
-      def forwarded_authority: () -> (untyped | nil)
-
-      def ssl?: () -> untyped
-
-      def ip: () -> untyped
-
-      # The media type (type/subtype) portion of the CONTENT_TYPE header
-      # without any media type parameters. e.g., when CONTENT_TYPE is
-      # "text/plain;charset=utf-8", the media-type is "text/plain".
-      #
-      # For more information on the use of media types in HTTP, see:
-      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
-      def media_type: () -> untyped
-
-      # The media type parameters provided in CONTENT_TYPE as a Hash, or
-      # an empty Hash if no CONTENT_TYPE or media-type parameters were
-      # provided.  e.g., when the CONTENT_TYPE is "text/plain;charset=utf-8",
-      # this method responds with the following Hash:
-      #   { 'charset' => 'utf-8' }
-      def media_type_params: () -> untyped
-
-      # The character set of the request body if a "charset" media type
-      # parameter was given, or nil if no "charset" was specified. Note
-      # that, per RFC2616, text/* media types that specify no explicit
-      # charset are to be considered ISO-8859-1.
-      def content_charset: () -> untyped
-
-      # Determine whether the request body contains form-data by checking
-      # the request content-type for one of the media-types:
-      # "application/x-www-form-urlencoded" or "multipart/form-data". The
-      # list of form-data media types can be modified through the
-      # +FORM_DATA_MEDIA_TYPES+ array.
-      #
-      # A request body is also assumed to contain form-data when no
-      # content-type header is provided and the request_method is POST.
-      def form_data?: () -> untyped
-
-      # Determine whether the request body contains data by checking
-      # the request media_type against registered parse-data media-types
-      def parseable_data?: () -> untyped
-
-      # Returns the data received in the query string.
-      def GET: () -> untyped
-
-      # Returns the data received in the request body.
-      #
-      # This method support both application/x-www-form-urlencoded and
-      # multipart/form-data.
-      def POST: () -> untyped
-
-      # The union of GET and POST data.
-      #
-      # Note that modifications will not be persisted in the env. Use update_param or delete_param if you want to destructively modify params.
-      def params: () -> untyped
-
-      # Destructively update a parameter, whether it's in GET and/or POST. Returns nil.
-      #
-      # The parameter is updated wherever it was previous defined, so GET, POST, or both. If it wasn't previously defined, it's inserted into GET.
-      #
-      # <tt>env['rack.input']</tt> is not touched.
-      def update_param: (untyped k, untyped v) -> (nil | untyped)
-
-      # Destructively delete a parameter, whether it's in GET or POST. Returns the value of the deleted parameter.
-      #
-      # If the parameter is in both GET and POST, the POST value takes precedence since that's how #params works.
-      #
-      # <tt>env['rack.input']</tt> is not touched.
-      def delete_param: (untyped k) -> untyped
-
-      def base_url: () -> ::String
-
-      # Tries to return a remake of the original request URL as a string.
-      def url: () -> untyped
-
-      def path: () -> untyped
-
-      def fullpath: () -> (untyped | ::String)
-
-      def accept_encoding: () -> untyped
-
-      def accept_language: () -> untyped
-
-      def trusted_proxy?: (untyped ip) -> untyped
-
-      # shortcut for <tt>request.params[key]</tt>
-      def []: (untyped key) -> untyped
-
-      # shortcut for <tt>request.params[key] = value</tt>
-      #
-      # Note that modifications will not be persisted in the env. Use update_param or delete_param if you want to destructively modify params.
-      def []=: (untyped key, untyped value) -> untyped
-
-      # like Hash#values_at
-      def values_at: (*untyped keys) -> untyped
-
-      private
-
-      def default_session: () -> ::Hash[untyped, untyped]
-
-      # Assist with compatibility when processing `X-Forwarded-For`.
-      def wrap_ipv6: (untyped host) -> (::String | untyped)
-
-      def parse_http_accept_header: (untyped header) -> untyped
-
-      # Get an array of values set in the RFC 7239 `Forwarded` request header.
-      def get_http_forwarded: (untyped token) -> untyped
-
-      def query_parser: () -> untyped
-
-      def parse_query: (untyped qs, ?::String d) -> untyped
-
-      def parse_multipart: () -> untyped
-
-      def expand_param_pairs: (untyped pairs, ?untyped query_parser) -> untyped
-
-      def split_header: (untyped value) -> (untyped | ::Array[untyped])
-
-      AUTHORITY: ::Regexp
-
-      def split_authority: (untyped authority) -> ::Array[untyped]
-
-      def reject_trusted_ip_addresses: (untyped ip_addresses) -> untyped
-
-      FORWARDED_SCHEME_HEADERS: { proto: untyped, scheme: untyped }
-
-      def forwarded_scheme: () -> (untyped | nil)
-
-      def allowed_scheme: (untyped header) -> (untyped | nil)
-
-      def forwarded_priority: () -> untyped
-
-      def x_forwarded_proto_priority: () -> untyped
-    end
-
-    include Env
-
-    include Helpers
-  end
-end