sciosano 0.1.0

data/lib/sciosano.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "concurrent"
+require "json"
+require "securerandom"
+require "socket"
+
+require_relative "sciosano/version"
+require_relative "sciosano/configuration"
+require_relative "sciosano/client"
+require_relative "sciosano/context"
+require_relative "sciosano/breadcrumb"
+require_relative "sciosano/report"
+
+# Integrations - Rack is always loaded
+require_relative "sciosano/integrations/rack"
+
+# Rails integration - load at require time so Railtie initializers register
+# BEFORE Rails runs them. This is critical: if we wait until configure(),
+# Rails has already built the middleware stack and our initializer is missed.
+if defined?(Rails::Railtie)
+  require_relative "sciosano/integrations/rails"
+end
+
+module Sciosano
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class << self
+    attr_accessor :client
+
+    # Configure sciosano
+    #
+    # @example
+    #   Sciosano.configure do |config|
+    #     config.api_key = "sciosano_prod_abc123"
+    #     config.environment = Rails.env
+    #   end
+    #
+    # @yield [Configuration] Configuration instance
+    def configure
+      yield configuration
+      self.client = Client.new(configuration)
+      setup_integrations
+      log_initialization
+    end
+
+    # Get the current configuration
+    #
+    # @return [Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Capture an exception
+    #
+    # @param exception [Exception] The exception to capture
+    # @param context [Hash] Additional context
+    # @return [String, nil] Report ID if successful
+    #
+    # @example
+    #   begin
+    #     dangerous_operation
+    #   rescue => e
+    #     Sciosano.capture_exception(e, user_id: current_user.id)
+    #   end
+    def capture_exception(exception, context = {})
+      return nil unless client
+
+      client.capture_exception(exception, context)
+    end
+
+    # Capture a message
+    #
+    # @param message [String] The message to capture
+    # @param level [Symbol] Message level (:info, :warning, :error)
+    # @param context [Hash] Additional context
+    # @return [String, nil] Report ID if successful
+    def capture_message(message, level: :info, context: {})
+      return nil unless client
+
+      client.capture_message(message, level: level, context: context)
+    end
+
+    # Add a breadcrumb
+    #
+    # @param category [String] Breadcrumb category
+    # @param message [String] Breadcrumb message
+    # @param data [Hash] Additional data
+    # @param type [Symbol] Breadcrumb type
+    def add_breadcrumb(category:, message:, data: {}, type: :default)
+      return unless client
+
+      client.add_breadcrumb(
+        Breadcrumb.new(
+          type: type,
+          category: category,
+          message: message,
+          data: data
+        )
+      )
+    end
+
+    # Set user context
+    #
+    # @param id [String, Integer] User ID
+    # @param email [String] User email
+    # @param name [String] User name
+    # @param extra [Hash] Additional user data
+    def set_user(id: nil, email: nil, name: nil, **extra)
+      return unless client
+
+      client.set_user(id: id, email: email, name: name, **extra)
+    end
+
+    # Clear user context
+    def clear_user
+      return unless client
+
+      client.clear_user
+    end
+
+    # Set extra context
+    #
+    # @param key [String, Symbol] Context key
+    # @param value [Object] Context value
+    def set_extra(key, value)
+      return unless client
+
+      client.set_extra(key, value)
+    end
+
+    # Set tags
+    #
+    # @param tags [Hash] Tags to set
+    def set_tags(tags)
+      return unless client
+
+      client.set_tags(tags)
+    end
+
+    # Execute block with additional context
+    #
+    # @param context [Hash] Context to add
+    # @yield Block to execute
+    def with_context(context = {})
+      return yield unless client
+
+      client.with_context(context) { yield }
+    end
+
+    # Verify the installation is working correctly
+    #
+    # @return [Array<String>] List of issues found (empty = all good)
+    def verify_installation
+      issues = []
+
+      unless client
+        issues << "Client not initialized - call Sciosano.configure first"
+        return issues
+      end
+
+      # Check Rails middleware
+      if defined?(Rails.application) && Rails.application
+        middleware_installed = Rails.application.middleware.any? do |m|
+          m.klass == Sciosano::Integrations::RackMiddleware rescue m == Sciosano::Integrations::RackMiddleware
+        end
+        issues << "Rails middleware not installed" unless middleware_installed
+      end
+
+      # Check API key format
+      unless configuration.api_key&.start_with?("sciosano_")
+        issues << "API key appears invalid (should start with 'sciosano_')"
+      end
+
+      issues
+    end
+
+    private
+
+    def setup_integrations
+      # Sidekiq integration - load if Sidekiq is defined and enabled
+      if defined?(Sidekiq) && configuration.sidekiq_enabled
+        require_relative "sciosano/integrations/sidekiq"
+        Sciosano::Integrations::Sidekiq.setup
+      end
+
+      # ActiveJob integration (separate from Rails for standalone use)
+      if defined?(ActiveJob) && configuration.active_job_enabled
+        require_relative "sciosano/integrations/active_job"
+      end
+    end
+
+    def log_initialization
+      return unless defined?(Rails.logger) && Rails.logger
+
+      Rails.logger.info "[Sciosano] Initialized (environment: #{configuration.environment})"
+
+      # Verify middleware in after_initialize if Rails is present
+      if defined?(Rails.application) && Rails.application
+        Rails.application.config.after_initialize do
+          issues = Sciosano.verify_installation
+          if issues.any?
+            issues.each { |issue| Rails.logger.warn "[Sciosano] #{issue}" }
+          else
+            Rails.logger.info "[Sciosano] Middleware installed successfully"
+          end
+        end
+      end
+    end
+  end
+end

data/sciosano.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/sciosano/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sciosano"
+  spec.version = Sciosano::VERSION
+  spec.authors = ["Brightech"]
+  spec.email = ["support@brightech.com"]
+
+  spec.summary = "Error tracking SDK for Ruby and Rails applications"
+  spec.description = "Capture and report errors from Ruby and Rails applications to sciosano. Includes Rails middleware, Sidekiq integration, and ActiveJob support."
+  spec.homepage = "https://github.com/brightech/sciosano"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/brightech/sciosano"
+  spec.metadata["changelog_uri"] = "https://github.com/brightech/sciosano/blob/main/CHANGELOG.md"
+
+  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 .github appveyor Gemfile])
+    end
+  end
+
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "faraday", ">= 1.0", "< 3.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: sciosano
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brightech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-02-10 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: Capture and report errors from Ruby and Rails applications to sciosano.
+  Includes Rails middleware, Sidekiq integration, and ActiveJob support.
+email:
+- support@brightech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sciosano.rb
+- lib/sciosano/breadcrumb.rb
+- lib/sciosano/client.rb
+- lib/sciosano/configuration.rb
+- lib/sciosano/context.rb
+- lib/sciosano/integrations/active_job.rb
+- lib/sciosano/integrations/rack.rb
+- lib/sciosano/integrations/rails.rb
+- lib/sciosano/integrations/sidekiq.rb
+- lib/sciosano/report.rb
+- lib/sciosano/version.rb
+- sciosano.gemspec
+homepage: https://github.com/brightech/sciosano
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/brightech/sciosano
+  source_code_uri: https://github.com/brightech/sciosano
+  changelog_uri: https://github.com/brightech/sciosano/blob/main/CHANGELOG.md
+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.4.19
+signing_key: 
+specification_version: 4
+summary: Error tracking SDK for Ruby and Rails applications
+test_files: []