grafana 0.8.2 → 0.8.5

data/lib/grafana/organizations.rb

@@ -13,7 +13,6 @@ module Grafana
       get( endpoint )
     end
 
-
     # Get a single data sources by Id or Name
     #
     # @example
@@ -35,28 +34,6 @@ module Grafana
       get(endpoint)
     end
 
-#     # Get Organisation by Id
-#     # GET /api/orgs/:orgId
-#     def organization_by_id( id )
-#
-#       raise ArgumentError.new('id must be an Integer') unless( id.is_a?(Integer) )
-#
-#       endpoint = format( '/api/orgs/%d', id )
-#       @logger.debug("Get Organisation by Id (GET #{endpoint}})") if @debug
-#       get( endpoint )
-#     end
-#
-#     # Get Organisation by Name
-#     # GET /api/orgs/name/:orgName
-#     def organization_by_name( name )
-#
-#       raise ArgumentError.new('name must be an String') unless( name.is_a?(String) )
-#
-#       endpoint = format( '/api/orgs/name/%s', URI.escape( name ) )
-#       @logger.debug("Get Organisation by Name (GET #{endpoint})") if @debug
-#       get( endpoint )
-#     end
-
     # Update Organisation
     #
     # fields Adress 1, Adress 2, City are not implemented yet.
@@ -78,30 +55,25 @@ module Grafana
       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? )
 
-      organization   = validate( params, required: true, var: 'organization', type: String )
-      name = validate( params, required: true, var: 'name', type: String )
+      organization = validate( params, required: true, var: 'organization', type: String )
+      name         = validate( params, required: true, var: 'name', type: String )
+      org          = organization( organization )
 
-      org = organization( organization )
+      return { 'status' => 404, 'message' => format('Organization \'%s\' not found', organization) } if( org.nil? || org.dig('status').to_i != 200 )
 
-      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')
+      organization_id = org.dig('id')
 
+      endpoint = format( '/api/orgs/%s', organization_id )
       payload = { name: name }
 
-      endpoint = format( '/api/orgs/%s', org_id )
-      @logger.debug("Update Organisation id #{org_id} (PUT #{endpoint})") if @debug
+      @logger.debug("Update Organisation id #{organization_id} (PUT #{endpoint})") if @debug
 
       put( endpoint, payload.to_json )
     end
 
     # Get Users in Organisation
     #
-    # @param [Mixed] user_id Username (String) or Userid (Integer) for delete User
+    # @param [Mixed] organization_id Organistaion Name (String) or Organistaion Id (Integer)
     #
     # @example
     #    organization_users( 1 )
@@ -109,36 +81,32 @@ module Grafana
     #
     # @return [Hash]
     #
-    def organization_users( org_id )
+    def organization_users( organization_id )
 
-      raise ArgumentError.new(format('wrong type. user \'org_id\' must be an String (for an Organisation name) or an Integer (for an Organisation Id), given \'%s\'', org_id.class.to_s)) if( org_id.is_a?(String) && org_id.is_a?(Integer) )
-      raise ArgumentError.new('missing \'org_id\'') if( org_id.size.zero? )
+      raise ArgumentError.new(format('wrong type. user \'organization_id\' must be an String (for an Organisation name) or an Integer (for an Organisation Id), given \'%s\'', organization_id.class.to_s)) if( organization_id.is_a?(String) && organization_id.is_a?(Integer) )
+      raise ArgumentError.new('missing \'organization_id\'') if( organization_id.size.zero? )
 
-      if(org_id.is_a?(String))
-        org = organization(org_id)
-        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')
+      if(organization_id.is_a?(String))
+        org = organization(organization_id)
+        return { 'status' => 404, 'message' => format('Organization \'%s\' not found', organization) } if( org.nil? || org.dig('status').to_i != 200 )
+
+        organization_id = org.dig('id')
       end
 
-      endpoint = format( '/api/orgs/%s/users', org_id )
+      endpoint = format( '/api/orgs/%s/users', organization_id )
 
-      @logger.debug("Getting users in Organisation id #{org_id} (GET #{endpoint})") if @debug
+      @logger.debug("Getting users in Organisation id #{organization_id} (GET #{endpoint})") if @debug
       get(endpoint)
     end
 
     # Add User in Organisation
     #
-    # @param
+    # @param [Hash] params
     # @option params [String] organization Organisation name
     # @option params [String] login_or_email Login or email
     # @option params [String] role Name of the Role - only 'Viewer', 'Editor', 'Read Only Editor' or 'Admin' allowed
     #
-    # @examle
+    # @example
     #    params = {
     #      organization: 'Foo',
     #      login_or_email: 'foo@foo-bar.tld',
@@ -150,54 +118,25 @@ module Grafana
     #
     def add_user_to_organization( 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? )
-
-      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']
-
-      # 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 ) )
+      data   = validate_organisation_user( params )
+      status = data.dig('status')
 
-        message = format( 'wrong role. Role must be one of %s, given \'%s\'', valid_roles.join(', '), role )
+      return data if( status.nil? || status.to_i == 404 )
 
-        return {
-          'status' => 404,
-          'login_or_email' => login_or_email,
-          'role' => role,
-          'message' => message
-        }
-      end
+      org = data.dig('organisation')
+      usr = data.dig('user')
 
-      org = organization( organization )
-      usr = user_by_name( login_or_email )
-
-      if( org.nil? || org.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('Organization \'%s\' not found', organization)
-        }
-      end
-
-      if( usr.nil? || usr.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('User \'%s\' not found', login_or_email)
-        }
-      end
-
-      org_id = org.dig('id')
+      organization_id = org.dig('id')
+      organization = org.dig('name')
+      login_or_email = usr.dig('email')
+      role = data.dig('role')
 
+      endpoint = format( '/api/orgs/%d/users', organization_id )
       payload = {
         loginOrEmail: login_or_email,
         role: role
       }
 
-      endpoint = format( '/api/orgs/%d/users', org_id )
       @logger.debug("Adding user '#{login_or_email}' to organisation '#{organization}' (POST #{endpoint})") if @debug
 
       post( endpoint, payload.to_json )
@@ -205,12 +144,12 @@ module Grafana
 
     # Update Users in Organisation
     #
-    # @param
+    # @param [Hash] params
     # @option params [String] organization Organisation name
     # @option params [String] login_or_email Login or email
     # @option params [String] role Name of the Role - only 'Viewer', 'Editor', 'Read Only Editor' or 'Admin' allowed
     #
-    # @examle
+    # @example
     #    params = {
     #      organization: 'Foo',
     #      login_or_email: 'foo@foo-bar.tld',
@@ -222,67 +161,36 @@ module Grafana
     #
     def update_organization_user( 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? )
+      data   = validate_organisation_user( params )
+      status = data.dig('status')
 
-      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']
+      return data if( status.nil? || status.to_i == 404 )
 
-      # 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 ) )
-
-        message = format( 'wrong role. Role must be one of %s, given \'%s\'', valid_roles.join(', '), role )
-
-        return {
-          'status' => 404,
-          'login_or_email' => login_or_email,
-          'role' => role,
-          'message' => message
-        }
-      end
-
-      org = organization( organization )
-      usr = user_by_name( login_or_email )
+      org = data.dig('organisation')
+      usr = data.dig('user')
 
-      if( org.nil? || org.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('Organization \'%s\' not found', organization)
-        }
-      end
-
-      if( usr.nil? || usr.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('User \'%s\' not found', login_or_email)
-        }
-      end
-
-      org_id = org.dig('id')
+      organization_id = org.dig('id')
+      organization = org.dig('name')
       usr_id = usr.dig('id')
+      login_or_email = usr.dig('name')
+      role = data.dig(:role)
 
+      endpoint = format( '/api/orgs/%d/users/%d', organization_id, usr_id )
       payload = {
         role: role
       }
 
-      endpoint = format( '/api/orgs/%d/users/%d', org_id, usr_id )
-
       @logger.debug("Updating user '#{login_or_email}' in organization '#{organization}' (PATCH #{endpoint})") if @debug
       patch( endpoint, payload.to_json )
     end
 
     # Delete User in Organisation
     #
-    # @param
+    # @param [Hash] params
     # @option params [String] organization Organisation name
     # @option params [String] login_or_email Login or email
-    # @option params [String] role Name of the Role - only 'Viewer', 'Editor', 'Read Only Editor' or 'Admin' allowed
     #
-    # @examle
+    # @example
     #    params = {
     #      organization: 'Foo',
     #      login_or_email: 'foo@foo-bar.tld'
@@ -291,7 +199,6 @@ module Grafana
     #
     # @return [Hash]
     #
-    # DELETE /api/orgs/:orgId/users/:userId
     def delete_user_from_organization( params )
 
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
@@ -301,26 +208,15 @@ module Grafana
       login_or_email = validate( params, required: true, var: 'login_or_email', type: String )
 
       org = organization( organization )
-      usr = user_by_name( login_or_email )
+      usr = user( login_or_email )
 
