noresponse 2.1.6 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953aaf4d77bd7078a2f57974957a15fcef6137a2551b4fb4123184fb6535ac7d
-  data.tar.gz: 922e8eedbf3c54bf642b68f3648755afae11785fe8fa70ac8d7b78167f5e8e0a
+  metadata.gz: 23eb30fbb62a49330cd9e5db69140d6ccfeb408d7a44937d594f54e4b8482761
+  data.tar.gz: 7d11e9e140129264da5d4a897096a10e15a01c68d6bd991a0645357cac0b6058
 SHA512:
-  metadata.gz: 30dc14f0b68d530ceeabbe221c83d6b6dbf2506905d65edb3fd100db3606bfdda60f043caff442dec303f0151c3c9191ae806833c516bc3f5688127b5a8c2781
-  data.tar.gz: 9fc977645d6d05b42a29e1a7e414d46aa29f5d625a35c0ae4b5be875737d1b1e6a1e051dd08151469fe5c31cdec09ff8e258ae24b4d371733550324f48ad31c6
+  metadata.gz: 30f786d6011a91db0826d647bd31a7a987c46a4ccc4bef38f0b08c537a29aac412ecde15e3a53241135ae9508a727489cc9071460f04a47f0ea2bf3575f79595
+  data.tar.gz: a0150b0114a84e97d0ccb31aeb56bfe1500f9664e6e139912c9eb258bda05b9df1500facc100b5a0734aeaa7fa817f04d6b292b84c4476604a119a5379f329bf

data/lib/no_response/late_results.rb

@@ -156,6 +156,17 @@ module NoResponse
 
         Auth0.new(Caller.new('auth0', base, "Bearer #{token}", http_client))
       end
+
+      # A provider for an app with its own login, or for trying the handler
+      # before you wire up a real one. revoke_sessions and ban each log one
+      # line saying what they would do and call nothing: no request leaves
+      # your process. log is any callable that takes the line; the default
+      # writes it to standard error with Kernel#warn. Replace it with your own
+      # provider (name, revoke_sessions and ban) once you know what revoking
+      # and banning mean in your app.
+      def log_only(log: nil)
+        LogOnly.new(log || ->(line) { Kernel.warn(line) })
+      end
     end
 
     # One provider HTTP client: base URL, Authorization header, error mapping.
@@ -303,5 +314,25 @@ module NoResponse
         revoke_sessions(user_id)
       end
     end
+
+    class LogOnly
+      def initialize(log)
+        @log = log
+      end
+
+      def name = 'log_only'
+
+      def revoke_sessions(user_id)
+        Segment.encode(user_id)
+        @log.call("NoResponse late result (log only): would revoke every session of user #{user_id}")
+        nil
+      end
+
+      def ban(user_id)
+        Segment.encode(user_id)
+        @log.call("NoResponse late result (log only): would ban user #{user_id} and end their sessions")
+        nil
+      end
+    end
   end
 end

data/lib/no_response/models/operations/listwebhookdeliveries_request.rb

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class ListWebhookDeliveriesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
+        field :endpoint_id, ::String, {'path_param': {'field_name': "endpoint_id", 'style': "simple", 'explode': false}}
+        # next_cursor from the previous page, unchanged.
+        field(
+          :cursor,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "cursor", 'style': "form", 'explode': true}}
+        )
+        # Attempts per page.
+        field(
+          :limit,
+          Crystalline::Nilable.new(::Integer),
+          {'query_param': {'field_name': "limit", 'style': "form", 'explode': true}}
+        )
+
+        sig { params(endpoint_id: ::String, cursor: T.nilable(::String), limit: T.nilable(::Integer)).void }
+        def initialize(endpoint_id:, cursor: nil, limit: 20)
+          @endpoint_id = endpoint_id
+          @cursor = cursor
+          @limit = limit
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @endpoint_id == other.endpoint_id
+          return false unless @cursor == other.cursor
+          return false unless @limit == other.limit
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/listwebhookdeliveries_request.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::ListWebhookDeliveriesRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::ListWebhookDeliveriesRequest
+  def endpoint_id
+  end
+
+  def endpoint_id=(str_)
+  end
+
+  def cursor
+  end
+
+  def cursor=(str_)
+  end
+
+  def limit
+  end
+
+  def limit=(str_)
+  end
+end

