Add Verbose option

This change turns off request and response logging by default and allows
users to turn that back on by setting a new `verbose` option to true.

Author: bhornseth

CHANGELOG

@@ -2,6 +2,8 @@ v1.7.0
  - Drop support for ruby 2.7
  - Add support for ruby 3.2+
  - Require minimum version of faraday 2.0
+ - Disabled request/response logging by default. Old behavior can be restored
+   by setting a new `verbose` configuration option to true
 
 v1.6.3
  - Add support for sending end user ip address in request headers

lib/spark_api/configuration.rb

@@ -9,9 +9,9 @@ module Configuration
     end
 
     # valid configuration options
-    VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, 
-      :user_agent, :version, :ssl, :ssl_verify, :oauth2_provider, :authentication_mode, 
-      :auth_endpoint, :callback, :compress, :timeout, :middleware, :dictionary_version, :request_id_chain, :user_ip_address].freeze
+    VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint,
+      :user_agent, :version, :ssl, :ssl_verify, :oauth2_provider, :authentication_mode,
+      :auth_endpoint, :callback, :compress, :timeout, :middleware, :dictionary_version, :request_id_chain, :user_ip_address, :verbose].freeze
     OAUTH2_KEYS = [:authorization_uri, :access_uri, :client_id, :client_secret,
       # Requirements for authorization_code grant type
       :redirect_uri,  
@@ -47,6 +47,7 @@ module Configuration
     DEFAULT_DICTIONARY_VERSION = nil
     DEFAULT_REQUEST_ID_CHAIN = nil
     DEFAULT_USER_IP_ADDRESS = nil
+    DEFAULT_VERBOSE = false
 
     X_SPARK_API_USER_AGENT = "X-SparkApi-User-Agent"
     X_USER_IP_ADDRESS = "X-User-IP-Address"
@@ -85,6 +86,7 @@ def reset_configuration
       self.dictionary_version = DEFAULT_DICTIONARY_VERSION
       self.request_id_chain = DEFAULT_REQUEST_ID_CHAIN
       self.user_ip_address = DEFAULT_USER_IP_ADDRESS
+      self.verbose = DEFAULT_VERBOSE
       self
     end
   end

lib/spark_api/connection.rb

@@ -40,7 +40,9 @@ def connection(force_ssl = false)
         conn.options[:timeout] = self.timeout
         conn.adapter Faraday.default_adapter
       end
-      SparkApi.logger.debug { "Connection: #{conn.inspect}" }
+      if self.verbose
+        SparkApi.logger.debug { "Connection: #{conn.inspect}" }
+      end
       conn
     end
 

lib/spark_api/faraday_middleware.rb

@@ -18,7 +18,9 @@ def on_complete(env)
       env[:body] = decompress_body(env)
 
       body = MultiJson.decode(env[:body])
-      SparkApi.logger.debug{ "Response Body: #{body.inspect}" }
+      if SparkApi.verbose
+        SparkApi.logger.debug{ "Response Body: #{body.inspect}" }
+      end
       unless body.is_a?(Hash) && body.key?("D")
         raise InvalidResponse, "The server response could not be understood"
       end

lib/spark_api/request.rb

@@ -93,7 +93,9 @@ def request(method, path, body, options)
           response = authenticator.request(method, request_path, nil, request_opts)
         else
           post_data = process_request_body(body)
-          SparkApi.logger.debug { "#{method.to_s.upcase} Data:   #{post_data}" }
+          if self.verbose
+            SparkApi.logger.debug { "#{method.to_s.upcase} Data:   #{post_data}" }
+          end
           response = authenticator.request(method, request_path, post_data, request_opts)
         end
         request_time = Time.now - start_time

spec/unit/spark_api/configuration_spec.rb

@@ -16,6 +16,7 @@
       expect(SparkApi.request_id_chain).to be_nil
       expect(SparkApi.user_ip_address).to be_nil
       expect(SparkApi.middleware).to eq('spark_api')
+      expect(SparkApi.verbose).to be false
     end
   end
 
@@ -28,7 +29,8 @@
                                     :endpoint => "http://api.wade.dev.fbsdata.com",
                                     :timeout => 15,
                                     :request_id_chain => 'foobar',
-                                    :user_ip_address => 'barfoo')
+                                    :user_ip_address => 'barfoo',
+                                    :verbose => true)
 
       expect(client.api_key).to match("key_of_wade")
       expect(client.api_secret).to match("TopSecret")
@@ -39,6 +41,7 @@
       expect(client.timeout).to eq(15)
       expect(client.request_id_chain).to eq('foobar')
       expect(client.user_ip_address).to eq('barfoo')
+      expect(client.verbose).to be true
     end
 
     it "should allow unverified ssl certificates when verification is off" do
@@ -101,6 +104,7 @@
         config.endpoint = "test.api.sparkapi.com"
         config.user_agent = "my useragent"
         config.timeout = 15
+        config.verbose = true
       end
 
       expect(SparkApi.api_key).to match("my_key")
@@ -111,6 +115,7 @@
       expect(SparkApi.user_agent).to match("my useragent")
       expect(SparkApi.oauth2_enabled?()).to be false
       expect(SparkApi.timeout).to eq(15)
+      expect(SparkApi.verbose).to be true
     end
 
     it "should correctly set up the client for oauth2" do