hawk-ruby 0.1.0

data/sig/hawk/json_value.rbs

@@ -0,0 +1,17 @@
+module Hawk
+  class JSONValue
+    @seen: Hash[Object, bool]
+    @remaining: Integer
+    def self.normalize: (top) -> json
+    def self.object: (top) -> payload
+    def initialize: () -> void
+    def visit: (top, Integer) -> json
+
+    private
+
+    def scalar: (top) -> json
+    def text: (String) -> String
+    def container: (Array[top] | Hash[top, top], Integer) -> json
+    def mapping: (Hash[top, top], Integer) -> payload
+  end
+end

data/sig/hawk/process_hooks.rbs

@@ -0,0 +1,7 @@
+module Hawk
+  module ProcessHooks
+    self.@installed: bool?
+    def self.install: () -> void
+    def self.report_exit: (Exception?) -> void
+  end
+end

data/sig/hawk/rack.rbs

@@ -0,0 +1,74 @@
+module Hawk
+  type rack_headers = Hash[String, String | Array[String]]
+  type rack_body = _RackEnumerableBody | _RackCallableBody
+  type rack_response = [Integer, rack_headers, rack_body]
+
+  interface _RackProtocol
+    def respond_to?: (Symbol, ?bool) -> bool
+  end
+
+  interface _RackEnumerableBody
+    include _RackProtocol
+    def each: () { (String) -> void } -> top
+  end
+
+  interface _RackCallableBody
+    include _RackProtocol
+    def call: (top) -> top
+  end
+
+  interface _RackFileBody
+    include _RackEnumerableBody
+    def to_path: () -> String
+  end
+
+  interface _RackClosableBody
+    def close: () -> top
+  end
+
+  interface _RackApp
+    def call: (Hash[String, top]) -> rack_response
+  end
+
+  class Rack
+    @app: _RackApp
+    @client: Client?
+    @integration: Symbol
+    def initialize: (_RackApp, ?client: Client?, ?integration: Symbol) -> void
+    def call: (Hash[String, top]) -> rack_response
+
+    private
+
+    def active_client: () -> Client?
+    def invoke: (Client, Hash[String, top]) -> rack_response
+    def metadata: (Hash[String, top]) -> payload
+    def optional_metadata: (payload, Hash[String, top]) -> payload
+    def headers: (Hash[String, top]) -> payload
+
+    class Body
+      @body: _RackEnumerableBody
+      @client: Client
+      @scope: Scope
+      def self.wrap: (rack_body, client: Client, scope: Scope) -> rack_body
+      def initialize: (_RackEnumerableBody, client: Client, scope: Scope) -> void
+      def each: () -> Enumerator[String, top]
+              | () { (String) -> void } -> top
+      def close: () -> top
+    end
+
+    class FileBody < Body
+      @file_body: _RackFileBody
+      def initialize: (_RackFileBody, client: Client, scope: Scope) -> void
+      def to_path: () -> String
+    end
+
+    class CallableBody
+      @body: _RackCallableBody
+      @client: Client
+      @scope: Scope
+      def initialize: (_RackCallableBody, client: Client, scope: Scope) -> void
+      def call: (top) -> top
+      def close: () -> top
+    end
+  end
+end

data/sig/hawk/rails/action_cable.rbs

@@ -0,0 +1,40 @@
+module Hawk::Rails
+  interface _CableChannel
+    def perform_action: (Hash[String, top]) -> top
+    def subscribe_to_channel: () -> top
+    def unsubscribe_from_channel: () -> top
+  end
+
+  interface _CableConnection
+    def handle_open: () -> top
+    def handle_close: () -> top
+  end
+
+  interface _CableRescue
+    def rescue_with_handler: (Exception) -> Exception?
+  end
+
+  module ActionCable
+    self.@installed: bool?
+    def self.install: () -> void
+    def self.client: () -> Hawk::Client?
+    def self.run: [A] (Object, String) { () -> A } -> A
+    def self.report: (Exception, handled: bool) -> String?
+
+    module ChannelMethods : _CableChannel
+      def perform_action: (Hash[String, top]) -> top
+      def subscribe_to_channel: () -> top
+      def unsubscribe_from_channel: () -> top
+    end
+
+    module ConnectionMethods : _CableConnection
+      private
+      def handle_open: () -> top
+      def handle_close: () -> top
+    end
+
+    module RescueMethods : _CableRescue
+      def rescue_with_handler: (Exception) -> Exception?
+    end
+  end
+end

data/sig/hawk/rails/active_job.rbs

