faraday-conductivity 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 iain
+
+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,119 @@
+# Faraday::Conductivity
+
+Extra Faraday Middleware! Geared towards a service oriented architecture.
+
+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
+
+connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
+
+  # provided by Faraday itself
+  faraday.token_auth   "secret"
+
+  # provided by this gem
+  faraday.use :extended_logging, logger: Rails.logger
+
+  # provided by Faraday
+  faraday.request :multipart
+  faraday.request :url_encoded
+
+  # provided by this gem
+  faraday.request :user_agent, app: "MarketingSite", version: APP_VERSION
+  faraday.request :request_id
+
+  # provided by faraday_middleware
+  faraday.response :json, content_type: /\bjson$/
+
+  faraday.adapter Faraday.default_adapter
+
+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'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday-conductivity
+
+## Usage
+
+Here is an overview of the middleware included in this gem.
+
+### Extended Logging
+
+Provides pretty logging, allowing you to inspect every detail of the request
+and response.
+
+``` ruby
+connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
+  faraday.use :extended_logging, logger: Rails.logger
+end
+```
+
+### RequestID
+
+Pass on a request ID from your frontend applications to your backend services.
+This allows for tracking requests over multiple services. Use this in
+combination with something like the Rails tagged logger and you'll always know
+what triggered something to happen in your application.
+
+It works by trying to find the request id in `Thread.current[:request_id]` and
+setting the `X-Request-Id` header.
+
+``` ruby
+connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
+  faraday.request :request_id
+end
+```
+
+In order for this to work, you need to make the Request ID globally available.
+To do this in Rails:
+
+``` ruby
+class Application < ActionController::Base
+  before_filter Faraday::Conductivity::RequestIdFilter
+end
+```
+
+It's a hack, but it works really well.
+
+### User Agent
+
+Which application, on which server, made this request? With this middleware you
+know! It sets the User-Agent string based on the user, pid and hostname.
+
+``` ruby
+connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
+  faraday.request :user_agent, app: "MarketingSite", version: "1.1"
+end
+```
+
+The User-Agent will looks like this on my machine:
+
+```
+MarketingSite/1.1 (iain.local; iain; 30360) ruby/1.9.3 (327; x86_64-darwin12.2.0)
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/faraday-conductivity.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/conductivity/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "faraday-conductivity"
+  gem.version       = Faraday::Conductivity::VERSION
+  gem.authors       = ["iain"]
+  gem.email         = ["iain@iain.nl"]
+  gem.description   = %q{Extra Faraday middleware, geared towards a service oriented architecture.}
+  gem.summary       = %q{Extra Faraday middleware, geared towards a service oriented architecture.}
+  gem.homepage      = "https://github.com/yourkarma/faraday-conductivity"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "faraday", "~> 0.8"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+end

data/lib/faraday/conductivity/extended_logging.rb

@@ -0,0 +1,71 @@
+require 'forwardable'
+
+module Faraday
+  module Conductivity
+    class ExtendedLogging < Faraday::Middleware
+
+      extend Forwardable
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+      def initialize(app, options = {})
+        @app = app
+        @logger = options.fetch(:logger) {
+          require 'logger'
+          ::Logger.new($stderr)
+        }
+      end
+
+      def call(env)
+        start_time = Time.now
+        info  { request_info(env) }
+        debug { 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) }
+        end
+      end
+
+      private
+
+      def request_info(env)
+        "Started #{env[:method].to_s.upcase} request to: #{env[:url]}"
+      end
+
+      def response_info(env, response_time)
+        "Response from #{env[:url]}; Status: #{env[:status]}; Time: %.1fms" % (response_time * 1_000.0)
+      end
+
+      def request_debug(env)
+        <<-MESSAGE
+          Request Headers:
+          ----------------
+          #{format_headers env[:request_headers]}
+
+          Request Body:
+          -------------
+          #{env[:body]}
+        MESSAGE
+      end
+
+      def response_debug(env)
+        <<-MESSAGE
+          Response Headers:
+          -----------------
+          #{format_headers env[:response_headers]}
+
+          Response Body:
+          --------------
+          #{env[:body]}
+        MESSAGE
+      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.inspect}" }.join("\n")
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/request_id.rb

@@ -0,0 +1,19 @@
+module Faraday
+  module Conductivity
+    class RequestId < Faraday::Middleware
+
+      def initialize(app)
+        super(app)
+      end
+
+      def call(env)
+        request_id = Thread.current[:request_id]
+        if request_id
+          env[:request_headers]['X-Request-Id'] ||= request_id
+        end
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/request_id_filter.rb

@@ -0,0 +1,11 @@
+module Faraday
+  module Conductivity
+    class RequestIdFilter
+
+      def self.filter(controller)
+        Thread.current[:request_id] = controller.request.uuid
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/user_agent.rb

@@ -0,0 +1,26 @@
+require "etc"
+require "socket"
+require "thread"
+
+module Faraday
+  module Conductivity
+    class UserAgent < Faraday::Middleware
+
+      def initialize(app, options = {})
+        super(app)
+        @name = options.fetch(:app) { "Faraday" }
+        @version = options.fetch(:version) { "0.0" }
+      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
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  module Conductivity
+    VERSION = "0.0.1"
+  end
+end

data/lib/faraday/conductivity.rb

@@ -0,0 +1,16 @@
+require "faraday"
+
+require "faraday/conductivity/version"
+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
+  end
+  register_middleware :middleware, :extended_logging => Faraday::Conductivity::ExtendedLogging
+  register_middleware :request, :user_agent => Faraday::Conductivity::UserAgent
+  register_middleware :request, :request_id => Faraday::Conductivity::RequestId
+end
+

data/spec/faraday/conductivity_spec.rb

@@ -0,0 +1,61 @@
+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
+
+  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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'faraday/conductivity'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: faraday-conductivity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extra Faraday middleware, geared towards a service oriented architecture.
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-conductivity.gemspec
+- lib/faraday/conductivity.rb
+- lib/faraday/conductivity/extended_logging.rb
+- lib/faraday/conductivity/request_id.rb
+- lib/faraday/conductivity/request_id_filter.rb
+- lib/faraday/conductivity/user_agent.rb
+- lib/faraday/conductivity/version.rb
+- spec/faraday/conductivity_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yourkarma/faraday-conductivity
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Extra Faraday middleware, geared towards a service oriented architecture.
+test_files:
+- spec/faraday/conductivity_spec.rb
+- spec/spec_helper.rb