grafana 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e73fd657e1a344d3cb67b5bf01cd33f8e227447e92e6e93b575a51a0091a253
-  data.tar.gz: c9f41ad884326c341d9c25746bfb80967206c5d0f94ef2bf94a4de6dd7e74435
+  metadata.gz: ee4ecb6c21184aee321f81b9d5a5681524da6cac47b736756e8b3b1a4c091eed
+  data.tar.gz: 267e82424dad92727eace6b546f2fd436235e51af5b471c806833e4eb3186efe
 SHA512:
-  metadata.gz: 4aa2e43dbde3b105b5f85c74ac84a4269cd67d2de6b327cc597854ef1e6e4d66ce52628e9564785a0f1729527e90514e2577c83a651d8fe6c82c765c73a8ecbc
-  data.tar.gz: 50df29f0e9ad79c5dd7586dd1190585badb8ae3e09b82847433721cded33a6aa562ccba34be65c12356ca00cde64a45a18bf9dde1592af614a52263d71bca2f4
+  metadata.gz: 97d4a3aa5740c1992cf706fec3deae4690db5c68f05eb334b828dea74d6173fde86fbb3a53c2afe562d5a299e13a2c5450d4e27bcdf7dae96a146a8b3f2cb770
+  data.tar.gz: 5c231dad3f4552d8176b8b0a5653284b3792ec1058c958674a625e99b790d9e51f93eb240ca5f500c94e2cbff23159b2933fac13723cdaa0518b8f808f31176a

data/README.md

@@ -33,9 +33,9 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 To install this gem onto your local machine, run `bundle exec rake install`.
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
 which will create a git tag for the version,
