grafana 0.8.2 → 1.0.0

data/lib/grafana/network.rb

@@ -3,77 +3,151 @@ module Grafana
 
   module Network
 
+    # GET request
+    #
+    # @param endpoint [String]
+    #
     def get( endpoint )
-
       request( 'GET', endpoint )
     end
 
+    # POST request
+    #
+    # @param endpoint [String]
+    # @param data [Hash]
+    #
     def post( endpoint, data )
-
       request( 'POST', endpoint, data )
     end
 
+    # PUT request
+    #
+    # @param endpoint [String]
+    # @param data [Hash]
+    #
     def put( endpoint, data )
-
       request( 'PUT', endpoint, data )
     end
 
+    # PATCH request
+    #
+    # @param endpoint [String]
+    # @param data [Hash]
+    #
     def patch( endpoint, data )
-
       request( 'PATCH', endpoint, data )
     end
 
+    # DELETE request
+    #
+    # @param endpoint [String]
+    #
     def delete( endpoint )
-
       request( 'DELETE', endpoint )
     end
 
+
+    private
+    # helper function for all request methods
+    #
+    # @param method_type [String]
+    # @param endpoint [String]
+    # @param data [Hash]
+    #
+    # @example
+    #
+    #
+    # @return [Hash]
+    #
     def request( method_type = 'GET', endpoint = '/', data = {} )
 
-      raise 'try first login()' if  @api_instance.nil?
+      raise 'try first login()' if @api_instance.nil?
+
+      login( username: @username, password: @password )
 
       response             = nil
       response_code        = 404
       response_body        = ''
 
       begin
-
         case method_type.upcase
         when 'GET'
-          response = @api_instance[endpoint].get( @headers )
+          response = @api_instance[endpoint].get( headers )
         when 'POST'
-          response = @api_instance[endpoint].post( data, @headers )
+          response = @api_instance[endpoint].post( data, headers )
         when 'PATCH'
-          response = @api_instance[endpoint].patch( data, @headers )
+          response = @api_instance[endpoint].patch( data, headers )
         when 'PUT'
-          # response = @api_instance[endpoint].put( data, @headers )
-          @api_instance[endpoint].put( data, @headers ) do |response, request, result|
 
-            case response.code
+          # response = @api_instance[endpoint].put( data, headers )
+          @api_instance[endpoint].put( data, headers ) do |resp, _request, _result|
+
+            response_code = resp.code.to_i
+            response_body = resp.body
+            response_body = JSON.parse(response_body) if response_body.is_a?(String)
+
+            #logger.debug( "code   : #{response_code}" )
+            #logger.debug( "message: #{response_body}" )
+
+            case response_code.to_i
             when 200
-              response_body = response.body
-              response_code = response.code.to_i
-              response_body = JSON.parse(response_body) if response_body.is_a?(String)
-
-              return {
-                'status' => response_code,
-                'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message')
-              }
+              return { 'status' => response_code, 'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message') }
             when 400
-              response_body = response.body
-              response_code = response.code.to_i
               raise RestClient::BadRequest
+            when 412
+              status  = response_body.dig('status')
+              message = response_body.dig('message')
+              message += " (#{status})"  unless(status.nil?)
+              return { 'status'  => response_code, 'message' => message }
+            when 422
+              logger.error('422')
+
+              response_body = response_body.first if(response_body.is_a?(Array))
+              message_field_name = response_body.dig('fieldNames')
+
+              #status   = response_code # response_body.dig('status')
+              message  = response_body # .dig('message')
+              #message += " (#{status})"  unless(status.nil?)
+
+              # [{fieldNames"=>["Id"], "classification"=>"RequiredError", "message"=>"Required"}]
+
+              logger.error(message)
+              return { 'status'  => response_code, 'message' => message }
+#              #raise RestClient::UnprocessableEntity
             else
-              logger.error( response.code )
-              logger.error( response.body )
-              response.return! # (request, result)
+#              logger.error( response_code )
+#              logger.error( response_body )
+              return { 'status' => response_code, 'message' => response_body.dig('message') }
+              # response.return! # (request, result)
             end
           end
 
         when 'DELETE'
