vigiles 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41caead3a350b299aaccd28f0a57472d7c91e1a3f4d99edc93fb5721883ede73
-  data.tar.gz: d890a26b05693bb9503e4ed5583489d9100eed2703c4e2b2028b03c4d7e863bc
+  metadata.gz: 5cad76457ae57c5b08da94044394a063e57f5d1e5ea5a8b9cea412876dce12bf
+  data.tar.gz: 6eb84b1766ef2e737652fc63e28924756b8d26d74b676d9f716f1db8e0744c8f
 SHA512:
-  metadata.gz: 06fd18e862c094ae7e90f602eb4505f0906528c17a28d69d04c2bd1f2dfa49b771c65bffdcd42590a93b44a85bdb13a0a7822889ec329cc9aee7b165297b171f
-  data.tar.gz: 036f4843fe70977471e7bf67d08850971593cff46abf1a47ae9fe8634b413b4eb7911eb92ac0fcbb107b34ff273f8d2d74d96148abab118efed400e22f25469d
+  metadata.gz: 23a0e61a11a529603eebc7e197961762b493c940a2b33cb510f0f81e419b2379a9a3e207eb236be1a1aae44009cf75f95aec401dc1b3ee95cefad6b678809505
+  data.tar.gz: 697eb918976d40ea0189d9b1de700caeae6931e28f41a6627d055c7c3d6eed4df44cf541d705f2ecb66931549c8af5825cf0177e9835eb2f2a7d2705dcf000b5

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.3
   Exclude:
     - "**/generators/**/*"
     - "**/sorbet/**/*"

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/lib/generators/vigiles/initializer_generator.rb

@@ -10,7 +10,7 @@ module Vigiles
         default configuration.
       DOC
 
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def copy_initializer_file
         copy_file \

data/lib/generators/vigiles/install_generator.rb

@@ -13,7 +13,7 @@ module Vigiles
         ]
       ).freeze
 
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def install_vigiles
         SUB_GENERATORS.each do |generator_task|

data/lib/generators/vigiles/migration_generator.rb

@@ -3,6 +3,7 @@
 
 require "rails/generators"
 require "rails/generators/active_record"
+require "active_record"
 
 module Vigiles
   module Generators
@@ -12,7 +13,7 @@ module Vigiles
 
       include ::Rails::Generators::Migration
 
