api_client 0.5.15 → 0.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6c012cef145acbd3588f48fd9c4dbd56aa0ba90
-  data.tar.gz: c9e0e93d078e9fac878b72f2a11220d40cb72e63
+  metadata.gz: 37901cb1987dc20c32b8853eedfabab968bf3b0e
+  data.tar.gz: fd064629bf64b68239f8957e3bbfa44eb2fde456
 SHA512:
-  metadata.gz: 1111eab30cc3bcdc8fec74ba66a0b356f2ec6eb0460f4ee3e7991c2c5433996cd9416eaf84cbf418bc2dc790b2714e92ea5a352ffe68f77fb2abfd555c468b90
-  data.tar.gz: 5aa6b0e78e3912e6c68b39ee4cacccc94394737e86cb5af64a2f32e370d72d1f811d9d2a0f59b4aab2ba8b43a7c86383152cc4d21e744e6131a1befec6932aab
+  metadata.gz: af89fc9e078b61a8a368e9ef777c5373fff8740e47cd67e40b1fb4a6a0724a1b6e581cf61df0cd14d8d2262be8bb405310fe31940aeb1974e1350e81f9154d8d
+  data.tar.gz: 13154f7651b172e8a647488583d89371873a64322c8ebc3bb55bc4c3fbdd070bab169982c424371ae288f058e5822f809dd5da50e47880a36be273cec8a0239d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.5.16
+
+ * improve logging, log request details on Logger::DEBUG level
+
 # 0.5.15
 
  * add response status code to error message

data/README.md

@@ -143,6 +143,17 @@ ApiClient::Base.
   get('/stuff.json') # => returns a parsed Array object
 ```
 
+## Logging
+
+To log requests set the `ApiClient.logger`. To log request payloads and headers set level to `Logger::DEBUG`
+
+```ruby
+require 'logger'
+ApiClient.logger = Logger.new('api_client.log')
+ApiClient.logger.level = Logger::INFO
+
+```
+
 Copyright
 ---------
 

data/lib/api_client/connection/middlewares/request/logger.rb

@@ -1,17 +1,51 @@
 require "logger"
-class ApiClient::Connection::Middlewares::Request::Logger < Faraday::Middleware
 
+class ApiClient::Connection::Middlewares::Request::Logger < Faraday::Middleware
   def call(env)
-    time    = Time.now
-    returns = @app.call(env)
-    taken   = Time.now - time
-    @logger.info "#{env[:method].to_s.upcase} #{env[:url]}: #{"%.4f" % taken} seconds"
-    returns
+    debug_lines = []
+    should_log_details = @logger.level <= ::Logger::DEBUG
+
+    gather_request_debug_lines(env, debug_lines) if should_log_details
+
+    start = current_stamp_millisec
+    response = @app.call(env)
+    taken_sec = (current_stamp_millisec - start) / 1000.0
+
+    gather_response_debug_lines(response, taken_sec, debug_lines) if response && should_log_details
+
+    if should_log_details
+      @logger.debug { debug_lines.join("\n") }
+    else
+      @logger.info { "#{env[:method].to_s.upcase} #{env[:url]}: #{"%.4f" % taken_sec} seconds" }
+    end
+
+    response
   end
 
   def initialize(app, logger = nil)
     @logger = logger || ::Logger.new(STDOUT)
-    @app    = app
+    @app = app
   end
 
+  private
+
+  def gather_request_debug_lines(env, debug_lines)
+    debug_lines << "> #{env[:method].to_s.upcase} #{env[:url]}"
+    env[:request_headers].each { |k, v| debug_lines << "> #{k}: #{v}" }
+    debug_lines << "> "
+    debug_lines << "> #{env[:body]}\n> " if env[:body] && env[:body] != ""
+    debug_lines
+  end
+
+  def gather_response_debug_lines(response, taken_sec, debug_lines)
+    debug_lines << "< responded in #{"%.4f" % taken_sec} seconds with HTTP #{response.status}"
+    response.headers.each { |k, v| debug_lines << "< #{k}: #{v}" }
+    debug_lines << "< "
+    debug_lines << "< #{response.body}\n> " if response.body && response.body != ""
+    debug_lines
+  end
+
+  def current_stamp_millisec
+    Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+  end
 end

data/lib/api_client/version.rb

@@ -1,3 +1,3 @@
 module ApiClient
-  VERSION = "0.5.15"
+  VERSION = "0.5.16"
 end

data/spec/api_client/base_spec.rb

@@ -46,7 +46,7 @@ describe ApiClient::Base do
 
     it "inspects subobjects properly" do
       subject.update(:id => 1, :sub => [1,2])
-      subject.inspect.should == '#<ApiClient::Base id: 1, sub: [1, 2]>'
+      subject.inspect.should == '#<ApiClient::Base id: 1, sub: #<Hashie::Array [1, 2]>>'
     end
 
     it "makes sure id is the first key" do

data/spec/api_client/connection/request/logger_spec.rb

@@ -1,10 +1,10 @@
 require "spec_helper"
 
 describe ApiClient::Connection::Middlewares::Request::Logger do
-
   it "adds a oauth header to the request" do
-    app      = double
-    logger   = FakeLogger.new
+    app = double
+    io = StringIO.new
+    logger = Logger.new(io)
     instance = ApiClient::Connection::Middlewares::Request::Logger.new(app, logger)
     env = {
       :url => "http://api.twitter.com",
@@ -13,7 +13,6 @@ describe ApiClient::Connection::Middlewares::Request::Logger do
     }
     app.should_receive(:call).with(env)
     instance.call(env)
-    logger.history.first.include?("GET http://api.twitter.com").should be_true
+    io.string.should match("GET http://api.twitter.com")
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.5.16
 platform: ruby
 authors:
 - Marcin Bunsch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -145,7 +145,6 @@ files:
 - spec/api_client/scope_spec.rb
 - spec/api_client/utils_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_logger.rb
 - spec/support/matchers.rb
 homepage: https://github.com/futuresimple/api_client
 licenses: []
@@ -166,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: api_client
-rubygems_version: 2.6.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 3
 summary: API client builder
@@ -191,6 +190,4 @@ test_files:
 - spec/api_client/scope_spec.rb
 - spec/api_client/utils_spec.rb
 - spec/spec_helper.rb
-- spec/support/fake_logger.rb
 - spec/support/matchers.rb
-has_rdoc: 

data/spec/support/fake_logger.rb

@@ -1,15 +0,0 @@
-class FakeLogger
-
-  def initialize(*)
-    @history = []
-  end
-
-  def history
-    @history
-  end
-
-  def info(msg)
-    @history.push(msg)
-  end
-
-end