dristi-client 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7066db6c24c6d8446f9e34a39f880db8270898a8fd8af5e8ddae68618962e2af
+  data.tar.gz: ebe3f6ff03b3d2cc44329584a27ae536d107ca3889537546458182210f0db09d
+SHA512:
+  metadata.gz: db87e66caa842fe6af4ee74281f33292d775c63cf1a494d34f585bedf3cdeb3cc3a4c89bb633985ec8d53556cdfa3e9c77697bc93c34f28e718647ad6a0e6c69
+  data.tar.gz: 0eab437d7047428a6466c18506e9fcfa1b80dd2ab0000814bafd084cdea01282c9645254b469bd3468bbc79c04b02e16e37a68bcb7b5332f94f34857be9c74d4

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.2] - 2025-01-23
+
+### Added
+- Capture HTTP referer in error context
+- Include referer path for easier analysis
+
+### Fixed
+- Middleware position to properly capture exceptions
+
+## [0.1.1] - 2025-01-23
+
+### Added
+- Initial release
+- Rack middleware for automatic exception capture
+- Manual error reporting with `DristiClient.capture`
+- Sensitive parameter filtering
+- Retry logic with exponential backoff
+- Fallback to local file when API is unavailable
+- Rails integration via Railtie

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dristi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# Dristi Client
+
+[![Gem Version](https://badge.fury.io/rb/dristi-client.svg)](https://rubygems.org/gems/dristi-client)
+
+Ruby client for [Dristi](https://dristiapp.com) error tracking service.
+
+## Requirements
+
+- Ruby >= 3.0.0
+- Rails (optional, for automatic middleware integration)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "dristi-client"
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Create an initializer at `config/initializers/dristi_client.rb`:
+
+```ruby
+DristiClient.configure do |config|
+  config.api_token = ENV["DRISTI_API_TOKEN"]
+
+  # Optional: disable in specific environments
+  config.enabled = !Rails.env.test?
+
+  # Optional: ignore specific exception classes
+  config.ignored_exceptions = [ActiveRecord::RecordNotFound]
+end
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `api_token` | String | `nil` | Required. API token for authentication |
+| `enabled` | Boolean | `true` | Enable/disable error reporting |
+| `ignored_exceptions` | Array | `[]` | Exception classes to skip |
+
+## Usage
+
+### Automatic Error Capture
+
+The gem automatically captures unhandled exceptions via Rack middleware. No additional code is needed for Rails applications.
+
+The middleware captures the following context automatically:
+
+- `request_method` - HTTP method (GET, POST, etc.)
+- `request_path` - Request path
+- `request_params` - Request parameters (sensitive params filtered)
+- `query_string` - Query string
+- `user_agent` - Browser/client user agent
+- `remote_ip` - Client IP address
+- `request_id` - Rails request ID
+- `referer` - HTTP referer URL (if present)
+- `referer_path` - Path portion of the referer URL
+
+### Manual Error Reporting
+
+You can manually report errors with additional context:
+
+```ruby
+begin
+  # risky code
+rescue => e
+  DristiClient.capture(e, {
+    user_id: current_user.id,
+    action: "checkout",
+    custom_data: { cart_items: cart.items.count }
+  })
+  raise
+end
+```
+
+### Custom Context
+
+Add any relevant context to help with debugging:
+
+```ruby
+DristiClient.capture(exception, {
+  user_id: current_user&.id,
+  user_email: current_user&.email,
+  feature_flags: FeatureFlags.active,
+  request_id: request.request_id
+})
+```
+
+## Error Payload
+
+Errors are reported with the following structure:
+
+```json
+{
+  "exception_class": "NoMethodError",
+  "message": "undefined method 'foo' for nil:NilClass",
+  "backtrace": ["app/models/user.rb:42:in `process'", "..."],
+  "context": { "user_id": 123 },
+  "environment": {
+    "ruby_version": "3.3.0",
+    "rails_version": "8.1.2",
+    "rails_env": "production",
+    "hostname": "web-1"
+  },
+  "occurred_at": "2025-01-21T12:00:00Z"
+}
+```
+
+## Retry & Fallback Behavior
+
+- Errors are sent in a background thread to avoid blocking requests
+- Failed requests retry up to 3 times with exponential backoff (1s, 2s, 4s)
+- If all retries fail, errors are written to `tmp/dristi_fallback.jsonl`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logicalgroove/dristi-client.
+
+## License
+
+MIT License. See [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/dristi-client.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/dristi_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dristi-client"
+  spec.version = DristiClient::VERSION
+  spec.authors = ["Aleksander Lopez Yazikov"]
+  spec.email = ["webodessa@gmail.com"]
+
+  spec.summary = "Ruby client for Dristi error tracking"
+  spec.description = "A lightweight Ruby gem for reporting errors to Dristi error tracking service"
+  spec.homepage = "https://github.com/logicalgroove/dristi-client"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/logicalgroove/dristi-client"
+  spec.metadata["changelog_uri"] = "https://github.com/logicalgroove/dristi-client"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/dristi_client/client.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "socket"
+require "uri"
+
+module DristiClient
+  class Client
+    FALLBACK_FILE = "tmp/dristi_fallback.jsonl"
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def capture(exception, context = {})
+      return unless @configuration.enabled
+      return unless @configuration.valid?
+      return if ignored?(exception)
+
+      payload = build_payload(exception, context)
+
+      Thread.new do
+        post_with_retry(payload)
+      end
+    end
+
+    private
+
+    def ignored?(exception)
+      @configuration.ignored_exceptions.any? do |klass|
+        exception.is_a?(klass)
+      end
+    end
+
+    def build_payload(exception, context)
+      {
+        exception_class: exception.class.name,
+        message: exception.message,
+        backtrace: exception.backtrace || [],
+        context: context,
+        environment: gather_environment,
+        occurred_at: Time.now.utc.iso8601
+      }
+    end
+
+    def gather_environment
+      env = {
+        ruby_version: RUBY_VERSION,
+        hostname: Socket.gethostname
+      }
+
+      if defined?(Rails)
+        env[:rails_version] = Rails::VERSION::STRING
+        env[:rails_env] = Rails.env
+      end
+
+      env
+    end
+
+    def post_with_retry(payload, retries: 3)
+      uri = URI.parse(@configuration.endpoint)
+      attempt = 0
+
+      begin
+        attempt += 1
+        response = make_request(uri, payload)
+
+        unless response.is_a?(Net::HTTPSuccess)
+          raise "HTTP #{response.code}: #{response.body}"
+        end
+      rescue StandardError => e
+        if attempt < retries
+          sleep(2 ** (attempt - 1))
+          retry
+        else
+          write_to_fallback(payload, e.message)
+        end
+      end
+    end
+
+    def make_request(uri, payload)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = 5
+      http.read_timeout = 10
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request["Content-Type"] = "application/json"
+      request["X-API-Token"] = @configuration.api_token
+      request.body = JSON.generate(payload)
+
+      http.request(request)
+    end
+
+    def write_to_fallback(payload, error_message)
+      fallback_data = payload.merge(fallback_error: error_message)
+
+      if defined?(Rails)
+        path = Rails.root.join(FALLBACK_FILE)
+      else
+        path = FALLBACK_FILE
+      end
+
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, "a") do |f|
+        f.puts(JSON.generate(fallback_data))
+      end
+    rescue StandardError
+    end
+  end
+end

data/lib/dristi_client/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DristiClient
+  class Configuration
+    ENDPOINT = "https://dristiapp.com/api/errors"
+
+    attr_accessor :api_token, :enabled, :ignored_exceptions
+    attr_reader :endpoint
+
+    def initialize
+      @api_token = nil
+      @endpoint = ENDPOINT
+      @enabled = true
+      @ignored_exceptions = []
+    end
+
+    def valid?
+      !api_token.nil? && !api_token.empty?
+    end
+  end
+end

data/lib/dristi_client/middleware.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module DristiClient
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => e
+      context = extract_context(env)
+      DristiClient.client.capture(e, context)
+      raise
+    end
+
+    private
+
+    def extract_context(env)
+      context = {
+        request_method: env["REQUEST_METHOD"],
+        request_path: env["PATH_INFO"],
+        request_params: extract_params(env),
+        query_string: env["QUERY_STRING"],
+        user_agent: env["HTTP_USER_AGENT"],
+        remote_ip: env["HTTP_X_FORWARDED_FOR"] || env["REMOTE_ADDR"],
+        request_id: env["HTTP_X_REQUEST_ID"] || env["action_dispatch.request_id"]
+      }
+
+      if env["HTTP_REFERER"] && !env["HTTP_REFERER"].empty?
+        context[:referer] = env["HTTP_REFERER"]
+        context[:referer_path] = URI.parse(env["HTTP_REFERER"]).path rescue nil
+      end
+
+      context
+    end
+
+    def extract_params(env)
+      params = {}
+
+      if env["rack.request.form_hash"]
+        params.merge!(env["rack.request.form_hash"])
+      end
+
+      if env["action_dispatch.request.parameters"]
+        params.merge!(env["action_dispatch.request.parameters"])
+      end
+
+      filter_sensitive_params(params)
+    end
+
+    def filter_sensitive_params(params)
+      sensitive_keys = %w[password password_confirmation token api_key secret]
+
+      params.transform_values.with_index do |value, _|
+        key = params.keys[params.values.index(value)]
+        if sensitive_keys.any? { |k| key.to_s.downcase.include?(k) }
+          "[FILTERED]"
+        elsif value.is_a?(Hash)
+          filter_sensitive_params(value)
+        else
+          value
+        end
+      end
+    rescue StandardError
+      params
+    end
+  end
+end

data/lib/dristi_client/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DristiClient
+  class Railtie < ::Rails::Railtie
+    initializer "dristi_client.insert_middleware" do |app|
+      app.config.middleware.insert_after(ActionDispatch::DebugExceptions, DristiClient::Middleware)
+    end
+  end
+end

data/lib/dristi_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DristiClient
+  VERSION = "0.1.2"
+end

data/lib/dristi_client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "dristi_client/version"
+require_relative "dristi_client/configuration"
+require_relative "dristi_client/client"
+require_relative "dristi_client/middleware"
+
+module DristiClient
+  class << self
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def capture(exception, context = {})
+      client.capture(exception, context)
+    end
+
+    def reset!
+      @configuration = nil
+      @client = nil
+    end
+  end
+end
+
+require_relative "dristi_client/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: dristi-client
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Aleksander Lopez Yazikov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A lightweight Ruby gem for reporting errors to Dristi error tracking
+  service
+email:
+- webodessa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- dristi-client.gemspec
+- lib/dristi_client.rb
+- lib/dristi_client/client.rb
+- lib/dristi_client/configuration.rb
+- lib/dristi_client/middleware.rb
+- lib/dristi_client/railtie.rb
+- lib/dristi_client/version.rb
+homepage: https://github.com/logicalgroove/dristi-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/logicalgroove/dristi-client
+  source_code_uri: https://github.com/logicalgroove/dristi-client
+  changelog_uri: https://github.com/logicalgroove/dristi-client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby client for Dristi error tracking
+test_files: []