soaspec 0.2.28 → 0.2.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff6cda10e896b7bffe2e1af83020b86c9e180a802c03faa52758cb119f513cd4
-  data.tar.gz: 3cc64688800e7cac5c90602d05cb78262e24389259802883e07ceff03038cb9f
+  metadata.gz: 85321b628bfe9f5c96477fbbb8b630439332838b4552ce295c00486c94922461
+  data.tar.gz: 9de5454ec0b65ee3442e6f3772d0f61d09463f1ba78751edfb9e9394331aaafb
 SHA512:
-  metadata.gz: ea53235d5b99cf5bc148c31ce4bf2e41d6ffcacf9dc5124d3218fdef11c947cc968ae9af82bd4609a9d685b9b0103603f9b061cc4b8e05897209ce1d8d9da62f
-  data.tar.gz: 1d90c38a4bf0ebebfa460ac305ed13536c3162c8bb4ee8e482d4f75300aa4097c4bd662aed5eb1522517c608bc57a42e2a21a5ebdceb0005e53ef3e9f82f9ed3
+  metadata.gz: 4a6b6e8b16a9c432ea9b8b23e90ec64e9174d96504c2c49089d0a732ddefe6d9d6b67b258dc143887314cf767ff3bd822b4c7a12baebc38824f72947823d9152
+  data.tar.gz: d8cda71cffe34d1df8bae7fa0c701e6360009a70458e62eed88821cafd79ca25c47f6090f27821e4f1fc9c843741601e37ee3fa0e8c86ddcf73cc39680fe13ae

data/ChangeLog

@@ -1,3 +1,12 @@
+Version 0.2.29
+* Enhancement
+  * SpecLogger - change:
+    * Programe name
+    * Date and time format
+    * Accessor internal logger object
+    * Removed unnecessarily severity as it's always INFO
+  * For REST calls log Response under 1 log with headers and body indented on new lines
+
 Version 0.2.28
 * Enhancement
   * Ability to change OAuth2 retry limit as retrying too many times can cause a lock out

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -107,7 +107,7 @@ module Soaspec
       rescue RestClient::ExceptionWithResponse => e
         response = e.response
       end
-      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response}"])
+      Soaspec::SpecLogger.info("response: \n  headers: #{response&.headers}\n  body: #{response}\n")
       after_response(response, self)
       response
     end

data/lib/soaspec/o_auth2.rb

@@ -105,7 +105,7 @@ module Soaspec
       retry if retry_count < self.class.retry_limit
       raise error
     else
-      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response.body}"]) if debug_oauth?
+      Soaspec::SpecLogger.info(["response: \n  headers: #{response&.headers}\n  body: #{response}\n"]) if debug_oauth?
       JSON.parse(response)
     end
 

data/lib/soaspec/spec_logger.rb

@@ -27,6 +27,8 @@ module Soaspec
     @time_test_run = Time.now.strftime('%Y-%m-%d_%H_%M_%S')
     # By default file is based on time
     @traffic_file = nil
+    # Name of program to include in logs
+    @progname
     class << self
       # Folder to put API traffic logs
       attr_accessor :traffic_folder
@@ -34,8 +36,20 @@ module Soaspec
       attr_accessor :terminal_color
       # Readers for log parameters
       attr_reader :output_to_terminal, :output_to_file, :time_test_run
+      # @return [String] Name of program to include in logs
+      attr_accessor :progname
+      # @return [String] String representing date format to use for traffic
+      attr_writer :time_format
+      # Logger used to log API requests
+      attr_accessor :logger
+
+      # String representing date format to use for traffic
+      def time_format
+        @time_format || '%H:%M:%S'
+      end
 
       # Set file to log traffic to
+      # @param [String] file Path to traffic file to use
       def traffic_file=(file)
         @traffic_file = file
         reset_log
@@ -83,8 +97,9 @@ module Soaspec
       def create
         create_log_file
         @logger = ApiLogger.new(traffic_file) # Where request and responses of APIs are stored
-        @logger.formatter = proc do |severity, datetime, _progname, msg|
-          message = "SpecLog, [#{datetime.strftime('%Y-%m-%d_%H:%M:%S')}] #{severity} -- : #{msg}\n"
+        @logger.progname = progname || 'SpecLog'
+        @logger.formatter = proc do |_severity, datetime, progname, msg|
+          message = "#{progname}, [#{datetime.strftime(time_format)}] : #{msg}\n"
           print message.colorize(terminal_color) if @output_to_terminal
           message if @output_to_file
         end
@@ -94,17 +109,21 @@ module Soaspec
 
       # Log a message using Soaspec logger
       # Logger (and it's file) will be created if it's not already set
-      # @param [String] message The message to add to the logger
+      # @param [String, Array] message The message to add to the logger or list of messages
       def info(message)
         return unless log_api_traffic?
 
         create unless @logger
         if message.respond_to? :each
           message.each do |message_item|
-            @logger.info(message_item)
+            info(message_item)
           end
         else
-          @logger.info(message)
+          if block_given?
+            @logger.info(message) { yield }
+          else
+            @logger.info(message)
+          end
         end
       end
 

data/lib/soaspec/version.rb

@@ -1,4 +1,4 @@
 module Soaspec
   # @return [String] Version of the gem
-  VERSION = '0.2.28'.freeze
+  VERSION = '0.2.29'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.28
+  version: 0.2.29
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler