faraday-conductivity 0.0.3 → 0.0.4

data/README.md

@@ -31,9 +31,6 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
 
   # provided by Faraday itself
   faraday.token_auth "secret"
-
-
-  # provided by Faraday
   faraday.request :multipart
   faraday.request :url_encoded
 

data/lib/faraday/conductivity/extended_logging.rb

@@ -59,7 +59,7 @@ module Faraday
 
       def format_headers(headers)
         length = headers.map {|k,v| k.to_s.size }.max
-        headers.map { |name, value| "#{name.to_s.ljust(length)} : #{value.inspect}" }.join("\n")
+        headers.map { |name, value| "#{name.to_s.ljust(length)} : #{value}" }.join("\n")
       end
 
     end

data/lib/faraday/conductivity/user_agent.rb

@@ -1,6 +1,5 @@
 require "etc"
 require "socket"
-require "thread"
 
 module Faraday
   module Conductivity
@@ -10,17 +9,42 @@ module Faraday
         super(app)
         @name = options.fetch(:app) { "Faraday" }
         @version = options.fetch(:version) { "0.0" }
+        @environment = options.fetch(:environment) { Environment.new }
       end
 
       def call(env)
-        login    = Etc.getlogin
-        hostname = Socket.gethostname
-        pid      = Process.pid
-        user_agent = "#{@name}/#{@version} (#{hostname}; #{login}; #{pid}) #{RUBY_ENGINE}/#{RUBY_VERSION} (#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM})"
-        env[:request_headers]['User-Agent'] ||= user_agent
+        env[:request_headers]['User-Agent'] = user_agent
         @app.call(env)
       end
 
+      def user_agent
+        [ app, ruby ].join(' ')
+      end
+
+      def app
+        "#{@name}/#{@version} (#{@environment.hostname}; #{@environment.login}; #{@environment.pid})"
+      end
+
+      def ruby
+        "#{RUBY_ENGINE}/#{RUBY_VERSION} (#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM})"
+      end
+
+    end
+
+    class Environment
+
+      def login
+        Etc.getlogin
+      end
+
+      def hostname
+        Socket.gethostname
+      end
+
+      def pid
+        Process.pid
+      end
+
     end
   end
 end

data/lib/faraday/conductivity/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Conductivity
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/middleware/extended_logging_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'logger'
+
+describe Faraday::Conductivity::ExtendedLogging do
+
+  subject(:log) { io.read }
+
+  it "includes the HTTP verb" do
+    log.should include "GET"
+  end
+
+  it "includes the request body" do
+    log.should include "the request body"
+  end
+
+  it "includes the request headers" do
+    log.should match %r"X-Foo\s+: bar"
+  end
+
+  it "includes the complete URL" do
+    log.should include "http://widgets.example.org/test"
+  end
+
+  it "includes the response status" do
+    log.should include "200"
+  end
+
+  it "includes the response time" do
+    log.should match(/\d+\.\d+ms/)
+  end
+
+  it "includes the response headers" do
+    log.should include "X-Bar : foo"
+  end
+
+  it "includes the response body" do
+    log.should include "the response body"
+  end
+
+  before do
+    perform_request
+    io.rewind
+  end
+
+  let(:io) { StringIO.new }
+  let(:logger) { Logger.new(io) }
+
+  def perform_request
+    connection.get("/test") do |request|
+      request.headers["X-Foo"] = "bar"
+      request.body = "the request body"
+    end
+  end
+
+  def connection
+    create_connection do |faraday|
+      faraday.use :extended_logging, :logger => logger
+    end
+  end
+
+end

data/spec/middleware/mimetype_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Faraday::Conductivity::Mimetype do
+
+  subject(:request_headers) { response.env[:request_headers] }
+
+  it "includes the mimetype specified" do
+    request_headers["Accept"].should eq mimetype
+  end
+
+  let(:mimetype) { "application/vnd.users-v2+json" }
+
+  def connection
+    create_connection do |faraday|
+      faraday.request :mimetype, :accept => mimetype
+    end
+  end
+
+end

data/spec/middleware/request_id_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Faraday::Conductivity::RequestId do
+
+  subject(:request_headers) { response.env[:request_headers] }
+
+  it "includes the thread local variable" do
+    Thread.current[:request_id] = "my-request-id"
+    request_headers["X-Request-Id"].should eq "my-request-id"
+  end
+
+  it "doesn't add the header if there is no request id" do
+    Thread.current[:request_id] = nil
+    request_headers.should_not have_key "X-Request-Id"
+  end
+
+  def connection
+    create_connection do |faraday|
+      faraday.request :request_id
+    end
+  end
+
+end

