grafana 0.8.2 → 1.0.0

data/lib/grafana/dashboard_permissions.rb

@@ -0,0 +1,132 @@
+
+module Grafana
+
+  # http://docs.grafana.org/http_api/dashboard_permissions/#dashboard-permissions-api
+  #
+  # This API can be used to update/get the permissions for a dashboard.
+  # Permissions with dashboardId=-1 are the default permissions for users with the Viewer and Editor roles.
+  # Permissions can be set for a user, a team or a role (Viewer or Editor).
+  # Permissions cannot be set for Admins - they always have access to everything.
+  #
+  # The permission levels for the permission field:
+  #
+  #  1 = View
+  #  2 = Edit
+  #  4 = Admin
+  #
+  module DashboardPermissions
+
+    # http://docs.grafana.org/http_api/dashboard_permissions/#get-permissions-for-a-dashboard
+    #
+    # GET /api/dashboards/id/:dashboardId/permissions
+    #
+    # Gets all existing permissions for the dashboard with the given dashboardId.
+    #
+    def dashboard_permissions(uid)
+
+      if( uid.is_a?(String) && uid.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. dashboard \'uid\' must be an String (for an title name) or an Integer (for an Datasource Id), given \'%s\'', uid.class.to_s))
+      end
+      raise ArgumentError.new('missing \'uid\'') if( uid.size.zero? )
+
+      endpoint = format( '/api/dashboards/id/%s/permissions', uid )
+      @logger.debug( "Attempting to get dashboard permissions (GET #{endpoint})" ) if @debug
+
+      r = get( endpoint )
+      r['message'] = format('dashboard \'%s\' not found', uid) if(r.dig('status') == 404)
+      r
+    end
+
+    # http://docs.grafana.org/http_api/dashboard_permissions/#update-permissions-for-a-dashboard
+    #
+    # POST /api/dashboards/id/:dashboardId/permissions
+    #
+    # Updates permissions for a dashboard.
+    # This operation will remove existing permissions if they're not included in the request.
+    #
+    #
+    def update_dashboad_permissions(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 )
+      permissions  = validate( params, required: true, var: 'permissions' , type: Hash )
+
+      return { 'status' => 404, 'message' => 'no permissions given' } if( permissions.size.zero? )
+
+      valid_roles = %w[View Edit Admin]
+
+      c_team = permissions.dig('team')
+      c_user = permissions.dig('user')
+      team   = []
+      user   = []
+
+      unless(c_team.nil?)
+        check_keys = []
+
+        c_team.uniq.each do |x|
+          k = x.keys.first
+          v = x.values.first
+          r = validate_hash( v, valid_roles )
+
+          f_team = team(k)
+          team_id = f_team.dig('id')
+
+          next unless(( f_team.dig('status') == 200) && !check_keys.include?(team_id) && r == true )
+
+          check_keys << team_id
+
+          role_id = valid_roles.index(v)
+          role_id += 1
+          role_id += 1 if(v == 'Admin')
+
+          team << {
+            teamId: team_id,
+            permission: role_id
+          }
+        end
+      end
+
+      unless(c_user.nil?)
+        check_keys = []
+
+        c_user.uniq.each do |x|
+          k = x.keys.first
+          v = x.values.first
+          r = validate_hash( v, valid_roles )
+
+          f_user = user(k)
+          user_id = f_user.dig('id')
+
+          next unless(( f_user.dig('status') == 200) && !check_keys.include?(user_id) && r == true )
+
+          check_keys << user_id
+
+          role_id = valid_roles.index(v)
+          role_id += 1
+          role_id += 1 if(v == 'Admin')
+
+          user << {
+            userId: user_id,
+            permission: role_id
+          }
+        end
+      end
+
+      payload = {
+        items: team + user
+      }
+      payload.reject!{ |_, y| y.nil? }
+
+
+      endpoint = format('/api/dashboards/id/%s/permissions', dashboard_id)
+      post(endpoint, payload.to_json)
+    end
+
+  end
+
+end

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

@@ -20,12 +20,7 @@ module Grafana
 
       datasources = get( endpoint )
 
-      if  datasources.nil? || datasources.dig('status').to_i != 200
-        return {
-          'status' => 404,
-          'message' => 'No Datasources found'
-        }
-      end
+      return { 'status' => 404, 'message' => 'No Datasources found' } if( datasources.nil? || datasources == false || datasources.dig('status').to_i != 200 )
 
       datasources = datasources.dig('message')
 
@@ -39,6 +34,8 @@ module Grafana
 
     # Get a single datasources by Id or Name
     #
+    # @param [Mixed] datasource_id Datasource Name (String) or Datasource Id (Integer)
+    #
     # @example
     #    datasource( 1 )
     #    datasource( 'foo' )
@@ -47,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))
@@ -55,12 +54,7 @@ module Grafana
         datasource_id = data.keys.first if( data )
       end
 
