brainzlab 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a23ea95f03ef25ac3386a0fbf07ea352a01440afc23ec340625f9932bc1cf6a6
-  data.tar.gz: c6f73bc4d7c99a1c4eae51dd34a525e8e3d48b4d0ad4a5502a96baf931f5e44a
+  metadata.gz: a2ccfb8ed0a1aefc1a67e709438812194e6a6a1ce79f7044824ab3f2accd3aca
+  data.tar.gz: 99df1dbd2842a09ab90165755746a8248c5b103854dcddd8c28c1f8ee7e239f9
 SHA512:
-  metadata.gz: abf6406497997a9de152038c1f7764ba66165681091ce9f2c91fe3414097beb2599976bcd0ffb0f5bd175cf2fc8d1909a8931cd50794f7a049569a6fa3914140
-  data.tar.gz: 5dde805af2709726635c798aec9029dff143ffd63ca1de0166328d7ab68c892ab507a02b9127e6d1af3abd89d18774cf4f4d197dfd7656ae474d493821a54433
+  metadata.gz: 49a8f8a4be96f4f917fef27661caa12bde990cfa88dcc19d8917c4c74c4446b63cff26ad52ee524c577d8c9bc3f6767315245e1dace168a46422858f43af2620
+  data.tar.gz: d64004b9afc21429742c61deebbfd5cfe244b83ff477bb4c4809d9fd156917652e150f0236aca3abba6d42df53a231fd6deb54c57b7914f1267d40cc4d1f9a75

data/LICENSE

@@ -1,26 +1,11 @@
-Ossassy License
+OSAaSy License
 
-Copyright (c) 2025, Brainz Lab
+Copyright © 2025, Brainz Lab.
 
-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:
+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 above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-No licensee or downstream recipient may use the Software (including any modified
-or derivative versions) to directly compete with the original Licensor by
-offering it to third parties as a hosted, managed, or Software-as-a-Service
-(SaaS) product or cloud service where the primary value of the service is the
-functionality of the Software itself.
+No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
 
-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.
+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

