spectre-core 1.8.0

data/lib/spectre/diagnostic.rb

@@ -0,0 +1,29 @@
+module Spectre
+  module Diagnostic
+    module Stopwatch
+      @@duration = 0.0
+
+      class << self
+        def start_watch
+          @@start_time = Time.now
+        end
+
+        def stop_watch
+          @@end_time = Time.now
+        end
+
+        def measure
+          start_watch
+          yield
+          stop_watch
+        end
+
+        def duration
+          @@end_time - @@start_time
+        end
+      end
+
+      Spectre.delegate :start_watch, :stop_watch, :duration, :measure, to: Stopwatch
+    end
+  end
+end

data/lib/spectre/environment.rb

@@ -0,0 +1,26 @@
+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)
+end
+
+module Spectre
+  module Environment
+    class << self
+      @@environment = OpenStruct.new
+
+      def env
+        @@environment
+      end
+    end
+
+    Spectre.register do |config|
+      @@environment = to_recursive_ostruct(config)
+      @@environment.freeze
+    end
+
+    Spectre.delegate :env, to: Environment
+  end
+end

data/lib/spectre/ftp.rb

@@ -0,0 +1,195 @@
+require 'net/ftp'
+require 'net/sftp'
+require 'logger'
+require 'json'
+
+
+module Spectre
+  module FTP
+    @@cfg = {}
+
+    class FTPConnection < DslClass
+      def initialize host, username, password, opts, logger
+        @__logger = logger
+        @__session = nil
+
+        @__host = host
+        @__username = username
+        @__password = password
+        @__opts = opts
+      end
+
+      def connect!
+        return unless @__session == nil or @__session.closed?
+        @__logger.info "Connecting to '#{@__host}' with user '#{@__username}'"
+        @__session = Net::FTP.new(@__host, @__opts)
+        @__session.login @__username, @__password
+      end
+
+      def close
+        return unless @__session and not @__session.closed?
+        @__session.close
+      end
+
+      def can_connect?
+        begin
+          connect!
+          return true
+        rescue
+          return false
+        end
+      end
+
+      def download remotefile, to: File.basename(remotefile)
+        connect!
+        @__logger.info "Downloading '#{@__username}@#{@__host}:#{File.join @__session.pwd, remotefile}' to '#{File.expand_path to}'"
+        @__session.getbinaryfile(remotefile, to)
+      end
+
+      def upload localfile, to: File.basename(localfile)
+        connect!
+        @__logger.info "Uploading '#{File.expand_path localfile}' to '#{@__username}@#{@__host}:#{File.join @__session.pwd, to}'"
+        @__session.putbinaryfile(localfile, to)
+      end
+
+      def list
+        connect!
+        file_list = @__session.list
+        @__logger.info "Listing file in #{@__session.pwd}\n#{file_list}"
+        file_list
+      end
+    end
+
+
+    class SFTPConnection < DslClass
+      def initialize host, username, opts, logger
+        opts[:non_interactive] = true
+
+        @__logger = logger
+        @__session = nil
+        @__host = host
+        @__username = username
+        @__opts = opts
+      end
+
+      def connect!
+        return unless @__session == nil or @__session.closed?
+        @__logger.info "Connecting to '#{@__host}' with user '#{@__username}'"
+        @__session = Net::SFTP.start(@__host, @__username, @__opts)
+        @__session.connect!
+      end
+
+      def close
+        return unless @__session and not @__session.closed?
+        # @__session.close!
+      end
+
+      def can_connect?
+        begin
+          connect!
+          return true
+        rescue
+          return false
+        end
+      end
+
+      def download remotefile, to: File.basename(remotefile)
+        @__logger.info "Downloading '#{@__username}@#{@__host}:#{remotefile}' to '#{File.expand_path to}'"
+        connect!
+        @__session.download!(remotefile, to)
+      end
+
+      def upload localfile, to: File.basename(localfile)
+        @__logger.info "Uploading '#{File.expand_path localfile}' to '#{@__username}@#{@__host}:#{to}'"
+        connect!
+        @__session.upload!(localfile, to)
+      end
+
+      def stat path
+        connect!
+        file_info = @__session.stat! path
+        @__logger.info "Stat '#{path}'\n#{JSON.pretty_generate file_info.attributes}"
+        file_info.attributes
+      end
+
+      def exists path
+        begin
+          file_info = @__session.stat! path
+
+        rescue Net::SFTP::StatusException => e
+          return false if e.description == 'no such file'
+          raise e
+        end
+
+        return true
+      end
+    end
+
+
+    class << self
+      def ftp name, config={}, &block
+        raise "FTP connection '#{name}' not configured" unless @@cfg.has_key?(name) or config.count > 0
+        cfg = @@cfg[name] || {}
+
+        host = config[:host] || cfg['host'] || name
+        username = config[:username] || cfg['username']
+        password = config[:password] || cfg['password']
+
+        opts = {}
+        opts[:ssl] = config[:ssl]
+        opts[:port] = config[:port] || cfg['port'] || 21
+
+        @@logger.info "Connecting to #{host} with user #{username}"
+
+        ftp_conn = FTPConnection.new(host, username, password, opts, @@logger)
+
+        begin
+          ftp_conn.instance_eval &block
+        ensure
+          ftp_conn.close
+        end
+      end
+
+      def sftp name, config={}, &block
+        raise "FTP connection '#{name}' not configured" unless @@cfg.has_key?(name) or config.count > 0
+
+        cfg = @@cfg[name] || {}
+
+        host = config[:host] || cfg['host'] || name
+        username = config[:username] || cfg['username']
+        password = config[:password] || cfg['password']
+
+        opts = {}
+        opts[:password] = password
+        opts[:port] = config[:port] || cfg['port'] || 22
+        opts[:keys] = [cfg['key']] if cfg.has_key? 'key'
+        opts[:passphrase] = cfg['passphrase'] if cfg.has_key? 'passphrase'
+
+        opts[:auth_methods] = []
+        opts[:auth_methods].push 'publickey' if opts[:keys]
+        opts[:auth_methods].push 'password' if opts[:password]
+
+        sftp_con = SFTPConnection.new(host, username, opts, @@logger)
+
+        begin
+          sftp_con.instance_eval &block
+        ensure
+          sftp_con.close
+        end
+      end
+    end
+
+    Spectre.register do |config|
+      @@logger = ::Logger.new config['log_file'], progname: 'spectre/ftp'
+
+      if config.has_key? 'ftp'
+
+        config['ftp'].each do |name, cfg|
+          @@cfg[name] = cfg
+        end
+      end
+    end
+
+    Spectre.delegate :ftp, :sftp, to: self
+  end
+end

