faraday-conductivity 0.0.2 → 0.0.3

data/README.md

@@ -2,19 +2,36 @@
 
 Extra Faraday Middleware! Geared towards a service oriented architecture.
 
+These middlewares are currently included:
+
+* **user_agent**, adds a dynamic `User-Agent` header to the request, so you
+  know which server and process the request is coming from.
+* **extended_logging**, logs *all* the information of the request.
+* **request_id**, passes along the `X-Request-Id` header to track API request
+  back to the source.
+* **mimetype**, allows you to specify the `Accept` header for API versioning.
+
+Further information:
+
+* [faraday](https://github.com/lostisland/faraday)
+* [faraday_middleware](https://github.com/lostisland/faraday_middleware)
+
+## Example
+
 Here is an overview of my favorite stack. More information about each
 middleware is below.
 
 ``` ruby
 APP_VERSION = IO.popen(["git", "rev-parse", "HEAD", :chdir => Rails.root]).read.chomp
 
+require "faraday_middleware"
+require "faraday/conductivity"
+
 connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
 
   # provided by Faraday itself
-  faraday.token_auth   "secret"
+  faraday.token_auth "secret"
 
-  # provided by this gem
-  faraday.use :extended_logging, logger: Rails.logger
 
   # provided by Faraday
   faraday.request :multipart
@@ -23,6 +40,10 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
   # provided by this gem
   faraday.request :user_agent, app: "MarketingSite", version: APP_VERSION
   faraday.request :request_id
+  faraday.request :mimetype, accept: "application/vnd.widgets-v2+json"
+
+  # provided by this gem
+  faraday.use :extended_logging, logger: Rails.logger
 
   # provided by faraday_middleware
   faraday.response :json, content_type: /\bjson$/
@@ -32,24 +53,25 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
 end
 ```
 
-You should also take a look at
-[faraday_middleware](https://github.com/lostisland/faraday_middleware).
-
-More middleware to come!
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'faraday-conductivity'
+``` ruby
+gem 'faraday-conductivity'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install faraday-conductivity
+```
+$ gem install faraday-conductivity
+```
 
 ## Usage
 
@@ -66,6 +88,9 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
 end
 ```
 
+Be sure to put this middleware after other middleware that add headers,
+otherwise it will log incomplete requests.
+
 ### RequestID
 
 Pass on a request ID from your frontend applications to your backend services.
@@ -91,7 +116,15 @@ class Application < ActionController::Base
 end
 ```
 
-It's a hack, but it works really well.
+It's a hack, because it uses a thread local variable, but it works really well.
+
+Don't forget to turn on uuid logging in Rails too, by uncommenting the line in
+`config/environments/production.rb`:
+
+``` ruby
+# Prepend all log lines with the following tags
+config.log_tags = [ :uuid ]
+```
 
 ### User Agent
 

data/lib/faraday/conductivity/extended_logging.rb

@@ -38,26 +38,22 @@ module Faraday
       end
 
       def request_debug(env)
-        <<-MESSAGE
-          Request Headers:
-          ----------------
-          #{format_headers env[:request_headers]}
-
-          Request Body:
-          -------------
-          #{env[:body]}
-        MESSAGE
+        debug_message("Request", env[:request_headers], env[:body])
       end
 
       def response_debug(env)
-        <<-MESSAGE
-          Response Headers:
-          -----------------
-          #{format_headers env[:response_headers]}
+        debug_message("Response", env[:response_headers], env[:body])
+      end
+
+      def debug_message(name, headers, body)
+        <<-MESSAGE.gsub(/^ +([^ ])/m, '\\1')
+        #{name} Headers:
+        ----------------
+        #{format_headers(headers)}
 
-          Response Body:
-          --------------
-          #{env[:body]}
+        #{name} Body:
+        -------------
+        #{body}
         MESSAGE
       end
 

data/lib/faraday/conductivity/mimetype.rb

@@ -0,0 +1,17 @@
+module Faraday
+  module Conductivity
+    class Mimetype < Faraday::Middleware
+
+      def initialize(app, options = {})
+        super(app)
+        @accept = options.fetch(:accept)
+      end
+
+      def call(env)
+        env[:request_headers]['Accept'] ||= @accept
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/version.rb

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

data/lib/faraday/conductivity.rb

@@ -1,10 +1,12 @@
 require "faraday"
 
 require "faraday/conductivity/version"
+
+require "faraday/conductivity/extended_logging"
+require "faraday/conductivity/mimetype"
 require "faraday/conductivity/request_id"
 require "faraday/conductivity/request_id_filter"
 require "faraday/conductivity/user_agent"
-require "faraday/conductivity/extended_logging"
 
 module Faraday
   module Conductivity
@@ -12,5 +14,6 @@ module Faraday
   register_middleware :middleware, :extended_logging => Faraday::Conductivity::ExtendedLogging
   register_middleware :request, :user_agent => Faraday::Conductivity::UserAgent
   register_middleware :request, :request_id => Faraday::Conductivity::RequestId
+  register_middleware :request, :mimetype => Faraday::Conductivity::Mimetype
 end
 

data/spec/faraday/conductivity_spec.rb

@@ -45,6 +45,14 @@ describe Faraday::Conductivity do
     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] }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-conductivity
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -91,6 +91,7 @@ files:
 - faraday-conductivity.gemspec
 - lib/faraday/conductivity.rb
 - lib/faraday/conductivity/extended_logging.rb
+- lib/faraday/conductivity/mimetype.rb
 - lib/faraday/conductivity/request_id.rb
 - lib/faraday/conductivity/request_id_filter.rb
 - lib/faraday/conductivity/user_agent.rb