grafana 0.8.5 → 1.1.0

data/lib/grafana/tools.rb

@@ -3,27 +3,52 @@ module Grafana
 
   module Tools
 
+    # return a slugged string for Grafana Dashboards
+    #
+    # @param text [String] text
+    #
+    # @example
+    #    slug( 'test dashboard' )
+    #
+    # @retunr [String]
+    #
     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 =~ /\s/ && text =~ /-/ )
 #        if( text =~ /-/ )
           text = text.gsub( /\s+/, '' )
         else
           text = text.gsub( /\s+/, '-' )
 #        end
-      end
+        end
 
-      rescue => e
-        puts e
+      rescue => error
+        puts error
       end
 
       text.downcase
     end
 
-
+    # regenerate Row Ids in the Dashboard
+    # usefull for an automatic generated Dashboard
+    #
+    # @param params [Hash] params
+    #
+    # @example
+    #    params = {
+    #      dashboard: {
+    #        rows: [
+    #
+    #        ]
+    #      }
+    #    }
+    #    regenerate_template_ids( params )
+    #
+    # @return [Hash]
+    #
     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) )
@@ -49,17 +74,25 @@ module Grafana
       JSON.generate( params )
     end
 
-
+    # check, it an String a valid Json
+    #
+    # @param json [String] json
+    #
+    # @example
+    #   valid_json?( json )
+    #
+    # @return [Boolean]
+    #
     def valid_json?( json )
       begin
         JSON.parse( json )
         return true
-      rescue JSON::ParserError => e
-        @logger.error("json parse error: #{e}") if @debug
+      rescue JSON::ParserError => error
+        @logger.error("json parse error: #{error}") if @debug
         return false
       end
     end
 
-  end
 
+  end
 end

data/lib/grafana/user.rb

@@ -98,7 +98,9 @@ module Grafana
     #
     def add_dashboard_star( dashboard_id )
 
-      raise ArgumentError.new(format('wrong type. user \'dashboard_id\' must be an String (for an Dashboard name) or an Integer (for an Dashboard Id), given \'%s\'', dashboard_id.class.to_s)) if( dashboard_id.is_a?(String) && dashboard_id.is_a?(Integer) )
+      if( dashboard_id.is_a?(String) && dashboard_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'dashboard_id\' must be an String (for an Dashboard name) or an Integer (for an Dashboard Id), given \'%s\'', dashboard_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'dashboard_id\'') if( dashboard_id.size.zero? )
 
       dashboard_id = dashboard if(dashboard_id.is_a?(Integer))
@@ -128,7 +130,9 @@ module Grafana
     #
     def remove_dashboard_star( dashboard_id )
 
-      raise ArgumentError.new(format('wrong type. user \'dashboard_id\' must be an String (for an Dashboard name) or an Integer (for an Dashboard Id), given \'%s\'', dashboard_id.class.to_s)) if( dashboard_id.is_a?(String) && dashboard_id.is_a?(Integer) )
+      if( dashboard_id.is_a?(String) && dashboard_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'dashboard_id\' must be an String (for an Dashboard name) or an Integer (for an Dashboard Id), given \'%s\'', dashboard_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'dashboard_id\'') if( dashboard_id.size.zero? )
 
       dashboard_id = dashboard( dashboard_id ) if(dashboard_id.is_a?(Integer))

data/lib/grafana/users.rb

@@ -30,17 +30,23 @@ module Grafana
     #
     def user( user_id )
 
-      raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', user_id.class.to_s)) if( user_id.is_a?(String) && user_id.is_a?(Integer) )
+      if( user_id.is_a?(String) && user_id.is_a?(Integer) )
+        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))
+      end
       raise ArgumentError.new('missing \'user_id\'') if( user_id.size.zero? )
 
       if(user_id.is_a?(String))
-        user_map = {}
-        users.dig('message').each do |d|
-          usr_id = d.dig('id').to_i
-          user_map[usr_id] = d
-        end
+        usrs  = users
+        usrs  = JSON.parse(usrs) if(usrs.is_a?(String))
+
+        status = usrs.dig('status')
+        return usrs if( status != 200 )
+
+        u = usrs.dig('message').detect { |v| v['login'] == user_id || v['email'] == user_id || v['name'] == user_id }
 
-        user_id = user_map.select { |_k,v| v['login'] == user_id || v['email'] == user_id || v['name'] == user_id }.keys.first
+        return { 'status' => 404, 'message' => format( 'No User \'%s\' found', user_id) } if( u.nil? )
+
+        user_id = u.dig('id') unless(u.nil?)
       end
 
       return { 'status' => 404, 'message' => format( 'No User \'%s\' found', user_id) } if( user_id.nil? )
@@ -102,10 +108,10 @@ module Grafana
 
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
 
-      user_name  = validate( params, required: true, var: 'user_name', type: String )
-      email      = validate( params, required: true, var: 'email', type: String )
+      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
-      theme      = validate( params, required: false, var: 'theme', type: String )
+      theme      = validate( params, required: false, var: 'theme'     , type: String )
 
       usr = user(user_name)
 
