ruby-grafana-reporter 0.1.6

data/lib/grafana_reporter/errors.rb

@@ -0,0 +1,38 @@
+module GrafanaReporter
+  # General error of the reporter. All other errors will inherit from this class.
+  class GrafanaReporterError < StandardError
+    def initialize(message)
+      super('GrafanaReporterError: ' + message.to_s)
+    end
+  end
+
+  # Thrown, if the requested grafana instance does not have the mandatory 'host'
+  # setting configured.
+  class GrafanaInstanceWithoutHostError < GrafanaReporterError
+    def initialize(instance)
+      super("Grafana instance '#{instance}' has been configured without mandatory 'host' setting.")
+    end
+  end
+
+  # General configuration error. All configuration errors inherit from this class.
+  class ConfigurationError < GrafanaReporterError
+    def initialize(message)
+      super("Configuration error: #{message}")
+    end
+  end
+
+  # Thrown, if a configured path does not exist.
+  class FolderDoesNotExistError < ConfigurationError
+    def initialize(folder, config_item)
+      super("#{config_item} '#{folder}' does not exist.")
+    end
+  end
+
+  # Thrown if the configuration does not match the expected schema.
+  # Details about how to fix that are provided in the message.
+  class ConfigurationDoesNotMatchSchemaError < ConfigurationError
+    def initialize(item, verb, expected, currently)
+      super("Configuration file does not match schema definition. Expected '#{item}' to #{verb} '#{expected}', but was '#{currently}'.")
+    end
+  end
+end

data/lib/grafana_reporter/logger/two_way_logger.rb

@@ -0,0 +1,52 @@
+module GrafanaReporter
+
+  # This module contains special extensions for use in the reporter.
+  module Logger
+
+    # This logger enables a special use case, so that one and the same log
+    # will automatically be send to two different logger destinations.
+    #
+    # One destination is the set {#additional_logger=} which respects the
+    # configured severity. The other destination is an internal logger, which
+    # will always log all messages in mode Logger::Severity::Debug. All messages
+    # of the internal logger can easily be retrieved, by using the
+    # {#internal_messages} method.
+    #
+    # Except the {#level=} setting, all calls to the logger will immediately
+    # be delegated to the internal logger and the configured {#additional_logger=}.
+    # By having this behavior, the class can be used wherever the standard Logger
+    # can also be used.
+    class TwoWayDelegateLogger
+      def initialize
+        @internal_messages = StringIO.new
+        @internal_logger = ::Logger.new(@internal_messages)
+        @internal_logger.level = ::Logger::Severity::DEBUG
+        @additional_logger = ::Logger.new(nil)
+      end
+
+      # Sets the severity level of the additional logger to the given severity.
+      # @param severity one of {Logger::Severity}
+      def level=(severity)
+        @additional_logger.level = severity
+      end
+
+      # @return [String] all messages of the internal logger.
+      def internal_messages
+        @internal_messages.string
+      end
+
+      # Used to set the additional logger in this class to an already existing
+      # logger.
+      # @param logger [Logger] sets the additional logger to the given value.
+      def additional_logger=(logger)
+        @additional_logger = logger || ::Logger.new(nil)
+      end
+
+      # Delegates all not configured calls to the internal and the additional logger.
+      def method_missing(method, *args)
+        @internal_logger.send(method, *args)
+        @additional_logger.send(method, *args)
+      end
+    end
+  end
+end

data/lib/ruby-grafana-reporter.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'fileutils'
+require 'yaml'
+require 'socket'
+require 'uri'
+require 'json'
+require 'tempfile'
+require 'cgi'
+require 'optparse'
+require 'date'
+require 'time'
+require 'logger'
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require 'asciidoctor-pdf'
+require 'zip'
+require_relative 'VERSION.rb'
+
+folders = [
+  %w[grafana],
+  %w[grafana_reporter logger],
+  %w[grafana_reporter],
+  %w[grafana_reporter asciidoctor extensions],
+  %w[grafana_reporter asciidoctor],
+  %w[grafana_reporter application]
+]
+folders.each { |folder| Dir[File.join(__dir__, *folder, '*.rb')].sort.each { |file| require_relative file } }

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruby-grafana-reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Christian Kohlmeyer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-19 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  The reporter provides a full extension setup for the famous Asciidoctor and can perfectly integrate in a docker environment. It can be used as to convert single documents or run as a service.
+
+  As a result of the reporter, you receive PDF documents or any other format that is supported by Asciidoctor.
+email: kohly@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/VERSION.rb"
+- "./lib/grafana/abstract_panel_query.rb"
+- "./lib/grafana/abstract_query.rb"
+- "./lib/grafana/abstract_sql_query.rb"
+- "./lib/grafana/dashboard.rb"
+- "./lib/grafana/errors.rb"
+- "./lib/grafana/grafana.rb"
+- "./lib/grafana/panel.rb"
+- "./lib/grafana/panel_image_query.rb"
+- "./lib/grafana/variable.rb"
+- "./lib/grafana_reporter/abstract_report.rb"
+- "./lib/grafana_reporter/application/application.rb"
+- "./lib/grafana_reporter/application/errors.rb"
+- "./lib/grafana_reporter/asciidoctor/alerts_table_query.rb"
+- "./lib/grafana_reporter/asciidoctor/annotations_table_query.rb"
+- "./lib/grafana_reporter/asciidoctor/errors.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/alerts_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/annotations_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/panel_query_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/panel_query_value_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/processor_mixin.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/show_environment_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/show_help_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/sql_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/sql_value_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/extensions/value_as_variable_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_first_value_query.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_image_query.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_property_query.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_table_query.rb"
+- "./lib/grafana_reporter/asciidoctor/query_mixin.rb"
+- "./lib/grafana_reporter/asciidoctor/report.rb"
+- "./lib/grafana_reporter/asciidoctor/sql_first_value_query.rb"
+- "./lib/grafana_reporter/asciidoctor/sql_table_query.rb"
+- "./lib/grafana_reporter/configuration.rb"
+- "./lib/grafana_reporter/errors.rb"
+- "./lib/grafana_reporter/logger/two_way_logger.rb"
+- "./lib/ruby-grafana-reporter.rb"
+- LICENSE
+- README.md
+homepage: https://github.com/divinity666/ruby-grafana-reporter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: "(Asciidoctor) Reporter Service for Grafana"
+test_files: []