spectre-core 1.9.0 → 1.12.1

data/lib/spectre/curl.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 require 'open3'
 require 'ostruct'
 
@@ -21,17 +23,17 @@ module Spectre::Curl
     end
 
     def header name, value
-      @__req['headers'] = [] if not @__req['headers']
+      @__req['headers'] = [] unless @__req['headers']
       @__req['headers'].append [name, value.to_s.strip]
     end
 
     def param name, value
-      @__req['query'] = [] if not @__req['query']
+      @__req['query'] = [] unless @__req['query']
       @__req['query'].append [name, value.to_s.strip]
     end
 
     def content_type media_type
-      @__req['headers'] = [] if not @__req['headers']
+      @__req['headers'] = [] unless @__req['headers']
       @__req['headers'].append ['Content-Type', media_type]
     end
 
@@ -111,7 +113,7 @@ module Spectre::Curl
     end
 
     def json
-      return nil if not @res[:body]
+      return nil unless @res[:body]
 
       if @data == nil
         begin
@@ -161,28 +163,31 @@ module Spectre::Curl
 
       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']
+        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
 
-      SpectreHttpRequest.new(req).instance_eval(&block) if block_given?
+      SpectreHttpRequest.new(req)._evaluate(&block) if block_given?
 
       invoke(req)
     end
 
     def curl_request
       raise 'No request has been invoked yet' unless @@request
+
       @@request
     end
 
     def curl_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
 
@@ -192,7 +197,8 @@ module Spectre::Curl
       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)
@@ -206,6 +212,25 @@ module Spectre::Curl
       str
     end
 
+    def secure? key
+      @@secure_keys.any? { |x| key.to_s.downcase.include? x.downcase }
+    end
+
+    def header_to_s headers
+      s = ''
+
+      return s unless headers
+
+      headers.each do |header|
+        key = header[0].to_s
+        value = header[1].to_s
+        value = '*****' if secure?(key) and not @@debug
+        s += "#{key.ljust(30, '.')}: #{value}\n"
+      end
+
+      s
+    end
+
     def invoke req
       cmd = [@@curl_path]
 
@@ -217,12 +242,12 @@ module Spectre::Curl
 
       uri = req['base_url']
 
-      if not uri.match /http(?:s)?:\/\//
+      unless uri.match /http(?:s)?:\/\//
         uri = scheme + '://' + uri
       end
 
       if req['path']
-        uri += '/' if !uri.end_with? '/'
+        uri += '/' unless uri.end_with? '/'
         uri += req['path']
       end
 
@@ -230,11 +255,11 @@ module Spectre::Curl
         uri += '?'
         uri += req['query']
           .map { |x| x.join '='}
-          .join '&'
+          .join('&')
       end
 
-      cmd.append '"' + uri + '"'
-      cmd.append '-X', req['method'] unless req['method'] == 'GET' or (req['body'] and req['method'] == 'POST')
+      cmd.append('"' + uri + '"')
+      cmd.append('-X', req['method']) unless req['method'] == 'GET' or (req['body'] and req['method'] == 'POST')
 
       # Call all registered modules
       @@modules.each do |mod|
@@ -243,43 +268,42 @@ module Spectre::Curl
 
       # Add headers to curl command
       req['headers'].each do |header|