@@ -144,7 +150,9 @@ module Grafana
     #
     def user_organizations( user_id )
 
-      raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an Username) or an Integer (for an Userid), given \'%s\'', user_id.class.to_s)) if( user_id.is_a?(String) && user_id.is_a?(Integer) )
+      if( user_id.is_a?(String) && user_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an Username) or an Integer (for an Userid), given \'%s\'', user_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'user_id\'') if( user_id.size.zero? )
 
       usr = user(user_id)

data/lib/grafana/validator.rb

@@ -4,7 +4,20 @@ module Grafana
   # namespace for validate options
   module Validator
 
-    # validate( params, { required: true, var: name, type: String } )
+    # validate some parameters
+    #
+    # @param params [Hash]
+    # @param options [Hash]
+    # @option options [Boolean] required
+    # @option options [String] var
+    # @option options [Class] type
+    #
+    # @example
+    #    default = validate( params, required: false, var: 'default', type: Boolean )
+    #    name    = validate( params, required: true, var: 'name', type: String )
+    #
+    # @return [Mixed]
+    #
     def validate( params, options )
       required = options.dig(:required) || false
       var      = options.dig(:var)
@@ -13,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?) if(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)
@@ -23,6 +36,38 @@ module Grafana
       variable
     end
 
+    # validate an value with an array of values
+    #
+    #
+    # @return [Mixed]
+    #
+    def validate_hash( value, valid_params )
+
+#       puts "validate_hash( #{value}, #{valid_params} )"
+
+      unless( valid_params.collect { |r| r.downcase }.include?(value.downcase) )
+#         puts "NOOO : #{value}"
+        return {
+          'status' => 404,
+          'message' => format( 'wrong value. \'%s\' must be one of \'%s\'', value, valid_params.join('\', \''))
+        }
+      end
+#      puts "result: #{result} #{result.class}"
+#
+#
+#      downcased = Set.new valid_params.map(&:downcase)
+#
+#      puts "downcased: #{downcased}"
+#
+#      unless( downcased.include?( value.downcase ) )
+#        return {
+#          'status' => 404,
+#          'message' => format( 'wrong value. \'%s\' must be one of \'%s\'', value, valid_params.join('\', \''))
+#        }
+#      end
+      true
+    end
+
   end
 end
 

data/lib/grafana/version.rb

@@ -4,11 +4,11 @@ module Grafana
   module Version
 
     # major part of version
-    MAJOR = 0
+    MAJOR = 1
     # minor part of version
-    MINOR = 8
+    MINOR = 1
     # tiny part of version
-    TINY  = 5
+    TINY  = 0
   end
 
   # Current version of gem.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grafana
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Bodo Schulz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: ruby_dig
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -229,49 +215,41 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- doc/Array.html
-- doc/Boolean.html
-- doc/FalseClass.html
-- doc/Grafana.html
-- doc/Hash.html
-- doc/Logging.html
-- doc/Object.html
-- doc/Time.html
-- doc/TrueClass.html
-- doc/_index.html
-- doc/class_list.html
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/method_list.html
-- doc/top-level-namespace.html
+- 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
 - lib/grafana/dashboard_versions.rb
 - lib/grafana/datasource.rb
+- 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
 - lib/grafana/organizations.rb
+- lib/grafana/playlist.rb
+- lib/grafana/preferences.rb
 - lib/grafana/snapshot.rb
 - lib/grafana/tags.rb
+- lib/grafana/teams.rb
 - lib/grafana/tools.rb
 - lib/grafana/user.rb
 - 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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -286,9 +264,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: Grafana HTTP API Wrapper
 test_files: []

data/doc/Array.html

@@ -1,200 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: Array
-  
-    &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 = "Array";
-  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)</a> &raquo;
-    
-    
-    <span class="title">Array</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>Class: Array
-  
-  
-  
-</h1>
-<div class="box_info">
-  
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName"><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></span>
-      
-        <ul class="fullTree">
-          <li><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></li>
-          
-            <li class="next">Array</li>
-          
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      
-    </dd>
-  </dl>
-  
-
-  
-  
-  
-  
-  
-
-  
-
-  
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/monkey_patches.rb</dd>
-  </dl>
-  
-</div>
-
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <hr>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div>
-
-
-
-
-
-
-  
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#compare-instance_method" title="#compare (instance method)">#<strong>compare</strong>(comparate)  &#x21d2; Object </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'></div></span>
-  
-</li>
-
-      
-    </ul>
-  
-
-
-
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="compare-instance_method">
-  
-    #<strong>compare</strong>(comparate)  &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt> 
-  
-
-  
-
-  
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-47
-48
-49</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/monkey_patches.rb', line 47</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_compare'>compare</span><span class='lparen'>(</span> <span class='id identifier rubyid_comparate'>comparate</span> <span class='rparen'>)</span>
-  <span class='id identifier rubyid_to_set'>to_set</span> <span class='op'>==</span> <span class='id identifier rubyid_comparate'>comparate</span><span class='period'>.</span><span class='id identifier rubyid_to_set'>to_set</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
-
-</div>
-
-      <div id="footer">
-  Generated on Tue Dec 12 19:57:41 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>