@@ -0,0 +1,34 @@
+module Hawk::Rails
+  interface _ActiveJobExecutor
+    def execute: (Hash[String, top]) -> top
+  end
+
+  interface _ActiveJobInstance
+    def serialize: () -> Hash[String, top]
+    def deserialize: (Hash[String, top]) -> top
+    def perform_now: () -> top
+    def job_id: () -> String
+    def queue_name: () -> String
+    def executions: () -> Integer
+    def arguments: () -> Array[top]
+  end
+
+  module ActiveJob
+    self.@installed: bool?
+    def self.install: () -> void
+    def self.client: () -> Hawk::Client?
+    def self.run: [A] (Hash[String, top], top) { () -> A } -> A
+    def self.metadata: (Hawk::Client, Hash[String, top]) -> Hawk::payload
+
+    module ClassMethods : _ActiveJobExecutor
+      def execute: (Hash[String, top]) -> top
+    end
+
+    module InstanceMethods : _ActiveJobInstance
+      @hawk_context: Hawk::payload?
+      def serialize: () -> Hash[String, top]
+      def deserialize: (Hash[String, top]) -> top
+      def perform_now: () -> top
+    end
+  end
+end

data/sig/hawk/rails/error_subscriber.rbs

@@ -0,0 +1,9 @@
+module Hawk::Rails
+  class ErrorSubscriber
+    self.@installed: bool?
+    def self.install: () -> void
+    def report: (Exception, handled: bool, severity: Symbol, context: top, ?source: String?) -> void
+    private
+    def request_owned?: (Hawk::Client, Exception, String?) -> bool
+  end
+end

data/sig/hawk/rails/payload_filter.rbs

@@ -0,0 +1,16 @@
+module Hawk
+  interface _ParameterFilter
+    def filter: (payload) -> top
+  end
+  module Rails
+    class PayloadFilter
+      PATHS: Array[Array[String]]
+      @filter: _ParameterFilter
+      def initialize: (_ParameterFilter) -> void
+      def call: (payload) -> payload
+      private
+      def filter: (payload) -> payload
+      def filter_tree: (String, json) -> json
+    end
+  end
+end

data/sig/hawk/rails.rbs

@@ -0,0 +1,26 @@
+module Hawk
+  interface _RailsErrorReporter
+    def subscribe: (Hawk::Rails::ErrorSubscriber) -> void
+  end
+  interface _RailsMiddlewareStack
+    def insert_after: (Class, Class, ?integration: Symbol) -> void
+  end
+
+  interface _RailsConfiguration
+    def filter_parameters: () -> Array[top]
+  end
+
+  interface _RailsApplication
+    def config: () -> _RailsConfiguration
+    def middleware: () -> _RailsMiddlewareStack
+  end
+
+  module Rails
+    def self.configure: (Configuration) -> void
+    def self.activate_integrations: (Configuration) -> void
+    def self.integration_client: (Symbol) -> Client?
+  end
+
+  class Railtie
+  end
+end

data/sig/hawk/rake.rbs

@@ -0,0 +1,13 @@
+module Hawk
+  interface _RakeTask
+    def name: () -> String
+    def execute: (?top) -> top
+  end
+
+  module Rake
+    module TaskMethods : _RakeTask
+      def execute: (?top) -> top
+    end
+    def self.install: () -> void
+  end
+end

data/sig/hawk/release.rbs

@@ -0,0 +1,6 @@
+module Hawk
+  module Release
+    def self.detect: (Configuration) -> String?
+    def self.git_revision: () -> String?
+  end
+end

data/sig/hawk/resque.rbs

@@ -0,0 +1,25 @@
+module Hawk
+  interface _ResqueJob
+    def perform: () -> bool
+    def payload: () -> Hash[String, top]
+    def queue: () -> String
+  end
+
+  interface _ResqueFailure
+    def create: (?Hash[Symbol, top]) -> top
+  end
+
+  module Resque
+    def self.install: () -> void
+    def self.client: () -> Client?
+    def self.metadata: (Client, Hash[String, top], top) -> payload
+    def self.run: [A] (Hash[String, top], String) { () -> A } -> A
+    def self.report_failure: (Hash[Symbol, top]) -> void
+    module JobMethods : _ResqueJob
+      def perform: () -> bool
+    end
+    module FailureMethods : _ResqueFailure
+      def create: (?Hash[Symbol, top]) -> top
+    end
+  end
+end

data/sig/hawk/scope.rbs