-        cmd.append '-H', '"' + header.join(':') + '"'
+        cmd.append('-H', '"' + header.join(':') + '"')
       end if req['headers']
 
       # Add request body
       if req['body'] != nil and not req['body'].empty?
         req_body = try_format_json(req['body']).gsub(/"/, '\\"')
-        cmd.append '-d', '"' + req_body + '"'
+        cmd.append('-d', '"' + req_body + '"')
       elsif ['POST', 'PUT', 'PATCH'].include? req['method'].upcase
-        cmd.append '-d', '"\n"'
+        cmd.append('-d', '"\n"')
       end
 
       # Add certificate path if one if given
       if req['cert']
         raise "Certificate '#{req['cert']}' does not exist" unless File.exists? req['cert']
-        cmd.append '--cacert', req['cert']
+
+        cmd.append('--cacert', req['cert'])
       elsif req['use_ssl'] or uri.start_with? 'https'
-        cmd.append '-k'
+        cmd.append('-k')
       end
 
-      cmd.append '-i'
-      cmd.append '-v'
+      cmd.append('-i')
+      cmd.append('-v')
 
-      @@request = OpenStruct.new req
+      @@request = OpenStruct.new(req)
 
-      sys_cmd = cmd.join ' '
+      sys_cmd = cmd.join(' ')
 
-      @@logger.debug sys_cmd
+      @@logger.debug(sys_cmd)
 
       req_id = SecureRandom.uuid()[0..5]
 
       req_log = "[>] #{req_id} #{req['method']} #{uri}\n"
-      req['headers'].each do |header|
-        req_log += "#{header[0].to_s.ljust(30, '.')}: #{header[1].to_s}\n"
-      end if req['headers']
-      req_log += req['body'] if req['body'] != nil and not req['body'].empty?
+      req_log += header_to_s(req['headers'])
+      req_log += try_format_json(req['body'], pretty: true)
 
-      @@logger.info req_log
+      @@logger.info(req_log)
 
       start_time = Time.now
 
@@ -295,9 +319,9 @@ module Spectre::Curl
 
       # debug_log.lines.each { |x| @@logger.debug x unless x.empty? }
 
-      raise "Unable to request #{uri}. Please check if this service is reachable." unless output
+      raise "Unable to request #{uri}. Please check if this URL is correctly configured and reachable." unless output
 
-      @@logger.debug "[<] #{req_id} stdout:\n#{output}"
+      @@logger.debug("[<] #{req_id} stdout:\n#{output}")
 
       header, body = output.split /\r?\n\r?\n/
 
@@ -323,7 +347,7 @@ module Spectre::Curl
         code: match[:code].to_i,
         message: match[:message],
         headers: Hash[res_headers],
-        body: body
+        body: body,
       }
 
       # Call all registered modules
@@ -342,7 +366,7 @@ module Spectre::Curl
 
       @@logger.info res_log
 
-      @@response = SpectreHttpResponse.new res
+      @@response = SpectreHttpResponse.new(res)
 
       raise "Response did not indicate success: #{@@response.code} #{@@response.message}" if req['ensure_success'] and not @@response.success?
 
@@ -351,7 +375,12 @@ module Spectre::Curl
   end
 
   Spectre.register do |config|
-    @@logger = ::Logger.new config['log_file'], progname: 'spectre/curl'
+    @@debug = config['debug']
+
+    @@logger = ::Logger.new(config['log_file'], progname: 'spectre/curl')
+    @@logger.level = @@debug ? Logger::DEBUG : Logger::INFO
+
+    @@secure_keys = config['secure_keys'] || []
 
     @@curl_path = config['curl_path'] || 'curl'
 
@@ -365,4 +394,4 @@ module Spectre::Curl
   end
 
   Spectre.delegate :curl, :curl_response, :curl_request, to: self
-end
+end

data/lib/spectre/diagnostic.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 module Spectre
   module Diagnostic
     module Stopwatch
@@ -21,9 +23,17 @@ module Spectre
         def duration
           @@end_time - @@start_time
         end
+
+        def started_at
+          @@start_time
+        end
+
+        def finished_at
+          @@end_time
+        end
       end
 
-      Spectre.delegate :start_watch, :stop_watch, :duration, :measure, to: Stopwatch
+      Spectre.delegate :start_watch, :stop_watch, :duration, :measure, to: self
     end
   end
-end
+end

data/lib/spectre/environment.rb

@@ -1,9 +1,13 @@
+require_relative '../spectre'
+
 require 'ostruct'
 
 def to_recursive_ostruct(hash)
-  OpenStruct.new(hash.each_with_object({}) do |(key, val), memo|
-    memo[key] = val.is_a?(Hash) ? to_recursive_ostruct(val) : val
-  end)
+  OpenStruct.new(
+    hash.each_with_object({}) do |(key, val), memo|
+      memo[key] = val.is_a?(Hash) ? to_recursive_ostruct(val) : val
+    end
+  )
 end
 
 module Spectre
@@ -21,6 +25,6 @@ module Spectre
       @@environment.freeze
     end
 
-    Spectre.delegate :env, to: Environment
+    Spectre.delegate :env, to: self
   end
-end
+end

data/lib/spectre/helpers.rb

@@ -1,7 +1,10 @@
+require_relative '../spectre'
+
 require 'securerandom'
 require 'json'
 require 'date'
 require 'ostruct'
+require 'jsonpath'
 
 class ::String
   def as_json
@@ -12,15 +15,8 @@ class ::String
     DateTime.parse(self)
   end
 