data/spec/middleware/user_agent_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Faraday::Conductivity::UserAgent do
+
+  subject(:user_agent) { response.env[:request_headers]["User-Agent"] }
+
+  it "includes the name and version of the app" do
+    user_agent.should start_with "MarketingSite/1.1"
+  end
+
+  it "includes the current ruby version" do
+    user_agent.should include RUBY_VERSION
+  end
+
+  it "includes the current ruby engine" do
+    user_agent.should include RUBY_ENGINE
+  end
+
+  it "includes the current ruby patch level" do
+    user_agent.should include RUBY_PATCHLEVEL.to_s
+  end
+
+  it "includes the platform" do
+    user_agent.should include RUBY_PLATFORM
+  end
+
+  it "includes the pid" do
+    user_agent.should include "1337"
+  end
+
+  it "includes the current host" do
+    user_agent.should include "my.hostname"
+  end
+
+  it "includes the current user name" do
+    user_agent.should include "linus"
+  end
+
+  let(:environment) {
+    double :environment, :login => "linus", :hostname => "my.hostname", :pid => 1337
+  }
+
+  def connection
+    create_connection do |faraday|
+      faraday.request :user_agent, :app => "MarketingSite", :version => "1.1", :environment => environment
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,2 +1,36 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'faraday/conductivity'
+
+module SpecHelper
+
+  def response
+    connection.get("/test")
+  end
+
+  def create_connection
+    Faraday.new(url: "http://widgets.example.org") do |faraday|
+      yield faraday
+      faraday.adapter :test, stubs
+    end
+  end
+
+  def stubs
+    @stubs ||= create_stubs do |stub|
+      stub.get('/test') { |env| [200, {"X-Bar" => "foo"} , "the response body"] }
+    end
+  end
+
+  def create_stubs
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      yield stub
+    end
+  end
+
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.include SpecHelper
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-conductivity
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -96,7 +96,10 @@ files:
 - lib/faraday/conductivity/request_id_filter.rb
 - lib/faraday/conductivity/user_agent.rb
 - lib/faraday/conductivity/version.rb
-- spec/faraday/conductivity_spec.rb
+- spec/middleware/extended_logging_spec.rb
+- spec/middleware/mimetype_spec.rb
+- spec/middleware/request_id_spec.rb
+- spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/yourkarma/faraday-conductivity
 licenses:
@@ -124,5 +127,8 @@ signing_key:
 specification_version: 3
 summary: Extra Faraday middleware, geared towards a service oriented architecture.
 test_files:
-- spec/faraday/conductivity_spec.rb
+- spec/middleware/extended_logging_spec.rb
+- spec/middleware/mimetype_spec.rb
+- spec/middleware/request_id_spec.rb
+- spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb

data/spec/faraday/conductivity_spec.rb

@@ -1,69 +0,0 @@
-require "logger"
-require "faraday/conductivity"
-require "faraday_middleware"
-require "json"
-
-# I'm sorry about the state of this test file.
-# This will be cleaned up, I promise.
-
-describe Faraday::Conductivity do
-
-  it 'should have a version number' do
-    Faraday::Conductivity::VERSION.should_not be_nil
-  end
-
-  example "user_agent" do
-    connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
-      faraday.request :user_agent, app: "MarketingSite", version: "1.1"
-    end
-    request = connection.get("/foobar")
-    request.env[:request_headers]["User-Agent"].should match %r(^MarketingSite/1.1 \([^\s]+; [^\s]+; \d+\) ruby/1.9.3)
-  end
-
-  example "extended_logging" do
-    io = StringIO.new
-    dummy_logger = Logger.new(io)
-    request_with do |faraday|
-      faraday.use :extended_logging, logger: dummy_logger
-    end
-    io.rewind
-    logged = io.read
-    logged.should include "Started GET request"
-    logged.should include "http://example.org/test"
-    logged.should include "the dummy response"
-    logged.should include "the request body"
-    logged.should include "X-Response-Header"
-    logged.should include "header-value"
-    # puts logged
-  end
-
-  example "request id" do
-    Thread.current[:request_id] = "my-request-id"
-    response = request_with do |faraday|
-      faraday.request :request_id
-    end
-    response.env[:request_headers]["X-Request-Id"].should eq "my-request-id"
-  end
-
-  example "mimetype" do
-    mimetype = "application/vnd.users-v2+json"
-    response = request_with do |faraday|
-      faraday.request :mimetype, accept: mimetype
-    end
-    response.env[:request_headers]["Accept"].should eq mimetype
-  end
-
-  def request_with
-    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.get('/test') { |env| [200, {"X-Response-Header" => "header-value"}, {foo:"the dummy response"}.to_json] }
-    end
-    connection = Faraday.new(url: "http://example.org/") do |faraday|
-      yield faraday
-      faraday.adapter :test, stubs
-    end
-    connection.get("/test") do |req|
-      req.body = "the request body"
-    end
-  end
-
-end