spectre-core 1.8.4 → 1.12.0

data/lib/spectre/http.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 require 'net/http'
 require 'openssl'
 require 'json'
@@ -5,7 +7,6 @@ require 'securerandom'
 require 'logger'
 require 'ostruct'
 
-
 module Spectre
   module Http
     DEFAULT_HTTP_CONFIG = {
@@ -19,11 +20,16 @@ module Spectre
       'headers' => nil,
       'query' => nil,
       'content_type' => '',
-    }
+    }.freeze
 
     @@modules = []
 
     class SpectreHttpRequest < Spectre::DslClass
+      class Headers
+        CONTENT_TYPE = 'Content-Type'
+        UNIQUE_HEADERS = [CONTENT_TYPE].freeze
+      end
+
       def initialize request
         @__req = request
       end
@@ -40,30 +46,34 @@ module Spectre
         @__req['path'] = url_path
       end
 
+      def timeout seconds
+        @__req['timeout'] = seconds
+      end
+
       def header name, value
-        @__req['headers'] = [] if not @__req['headers']
+        @__req['headers'] ||= []
         @__req['headers'].append [name, value.to_s.strip]
       end
 
       def param name, value
-        @__req['query'] = [] if not @__req['query']
+        @__req['query'] ||= []
         @__req['query'].append [name, value.to_s.strip]
       end
 
       def content_type media_type
-        @__req['headers'] = [] if not @__req['headers']
-        @__req['headers'].append ['Content-Type', media_type]
+        @__req['content_type'] = media_type
       end
 
       def json data
         data = data.to_h if data.is_a? OpenStruct
         body JSON.pretty_generate(data)
-        content_type 'application/json'
+
+        # TODO: Only set content type, if not explicitly set
+        content_type('application/json')
       end
 
       def body body_content
-        raise 'Body value must be a string' if not body_content.is_a? String
-        @__req['body'] = body_content
+        @__req['body'] = body_content.to_s
       end
 
       def ensure_success!
@@ -78,9 +88,12 @@ module Spectre
         @__req['auth'] = method
       end
 
+      def no_auth!
+        @__req['auth'] = 'none'
+      end
+
       def certificate path
         @__req['cert'] = path
-        use_ssl!
       end
 
       def use_ssl!
@@ -102,6 +115,8 @@ module Spectre
       end
 
       def [] key
+        return nil unless @headers.key?(key.downcase)
+
         @headers[key.downcase].first
       end
 
@@ -111,52 +126,30 @@ module Spectre
     end
 
     class SpectreHttpResponse
-      def initialize res
-        @res = res
-        @data = nil
-        @headers = SpectreHttpHeader.new @res[:headers]
-      end
-
-      def code
-        @res[:code]
-      end
+      attr_reader :code, :message, :headers, :body
 
-      def message
-        @res[:message]
-      end
-
-      def headers
-        @headers
-      end
-
-      def body
-        @res[:body]
+      def initialize net_res
+        @code = net_res.code.to_i
+        @message = net_res.message
+        @body = net_res.body
+        @headers = SpectreHttpHeader.new(net_res.to_hash)
+        @json_data = nil
       end
 
       def json
-        return nil if not @res[:body]
-
-        if @data == nil
+        if !@body.nil? and @json_data.nil?
           begin
-            @data = JSON.parse(@res[:body], object_class: OpenStruct)
-          rescue
-            raise "Body content is not a valid JSON:\n#{@res[:body]}"
+            @json_data = JSON.parse(@body, object_class: OpenStruct)
+          rescue JSON::ParserError
+            raise "Body content is not a valid JSON:\n#{@body}"
           end
         end
 
-        @data
+        @json_data
       end
 
       def success?
-        @res[:code] < 400
-      end
-
-      def to_s
-        @res.to_s
-      end
-
-      def pretty
-        @res.pretty
+        @code < 400
       end
     end
 
@@ -166,40 +159,44 @@ module Spectre
       @@response = nil
       @@request = nil
       @@modules = []
+      @@secure_keys = []
 
       def https name, &block
         http(name, secure: true, &block)
       end
 
-      def http name, secure: nil, &block
+      def http name, secure: false, &block
         req = {}
 
         if @@http_cfg.key? name
-          req.merge! @@http_cfg[name]
-          raise "No `base_url' set for HTTP client '#{name}'. Check your HTTP config in your environment." if !req['base_url']
+          req.deep_merge! @@http_cfg[name].deep_clone
+          raise "No `base_url' set for HTTP client '#{name}'. Check your HTTP config in your environment." unless req['base_url']
         else
           req['base_url'] = name
         end
 