data/lib/no_response/models/operations/listwebhookdeliveries_response.rb

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class ListWebhookDeliveriesResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+        sig { returns(T.proc.returns(T.nilable(ListWebhookDeliveriesResponse))) }
+        attr_accessor :next_page
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+
+        field :result, Models::Shared::WebhookDeliveryList, {}
+
+        sig { params(headers: T::Hash[Symbol, T::Array[::String]], result: Models::Shared::WebhookDeliveryList).void }
+        def initialize(headers:, result:)
+          @headers = headers
+          @result = result
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @headers == other.headers
+          return false unless @result == other.result
+          true
+        end
+
+        def each
+          page = self
+          loop do
+            yield page
+            next_page = page.next_page.call if page.next_page
+            break if next_page.nil?
+            page = T.must(next_page)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/listwebhookdeliveries_response.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::ListWebhookDeliveriesResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::ListWebhookDeliveriesResponse
+  def headers
+  end
+
+  def headers=(str_)
+  end
+
+  def result
+  end
+
+  def result=(str_)
+  end
+end

data/lib/no_response/models/operations/replaywebhookdelivery_request.rb

@@ -0,0 +1,37 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class ReplayWebhookDeliveryRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The endpoint's whe_ id. An id that is unknown, malformed or another tenant's answers 404.
+        field :endpoint_id, ::String, {'path_param': {'field_name': "endpoint_id", 'style': "simple", 'explode': false}}
+        # The evt_ id of a delivery the endpoint's log holds, as GET /v1/webhooks/{endpoint_id}/deliveries lists it. An id that is malformed, not sent to this endpoint, past the log's retention or another tenant's answers 404.
+        field :event_id, ::String, {'path_param': {'field_name': "event_id", 'style': "simple", 'explode': false}}
+
+        field :body, Models::Shared::WebhookReplayRequest, {'request': {'media_type': "application/json"}}
+
+        sig { params(endpoint_id: ::String, event_id: ::String, body: Models::Shared::WebhookReplayRequest).void }
+        def initialize(endpoint_id:, event_id:, body:)
+          @endpoint_id = endpoint_id
+          @event_id = event_id
+          @body = body
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @endpoint_id == other.endpoint_id
+          return false unless @event_id == other.event_id
+          return false unless @body == other.body
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/replaywebhookdelivery_request.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::ReplayWebhookDeliveryRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::ReplayWebhookDeliveryRequest
+  def endpoint_id
+  end
+
+  def endpoint_id=(str_)
+  end
+
+  def event_id
+  end
+
+  def event_id=(str_)
+  end
+
+  def body
+  end
+
+  def body=(str_)
+  end
+end

data/lib/no_response/models/operations/replaywebhookdelivery_response.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class ReplayWebhookDeliveryResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+
+        field :result, Models::Shared::WebhookReplay, {}
+
+        sig { params(headers: T::Hash[Symbol, T::Array[::String]], result: Models::Shared::WebhookReplay).void }
+        def initialize(headers:, result:)
+          @headers = headers
+          @result = result
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @headers == other.headers
+          return false unless @result == other.result
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/replaywebhookdelivery_response.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::ReplayWebhookDeliveryResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::ReplayWebhookDeliveryResponse
+  def headers
+  end
+
+  def headers=(str_)
+  end
+
+  def result
+  end
+
+  def result=(str_)
+  end
+end

data/lib/no_response/models/operations.rb

@@ -19,10 +19,14 @@ module NoResponse
       autoload :ListAccountAssessmentsRequest, "no_response/models/operations/listaccountassessments_request.rb"
       autoload :ListAccountAssessmentsResponse, "no_response/models/operations/listaccountassessments_response.rb"
       autoload :ListIntegrationsResponse, "no_response/models/operations/listintegrations_response.rb"
