faraday-stack 0.1.0 → 0.1.2

data/README.md

@@ -38,7 +38,9 @@ Awesome example:
 * raises exceptions on 4xx, 5xx responses
 * follows redirects
 
-Optional features:
+To see how the default stack is built, see "[faraday_stack.rb][source]".
+
+### Optional features:
 
 * encode POST/PUT bodies as JSON:
       
@@ -55,7 +57,14 @@ Optional features:
             :namespace => 'faraday', :expires_in => 3600
         end
 
-To see how the default stack is built, see "[faraday_stack.rb][source]".
+* mount [Rack::Cache][] through `RackCompatible` middleware for HTTP caching of responses
+      
+        conn.builder.insert_after FaradayStack::FollowRedirects, FaradayStack::RackCompatible,
+          Rack::Cache::Context,
+            :metastore   => "file:/var/cache/rack/meta",
+            :entitystore => "file:/var/cache/rack/body"
+
 
 [faraday]: https://github.com/technoweenie/faraday
 [source]: https://github.com/mislav/faraday-stack/blob/master/lib/faraday_stack.rb
+[rack::cache]: http://rtomayko.github.com/rack-cache/

data/lib/faraday_stack.rb

@@ -28,13 +28,22 @@ module FaradayStack
   end
   
   def self.build(url = nil, options = {})
-    Faraday::Connection.new(url, options) do |builder|
+    klass = nil
+    if    url.is_a?(Hash)   then options = url.dup
+    elsif url.is_a?(Class)  then klass = url
+    else  options = options.merge(:url => url)
+    end
+
+    klass ||= options.delete(:class) || Faraday::Connection
+
+    klass.new(options) do |builder|
       builder.request :url_encoded
       builder.request :json
       yield builder if block_given?
       builder.use ResponseXML,  :content_type => /[+\/]xml$/
       builder.use ResponseHTML, :content_type => 'text/html'
-      builder.use ResponseJSON, :content_type => 'application/json'
+      builder.use ResponseJSON, :content_type => /(application|text)\/json/
+      builder.use ResponseJSON::MimeTypeFix, :content_type => /text\/(plain|javascript)/
       builder.use FollowRedirects
       builder.response :raise_error
       builder.adapter Faraday.default_adapter

data/lib/faraday_stack/addressable_patch.rb

@@ -1,18 +1,20 @@
 require 'addressable/uri'
 
-# fix `normalized_query` by sorting query key-value pairs
-# (rejected: https://github.com/sporkmonger/addressable/issues/28)
-class Addressable::URI
-  class << self
-    alias old_normalize_component normalize_component
+# feature-detect the bug
+unless Addressable::URI.parse('/?a=1&b=2') === '/?b=2&a=1'
+  # fix `normalized_query` by sorting query key-value pairs
+  # (rejected: https://github.com/sporkmonger/addressable/issues/28)
+  class Addressable::URI
+    alias normalized_query_without_ordering_fix normalized_query
     
-    def normalize_component(component, character_class = CharacterClasses::RESERVED + CharacterClasses::UNRESERVED)
-      normalized = old_normalize_component(component, character_class)
-      if character_class == Addressable::URI::CharacterClasses::QUERY
-        pairs = normalized.split('&').sort_by { |pair| pair[0, pair.index('=') || pair.length] }
-        normalized = pairs.join('&')
+    def normalized_query
+      fresh = @normalized_query.nil?
+      query = normalized_query_without_ordering_fix
+      if query && fresh
+        @normalized_query = query.split('&', -1).sort_by {|q| q[0..(q.index('=')||-1)] }.join('&')
+      else
+        query
       end
-      normalized
     end
   end
 end

data/lib/faraday_stack/caching.rb

@@ -24,14 +24,11 @@ module FaradayStack
     end
     
     def cache_key(env)
-      url = env[:url]
-      if params_to_strip.any?
-        url = url.dup
+      url = env[:url].dup
+      if url.query && params_to_strip.any?
         url.query_values = url.query_values.reject { |k,| params_to_strip.include? k }
-        url.normalize!
-      else
-        url = url.normalize
       end
+      url.normalize!
       url.request_uri
     end
     

data/lib/faraday_stack/response_json.rb

@@ -28,5 +28,23 @@ module FaradayStack
         end
       end
     end
