http_event_logger 0.1.0.rc1

data/spec/http_event_logger_integration_spec.rb

@@ -0,0 +1,151 @@
+describe HttpEventLogger do
+
+  let(:host) { "localhost" }
+  let(:port) { 9292 }
+  let(:path) { "/index.html" }
+  let(:data) { "foo=bar&bar=foo" }
+
+  DRIVERS = [
+    HttpEventLogger::Test::Driver::Ethon,
+    HttpEventLogger::Test::Driver::Excon,
+    HttpEventLogger::Test::Driver::Faraday,
+    HttpEventLogger::Test::Driver::HTTParty,
+    HttpEventLogger::Test::Driver::HTTPClient,
+    HttpEventLogger::Test::Driver::NetHTTP,
+    HttpEventLogger::Test::Driver::OpenUri,
+    HttpEventLogger::Test::Driver::Patron,
+    HttpEventLogger::Test::Driver::Typhoeus
+  ].freeze
+
+  DRIVERS.each do |driver_class|
+
+    connection_event_supported = !driver_class.is_libcurl?
+
+    context "when #{driver_class.library_name} is in use" do
+
+      let(:driver_class)               { driver_class }
+      let(:connection_event_supported) { connection_event_supported }
+      let(:expected_response_type)     { driver_class.expected_response_type }
+      let(:driver)                     { driver_class.new(host, port, path) }
+
+      context "and the defaults are configured" do
+
+        it "logs GET requests" do
+          res = driver.send_get_request
+
+          expect(log).to include_message("Connected") if connection_event_supported
+
+          expect(log).to include_message("Sent - GET http://#{host}:#{port}#{path}")
+          expect(log).to include_message("Sent - Headers:")
+          expect(log).to_not include_message("Sent - Body:")
+
+          expect(log).to include_message("Benchmark:")
+          expect(log).to include_message("Received - Status: 200")
+          expect(log).to include_message("Received - Headers:")
+          expect(log).to include_message("Received - Body:#{driver_class.expected_response_body}")
+
+          expect(res).to be_a(expected_response_type) if expected_response_type
+        end if driver_class.method_defined?(:send_get_request)
+
+        it "logs POST requests" do
+          res = driver.send_post_request
+
+          expect(log).to include_message("Connected") if connection_event_supported
+
+          expect(log).to include_message("Sent - POST http://#{host}:#{port}#{path}")
+          expect(log).to include_message("Sent - Headers:")
+          expect(log).to include_message("Sent - Body: #{data}")
+
+          expect(log).to include_message("Benchmark:")
+          expect(log).to include_message("Received - Status: 200")
+          expect(log).to include_message("Received - Headers:")
+          expect(log).to include_message("Received - Body:#{driver_class.expected_response_body}")
+
+          expect(res).to be_a(expected_response_type) if expected_response_type
+        end if driver_class.method_defined?(:send_post_request)
+
+      end
+
+      context "and the default logger is configured with a custom log level" do
+
+        before(:example) { configure(HttpEventLogger::Logger.new(logger: @logger, severity: ::Logger::Severity::INFO)) }
+
+        it "logs at the configured level" do
+          driver.send_get_request
+
+          expect(log).to include("INFO")
+        end
+
+      end
+
+      context "and the default logger is configured with a uri blacklist pattern" do
+
+        before(:example) do
+          configure(HttpEventLogger::Logger.new(logger: @logger, blacklist_pattern: blacklist_pattern))
+        end
+
+        context "and a request is made matching the pattern" do
+
+          let(:blacklist_pattern) { /localhost/ }
+
+          it "should not log anything" do
+            driver.send_get_request
+
+            expect(log).to be_empty
+          end
+
+        end
+
+        context "and a request is made that does not match the pattern" do
+
+          let(:blacklist_pattern) { /does_not_match/ }
+
+          it "logs all events" do
+            driver.send_get_request
+
+            expect(log).to include_message("Sent")
+            expect(log).to include_message("Benchmark")
+            expect(log).to include_message("Received")
+          end
+
+        end
+
+      end
+
+      context "and a custom logger is configured" do
+
+        before(:example) { configure(HttpEventLogger::Test::CustomLogger.new(@logger)) }
+
+        it "logs connection events" do
+          driver.send_get_request
+
+          expect(log).to include("Custom - Connected: #{host}:#{port}")
+        end if connection_event_supported
+
+        it "logs request events" do
+          driver.send_get_request
+
+          expect(log).to include("Custom - Sent: Request Event")
+        end
+
+        it "logs repsonse events" do
+          driver.send_get_request
+
+          expect(log).to include("Custom - Received: Response Event")
+        end
+
+      end
+
+    end
+
+  end
+  
+  def include_message(message)
+    include("[#{host}:#{port}] #{message}")
+  end
+
+  def configure(logger)
+    HttpEventLogger.configuration.logger = logger
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'bundler'
+Bundler.require(:development)
+
+SimpleCov.start do
+  coverage_dir "tmp/coverage"
+
+  add_filter "/spec/"
+
+  refuse_coverage_drop
+end if ENV["coverage"]
+
+require 'stringio'
+
+require_relative '../lib/http_event_logger'
+
+require_relative 'support/driver/base'
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }
+
+# Server for test endpoints
+@server_thread = Thread.new { Rack::Handler::Thin.run(HttpEventLogger::Test::Server.new, Port: 9292) }
+sleep(1) # Wait for server
+
+RSpec.configure do |config|
+
+  config.before(:example) do
+    @log    = StringIO.new
+    @logger = ::Logger.new(@log)
+
+    HttpEventLogger.configure { |config| config.logger = HttpEventLogger::Logger.new(logger: @logger) }
+  end
+
+  def log
+    @log.string
+  end
+
+end