@@ -0,0 +1,31 @@
+module Hawk
+  class Scope
+    class Ledger
+      @errors: Hash[Exception, bool]
+      def initialize: () -> void
+      def accept: (Exception, ?evict: bool) -> (:duplicate | :overflow | :accepted)
+    end
+
+    attr_reader context: payload
+    attr_reader user: payload?
+    attr_reader anonymous_id: String
+    attr_accessor addons: payload
+    attr_accessor breadcrumbs: Array[payload]
+    attr_accessor ledger: Ledger
+    attr_accessor boundary: bool
+    attr_accessor request_metadata: (^() -> payload)?
+    def initialize: (?context: raw_context, ?user: raw_context?, ?anonymous_id: String) -> void
+    @filtered_context_keys: Hash[String, bool]
+    @filtered_user: bool
+    def set_context: (raw_context) -> void
+    def set_user: (raw_context?) -> void
+    def restore_filtered: (raw_context, raw_context?) -> void
+    def filtered_paths: (?except_context: Array[String], ?user_override: bool) -> Array[Array[String]]
+    def event_addons: () -> payload
+    def event_data: (raw_context, raw_context?, raw_context?, payload) -> { context: payload, user: payload, breadcrumbs: Array[payload], addons: payload, filtered_paths: Array[Array[String]] }
+    def copy: () -> Scope
+    private
+    def update_context: (raw_context, bool) -> void
+    def update_user: (raw_context?, bool) -> void
+  end
+end

data/sig/hawk/scope_store.rbs

@@ -0,0 +1,15 @@
+module Hawk
+  class ScopeStore
+    @configuration: Configuration
+    @anonymous_id: String
+    @scope_key: String
+    @escape_key: String
+    def initialize: (Configuration, String) -> void
+    def current: () -> Scope
+    def replace: (Scope) -> void
+    def remember_escape: (Exception) -> void
+    def consume_escape: (Exception) -> bool
+    def clear_escape: () -> void
+    def clear: () -> void
+  end
+end

data/sig/hawk/sidekiq.rbs

@@ -0,0 +1,29 @@
+module Hawk
+  interface _MiddlewareChain
+    def add: (Class) -> void
+  end
+
+  interface _SidekiqConfig
+    def client_middleware: () { (_MiddlewareChain) -> void } -> void
+    def server_middleware: () { (_MiddlewareChain) -> void } -> void
+    def error_handlers: () -> Array[top]
+  end
+
+  module Sidekiq
+    def self.install: () -> void
+    def self.register_client: (_SidekiqConfig) -> void
+    def self.register: (_SidekiqConfig) -> void
+    def self.client: () -> Client?
+    def self.metadata: (Client, Hash[String, top]) -> payload
+    class ClientMiddleware
+      def call: [A] (top, Hash[String, top], String, ?top) { () -> A } -> A
+    end
+    class ServerMiddleware
+      def call: [A] (top, Hash[String, top], String) { () -> A } -> A
+    end
+    class ErrorHandler
+      def call: (Exception, Hash[Symbol, top], ?top) -> void
+    end
+    ERROR_HANDLER: ErrorHandler
+  end
+end

data/sig/hawk/source.rbs

@@ -0,0 +1,18 @@
+module Hawk
+  class Source
+    @enabled: bool
+    @roots: Array[String]
+    def initialize: (Configuration) -> void
+    def frames: (Exception) -> Array[payload]
+
+    private
+
+    def location_frame: (Thread::Backtrace::Location) -> payload?
+    def realpath: (String) -> String?
+    def parse: (String) -> payload?
+    def frame: (String, Integer, String?) -> payload?
+    def snippets: (String, Integer) -> Array[payload]
+    def readable_path: (String) -> String?
+    def excerpt: (String, Integer) -> Array[payload]
+  end
+end

data/sig/hawk/token.rbs

@@ -0,0 +1,14 @@
+module Hawk
+  class ConfigurationError < ArgumentError
+  end
+
+  class Token
+    LABEL: Regexp
+    @integration_id: String
+    def self.decode: (String) -> Token
+    def self.integration_id: (top) -> String?
+    def self.valid_secret?: (top) -> bool
+    def initialize: (String) -> void
+    def endpoint: () -> URI::HTTPS
+  end
+end

data/sig/hawk/transport.rbs

@@ -0,0 +1,32 @@
+module Hawk
+  interface _Transport
+    def available?: () -> bool
+    def send: (String) -> Symbol
+  end
+
+  class Transport
+    class ResponseTooLarge < StandardError
+    end
+
+    @configuration: Configuration
+    @uri: URI::HTTP?
+    @mutex: Thread::Mutex
+    @pid: Integer
+    @cooldown_until: Float
+    def initialize: (Configuration) -> void
+    def available?: () -> bool
+    def send: (String) -> Symbol
+
+    private
+
+    def reset: () -> void
+    def monotonic: () -> Float
+    def connection: (URI::HTTP) -> Net::HTTP
+    def request: (String, URI::HTTP) -> Symbol
+    def handle: (Net::HTTPResponse) -> Symbol
+    def response_body: (Net::HTTPResponse) -> String
+    def success?: (String) -> bool
+    def cooldown: (String?) -> void
+    def retry_delay: (String?) -> Float
+  end
+end