-          response = @api_instance[endpoint].delete( @headers )
+
+          @api_instance[endpoint].delete( headers ) do |resp, _request, _result|
+
+            response_code = resp.code.to_i
+            response_body = resp.body
+            response_body = JSON.parse(response_body) if response_body.is_a?(String)
+
+            #logger.debug( "code   : #{response_code}" )
+            #logger.debug( "message: #{response_body}" )
+
+            case response_code.to_i
+            when 200
+              return { 'status' => response_code, 'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message') }
+            when 404
+              return { 'status' => response_code, 'message' => response_body.dig('message').nil? ? 'Successful' : response_body.dig('message') }
+            else
+#              logger.error( response_code )
+#              logger.error( response_body )
+              return { 'status' => response_code, 'message' => response_body.dig('message') }
+            end
+
+          end
+
         else
-          @logger.error( "Error: #{__method__} is not a valid request method." )
+          logger.error( "Error: #{__method__} is not a valid request method." )
           return false
         end
 
@@ -81,89 +155,52 @@ module Grafana
         response_body    = response.body
         response_headers = response.headers
 
-        if( @debug )
-          logger.debug("response_code : #{response_code}" )
-          logger.debug("response_body : #{response_body}" )
-          logger.debug("response_headers : #{response_headers}" )
-        end
-
         if( ( response_code >= 200 && response_code <= 299 ) || ( response_code >= 400 && response_code <= 499 ) )
 
-          result = JSON.parse( response_body )
-
-          if( result.is_a?(Array) )
-            r_result= {
-              'status' => response_code,
-              'message' => result
-            }
-            return r_result
+          if( response_body =~ /^\[.*\]$/ || response_body =~ /^\{.*\}$/ )
+            result = JSON.parse( response_body )
+            return { 'status' => response_code, 'message' => result } if( result.is_a?(Array) )
+          else
+            return { 'status' => response_code, 'message' => response_body }
           end
 
-          result_status = result.dig('status') if( result.is_a?( Hash ) )
-
+          result_status     = result.dig('status') if( result.is_a?( Hash ) )
           result['message'] = result_status unless( result_status.nil? )
           result['status']  = response_code
 
           return result
         else
-
-          @logger.error( "#{__method__} #{method_type.upcase} on #{endpoint} failed: HTTP #{response.code} - #{response_body}" )
-          @logger.error( @headers )
-          @logger.error( JSON.pretty_generate( response_headers ) )
+          logger.error( "#{__method__} #{method_type.upcase} on #{endpoint} failed: HTTP #{response.code} - #{response_body}" )
+          logger.error( headers )
+          logger.error( JSON.pretty_generate( response_headers ) )
 
           return JSON.parse( response_body )
         end
 
       rescue RestClient::BadRequest
-
         response_body = JSON.parse(response_body) if response_body.is_a?(String)
-
-        return {
-          'status' => 400,
-          'message' => response_body.dig('message').nil? ? 'Bad Request' : response_body.dig('message')
-        }
-
+        return { 'status' => 400, 'message' => response_body.dig('message').nil? ? 'Bad Request' : response_body.dig('message') }
       rescue RestClient::Unauthorized
-
-        return {
-          'status' => 401,
-          'message' => format('Not authorized to connect \'%s/%s\' - wrong username or password?', @url, endpoint)
-        }
-
+        return { 'status' => 401, 'message' => format('Not authorized to connect \'%s/%s\' - wrong username or password?', @url, endpoint) }
+      rescue RestClient::Forbidden
+        return { 'status' => 403, 'message' => format('The operation is forbidden \'%s/%s\'', @url, endpoint) }
       rescue RestClient::NotFound
-
-        return {
-          'status' => 404,
-          'message' => 'Not Found'
-        }
-
+        return { 'status' => 404, 'message' => 'Not Found' }
       rescue RestClient::Conflict
-
-        return {
-          'status' => 409,
-          'message' => 'Conflict with the current state of the target resource'
-        }
-
+        return { 'status' => 409, 'message' => 'Conflict with the current state of the target resource' }
       rescue RestClient::PreconditionFailed
-
-        return {
-          'status' => 412,
-          'message' => 'Precondition failed. The Object probably already exists.'
-        }
-
-      rescue RestClient::ExceptionWithResponse => e
-
-        logger.error( "Error: #{__method__} #{method_type.upcase} on #{endpoint} error: '#{e}'" )
-        logger.error( data )
-        logger.error( @headers )
-        logger.error( JSON.pretty_generate( response_headers ) )
-
-        return false
-
+        return { 'status' => 412, 'message' => 'Precondition failed. The Object probably already exists.' }
+      rescue RestClient::PreconditionFailed
+        return { 'status' => 412, 'message' => 'Precondition failed. The Object probably already exists.' }
+      rescue RestClient::ExceptionWithResponse => error
+        #logger.error( "Error: (RestClient::ExceptionWithResponse) #{__method__} #{method_type.upcase} on #{endpoint} error: '#{error}'" )
+        #logger.error( "query: #{data}" )
+        return { 'status' => 500, 'message' => "Internal Server Error: #{error}" }
+      rescue => error
+        #logger.error( "Error: #{__method__} #{method_type.upcase} on #{endpoint} error: '#{error}'" )
+        #logger.error( "query: #{data}" )
+        return { 'status' => 500, 'message' => "Internal Server Error: #{error}" }
       end