+      autoload :ListWebhookDeliveriesRequest, "no_response/models/operations/listwebhookdeliveries_request.rb"
+      autoload :ListWebhookDeliveriesResponse, "no_response/models/operations/listwebhookdeliveries_response.rb"
       autoload :ListWebhookEndpointsResponse, "no_response/models/operations/listwebhookendpoints_response.rb"
       autoload :QueryAccountAssessmentsResponse, "no_response/models/operations/queryaccountassessments_response.rb"
       autoload :RecordAssessmentOutcomeRequest, "no_response/models/operations/recordassessmentoutcome_request.rb"
       autoload :RecordAssessmentOutcomeResponse, "no_response/models/operations/recordassessmentoutcome_response.rb"
+      autoload :ReplayWebhookDeliveryRequest, "no_response/models/operations/replaywebhookdelivery_request.rb"
+      autoload :ReplayWebhookDeliveryResponse, "no_response/models/operations/replaywebhookdelivery_response.rb"
       autoload :RotateApiKeyResponse, "no_response/models/operations/rotateapikey_response.rb"
       autoload :RotateIntegrationSecretRequest, "no_response/models/operations/rotateintegrationsecret_request.rb"
       autoload :RotateIntegrationSecretResponse, "no_response/models/operations/rotateintegrationsecret_response.rb"

data/lib/no_response/models/shared/eventtype.rb

@@ -0,0 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class EventType
+        include ::Crystalline::Enum
+        enums do
+          ASSESSMENT_UPDATED = new("assessment.updated")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/eventtype.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::EventType
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::EventType
+end

data/lib/no_response/models/shared/failure.rb

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Failure - Why the attempt failed: the URL is no longer valid, the host did not resolve, it resolved to an address that is not public, no answer within 5 seconds, the connection failed, a 3xx (redirects are not followed) or another non-2xx status. Absent for a delivered attempt.
+      class Failure
+        include ::Crystalline::Enum
+        enums do
+          INVALID_URL = new("invalid_url")
+          RESOLVE_FAILED = new("resolve_failed")
+          ADDRESS_REFUSED = new("address_refused")
+          TIMEOUT = new("timeout")
+          CONNECTION_FAILED = new("connection_failed")
+          REDIRECT = new("redirect")
+          NON_2XX = new("non_2xx")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/failure.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Failure
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Failure
+end

data/lib/no_response/models/shared/webhookdeliveryattempt.rb