-  def content with: nil
-    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
-    file_content = File.read(self)
-
-    if with
-      file_content.with(with)
-    else
-      file_content
-    end
+  def as_timestamp
+    DateTime.parse(self).to_time.to_i
   end
 
   def with mapping
@@ -29,46 +25,109 @@ class ::String
     new_string = self
 
     mapping.each do |key, value|
-      new_string = new_string.gsub '#{' + key.to_s + '}', value.to_s
+      new_string = new_string.gsub('#{' + key.to_s + '}', value.to_s)
     end
 
     new_string
   end
 
-  def exists?
-    File.exists? self
+  def trim size = 50
+    if (self.length + 3) > size
+      return self[0..size-4] + '...'
+    end
+
+    self
   end
 
-  def remove!
-    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
+  def pick path
+    raise ArgumentError.new("`path' must not be nil or empty") if path.nil? or path.empty?
 
-    File.delete self
+    begin
+      JsonPath.on(self, path)
+    rescue MultiJson::ParseError
+      # do nothing and return nil
+    end
   end
 
-  def trim count = 50
-    if (self.length + 3) > count
-      return self[0..count-4] + '...'
+  # File helpers
+
+  def content with: nil
+    fail "'#{self}' is not a file path, or the file does not exist." unless File.exists? self
+
+    file_content = File.read(self)
+
+    if with
+      file_content.with(with)
+    else
+      file_content
     end
+  end
 
-    self
+  def file_size
+    fail "'#{self}' is not a file path, or the file does not exist." unless File.exists? self
+
+    File.size(self)
   end
-end
 
+  def exists?
+    File.exists? self
+  end
+
+  def remove!
+    fail "'#{self}' is not a file path, or the file does not exist." unless File.exists? self
+
+    File.delete self
+  end
+end
 
 class ::OpenStruct
   def to_json *args, **kwargs
     self.to_h.inject({}) { |memo, (k,v)| memo[k] = v.is_a?(OpenStruct) ? v.to_h : v; memo }.to_json(*args, **kwargs)
   end
-end
 
+  def pick path
+    raise ArgumentError.new("`path' must not be nil or empty") if path.nil? or path.empty?
+
+    JsonPath.on(self, path)
+  end
+
+  def default_to! defaults
+    defaults.each_key do |key|
+      unless self[key] != nil
+        self[key] = defaults[key]
+      end
+    end
+  end
+
+  alias :defaults_to! :default_to!
+end
 
 class ::Hash
   def symbolize_keys
     self.inject({}) { |memo, (k,v)| memo[k.to_sym] = v; memo }
   end
+
+  def default_to! defaults
+    defaults.each_key do |key|
+      unless self[key] != nil
+        self[key] = defaults[key]
+      end
+    end
+  end
+
+  alias :defaults_to! :default_to!
 end
 
+class ::Array
+  def last_element
+    self[-1]
+  end
+end
 
 def uuid length = 5
   SecureRandom.uuid().gsub('-', '')[0..length-1]
-end
+end
+
+def now
+  Time.now
+end

data/lib/spectre/http/basic_auth.rb

@@ -1,7 +1,9 @@
+require_relative '../http'
+
 module Spectre::Http
   class SpectreHttpRequest
     def basic_auth username, password
-      @__req['basic_auth'] = {} if not @__req.key? 'basic_auth'
+      @__req['basic_auth'] = {} unless @__req.key? 'basic_auth'
 
       @__req['basic_auth']['username'] = username
       @__req['basic_auth']['password'] = password
@@ -11,8 +13,9 @@ module Spectre::Http
   end
 
   module BasicAuth
-    def self.on_req http, net_req, req
+    def self.on_req _http, net_req, req
       return unless req.key? 'basic_auth' and req['auth'] == 'basic_auth'
+
       basic_auth_cfg = req['basic_auth']
       net_req.basic_auth(basic_auth_cfg['username'], basic_auth_cfg['password'])
     end

data/lib/spectre/http/keystone.rb

