lex-grafana 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 686c6e8ad86aacf569c08e9cad9f40be6e3c56ad0caebd55ee972a30e88b7f8a
+  data.tar.gz: '05895019f4775c4be40d5db39659f159ddc939aacc09bfe9cd2810d81e1f142e'
+SHA512:
+  metadata.gz: e8c9a4d3abe0e750bf74515b5ede3ba5dd5877df9969fc1c9c08c6aafc12ff30a316c1c78dbad3ccde706098d927b5db63d4fbe92b59b8a0312374a6d7b2d6aa
+  data.tar.gz: ad98edf1dfb5531b5f02b4af6aa5754c315a0e1f339ba9da5d29a7ded606a4ded1b62232f94ffd6f729604e695c4d832e399285720227f6c2af1a144f6655c29

data/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  ci:
+    uses: LegionIO/.github/.github/workflows/ci.yml@main
+
+  release:
+    needs: ci
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    uses: LegionIO/.github/.github/workflows/release.yml@main
+    secrets:
+      rubygems-api-key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,53 @@
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 160
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/ModuleLength:
+  Max: 1500
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/PerceivedComplexity:
+  Max: 17
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Naming/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- `Helpers::Client` — Faraday connection builder with Bearer token auth
+- `Runners::Dashboards` — list_dashboards, get_dashboard, create_dashboard, delete_dashboard
+- `Runners::Alerts` — list_alerts, list_alert_rules, pause_alert
+- `Runners::Datasources` — list_datasources, get_datasource, create_datasource
+- Standalone `Client` class for use outside the Legion framework

data/CLAUDE.md