data/lib/spectre/helpers.rb

@@ -0,0 +1,64 @@
+require 'securerandom'
+require 'json'
+require 'date'
+require 'ostruct'
+
+class ::String
+  def as_json
+    JSON.parse(self, object_class: OpenStruct)
+  end
+
+  def as_date
+    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
+      with.each do |key, value|
+        file_content = file_content.gsub '#{' + key.to_s + '}', value.to_s
+      end
+    end
+
+    file_content
+  end
+
+  def exists?
+    File.exists? self
+  end
+
+  def remove!
+    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
+
+    File.delete self
+  end
+
+  def trim count=50
+    if (self.length + 3) > count
+      return self[0..count] + '...'
+    end
+
+    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
+
+
+class ::Hash
+  def symbolize_keys
+    self.inject({}) { |memo, (k,v)| memo[k.to_sym] = v; memo }
+  end
+end
+
+
+def uuid length = 5
+  SecureRandom.uuid().gsub('-', '')[0..length]
+end

data/lib/spectre/http.rb

@@ -0,0 +1,343 @@
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'securerandom'
+require 'logger'
+require 'ostruct'
+
+
+module Spectre
+  module Http
+    DEFAULT_HTTP_CONFIG = {
+      'method' => 'GET',
+      'path' => '',
+      'host' => nil,
+      'port' => 80,
+      'scheme' => 'http',
+      'use_ssl' => false,
+      'cert' => nil,
+      'headers' => nil,
+      'query' => nil,
+      'content_type' => '',
+    }
+
+    @@modules = []
+
+    class SpectreHttpRequest < Spectre::DslClass
+      def initialize request
+        @__req = request
+      end
+
+      def method method_name
+        @__req['method'] = method_name.upcase
+      end
+
+      def url base_url
+        @__req['base_url'] = base_url
+      end
+
+      def path url_path
+        @__req['path'] = url_path
+      end
+
+      def header name, value
+        @__req['headers'] = [] if not @__req['headers']
+        @__req['headers'].append [name, value.to_s.strip]
+      end
+
+      def param name, value
+        @__req['query'] = [] if not @__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]
+      end
+
+      def json data
+        data = data.to_h if data.is_a? OpenStruct
+        body JSON.pretty_generate(data)
+        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
+      end
+
+      def ensure_success!
+        @__req['ensure_success'] = true
+      end
+
+      def ensure_success?
+        @__req['ensure_success']
+      end
+
+      def authenticate method
+        @__req['auth'] = method
+      end
+
+      def certificate path
+        @__req['cert'] = path
+        use_ssl!
+      end
+
+      def use_ssl!
+        @__req['use_ssl'] = true
+      end
+
+      def to_s
+        @__req.to_s
+      end
+
+      alias_method :auth, :authenticate
+      alias_method :cert, :certificate
+      alias_method :media_type, :content_type
+    end
+
+    class SpectreHttpHeader
+      def initialize headers
+        @headers = headers || {}
+      end
+
+      def [] key
+        @headers[key.downcase].first
+      end
+
+      def to_s
+        @headers.to_s
+      end
+    end
+
+    class SpectreHttpResponse
+      def initialize res
+        @res = res
+        @data = nil
+        @headers = SpectreHttpHeader.new @res[:headers]
+      end
+
+      def code
+        @res[:code]
+      end
+
+      def message
+        @res[:message]
+      end
+
+      def headers
+        @headers
+      end
+
+      def body
+        @res[:body]
+      end
+
+      def json
+        return nil if not @res[:body]
+
+        if @data == nil
+          begin
+            @data = JSON.parse(@res[:body], object_class: OpenStruct)
+          rescue
+            raise "Body content is not a valid JSON:\n#{@res[:body]}"
+          end
+        end
+
+        @data
+      end
+
+      def success?
+        @res[:code] < 400
+      end
+
+      def to_s
+        @res.to_s
+      end
+
+      def pretty
+        @res.pretty
+      end
+    end
+
+
+    class << self
+      @@http_cfg = {}
+      @@response = nil
+      @@request = nil
+      @@modules = []
+
+      def https name, &block
+        http(name, secure: true, &block)
+      end
+
+      def http name, secure: nil, &block
+        req = {}
+
+        if @@http_cfg.has_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']
+        else
+          req['base_url'] = name
+        end
+
+        req['user_ssl'] = secure if secure != nil
+
+        SpectreHttpRequest.new(req).instance_eval(&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
+
+      private
+
+      def try_format_json str, pretty: false
+        return str unless str or str.empty?
+
+        begin
+          json = JSON.parse str
+
+          if pretty
+            str = JSON.pretty_generate(json)
+          else
+            str = JSON.dump(json)
+          end
+        rescue
+          # do nothing
+        end
+
+        str
+      end
+
+      def invoke req
+        @@request = nil
+
+        if req['cert'] or req['use_ssl']
+          scheme = 'https'
+        else
+          scheme = 'http'
+        end
+
+        base_url = req['base_url']
+
+        if not 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 += req['path']
+        end
+
+        uri = URI(base_url)
+
+        raise "'#{uri}' is not a valid uri" if not uri.host
+
+        uri.query = URI.encode_www_form(req['query']) unless not req['query'] or req['query'].empty?
+
+        net_http = Net::HTTP.new(uri.host, uri.port)
+
+        if uri.scheme == 'https'
+          net_http.use_ssl = true
+
+          if req.has_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
+            net_http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+        end
+
+        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?
+
+        if req['headers']
+          req['headers'].each do |header|
+            net_req[header[0]] = header[1]
+          end
+        end
+
+        req_id = SecureRandom.uuid()[0..5]
+
+        # 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?
+
+        @@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
+        end
+
+        net_res = net_http.request(net_req)
+
+        end_time = Time.now
+
+        @@modules.each do |mod|
+          mod.on_res(net_http, net_res, req) if mod.respond_to? :on_res
+        end
+
+        # 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?
+
+        @@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
+
+        @@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
+        })
+      end
+    end
+
+    Spectre.register do |config|
+      @@logger = ::Logger.new config['log_file'], progname: 'spectre/http'
+
+      if config.has_key? 'http'
+        @@http_cfg = {}
+
+        config['http'].each do |name, cfg|
+          @@http_cfg[name] = cfg
+        end
+      end
+    end
+
+    Spectre.delegate :http, :https, :request, :response, to: self
+  end
+end