-        req['user_ssl'] = secure if secure != nil
+        req['use_ssl'] = secure unless secure.nil?
 
-        SpectreHttpRequest.new(req).instance_eval(&block) if block_given?
+        SpectreHttpRequest.new(req)._evaluate(&block) if block_given?
 
         invoke(req)
       end
 
       def request
         raise 'No request has been invoked yet' unless @@request
+
         @@request
       end
 
       def response
         raise 'There is no response. No request has been invoked yet.' unless @@response
+
         @@response
       end
 
       def register mod
         raise 'Module must not be nil' unless mod
+
         @@modules << mod
       end
 
@@ -209,7 +206,8 @@ module Spectre
         return str unless str or str.empty?
 
         begin
-          json = JSON.parse str
+          json = JSON.parse(str)
+          json.obfuscate!(@@secure_keys) unless @@debug
 
           if pretty
             str = JSON.pretty_generate(json)
@@ -223,39 +221,55 @@ module Spectre
         str
       end
 
+      def secure? key
+        @@secure_keys.any? { |x| key.to_s.downcase.include? x.downcase }
+      end
+
+      def header_to_s headers
+        s = ''
+        headers.each_header.each do |header, value|
+          value = '*****' if secure?(header) and not @@debug
+          s += "#{header.to_s.ljust(30, '.')}: #{value.to_s}\n"
+        end
+        s
+      end
+
       def invoke req
         @@request = nil
 
-        if req['cert'] or req['use_ssl']
-          scheme = 'https'
-        else
-          scheme = 'http'
-        end
+        # Build URI
 
+        scheme = req['use_ssl'] ? 'https' : 'http'
         base_url = req['base_url']
 
-        if not base_url.match /http(?:s)?:\/\//
+        unless base_url.match /http(?:s)?:\/\//
           base_url = scheme + '://' + base_url
         end
 
         if req['path']
-          base_url = base_url + '/' if not base_url.end_with? '/'
+          base_url = base_url + '/' unless base_url.end_with? '/'
           base_url += req['path']
         end
 
         uri = URI(base_url)
 
-        raise "'#{uri}' is not a valid uri" if not uri.host
+        raise "'#{uri}' is not a valid uri" unless uri.host
+
+        # Build query parameters
 
         uri.query = URI.encode_www_form(req['query']) unless not req['query'] or req['query'].empty?
 
+        # Create HTTP client
+
         net_http = Net::HTTP.new(uri.host, uri.port)
+        net_http.read_timeout = req['timeout'] || 180
 
         if uri.scheme == 'https'
           net_http.use_ssl = true
 
           if req.key? 'cert'
             raise "Certificate '#{req['cert']}' does not exist" unless File.exists? req['cert']
+
             net_http.verify_mode = OpenSSL::SSL::VERIFY_PEER
             net_http.ca_file = req['cert']
           else
@@ -263,6 +277,8 @@ module Spectre
           end
         end
 
+        # Create HTTP Request
+
         net_req = Net::HTTPGenericRequest.new(req['method'], true, true, uri)
         net_req.body = req['body']
         net_req.content_type = req['content_type'] if req['content_type'] and not req['content_type'].empty?
@@ -275,28 +291,37 @@ module Spectre
 
         req_id = SecureRandom.uuid()[0..5]
 
+        # Run HTTP modules
+
+        @@modules.each do |mod|
+          mod.on_req(net_http, net_req, req) if mod.respond_to? :on_req
+        end
+
         # Log request
 
-        req_log = "[>] #{req_id} #{req['method']} #{uri}"
-        req['headers'].each do |header|
-          req_log += "\n#{header[0].to_s.ljust(30, '.')}: #{header[1].to_s}"
-        end if req['headers']
-        req_log += "\n" + try_format_json(req['body'], pretty: true) if req['body'] != nil and not req['body'].empty?
+        req_log = "[>] #{req_id} #{req['method']} #{uri}\n"
+        req_log += header_to_s(net_req)
+        req_log += try_format_json(req['body'], pretty: true) if req['body'] != nil and not req['body'].empty?
 
-        @@logger.info req_log
+        @@logger.info(req_log)
 
         # Request
 
         start_time = Time.now
 
-        @@modules.each do |mod|
-          mod.on_req(net_http, net_req, req) if mod.respond_to? :on_req
+        begin
+          net_res = net_http.request(net_req)
+        rescue SocketError => e
+          raise "The request '#{req['method']} #{uri}' failed. Please check if the given URL '#{uri}' is valid and available or a corresponding HTTP config in the environment file exists. See log for more details. Original.\nOriginal error was: #{e.message}"
         end
 
