grafana 0.8.5 → 1.1.0

data/lib/grafana/dashboard_versions.rb

@@ -1,29 +1,125 @@
 
 module Grafana
 
-  # http://docs.grafana.org/http_api/annotations/
+  # http://docs.grafana.org/http_api/dashboard_versions
   #
   module DashboardVersions
 
     # Get all dashboard versions
     # http://docs.grafana.org/http_api/dashboard_versions/#get-all-dashboard-versions
     # GET /api/dashboards/id/:dashboardId/versions
-    def dashboard_all_versions( params ); end
+    #
+    #
+    #
+    #
+    #
+    #
+    def dashboard_all_versions( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+#      v, mv = version.values
+#      return { 'status' => 404, 'message' => format( 'dashboard has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      dashboard_id  = validate( params, required: true , var: 'dashboard_id', type: Integer )
+      start         = validate( params, required: false, var: 'start'       , type: Integer )
+      limit         = validate( params, required: false, var: 'limit'       , type: Integer )
+
+      api     = []
+      api << format( 'start=%s', start ) unless( start.nil? )
+      api << format( 'limit=%s', limit ) unless( limit.nil? )
+      api = api.join( '&' )
+
+      endpoint = format('/api/dashboards/id/%s/versions?%s', dashboard_id, api)
+      get(endpoint)
+    end
 
     # Get dashboard version
     # http://docs.grafana.org/http_api/dashboard_versions/#get-dashboard-version
     # GET /api/dashboards/id/:dashboardId/versions/:id
-    def dashboard_version( params ); end
+    def dashboard_version( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      dashboard_id  = validate( params, required: true, var: 'dashboard_id', type: Integer )
+      version       = validate( params, required: true, var: 'version'     , type: Integer )
+
+      endpoint = format('/api/dashboards/id/%s/versions/%s', dashboard_id, version)
+
+      r = get(endpoint)
+
+      r['message'] = format('no dashboard version \'%s\' for dashboard \'%s\' found', version, dashboard_id) if(r.dig('status') == 404)
+      r['message'] = format('no dashboard version \'%s\' for dashboard \'%s\' found', version, dashboard_id) if(r.dig('status') == 500)
+      r
+    end
 
     # Restore dashboard
     # http://docs.grafana.org/http_api/dashboard_versions/#restore-dashboard
     # POST /api/dashboards/id/:dashboardId/restore
-    def restore_dashboard( params ); end
+    def restore_dashboard( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+#      v, mv = version.values
+#      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      dashboard_id  = validate( params, required: true, var: 'dashboard_id', type: Integer )
+      version       = validate( params, required: true, var: 'version'    , type: Integer )
+
+      endpoint = format('/api/dashboards/id/%s/restore', dashboard_id)
+
+      payload = {
+        version: version
+      }
+
+      post(endpoint, payload.to_json)
+    end
 
     # Compare dashboard versions
     # http://docs.grafana.org/http_api/dashboard_versions/#compare-dashboard-versions
     # POST /api/dashboards/calculate-diff
-    def compare_dashboard_version( params ); end
+    def compare_dashboard_version( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      base      = validate( params, required: true , var: 'base'     , type: Hash )
+      new       = validate( params, required: true , var: 'new'      , type: Hash )
+      diff_type = validate( params, required: false, var: 'diff_type', type: String ) || 'json'
+
+      base_dashboard_id      = validate( base, required: true , var: 'dashboard_id', type: Integer )
+      base_dashboard_version = validate( base, required: true , var: 'version'     , type: Integer )
+      new_dashboard_id       = validate( new , required: true , var: 'dashboard_id', type: Integer )
+      new_dashboard_version  = validate( new , required: true , var: 'version'     , type: Integer )
+
+      valid_diff_type = %w[json basic]
+
+      r = validate_hash(diff_type, valid_diff_type)
+
+      return r unless(r == true)
+
+      payload = {
+        base: {
+          dashboardId: base_dashboard_id,
+          version: base_dashboard_version
+        },
+        new: {
+          dashboardId: new_dashboard_id,
+          version: new_dashboard_version
+        },
+        diffType: diff_type
+      }
+
+      endpoint = '/api/dashboards/calculate-diff'
+
+      post(endpoint, payload.to_json)
+    end
 
   end
 

data/lib/grafana/datasource.rb

@@ -44,7 +44,9 @@ module Grafana
     #
     def datasource( datasource_id )
 
-      raise ArgumentError.new(format('wrong type. user \'datasource_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', datasource_id.class.to_s)) if( datasource_id.is_a?(String) && datasource_id.is_a?(Integer) )
+      if( datasource_id.is_a?(String) && datasource_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'datasource_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', datasource_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'datasource_id\'') if( datasource_id.size.zero? )
 
       if(datasource_id.is_a?(String))
@@ -105,27 +107,31 @@ module Grafana
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      name = validate( params, required: true, var: 'name' )
-      organisation  = validate( params, required: false, var: 'organisation' )
-      type          = validate( params, required: false, var: 'type', type: String )
-      new_name      = validate( params, required: false, var: 'new_name', type: String )
-      database    = validate( params, required: false, var: 'database', type: String )
-      access      = validate( params, required: false, var: 'access', type: String ) || 'proxy'
-      default     = validate( params, required: false, var: 'default', type: Boolean ) || false
-      user        = validate( params, required: false, var: 'user', type: String )
-      password    = validate( params, required: false, var: 'password', type: String )
-      url         = validate( params, required: false, var: 'url', type: String )
-      json_data   = validate( params, required: false, var: 'json_data', type: Hash )
-      ba_user     = validate( params, required: false, var: 'basic_user', type: String )
-      ba_password = validate( params, required: false, var: 'basic_password', type: String )
-      basic_auth  = false
-      basic_auth  = true unless( ba_user.nil? && ba_password.nil? )
-      org_id      = nil
-
-      raise ArgumentError.new(format('wrong type. user \'name\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', name.class.to_s)) if( name.is_a?(String) && name.is_a?(Integer) )
-
+      name         = validate( params, required: true , var: 'name' )
+      organisation = validate( params, required: false, var: 'organisation' )
+      type         = validate( params, required: false, var: 'type', type: String )
+      new_name     = validate( params, required: false, var: 'new_name', type: String )
+      database     = validate( params, required: false, var: 'database', type: String )
+      access       = validate( params, required: false, var: 'access', type: String ) || 'proxy'
+      default      = validate( params, required: false, var: 'default', type: Boolean ) || false
+      user         = validate( params, required: false, var: 'user', type: String )
+      password     = validate( params, required: false, var: 'password', type: String )
+      url          = validate( params, required: false, var: 'url', type: String )
+      json_data    = validate( params, required: false, var: 'json_data', type: Hash )
+      ba_user      = validate( params, required: false, var: 'basic_user', type: String )
+      ba_password  = validate( params, required: false, var: 'basic_password', type: String )
+      basic_auth   = false
+      basic_auth   = true unless( ba_user.nil? && ba_password.nil? )
+      org_id       = nil
+
+      if( name.is_a?(String) && name.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'name\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', name.class.to_s))
+      end
       if( organisation )
-        raise ArgumentError.new(format('wrong type. user \'organisation\' must be an String (for an Organisation name) or an Integer (for an Organisation Id), given \'%s\'', organisation.class.to_s)) if( organisation.is_a?(String) && organisation.is_a?(Integer) )
+        if( organisation.is_a?(String) && organisation.is_a?(Integer) )
+          raise ArgumentError.new(format('wrong type. \'organisation\' must be an String (for an Organisation name) or an Integer (for an Organisation Id), given \'%s\'', organisation.class.to_s))
+        end
+
         org    = organization( organisation )
         org_id = org.dig('id')
 
@@ -170,7 +176,7 @@ module Grafana
       endpoint = format('/api/datasources/%d', datasource_id )
 
       @logger.debug("Updating data source Id #{datasource_id} (GET #{endpoint})") if  @debug
-      logger.debug(payload.to_json) if(@debug)
+#       logger.debug(payload.to_json) if(@debug)
 
       put( endpoint, payload.to_json )
     end
@@ -180,10 +186,8 @@ module Grafana
     # @param [Hash] params
     # @option params [String] type Datasource Type - (required) (grafana graphite cloudwatch elasticsearch prometheus influxdb mysql opentsdb postgres)
     # @option params [String] name  Datasource Name - (required)
-    # @option params [String] database  Datasource Database - (required)
     # @option params [String] access (proxy) Acess Type - (required) (proxy or direct)
     # @option params [Boolean] default (false)
-    # @option params [String] password
     # @option params [String] url Datasource URL - (required)
     # @option params [Hash] json_data
     # @option params [Hash] json_secure
@@ -194,7 +198,6 @@ module Grafana
     #    params = {
     #      name: 'graphite',
     #      type: 'graphite',
-    #      database: 'graphite',
     #      url: 'http://localhost:8080'
     #    }
     #    create_datasource(params)
@@ -202,7 +205,6 @@ module Grafana
     #    params = {
     #      name: 'graphite',
     #      type: 'graphite',
-    #      database: 'graphite',
     #      default: true,
     #      url: 'http://localhost:8080',
     #      json_data: { graphiteVersion: '1.1' }
@@ -231,13 +233,11 @@ module Grafana
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      type        = validate( params, required: true, var: 'type', type: String )
-      name        = validate( params, required: true, var: 'name', type: String )
-      database    = validate( params, required: true, var: 'database', type: String )
+      type        = validate( params, required: true , var: 'type', type: String )
+      name        = validate( params, required: true , var: 'name', type: String )
       access      = validate( params, required: false, var: 'access', type: String ) || 'proxy'
       default     = validate( params, required: false, var: 'default', type: Boolean ) || false
-      password    = validate( params, required: false, var: 'password', type: String )
-      url         = validate( params, required: true, var: 'url', type: String )
+      url         = validate( params, required: true , var: 'url', type: String )
       json_data   = validate( params, required: false, var: 'json_data', type: Hash )
       json_secure = validate( params, required: false, var: 'json_secure', type: Hash )
       ba_user     = validate( params, required: false, var: 'basic_user', type: String )
@@ -262,14 +262,8 @@ module Grafana
         jsonData: json_data,
         secureJsonData: json_secure
       }
-
       payload.reject!{ |_k, v| v.nil? }
 
-      if( @debug )
-        logger.debug("Creating data source: #{name} (database: #{database})")
-        logger.debug( payload.to_json )
-      end
-
       endpoint = '/api/datasources'
       post(endpoint, payload.to_json)
     end
@@ -286,7 +280,9 @@ module Grafana
     #
     def delete_datasource( datasource_id )
 
-      raise ArgumentError.new(format('wrong type. user \'datasource_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', datasource_id.class.to_s)) if( datasource_id.is_a?(String) && datasource_id.is_a?(Integer) )
+      if( datasource_id.is_a?(String) && datasource_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'datasource_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', datasource_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'datasource_id\'') if( datasource_id.size.zero? )
 
       if(datasource_id.is_a?(String))

data/lib/grafana/folder.rb

@@ -0,0 +1,198 @@
+module Grafana
+
+  # http://docs.grafana.org/http_api/folder/#folder-api
+  #
+  module Folder
+
+    # Get all folders
+    # GET /api/folders
+    # Returns all folders that the authenticated user has permission to view.
+    #
+    # @example
+    #    folders
+    #
+    # @return [Hash]
+    #
+    def folders
+
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      endpoint = '/api/folders'
+      @logger.debug("Getting all folders (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Get folder by uid
+    # GET /api/folders/:uid
+    #
+    # Will return the folder given the folder uid.
+    #
+    # Get folder by id
+    # GET /api/folders/:id
+    #
+    # Will return the folder identified by id.
+    def folder( folder_uid )
+
+      raise ArgumentError.new(format('wrong type. user \'folder_uid\' must be an String (for an Folder Uid) or an Integer (for an Folder Id), given \'%s\'', folder_uid.class.to_s)) \
+          if( folder_uid.is_a?(String) && folder_uid.is_a?(Integer) )
+      raise ArgumentError.new('missing \'folder_uid\'') if( folder_uid.size.zero? )
+
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      if(folder_uid.is_a?(Integer))
+
+        f  = folders
+        f  = JSON.parse(f) if(f.is_a?(String))
+
+        status = f.dig('status')
+        return f if( status != 200 )
+
+        f = f.dig('message').detect {|x| x['id'] == folder_uid }
+
+        return { 'status' => 404, 'message' => format( 'No Folder \'%s\' found', folder_uid) } if( folder_uid.nil? )
+
+        folder_uid = f.dig('uid') unless(f.nil?)
+
+        return { 'status' => 404, 'message' => format( 'No Folder \'%s\' found', folder_uid) } if( folder_uid.is_a?(Integer) )
+      end
+
+      return { 'status' => 404, 'message' => format( 'The uid can have a maximum length of 40 characters, but it is %s characters long', folder_uid.length) } \
+          if( folder_uid.is_a?(String) && folder_uid.length > 40 )
+      return { 'status' => 404, 'message' => format( 'No Folder \'%s\' found', folder_uid) } if( folder_uid.nil? )
+
+      endpoint = format( '/api/folders/%s', folder_uid )
+
+      @logger.debug("Getting folder by Id #{folder_uid} (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Create folder
+    # POST /api/folders
+    #
+    # Creates a new folder.
+    # JSON Body schema:
+    #
+    #   uid   - Optional unique identifier.
+    #   title - The title of the folder.
+    def create_folder( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      title = validate( params, required: false, var: 'title', type: String )
+      uid   = validate( params, required: true , var: 'uid'  , type: String )
+
+      return { 'status' => 404, 'message' => format( 'The uid can have a maximum length of 40 characters. \'%s\' given', uid.length) } if( uid.length > 40 )
+
+      data = {
+        uid: uid,
+        title: title
+      }
+      data.reject!{ |_, y| y.nil? }
+
+      payload = data.deep_string_keys
+
+      endpoint = '/api/folders'
+
+      @logger.debug("create folder #{title} (GET #{endpoint})") if  @debug
+      logger.debug(payload.to_json) if(@debug)
+
+      post( endpoint, payload.to_json )
+    end
+
+    # Update folder
+    # PUT /api/folders/:uid
+    #
+    # schould be fail, when the version are not incremented
+    # overwrite helps
+    #
+    # Updates an existing folder identified by uid.
+    # JSON Body schema:
+    #
+    #   - uid - Provide another unique identifier than stored to change the unique identifier.
+    #   - title - The title of the folder.
+    #   - version - Provide the current version to be able to update the folder. Not needed if overwrite=true.
+    #   - overwrite - Set to true if you want to overwrite existing folder with newer version.
+    def update_folder( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      uid       = validate( params, required: true , var: 'uid'      , type: String )
+      title     = validate( params, required: true , var: 'title'    , type: String )
+      new_uid   = validate( params, required: false, var: 'new_uid'  , type: String )
+      version   = validate( params, required: false, var: 'version'  , type: Integer )
+      overwrite = validate( params, required: false, var: 'overwrite', type: Boolean ) || false
+
+      existing_folder = folder( uid )
+      return { 'status' => 404, 'message' => format( 'No Folder \'%s\' found', uid) } if( existing_folder.dig('status') != 200 )
+
+      unless( new_uid.nil? )
+        existing_folder = folder( new_uid )
+        return { 'status' => 404, 'message' => format( 'Folder \'%s\' found', uid) } if( existing_folder.dig('status') == 200 )
+      end
+
+      payload = {
+        title: title,
+        uid: new_uid,
+        version: version,
+        overwrite: overwrite
+      }
+      payload.reject!{ |_, y| y.nil? }
+
+      @logger.debug("Updating folder with Uid #{uid}") if @debug
+
+      endpoint = format( '/api/folders/%s', uid )
+
+      put( endpoint, payload.to_json )
+    end
+
+
+    # Delete folder
+    # DELETE /api/folders/:uid
+    #
+    # Deletes an existing folder identified by uid together with all dashboards stored in the folder, if any.
+    # This operation cannot be reverted.
+    def delete_folder( folder_uid )
+
+      raise ArgumentError.new(format('wrong type. user \'folder_uid\' must be an String (for an Folder Uid) or an Integer (for an Folder Id), given \'%s\'', folder_uid.class.to_s)) \
+          if( folder_uid.is_a?(String) && folder_uid.is_a?(Integer) )
+      raise ArgumentError.new('missing \'folder_uid\'') if( folder_uid.size.zero? )
+
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'folder has been supported in Grafana since version 5. you use version %s', v) } if(mv < 5)
+
+      if(folder_uid.is_a?(Integer))
+
+        fldrs  = folders
+
+        fldrs  = JSON.parse(fldrs) if(fldrs.is_a?(String))
+        status = fldrs.dig('status')
+
+        return fldrs if( status != 200 )
+
+        fldrs.dig('message').each do |d|
+          folder_uid = d.dig('uid').to_s
+        end
+      end
+
+      return { 'status' => 404, 'message' => format( 'No User \'%s\' found', folder_uid) } if( folder_uid.nil? )
+
+      endpoint = format( '/api/folders/%s', folder_uid )
+
+      @logger.debug("deleting folder by uid #{folder_uid} (GET #{endpoint})") if @debug
+      delete(endpoint)
+    end
+
+
+  end
+end
+