@@ -2,7 +2,10 @@
 
 [![Gem Version](https://badge.fury.io/rb/brainzlab.svg)](https://rubygems.org/gems/brainzlab)
 [![CI](https://github.com/brainz-lab/brainzlab-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/brainz-lab/brainzlab-ruby/actions/workflows/ci.yml)
-[![License](https://img.shields.io/badge/license-Ossassy-blue.svg)](LICENSE)
+[![CodeQL](https://github.com/brainz-lab/brainzlab-ruby/actions/workflows/codeql.yml/badge.svg)](https://github.com/brainz-lab/brainzlab-ruby/actions/workflows/codeql.yml)
+[![codecov](https://codecov.io/gh/brainz-lab/brainzlab-ruby/graph/badge.svg)](https://codecov.io/gh/brainz-lab/brainzlab-ruby)
+[![Docs](https://img.shields.io/badge/docs-brainzlab.ai-orange)](https://docs.brainzlab.ai/sdk/ruby/installation)
+[![License: OSAaSy](https://img.shields.io/badge/License-OSAaSy-blue.svg)](LICENSE)
 
 Official Ruby SDK for [BrainzLab](https://brainzlab.ai) - the complete observability platform.
 
@@ -328,6 +331,25 @@ Full documentation: [docs.brainzlab.ai](https://docs.brainzlab.ai)
 - [Reflex (Errors)](https://docs.brainzlab.ai/sdk/ruby/reflex)
 - [Pulse (APM)](https://docs.brainzlab.ai/sdk/ruby/pulse)
 
+## Related
+
+- [Recall](https://github.com/brainz-lab/recall) - Logging service
+- [Reflex](https://github.com/brainz-lab/reflex) - Error tracking service
+- [Pulse](https://github.com/brainz-lab/pulse) - APM service
+- [Stack](https://github.com/brainz-lab/stack) - Self-hosted deployment
+
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+Thanks to all our contributors! See [all-contributors](https://allcontributors.org) for how to add yourself.
+
+
 ## License
 
-Ossassy License - see [LICENSE](LICENSE) for details.
+OSAaSy License - see [LICENSE](LICENSE) for details.

data/lib/brainzlab/beacon/client.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+require 'cgi'
+
+module BrainzLab
+  module Beacon
+    class Client
+      def initialize(config)
+        @config = config
+        @base_url = config.beacon_url || 'https://beacon.brainzlab.ai'
+      end
+
+      # Create a new monitor
+      def create_monitor(name:, url:, type: 'http', interval: 60, **options)
+        response = request(
+          :post,
+          '/api/v1/monitors',
+          body: {
+            name: name,
+            url: url,
+            monitor_type: type,
+            interval: interval,
+            **options
+          }
+        )
+
+        return nil unless response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPCreated)
+
+        JSON.parse(response.body, symbolize_names: true)
+      rescue StandardError => e
+        log_error('create_monitor', e)
+        nil
+      end
+
+      # Get monitor status
+      def get_monitor(id)
+        response = request(:get, "/api/v1/monitors/#{id}")
+
+        return nil unless response.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(response.body, symbolize_names: true)
+      rescue StandardError => e
+        log_error('get_monitor', e)
+        nil
+      end
+
+      # List all monitors
+      def list_monitors
+        response = request(:get, '/api/v1/monitors')
+
+        return [] unless response.is_a?(Net::HTTPSuccess)
+
+        data = JSON.parse(response.body, symbolize_names: true)
+        data[:monitors] || []
+      rescue StandardError => e
+        log_error('list_monitors', e)
+        []
+      end
+
+      # Update a monitor
+      def update_monitor(id, **attributes)
+        response = request(
+          :put,
+          "/api/v1/monitors/#{id}",
+          body: attributes
+        )
+
+        response.is_a?(Net::HTTPSuccess)
+      rescue StandardError => e
+        log_error('update_monitor', e)
+        false
+      end
+
+      # Delete a monitor
+      def delete_monitor(id)
+        response = request(:delete, "/api/v1/monitors/#{id}")
+        response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPNoContent)
+      rescue StandardError => e
+        log_error('delete_monitor', e)
+        false
+      end
+
+      # Pause a monitor
+      def pause_monitor(id)
+        response = request(:post, "/api/v1/monitors/#{id}/pause")
+        response.is_a?(Net::HTTPSuccess)
+      rescue StandardError => e
+        log_error('pause_monitor', e)
+        false
+      end
+
+      # Resume a monitor
+      def resume_monitor(id)
+        response = request(:post, "/api/v1/monitors/#{id}/resume")
+        response.is_a?(Net::HTTPSuccess)
+      rescue StandardError => e
+        log_error('resume_monitor', e)
+        false
+      end
+
+      # Get check history
+      def check_history(monitor_id, limit: 100)
+        response = request(
+          :get,
+          "/api/v1/monitors/#{monitor_id}/checks",
+          params: { limit: limit }
+        )
+
+        return [] unless response.is_a?(Net::HTTPSuccess)
+
+        data = JSON.parse(response.body, symbolize_names: true)
+        data[:checks] || []
+      rescue StandardError => e
+        log_error('check_history', e)
+        []
+      end
+
+      # Get current status summary
+      def status_summary
+        response = request(:get, '/api/v1/status')
+
+        return nil unless response.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(response.body, symbolize_names: true)
+      rescue StandardError => e
+        log_error('status_summary', e)
+        nil
+      end
+
+      # List active incidents
+      def list_incidents(status: nil)
+        params = {}
+        params[:status] = status if status
+
+        response = request(:get, '/api/v1/incidents', params: params)
+
+        return [] unless response.is_a?(Net::HTTPSuccess)
+
+        data = JSON.parse(response.body, symbolize_names: true)
+        data[:incidents] || []
+      rescue StandardError => e
+        log_error('list_incidents', e)
+        []
+      end
+
+      def provision(project_id:, app_name:)
+        response = request(
+          :post,
+          '/api/v1/projects/provision',
+          body: { project_id: project_id, app_name: app_name },
+          use_service_key: true
+        )
+
+        response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPCreated)
+      rescue StandardError => e
+        log_error('provision', e)
+        false
+      end
+
+      private
+
+      def request(method, path, headers: {}, body: nil, params: nil, use_service_key: false)
+        uri = URI.parse("#{@base_url}#{path}")
+
+        uri.query = URI.encode_www_form(params) if params
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http.open_timeout = 10
+        http.read_timeout = 30
+
+        request = case method
+                  when :get
+                    Net::HTTP::Get.new(uri)
+                  when :post
+                    Net::HTTP::Post.new(uri)
+                  when :put
+                    Net::HTTP::Put.new(uri)
+                  when :delete
+                    Net::HTTP::Delete.new(uri)
+                  end
+
+        request['Content-Type'] = 'application/json'
+        request['Accept'] = 'application/json'
+
+        if use_service_key
+          request['X-Service-Key'] = @config.beacon_master_key || @config.secret_key
+        else
+          auth_key = @config.beacon_api_key || @config.secret_key
+          request['Authorization'] = "Bearer #{auth_key}" if auth_key
+        end
+
+        headers.each { |k, v| request[k] = v }
+        request.body = body.to_json if body
+
+        http.request(request)
+      end
+
+      def log_error(operation, error)
+        BrainzLab.debug_log("[Beacon::Client] #{operation} failed: #{error.message}")
+      end
+    end
+  end
+end

data/lib/brainzlab/beacon/provisioner.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BrainzLab
+  module Beacon
+    class Provisioner
+      def initialize(config)
+        @config = config
+        @provisioned = false
+      end
+
+      def ensure_project!
+        return if @provisioned
+        return unless @config.beacon_auto_provision
+        return unless valid_auth?
+
+        @provisioned = true
+
+        project_id = detect_project_id
+        return unless project_id
+
+        client = Client.new(@config)
+        client.provision(
+          project_id: project_id,
+          app_name: @config.app_name || @config.service
+        )
+
+        BrainzLab.debug_log("[Beacon::Provisioner] Project provisioned: #{project_id}")
+      rescue StandardError => e
+        BrainzLab.debug_log("[Beacon::Provisioner] Provisioning failed: #{e.message}")
+      end
+
+      private
+
+      def valid_auth?
+        key = @config.beacon_api_key || @config.beacon_master_key || @config.secret_key
+        !key.nil? && !key.empty?
+      end
+
+      def detect_project_id
+        ENV.fetch('BRAINZLAB_PROJECT_ID', nil)
+      end
+    end
+  end
+end

data/lib/brainzlab/beacon.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+require_relative 'beacon/client'
+require_relative 'beacon/provisioner'
+
+module BrainzLab
+  module Beacon
+    class << self
+      # Create an HTTP monitor
+      # @param name [String] Monitor name
+      # @param url [String] URL to monitor
+      # @param interval [Integer] Check interval in seconds (default: 60)
+      # @param options [Hash] Additional options
+      # @return [Hash, nil] Created monitor or nil
+      #
+      # @example
+      #   BrainzLab::Beacon.create_http_monitor(
+      #     "Production API",
+      #     "https://api.example.com/health",
+      #     interval: 30,
+      #     expected_status: 200,
+      #     timeout: 5
+      #   )
+      #
+      def create_http_monitor(name, url, interval: 60, **)
+        return nil unless enabled?
+
+        ensure_provisioned!
+        return nil unless BrainzLab.configuration.beacon_valid?
+
+        client.create_monitor(
+          name: name,
+          url: url,
+          type: 'http',
+          interval: interval,
+          **
+        )
+      end
+
+      # Create an SSL certificate monitor
+      def create_ssl_monitor(name, domain, warn_days: 30, **)
+        return nil unless enabled?
+
+        ensure_provisioned!
+        return nil unless BrainzLab.configuration.beacon_valid?
+
+        client.create_monitor(
+          name: name,
+          url: "https://#{domain}",
+          type: 'ssl',
+          ssl_warn_days: warn_days,
+          **
+        )
+      end
+
+      # Create a TCP port monitor
+      def create_tcp_monitor(name, host, port, **)
+        return nil unless enabled?
+
+        ensure_provisioned!
+        return nil unless BrainzLab.configuration.beacon_valid?
+
+        client.create_monitor(
+          name: name,
+          url: "#{host}:#{port}",
+          type: 'tcp',
+          **
+        )
+      end
+
+      # Create a DNS monitor
+      def create_dns_monitor(name, domain, expected_record: nil, **)
+        return nil unless enabled?
+
+        ensure_provisioned!
+        return nil unless BrainzLab.configuration.beacon_valid?
+
+        client.create_monitor(
+          name: name,
+          url: domain,
+          type: 'dns',
+          expected_record: expected_record,
+          **
+        )
+      end
+
+      # Get monitor by ID
+      def get(id)
+        return nil unless enabled?
+
+        ensure_provisioned!
+        return nil unless BrainzLab.configuration.beacon_valid?
+
+        client.get_monitor(id)
+      end
+
+      # List all monitors
+      def list
+        return [] unless enabled?
+
+        ensure_provisioned!
+        return [] unless BrainzLab.configuration.beacon_valid?
+
+        client.list_monitors
+      end
+
+      # Update a monitor
+      def update(id, **attributes)
+        return false unless enabled?
+
+        ensure_provisioned!
+        return false unless BrainzLab.configuration.beacon_valid?
+
+        client.update_monitor(id, **attributes)
+      end
+
+      # Delete a monitor
+      def delete(id)
+        return false unless enabled?
+
+        ensure_provisioned!
+        return false unless BrainzLab.configuration.beacon_valid?
+
+        client.delete_monitor(id)
+      end
+
+      # Pause a monitor
+      def pause(id)
+        return false unless enabled?
+
+        ensure_provisioned!
+        return false unless BrainzLab.configuration.beacon_valid?
+
+        client.pause_monitor(id)
+      end
+
+      # Resume a paused monitor
+      def resume(id)
+        return false unless enabled?
+
+        ensure_provisioned!
+        return false unless BrainzLab.configuration.beacon_valid?
+
+        client.resume_monitor(id)
+      end
+
+      # Get check history for a monitor
+      def history(monitor_id, limit: 100)
+        return [] unless enabled?
+
+        ensure_provisioned!
+        return [] unless BrainzLab.configuration.beacon_valid?
+
+        client.check_history(monitor_id, limit: limit)
+      end
+
+      # Get overall status summary
+      def status
+        return nil unless enabled?
+
+        ensure_provisioned!
+        return nil unless BrainzLab.configuration.beacon_valid?
+
+        client.status_summary
+      end
+
+      # Check if all monitors are up
+      def all_up?
+        summary = status
+        return false unless summary
+
+        %w[up operational].include?(summary[:status])
+      end
+
+      # List active incidents
+      def incidents(status: nil)
+        return [] unless enabled?
+
+        ensure_provisioned!
+        return [] unless BrainzLab.configuration.beacon_valid?
+
+        client.list_incidents(status: status)
+      end
+
+      # === INTERNAL ===
+
+      def ensure_provisioned!
+        return if @provisioned
+
+        @provisioned = true
+        provisioner.ensure_project!
+      end
+
+      def provisioner
+        @provisioner ||= Provisioner.new(BrainzLab.configuration)
+      end
+
+      def client
+        @client ||= Client.new(BrainzLab.configuration)
+      end
+
+      def reset!
+        @client = nil
+        @provisioner = nil
+        @provisioned = false
+      end
+
+      private
+
+      def enabled?
+        BrainzLab.configuration.beacon_enabled
+      end
+    end
+  end
+end