@@ -1,98 +1,101 @@
-class HttpRequest
-  def keystone url, username, password, project, domain, cert
-    @__req['keystone'] = {} if not @__req.key? 'keystone'
-
-    @__req['keystone']['url'] = url
-    @__req['keystone']['username'] = username
-    @__req['keystone']['password'] = password
-    @__req['keystone']['project'] = project
-    @__req['keystone']['domain'] = domain
-    @__req['keystone']['cert'] = cert
-
-    @__req.config['auth'] = 'keystone'
+require_relative '../http'
+
+module Spectre::Http
+  class SpectreHttpRequest
+    def keystone url, username, password, project, domain, cert=nil
+      @__req['keystone'] = {} unless @__req.key? 'keystone'
+
+      @__req['keystone']['url'] = url
+      @__req['keystone']['username'] = username
+      @__req['keystone']['password'] = password
+      @__req['keystone']['project'] = project
+      @__req['keystone']['domain'] = domain
+      @__req['keystone']['cert'] = cert
+
+      @__req['auth'] = 'keystone'
+    end
   end
-end
 
+  module Keystone
+    @@cache = {}
 
-module Spectre::Http::Keystone
-  @@cache = {}
+    def self.on_req _http, net_req, req
+      return unless req.key? 'keystone' and req['auth'] == 'keystone'
 
-  def self.on_req http, net_req, req
-    return unless req.key? 'keystone' and req['auth'] == 'keystone'
+      keystone_cfg = req['keystone']
 
-    keystone_cfg = req['keystone']
+      if @@cache.key? keystone_cfg
+        token = @@cache[keystone_cfg]
+      else
+        token, _ = authenticate(
+          keystone_cfg['url'],
+          keystone_cfg['username'],
+          keystone_cfg['password'],
+          keystone_cfg['project'],
+          keystone_cfg['domain'],
+          keystone_cfg['cert'],
+        )
 
-    if @@cache.key? keystone_cfg
-      token = @@cache[keystone_cfg]
-    else
-      token, _ = authenticate(
-        keystone_cfg['url'],
-        keystone_cfg['username'],
-        keystone_cfg['password'],
-        keystone_cfg['project'],
-        keystone_cfg['domain'],
-        keystone_cfg['cert'],
-      )
+        @@cache[keystone_cfg] = token
+      end
 
-      @@cache[keystone_cfg] = token
+      net_req['X-Auth-Token'] = token
     end
 
-    net_req['X-Auth-Token'] = token
-  end
-
-  private
-
-  def self.authenticate keystone_url, username, password, project, domain, cert
-    auth_data = {
-      auth: {
-        identity: {
-          methods: ['password'],
-          password: {
-            user: {
-              name: username,
-              password: password,
-              domain: {
-                name: domain,
+    private
+
+    def self.authenticate keystone_url, username, password, project, domain, cert
+      auth_data = {
+        auth: {
+          identity: {
+            methods: ['password'],
+            password: {
+              user: {
+                name: username,
+                password: password,
+                domain: {
+                  name: domain,
+                },
               },
             },
           },
-        },
-        scope: {
-          project: {
-            name: project,
-            domain: {
-              name: domain,
+          scope: {
+            project: {
+              name: project,
+              domain: {
+                name: domain,
+              },
             },
           },
         },
-      },
-    }
+      }
 
-    keystone_url = keystone_url + '/' if !keystone_url.end_with? '/'
+      keystone_url = keystone_url + '/' unless keystone_url.end_with? '/'
 
-    base_uri = URI(keystone_url)
-    uri = URI.join(base_uri, 'auth/tokens?nocatalog=true')
+      base_uri = URI(keystone_url)
+      uri = URI.join(base_uri, 'auth/tokens?nocatalog=true')
 
-    http = Net::HTTP.new(base_uri.host, base_uri.port)
+      http = Net::HTTP.new(base_uri.host, base_uri.port)
 
-    if cert
-      http.use_ssl = true
-      http.ca_file = cert
-    end
+      if cert
+        http.use_ssl = true
+        http.ca_file = cert
+      end
 
-    req = Net::HTTP::Post.new(uri)
-    req.body = JSON.pretty_generate(auth_data)
-    req.content_type = 'application/json'
+      req = Net::HTTP::Post.new(uri)
+      req.body = JSON.pretty_generate(auth_data)
+      req.content_type = 'application/json'
 
-    res = http.request(req)
+      res = http.request(req)
 
-    raise "error while authenticating: #{res.code} #{res.message}\n#{res.body}" if res.code != '201'
+      raise "error while authenticating: #{res.code} #{res.message}\n#{res.body}" if res.code != '201'
 
-    [
-      res['X-Subject-Token'],
-      JSON.parse(res.body),
-    ]
-  end
+      [
+        res['X-Subject-Token'],
+        JSON.parse(res.body),
+      ]
+    end
 
-  Spectre::Http.register(self)
+    Spectre::Http.register(self)
+  end
 end