vigiles 0.1.0.pre.beta3 → 0.1.0.pre.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7d3519a6e858e96fb583784e5fc6b79943ec60bf20e97437eb40552bb9583b
-  data.tar.gz: d17b829ca3369c0324f8696943b53949be682bdfb0695fe19631f5fc9d299f34
+  metadata.gz: 7e4ea4b46169baf532079483c8827ee4d96f44165e3b5b1f4c021ac99a9a82bd
+  data.tar.gz: 8735c9877784c68115ea803aea9bad226d7926528208cbad19fef1f5d0d00b60
 SHA512:
-  metadata.gz: 4915409f03686c6181d3dfc54e1cc2a965a2808f0901f67e2a72836665ced0b13de3bfcab06cfff1227aac48b0aa0ff96e1c6ce4b24cff6c6210136e79d15c97
-  data.tar.gz: f6ae4066b0195444ade50c2c60e21f5fdfbb1251d6050669e981ee5c7c2f7decd2dd22bbdbf6764c1404e78ac61ab4531f435b877b400527634a4569863bebfe
+  metadata.gz: 8d8d94f910b17027a7db1776db0f1ec84b197a2a47e64de039cfab327af8d59cbfd7037ada8fa403f2c04cf4ef2f7697cb206da86529deab44d4f90bb7c92919
+  data.tar.gz: 0ed649f1d6fe5ef184d286eba622c7fbade046686bf56d7e8f0f35e06aad77820fa64c5434b64f68663537791e80ef5036c7ee228a79267463571e1319457107

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   Exclude:
     - "**/generators/**/*"
     - "**/sorbet/**/*"
@@ -22,5 +22,14 @@ Style/AccessModifierDeclarations:
   Enabled: true
   EnforcedStyle: inline
 
+Style/Documentation:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/lib/vigiles/archive/extras.rb

@@ -3,11 +3,12 @@
 
 module Vigiles
   module Archive
-    class Extras < T::Struct;
-      const :request_env, T.untyped
+    class Extras < T::Struct
+      const :request_env, T::Hash[T.untyped, T.untyped]
 
+      sig { params(request_env: T::Hash[T.untyped, T.untyped]).returns(Extras) }
       def self.from(request_env)
-        Extras.new(request_env:)
+        Extras.new(request_env: request_env)
       end
     end
   end

data/lib/vigiles/archive/metadata.rb

@@ -4,10 +4,11 @@
 module Vigiles
   module Archive
     class Metadata < T::Struct
-      const :request_env, T.untyped
+      const :request_env, T::Hash[T.untyped, T.untyped]
 
+      sig { params(request_env: T::Hash[T.untyped, T.untyped]).returns(Metadata) }
       def self.from(request_env)
-        Metadata.new(request_env:)
+        Metadata.new(request_env: request_env)
       end
     end
   end

data/lib/vigiles/archive/request.rb

@@ -8,6 +8,20 @@ module Vigiles
     extend T::Sig
 
     class Request < T::Struct
+      # raised when some request parameters are either bad/invalid
+      # or absent. for example, it is required the request url always
+      # be present, and have either http or https scheme.
+      class InvalidParameterError < StandardError
+        sig { returns(String) }
+        attr_reader :parameter
+
+        sig { params(parameter: String).void }
+        def initialize(parameter)
+          @parameter = parameter
+          super
+        end
+      end
+
       const :content_type, String
       const :http_method,  Types::HttpMethod
       const :user_agent,   String
@@ -24,17 +38,17 @@ module Vigiles
       sig { params(request: ActionDispatch::Request).returns(Request) }
       def self.from(request)
         Request.new(
-          content_type: request.content_type,
-          user_agent: request.user_agent,
+          content_type: request.content_type || (raise InvalidParameterError, "content_type"),
+          user_agent: request.user_agent || "unknown_user_agent",
           timestamp: DateTime.now,
           remote_ip: IPAddr.new(request.remote_ip),
           protocol: request.protocol,
           headers: {},
-          origin: request.origin || "n/a",
+          origin: request.origin || "unknown_origin_url",
           payload: request.body.read,
           http_method: Types::HttpMethod.deserialize(request.method),
           path: request.path,
-          url: URI.parse(request.url),
+          url: Utilities::URI.parse_into_http_or_https(request.url),
           id: request.request_id
         )
       end

data/lib/vigiles/archive.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "action_dispatch"
-
 module Vigiles
   module Archive
     extend T::Sig
@@ -10,6 +8,14 @@ module Vigiles
     Types       = Vigiles::Types
     ContentType = Types::ContentType
 
+    class UnrecordableRequestError < StandardError
+      sig { params(reason: String).void }
+      def initialize(reason)
+        @reason = reason
+        super
+      end
+    end
+    
     sig { params(ad_response: ActionDispatch::Response).returns(T.nilable(Conversation)) }
     def self.record_conversation(ad_response)
         # preferring to call `response.request` instead of preparing a new
@@ -26,8 +32,10 @@ module Vigiles
       case (content_type = request.content_type)
       when ContentType::ApplicationJson.serialize then record_json_conversation(request:, response:, metadata:, extras:)
       when ContentType::TextHtml.serialize        then record_html_conversation(request:, response:, metadata:, extras:)
-      else record_conversation_with_unknown_content_type(request:)
+      else record_conversation_with_unknown_content_type(request:, response:, metadata:, extras:)
       end
