Add better error/debug message when none explicitly set for API reque…

…st (refs #76)

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file is used to list changes made in each version of grafana.
 
+## dev:
+
+* Ensure we're displaying better messages in some edge cases with HTTP requests [#76](https://github.com/JonathanTron/chef-grafana/issues/76)
+
 ## 2.1.0 (2015-08-17):
 
 * Update Grafana default version to 2.1.1

libraries/api_helper.rb

@@ -21,6 +21,7 @@ def login(host, port, user, password)
       end
 
       handle_response(
+        request,
         response,
         success: 'Login was successful.',
         unauthorized: 'Invalid username/password.',
@@ -50,14 +51,26 @@ def with_limited_retry(opts, &block)
       end
     end
 
+    # Format a request for use in error/debug message
+    # Params:
+    # +request+:: Net::HTTPRequest
+    def request_message(request)
+      "#{request.method} #{request.path}"
+    end
+
     # Log the right thing when
     # Params:
+    # +request+:: Net::HTTPRequest
     # +response+:: Net::HTTPResponse -
     # +messages+:: String or  -
-    def handle_response(response, messages)
+    def handle_response(request, response, messages)
       case response
       when Net::HTTPSuccess
-        Chef::Log.debug messages[:success]
+        if messages[:success].nil?
+          Chef::Log.debug "Request succeeded when sending #{request_message request}"
+        else
+          Chef::Log.debug messages[:success]
+        end
       when Net::HTTPUnauthorized
         if messages[:unauthorized].nil?
           Chef::Log.error 'Invalid grafana_user and grafana_sess.'
@@ -66,12 +79,20 @@ def handle_response(response, messages)
         end
         raise BackendError
       when Net::HTTPNotFound
-        Chef::Log.error messages[:not_found]
+        if messages[:not_found].nil?
+          Chef::Log.error "Endpoint not found when sending #{request_message request}"
+        else
+          Chef::Log.error messages[:not_found]
+        end
       when nil
         Chef::Log.error 'Connection refused.'
         raise BackendError
       else
-        Chef::Log.error(messages[:unknown_code] % { code: response.code })
+        if messages[:unknown_code].nil?
+          Chef::Log.error "Response code '#{response.code}' not handled when sending #{request_message request}"
+        else
+          Chef::Log.error(messages[:unknown_code] % { code: response.code })
+        end
         raise BackendError
       end
     end

libraries/dashboard_api.rb

@@ -16,6 +16,7 @@ def get_dashboard(dashboard_options, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'The dashboard has been successfully retrieved.',
         not_found: 'The dashboard does not exist.',
@@ -48,6 +49,7 @@ def create_dashboard(dashboard_options, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: "Dashboard (#{dashboard_options[:name]}) creation was successful.",
         unknown_code: 'DashboardApi::create_dashboard unchecked response code: %{code}'
@@ -69,6 +71,7 @@ def delete_dashboard(name, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'Dashboard deletion was successful.',
         unknown_code: 'DashboardApi::delete_dashboard unchecked response code: %{code}'

libraries/datasource_api.rb

@@ -29,6 +29,7 @@ def add_data_source(db_options, legacy_http_semantic, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'Datasource addition was successful.',
         unknown_code: 'DataSourceAPI::add_data_source unchecked response code: %{code}'
@@ -59,6 +60,7 @@ def update_data_source(db_options, legacy_http_semantic, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'Datasource update was successful.',
         unknown_code: 'DataSourceAPI::update_data_source unchecked response code: %{code}'
@@ -83,6 +85,7 @@ def delete_data_source(db_id, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'Datasource deletion was successful.',
         unknown_code: 'DataSourceAPI::delete_data_source unchecked response code: %{code}'
@@ -106,6 +109,7 @@ def get_data_source_list(grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'List of datasources have been successfully retrieved.',
         unknown_code: 'Error retrieving list of datasources.'

libraries/organization_api.rb

@@ -16,6 +16,7 @@ def add_org(name, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'Organization addition was successful.',
         unknown_code: 'OrganizationApi::add_org unchecked response code: %{code}'
@@ -40,6 +41,7 @@ def update_org(org_options, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'Organization update was successful.',
         unknown_code: 'OrganizationApi::update_org unchecked response code: %{code}'
@@ -63,6 +65,7 @@ def get_orgs_list(grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'The list of organizations has been successfully retrieved.',
         unknown_code: 'OrganizationApi::get_orgs_list unchecked response code: %{code}'

libraries/user_api.rb

@@ -16,6 +16,7 @@ def add_global_user(person, grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'The admin user has been successfully created.',
         unknown_code: 'UserApi::add_admin_user unchecked response code: %{code}'
@@ -40,6 +41,7 @@ def get_global_user_list(grafana_options)
       end
 
       handle_response(
+        request,
         response,
         success: 'The list of users has been successfully retrieved.',
         unknown_code: 'UserApi::get_admin_user_list unchecked response code: %{code}'