grafana 0.8.2

data/lib/grafana/snapshot.rb

@@ -0,0 +1,47 @@
+
+module Grafana
+
+  # http://docs.grafana.org/http_api/snapshot/
+  #
+  module Snapshot
+
+    # Get Snapshot by Id
+    # GET /api/snapshots/:key
+    def snapshot(key)
+
+      raise ArgumentError.new('key must be an String') unless( key.is_a?(String) )
+
+      endpoint = format('/api/snapshot/%s', key)
+      @logger.debug("Get Snapshot by Id #{key} (GET #{endpoint})") if @debug
+
+      get(endpoint)
+    end
+
+    # Create new snapshot
+    # POST /api/snapshots
+    def create_snapshot( dashboard = {} )
+
+      raise ArgumentError.new('dashboard must be an Hash') unless( dashboard.is_a?(String) )
+
+      endpoint = '/api/snapshot'
+      @logger.debug("Creating dashboard snapshot (POST #{endpoint})") if @debug
+
+      post(endpoint, dashboard)
+    end
+
+
+    # Delete Snapshot by Id
+    # GET /api/snapshots-delete/:key
+    def delete_snapshot(key)
+
+      raise ArgumentError.new('key must be an String') unless( key.is_a?(String) )
+
+      endpoint = format( '/api/snapshots-delete/%s', key)
+      @logger.debug("Deleting snapshot id #{key} (GET #{endpoint})") if @debug
+
+      delete(endpoint)
+    end
+
+  end
+
+end

data/lib/grafana/tags.rb