data/spec/support/custom_logger.rb

@@ -0,0 +1,25 @@
+module HttpEventLogger
+  module Test
+
+    class CustomLogger < HttpEventLogger::Logger
+
+      def initialize(logger)
+        super(logger: logger)
+      end
+
+      def connected(connection)
+        log "Custom - Connected: #{connection.uri}"
+      end
+
+      def sent(request)
+        log "Custom - Sent: Request Event"
+      end
+
+      def received(response)
+        log "Custom - Received: Response Event"
+      end
+
+    end
+
+  end
+end

data/spec/support/driver/base.rb

@@ -0,0 +1,48 @@
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class Base
+
+        class << self
+
+          def library_name
+            self.name.demodulize
+          end
+
+          def is_libcurl?
+            false
+          end
+
+          def expected_response_type
+            nil
+          end
+
+          def expected_response_body
+            "\n<html>"
+          end
+
+        end
+
+        def initialize(host, port, path, protocol="http")
+          @host     = host
+          @port     = port
+          @path     = path
+          @protocol = protocol
+          @headers  = { "accept" => "*/*", "foo" => "bar" }
+          @data     = "foo=bar&bar=foo"
+          @params   = { "foo" => 'bar', "bar" => "foo" }
+        end
+
+        def uri
+          "#{@protocol}://#{@host}:#{@port}#{@path}"
+        end
+
+        def send_post_form_request
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/ethon.rb

@@ -0,0 +1,29 @@
+require 'ethon'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class Ethon < HttpEventLogger::Test::Driver::Base
+
+        def self.is_libcurl?
+          true
+        end
+
+        def send_get_request
+          easy = ::Ethon::Easy.new
+          easy.http_request(uri, :get, { headers: @headers })
+          easy.perform
+        end
+
+        def send_post_request
+          easy = ::Ethon::Easy.new
+          easy.http_request(uri, :post, { headers: @headers, body: @data })
+          easy.perform
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/excon.rb