-push git commits and tags and push the `.gem` file to [rubygems.org](https://rubygems.org).
+push git commits and tags and push the `.gem` file to [rubygems.org](https://rubygems.org/gems/grafana).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grafana.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bodsch/grafana.
 

data/lib/_logging.rb_

@@ -0,0 +1,55 @@
+
+require 'logger'
+
+# -------------------------------------------------------------------------------------------------
+
+module Logging
+
+  def logger
+    @logger ||= Logging.logger_for( self.class.name )
+  end
+
+  # Use a hash class-ivar to cache a unique Logger per class:
+  @loggers = {}
+
+  class << self
+
+    def logger_for( classname )
+      @loggers[classname] ||= configure_logger_for( classname )
+    end
+
+    def configure_logger_for( classname )
+
+      log_level = ENV.fetch('LOG_LEVEL', 'INFO' )
+      level = log_level.dup
+
+      # DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
+      log_level = case level.upcase
+        when 'DEBUG'
+          Logger::DEBUG   # Low-level information for developers.
+        when 'INFO'
+          Logger::INFO    # Generic (useful) information about system operation.
+        when 'WARN'
+          Logger::WARN    # A warning.
+        when 'ERROR'
+          Logger::ERROR   # A handleable error condition.
+        when 'FATAL'
+          Logger::FATAL   # An unhandleable error that results in a program crash.
+        else
+          Logger::UNKNOWN  # An unknown message that should always be logged.
+        end
+
+      $stdout.sync           = true
+      logger                 = Logger.new($stdout)
+      logger.level           = log_level
+      logger.datetime_format = "%Y-%m-%d %H:%M:%S %z"
+      logger.formatter       = proc do |severity, datetime, progname, msg|
+        "[#{datetime.strftime( logger.datetime_format )}] #{severity.ljust(5)}  #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end
+
+# -------------------------------------------------------------------------------------------------

data/lib/grafana.rb

@@ -1,5 +1,5 @@
 
-require_relative 'logging'
+# require_relative 'logging'
 require_relative 'monkey_patches.rb'
 require_relative 'grafana/client.rb'
 

data/lib/grafana/alerts.rb

@@ -102,7 +102,6 @@ module Grafana
 #       puts alert_id
       # GET /api/alerts/:id
 
-
       endpoint = format( '/api/alerts/%d' , alert_id )
 
 #       puts endpoint
@@ -130,13 +129,18 @@ module Grafana
       end
       raise ArgumentError.new('missing \'alert_id\'') if( alert_id.size.zero? )
 
-      if(alert_id.is_a?(String))
+      if( alert_id.is_a?(String) )
         data = alerts( alerts: 'all' ).select { |_k,v| v['name'] == alert_id }
         alert_id = data.keys.first if( data )
       end
 
+      endpoint = format( '/api/alerts/%d/pause', alert_id )
+
+      @logger.debug("Attempting pause alert id #{alert_id} (POST #{endpoint})") if @debug
+
       # POST /api/alerts/:id/pause
 #       puts alert_id
+      post( endpoint )
     end
 
     # Get alert notifications

data/lib/grafana/annotations.rb

@@ -124,8 +124,8 @@ module Grafana
       time      = validate( params, required: false, var: 'time', type: Integer ) || Time.now.to_i
       time_end  = validate( params, required: false, var: 'time_end', type: Integer )
       region    = validate( params, required: false, var: 'region', type: Boolean )
-      tags      = validate( params, required: true, var: 'tags', type: Array )
-      text      = validate( params, required: true, var: 'text', type: String )
+      tags      = validate( params, required: true , var: 'tags', type: Array )
+      text      = validate( params, required: true , var: 'text', type: String )
 
       if( dashboard.is_a?(String) )
 

data/lib/grafana/auth.rb

@@ -0,0 +1,150 @@
+
+module Grafana
+
+  # abstract base class for authentication API
+  #
+  # https://grafana.com/docs/grafana/latest/http_api/auth/
+  #
+  # Token
+  #   - Currently you can authenticate via an API Token or via a Session cookie (acquired using regular login or oauth).
+  #
+  # Basic Auth
+  #   - If basic auth is enabled (it is enabled by default) you can authenticate your HTTP request via standard
+  #     basic auth. Basic auth will also authenticate LDAP users.
+  #
+  module Auth
+
+    # Auth HTTP resources / actions
+    # Api Keys
+    #
+    # GET /api/auth/keys
+    def api_keys
+
+      endpoint = '/api/auth/keys'
+
+      @logger.debug("Attempting to get all existing api keys (GET #{endpoint})") if @debug
+
+      get( endpoint )
+    end
+
+
+    def api_key( api_id )
+
+      if( api_id.is_a?(String) && api_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. API token \'api_id\' must be an String (for an API name) or an Integer (for an API Id), given \'%s\'', api_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'api_id\'') if( api_id.size.zero? )
+
+      if(api_id.is_a?(String))
+        keys  = api_keys
+        keys  = JSON.parse(keys) if(keys.is_a?(String))
+
+#         logger.debug(keys)
+
+        status = keys.dig('status')
+        return keys if( status != 200 )
+
+        u = keys.dig('message').detect { |v| v['id'] == api_id || v['name'] == api_id }
+
+#         logger.debug(u)
+
+        return { 'status' => 404, 'message' => format( 'No API token \'%s\' found', api_id ) } if( u.nil? )
+
+        # api_id = u.dig('id') unless(u.nil?)
+      end
+
+      { 'status' => 200, 'message' => u }
+
+    end
+
+
+    # Create API Key
+    #
+    # POST /api/auth/keys
+    # https://grafana.com/docs/grafana/latest/http_api/auth/#create-api-key
+    #
+    # @param [Hash] params
+    # @option params [String] name The key name   - (required)
+    # @option params [String] role  Sets the access level/Grafana Role for the key. Can be one of the following values: Viewer, Editor or Admin.   - (required)
+    # @option params [Integer] seconds_to_live  Sets the key expiration in seconds.
+    #                          It is optional. If it is a positive number an expiration date for the key is set.
+    #                          If it is null, zero or is omitted completely (unless api_key_max_seconds_to_live configuration option is set) the key will never expire.
+    #
+    #
+    # @return [Hash]
+    #
+    # @example:
+    #
+    def create_api_key( 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? )
+
+      name            = validate( params, required: true, var: 'name' )
+      role            = validate( params, required: true, var: 'role' )
+      seconds_to_live = validate( params, required: false, var: 'seconds_to_live', type: Integer )
+
+      valid_roles     = %w[Viewer Editor Admin]
+
+      # https://stackoverflow.com/questions/9333952/case-insensitive-arrayinclude?answertab=votes#tab-top
+      # Do this once, or each time the array changes
+      downcased = Set.new valid_roles.map(&:downcase)
+      unless( downcased.include?( role.downcase ) )
+        return {
+          'status' => 404,
+          'login_or_email' => login_or_email,
+          'role' => role,
+          'message' => format( 'wrong role. Role must be one of %s, given \'%s\'', valid_roles.join(', '), role )
+        }
+      end
+
+      seconds_to_live = 86_400 if seconds_to_live.nil?
+
+      endpoint = '/api/auth/keys'
+
+      data = {
+        name: name,
+        role: role,
+        secondsToLive: seconds_to_live
+      }
+
+      data.reject!{ |_k, v| v.nil? }
+
+      payload = data.deep_string_keys
+      # payload = existing_ds.merge(payload).deep_symbolize_keys
+
+      @logger.debug("create API token (POST #{endpoint})") if @debug
+
+      post(endpoint, payload.to_json)
+
+    end
+
+    # Delete API Key
+    #
+    # DELETE /api/auth/keys/:id
+    def delete_api_key( key_id )
+
+      if( key_id.is_a?(String) && key_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'key_id\' must be an String (for an API Key name) or an Integer (for an API Key Id), given \'%s\'', key_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'key_id\'') if( key_id.size.zero? )
+
+      if(key_id.is_a?(String))
+        data = api_keys.select { |_k,v| v['name'] == key_id }
+        key_id = data.keys.first if( data )
+      end
+
+      return { 'status' => 404, 'message' => format( 'No API key \'%s\' found', key_id) } if( key_id.nil? )
+
+      raise format('API Key can not be 0') if( key_id.zero? )
+
+      endpoint = format('/api/auth/keys/%d', key_id)
+      logger.debug("Deleting API key #{key_id} (DELETE #{endpoint})") if @debug
+
+      delete(endpoint)
+
+    end
+
+  end
+
+end

data/lib/grafana/client.rb

@@ -5,7 +5,9 @@ require 'rest-client'
 require 'json'
 require 'timeout'
 
+require_relative 'logging'
 require_relative 'version'
+require_relative 'auth'
 require_relative 'validator'
 require_relative 'login'
 require_relative 'network'
@@ -48,6 +50,7 @@ module Grafana
     include Logging
 
     include Grafana::Version
+    include Grafana::Auth
     include Grafana::Validator
     include Grafana::Login
     include Grafana::Network
@@ -111,11 +114,18 @@ module Grafana
       ssl                 = settings.dig(:grafana, :ssl)           || false
       @timeout            = settings.dig(:grafana, :timeout)       || 5
       @open_timeout       = settings.dig(:grafana, :open_timeout)  || 5
-      @http_headers       = settings.dig(:grafana, :http_headers)  || {}
+      @api_user           = settings.dig(:grafana, :api, :user)    || 'admin'
+      @api_password       = settings.dig(:grafana, :api, :password)
+      @http_headers       = settings.dig(:grafana, :http_headers)  || { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
       @debug              = settings.dig(:debug)                   || false
-
+      @debug = false
       @headers            = {}
 
+      # Token Support for Grafana 6
+      @api_key            = nil
+      @api_token_name     = settings.dig(:grafana, :api, :token, :name ) || (0..10).to_a.map{|_a| rand(16).to_s(16)}.join
+      @api_token_lifetime = settings.dig(:grafana, :api, :token, :lifetime ) || 0
+
       raise ArgumentError.new('missing \'host\'') if( host.nil? )
 
       raise ArgumentError.new(format('wrong type. \'port\' must be an Integer, given \'%s\'', port.class.to_s)) unless( port.is_a?(Integer) )
@@ -129,6 +139,28 @@ module Grafana
       @url      = format( '%s://%s:%d%s', protocoll, host, port, url_path )
     end
 
+
+    def create_instance
+
+      logger.debug( "create_instance" )
+      logger.debug( "@api_key: #{@api_key} #{@api_key.class}" )
+
+      params = { timeout: @timeout.to_i, open_timeout: @open_timeout.to_i, headers: @http_headers, verify_ssl: false }
+      params = { timeout: @timeout.to_i, open_timeout: @open_timeout.to_i, headers: @http_headers, verify_ssl: false, user: @api_user, password: @api_password } if( @api_key.nil? )
+
+      logger.debug( "url   : #{@url}" )
+      logger.debug( "params: #{params}" )
+
+      begin
+        RestClient::Resource.new( @url, params )
+      rescue => error
+        logger.error( error ) # if @debug
+        logger.debug( e.backtrace.join("\n") ) #if @debug
+        false
+      end
+    end
+
+
     # Get Settings
     #
     # http://docs.grafana.org/http_api/other/#get-settings
@@ -142,20 +174,26 @@ module Grafana
 
     def version
       s = settings
-      @version =  s.dig('buildInfo','version')
-      @major_version = @version.split('.').first.to_i
-
-      {version: @version, major_version: @major_version}
-    end
 
+      status = s.dig('status')
+      if( status.to_i == 200 )
+        @version =  s.dig('buildInfo','version')
+        @major_version = @version.split('.').first.to_i
 
-    def self.logger
-      @@logger ||= defined?(Logging) ? Logging.logger : Logger.new(STDOUT)
+        { version: @version, major_version: @major_version }
+      else
+        s
+      end
     end
 
-    def self.logger=(logger)
-      @@logger = logger
-    end
+
+#    def self.logger
+#      @@logger ||= defined?(Logging) ? Logging.logger : Logger.new(STDOUT)
+#    end
+#
+#    def self.logger=(logger)
+#      @@logger = logger
+#    end
 
   end
 

data/lib/grafana/folder.rb

@@ -99,7 +99,7 @@ module Grafana
 
       endpoint = '/api/folders'
 
-      @logger.debug("create folder#{title} (GET #{endpoint})") if  @debug
+      @logger.debug("create folder #{title} (GET #{endpoint})") if  @debug
       logger.debug(payload.to_json) if(@debug)
 
       post( endpoint, payload.to_json )

data/lib/grafana/logging.rb

@@ -0,0 +1,55 @@
+
+require 'logger'
+
+# -------------------------------------------------------------------------------------------------
+
+module Logging
+
+  def logger
+    @logger ||= Logging.logger_for( self.class.name )
+  end
+
+  # Use a hash class-ivar to cache a unique Logger per class:
+  @loggers = {}
+
+  class << self
+
+    def logger_for( classname )
+      @loggers[classname] ||= configure_logger_for( classname )
+    end
+
+    def configure_logger_for( classname )
+
+      log_level = ENV.fetch('LOG_LEVEL', 'INFO' )
+      level = log_level.dup
+
+      # DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
+      log_level = case level.upcase
+        when 'DEBUG'
+          Logger::DEBUG   # Low-level information for developers.
+        when 'INFO'
+          Logger::INFO    # Generic (useful) information about system operation.
+        when 'WARN'
+          Logger::WARN    # A warning.
+        when 'ERROR'
+          Logger::ERROR   # A handleable error condition.
+        when 'FATAL'
+          Logger::FATAL   # An unhandleable error that results in a program crash.
+        else
+          Logger::UNKNOWN  # An unknown message that should always be logged.
+        end
+
+      $stdout.sync           = true
+      logger                 = Logger.new($stdout)
+      logger.level           = log_level
+      logger.datetime_format = "%Y-%m-%d %H:%M:%S %z"
+      logger.formatter       = proc do |severity, datetime, progname, msg|
+        "[#{datetime.strftime( logger.datetime_format )}] #{severity.ljust(5)}  #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end
+
+# -------------------------------------------------------------------------------------------------

data/lib/grafana/login.rb

@@ -29,20 +29,27 @@ module Grafana
       max_retries = validate( params, required: false, var: 'max_retries', type: Integer ) || 2
       sleep_between_retries = validate( params, required: false, var: 'sleep_between_retries', type: Integer ) || 5
 
-      begin
-        @api_instance = RestClient::Resource.new(
-          @url,
-          timeout: @timeout.to_i,
-          open_timeout: @open_timeout.to_i,
-          headers: @http_headers,
-          verify_ssl: false
-        )
-      rescue => e
-        logger.error( e ) if @debug
-        logger.debug( e.backtrace.join("\n") ) if @debug
-        false
+      # raise 'no valid rest instance found' if( @api_instance.nil? )
+
+      # only useful for Grafana version < 6
+      #
+      if( @api_instance.nil? )
+
+        @api_user = username
+        @api_password = password
+
+        @api_instance = create_instance
+
+        return true if(@api_instance)
+      else
+        logger.debug('User session already initiated') if @debug
+        return true
       end
 
+      logger.debug( "resource: #{@api_instance.inspect}")
+
+      false
+
       request_data = { 'User' => username, 'Password' => password }
 
       if( @api_instance )
@@ -51,13 +58,15 @@ module Grafana
         @headers          = {}
 
         begin
-          logger.debug('Attempting to establish user session') if @debug
+          logger.debug('Attempting to establish user session') # if @debug
 
-          response = @api_instance['/login'].post(
+          response = @api_instance['/api/login'].post(
             request_data.to_json,
             content_type: 'application/json; charset=UTF-8'
           )
 
+          logger.debug( "response #{response}")
+
           response_cookies  = response.cookies
           response_code     = response.code.to_i
 
@@ -131,11 +140,40 @@ module Grafana
     # @return [Hash]
     #
     def ping_session
-      logger.debug( "Pinging current session (GET #{endpoint})" ) if @debug
       endpoint = '/api/login/ping'
-      get( endpoint )
+      logger.debug( "Pinging current session (GET #{endpoint})" ) if @debug
+
+      begin
+        get( endpoint )
+      rescue => error
+        logger.error(e)
+      end
     end
 
+    # Returns health information about Grafana
+    #
+    # @example
+    #    health
+    #
+    # @return [Hash]
+    #
+    def health
+      endpoint = '/api/health'
+      logger.debug( "get health information (GET #{endpoint})" ) if @debug
+
+      result = get( endpoint )
+
+      if( result.is_a?(Hash) )
+        status = result.dig('status')
+        if( status.to_i == 200 )
+          message = result.dig('message')
+          r = message.gsub('=>', ':').gsub(':nil,', ':null,')
+          return { 'status' => status, 'message' => JSON.parse( r ) }
+        end
+      end
+
+      result
+    end
 
     def headers
       @headers

data/lib/grafana/network.rb

@@ -61,9 +61,11 @@ module Grafana
     #
     def request( method_type = 'GET', endpoint = '/', data = {} )
 
+      logger.debug( "request( method_type: #{method_type}, endpoint: #{endpoint}, data )" )
+
       raise 'try first login()' if @api_instance.nil?
 
-      login( username: @username, password: @password )
+#      login( username: @username, password: @password )
 
       response             = nil
       response_code        = 404
@@ -103,7 +105,7 @@ module Grafana
               logger.error('422')
 
               response_body = response_body.first if(response_body.is_a?(Array))
-              message_field_name = response_body.dig('fieldNames')
+              # message_field_name = response_body.dig('fieldNames')
 
               #status   = response_code # response_body.dig('status')
               message  = response_body # .dig('message')
@@ -151,6 +153,8 @@ module Grafana
           return false
         end
 
+#         logger.debug( "response: #{response} (#{response.class})" )
+
         response_code    = response.code.to_i
         response_body    = response.body
         response_headers = response.headers

data/lib/grafana/organizations.rb

@@ -317,7 +317,7 @@ module Grafana
       organization   = validate( params, required: true, var: 'organization', type: String )
       login_or_email = validate( params, required: true, var: 'login_or_email', type: String )
       role           = validate( params, required: true, var: 'role', type: String )
-      valid_roles    = ['Viewer', 'Editor', 'Read Only Editor', 'Admin']
+      valid_roles    = %w[Viewer Editor "Read Only Editor" Admin]
 
       # https://stackoverflow.com/questions/9333952/case-insensitive-arrayinclude?answertab=votes#tab-top
       # Do this once, or each time the array changes

data/lib/grafana/playlist.rb

@@ -122,17 +122,16 @@ module Grafana
         d = data.dig('message')
         data = d.select { |k| k['name'] == playlist_id }
 
-        return { 'status' => 404, 'message' => format( 'No Playlist \'%s\' found', playlist_id) } if( data.size == 0 )
+        return { 'status' => 404, 'message' => format( 'No Playlist \'%s\' found', playlist_id) } if( data.size.zero? )
 
-        if( data.size != 0 )
-
-          _d = []
-          data.each do |k,v|
-            _d << playlist( k['id'] )
+        unless( data.empty? )
+          playlist_data = []
+          data.each_entry do |k|
+            playlist_data << playlist( k['id'] )
           end
-          return { 'status' => status, 'playlists' => _d }
+
+          return { 'status' => status, 'playlists' => playlist_data }
         end
-#        return { 'status' => 200, 'message' => data } if( data.size != 0 )
       end
 
       raise format('playlist id can not be 0') if( playlist_id.zero? )
@@ -145,7 +144,7 @@ module Grafana
 
       return { 'status' => 404, 'message' => 'playlist is empty', 'items' => [] } if( result.dig('status') == 404 )
 
-      return result
+      result
     end
 
     ### Get Playlist items
@@ -192,24 +191,22 @@ module Grafana
       end
       raise ArgumentError.new('missing \'playlist_id\'') if( playlist_id.size.zero? )
 
-      _playlists = playlists
+      tmp_playlists = playlists
 
       begin
-        status  = _playlists.dig('status')
-        message = _playlists.dig('message')
+        status  = tmp_playlists.dig('status').to_i
+        message = tmp_playlists.dig('message')
 
-        if( status == 200 )
+        return tmp_playlists if( status != 200 )
 
-          data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
-          data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+        data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
+        data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
 
-          return { 'status' => 404, 'message' => 'No Playlist found' } if( !data.is_a?(Array) || data.count == 0 || status.to_i != 200 )
-          return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
+        return { 'status' => 404, 'message' => 'No Playlist found' } if( !data.is_a?(Array) || data.count.zero? || status.to_i != 200 )
+        return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
+
+        id = data.first.dig('id')
 
-          id = data.first.dig('id')
-        else
-          return _playlists
-        end
       rescue
         return { 'status' => 404, 'message' => 'No Playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
       end
@@ -220,7 +217,7 @@ module Grafana
 
       return { 'status' => 404, 'message' => 'playlist is empty' } if( result.dig('status') == 404 )
 
-      return result
+      result
     end
 
     ### Get Playlist dashboards
@@ -321,7 +318,7 @@ module Grafana
       interval = validate( params, required: true , var: 'interval'  , type: String )
       items    = validate( params, required: true , var: 'items'     , type: Array )
 
-      return { 'status' => 404, 'message' => 'There are no elements for a playlist' } if(items.count == 0)
+      return { 'status' => 404, 'message' => 'There are no elements for a playlist' } if(items.count.zero?)
 
       payload_items = create_playlist_items(items)
 
@@ -412,29 +409,28 @@ module Grafana
       # organisation = validate( params, required: false, var: 'organisation' )
       items         = validate( params, required: false, var: 'items', type: Array )
 
-      _playlists    = playlists
+      tmp_playlists    = playlists
 
       data = []
 
       begin
-        status  = _playlists.dig('status')
-        message = _playlists.dig('message')
+        status  = tmp_playlists.dig('status').to_i
+        message = tmp_playlists.dig('message')
 
-        if( status == 200 )
-          data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
-          data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+        return tmp_playlists if( status != 200 )
+
+        data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
+        data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+
+        return { 'status' => 404, 'message' => 'no playlist found' } if( !data.is_a?(Array) || data.count.zero? || status.to_i != 200 )
+        return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
 
-          return { 'status' => 404, 'message' => 'no playlist found' } if( !data.is_a?(Array) || data.count == 0 || status.to_i != 200 )
-          return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
-        else
-          return _playlists
-        end
       rescue
         return { 'status' => 404, 'message' => 'no playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
       end
 
       playlist_id   = data.first.dig('id')
-      playlist_name = data.first.dig('name')
+      # playlist_name = data.first.dig('name')
       payload_items = create_playlist_items(items, playlist_id)
 
       payload = {
@@ -479,24 +475,22 @@ module Grafana
       end
       raise ArgumentError.new('missing \'playlist_id\'') if( playlist_id.size.zero? )
 
-      _playlists = playlists
+      tmp_playlists = playlists
 
       data = []
 
       begin
-        status  = _playlists.dig('status')
-        message = _playlists.dig('message')
+        status  = tmp_playlists.dig('status').to_i
+        message = tmp_playlists.dig('message')
 
-        if( status == 200 )
+        return tmp_playlists if( status != 200 )
 
-          data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
-          data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+        data = message.select { |k| k['id'] == playlist_id } if( playlist_id.is_a?(Integer) )
+        data = message.select { |k| k['name'] == playlist_id } if( playlist_id.is_a?(String) )
+
+        return { 'status' => 404, 'message' => 'no playlist found' } if( !data.is_a?(Array) || data.count.zero? || status.to_i != 200 )
+        return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
 
-          return { 'status' => 404, 'message' => 'no playlist found' } if( !data.is_a?(Array) || data.count == 0 || status.to_i != 200 )
-          return { 'status' => 404, 'message' => format('found %d playlists with name %s', data.count, playlist_id ) } if( data.count > 1 && multi_result == false )
-        else
-          return _playlists
-        end
       rescue
         return { 'status' => 404, 'message' => 'no playlists found' } if( playlists.nil? || playlists == false || playlists.dig('status').to_i != 200 )
       end
@@ -515,7 +509,7 @@ module Grafana
           end
         end
 
-        return result
+        # return result
       else
 
         playlist_id = data.first.dig('id')
@@ -530,69 +524,70 @@ module Grafana
           return { 'status' => 200, 'message' => 'playlist deleted' } if(r.dig('status').to_i == 404)
         end
 
-        return result
+        # return result
       end
 
+      result
     end
 
 
     private
-    def create_playlist_items( items, playlistId = nil)
+    def create_playlist_items( items, playlist_id = nil)
 
-      _items   = []
+      playlist_items   = []
 
       items.each do |r|
-        _element = {}
+        playlist_element = {}
 
         if( r['name'] )
 
-          _name = search_dashboards( query: r['name'] )
-          _name_status = _name.dig('status')
+          playlist_name = search_dashboards( query: r['name'] )
+          playlist_name_status = playlist_name.dig('status')
 
-          next unless( _name_status == 200 )
+          next unless( playlist_name_status == 200 )
 
-          _name       = _name.dig('message')
-          _name_id    = _name.first.dig('id')
-          _name_title = _name.first.dig('title')
+          playlist_name       = playlist_name.dig('message')
+          playlist_name_id    = playlist_name.first.dig('id')
+          playlist_name_title = playlist_name.first.dig('title')
 
-          _element[:type]  = 'dashboard_by_id'
-          _element[:value] = _name_id.to_s
-          _element[:title] = _name_title
-          _element[:playlistId] = playlistId unless(playlistId.nil?)
+          playlist_element[:type]  = 'dashboard_by_id'
+          playlist_element[:value] = playlist_name_id.to_s
+          playlist_element[:title] = playlist_name_title
+          playlist_element[:playlistId] = playlist_id unless(playlist_id.nil?)
 
         elsif( r['id'] )
 
-          _uid = dashboard_by_uid(r['id'])
-          _uid_status = _uid.dig('status')
+          uid = dashboard_by_uid(r['id'])
+          uid_status = uid.dig('status')
 
-          next unless( _uid_status == 200 )
+          next unless( uid_status == 200 )
 
-          _element[:type]  = 'dashboard_by_id'
-          _element[:value] = r['id']
-          _element[:playlistId] = playlistId unless(playlistId.nil?)
+          playlist_element[:type]  = 'dashboard_by_id'
+          playlist_element[:value] = r['id']
+          playlist_element[:playlistId] = playlist_id unless(playlist_id.nil?)
 
         elsif( r['tag'] )
 
-          _tags = search_dashboards( tags: r['tag'] )
-          _tags_status = _tags.dig('status')
+          tags        = search_dashboards( tags: r['tag'] )
+          tags_status = tags.dig('status')
 
-          next unless( _tags_status == 200 )
+          next unless( tags_status == 200 )
 
-          _element[:type]  = 'dashboard_by_tag'
-          _element[:value] = r['tag']
-          _element[:title] = r['tag']
-          _element[:playlistId] = playlistId unless(playlistId.nil?)
+          playlist_element[:type]  = 'dashboard_by_tag'
+          playlist_element[:value] = r['tag']
+          playlist_element[:title] = r['tag']
+          playlist_element[:playlistId] = playlist_id unless(playlist_id.nil?)
 
         else
           next
         end
 
-        _element[:order] = r['order'] if(r['order'])
+        playlist_element[:order] = r['order'] if(r['order'])
 
-        _items << _element if(_element.count >= 4)
+        playlist_items << playlist_element if(playlist_element.count >= 4)
       end
 
-      _items
+      playlist_items
     end
 
   end

data/lib/grafana/preferences.rb

@@ -11,7 +11,7 @@ module Grafana
 
     # Get Current User Prefs
     # GET /api/user/preferences
-    def user_preferences()
+    def user_preferences
 
       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)
@@ -43,7 +43,7 @@ module Grafana
 
     # Get Current Org Prefs
     # GET /api/org/preferences
-    def org_preferences()
+    def org_preferences
 
       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)

data/lib/grafana/validator.rb

@@ -8,7 +8,7 @@ module Grafana
     #
     # @param params [Hash]
     # @param options [Hash]
-    # @option options [Boolean] requiered
+    # @option options [Boolean] required
     # @option options [String] var
     # @option options [Class] type
     #
@@ -26,7 +26,7 @@ module Grafana
       params   = params.deep_symbolize_keys
       variable = params.dig(var.to_sym)
 
-      raise ArgumentError.new(format('\'%s\' is requiered and missing!', var)) if(variable.nil? && required == true )
+      raise ArgumentError.new(format('\'%s\' is required and missing!', var)) if(variable.nil? && required == true )
 
       unless( type.nil? )
         clazz = Object.const_get(type.to_s)

data/lib/grafana/version.rb

@@ -6,7 +6,7 @@ module Grafana
     # major part of version
     MAJOR = 1
     # minor part of version
-    MINOR = 0
+    MINOR = 1
     # tiny part of version
     TINY  = 0
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grafana
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Bodo Schulz
@@ -215,10 +215,12 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/_logging.rb_
 - lib/grafana.rb
 - lib/grafana/admin.rb
 - lib/grafana/alerts.rb
 - lib/grafana/annotations.rb
+- lib/grafana/auth.rb
 - lib/grafana/client.rb
 - lib/grafana/dashboard.rb
 - lib/grafana/dashboard_permissions.rb
@@ -227,6 +229,7 @@ files:
 - lib/grafana/folder.rb
 - lib/grafana/folder_and_dashboard_search.rb
 - lib/grafana/folder_permissions.rb
+- lib/grafana/logging.rb
 - lib/grafana/login.rb
 - lib/grafana/network.rb
 - lib/grafana/organization.rb
@@ -241,7 +244,6 @@ files:
 - lib/grafana/users.rb
 - lib/grafana/validator.rb
 - lib/grafana/version.rb
-- lib/logging.rb
 - lib/monkey_patches.rb
 homepage: http://github.com/bodsch/ruby-grafana
 licenses:

data/lib/logging.rb

@@ -1,35 +0,0 @@
-
-require 'logger'
-
-# -------------------------------------------------------------------------------------------------
-
-module Logging
-
-  def logger
-    @logger ||= Logging.logger_for( self.class.name )
-  end
-
-  # Use a hash class-ivar to cache a unique Logger per class:
-  @loggers = {}
-
-  class << self
-    def logger_for( classname )
-      @loggers[classname] ||= configure_logger_for( classname )
-    end
-
-    def configure_logger_for( classname )
-
-      logger                 = Logger.new(STDOUT)
-      logger.progname        = classname
-      logger.level           = Logger::DEBUG
-      logger.datetime_format = '%Y-%m-%d %H:%M:%S::%3N'
-      logger.formatter       = proc do |severity, datetime, progname, msg|
-        "[#{datetime.strftime( logger.datetime_format )}] #{severity.ljust(5)} : #{progname} - #{msg}\n"
-      end
-
-      logger
-    end
-  end
-end
-
-# -------------------------------------------------------------------------------------------------