faraday-detailed_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40a4b8eee431c057e71e75cbea811d3637c13939
+  data.tar.gz: fb290d8d2af9104d3a94b3fde042678e988076bd
+SHA512:
+  metadata.gz: 044fe22fe6c4a0b692c6d342b661acbc80b3ac0481952ec7b194d960bf1a9d2ede75a2324ce53b3c9010e55dd9813445d26d967d9063c583ed565117daea0147
+  data.tar.gz: f27298c2fb4966bb1348bc5e4d8a31ab9de30222c5f4939c5a717fe8b831d30243031b0c76a24388ec3372321ef18c2b8e1c4e4b56c50fcebb641343f26a9262

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-gemset
+.ruby-version
+.yardoc
+Gemfile.lock
+gemfiles/*.gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.1.1
+notifications:
+  email: false

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "faraday-0.8" do
+  gem "faraday", "~> 0.8.0"
+end
+
+appraise "faraday-current" do
+  gem "faraday"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday-detailed_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Envy Labs, LLC
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Faraday::DetailedLogger
+
+[![Gem Version](https://img.shields.io/gem/v/faraday-detailed_logger.svg)](http://rubygems.org/gems/faraday-detailed_logger)
+[![Build Status](https://img.shields.io/travis/envylabs/faraday-detailed_logger/master.svg)](https://travis-ci.org/envylabs/faraday-detailed_logger)
+[![Code Climate](https://img.shields.io/codeclimate/github/envylabs/faraday-detailed_logger.svg)](https://codeclimate.com/github/envylabs/faraday-detailed_logger)
+[![Dependency Status](https://gemnasium.com/envylabs/faraday-detailed_logger.svg)](https://gemnasium.com/envylabs/faraday-detailed_logger)
+
+A Faraday middleware used for providing debug- and info-level logging
+information. The request and response logs follow very closely with cURL output
+for ease of understanding.
+
+**Caution:** Be careful about your log level settings when using this
+middleware, _especially_ in a production environment. With a DEBUG level log
+enabled, there will be information security concerns.
+
+At a DEBUG level, the request and response headers and their bodies will be
+logged. This means that if you have Authorization information or API keys in
+your headers or are passing around sensitive information in the bodies, only an
+INFO level or above should be used.
+
+No headers or bodies are logged at an INFO or greater log level.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "faraday-detailed_logger"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install faraday-detailed_logger
+```
+
+## Usage
+
+Once required, the logger can be added to any Faraday connection by inserting
+it into your connection's request/response stack:
+
+```ruby
+connection = Faraday.new(:url => "http://sushi.com") do |faraday|
+  faraday.request  :url_encoded
+  faraday.response :detailed_logger # <-- Inserts the logger into the connection.
+  faraday.adapter  Faraday.default_adapter
+end
+```
+
+By default, the Faraday::DetailedLogger will log to STDOUT. If this is not your
+desired log location, simply provide any Logger-compatible object as a
+parameter to the middleware definition:
+
+```ruby
+my_logger = Logger.new("logfile.log")
+my_logger.level = Logger::INFO
+
+connection = Faraday.new(:url => "http://sushi.com") do |faraday|
+  faraday.request  :url_encoded
+  faraday.response :detailed_logger, my_logger # <-- sets a custom logger.
+  faraday.adapter  Faraday.default_adapter
+end
+```
+
+Or, perhaps use your Rails logger:
+
+```ruby
+faraday.response :detailed_logger, Rails.logger
+```
+
+### Example output
+
+Because logs generally work best with a single line of data per entry, the
+DEBUG-level output which contains the headers and bodies is inspected prior to
+logging. This crushes down and slightly manipulates the multi-line output one
+would expect when performing a verbose cURL operation into a log-compatible
+single line.
+
+Below is a contrived example showing how this works. Presuming cURL generated
+the following request and received the associated response:
+
+```bash
+$ curl -v -d "requestbody=content" http://sushi.com/temaki
+> GET /temaki HTTP/1.1
+> User-Agent: Faraday::DetailedLogger
+> Host: sushi.com
+> Content-Type: application/x-www-form-urlencoded
+> 
+> requestbody=content
+>
+< HTTP/1.1 200 OK
+< Content-Type: application/json
+< 
+< {"order_id":"1"}
+```
+
+The Faraday::DetailedLogger would log something similar to the following, with
+DEBUG-level logging enabled:
+
+```plain
+POST http://sushi.com/nigirizushi
+"User-Agent: Faraday::DetailedLogger\nContent-Type: application/x-www-form-urlencoded\n\nrequestbody=content"
+HTTP 200
+"Content-Type: application/json\n\n{\"order_id\":\"1\"}"
+```
+
+#### Request logging
+
+Log output for the request-portion of an HTTP interaction:
+
+```plain
+POST http://sushi.com/temaki
+"User-Agent: Faraday v0.9.0\nAccept: application/json\nContent-Type: application/json\n\n{\"name\":\"Polar Bear\",\"ingredients\":[\"Tuna\",\"Salmon\",\"Cream Cheese\",\"Tempura Flakes\"],\"garnish\":\"Eel Sauce\"}"
+```
+
+The POST line is logged at an INFO level just before the request is transmitted
+to the remote system. The second line containing the request headers and body
+are logged at a DEBUG level.
+
+#### Response logging
+
+Log output for the response-portion of an HTTP interaction:
+Response portion:
+
+```plain
+HTTP 202
+"server: nginx\ndate: Tue, 01 Jul 2014 21:56:52 GMT\ncontent-type: application/json\ncontent-length: 17\nconnection: close\nstatus: 202 Accepted\n\n{\"order_id\":\"1\"}"
+```
+
+The HTTP status line is logged at an INFO level at the same time the response
+is returned from the remote system. The second line containing the response
+headers and body are logged at a DEBUG level.
+
+## Contributing
+
+1. Fork it ( https://github.com/envylabs/faraday-detailed_logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/faraday-detailed_logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/detailed_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-detailed_logger"
+  spec.version       = Faraday::DetailedLogger::VERSION
+  spec.authors       = ["Envy Labs"]
+  spec.email         = [""]
+  spec.summary       = %q{A detailed request and response logger for Faraday.}
+  spec.description   = %q{A Faraday middleware for logging request and response activity including method, URI, headers, and body at varying log levels.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "appraisal", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/gemfiles/faraday_0.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.8.0"
+
+gemspec :path => "../"

data/gemfiles/faraday_current.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday"
+
+gemspec :path => "../"

data/lib/faraday/detailed_logger.rb

@@ -0,0 +1,7 @@
+require "faraday/detailed_logger/version"
+require "faraday/detailed_logger/middleware"
+
+module Faraday
+  module DetailedLogger
+  end
+end

data/lib/faraday/detailed_logger/middleware.rb

@@ -0,0 +1,75 @@
+require "faraday"
+
+module Faraday
+  module DetailedLogger
+    # A Faraday middleware used for providing debug-level logging information.
+    # The request and response logs follow very closely with cURL output for
+    # ease of understanding.
+    #
+    # Be careful about your log level settings when using this middleware,
+    # especially in a production environment. With a DEBUG level log enabled,
+    # there will be potential information security concerns, because the
+    # request and response headers and bodies will be logged out. At an INFO or
+    # greater level, this is not a concern.
+    #
+    class Middleware < Faraday::Response::Middleware
+
+      def self.default_logger
+        require "logger"
+        ::Logger.new(STDOUT)
+      end
+
+
+      # Public: Initialize a new Logger middleware.
+      #
+      # app - A Faraday-compatible middleware stack or application.
+      # logger - A Logger-compatible object to which the log information will
+      #          be recorded.
+      # progname - A String containing a program name to use when logging.
+      #
+      # Returns a Logger instance.
+      #
+      def initialize(app, logger = nil, progname = nil)
+        super(app)
+        @logger = logger || self.class.default_logger
+        @progname = progname
+      end
+
+      # Public: Used by Faraday to execute the middleware during the
+      # request/response cycle.
+      #
+      # env - A Faraday-compatible request environment.
+      #
+      # Returns the result of the parent application execution.
+      #
+      def call(env)
+        @logger.info(@progname) { "#{env[:method].upcase} #{env[:url]}" }
+        @logger.debug(@progname) { curl_output(env[:request_headers], env[:body]).inspect }
+        super
+      end
+
+      # Internal: Used by Faraday as a callback hook to process a network
+      # response after it has completed.
+      #
+      # env - A Faraday-compatible response environment.
+      #
+      # Returns nothing.
+      #
+      def on_complete(env)
+        @logger.info(@progname) { "HTTP #{env[:status]}" }
+        @logger.debug(@progname) { curl_output(env[:response_headers], env[:body]).inspect }
+      end
+
+
+      private
+
+
+      def curl_output(headers, body)
+        string = headers.collect { |k,v| "#{k}: #{v}" }.join("\n")
+        string + "\n\n#{body}"
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(:detailed_logger => Faraday::DetailedLogger::Middleware)

data/lib/faraday/detailed_logger/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  module DetailedLogger
+    VERSION = "1.0.0"
+  end
+end

data/spec/faraday/detailed_logger/middleware_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+require "logger"
+require "stringio"
+
+describe Faraday::DetailedLogger::Middleware do
+  it "passes through the given progname to the logger" do
+    logger = Logger.new(log = StringIO.new)
+
+    expect {
+      connection(logger, "TESTPROGNAME").get("/temaki")
+    }.to change {
+      log.rewind
+      !!(log.read =~/\bTESTPROGNAME\b/)
+    }.to(true)
+  end
+
+  it "logs the request method at an INFO level" do
+    logger = Logger.new(log = StringIO.new)
+
+    connection(logger).get("/temaki")
+    log.rewind
+    expect(log.read).to match(/\bINFO\b.+\bGET\b/)
+  end
+
+  it "logs the request URI at an INFO level" do
+    logger = Logger.new(log = StringIO.new)
+
+    connection(logger).get("/temaki")
+    log.rewind
+    expect(log.read).to match(/\bINFO\b.+\bhttp:\/\/sushi.com\/temaki\b/)
+  end
+
+  it "logs a cURL-like request package at a DEBUG level" do
+    logger = Logger.new(log = StringIO.new)
+
+    connection(logger).post("/nigirizushi", {"body" => "content"}, {:user_agent => "Faraday::DetailedLogger"})
+    log.rewind
+    curl = <<-CURL.strip
+User-Agent: Faraday::DetailedLogger
+Content-Type: application/x-www-form-urlencoded
+
+body=content
+CURL
+    expect(log.read).to match(/\bDEBUG\b.+#{Regexp.escape(curl.inspect)}/)
+  end
+
+  it "logs the response status code at an INFO level" do
+    logger = Logger.new(log = StringIO.new)
+
+    connection(logger).get("/temaki")
+    log.rewind
+    expect(log.read).to match(/\bINFO\b.+\bHTTP 200\b/)
+  end
+
+  it "logs a cURL-like response package at a DEBUG level" do
+    logger = Logger.new(log = StringIO.new)
+
+    connection(logger).post("/nigirizushi")
+    log.rewind
+    curl = <<-CURL.strip
+Content-Type: application/json
+
+{"order_id":"1"}
+CURL
+    expect(log.read).to match(/\bDEBUG\b.+#{Regexp.escape(curl.inspect)}/)
+  end
+
+
+  private
+
+
+  def connection(logger = nil, progname = nil)
+    Faraday.new(:url => "http://sushi.com") do |builder|
+      builder.request(:url_encoded)
+      builder.response(:detailed_logger, logger, progname)
+      builder.adapter(:test) do |stub|
+        stub.get("/temaki") {
+          [200, {"Content-Type" => "text/plain"}, "temaki"]
+        }
+        stub.post("/nigirizushi") {
+          [200, {"Content-Type" => "application/json"}, "{\"order_id\":\"1\"}"]
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "bundler/setup"
+require "faraday/detailed_logger"
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: faraday-detailed_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Envy Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Faraday middleware for logging request and response activity including
+  method, URI, headers, and body at varying log levels.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-detailed_logger.gemspec
+- gemfiles/faraday_0.8.gemfile
+- gemfiles/faraday_current.gemfile
+- lib/faraday/detailed_logger.rb
+- lib/faraday/detailed_logger/middleware.rb
+- lib/faraday/detailed_logger/version.rb
+- spec/faraday/detailed_logger/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: A detailed request and response logger for Faraday.
+test_files:
+- spec/faraday/detailed_logger/middleware_spec.rb
+- spec/spec_helper.rb