grafana-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feef62d5dcc9495d04c3a012537f79488416e08a64d4ade27c43bc608adc055d
-  data.tar.gz: 2d01176ce013313d5cf9b618f85000a66d84a9c4a4c766c563c1ab9d038a3f48
+  metadata.gz: 8f855fcd107829fe6a38608b160867dab591272da9fec63f8aba6b20b3cec35e
+  data.tar.gz: b1a62e82cb2ce97528be51e0a099fcfc835de974a9ec776fbce392e171120306
 SHA512:
-  metadata.gz: '04993d0c515a02e0c91e24196d5e0c7a7616056715095290418436b29da3eb3824bb14c40b00b08cfadf259d85418b12d9085dff87b57d452e015710a4a550dd'
-  data.tar.gz: e070532c25999ae481447b5d39a0db69ff44832046b119c641582d3d3f112e63f621838841f67d8a63645c7d6ffc9a6c90dd2c49306d0e79ff13054e665e1680
+  metadata.gz: 05bb6912d1040b15caf4631a667cbed87f299279fb93a6e72d4e49d7143c7e2393922dd8d5d3828106b2b5e24808a63cd841bd4ef9c7e535bb2def5e8ea7ca9d
+  data.tar.gz: a5766d1cc020f7d8fa24857cd167064501f3660440136828c610265ab32788bbb473cd504051aa7ebdcfe6df35ba0e19c263ea9ca082587365dab87d147b0e82

data/.github/workflows/main.yml

@@ -10,6 +10,8 @@ jobs:
         # due to https://github.com/actions/runner/issues/849, we need quotes for '3.0'
         ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head, truffleruby, truffleruby-head]
     runs-on: ${{ matrix.os }}
+    # Don't duplicate test runs for both push and PR for internal PRs
+    if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository }}
     steps:
       - name: "Checkout"
         uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.1] - 2021-06-01
+
+- Add Dashboard/Folder search capabilities
+
 ## [0.1.0] - 2021-05-21
 
 - Initial release

data/lib/grafana/client.rb

@@ -6,7 +6,7 @@ Dir[File.join(__dir__, 'modules', '*.rb')].sort.each { |file| require file }
 module Grafana
   class Client < Grafana::BaseClient
     VERSION = Grafana::CLIENT_VERSION
-    
+
     class << self
       attr_accessor :api_key, :grafana_url
 

data/lib/grafana/client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Grafana
-  CLIENT_VERSION = "0.1.0"
+  CLIENT_VERSION = "0.1.1"
 end

data/lib/grafana/modules/dashboard.rb

@@ -37,6 +37,34 @@ module Grafana
         post('/api/dashboards/db', req_body)
       end
 
+      def overwrite_dashboard(dashboard:, **options)
+        req_body = {
+          dashboard: dashboard,
+          message: options[:message],
+          folderId: options[:folder_id],
+          overwrite: true # Overwriting dashboard (if exists)
+        }
+
+        post('/api/dashboards/db', req_body)
+      end
+
+      def dashboard_search(**options)
+        options = options.slice(:query, :tag, :dashboard_ids, :folder_ids, :starred, :limit, :page)
+
+        options[:folderIds] = Array.wrap(options.delete(:folder_ids)) if options[:folder_ids].present?
+        options[:dashboardIds] = Array.wrap(options.delete(:dashboard_ids)) if options[:dashboard_ids].present?
+
+        options.delete(:starred) unless options[:starred].is_a?(Boolean)
+        options.delete(:limit) unless options[:limit].is_a?(Integer) && options[:limit] <= 5000
+        options.delete(:page) unless options[:page].is_a?(Integer)
+
+        options.merge({ type: 'dash-db' })
+
+        search_url = '/api/search'
+        search_url = "?#{URI.encode_www_form(options)}"
+        get(search_url)
+      end
+
       def dashboard(uid:)
         get("/api/dashboards/uid/#{uid}")
       end

data/lib/grafana/modules/folder.rb

@@ -1,6 +1,22 @@
 module Grafana
   module Modules
     module Folder
+      def folder_search(**options)
+        options = options.slice(:query, :tag, :dashboard_ids, :folder_ids, :starred, :limit, :page)
+
+        options[:folderIds] = Array.wrap(options.delete(:folder_ids)) if options[:folder_ids].present?
+        options[:dashboardIds] = Array.wrap(options.delete(:dashboard_ids)) if options[:dashboard_ids].present?
+
+        options.delete(:starred) unless options[:starred].is_a?(Boolean)
+        options.delete(:limit) unless options[:limit].is_a?(Integer) && options[:limit] <= 5000
+        options.delete(:page) unless options[:page].is_a?(Integer)
+
+        options.merge({ type: 'dash-folder' })
+
+        search_url = '/api/search'
+        search_url = "?#{URI.encode_www_form(options)}"
+        get(search_url)
+      end
       def folders
         get('/api/folders')
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grafana-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Tanous
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday