shutl_resource 1.8.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4e6e89f181b62bd4c7d217a7f303f6f0a573607
-  data.tar.gz: befdafe23b0daf80bc0d393094babfca05ded320
+  metadata.gz: 500c2ab1f17cb6cf8130a6add480df375ddb3820
+  data.tar.gz: 15799d11ac8846e9451b9ac4c1f1c265cf971137
 SHA512:
-  metadata.gz: 120c5ca58f3a0b3caa7ddd3898f8ae5d018127dc64adee99e3411fc6ad25c3465d301447ab25f7ec0c8b88d37d3acd3791440d8b576ebd6932599128f800bd83
-  data.tar.gz: b9c40de77edc47756c0e10f97435cfab8d530b5435426bcf72a655e7736fd9e945057b8ec5c3dfc75c185a4354c1c6f1f1d6fbcfea241d508dedbf7c29698174
+  metadata.gz: 98e554b684023c9a6ab7f74039d1e1d7152f4839d90272c723b2ca411ddc3f23665e53f0cca6d100d770612c6cef57f63c0e4ea7c0f791f6dc9a88a8f6754ae4
+  data.tar.gz: c2355f511c325103a30888fb5285af2759c199184686bcba8f873f7c0478eb681c3b3b7b11787072cc1607c257dd8e749d6683b9895493bb12785c42f9c52a05

data/.rspec

@@ -1,4 +1,2 @@
 --color
---drb
---debug
 --tag ~@slow

data/.ruby-version

@@ -1 +1 @@
-2.1.1
+2.2.3

data/lib/shutl/resource/default_logger.rb

@@ -1,8 +1,6 @@
 require 'forwardable'
 
-module Faraday
-  class Middleware
-    class DefaultLogger < Faraday::Middleware
+class DefaultLogger < Faraday::Middleware
       extend Forwardable
 
       def_delegators :@logger, :debug, :info, :warn, :error, :fatal
@@ -18,30 +16,30 @@ module Faraday
       def call(env)
         start_time = Time.now
         info  request_info(env)
-        debug request_debug(env)
+        request_debug(env)
 
         @app.call(env).on_complete do
           end_time = Time.now
           response_time = end_time - start_time
           info  response_info(env, response_time)
-          debug response_debug(env)
+          response_debug(env)
         end
       end
 
       private
 
       def request_info(env)
-        "  Started %s request to: %s" % [ env[:method].to_s.upcase, env[:url] ]
+        "Started %s request to: %s" % [ env[:method].to_s.upcase, env[:url] ]
       end
 
       def response_info(env, response_time)
-        "  Response from %s; Status: %d; Time: %.1fms" % [ env[:url], env[:status], (response_time * 1_000.0) ]
+        "Response from %s; Status: %d; Time: %.1fms" % [ env[:url], env[:status], (response_time * 1_000.0) ]
       end
 
       def request_debug(env)
         request_headers = obfuscate_auth env[:request_headers]
 
-        debug_message("Request", request_headers, env[:body])
+        debug_request_response("Request", request_headers, env[:body])
       end
 
       def obfuscate_auth(headers)
@@ -54,25 +52,18 @@ module Faraday
       end
 
       def response_debug(env)
-        debug_message("Response", env[:response_headers], env[:body])
+        debug_request_response("Response", env[:response_headers], env[:body])
       end
 
-      def debug_message(name, headers, body)
-        <<-MESSAGE.gsub(/^ +([^ ])/m, '    \\1')
-        #{name} Headers:
-        ----------------
-        #{format_headers(headers)}
-
-        #{name} Body:
-        -------------
-        #{body}
-        MESSAGE
+      def debug_request_response(name, headers, body)
+        debug "#{name} headers: #{JSON.generate headers}"
+        debug "#{name} body: #{format_body body}"
       end
 
-      def format_headers(headers)
-        length = headers.map {|k,v| k.to_s.size }.max
-        headers.map { |name, value| "    #{name.to_s.ljust(length)} : #{value}" }.join("\n")
+      def format_body(body)
+        return '' unless body
+        JSON.generate JSON.parse Array(body).join("\n")
+      rescue JSON::ParserError
+        Array(body).join("\n").gsub /\n/, '\n'
       end
     end
-  end
-end

data/lib/shutl/resource/version.rb

@@ -1,5 +1,5 @@
 module Shutl
   module Resource
-    VERSION = '1.8.0'
+    VERSION = '1.8.2'
   end
 end

data/shutl_resource.gemspec

@@ -26,8 +26,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.11.0'
-  gem.add_development_dependency 'debugger'   if $platform.to_s == 'ruby'
-  gem.add_development_dependency 'ruby-debug' if $platform.to_s == 'java'
 
   gem.add_development_dependency 'webmock', '~> 1.8.7'
 end

data/spec/default_logger_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'stringio'
+require 'logger'
+
+describe DefaultLogger do
+
+  def conn(logger, logger_options={})
+    rubbles = ['Barney', 'Betty', 'Bam Bam']
+
+    Faraday.new do |b|
+      b.use DefaultLogger, logger: @logger
+      b.adapter :test do |stubs|
+        stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
+        stubs.post('/ohai') { [200, {'Content-Type' => 'text/html'}, 'fred'] }
+        stubs.get('/ohno') { [200, {'Content-Type' => 'text/html'}, 'wilma'] }
+        stubs.post('/ohyes') { [200, {'Content-Type' => 'text/html'}, 'pebbles'] }
+        stubs.get('/rubbles') { [200, {'Content-Type' => 'application/json'}, rubbles] }
+      end
+    end
+  end
+
+  before do
+    @io     = StringIO.new
+    @logger = Logger.new(@io)
+    @logger.level = Logger::DEBUG
+
+    @conn = conn(@logger)
+    @resp = @conn.get '/hello', nil, :accept => 'text/html'
+  end
+
+  it "still returns output" do
+    expect(@resp.body).to eq 'hello'
+  end
+
+  it "logss method and url" do
+    expect(@io.string).to match 'Started GET request to:'
+  end
+
+  it "logss request headers" do
+    expect(@io.string).to match %("Accept":"text/html")
+  end
+
+  it "logs response headers" do
+    expect(@io.string).to match %("Content-Type":"text/html")
+  end
+
+  it "logs request body" do
+    app = conn(@logger, :bodies => { :request => true })
+    app.post '/ohyes', 'name=Tamago', :accept => 'text/html'
+
+    expect(@io.string).to match %(name=Tamago)
+  end
+
+  it "logs response body" do
+    app = conn(@logger, :bodies => { :response => true })
+    app.get '/ohno', :accept => 'text/html'
+
+    expect(@io.string).to match %(wilma)
+  end
+
+  it "logs request and response body" do
+    app = conn(@logger, :bodies => true)
+    app.post '/ohyes', 'name=Ebi', :accept => 'text/html'
+
+    expect(@io.string).to match %(name=Ebi)
+    expect(@io.string).to match %(pebbles)
+  end
+
+  it "logs response body object" do
+    app = conn(@logger, :bodies => true)
+    app.get '/rubbles', nil, :accept => 'text/html'
+
+    expect(@io.string).to match %([\"Barney\", \"Betty\", \"Bam Bam\"]\n)
+  end
+
+  it 'obfuscates the token in the header' do
+    app = conn(@logger, :bodies => true)
+    @conn.post '/ohai', 'name=Toro', :accept => 'text/html', :authorization => 'Bearer 1234567890'
+
+    expect(@io.string).to_not match %(1234567890)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutl_resource
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.2
 platform: ruby
 authors:
 - David Rouchy
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shutl_auth
@@ -113,20 +113,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.0
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +163,7 @@ files:
 - shutl_resource.gemspec
 - spec/configuration_spec.rb
 - spec/configured_base_uri_spec.rb
+- spec/default_logger_spec.rb
 - spec/dynamic_resource_spec.rb
 - spec/error_spec.rb
 - spec/remote_url_spec.rb
@@ -205,13 +192,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Manage Shutl Rest resource. Parse/Serialize JSON
 test_files:
 - spec/configuration_spec.rb
 - spec/configured_base_uri_spec.rb
+- spec/default_logger_spec.rb
 - spec/dynamic_resource_spec.rb
 - spec/error_spec.rb
 - spec/remote_url_spec.rb