-      if( datasource_id.nil? )
-        return {
-          'status' => 404,
-          'message' => format( 'No Datasource \'%s\' found', datasource_id)
-        }
-      end
+      return { 'status' => 404, 'message' => format( 'No Datasource \'%s\' found', datasource_id) } if( datasource_id.nil? )
 
       raise format('DataSource Id can not be 0') if( datasource_id.zero? )
 
@@ -82,14 +76,29 @@ module Grafana
     # merge an current existing datasource configuration with the new values
     #
     # @param [Hash] params
-    # @option params [Hash] data
-    # @option params [Mixed] datasource Datasource Name (String) or Datasource Id (Integer)
+    # @option params [Mixed] name Name or Id of the current existing Datasource (required)
+    # @option params [Mixed] organisation Name or Id of an existing Organisation
+    # @option params [String] type Datasource Type - (required) (grafana graphite cloudwatch elasticsearch prometheus influxdb mysql opentsdb postgres)
+    # @option params [String] new_name  New Datasource Name
+    # @option params [String] database  Datasource Database
+    # @option params [String] access (proxy) Acess Type
+    # @option params [Boolean] default (false)
+    # @option params [String] user
+    # @option params [String] password
+    # @option params [String] url Datasource URL
+    # @option params [Hash] json_data
+    # @option params [String] basic_user
+    # @option params [String] basic_password
     #
     # @example
-    #    update_datasource(
-    #      datasource: 'graphite',
-    #      data: { url: 'http://localhost:2003' }
-    #    )
+    #    params = {
+    #      name: 'graphite',
+    #      new_name: 'influx',
+    #      organisation: 'Main Org.',
+    #      type: 'influxdb',
+    #      url: 'http://localhost:8090'
+    #    }
+    #    update_datasource( params )
     #
     # @return [Hash]
     #
@@ -98,24 +107,76 @@ 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? )
 
-      data       = validate( params, required: true, var: 'data', type: Hash )
-      datasource = validate( params, required: true, var: 'datasource' )
+      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 )
+        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
 
-      raise ArgumentError.new(format('wrong type. user \'datasource\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', datasource.class.to_s)) if( datasource.is_a?(String) && datasource.is_a?(Integer) )
+        org    = organization( organisation )
+        org_id = org.dig('id')
 
-      existing_ds = datasource(datasource)
+        return { 'status' => 404, 'message' => format('Organization \'%s\' not found', organization) } if( org.nil? || org.dig('status').to_i != 200 )
+      end
 
+      existing_ds = datasource(name)
       existing_ds.reject! { |x| x == 'status' }
       existing_ds = existing_ds.deep_string_keys
-
       datasource_id = existing_ds.dig('id')
 
+      return { 'status' => 404, 'message' => format('No Datasource \'%s\' found', name) } if( datasource_id.nil? )
+
+      raise format('Data Source Id can not be 0') if( datasource_id.zero? )
+
+      unless( type.nil? )
+        valid_types = %w[grafana graphite cloudwatch elasticsearch prometheus influxdb mysql opentsdb postgres]
+        raise ArgumentError.new(format('wrong datasource type. only %s allowed, given \%s\'', valid_types.join(', '), type)) if( valid_types.include?(type.downcase) == false )
+      end
+
+      data = {
+        id: datasource_id,
+        orgId: org_id,
+        name: new_name,
+        type: type,
+        access: access,
+        url: url,
+        password: password,
+        user: user,
+        database: database,
+        basicAuth: basic_auth,
+        basicAuthUser: ba_user,
+        basicAuthPassword: ba_user,
+        isDefault: default,
+        jsonData: json_data
+      }
+      data.reject!{ |_k, v| v.nil? }
+
       payload = data.deep_string_keys
       payload = existing_ds.merge(payload).deep_symbolize_keys
 
       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
@@ -125,11 +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] user
-    # @option params [String] password
     # @option params [String] url Datasource URL - (required)
     # @option params [Hash] json_data
     # @option params [Hash] json_secure
@@ -140,7 +198,6 @@ module Grafana
     #    params = {
     #      name: 'graphite',
     #      type: 'graphite',
-    #      database: 'graphite',
     #      url: 'http://localhost:8080'
     #    }
     #    create_datasource(params)
@@ -148,7 +205,6 @@ module Grafana
     #    params = {
     #      name: 'graphite',
     #      type: 'graphite',
-    #      database: 'graphite',
     #      default: true,
     #      url: 'http://localhost:8080',
     #      json_data: { graphiteVersion: '1.1' }
@@ -177,14 +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
-      user        = validate( params, required: false, var: 'user', type: String )
-      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 )
@@ -209,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
@@ -233,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))
@@ -241,12 +290,7 @@ module Grafana
         datasource_id = data.keys.first if( data )
       end
 
-      if( datasource_id.nil? )
-        return {
-          'status' => 404,
-          'message' => format( 'No Datasource \'%s\' found', datasource_id)
-        }
-      end
+      return { 'status' => 404, 'message' => format( 'No Datasource \'%s\' found', datasource_id) } if( datasource_id.nil? )
 
       raise format('Data Source Id can not be 0') if( datasource_id.zero? )