alovak-network 1.0.0 → 1.1.0

data/lib/network/connection.rb

@@ -4,7 +4,8 @@ module Network
 
     attr_accessor :read_timeout, :open_timeout, :headers, 
                   :verify_peer, :ca_file,
-                  :debugger_stream
+                  :debugger_stream,
+                  :logger, :request_filter, :response_filter, :sender
 
     READ_TIMEOUT = 60
     OPEN_TIMEOUT = 30 
@@ -22,6 +23,7 @@ module Network
 
     def post(data)
       begin
+        log_request(data)
         http.post(uri.path, data, post_headers(data))
       rescue Timeout::Error, Errno::ETIMEDOUT, Timeout::ExitException
         raise Error, "The connection to the remote server is timed out"
@@ -91,5 +93,22 @@ module Network
     def cert
       OpenSSL::X509::Certificate.new(pem)
     end
+
+    def log(message)
+      logger.info(message) if logger
+    end
+
+    def log_request(data)
+      log sender if sender
+      log "POST #{uri}"
+      log "--->"
+      log (request_filter ? request_filter.call(data) : data)
+    end
+
+    def log_response(data)
+      log "<---"
+      log (response_filter ? response_filter.call(data) : data)
+      log "----"
+    end
   end
 end

data/test/network/test_connection.rb

@@ -1,5 +1,57 @@
 require 'test_helper'
 
+class TestLogger
+  attr_reader :log
+
+  def method_missing(method, *args)
+    @log ||= ""
+    @log << "#{args.first}\n"
+  end
+end
+
+class TestConnectionLogging < Test::Unit::TestCase
+  def setup
+    @connection = Network::Connection.new("http://example.com/path")
+    @connection.logger = TestLogger.new
+  end
+
+  def test_log_request
+    @connection.send(:log_request, "request data")
+    log = @connection.logger.log
+
+    assert_match /POST http:\/\/example.com\/path/,  log
+    assert_match /--->/,                    log
+    assert_match /request data/,            log
+  end
+
+  def test_log_request_with_sender
+    @connection.sender = "ModuleName"
+    @connection.send(:log_request, "request data")
+    assert_match /ModuleName/, @connection.logger.log  
+  end
+
+  def test_log_response
+    @connection.send(:log_response, "response data")
+    log = @connection.logger.log
+
+    assert_match /<---/,                    log
+    assert_match /response data/,           log
+    assert_match /----/,                    log
+  end
+
+  def test_request_filtering
+    @connection.request_filter = Proc.new {|req| "#{req} is filtered"}
+    @connection.send(:log_request, "request")
+    assert_match /request is filtered/, @connection.logger.log
+  end
+
+  def test_response_filtering
+    @connection.response_filter = Proc.new {|req| "#{req} is filtered"}
+    @connection.send(:log_response, "response")
+    assert_match /response is filtered/, @connection.logger.log
+  end
+end
+
 class TestConnection < Test::Unit::TestCase
   def setup
     @connection = Network::Connection.new("http://example.com/path")

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 require "test/unit"
+require "rubygems"
 require "mocha"
 require 'turn'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: alovak-network
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Pavel Gabriel
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.6.0
     version: 
-description: HTTP/HTTPS communication module based on ruby net/http, net/https modules
+description: HTTP/HTTPS communication module with logging, filtering and easy SSL configuration
 email: alovak@gmail.com
 executables: []