@@ -0,0 +1,76 @@
+# lex-grafana: Grafana HTTP API Integration for LegionIO
+
+**Repository Level 4 Documentation**
+- **Parent**: `/Users/miverso2/rubymine/legion/extensions-other/CLAUDE.md`
+
+## Purpose
+
+Legion extension for interacting with the Grafana HTTP API. Supports dashboard CRUD, alert management, and datasource operations.
+
+**GitHub**: https://github.com/LegionIO/lex-grafana
+**Gem**: `lex-grafana`
+**Version**: 0.1.0
+**License**: MIT
+**Ruby**: >= 3.4
+
+## Architecture
+
+### Runners
+
+| Runner | Methods | Description |
+|--------|---------|-------------|
+| `Dashboards` | `list_dashboards`, `get_dashboard`, `create_dashboard`, `delete_dashboard` | Dashboard CRUD |
+| `Alerts` | `list_alerts`, `list_alert_rules`, `pause_alert` | Alert management |
+| `Datasources` | `list_datasources`, `get_datasource`, `create_datasource` | Datasource management |
+
+### Helpers
+
+- `Helpers::Client` — Faraday connection factory. Connects to Grafana base URL with Bearer token auth. URL and API key resolved from kwargs or Legion::Settings.
+
+### Standalone Client
+
+```ruby
+client = Legion::Extensions::Grafana::Client.new(url: 'https://grafana.example.com', api_key: 'KEY')
+client.list_dashboards
+client.get_dashboard(uid: 'abc123')
+client.list_alerts
+```
+
+## Authentication
+
+Bearer token via `Authorization: Bearer <api_key>` header.
+
+## Settings
+
+```json
+{
+  "lex-grafana": {
+    "url": "https://grafana.example.com",
+    "api_key": "vault://secret/grafana#api_key"
+  }
+}
+```
+
+## File Map
+
+| Path | Purpose |
+|------|---------|
+| `lib/legion/extensions/grafana.rb` | Entry point |
+| `lib/legion/extensions/grafana/version.rb` | Version constant |
+| `lib/legion/extensions/grafana/helpers/client.rb` | Faraday connection factory |
+| `lib/legion/extensions/grafana/runners/dashboards.rb` | Dashboard CRUD |
+| `lib/legion/extensions/grafana/runners/alerts.rb` | Alert management |
+| `lib/legion/extensions/grafana/runners/datasources.rb` | Datasource management |
+| `lib/legion/extensions/grafana/client.rb` | Standalone Client class |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec       # 15 examples, 0 failures
+bundle exec rubocop     # 0 offenses
+```
+
+---
+
+**Maintained By**: Matthew Iverson (@Esity)

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rspec_junit_formatter'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/lex-grafana.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/legion/extensions/grafana/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lex-grafana'
+  spec.version       = Legion::Extensions::Grafana::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'LEX::Grafana'
+  spec.description   = 'Used to connect Legion to Grafana'
+  spec.homepage      = 'https://github.com/LegionIO/lex-grafana'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.4'
+
+  spec.metadata['homepage_uri']         = spec.homepage
+  spec.metadata['source_code_uri']      = 'https://github.com/LegionIO/lex-grafana'
+  spec.metadata['changelog_uri']        = 'https://github.com/LegionIO/lex-grafana/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 2.0'
+end

data/lib/legion/extensions/grafana/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/client'
+require_relative 'runners/dashboards'
+require_relative 'runners/alerts'
+require_relative 'runners/datasources'
+
+module Legion
+  module Extensions
+    module Grafana
+      class Client
+        include Helpers::Client
+        include Runners::Dashboards
+        include Runners::Alerts
+        include Runners::Datasources
+
+        attr_reader :opts
+
+        def initialize(url:, api_key: nil, **extra)
+          @opts = { url: url, api_key: api_key, **extra }
+        end
+
+        def settings
+          { options: @opts }
+        end
+
+        def connection(**override)
+          super(**@opts, **override)
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/grafana/helpers/client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Legion
+  module Extensions
+    module Grafana
+      module Helpers
+        module Client
+          def connection(url: nil, api_key: nil, **_opts)
+            base = url || settings.dig(:transport, :settings, :'lex-grafana', :url)
+            key  = api_key || settings.dig(:transport, :settings, :'lex-grafana', :api_key)
+            Faraday.new(url: base) do |f|
+              f.request :json
+              f.response :json
+              f.headers['Authorization'] = "Bearer #{key}" if key
+              f.adapter Faraday.default_adapter
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/grafana/runners/alerts.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Grafana
+      module Runners
+        module Alerts
+          def list_alerts(**opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.get('api/alerts')
+            response.body
+          end
+
+          def list_alert_rules(**opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.get('api/v1/provisioning/alert-rules')
+            response.body
+          end
+
+          def pause_alert(id:, paused:, **opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.post("api/alerts/#{id}/pause", paused: paused)
+            response.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/grafana/runners/dashboards.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Grafana
+      module Runners
+        module Dashboards
+          def list_dashboards(**opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.get('api/search', type: 'dash-db')
+            response.body
+          end
+
+          def get_dashboard(uid:, **opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.get("api/dashboards/uid/#{uid}")
+            response.body
+          end
+
+          def create_dashboard(dashboard:, folder_id: nil, overwrite: false, **opts)
+            conn = opts[:connection] || connection(**opts)
+            payload = { dashboard: dashboard, overwrite: overwrite }
+            payload[:folderId] = folder_id if folder_id
+            response = conn.post('api/dashboards/db', payload)
+            response.body
+          end
+
+          def delete_dashboard(uid:, **opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.delete("api/dashboards/uid/#{uid}")
+            response.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/grafana/runners/datasources.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Grafana
+      module Runners
+        module Datasources
+          def list_datasources(**opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.get('api/datasources')
+            response.body
+          end
+
+          def get_datasource(id:, **opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.get("api/datasources/#{id}")
+            response.body
+          end
+
+          def create_datasource(datasource:, **opts)
+            conn = opts[:connection] || connection(**opts)
+            response = conn.post('api/datasources', datasource)
+            response.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/extensions/grafana/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Grafana
+      VERSION = '0.1.1'
+    end
+  end
+end

data/lib/legion/extensions/grafana.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'legion/extensions/grafana/version'
+require 'legion/extensions/grafana/helpers/client'
+require 'legion/extensions/grafana/runners/dashboards'
+require 'legion/extensions/grafana/runners/alerts'
+require 'legion/extensions/grafana/runners/datasources'
+require 'legion/extensions/grafana/client'
+
+module Legion
+  module Extensions
+    module Grafana
+      extend Legion::Extensions::Core if Legion::Extensions.const_defined? :Core
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: lex-grafana
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Esity
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Used to connect Legion to Grafana
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CLAUDE.md
+- Gemfile
+- lex-grafana.gemspec
+- lib/legion/extensions/grafana.rb
+- lib/legion/extensions/grafana/client.rb
+- lib/legion/extensions/grafana/helpers/client.rb
+- lib/legion/extensions/grafana/runners/alerts.rb
+- lib/legion/extensions/grafana/runners/dashboards.rb
+- lib/legion/extensions/grafana/runners/datasources.rb
+- lib/legion/extensions/grafana/version.rb
+homepage: https://github.com/LegionIO/lex-grafana
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LegionIO/lex-grafana
+  source_code_uri: https://github.com/LegionIO/lex-grafana
+  changelog_uri: https://github.com/LegionIO/lex-grafana/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: LEX::Grafana
+test_files: []