+
+    # writes the correct MIME-type if the payload looks like JSON
+    class MimeTypeFix < ResponseMiddleware
+      def on_complete(env)
+        if process_response_type?(response_type(env)) and looks_like_json?(env)
+          old_type = env[:response_headers][CONTENT_TYPE]
+          new_type = 'application/json'
+          new_type << ';' << old_type.split(';', 2).last if old_type.index(';')
+          env[:response_headers][CONTENT_TYPE] = new_type
+        end
+      end
+
+      BRACKETS = %w- [ { -
+
+      def looks_like_json?(env)
+        parse_response?(env) and BRACKETS.include? env[:body][0,1]
+      end
+    end
   end
 end

data/test/factory_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+require 'forwardable'
+
+class FactoryTest < Test::Unit::TestCase
+  extend Forwardable
+  def_delegator FaradayStack, :build
+
+  class CustomConnection < Faraday::Connection
+  end
+
+  def test_default_connection
+    assert_instance_of Faraday::Connection, FaradayStack.default_connection
+  end
+
+  def test_build_subclass
+    assert_instance_of CustomConnection, build(CustomConnection)
+  end
+
+  def test_build_url
+    conn = FaradayStack.build('http://example.com')
+    assert_equal 'example.com', conn.host
+  end
+
+  def test_build_url_in_options
+    conn = FaradayStack.build(:url => 'http://example.com')
+    assert_equal 'example.com', conn.host
+  end
+end

data/test/response_middleware_test.rb

@@ -7,6 +7,8 @@ class ResponseMiddlewareTest < Test::Unit::TestCase
       b.use @json_handler
       b.adapter :test do |stub|
         stub.get('json')      { [200, {'Content-Type' => 'application/json; charset=utf-8'}, "[1,2,3]"] }
+        stub.get('bad_mime')  { [200, {'Content-Type' => 'text/javascript; charset=utf-8'}, "[1,2,3]"] }
+        stub.get('js')        { [200, {'Content-Type' => 'text/javascript'}, "alert('hello')"] }
         stub.get('blank')     { [200, {'Content-Type' => 'application/json'}, ''] }
         stub.get('nil')       { [200, {'Content-Type' => 'application/json'}, nil] }
         stub.get('bad_json')  { [200, {'Content-Type' => 'application/json'}, '<body></body>']}
@@ -19,6 +21,10 @@ class ResponseMiddlewareTest < Test::Unit::TestCase
     @conn.builder.swap @json_handler, @json_handler, :content_type => types
   end
 
+  def with_mime_type_fix(*types)
+    @conn.builder.insert_after @json_handler, FaradayStack::ResponseJSON::MimeTypeFix, :content_type => types
+  end
+
   def test_uses_json_to_parse_json_content
     response = @conn.get('json')
     assert response.success?
@@ -69,4 +75,19 @@ class ResponseMiddlewareTest < Test::Unit::TestCase
     assert_equal 'text/html', response.headers['Content-Type']
     assert_equal '<body></body>', response.body
   end
+  
+  def test_mime_type_fix
+    process_only('application/json')
+    with_mime_type_fix
+    response = @conn.get('bad_mime')
+    assert_equal 'application/json; charset=utf-8', response.headers['Content-Type']
+    assert_equal [1,2,3], response.body
+  end
+  
+  def test_mime_type_fix_conditional
+    process_only('application/json')
+    with_mime_type_fix
+    response = @conn.get('js')
+    assert_equal 'text/javascript', response.headers['Content-Type']
+  end
 end

metadata

@@ -1,34 +1,45 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: faraday-stack
-version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
-authors:
-- Mislav Marohnić
+authors: 
+- "Mislav Marohni\xC4\x87"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-01 00:00:00.000000000 +02:00
+
+date: 2011-06-13 00:00:00 +02:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: faraday
-  requirement: &2164745380 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.6'
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
   type: :runtime
-  prerelease: false
-  version_requirements: *2164745380
+  version_requirements: *id001
 description: 
 email: mislav.marohnic@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/faraday-stack.rb
 - lib/faraday_stack/addressable_patch.rb
 - lib/faraday_stack/caching.rb
@@ -41,33 +52,42 @@ files:
 - lib/faraday_stack/response_xml.rb
 - lib/faraday_stack.rb
 - test/caching_test.rb
+- test/factory_test.rb
 - test/follow_redirects_test.rb
 - test/response_middleware_test.rb
 - test/test_helper.rb
 - README.md
-has_rdoc: false
+has_rdoc: true
 homepage: https://github.com/mislav/faraday-stack
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Great Faraday stack for consuming all kinds of APIs
 test_files: []
+