data/sig/hawk.rbs

@@ -0,0 +1,16 @@
+module Hawk
+  self.@client: Client?
+  VERSION: String
+  type json = nil | bool | Integer | Float | String | Array[json] | Hash[String, json]
+  def self.client: () -> Client?
+  def self.init: () { (Configuration) -> void } -> Client
+  def self.capture_exception: (Exception, ?context: raw_context, ?user: raw_context?, ?level: Symbol) -> String?
+  def self.capture_message: (String, ?context: raw_context, ?user: raw_context?, ?level: Symbol) -> String?
+  def self.set_context: (raw_context) -> void
+  def self.add_breadcrumb: (raw_context) -> void
+  def self.set_user: (raw_context?) -> void
+  def self.with_scope: [A] () { (Scope) -> A } -> A
+  def self.capture: [A] () { () -> A } -> A
+  def self.flush: (?timeout: Float?) -> bool
+  def self.close: (?timeout: Float?) -> bool
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: hawk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonid Svyatov
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A Ruby error catcher with optional framework integrations for Hawk.
+email:
+- leonid@svyatov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- docs/configuration.md
+- docs/integrations.md
+- docs/releasing.md
+- docs/verification.md
+- lib/hawk.rb
+- lib/hawk/boundary.rb
+- lib/hawk/breadcrumbs.rb
+- lib/hawk/breadcrumbs/logger.rb
+- lib/hawk/breadcrumbs/net_http.rb
+- lib/hawk/breadcrumbs/rails.rb
+- lib/hawk/client.rb
+- lib/hawk/configuration.rb
+- lib/hawk/delayed_job.rb
+- lib/hawk/delivery.rb
+- lib/hawk/diagnostics.rb
+- lib/hawk/event.rb
+- lib/hawk/filter.rb
+- lib/hawk/filtered_fields.rb
+- lib/hawk/framework_filter.rb
+- lib/hawk/hook.rb
+- lib/hawk/job_context.rb
+- lib/hawk/json_value.rb
+- lib/hawk/process_hooks.rb
+- lib/hawk/rack.rb
+- lib/hawk/rack/body.rb
+- lib/hawk/rails.rb
+- lib/hawk/rails/action_cable.rb
+- lib/hawk/rails/active_job.rb
+- lib/hawk/rails/error_subscriber.rb
+- lib/hawk/rails/integration.rb
+- lib/hawk/rails/payload_filter.rb
+- lib/hawk/rake.rb
+- lib/hawk/release.rb
+- lib/hawk/resque.rb
+- lib/hawk/scope.rb
+- lib/hawk/scope_store.rb
+- lib/hawk/sidekiq.rb
+- lib/hawk/source.rb
+- lib/hawk/token.rb
+- lib/hawk/transport.rb
+- lib/hawk/version.rb
+- sig/hawk.rbs
+- sig/hawk/boundary.rbs
+- sig/hawk/breadcrumbs.rbs
+- sig/hawk/breadcrumbs/logger.rbs
+- sig/hawk/breadcrumbs/net_http.rbs
+- sig/hawk/breadcrumbs/rails.rbs
+- sig/hawk/client.rbs
+- sig/hawk/configuration.rbs
+- sig/hawk/delayed_job.rbs
+- sig/hawk/delivery.rbs
+- sig/hawk/diagnostics.rbs
+- sig/hawk/event.rbs
+- sig/hawk/filter.rbs
+- sig/hawk/filtered_fields.rbs
+- sig/hawk/framework_filter.rbs
+- sig/hawk/hook.rbs
+- sig/hawk/job_context.rbs
+- sig/hawk/json_value.rbs
+- sig/hawk/process_hooks.rbs
+- sig/hawk/rack.rbs
+- sig/hawk/rails.rbs
+- sig/hawk/rails/action_cable.rbs
+- sig/hawk/rails/active_job.rbs
+- sig/hawk/rails/error_subscriber.rbs
+- sig/hawk/rails/payload_filter.rbs
+- sig/hawk/rake.rbs
+- sig/hawk/release.rbs
+- sig/hawk/resque.rbs
+- sig/hawk/scope.rbs
+- sig/hawk/scope_store.rbs
+- sig/hawk/sidekiq.rbs
+- sig/hawk/source.rbs
+- sig/hawk/token.rbs
+- sig/hawk/transport.rbs
+homepage: https://hawk.so
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/svyatov/hawk.ruby
+  bug_tracker_uri: https://github.com/svyatov/hawk.ruby/issues
+  changelog_uri: https://github.com/svyatov/hawk.ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/svyatov/hawk.ruby/blob/main/README.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Ruby error reporting for Hawk
+test_files: []