-        net_res = net_http.request(net_req)
-
         end_time = Time.now
 
+        req['started_at'] = start_time
+        req['finished_at'] = end_time
+
+        # Run HTTP modules
+
         @@modules.each do |mod|
           mod.on_res(net_http, net_res, req) if mod.respond_to? :on_res
         end
@@ -304,30 +329,26 @@ module Spectre
         # Log response
 
         res_log = "[<] #{req_id} #{net_res.code} #{net_res.message} (#{end_time - start_time}s)\n"
-        net_res.each_header do |header, value|
-          res_log += "#{header.to_s.ljust(30, '.')}: #{value}\n"
-        end
-        res_log += try_format_json(net_res.body, pretty: true) if net_res.body != nil and !net_res.body.empty?
+        res_log += header_to_s(net_res)
+        res_log += try_format_json(net_res.body, pretty: true) unless net_res.body.nil? or net_res.body.empty?
 
         @@logger.info(res_log)
 
-        if req['ensure_success']
-          code = Integer(net_res.code)
-          fail "Response code of #{req_id} did not indicate success: #{net_res.code} #{net_res.message}" if code >= 400
-        end
+        fail "Response code of #{req_id} did not indicate success: #{net_res.code} #{net_res.message}" if req['ensure_success'] and net_res.code.to_i >= 400
+
+        # Set global request and response variables
 
         @@request = OpenStruct.new(req)
-        @@response = SpectreHttpResponse.new({
-          code: net_res.code.to_i,
-          message: net_res.message,
-          headers: net_res.to_hash,
-          body: net_res.body
-        })
+        @@request.freeze
+
+        @@response = SpectreHttpResponse.new(net_res)
       end
     end
 
     Spectre.register do |config|
-      @@logger = ::Logger.new config['log_file'], progname: 'spectre/http'
+      @@logger = ::Logger.new(config['log_file'], progname: 'spectre/http')
+      @@secure_keys = config['secure_keys'] || []
+      @@debug = config['debug']
 
       if config.key? 'http'
         @@http_cfg = {}
@@ -340,4 +361,4 @@ module Spectre
 
     Spectre.delegate :http, :https, :request, :response, to: self
   end
-end
+end

data/lib/spectre/logger/console.rb