-      if( org.nil? || org.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('Organization \'%s\' not found', organization)
-        }
-      end
+      return { 'status' => 404, 'message' => format('Organization \'%s\' not found', organization) } if( org.nil? || org.dig('status').to_i != 200 )
+      return { 'status' => 404, 'message' => format('User \'%s\' not found', login_or_email) } if( usr.nil? || usr.dig('status').to_i != 200 )
 
-      if( usr.nil? || usr.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('User \'%s\' not found', login_or_email)
-        }
-      end
-
-      org_id = org.dig('id')
+      organization_id = org.dig('id')
       usr_id = usr.dig('id')
 
-      endpoint = format( '/api/orgs/%d/users/%d', org_id, usr_id )
+      endpoint = format( '/api/orgs/%d/users/%d', organization_id, usr_id )
 
       @logger.debug("Deleting user '#{login_or_email}' in organization '#{organization}' (DELETE #{endpoint})") if @debug
       delete(endpoint)
@@ -328,10 +224,10 @@ module Grafana
 
     # Create Organisation
     #
-    # @param
+    # @param [Hash] params
     # @option params [String] organization Organisation name
     #
-    # @examle
+    # @example
     #    params = {
     #      name: 'Foo'
     #    }
@@ -345,15 +241,9 @@ module Grafana
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
       name   = validate( params, required: true, var: 'name', type: String )
+      org    = organization( name )
 
-      org = organization( name )
-
-      if( org.nil? || org.dig('status').to_i == 200 )
-        return {
-          'status' => 409,
-          'message' => format('Organisation \'%s\' already exists', name )
-        }
-      end
+      return { 'status' => 409, 'message' => format('Organisation \'%s\' already exists', name ) } if( org.nil? || org.dig('status').to_i == 200 )
 
       endpoint = '/api/orgs'
       payload = {
@@ -382,25 +272,70 @@ module Grafana
       if(organisation_id.is_a?(String))
         data = organizations.dig('message')
         organisation_map = {}
-        data.each do |ds|
-          organisation_map[ds['id']] = ds
+        data.each do |d|
+          organisation_map[d.dig('id')] = d.dig('name')
         end
-        organisation_map.select { |_k,v| v['name'] == organisation_id }
-        organisation_id = organisation_map.keys.first if( data )
+        organisation_id = organisation_map.select { |x,y| y == organisation_id }.keys.first if( organisation_map )
       end
 
-      if( organisation_id.nil? )
+      return { 'status' => 404, 'message' => format( 'No Organisation \'%s\' found', organisation_id) } if( organisation_id.nil? )
+
+      endpoint = format( '/api/orgs/%d', organisation_id )
+      @logger.debug("Deleting organization #{organisation_id} (DELETE #{endpoint})") if @debug
+
+      delete(endpoint)
+    end
+
+
+    private
+    # validate an user for an organisation
+    #
+    # @example
+    #    params = {
+    #      organization: 'Foo',
+    #      login_or_email: 'foo@foo-bar.tld',
+    #      role: 'Viewer'
+    #    }
+    #    validate_organisation_user( params )
+    #
+    # @return [Hash]
+    #
+    def validate_organisation_user( 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? )
+
+      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']
+
+      # 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,
-          'message' => format( 'No Organisation \'%s\' found', organisation_id)
+          '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
 
-      endpoint = format( '/api/orgs/%d', organisation_id )
-      @logger.debug("Deleting organization #{organisation_id} (DELETE #{endpoint})") if @debug
+      org = organization( organization )
+      usr = user( login_or_email )
 
-      delete(endpoint)
+      return { 'status' => 404, 'message' => format('Organization \'%s\' not found', organization) } if( org.nil? || org.dig('status').to_i != 200 )
+      return { 'status' => 404, 'message' => format('User \'%s\' not found', login_or_email) } if( usr.nil? || usr.dig('status').to_i != 200 )
+
+      {
+        'status' => 200,
+        'organisation' => org,
+        'user' => usr,
+        'role' => role
+      }
     end
 
+
   end
 end

data/lib/grafana/tags.rb

@@ -9,12 +9,10 @@ module Grafana
     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) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      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) )
+      dashboard       = validate( params, required: true, var: 'dashboard', type: Hash )
+      additional_tags = validate( params, required: true, var: 'additional_tags', type: Array )
 
       # add tags
       # dashboard = JSON.parse( dashboard ) if( dashboard.is_a?( String ) )
@@ -24,12 +22,9 @@ module Grafana
       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