@@ -0,0 +1,21 @@
+require 'excon'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class Excon < HttpEventLogger::Test::Driver::Base
+
+        def send_get_request
+          ::Excon.get(uri, headers: @headers )
+        end
+
+        def send_post_request
+          ::Excon.post(uri, body: @data, headers: @headers)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/faraday.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class Faraday < HttpEventLogger::Test::Driver::Base
+
+        def send_get_request
+          connection.get do |req|
+            req.url(uri)
+            req.headers = @headers
+          end
+        end
+
+        def send_post_request
+          connection.post do |req|
+            req.url(uri)
+            req.headers = @headers
+            req.body    = @data
+          end
+        end
+
+        private
+
+        def connection
+          ::Faraday.new(url: "#{@protocol}://#{@host}:#{@port}") do |faraday|
+            faraday.adapter(::Faraday.default_adapter) # Uses Net::HTTP
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/httparty.rb

@@ -0,0 +1,21 @@
+require 'httparty'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class HTTParty < HttpEventLogger::Test::Driver::Base
+
+        def send_get_request
+          ::HTTParty.get(uri, headers: @headers)
+        end
+
+        def send_post_request
+          ::HTTParty.post(uri, body: @data, headers: @headers)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/httpclient.rb

@@ -0,0 +1,29 @@
+require 'httpclient'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class HTTPClient < HttpEventLogger::Test::Driver::Base
+
+        def self.expected_response_type
+          HTTP::Message
+        end
+
+        def send_get_request
+          ::HTTPClient.get(uri, header: @headers)
+        end
+
+        def send_post_request
+          ::HTTPClient.post(uri, body: @data, header: @headers)
+        end
+
+        def send_post_form_request(params)
+          ::HTTPClient.post_content(uri, params, @headers)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/net_http.rb

@@ -0,0 +1,24 @@
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class NetHTTP < HttpEventLogger::Test::Driver::Base
+
+        def send_get_request
+          Net::HTTP.get_response(@host, "#{@path}?#{@data}", @port)
+        end
+
+        def send_post_request
+          http = Net::HTTP.new(@host, @port)
+          http.post(@path, @data)
+        end
+
+        def send_post_form_request
+          Net::HTTP.post_form(uri, @params)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/open_uri.rb

@@ -0,0 +1,19 @@
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class OpenUri < HttpEventLogger::Test::Driver::Base
+
+        def self.expected_response_body
+          "[not available]"
+        end
+
+        def send_get_request
+          open(uri)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/patron.rb

@@ -0,0 +1,27 @@
+require 'patron'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class Patron < HttpEventLogger::Test::Driver::Base
+
+        def self.is_libcurl?
+          true
+        end
+
+        def send_get_request
+          session = ::Patron::Session.new
+          session.get(uri, @headers)
+        end
+
+        def send_post_request
+          session = ::Patron::Session.new
+          session.post(uri, @data, @headers)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/driver/typhoeus.rb

@@ -0,0 +1,34 @@
+require 'typhoeus'
+
+module HttpEventLogger
+  module Test
+    module Driver
+
+      class Typhoeus < HttpEventLogger::Test::Driver::Base
+
+        class << self
+
+          def is_libcurl?
+            true
+          end
+
+          # Note: Last supported Typhoeus version is 0.5.3
+          def expected_response_body
+            ""
+          end
+
+        end
+
+        def send_get_request
+          ::Typhoeus.get(uri, headers: @headers)
+        end
+
+        def send_post_request
+          ::Typhoeus.post(uri, body: @data, headers: @headers)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/support/index.html

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Test Page</title>
+  </head>
+  <body>
+    <h1>This is the test page.</h1>
+  </body>
+</html>

data/spec/support/server.rb

@@ -0,0 +1,28 @@
+require 'rack'
+
+module HttpEventLogger
+  module Test
+
+    class Server
+
+      def call(env)
+        @root = File.expand_path(File.dirname(__FILE__))
+        path = Rack::Utils.unescape(env["PATH_INFO"])
+        path += "index.html" if path == "/"
+        file = @root + "#{path}"
+
+        params = Rack::Utils.parse_nested_query(env["QUERY_STRING"])
+
+        if params["redirect"]
+          [ 301, { "Location" => "/index.html" }, "" ]
+        elsif File.exists?(file)
+          [ 200, { "Content-Type" => "text/html" }, File.read(file) ]
+        else
+          [ 404, { "Content-Type" => "text/plain" }, "file not found" ]
+        end
+      end
+
+    end
+
+  end
+end