-      source_root File.expand_path("../templates", __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def install
         migration_template(

data/lib/vigiles/archive/extras.rb

@@ -8,7 +8,7 @@ module Vigiles
 
       sig { params(request_env: T::Hash[T.untyped, T.untyped]).returns(Extras) }
       def self.from(request_env)
-        Extras.new(request_env: request_env)
+        Extras.new(request_env:)
       end
     end
   end

data/lib/vigiles/archive/metadata.rb

@@ -8,7 +8,7 @@ module Vigiles
 
       sig { params(request_env: T::Hash[T.untyped, T.untyped]).returns(Metadata) }
       def self.from(request_env)
-        Metadata.new(request_env: request_env)
+        Metadata.new(request_env:)
       end
     end
   end

data/lib/vigiles/archive/response.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Vigiles
@@ -10,6 +10,33 @@ module Vigiles
       const :payload,      Types::Payload
       const :status,       Integer
 
+      class ResponseBodyTooDeepError < StandardError
+        sig { returns(Integer) }
+        attr_reader :max_stack_depth
+
+        sig { returns(Integer) }
+        attr_reader :stack_depth
+
+        sig { params(stack_depth: Integer, max_stack_depth: Integer).void }
+        def initialize(stack_depth, max_stack_depth)
+          @max_stack_depth = max_stack_depth
+          @stack_depth     = stack_depth
+
+          super()
+        end
+      end
+
+      sig { params(body: Rack::BodyProxy, stack_depth: Integer).returns(String) }
+      private_class_method def self.extract_body_from_rack_body_proxy(body, stack_depth = 1)
+        raise ResponseBodyTooDeepError.new(stack_depth, 5) unless stack_depth < 5
+
+        case (inner_body = body.instance_variable_get(:@body))
+        when Rack::BodyProxy then extract_body_from_rack_body_proxy(inner_body, stack_depth + 1)
+        when Array           then inner_body[0] || "null"
+        else raise
+        end
+      end
+
       sig { params(rack_response: Rack::Response).returns(Types::Payload) }
       private_class_method def self.extract_payload(rack_response)
         case (body = rack_response.body)
@@ -18,12 +45,11 @@ module Vigiles
 
           { __false_body: :not_empty_handle_later }
         when Rack::BodyProxy
-          body_proxy = body
-          body_proxy = body_proxy.instance_variable_get(:@body) until body_proxy.is_a?(Array)
+          extracted_body = extract_body_from_rack_body_proxy(body)
           begin
-            JSON.parse(body_proxy[0])
+            JSON.parse(extracted_body)
           rescue StandardError
-            { __false_body: body_proxy[0] }
+            { __false_body: extracted_body }
           end
         else
           { __false_body: :unknown_response_payload_type }

data/lib/vigiles/archive.rb

@@ -15,7 +15,7 @@ module Vigiles
         super
       end
     end
-    
+
     sig { params(req: ActionDispatch::Request, res: Rack::Response).returns(T.nilable(Conversation)) }
     def self.record_conversation(req:, res:)
       content_type = req.content_type

data/lib/vigiles/constants.rb

@@ -8,7 +8,167 @@ module Vigiles
         %w[
           application/json
         ]
-      ), T::Set[String]
+      ).freeze,
+      T::Set[String]
+    )
+
+    ALL_IANA_CONTENT_TYPES = T.let(
+      {
+        Types::ContentType::ApplicationJson => Set.new(
+          %w[
+            application/3gppHal+json
+            application/3gppHalForms+json
+            application/ace+json
+            application/activity+json
+            application/aif+json
+            application/alto-cdni+json
+            application/alto-cdnifilter+json
+            application/alto-costmap+json
+            application/alto-costmapfilter+json
+            application/alto-directory+json
+            application/alto-endpointprop+json
+            application/alto-endpointpropparams+json
+            application/alto-endpointcost+json
+            application/alto-endpointcostparams+json
+            application/alto-error+json
+            application/alto-networkmapfilter+json
+            application/alto-networkmap+json
+            application/alto-propmap+json
+            application/alto-propmapparams+json
+            application/alto-tips+json
+            application/alto-tipsparams+json
+            application/alto-updatestreamcontrol+json
+            application/alto-updatestreamparams+json
+            application/atsc-rdt+json
+            application/calendar+json
+            application/captive+json
+            application/city+json
+            application/coap-group+json
+            application/csvm+json
+            application/cwl+json
+            application/dicom+json
+            application/dns+json
+            application/elm+json
+            application/EmergencyCallData.LegacyESN+json
+            application/expect-ct-report+json
+            application/fhir+json
+            application/geo+json
+            application/geo+json-seq
+            application/geoxacml+json
+            application/jf2feed+json
+            application/jose+json
+            application/jrd+json
+            application/jscalendar+json
+            application/jscontact+json
+            application/json
+            application/json-patch+json
+            application/json-seq
+            application/jsonpath
+            application/jwk+json
+            application/jwk-set+json
+            application/ld+json
+            application/linkset+json
+            application/manifest+json
+            application/merge-patch+json
+            application/mud+json
+            application/ppsp-tracker+json
+            application/problem+json
+            application/prs.implied-object+json
+            application/prs.implied-object+json-seq
+            application/pvd+json
+            application/rdap+json
+            application/reputon+json
+            application/sarif-external-properties+json
+            application/sarif+json
+            application/scim+json
+            application/senml-etch+json
+            application/senml+json
+            application/sensml+json
+            application/spdx+json
+            application/stix+json
+            application/taxii+json
+            application/td+json
+            application/tlsrpt+json
+            application/tm+json
+            application/vcard+json
+            application/vnd.acm.addressxfer+json
+            application/vnd.acm.chatbot+json
+            application/vnd.amadeus+json
+            application/vnd.apache.thrift.json
+            application/vnd.api+json
+            application/vnd.aplextor.warrp+json
+            application/vnd.apothekende.reservation+json
+            application/vnd.artisan+json
+            application/vnd.avalon+json
+            application/vnd.bbf.usp.msg+json
+            application/vnd.bekitzur-stech+json
+            application/vnd.byu.uapi+json
+            application/vnd.capasystems-pg+json
+            application/vnd.cncf.helm.config.v1+json
+            application/vnd.collection.doc+json
+            application/vnd.collection+json
+            application/vnd.collection.next+json
+            application/vnd.coreos.ignition+json
+            application/vnd.cryptii.pipe+json
+            application/vnd.cyclonedx+json
+            application/vnd.datapackage+json
+            application/vnd.dataresource+json
+            application/vnd.document+json
+            application/vnd.drive+json
+            application/vnd.eclipse.ditto+json
+            application/vnd.eu.kasparian.car+json
+            application/vnd.futoin+json
+            application/vnd.gentics.grd+json
+            application/vnd.geo+json
+            application/vnd.gnu.taler.exchange+json
+            application/vnd.gnu.taler.merchant+json
+            application/vnd.hal+json
+            application/vnd.hc+json
+            application/vnd.heroku+json
+            application/vnd.hyper-item+json
+            application/vnd.hyper+json
+            application/vnd.hyperdrive+json
+            application/vnd.ims.lis.v2.result+json
+            application/vnd.ims.lti.v2.toolconsumerprofile+json
+            application/vnd.ims.lti.v2.toolproxy.id+json
+            application/vnd.ims.lti.v2.toolproxy+json
+            application/vnd.ims.lti.v2.toolsettings+json
+            application/vnd.ims.lti.v2.toolsettings.simple+json
+            application/vnd.ipld.dag-json
+            application/vnd.las.las+json
+            application/vnd.leap+json
+            application/vnd.mason+json
+            application/vnd.micro+json
+            application/vnd.miele+json
+            application/vnd.nacamar.ybrid+json
+            application/vnd.nato.bindingdataobject+json
+            application/vnd.nearst.inv+json
+            application/vnd.oai.workflows+json
+            application/vnd.oci.image.manifest.v1+json
+            application/vnd.oftn.l10n+json
+            application/vnd.oma.lwm2m+json
+            application/vnd.oracle.resource+json
+            application/vnd.pagerduty+json
+            application/vnd.restful+json
+            application/vnd.seis+json
+            application/vnd.shootproof+json
+            application/vnd.shopkick+json
+            application/vnd.siren+json
+            application/vnd.syft+json
+            application/vnd.tableschema+json
+            application/vnd.think-cell.ppttc+json
+            application/vnd.vel+json
+            application/vnd.veritone.aion+json
+            application/vnd.xacml+json
+            application/voucher-cms+json
+            application/webpush-options+json
+            application/yang-data+json
+            application/yang-patch+json
+            application/yang-sid+json
+          ].map(&:downcase)
+        ).freeze
+      }.freeze,
+      T::Hash[Types::ContentType, T::Set[String]]
     )
 
     DEFAULT_CONTENT_TYPE_RECORDERS = T.let(

data/lib/vigiles/conversation_recorder.rb

@@ -20,6 +20,9 @@ module Vigiles
 
     abstract!
 
+    sig { abstract.params(req: ActionDispatch::Request).void }
+    def ensure_content_type_matches!(req); end
+
     sig { abstract.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
     def record(req:, res:); end
   end

data/lib/vigiles/conversation_recorders/application_json.rb

@@ -14,14 +14,19 @@ module Vigiles
       Request              = Vigiles::Archive::Request
       Extras               = Vigiles::Archive::Extras
 
+      sig { override.params(req: ActionDispatch::Request).void }
+      private def ensure_content_type_matches!(req)
+        return if req.content_type == ContentType::ApplicationJson.serialize
+
+        raise ConversationRecorder::MisconfiguredRecorderError.new(
+          expected: ContentType::ApplicationJson.serialize,
+          actual: req.content_type
+        )
+      end
+
       sig { override.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
       def record(req:, res:)
-        unless req.content_type == ContentType::ApplicationJson.serialize
-          raise ConversationRecorder::MisconfiguredRecorderError.new(
-            expected: ContentType::ApplicationJson.serialize,
-            actual: req.content_type
-          )
-        end
+        ensure_content_type_matches!(req)
 
         response = Response.from(res)
         request  = Request.from(req)

data/lib/vigiles/conversation_recorders/unknown.rb

@@ -6,6 +6,9 @@ module Vigiles
     class Unknown < ConversationRecorder
       include Singleton
 
+      sig { override.params(req: ActionDispatch::Request).void }
+      def ensure_content_type_matches!(req); end
+
       sig { override.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
       def record(req:, res:) = Archive::Conversation.new
     end

data/lib/vigiles/middleware/record_conversation.rb

@@ -13,7 +13,7 @@ module Vigiles
         to: :options
 
       sig { params(app: T.untyped, options: Vigiles::Options).void }
-      def initialize(app, options=Vigiles::Options.make_default_options)
+      def initialize(app, options = Vigiles::Options.make_default_options)
         @app     = app
         @options = options
       end
@@ -36,7 +36,7 @@ module Vigiles
             "[vigiles] conversation recorder: " \
             "conversation=#{convo.nil? ? "not_recorded" : convo.id} " \
             "request=#{req.request_id}"
-        rescue => e
+        rescue StandardError => e
           capture_exception.call(e)
           logger.warn \
             "[vigiles] conversation recorder error: " \

data/lib/vigiles/options.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "logger"
+require "rails"
 
 module Vigiles
   class Options < T::Struct

data/lib/vigiles/types.rb

@@ -24,6 +24,12 @@ module Vigiles
       end
     end
 
+    class WellKnownHttpHeader < T::Enum
+      enums do
+        ContentType = new("content-type")
+      end
+    end
+
     HtmlPayload = String
 
     UntypedHash = T.type_alias { T::Hash[T.untyped, T.untyped] }

data/lib/vigiles/utilities/http.rb

@@ -0,0 +1,60 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vigiles
+  module Utilities
+    module HTTP
+      extend T::Sig
+
+      WellKnownHttpHeader = Vigiles::Types::WellKnownHttpHeader
+      ContentType         = Vigiles::Types::ContentType
+
+      # if http headers could be stemmed, this is what the
+      # method below would have done. at the moment, it works
+      # for only a few headers, and tries to clean up excesses
+      # that are not necessarily part of the value.
+      #
+      # since it raises, do not call unless you have explicitly
+      # handled the header. thanks!
+      sig { params(header: String, value: String).returns(String) }
+      def self.sanitize_header_value(header:, value:)
+        # don't attempt to sanitize values for relatively unknown
+        # headers. for example, custom headers (those with the x
+        # prefix). obviously if the value is blank then no sanitization
+        # is necessary.
+        return value if value.blank? || !well_known?(header)
+
+        case header.downcase
+        when "content-type" then sanitize_content_type(value.strip)
+        else raise ArgumentError, header
+        end
+      end
+
+      sig { params(header_value: String).returns(String) }
+      private_class_method def self.sanitize_content_type(header_value)
+        downcased_v = header_value.downcase
+        return ContentType::ApplicationJson.serialize if json?(downcased_v)
+
+        raise
+      end
+
+      sig { params(header: String).returns(T::Boolean) }
+      private_class_method def self.well_known?(header)
+        WellKnownHttpHeader.deserialize(header.downcase)
+        true
+      rescue StandardError
+        false
+      end
+
+      sig { params(header_value: String).returns(T::Boolean) }
+      private_class_method def self.json?(header_value)
+        return false if header_value.blank?
+
+        application_json = T.must(header_value.split(/;/).first)
+        T.must(
+          Constants::ALL_IANA_CONTENT_TYPES[ContentType::ApplicationJson]
+        ).include?(application_json)
+      end
+    end
+  end
+end

data/lib/vigiles/utilities/json.rb

@@ -8,11 +8,12 @@ module Vigiles
     module JSON
       extend T::Sig
 
-      sig { params(text: String).returns(T.any(String, Vigiles::Types::UntypedHash)) }
+      sig { params(text: String).returns(T.untyped) }
       def self.parse_benignly(text)
         ::JSON.parse(text)
       rescue StandardError
-        text
+        return text unless block_given?
+        yield text
       end
     end
   end

data/lib/vigiles/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Vigiles
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/vigiles.rb

@@ -1,13 +1,18 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "zeitwerk"
 require "sorbet-runtime"
 require "action_dispatch"
+require "zeitwerk"
+
 require_relative "core_ext"
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
-loader.inflector.inflect("uri" => "URI", "json" => "JSON")
+loader.inflector.inflect(
+  "json" => "JSON",
+  "http" => "HTTP",
+  "uri" => "URI"
+)
 loader.ignore("#{__dir__}/generators")
 loader.ignore("#{__dir__}/core_ext.rb")
 loader.ignore("#{__dir__}/core_ext")
@@ -49,7 +54,14 @@ module Vigiles
 
   sig { params(request: ActionDispatch::Request).returns(T::Boolean) }
   private_class_method def self.content_type_match?(request)
-    !request.nil?
+    return false if (content_type = request.content_type).nil?
+
+    spec.request_content_types.include?(
+      Utilities::HTTP.sanitize_header_value(
+        header: "content-type",
+        value: content_type
+      )
+    )
   end
 
   sig { params(req: ActionDispatch::Request).returns(T::Boolean) }