@@ -0,0 +1,41 @@
+module Grafana
+
+  module Tags
+
+    # expand the Template Tags
+    #
+    #
+    #
+    def expand_tags( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+
+      dashboard        = params.dig(:dashboard)
+      additional_tags  = params.dig(:additional_tags) || []
+
+      raise ArgumentError.new(format('wrong type. \'dashboard\' must be an Hash, given \'%s\'', dashboard.class.to_s)) unless( dashboard.is_a?(Hash) )
+      raise ArgumentError.new(format('wrong type. \'additional_tags\' must be an Array, given \'%s\'', additional_tags.class.to_s)) unless( additional_tags.is_a?(Array) )
+
+      # add tags
+      # dashboard = JSON.parse( dashboard ) if( dashboard.is_a?( String ) )
+
+      additional_tags = additional_tags.values if( additional_tags.is_a?( Hash ) )
+
+      current_tags = dashboard.dig( 'dashboard', 'tags' )
+
+      if( !current_tags.nil? && additional_tags.count > 0 )
+
+        current_tags << additional_tags
+
+        current_tags.flatten!
+        current_tags.sort!
+
+        dashboard['dashboard']['tags'] = current_tags
+      end
+
+      JSON.generate( dashboard ) if( dashboard.is_a?( Hash ) )
+    end
+
+  end
+
+end

data/lib/grafana/tools.rb

@@ -0,0 +1,66 @@
+
+module Grafana
+
+  module Tools
+
+    def slug( text )
+
+      raise ArgumentError.new(format('wrong type. \'text\' must be an String, given \'%s\'', text.class.to_s)) unless( text.is_a?(String) )
+
+      begin
+      if( text =~ /\s/ && text =~ /-/ )
+#        if( text =~ /-/ )
+          text = text.gsub( /\s+/, '' )
+        else
+          text = text.gsub( /\s+/, '-' )
+#        end
+      end
+
+      rescue => e
+        puts e
+      end
+
+      text.downcase
+    end
+
+
+    def regenerate_template_ids( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+
+      rows = params.dig('dashboard','rows')
+
+      unless( rows.nil? )
+
+        # counter = 1
+        id_counter = 10
+        rows.each_with_index do |r, _counter|
+
+          panel = r.dig('panels')
+
+          next if( panel.nil? )
+
+          panel.each do |p|
+            p['id']   = id_counter
+            id_counter = id_counter +=1 # id_counter+1 # id_counter +=1 ??
+          end
+        end
+      end
+
+      JSON.generate( params )
+    end
+
+
+    def valid_json?( json )
+      begin
+        JSON.parse( json )
+        return true
+      rescue JSON::ParserError => e
+        @logger.error("json parse error: #{e}") if @debug
+        return false
+      end
+    end
+
+  end
+
+end

data/lib/grafana/user.rb

@@ -0,0 +1,116 @@
+
+module Grafana
+
+  # http://docs.grafana.org/http_api/user/
+  #
+  module User
+
+    # Actual User
+    # GET /api/user
+    def current_user
+      endpoint = '/api/user'
+      @logger.debug("Getting user current user (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Change Password
+    # PUT /api/user/password
+    def update_current_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) )
+
+      old_password = params.dig(:old_password)
+      new_password = params.dig(:new_password)
+
+      raise ArgumentError.new('missing old_password for update') if( old_password.nil? )
+      raise ArgumentError.new('missing new_password for update') if( new_password.nil? )
+
+      endpoint = '/api/user/password'
+      @logger.debug("Updating current user password (PUT #{endpoint})") if @debug
+      put( endpoint, { oldPassword: old_password, newPassword: new_password, confirmNew: new_password }.to_json )
+    end
+
+    # Switch user context for signed in user
+    # POST /api/user/using/:organizationId
+    def switch_current_user_organization( organization )
+
+      raise ArgumentError.new('organization must be an String') unless( params.is_a?(String) )
+
+      org = organization_by_name( organization )
+
+      if  org.nil? || org.dig('status').to_i != 200
+        return {
+          'status' => 404,
+          'message' => format('Organization \'%s\' not found', organization)
+        }
+      end
+
+      org_id = org.dig('id')
+
+      endpoint = format( '/api/user/using/%d', org_id )
+      @logger.debug("Switching current user to Organization #{organization} (GET #{endpoint})") if @debug
+
+      post( endpoint, {} )
+    end
+
+    # Organisations of the actual User
+    # GET /api/user/orgs
+    def current_user_oganizations
+
+      endpoint = '/api/user/orgs'
+      @logger.debug("Getting current user organizations (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Star a dashboard
+    # POST /api/user/stars/dashboard/:dashboardId
+    def add_dashboard_star( dashboard )
+
+      if( !dashboard.is_a?(String) && !dashboard.is_a?(Integer) )
+        raise ArgumentError.new('dashboard must be an String (for an Dashboard name) or an Integer (for an Dashboard ID)')
+      end
+
+      dashboard_id = dashboard if(dashboard.is_a?(Integer))
+
+      if(dashboard.is_a?(String))
+        search = { query: dashboard }
+        r = search_dashboards( search )
+        message = r.dig('message')
+        dashboard_id = message.first.dig('id')
+      end
+
+      raise format('Dashboard id can not be 0') if  dashboard_id.zero?
+
+      endpoint = format( '/api/user/stars/dashboard/%d', dashboard_id )
+      @logger.debug("Adding star to dashboard id #{dashboard_id} (GET #{endpoint})") if @debug
+      post(endpoint, {}.to_json)
+    end
+
+    # Unstar a dashboard
+    # DELETE /api/user/stars/dashboard/:dashboardId
+    def remove_dashboard_star( dashboard )
+
+      if( !dashboard.is_a?(String) && !dashboard.is_a?(Integer) )
+        raise ArgumentError.new('dashboard must be an String (for an Dashboard name) or an Integer (for an Dashboard ID)')
+      end
+
+      dashboard_id = dashboard if(dashboard.is_a?(Integer))
+
+      if(dashboard.is_a?(String))
+
+        search = { query: dashboard }
+        r = search_dashboards( search )
+        message = r.dig('message')
+        dashboard_id = message.first.dig('id')
+      end
+
+      raise format('Dashboard Id can not be 0') if  dashboard_id.zero?
+
+      endpoint = format( '/api/user/stars/dashboard/%d', dashboard_id )
+      @logger.debug("Deleting star on dashboard id #{dashboard_id} (GET #{endpoint})") if @debug
+      delete( endpoint )
+    end
+
+  end
+
+end

data/lib/grafana/users.rb

@@ -0,0 +1,122 @@
+
+module Grafana
+
+  # http://docs.grafana.org/http_api/user/
+  #
+  module Users
+
+    # Search Users
+    # GET /api/users
+    def all_users
+      endpoint = '/api/users'
+      @logger.debug("Getting all users (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Get single user by Id
+    # GET /api/users/:id
+    def user_by_id(id)
+
+      raise ArgumentError.new('id must be an Integer') unless( id.is_a?(Integer) )
+
+      endpoint = format( '/api/users/%d', id )
+      @logger.debug("Getting user by Id #{id} (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Get single user by Username(login) or Email
+    # GET /api/users/lookup?loginOrEmail=user@mygraf.com
+    def user_by_name( name )
+
+      endpoint = format( '/api/users/lookup?loginOrEmail=%s', URI.escape( name ) )
+      @logger.debug("Get User by Name (GET #{endpoint})") if @debug
+      get( endpoint )
+    end
+
+    #
+    #
+    def search_for_users_by( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+
+      all_users = self.all_users()
+      key, value = params.first
+
+      logger.debug("Searching for users matching '#{key}' = '#{value}'") if @debug
+      users = []
+
+      all_users.dig('message').each do |u|
+        users.push(u) if u.select { |_k,v| v == value }.count >= 1
+      end
+
+      (users.length >= 1 ? users : false)
+    end
+
+    # User Update
+    # PUT /api/users/:id
+    def update_user( params = {} )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+
+      user_name   = params.dig(:user_name)
+
+      raise ArgumentError.new('missing \'user_name\'') if( user_name.nil? )
+
+      if( !user_name.is_a?(String) && !user_name.is_a?(Integer) )
+        raise ArgumentError.new('user_name must be an String (for an Username) or an Integer (for an User Id)')
+      end
+
+      usr = user_by_id(user_name) if(user_name.is_a?(Integer))
+      usr = user_by_name(user_name) if(user_name.is_a?(String))
+
+      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/users/%d', user_id )
+
+      @logger.debug("Updating user with Id #{user_id}") if @debug
+
+      usr    = usr.deep_string_keys
+      params = params.deep_string_keys
+
+      params = usr.merge(params)
+
+      put( endpoint, params.to_json )
+    end
+
+    # Get Organisations for user
+    # GET /api/users/:id/orgs
+    def user_organizations(user)
+
+      if( !user.is_a?(String) && !user.is_a?(Integer) )
+        raise ArgumentError.new('user must be an String (for an Dashboard name) or an Integer (for an Dashboard ID)')
+      end
+
+      usr = user_by_id(user) if(user.is_a?(Integer))
+      usr = user_by_name(user) if(user.is_a?(String))
+
+      if  usr.nil? || usr.dig('status').to_i != 200
+        return {
+          'status' => 404,
+          'message' => format('User \'%s\' not found', user)
+        }
+      end
+
+      user_id = usr.dig('id')
+
+      endpoint = format('/api/users/%d/orgs', user_id )
+      @logger.debug("Getting organizations for User #{user} (GET #{endpoint})") if @debug
+      get(endpoint)
+    end
+
+    # Switch user context for a specified user
+    # POST /api/users/:userId/using/:organizationId
+
+  end
+end

data/lib/grafana/validator.rb

@@ -0,0 +1,28 @@
+
+module Grafana
+
+  # namespace for validate options
+  module Validator
+
+    # validate( params, { required: true, var: name, type: String } )
+    def validate( params, options )
+      required = options.dig(:required) || false
+      var      = options.dig(:var)
+      type     = options.dig(:type)
+
+      params   = params.deep_symbolize_keys
+      variable = params.dig(var.to_sym)
+
+      raise ArgumentError.new(format('\'%s\' is requiered and missing!', var)) if(variable.nil?) if(required == true )
+
+      unless( type.nil? )
+        clazz = Object.const_get(type.to_s)
+        raise ArgumentError.new(format('wrong type. \'%s\' must be an %s, given \'%s\'', var, type, variable.class.to_s)) unless( variable.nil? || variable.is_a?(clazz) )
+      end
+
+      variable
+    end
+
+  end
+end
+

data/lib/grafana/version.rb

@@ -0,0 +1,17 @@
+module Grafana
+
+  # namespace for version information
+  module Version
+
+    # major part of version
+    MAJOR = 0
+    # minor part of version
+    MINOR = 8
+    # tiny part of version
+    TINY  = 2
+  end
+
+  # Current version of gem.
+  VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'
+
+end

data/lib/logging.rb

@@ -0,0 +1,35 @@
+
+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
+
+# -------------------------------------------------------------------------------------------------