RubyGems - grafana - Versions diffs - 0.8.2 - Mend

grafana 0.8.2

Files changed (42) hide show

checksums.yaml +7 -0
data/LICENSE +21 -0
data/README.md +36 -0
data/doc/Array.html +200 -0
data/doc/Boolean.html +122 -0
data/doc/FalseClass.html +132 -0
data/doc/Grafana.html +172 -0
data/doc/Hash.html +212 -0
data/doc/Logging.html +326 -0
data/doc/Object.html +286 -0
data/doc/Time.html +200 -0
data/doc/TrueClass.html +132 -0
data/doc/_index.html +380 -0
data/doc/class_list.html +51 -0
data/doc/file.README.html +117 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +117 -0
data/doc/method_list.html +771 -0
data/doc/top-level-namespace.html +112 -0
data/lib/grafana.rb +7 -0
data/lib/grafana/admin.rb +310 -0
data/lib/grafana/alerts.rb +38 -0
data/lib/grafana/annotations.rb +40 -0
data/lib/grafana/client.rb +126 -0
data/lib/grafana/dashboard.rb +149 -0
data/lib/grafana/dashboard_versions.rb +30 -0
data/lib/grafana/datasource.rb +271 -0
data/lib/grafana/login.rb +139 -0
data/lib/grafana/network.rb +169 -0
data/lib/grafana/organization.rb +101 -0
data/lib/grafana/organizations.rb +406 -0
data/lib/grafana/snapshot.rb +47 -0
data/lib/grafana/tags.rb +41 -0
data/lib/grafana/tools.rb +66 -0
data/lib/grafana/user.rb +116 -0
data/lib/grafana/users.rb +122 -0
data/lib/grafana/validator.rb +28 -0
data/lib/grafana/version.rb +17 -0
data/lib/logging.rb +35 -0
data/lib/monkey_patches.rb +92 -0
metadata +294 -0

@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.11
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Boolean.html" title="Boolean (module)">Boolean</a></span>, <span class='object_link'><a href="Grafana.html" title="Grafana (module)">Grafana</a></span>, <span class='object_link'><a href="Logging.html" title="Logging (module)">Logging</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>, <span class='object_link'><a href="FalseClass.html" title="FalseClass (class)">FalseClass</a></span>, <span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span>, <span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span>, <span class='object_link'><a href="Time.html" title="Time (class)">Time</a></span>, <span class='object_link'><a href="TrueClass.html" title="TrueClass (class)">TrueClass</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Sun Dec 10 16:07:39 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.11 (ruby-2.2.8).
+</div>
+    </div>
+  </body>
+</html>

data/lib/grafana.rb ADDED

@@ -0,0 +1,7 @@
+require_relative 'logging'
+require_relative 'monkey_patches.rb'
+require_relative 'grafana/client.rb'
+module Grafana
+end

data/lib/grafana/admin.rb ADDED