-
     end
-
   end
-
 end

data/lib/grafana/organization.rb

@@ -6,9 +6,11 @@ module Grafana
   module Organization
 
     # Get current Organisation
-    # GET /api/org
     #
-    #  -> {"id"=>1, "name"=>"Docker", "address"=>{"address1"=>"", "address2"=>"", "city"=>"", "zipCode"=>"", "state"=>"", "country"=>""}, "status"=>200}
+    # @example
+    #    current_organization
+    #
+    # @return [Hash]
     #
     def current_organization
       endpoint = '/api/org'
@@ -17,25 +19,40 @@ module Grafana
     end
 
     # Update current Organisation
-    # PUT /api/org
     #
+    # @param [Hash] params
+    # @option params [String] name new Organisation Name
+    #
+    # @example
+    #    params = {
+    #       name: 'foo'
+    #    }
+    #    update_current_organization( params )
     #
+    # @return [Hash]
     #
-    def update_current_organization( params = {} )
+    def update_current_organization( params )
 
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
-      name = params.dig(:name)
-      raise ArgumentError.new('missing name') if( name.nil? )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      name         = validate( params, required: true, var: 'name', type: String )
 
       endpoint = '/api/org'
+      payload = {
+        name: name
+      }
+
       @logger.debug("Updating current organization (PUT #{endpoint})") if @debug
-      put(endpoint, params.to_json)
+      put(endpoint, payload.to_json)
     end
 
     # Get all users within the actual organisation
-    # GET /api/org/users
     #
+    # @example
+    #    current_organization_users
     #
+    # @return [Hash]
     #
     def current_organization_users
       endpoint = '/api/org/users'
@@ -44,46 +61,60 @@ module Grafana
     end
 
     # Add a new user to the actual organisation
-    # POST /api/org/users
     #
+    # @param [Hash] params
+    # @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
+    #
+    # @example
+    #    params = {
+    #       login_or_email: 'foo',
+    #       role: 'Editor'
+    #    }
+    #    add_user_to_current_organization( params )
     #
+    # @return [Hash]
     #
-    def add_user_to_current_organization( params = {} )
+    def add_user_to_current_organization( params )
 
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
-      login_or_email = params.dig(:loginOrEmail)
-      role           = params.dig(:role)
-      raise ArgumentError.new('missing loginOrEmail') if( login_or_email.nil? )
-      raise ArgumentError.new('missing role') if( role.nil? )
-      # Defaults to Viewer, other valid options are Admin and Editor and Read Only Editor
-      # valid_perms = ['Viewer','Editor','Read Only Editor','Admin']
-      raise ArgumentError.new( format( 'wrong role. only \'Admin\', \'Viewer\' or \'Editor\' allowed (\'%s\' giving)',role)) if( %w[Admin Viewer Editor].include?(role) == false )
-
-      org = current_organization_users
-      usr = user_by_name( login_or_email )
-
-      if( org )
-
-        org = org.dig('message')
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-        if( org.select { |x| x.dig('email') == login_or_email }.count >= 1 )
-          return {
-            'status' => 404,
-            'message' => format('User \'%s\' are already in the organisation', login_or_email)
-          }
-        end
-      end
+      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']
 
-      if( usr.nil? || usr.dig('status').to_i != 200 )
+      # 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('User \'%s\' not found', login_or_email)
+          '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
 
+      org = current_organization_users
+      usr = user( login_or_email )
+
+      return { 'status' => 404, 'message' => format('User \'%s\' not found', login_or_email) } if( usr.nil? || usr.dig('status').to_i != 200 )
+
+      if( org.is_a?(Hash) && org.dig('status').to_i == 200 )
+        org = org.dig('message')
+        return { 'status' => 404, 'message' => format('User \'%s\' are already in the organisation', login_or_email) } \
+          if( org.select { |x| x.dig('email') == login_or_email || x.dig('login') == login_or_email }.count >= 1 )
+      end
+
       endpoint = '/api/org/users'
+      payload = {
+        loginOrEmail: login_or_email,
+        role: role
+      }
+
       @logger.debug("Adding user to current organization (POST #{endpoint})") if @debug
-      post(endpoint, params.to_json)
+      post(endpoint, payload.to_json)
     end
 
     # Updates the given user

data/lib/grafana/organizations.rb

@@ -13,7 +13,6 @@ module Grafana
       get( endpoint )
     end
 
-
     # Get a single data sources by Id or Name
     #
     # @example
@@ -24,39 +23,20 @@ module Grafana
     #
     def organization( organisation_id )
 
-      raise ArgumentError.new(format('wrong type. user \'organisation_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', organisation_id.class.to_s)) if( organisation_id.is_a?(String) && organisation_id.is_a?(Integer) )
+      if( organisation_id.is_a?(String) && organisation_id.is_a?(Integer))
+        raise ArgumentError.new(format('wrong type. \'organisation_id\' must be an String (for an Datasource name) ' \
+                                       'or an Integer (for an Datasource Id), given \'%s\'', organisation_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'organisation_id\'') if( organisation_id.size.zero? )
 
       endpoint = format( '/api/orgs/%d', organisation_id ) if(organisation_id.is_a?(Integer))
-      endpoint = format( '/api/orgs/name/%s', URI.escape( organisation_id ) ) if(organisation_id.is_a?(String))
+      endpoint = format( '/api/orgs/name/%s', ERB::Util.url_encode( organisation_id ) ) if(organisation_id.is_a?(String))
 
       @logger.debug("Attempting to get existing data source Id #{organisation_id} (GET #{endpoint})") if  @debug
 
       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 +58,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 +84,35 @@ 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? )
+      if( organization_id.is_a?(String) && organization_id.is_a?(Integer))
+        raise ArgumentError.new(format('wrong type. \'organization_id\' must be an String (for an Organisation name) '\
+                                       'or an Integer (for an Organisation Id), given \'%s\'', organization_id.class.to_s))
+      end
+      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 +124,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 ) )
-
-        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 )
+      data   = validate_organisation_user( params )
+      status = data.dig('status')
 
-      if( org.nil? || org.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('Organization \'%s\' not found', organization)
-        }
-      end
+      return data if( status.nil? || status.to_i == 404 )
 
-      if( usr.nil? || usr.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('User \'%s\' not found', login_or_email)
-        }
-      end
+      org = data.dig('organisation')
+      usr = data.dig('user')
 
-      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 +150,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 +167,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? )
-
-      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 ) )
-
-        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 )
+      data   = validate_organisation_user( params )
+      status = data.dig('status')
 
-      if( org.nil? || org.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('Organization \'%s\' not found', organization)
-        }
-      end
+      return data if( status.nil? || status.to_i == 404 )
 
-      if( usr.nil? || usr.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('User \'%s\' not found', login_or_email)
-        }
-      end
+      org = data.dig('organisation')
+      usr = data.dig('user')
 
-      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 +205,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 +214,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 )
-
-      if( org.nil? || org.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('Organization \'%s\' not found', organization)
-        }
-      end
+      usr = user( login_or_email )
 
-      if( usr.nil? || usr.dig('status').to_i != 200 )
-        return {
-          'status' => 404,
-          'message' => format('User \'%s\' not found', login_or_email)
-        }
-      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 )
 
-      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 +230,10 @@ module Grafana
 
     # Create Organisation
     #
-    # @param
+    # @param [Hash] params
     # @option params [String] organization Organisation name
     #
-    # @examle
+    # @example
     #    params = {
     #      name: 'Foo'
     #    }
@@ -345,15 +247,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 = {
@@ -376,31 +272,79 @@ module Grafana
     #
     def delete_organisation( organisation_id )
 
-      raise ArgumentError.new(format('wrong type. user \'organisation_id\' must be an String (for an Datasource name) or an Integer (for an Datasource Id), given \'%s\'', organisation_id.class.to_s)) if( organisation_id.is_a?(String) && organisation_id.is_a?(Integer) )
+      if( organisation_id.is_a?(String) && organisation_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'organisation_id\' must be an String (for an Organisation name) ' \
+                                       'or an Integer (for an Organisation Id), given \'%s\'', organisation_id.class.to_s))
+      end
       raise ArgumentError.new('missing \'organisation_id\'') if( organisation_id.size.zero? )
 
       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 { |_,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