ruby-grafana-reporter 0.1.7 → 0.2.0

data/bin/ruby-grafana-reporter

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
-require_relative '../lib/ruby-grafana-reporter'
-
-GrafanaReporter::Application::Application.new.configure_and_run(ARGV)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/ruby-grafana-reporter'
+GrafanaReporter::Application::Application.new.configure_and_run(ARGV)

data/lib/VERSION.rb

@@ -1,3 +1,5 @@
-# Version information
-GRAFANA_REPORTER_VERSION = [0, 1, 7].freeze
-GRAFANA_REPORTER_RELEASE_DATE = '2020-10-24'
+# frozen_string_literal: true
+
+# Version information
+GRAFANA_REPORTER_VERSION = [0, 2, 0].freeze
+GRAFANA_REPORTER_RELEASE_DATE = '2020-11-30'

data/lib/grafana/abstract_panel_query.rb

@@ -1,20 +1,22 @@
-require_relative 'abstract_query'
-
-module Grafana
-  # @abstract
-  #
-  # Used as a superclass for all queries, which rely on a {Panel} object.
-  #
-  # @see AbstractQuery
-  class AbstractPanelQuery < AbstractQuery
-    attr_reader :panel
-
-    # Initializes the variables of the query using {AbstractQuery#extract_dashboard_variables}.
-    # @param panel [Panel] panel for which the query shall be executed
-    def initialize(panel)
-      super()
-      @panel = panel
-      extract_dashboard_variables(@panel.dashboard)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'abstract_query'
+
+module Grafana
+  # @abstract
+  #
+  # Used as a superclass for all queries, which rely on a {Panel} object.
+  #
+  # @see AbstractQuery
+  class AbstractPanelQuery < AbstractQuery
+    attr_reader :panel
+
+    # Initializes the variables of the query using {AbstractQuery#extract_dashboard_variables}.
+    # @param panel [Panel] panel for which the query shall be executed
+    def initialize(panel)
+      super()
+      @panel = panel
+      extract_dashboard_variables(@panel.dashboard)
+    end
+  end
+end

data/lib/grafana/abstract_query.rb