@@ -1,142 +1,143 @@
-require 'ectoplasm'
-
-module Spectre
-  module Logger
-    class Console
-      def initialize config
-        raise 'No log format section in config for console logger' unless config.key? 'log_format' and config['log_format'].key? 'console'
-
-        @config = config['log_format']['console']
-        @indent = @config['indent'] || 2
-        @width = @config['width'] || 80
-        @fmt_end_context = @config['end_context']
-        @fmt_sep = @config['separator']
-        @fmt_start_group = @config['start_group']
-        @fmt_end_group = @config['end_group']
-
-        @process = nil
-        @level = 0
-      end
-
-      def start_subject subject
-        puts subject.desc.blue
-      end
-
-      def start_context context
-        return unless context.__desc
-        puts (' ' * indent) + context.__desc.magenta
-        @level += 1
-      end
-
-      def end_context context
-        return unless context.__desc
-        @level -= 1
-        puts (' ' * indent) + @fmt_end_context.gsub('<desc>', context.__desc).magenta if @fmt_end_context
-      end
-
-      def start_spec spec, data=nil
-        text = spec.desc
-        text += " with #{data}" if data
-        puts (' ' * indent) + text.cyan
-
-        @level += 1
-      end
-
-      def end_spec spec, data
-        @level -= 1
-      end
-
-      def log_separator desc
-        if desc
-          desc = @fmt_sep.gsub('<indent>', ' ' * indent).gsub('<desc>', desc) if @fmt_sep
-          puts desc.blue
-        else
-          puts
-        end
-      end
-
-      def start_group desc
-        desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
-        puts (' ' * indent) + desc.blue
-        @level += 1
-      end
-
-      def end_group desc
-        if desc and @fmt_start_group
-          desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
-          puts (' ' * indent) + desc.blue
-        end
-
-        @level -= 1
-      end
-
-      def log_process desc
-        print_line(desc)
-        @process = desc
-        @level += 1
-      end
-
-      def log_status desc, status, annotation=nil
-        status = status.green if status == Status::OK
-        status = status.blue if status == Status::INFO
-        status = status.grey if status == Status::DEBUG
-        status = status.red if status == Status::FAILED
-        status = status.red if status == Status::ERROR
-        status = status.grey if status == Status::SKIPPED
-
-        txt = status
-        txt += ' ' + annotation if annotation
-
-        @level -= 1
-
-        if @process
-          puts txt
-        else
-          print_line('', status)
-        end
-
-        @process = nil
-      end
-
-      def log_info message
-        print_line(message, Status::INFO.blue)
-      end
-
-      def log_debug message
-        print_line(message, Status::DEBUG.grey)
-      end
-
-      def log_error spec, exception
-        txt = (Status::ERROR + ' - ' + exception.class.name).red
-        print_line('', txt)
-      end
-
-      def log_skipped spec
-        print_line('', Status::SKIPPED.grey)
-      end
-
-      private
-
-      def indent
-        (@level+1) * @indent
-      end
-
-      def print_line text='', status=nil
-        puts if @process
-
-        ind = indent
-        line = (' ' * indent) + text
-        remaining = @width - text.length - ind
-        line += '.' * (@width - text.length - ind) if remaining > 0
-
-        print line
-
-        if status
-          puts status
-          @process = nil
-        end
-      end
-
-    end
-  end
-end
+require 'ectoplasm'
+
+module Spectre
+  module Logger
+    class Console
+      def initialize config
+        raise 'No log format section in config for console logger' unless config.key? 'log_format' and config['log_format'].key? 'console'
+
+        @config = config['log_format']['console']
+        @indent = @config['indent'] || 2
+        @width = @config['width'] || 80
+        @fmt_end_context = @config['end_context']
+        @fmt_sep = @config['separator']
+        @fmt_start_group = @config['start_group']
+        @fmt_end_group = @config['end_group']
+
+        @process = nil
+        @level = 0
+      end
+
+      def start_subject subject
+        puts subject.desc.blue
+      end
+
+      def start_context context
+        return unless context.__desc
+
+        puts (' ' * indent) + context.__desc.magenta
+        @level += 1
+      end
+
+      def end_context context
+        return unless context.__desc
+
+        @level -= 1
+        puts (' ' * indent) + @fmt_end_context.gsub('<desc>', context.__desc).magenta if @fmt_end_context
+      end
+
+      def start_spec spec, data=nil
+        text = spec.desc
+        text += " with #{data}" if data
+        puts (' ' * indent) + text.cyan
+
+        @level += 1
+      end
+
+      def end_spec _spec, _data
+        @level -= 1
+      end
+
+      def log_separator desc
+        if desc
+          desc = @fmt_sep.gsub('<indent>', ' ' * indent).gsub('<desc>', desc) if @fmt_sep
+          puts desc.blue
+        else
+          puts
+        end
+      end
+
+      def start_group desc
+        desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
+        puts (' ' * indent) + desc.blue
+        @level += 1
+      end
+
+      def end_group desc
+        if desc and @fmt_start_group
+          desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
+          puts (' ' * indent) + desc.blue
+        end
+
+        @level -= 1
+      end
+
+      def log_process desc
+        print_line(desc)
+        @process = desc
+        @level += 1
+      end
+
+      def log_status _desc, status, annotation=nil
+        status = status.green if status == Status::OK
+        status = status.blue if status == Status::INFO
+        status = status.grey if status == Status::DEBUG
+        status = status.red if status == Status::FAILED
+        status = status.red if status == Status::ERROR
+        status = status.grey if status == Status::SKIPPED
+
+        txt = status
+        txt += ' ' + annotation if annotation
+
+        @level -= 1
+
+        if @process
+          puts txt
+        else
+          print_line('', status)
+        end
+
+        @process = nil
+      end
+
+      def log_info message
+        print_line(message, Status::INFO.blue)
+      end
+
+      def log_debug message
+        print_line(message, Status::DEBUG.grey)
+      end
+
+      def log_error _spec, exception
+        txt = (Status::ERROR + ' - ' + exception.class.name).red
+        print_line('', txt)
+      end
+
+      def log_skipped _spec
+        print_line('', Status::SKIPPED.grey)
+      end
+
+      private
+
+      def indent
+        (@level+1) * @indent
+      end
+
+      def print_line text='', status=nil
+        puts if @process
+
+        ind = indent
+        line = (' ' * indent) + text
+        remaining = @width - text.length - ind
+        line += '.' * (@width - text.length - ind) if remaining > 0
+
+        print line
+
+        if status
+          puts status
+          @process = nil
+        end
+      end
+    end
+  end
+end

data/lib/spectre/logger/file.rb

@@ -93,4 +93,4 @@ module Spectre
       end
     end
   end
-end
+end