@@ -0,0 +1,137 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class WebhookDeliveryAttempt
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The event id the receiver saw as NR-Webhook-Id and as the body's id. Replay it with POST /v1/webhooks/{endpoint_id}/deliveries/{event_id}/replay.
+        field(
+          :event_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("event_id"), required: true}}
+        )
+
+        field(
+          :event_type,
+          Models::Shared::EventType,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("event_type"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EventType, false)
+            }
+          }
+        )
+        # Which attempt of this delivery this was: 1 for the first send, up to 9 with retries. A replay counts its own attempts from 1.
+        field(
+          :attempt,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attempt"), required: true}}
+        )
+        # true for an attempt of a replay you asked for.
+        field(
+          :replay,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("replay"), required: true}}
+        )
+        # delivered when the endpoint answered 2xx; failed otherwise, with failure naming why.
+        field(
+          :status,
+          Models::Shared::WebhookDeliveryAttemptStatus,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("status"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::WebhookDeliveryAttemptStatus, false)
+            }
+          }
+        )
+        # Milliseconds from sending the request to the answer or the failure.
+        field(
+          :latency_ms,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("latency_ms"), required: true}}
+        )
+        # When the request was sent. Its NR-Webhook-Timestamp is this time in Unix seconds.
+        field(
+          :attempted_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attempted_at"), required: true}}
+        )
+        # The HTTP status the endpoint answered. Absent when no response was read.
+        field(
+          :response_code,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("response_code")}}
+        )
+        # Why the attempt failed: the URL is no longer valid, the host did not resolve, it resolved to an address that is not public, no answer within 5 seconds, the connection failed, a 3xx (redirects are not followed) or another non-2xx status. Absent for a delivered attempt.
+        field(
+          :failure,
+          Crystalline::Nilable.new(Models::Shared::Failure),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("failure"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Failure, true)
+            }
+          }
+        )
+
+        sig {
+          params(
+            event_id: ::String,
+            event_type: Models::Shared::EventType,
+            attempt: ::Integer,
+            replay: T::Boolean,
+            status: Models::Shared::WebhookDeliveryAttemptStatus,
+            latency_ms: ::Integer,
+            attempted_at: ::String,
+            response_code: T.nilable(::Integer),
+            failure: T.nilable(Models::Shared::Failure)
+          )
+            .void
+        }
+        def initialize(
+          event_id:,
+          event_type:,
+          attempt:,
+          replay:,
+          status:,
+          latency_ms:,
+          attempted_at:,
+          response_code: nil,
+          failure: nil
+        )
+          @event_id = event_id
+          @event_type = event_type
+          @attempt = attempt
+          @replay = replay
+          @status = status
+          @latency_ms = latency_ms
+          @attempted_at = attempted_at
+          @response_code = response_code
+          @failure = failure
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @event_id == other.event_id
+          return false unless @event_type == other.event_type
+          return false unless @attempt == other.attempt
+          return false unless @replay == other.replay
+          return false unless @status == other.status
+          return false unless @latency_ms == other.latency_ms
+          return false unless @attempted_at == other.attempted_at
+          return false unless @response_code == other.response_code
+          return false unless @failure == other.failure
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/webhookdeliveryattempt.rbi

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::WebhookDeliveryAttempt
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::WebhookDeliveryAttempt
+  def event_id
+  end
+
+  def event_id=(str_)
+  end
+
+  def event_type
+  end
+
+  def event_type=(str_)
+  end
+
+  def attempt
+  end
+
+  def attempt=(str_)
+  end
+
+  def replay
+  end
+
+  def replay=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def latency_ms
+  end
+
+  def latency_ms=(str_)
+  end
+
+  def attempted_at
+  end
+
+  def attempted_at=(str_)
+  end
+
+  def response_code
+  end
+
+  def response_code=(str_)
+  end
+
+  def failure
+  end
+
+  def failure=(str_)
+  end
+end

data/lib/no_response/models/shared/webhookdeliveryattemptstatus.rb

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # WebhookDeliveryAttemptStatus - delivered when the endpoint answered 2xx; failed otherwise, with failure naming why.
+      class WebhookDeliveryAttemptStatus
+        include ::Crystalline::Enum
+        enums do
+          DELIVERED = new("delivered")
+          FAILED = new("failed")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/webhookdeliveryattemptstatus.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::WebhookDeliveryAttemptStatus
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::WebhookDeliveryAttemptStatus
+end

data/lib/no_response/models/shared/webhookdeliverylist.rb

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The 200 answer of GET /v1/webhooks/{endpoint_id}/deliveries: one page of the endpoint's delivery attempts, newest first. Each item is one POST to the endpoint. Attempts are kept for 30 days, or the tenant's retention_days when that is shorter, and are deleted with the assessment they carried. next_cursor is present only when another page exists.
+      class WebhookDeliveryList
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Opaque id of the endpoint registration.
+        field(
+          :endpoint_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("endpoint_id"), required: true}}
+        )
+
+        field(
+          :items,
+          Crystalline::Array.new(Models::Shared::WebhookDeliveryAttempt),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
+        )
+        # Opaque cursor for the next page, MAC'd by the server and bound to the tenant and endpoint it was issued for. Pass it back unchanged as cursor; a tampered, foreign or expired cursor answers 400 invalid_cursor.
+        field(
+          :next_cursor,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("next_cursor")}}
+        )
+
+        sig {
+          params(
+            endpoint_id: ::String,
+            items: T::Array[Models::Shared::WebhookDeliveryAttempt],
+            next_cursor: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(endpoint_id:, items:, next_cursor: nil)
+          @endpoint_id = endpoint_id
+          @items = items
+          @next_cursor = next_cursor
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @endpoint_id == other.endpoint_id
+          return false unless @items == other.items
+          return false unless @next_cursor == other.next_cursor
+          true
+        end
+      end
+    end
+  end
+end