+    rescue Request::InvalidParameterError => e
+      raise UnrecordableRequestError, "#{e.parameter} considered invalid"
     end
 
     sig do
@@ -60,7 +68,11 @@ module Vigiles
       )
     rescue => e
     end
+    
+    sig { params(request: Request, response: Response, metadata: Metadata, extras: Extras).returns(T.nilable(Conversation)) }
     private_class_method def self.record_html_conversation(request:, response:, metadata:, extras:); end
+
+    sig { params(request: Request, response: Response, metadata: Metadata, extras: Extras).returns(T.nilable(Conversation)) }
     private_class_method def self.record_conversation_with_unknown_content_type(
       request:,
       response:,

data/lib/vigiles/constants.rb

@@ -0,0 +1,7 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vigiles
+  module Constants
+  end
+end

data/lib/vigiles/middleware/record_conversation.rb

@@ -1,26 +1,13 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "rack"
-
+require "logger"
 module Vigiles
   module Middleware
     class RecordConversation
-      class Options < T::Struct
-        const :logger, T.untyped
-
-        sig { returns(Options) }
-        def self.defaults
-          Options.new(
-            logger: Rails.logger
-          )
-        end
-      end
-
-      sig { params(app: T.untyped, options: Options).void }
-      def initialize(app, options = Options.defaults)
-        @app    = app
-        @logger = options.logger
+      sig { params(app: T.untyped).void }
+      def initialize(app)
+        @app = app
       end
 
       sig { params(env: T.untyped).returns(T.untyped) }
@@ -30,15 +17,12 @@ module Vigiles
         end
       end
 
+      sig { params(blk: T.proc.returns(T.untyped)).returns(T.untyped) }
       private def record_conversation(&blk)
         rack_response = blk.call
         _, _, body    = rack_response
         response      = body.instance_variable_get(:@response)
-        unless response.nil?
-          convo = Vigiles.maybe_record_conversation(response)
-          @logger.info "conversation recorded: conversation_id=#{convo&.id}" if convo
-        end
-
+        Vigiles.maybe_record_conversation(response) unless response.nil?
         rack_response
       ensure
         rack_response

data/lib/vigiles/spec.rb

@@ -4,6 +4,6 @@
 module Vigiles
   class Spec < T::Struct
     sig { returns(Spec) }
-    def self.make_default_spec; end
+    def self.make_default_spec = Spec.new
   end
 end

data/lib/vigiles/utilities/uri.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vigiles
+  module Utilities
+    module URI
+      extend T::Sig
+
+      sig { params(url: String).returns(T.any(::URI::HTTP, ::URI::HTTPS)) }
+      def self.parse_into_http_or_https(url)
+        parsed_uri = ::URI.parse(url)
+        raise unless parsed_uri.is_a?(::URI::HTTP) || parsed_uri.is_a?(::URI::HTTPS)
+
+        parsed_uri
+      end
+    end
+  end
+end

data/lib/vigiles/version.rb

@@ -1,6 +1,6 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Vigiles
-  VERSION = "0.1.0-beta3"
+  VERSION = "0.1.0-beta5"
 end

data/lib/vigiles.rb

@@ -4,8 +4,10 @@
 require "zeitwerk"
 require "sorbet-runtime"
 require_relative "core_ext"
+require "action_dispatch"
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.inflector.inflect("uri" => "URI")
 loader.ignore("#{__dir__}/generators")
 loader.ignore("#{__dir__}/core_ext.rb")
 loader.ignore("#{__dir__}/core_ext")
@@ -19,11 +21,13 @@ module Vigiles
     return unless should_record?(response)
 
     Archive.record_conversation(response)
+  rescue Archive::UnrecordableRequestError
+    nil
   end
 
   sig { params(blk: T.untyped).void }
   def self.configure(&blk)
-    default_spec = Vigiles::Spec.default_specification
+    default_spec = Vigiles::Spec.make_default_spec
     blk.call(default_spec)
   end
 

data/sorbet/rbi/gems/{activemodel@7.0.5.rbi → actioncable@7.1.3.3.rbi}

@@ -1,8 +1,8 @@
 # typed: true
 
 # DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `activemodel` gem.
-# Please instead update this file by running `bin/tapioca gem activemodel`.
+# This is an autogenerated file for types exported from the `actioncable` gem.
+# Please instead update this file by running `bin/tapioca gem actioncable`.
 
 # THIS IS AN EMPTY RBI FILE.
 # see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem

data/sorbet/rbi/gems/actionmailbox@7.1.3.3.rbi

@@ -0,0 +1,8 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `actionmailbox` gem.
+# Please instead update this file by running `bin/tapioca gem actionmailbox`.
+
+# THIS IS AN EMPTY RBI FILE.
+# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem

data/sorbet/rbi/gems/{activerecord@7.0.5.rbi → actionmailer@7.1.3.3.rbi}

@@ -1,8 +1,8 @@
 # typed: true
 
 # DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `activerecord` gem.
-# Please instead update this file by running `bin/tapioca gem activerecord`.
+# This is an autogenerated file for types exported from the `actionmailer` gem.
+# Please instead update this file by running `bin/tapioca gem actionmailer`.
 
 # THIS IS AN EMPTY RBI FILE.
 # see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem