alertiqo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aacacaa175b56e656658758e85b0a95b53660b608f4091aafca16a720bc28d1c
+  data.tar.gz: 2a4ab278096013f53d5ba3ef68b86ed1489be1b53be7fd935d753323f4df7272
+SHA512:
+  metadata.gz: 6fa1f2e38cf13d483b2f9f3507a4cc579b4d1f82a01993fcbe23a3f68828f5e45cecef7e1318077f395b155dea0c5af2dc7a5ab8d1145f4cd8beb0f551528c10
+  data.tar.gz: e73982c00557def886362d26c4654ac633140ccfe84afd50fb276399b8604c5f3fdd21af74a42b53eb99cc309618eb3d35ecfdeaf21313e6a00726e04074c94d

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Muhammad Hamizi Jaminan
+
+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,141 @@
+# Alertiqo Ruby SDK
+
+Error tracking SDK for Ruby and Rails applications.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'alertiqo'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install alertiqo
+```
+
+## Usage
+
+### Basic Setup
+
+```ruby
+require 'alertiqo'
+
+Alertiqo.configure do |config|
+  config.api_key = 'your-api-key'
+  config.endpoint = 'https://alertiqo.hamizi.net'
+  config.environment = 'production'
+  config.release = '1.0.0'
+end
+
+Alertiqo.init
+```
+
+### Rails Setup
+
+Create an initializer `config/initializers/alertiqo.rb`:
+
+```ruby
+Alertiqo.configure do |config|
+  config.api_key = ENV['ALERTIQO_API_KEY']
+  config.endpoint = ENV['ALERTIQO_ENDPOINT'] || 'https://alertiqo.hamizi.net'
+  config.environment = Rails.env
+  config.release = ENV['APP_VERSION']
+end
+```
+
+Add to your `application.rb`:
+
+```ruby
+require 'alertiqo/rails'
+```
+
+### Capture Exceptions
+
+```ruby
+begin
+  some_risky_operation
+rescue => e
+  Alertiqo.capture_exception(e)
+end
+```
+
+### Capture Messages
+
+```ruby
+Alertiqo.capture_message("User completed checkout", level: "info")
+```
+
+### Add Breadcrumbs
+
+```ruby
+Alertiqo.add_breadcrumb(
+  "User clicked button",
+  category: "user-action",
+  level: "info",
+  data: { button_id: "submit-btn" }
+)
+```
+
+### Set User Context
+
+```ruby
+Alertiqo.set_user(
+  id: "12345",
+  email: "user@example.com",
+  username: "johndoe"
+)
+```
+
+### Set Tags
+
+```ruby
+Alertiqo.set_tag("page", "checkout")
+Alertiqo.set_tags({
+  feature: "payments",
+  version: "2.1.0"
+})
+```
+
+## Configuration Options
+
+```ruby
+Alertiqo.configure do |config|
+  # Required
+  config.api_key = 'your-api-key'
+  config.endpoint = 'https://alertiqo.hamizi.net'
+
+  # Optional
+  config.environment = 'production'  # Default: RACK_ENV or RAILS_ENV
+  config.release = '1.0.0'           # App version
+  config.tags = { app: 'myapp' }     # Default tags
+  config.enabled = true              # Enable/disable tracking
+  config.capture_unhandled = true    # Auto-capture unhandled exceptions
+
+  # Filter/modify errors before sending
+  config.before_send = ->(report) {
+    # Return nil to skip sending
+    # Return modified report to send
+    report
+  }
+end
+```
+
+## Environment Variables
+
+```bash
+ALERTIQO_API_KEY=your-api-key
+ALERTIQO_ENDPOINT=https://alertiqo.hamizi.net
+```
+
+## License
+
+MIT

data/lib/alertiqo/breadcrumb.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Alertiqo
+  class Breadcrumb
+    attr_reader :timestamp, :message, :category, :level, :data
+
+    def initialize(message:, category: "default", level: "info", data: {})
+      @timestamp = (Time.now.to_f * 1000).to_i
+      @message = message
+      @category = category
+      @level = level
+      @data = data
+    end
+
+    def to_h
+      {
+        timestamp: @timestamp,
+        message: @message,
+        category: @category,
+        level: @level,
+        data: @data
+      }
+    end
+  end
+end

data/lib/alertiqo/client.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "socket"
+
+module Alertiqo
+  class Client
+    MAX_BREADCRUMBS = 100
+
+    def initialize(configuration)
+      @config = configuration
+      @breadcrumbs = []
+      @user = {}
+      @tags = {}
+      @initialized = false
+      @mutex = Mutex.new
+    end
+
+    def init
+      return if @initialized
+
+      @initialized = true
+
+      if @config.capture_unhandled
+        setup_exception_handler
+      end
+    end
+
+    def capture_exception(exception, **options)
+      return unless @config.enabled
+
+      report = build_error_report(
+        message: exception.message,
+        stack: exception.backtrace&.join("\n"),
+        level: options[:level] || "error",
+        tags: options[:tags] || {}
+      )
+
+      send_report(report)
+    end
+
+    def capture_message(message, level: "info", **options)
+      return unless @config.enabled
+
+      report = build_error_report(
+        message: message,
+        stack: nil,
+        level: level,
+        tags: options[:tags] || {}
+      )
+
+      send_report(report)
+    end
+
+    def add_breadcrumb(message, category: "default", level: "info", data: {})
+      @mutex.synchronize do
+        breadcrumb = Breadcrumb.new(
+          message: message,
+          category: category,
+          level: level,
+          data: data
+        )
+
+        @breadcrumbs << breadcrumb
+        @breadcrumbs.shift if @breadcrumbs.size > MAX_BREADCRUMBS
+      end
+    end
+
+    def set_user(id: nil, email: nil, username: nil)
+      @mutex.synchronize do
+        @user = { id: id, email: email, username: username }.compact
+      end
+    end
+
+    def set_tag(key, value)
+      @mutex.synchronize do
+        @tags[key.to_s] = value
+      end
+    end
+
+    def set_tags(tags)
+      @mutex.synchronize do
+        tags.each { |k, v| @tags[k.to_s] = v }
+      end
+    end
+
+    private
+
+    def setup_exception_handler
+      at_exit do
+        if $! && !$!.is_a?(SystemExit)
+          capture_exception($!)
+        end
+      end
+    end
+
+    def build_error_report(message:, stack:, level:, tags:)
+      merged_tags = @config.tags.merge(@tags).merge(tags)
+
+      @mutex.synchronize do
+        if @user[:id]
+          merged_tags["userId"] = @user[:id]
+        end
+        if @user[:email]
+          merged_tags["userEmail"] = @user[:email]
+        end
+      end
+
+      {
+        message: message,
+        stack: stack,
+        level: level,
+        timestamp: (Time.now.to_f * 1000).to_i,
+        environment: @config.environment,
+        release: @config.release,
+        tags: merged_tags,
+        context: get_context,
+        breadcrumbs: get_breadcrumbs
+      }
+    end
+
+    def get_context
+      {
+        runtime: "ruby",
+        rubyVersion: RUBY_VERSION,
+        platform: RUBY_PLATFORM,
+        hostname: Socket.gethostname
+      }
+    end
+
+    def get_breadcrumbs
+      @mutex.synchronize do
+        @breadcrumbs.map(&:to_h)
+      end
+    end
+
+    def send_report(report)
+      if @config.before_send
+        report = @config.before_send.call(report)
+        return if report.nil?
+      end
+
+      Thread.new do
+        begin
+          conn = Faraday.new(url: @config.endpoint) do |f|
+            f.request :json
+            f.response :json
+            f.adapter Faraday.default_adapter
+          end
+
+          conn.post("/api/errors") do |req|
+            req.headers["Content-Type"] = "application/json"
+            req.headers["X-API-Key"] = @config.api_key
+            req.body = report.to_json
+          end
+        rescue StandardError => e
+          warn "[Alertiqo] Failed to send error report: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/alertiqo/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Alertiqo
+  class Configuration
+    attr_accessor :api_key, :endpoint, :environment, :release, :tags,
+                  :before_send, :capture_unhandled, :enabled
+
+    def initialize
+      @api_key = ENV["ALERTIQO_API_KEY"]
+      @endpoint = ENV["ALERTIQO_ENDPOINT"] || "https://alertiqo.hamizi.net"
+      @environment = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "production"
+      @release = nil
+      @tags = {}
+      @before_send = nil
+      @capture_unhandled = true
+      @enabled = true
+    end
+  end
+end

data/lib/alertiqo/rails.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "alertiqo"
+
+module Alertiqo
+  class Railtie < Rails::Railtie
+    initializer "alertiqo.configure_rails_initialization" do |app|
+      app.config.middleware.use Alertiqo::RackMiddleware
+    end
+
+    config.after_initialize do
+      Alertiqo.init if Alertiqo.configuration&.capture_unhandled
+    end
+  end
+
+  class RackMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        Alertiqo.add_breadcrumb(
+          "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}",
+          category: "http",
+          level: "info",
+          data: {
+            method: env["REQUEST_METHOD"],
+            path: env["PATH_INFO"],
+            query: env["QUERY_STRING"]
+          }
+        )
+
+        @app.call(env)
+      rescue Exception => e
+        Alertiqo.capture_exception(e, tags: {
+          route: env["PATH_INFO"],
+          method: env["REQUEST_METHOD"]
+        })
+        raise
+      end
+    end
+  end
+end

data/lib/alertiqo/version.rb

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

data/lib/alertiqo.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "alertiqo/version"
+require_relative "alertiqo/client"
+require_relative "alertiqo/configuration"
+require_relative "alertiqo/breadcrumb"
+
+module Alertiqo
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def init
+      client.init
+    end
+
+    def capture_exception(exception, **options)
+      client.capture_exception(exception, **options)
+    end
+
+    def capture_message(message, level: "info", **options)
+      client.capture_message(message, level: level, **options)
+    end
+
+    def add_breadcrumb(message, category: "default", level: "info", data: {})
+      client.add_breadcrumb(message, category: category, level: level, data: data)
+    end
+
+    def set_user(id: nil, email: nil, username: nil)
+      client.set_user(id: id, email: email, username: username)
+    end
+
+    def set_tag(key, value)
+      client.set_tag(key, value)
+    end
+
+    def set_tags(tags)
+      client.set_tags(tags)
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: alertiqo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Muhammad Hamizi Jaminan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Error tracking SDK for Ruby and Rails applications
+email:
+- hello@hamizi.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/alertiqo.rb
+- lib/alertiqo/breadcrumb.rb
+- lib/alertiqo/client.rb
+- lib/alertiqo/configuration.rb
+- lib/alertiqo/rails.rb
+- lib/alertiqo/version.rb
+homepage: https://github.com/hymns/alertiqo-client-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hymns/alertiqo-client-ruby
+  source_code_uri: https://github.com/hymns/alertiqo-client-ruby
+  changelog_uri: https://github.com/hymns/alertiqo-client-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Alertiqo SDK for Ruby error tracking
+test_files: []