@@ -0,0 +1,310 @@
+module Grafana
+  # All Admin API Calls found under http://docs.grafana.org/http_api/admin/
+  #
+  # The Admin HTTP API does not currently work with an API Token.
+  # API Tokens are currently only linked to an organization and an organization role.
+  #
+  # They cannot be given the permission of server admin, only users can be given that permission.
+  # So in order to use these API calls you will have to use Basic Auth and the Grafana user must
+  # have the Grafana Admin permission.
+  #
+  # (The default admin user is called admin and has permission to use this API.)
+  #
+  module Admin
+    # get all admin settings
+    #
+    # @example
+    #    admin_settings
+    #
+    # @return [Hash]
+    #
+    def admin_settings
+      logger.debug('Getting admin settings') if @debug
+      get('/api/admin/settings')
+    end
+    # get all grafana statistics
+    #
+    # @example
+    #    admin_stats
+    #
+    # @return [Hash]
+    #
+    def admin_stats
+      logger.debug('Getting admin statistics') if @debug
+      get('/api/admin/stats')
+    end
+    # set User Permissions
+    #
+    # Only works with Basic Authentication (username and password).
+    #
+    # @param [Hash] params
+    # @option params [String] name login or email for user
+    # @option params [Mixed] permissions string or hash to change permissions
+    #  [String] only 'Viewer', 'Editor', 'Read Only Editor' or 'Admin' allowed
+    #  [Hash] grafana_admin: true or false
+    #
+    # @example
+    #    update_user_permissions( user_name: 'admin', permissions: 'Viewer' )
+    #    update_user_permissions( user_name: 'admin', permissions: { grafana_admin: true } )
+    #
+    # @return [Hash]
+    #
+    def update_user_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? )
+      user_name   = validate( params, required: true, var: 'user_name', type: String )
+      permissions = validate( params, required: true, var: 'permissions' )
+      raise ArgumentError.new(format('wrong type. \'permissions\' must be an String or Hash, given %s', permissions.class.to_s ) ) unless( permissions.is_a?(String) || permissions.is_a?(Hash) )
+      valid_perms = ['Viewer','Editor','Read Only Editor','Admin']
+      if( permissions.is_a?( String ) && !valid_perms.include?(permissions) )
+        message = format( 'user permissions must be one of %s, given \'%s\'', valid_perms.join(', '), permissions )
+#        logger.warn( message )
+        return {
+          'status' => 404,
+          'name' => user_name,
+          'permissions' => permissions,
+          'message' => message
+        }
+      elsif( permissions.is_a?(Hash) && !permissions.dig(:grafana_admin).nil? )
+        grafana_admin = permissions.dig(:grafana_admin)
+        unless( grafana_admin.is_a?(Boolean) )
+          message = 'Grafana admin permission must be either \'true\' or \'false\''
+#           logger.warn( message )
+          return {
+            'status' => 404,
+            'name' => user_name,
+            'permissions' => permissions,
+            'message' => message
+          }
+        end
+      end
+      usr = user_by_name(user_name)
+      if( usr.nil? || usr.dig('status').to_i != 200 )
+        return {
+          'status' => 404,
+          'message' => format('User \'%s\' not found', user_name)
+        }
+      end
+      user_id = usr.dig('id')
+      if( permissions.is_a?(Hash) )
+        endpoint = format( '/api/admin/users/%s/permissions', user_id )
+        payload = {
+          isGrafanaAdmin: grafana_admin
+        }
+        logger.debug("Updating user id #{user_id} permissions (PUT #{endpoint})") if @debug
+        logger.debug(payload.to_json) if(@debug)
+        return put(endpoint, payload.to_json )
+      else
+        org = current_organization
+        endpoint = format( '/api/orgs/%s/users/%s', org['id'], user_id )
+        logger.debug( format( 'Updating user id %s permissions', user_id ) ) if @debug
+        payload = {
+          name: org.dig('name'),
+          orgId: org.dig('id'),
+          role: permissions.downcase.capitalize
+        }
+        logger.debug("Updating user id #{user_id} permissions (PATCH #{endpoint})") if @debug
+        logger.debug(payload.to_json) if(@debug)
+        return patch( endpoint, payload.to_json )
+      end
+    end
+    # Delete an Global User
+    #
+    # Only works with Basic Authentication (username and password).
+    #
+    # @param [Mixed] user_id Username (String) or Userid (Integer) for delete User
+    #   The Admin User can't be delete!
+    #
+    # @example
+    #    delete_user( 1 )
+    #    delete_user( 'foo' )
+    #
+    # @return [Hash]
+    #
+    def delete_user( user_id )
+      raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an User name) or an Integer (for an User Id), given \'%s\'', user_id.class.to_s)) if( user_id.is_a?(String) && user_id.is_a?(Integer) )
+      raise ArgumentError.new('missing \'user_id\'') if( user_id.size.zero? )
+      if(user_id.is_a?(String))
+        usr = user_by_name(user_id)
+        user_id = usr.dig('id')
+      end
+      if( user_id.nil? )
+        return {
+          'status' => 404,
+          'message' => format( 'No User \'%s\' found', user_id)
+        }
+      end
+      if( user_id.is_a?(Integer) && user_id.to_i.zero? )
+        return {
+          'status' => 403,
+          'message' => format( 'Can\'t delete user id %d (admin user)', user_id )
+        }
+      end
+      endpoint = format('/api/admin/users/%d', user_id )
+      logger.debug( "Deleting user id #{user_id} (DELETE #{endpoint})" ) if @debug
+      delete( endpoint )
+    end
+    # Create new user
+    #
+    # Only works with Basic Authentication (username and password).
+    #
+    # @param [Hash] params
+    # @option params [String] user_name name for user (required)
+    # @option params [String] email email for user (required)
+    # @option params [String] login_name login name for user (optional)  - if 'login_name' is not set, 'name' is used
+    # @option params [String] password password (required)
+    #
+    # @example
+    #    params = {
+    #      user_name: 'foo',
+    #      email: 'foo@bar.com',
+    #      password: 'pass'
+    #    }
+    #    add_user( params )
+    #
+    # @return [Hash|FalseClass]
+    #
+    def add_user( 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? )
+      user_name = validate( params, required: true, var: 'user_name', type: String )
+      email = validate( params, required: true, var: 'email', type: String )
+      login_name = validate( params, required: false, var: 'login_name', type: String ) || user_name
+      password = validate( params, required: true, var: 'password', type: String )
+      usr = user_by_name(user_name)
+      if( usr.nil? || usr.dig('status').to_i == 200 )
+        return {
+          'status' => 404,
+          'id' => usr.dig('id'),
+          'email' => usr.dig('email'),
+          'name' => usr.dig('name'),
+          'login' => usr.dig('login'),
+          'message' => format( 'user \'%s\' with email \'%s\' exists', user_name, email )
+        }
+      end
+      #
+      payload = {
+        name: user_name,
+        email: email,
+        login: login_name,
+        password: password
+      }
+      payload.reject!{ |_k, v| v.nil? }
+      endpoint = '/api/admin/users'
+      logger.debug("Create user #{user_name} (PUT #{endpoint})") if @debug
+      logger.debug(payload.to_json) if(@debug)
+      post( endpoint, payload.to_json)
+    end
+    # Change Password for User
+    #
+    # Only works with Basic Authentication (username and password).
+    # Change password for a specific user.
+    #
+    # @param [Hash] params
+    # @option params [String] user_name user_name for user (required)
+    # @option params [String] password password to set (required)
+    #
+    # @example
+    #    params = {
+    #      user_name: 'foo',
+    #      password: 'bar'
+    #    }
+    #    update_user_password( params )
+    #
+    # @return [Hash]
+    #
+    def update_user_password( 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? )
+      user_name = validate( params, required: true, var: 'user_name', type: String )
+      password = validate( params, required: true, var: 'password', type: String )
+      usr = user_by_name(user_name)
+      if( usr.nil? || usr.dig('status').to_i != 200 )
+        return {
+          'status' => 404,
+          'message' => format('User \'%s\' not found', user_name)
+        }
+      end
+      user_id = usr.dig('id')
+      endpoint = format( '/api/admin/users/%d/password', user_id )
+      payload = {
+        password: password
+      }
+      logger.debug("Updating password for user id #{user_id} (PUT #{endpoint})") if @debug
+      logger.debug(payload.to_json) if(@debug)
+      put( endpoint, payload.to_json )
+    end
+    # Pause all alerts
+    #
+    # Only works with Basic Authentication (username and password).
+    #
+    # @example
+    #    pause_all_alerts
+    #
+    # @return [Hash]
+    #
+    def pause_all_alerts
+      endpoint = '/api/admin/pause-all-alerts'
+      logger.debug("pause all alerts (POST #{endpoint})") if @debug
+      post( endpoint, nil )
+    end
+  end
+end

data/lib/grafana/alerts.rb ADDED

@@ -0,0 +1,38 @@
+module Grafana
+  # http://docs.grafana.org/http_api/alerting/
+  #
+  module Alerts
+    # Get alerts
+    # GET /api/alerts/
+    #
+    # Get one alert
+    # GET /api/alerts/:id
+    #
+    def alerts( id = nil ); end
+    # Pause alert
+    # POST /api/alerts/:id/pause
+    def alert_pause( id ); end
+    # Get alert notifications
+    # GET /api/alert-notifications
+    def alert_notifications; end
+    # Create alert notification
+    # POST /api/alert-notifications
+    def create_alert_notification( oarams ); end
+    # Update alert notification
+    # PUT /api/alert-notifications/1
+    def update_alert_notification( params ); end
+    # Delete alert notification
+    # DELETE /api/alert-notifications/:notificationId
+    def delete_alert_notification( id ); end
+  end
+end