@@ -1,127 +1,132 @@
-module Grafana
-  # @abstract Override {#url}, #{#request}, {#pre_process} and {#post_process} in subclass.
-  #
-  # Superclass containing everything for all queries towards grafana.
-  class AbstractQuery
-    attr_accessor :from, :to, :timeout, :result
-    attr_reader :variables
-
-    def initialize
-      @variables = {}
-    end
-
-    # Runs the whole process to receive values properly from this query:
-    # - calls {#pre_process}
-    # - executes this query against the given {Grafana} instance
-    # - calls {#post_process}
-    # - returns the result
-    #
-    # @param grafana [Grafana] {Grafana} object, against which the query is executed
-    # @return [Object] result of the query
-    def execute(grafana)
-      return @result unless @result.nil?
-
-      pre_process(grafana)
-      @result = grafana.execute_http_request(url, request, timeout)
-      post_process
-      @result
-    end
-
-    # Used to retrieve default configurations from the given {Dashboard} and store them as settings in the query.
-    #
-    # Following data is extracted:
-    # - +from+, by {Dashboard#from_time}
-    # - +to+, by {Dashboard#to_time}
-    # - and all variables as {Variable}, prefixed with +var-+, as grafana also does it
-    def extract_dashboard_variables(dashboard)
-      @from = dashboard.from_time
-      @to = dashboard.to_time
-      dashboard.variables.each { |item| merge_variables({ "var-#{item.name}": item }) }
-      self
-    end
-
-    # Merges the given Hash with the stored variables.
-    #
-    # Can be used to easily set many values at once in the local variables hash.
-    #
-    # Please note, that the values of the Hash need to be of type {Variable}.
-    #
-    # @param hash [Hash<String,Variable>] Hash containing variable name as key and {Variable} as value
-    # @return [AbstractQuery] this object
-    def merge_variables(hash)
-      hash.each do |k, v|
-        if @variables[k.to_s].nil?
-          @variables[k.to_s] = v
-        else
-          @variables[k.to_s].raw_value = v.raw_value
-        end
-      end
-      self
-    end
-
-    # @return [Hash<String, Variable>] all grafana variables stored in this query, i.e. the variable name is prefixed with +var-+
-    def grafana_variables
-      @variables.select { |k, _v| k =~ /^var-.+/ }
-    end
-
-    # Replaces the grafana variables in the given string with their replacement value.
-    #
-    # @param string [String] string in which the variables shall be replaced
-    # @param variables [Hash<String,Variable>] Hash containing the variables, which shall be replaced in the given string
-    # @return [String] string in which all variables are properly replaced
-    def replace_variables(string, variables = {})
-      res = string
-      repeat = true
-      repeat_count = 0
-
-      # TODO find a proper way to replace variables recursively instead of over and over again
-      # TODO add tests for recursive replacement of variable
-      while repeat and repeat_count < 3
-        repeat = false
-        repeat_count += 1
-        variables.each do |var_name, obj|
-          # only set ticks if value is string
-          variable = var_name.gsub(/^var-/, '')
-          res = res.gsub(/(?:\$\{#{variable}(?::(?<format>[\w]+))?\}|(?<!\.)\$#{variable}(?!\.))/) do
-            obj.value_formatted($~[:format])
-          end
-        end
-        repeat = true if res.include?('$')
-      end
-
-      res
-    end
-
-    # @abstract
-    #
-    # @return [String] String containing the relative URL to execute the query
-    def uri
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # @return [Hash] Hash containing the request parameters, which shall be overwritten or extended in {Grafana#execute_http_request}
-    def request
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # Use this function to perform all necessary actions, before the query is actually executed.
-    # Here you can e.g. set values of variables or similar.
-    #
-    # @param grafana [Grafana] {Grafana} object, against which the query shall be executed
-    def pre_process(grafana)
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # Use this function to format the raw result of the @result variable to conform to the expected return value.
-    # You might also want to {#replace_variables} in the @result or similar.
-    def post_process
-      raise NotImplementedError
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Grafana
+  # @abstract Override {#url}, #{#request}, {#pre_process} and {#post_process} in subclass.
+  #
+  # Superclass containing everything for all queries towards grafana.
+  class AbstractQuery
+    attr_accessor :from, :to, :timeout, :result
+    attr_reader :variables
+
+    def initialize
+      @variables = {}
+    end
+
+    # Runs the whole process to receive values properly from this query:
+    # - calls {#pre_process}
+    # - executes this query against the given {Grafana} instance
+    # - calls {#post_process}
+    # - returns the result
+    #
+    # @param grafana [Grafana] {Grafana} object, against which the query is executed
+    # @return [Object] result of the query
+    def execute(grafana)
+      return @result unless @result.nil?
+
+      pre_process(grafana)
+      @result = grafana.execute_http_request(url, request, timeout)
+      post_process
+      @result
+    end
+
+    # Used to retrieve default configurations from the given {Dashboard} and store them as settings in the query.
+    #
+    # Following data is extracted:
+    # - +from+, by {Dashboard#from_time}
+    # - +to+, by {Dashboard#to_time}
+    # - and all variables as {Variable}, prefixed with +var-+, as grafana also does it
+    def extract_dashboard_variables(dashboard)
+      @from = dashboard.from_time
+      @to = dashboard.to_time
+      dashboard.variables.each { |item| merge_variables({ "var-#{item.name}": item }) }
+      self
+    end
+
+    # Merges the given Hash with the stored variables.
+    #
+    # Can be used to easily set many values at once in the local variables hash.
+    #
+    # Please note, that the values of the Hash need to be of type {Variable}.
+    #
+    # @param hash [Hash<String,Variable>] Hash containing variable name as key and {Variable} as value
+    # @return [AbstractQuery] this object
+    def merge_variables(hash)
+      hash.each do |k, v|
+        if @variables[k.to_s].nil?
+          @variables[k.to_s] = v
+        else
+          @variables[k.to_s].raw_value = v.raw_value
+        end
+      end
+      self
+    end
+
+    # @return [Hash<String, Variable>] all grafana variables stored in this query, i.e. the variable name
+    #  is prefixed with +var-+
+    def grafana_variables
+      @variables.select { |k, _v| k =~ /^var-.+/ }
+    end
+
+    # Replaces the grafana variables in the given string with their replacement value.
+    #
+    # @param string [String] string in which the variables shall be replaced
+    # @param variables [Hash<String,Variable>] Hash containing the variables, which shall be replaced in the
+    #  given string
+    # @return [String] string in which all variables are properly replaced
+    def replace_variables(string, variables = {})
+      res = string
+      repeat = true
+      repeat_count = 0
+
+      # TODO: find a proper way to replace variables recursively instead of over and over again
+      # TODO: add tests for recursive replacement of variable
+      while repeat && (repeat_count < 3)
+        repeat = false
+        repeat_count += 1
+        variables.each do |var_name, obj|
+          # only set ticks if value is string
+          variable = var_name.gsub(/^var-/, '')
+          res = res.gsub(/(?:\$\{#{variable}(?::(?<format>\w+))?\}|(?<!\.)\$#{variable}(?!\.))/) do
+            obj.value_formatted($LAST_MATCH_INFO[:format])
+          end
+        end
+        repeat = true if res.include?('$')
+      end
+
+      res
+    end
+
+    # @abstract
+    #
+    # @return [String] String containing the relative URL to execute the query
+    def uri
+      raise NotImplementedError
+    end
+
+    # @abstract
+    #
+    # @return [Hash] Hash containing the request parameters, which shall be overwritten or extended in
+    #  {Grafana#execute_http_request}
+    def request
+      raise NotImplementedError
+    end
+
+    # @abstract
+    #
+    # Use this function to perform all necessary actions, before the query is actually executed.
+    # Here you can e.g. set values of variables or similar.
+    #
+    # @param grafana [Grafana] {Grafana} object, against which the query shall be executed
+    def pre_process(grafana)
+      raise NotImplementedError
+    end
+
+    # @abstract
+    #
+    # Use this function to format the raw result of the @result variable to conform to the expected return value.
+    # You might also want to {#replace_variables} in the @result or similar.
+    def post_process
+      raise NotImplementedError
+    end
+  end
+end

data/lib/grafana/abstract_sql_query.rb

@@ -1,42 +1,51 @@
-module Grafana
-  # @abstract
-  #
-  # Used as a superclass for all queries, which execute SQL queries against {Grafana}.
-  #
-  # @see AbstractQuery
-  class AbstractSqlQuery < AbstractQuery
-    attr_reader :sql, :datasource_id
-
-    # @param raw_sql [String] raw sql statement, as it can be sent to a SQL database
-    # @param datasource_id [Integer] ID of the datasource against which the query is run
-    def initialize(raw_sql, datasource_id)
-      super()
-      @sql = raw_sql
-      @datasource_id = datasource_id
-    end
-
-    # @return [String] relative URL, where the request has to be sent to.
-    def url
-      '/api/tsdb/query'
-    end
-
-    # @return [Hash] request, which executes the SQL statement against the specified datasource
-    def request
-      { body: { from: @from, to: @to, queries: [rawSql: @sql, datasourceId: @datasource_id.to_i, format: 'table'] }.to_json, request: Net::HTTP::Post }
-    end
-
-    # Replaces all variables in the SQL statement.
-    def pre_process(grafana)
-      raise MissingSqlQueryError if @sql.nil?
-      unless grafana.datasource_id_exists?(@datasource_id.to_i)
-        raise DatasourceDoesNotExistError.new('id', @datasource_id)
-      end
-
-      @sql = replace_variables(@sql, grafana_variables)
-      # remove comments in query
-      @sql.gsub!(/--[^\r\n]*(?:[\r\n]+|$)/, ' ')
-      @sql.gsub!(/\r\n/, ' ')
-      @sql.gsub!(/\n/, ' ')
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Grafana
+  # @abstract
+  #
+  # Used as a superclass for all queries, which execute SQL queries against {Grafana}.
+  #
+  # @see AbstractQuery
+  class AbstractSqlQuery < AbstractQuery
+    attr_reader :sql, :datasource_id
+
+    # @param raw_sql [String] raw sql statement, as it can be sent to a SQL database
+    # @param datasource_id [Integer] ID of the datasource against which the query is run
+    def initialize(raw_sql, datasource_id)
+      super()
+      @sql = raw_sql
+      @datasource_id = datasource_id
+    end
+
+    # @return [String] relative URL, where the request has to be sent to.
+    def url
+      '/api/tsdb/query'
+    end
+
+    # @return [Hash] request, which executes the SQL statement against the specified datasource
+    def request
+      {
+        body: {
+          from: @from,
+          to: @to,
+          queries: [rawSql: @sql, datasourceId: @datasource_id.to_i, format: 'table']
+        }.to_json,
+        request: Net::HTTP::Post
+      }
+    end
+
+    # Replaces all variables in the SQL statement.
+    def pre_process(grafana)
+      raise MissingSqlQueryError if @sql.nil?
+      unless grafana.datasource_id_exists?(@datasource_id.to_i)
+        raise DatasourceDoesNotExistError.new('id', @datasource_id)
+      end
+
+      @sql = replace_variables(@sql, grafana_variables)
+      # remove comments in query
+      @sql.gsub!(/--[^\r\n]*(?:[\r\n]+|$)/, ' ')
+      @sql.gsub!(/\r\n/, ' ')
+      @sql.gsub!(/\n/, ' ')
+    end
+  end
+end

data/lib/grafana/dashboard.rb

@@ -1,66 +1,77 @@
-module Grafana
-  # Representation of one specific dashboard in a {Grafana} instance.
-  class Dashboard
-    # @return [Grafana] parent {Grafana} object
-    attr_reader :grafana
-    attr_reader :panels, :variables
-
-    # @param model [Hash] converted JSON Hash of the grafana dashboard
-    # @param grafana [Grafana] parent {Grafana} object
-    def initialize(model, grafana)
-      @grafana = grafana
-      @model = model
-
-      # read panels
-      @panels = []
-      if @model.key?('panels')
-        @model['panels'].each do |panel|
-          if panel.key?('panels')
-            panel['panels'].each do |subpanel|
-              @panels << Panel.new(subpanel, self)
-            end
-          else
-            @panels << Panel.new(panel, self)
-          end
-        end
-      end
-
-      # store variables in array as objects of type Variable
-      @variables = []
-      return unless @model.key?('templating')
-
-      list = @model['templating']['list']
-      return unless list.is_a? Array
-
-      list.each do |item|
-        @variables << Variable.new(item)
-      end
-    end
-
-    # @return [String] +from+ time configured in the dashboard.
-    def from_time
-      return @model['time']['from'] if @model['time']
-
-      nil
-    end
-
-    # @return [String] +to+ time configured in the dashboard.
-    def to_time
-      @model['time']['to'] if @model['time']
-      nil
-    end
-
-    # @return [String] dashboard UID
-    def id
-      @model['uid']
-    end
-
-    # @return [Panel] panel for the specified ID
-    def panel(id)
-      panels = @panels.select { |item| item.field('id') == id.to_i }
-      raise PanelDoesNotExistError.new(id, self) if panels.empty?
-
-      panels.first
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Grafana
+  # Representation of one specific dashboard in a {Grafana} instance.
+  class Dashboard
+    # @return [Grafana] parent {Grafana} object
+    attr_reader :grafana
+    attr_reader :panels, :variables
+
+    # @param model [Hash] converted JSON Hash of the grafana dashboard
+    # @param grafana [Grafana] parent {Grafana} object
+    def initialize(model, grafana)
+      @grafana = grafana
+      @model = model
+
+      initialize_panels
+      initialize_variables
+    end
+
+    # @return [String] +from+ time configured in the dashboard.
+    def from_time
+      return @model['time']['from'] if @model['time']
+
+      nil
+    end
+
+    # @return [String] +to+ time configured in the dashboard.
+    def to_time
+      @model['time']['to'] if @model['time']
+      nil
+    end
+
+    # @return [String] dashboard UID
+    def id
+      @model['uid']
+    end
+
+    # @return [Panel] panel for the specified ID
+    def panel(id)
+      panels = @panels.select { |item| item.field('id') == id.to_i }
+      raise PanelDoesNotExistError.new(id, self) if panels.empty?
+
+      panels.first
+    end
+  end
+
+  private
+
+  # store variables in array as objects of type Variable
+  def initialize_variables
+    @variables = []
+    return unless @model.key?('templating')
+
+    list = @model['templating']['list']
+    return unless list.is_a? Array
+
+    list.each do |item|
+      @variables << Variable.new(item)
+    end
+  end
+
+  # read panels
+  def initialize_panels
+    @panels = []
+    return unless @model.key?('panels')
+
+    @model['panels'].each do |panel|
+      if panel.key?('panels')
+        panel['panels'].each do |subpanel|
+          @panels << Panel.new(subpanel, self)
+        end
+      else
+        @panels << Panel.new(panel, self)
+      end
+    end
+  end
+end