faraday_middleware 0.8.7 → 0.8.8

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - ruby-head

data/Gemfile

@@ -1,8 +1,8 @@
 source 'http://rubygems.org'
 
-platforms :ruby_19 do
+platforms :mri_19 do
   gem 'simplecov'
-  gem 'cane'
+  gem 'cane', '>= 0.3'
 end
 
 gem 'json', :platforms => [:ruby_18, :jruby]

data/Rakefile

@@ -1,6 +1,4 @@
-#!/usr/bin/env rake
-
-if defined? RUBY_ENGINE and 'ruby' == RUBY_ENGINE and '1.9.3' == RUBY_VERSION
+if defined? RUBY_ENGINE and 'ruby' == RUBY_ENGINE and RUBY_VERSION.index('1.9') == 0
   task :default => [:enable_coverage, :spec, :test, :quality]
 else
   task :default => [:spec, :test]
@@ -22,7 +20,8 @@ end
 
 task :quality do
   sh 'cane',
+    '--abc-max=10',
     '--style-measure=100',
     '--gte=coverage/covered_percent,99',
-    '--max-violations=2' # TODO: remove for cane > 1.0.0
+    '--max-violations=2'
 end

data/lib/faraday_middleware.rb

@@ -11,6 +11,7 @@ module FaradayMiddleware
   autoload :ParseMarshal,    'faraday_middleware/response/parse_marshal'
   autoload :ParseYaml,       'faraday_middleware/response/parse_yaml'
   autoload :Caching,         'faraday_middleware/response/caching'
+  autoload :Chunked,         'faraday_middleware/response/chunked'
   autoload :RackCompatible,  'faraday_middleware/rack_compatible'
   autoload :FollowRedirects, 'faraday_middleware/response/follow_redirects'
   autoload :Instrumentation, 'faraday_middleware/instrumentation'
@@ -30,7 +31,8 @@ module FaradayMiddleware
       :marshal  => lambda { ParseMarshal },
       :yaml     => lambda { ParseYaml },
       :caching  => lambda { Caching },
-      :follow_redirects => lambda { FollowRedirects }
+      :follow_redirects => lambda { FollowRedirects },
+      :chunked => lambda { Chunked }
 
     Faraday.register_middleware \
       :instrumentation  => lambda { Instrumentation }

data/lib/faraday_middleware/request/encode_json.rb

@@ -12,7 +12,9 @@ module FaradayMiddleware
     CONTENT_TYPE = 'Content-Type'.freeze
     MIME_TYPE    = 'application/json'.freeze
 
-    dependency 'json'
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
 
     def call(env)
       match_content_type(env) do |data|
@@ -22,7 +24,7 @@ module FaradayMiddleware
     end
 
     def encode(data)
-      JSON.dump data
+      ::JSON.dump data
     end
 
     def match_content_type(env)

data/lib/faraday_middleware/response/chunked.rb

@@ -0,0 +1,29 @@
+require 'faraday_middleware/response_middleware'
+
+module FaradayMiddleware
+  # Public: Parse a Transfer-Encoding: Chunked response to just the original data
+  class Chunked < FaradayMiddleware::ResponseMiddleware
+    TRANSFER_ENCODING = 'transfer-encoding'.freeze
+
+    define_parser do |raw_body|
+      decoded_body = []
+      until raw_body.empty?
+        chunk_len, raw_body = raw_body.split("\r\n", 2)
+        chunk_len = chunk_len.split(';',2).first.hex
+        break if chunk_len == 0
+        decoded_body << raw_body[0, chunk_len]
+        # The 2 is to strip the extra CRLF at the end of the chunk
+        raw_body = raw_body[chunk_len + 2, raw_body.length - chunk_len - 2]
+      end
+      decoded_body.join('')
+    end
+
+    def parse_response?(env)
+      super and chunked_encoding?(env[:response_headers])
+    end
+
+    def chunked_encoding?(headers)
+      encoding = headers[TRANSFER_ENCODING] and encoding.split(',').include?('chunked')
+    end
+  end
+end

data/lib/faraday_middleware/response/follow_redirects.rb

@@ -50,6 +50,9 @@ module FaradayMiddleware
     #           standards_compliant - A Boolean indicating whether to respect
     #                                 the HTTP spec when following 302
     #                                 (default: false)
+    #          cookie - Use either an array of strings
+    #                  (e.g. ['cookie1', 'cookie2']) to choose kept cookies
+    #                  or :all to keep all cookies.
     def initialize(app, options = {})
       super(app)
       @options = options
@@ -84,6 +87,7 @@ module FaradayMiddleware
 
     def update_env(env, request_body, response)
       env[:url] += response['location']
+      env[:request_headers][:cookies] = keep_cookies(env) if @options[:cookies]
 
       if transform_into_get?(response)
         env[:method] = :get
@@ -106,6 +110,25 @@ module FaradayMiddleware
       @options.fetch(:limit, FOLLOW_LIMIT)
     end
 
+    def keep_cookies(env)
+      cookies = @options.fetch(:cookies, [])
+      response_cookies = env[:response_headers][:cookies]
+      cookies == :all ? response_cookies : selected_request_cookies(response_cookies)
+    end
+
+    def selected_request_cookies(cookies)
+      selected_cookies(cookies)[0...-1]
+    end
+
+    def selected_cookies(cookies)
+      "".tap do |cookie_string|
+        @options[:cookies].each do |cookie|
+          string = /#{cookie}=?[^;]*/.match(cookies)[0] + ';'
+          cookie_string << string
+        end
+      end
+    end
+
     def standards_compliant?
       @options.fetch(:standards_compliant, false)
     end

data/lib/faraday_middleware/response/mashify.rb

@@ -25,7 +25,7 @@ module FaradayMiddleware
       when Hash
         mash_class.new(body)
       when Array
-        body.map { |item| item.is_a?(Hash) ? mash_class.new(item) : item }
+        body.map { |item| parse(item) }
       else
         body
       end

data/lib/faraday_middleware/response/parse_dates.rb

@@ -0,0 +1,39 @@
+require "time"
+require "faraday"
+
+module FaradayMiddleware
+  # Parse dates from response body
+  class ParseDates < ::Faraday::Response::Middleware
+    ISO_DATE_FORMAT = /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z\Z/m
+
+    def initialize(app, options = {})
+      @regexp = options[:match] || ISO_DATE_FORMAT
+      super(app)
+    end
+
+    def call(env)
+      response = @app.call(env)
+      parse_dates! response.env[:body]
+      response
+    end
+
+    private
+
+    def parse_dates!(value)
+      case value
+      when Hash
+        value.each do |key, element|
+          value[key] = parse_dates!(element)
+        end
+      when Array
+        value.each_with_index do |element, index|
+          value[index] = parse_dates!(element)
+        end
+      when @regexp
+        Time.parse(value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/faraday_middleware/response/parse_json.rb

@@ -3,13 +3,13 @@ require 'faraday_middleware/response_middleware'
 module FaradayMiddleware
   # Public: Parse response bodies as JSON.
   class ParseJson < ResponseMiddleware
-    dependency {
-      require 'json' unless defined?(JSON)
-    }
+    dependency do
+      require 'json' unless defined?(::JSON)
+    end
 
-    define_parser { |body|
-      JSON.parse body unless body.strip.empty?
-    }
+    define_parser do |body|
+      ::JSON.parse body unless body.strip.empty?
+    end
 
     # Public: Override the content-type of the response with "application/json"
     # if the response body looks like it might be JSON, i.e. starts with an

data/lib/faraday_middleware/response/parse_marshal.rb

@@ -3,9 +3,9 @@ require 'faraday_middleware/response_middleware'
 module FaradayMiddleware
   # Public: Restore marshalled Ruby objects in response bodies.
   class ParseMarshal < ResponseMiddleware
-    define_parser { |body|
+    define_parser do |body|
       ::Marshal.load body unless body.empty?
-    }
+    end
   end
 end
 

data/lib/faraday_middleware/response/parse_xml.rb

@@ -5,9 +5,9 @@ module FaradayMiddleware
   class ParseXml < ResponseMiddleware
     dependency 'multi_xml'
 
-    define_parser { |body|
+    define_parser do |body|
       ::MultiXml.parse(body)
-    }
+    end
   end
 end
 

data/lib/faraday_middleware/response/parse_yaml.rb

@@ -5,7 +5,9 @@ module FaradayMiddleware
   class ParseYaml < ResponseMiddleware
     dependency 'yaml'
 
-    define_parser { |body| ::YAML.load body }
+    define_parser do |body|
+      ::YAML.load body
+    end
   end
 end
 

data/lib/faraday_middleware/version.rb

@@ -1,3 +1,3 @@
 module FaradayMiddleware
-  VERSION = "0.8.7"
+  VERSION = "0.8.8"
 end

data/spec/chunked_spec.rb

@@ -0,0 +1,78 @@
+require 'helper'
+require 'faraday_middleware/response/chunked'
+
+describe FaradayMiddleware::Chunked, :type => :response do
+  context "no transfer-encoding" do
+    it "doesn't change nil body" do
+      process(nil).body.should be_nil
+    end
+
+    it "doesn't change an empty body" do
+      process('').body.should eql('')
+    end
+
+    it "doesn't change a normal body" do
+      process('asdf').body.should eql('asdf')
+    end
+  end
+
+  context "transfer-encoding gzip" do
+    let(:headers) { {"transfer-encoding" => "gzip"}}
+
+    it "doesn't change nil body" do
+      process(nil).body.should be_nil
+    end
+
+    it "doesn't change an empty body" do
+      process('').body.should eql('')
+    end
+
+    it "doesn't change a normal body" do
+      process('asdf').body.should eql('asdf')
+    end
+  end
+
+  context "transfer-encoding chunked" do
+    let(:headers) { {"transfer-encoding" => "chunked"}}
+
+    it "doesn't change nil body" do
+      process(nil).body.should be_nil
+    end
+
+    it "doesn't change an empty body" do
+      process('').body.should eql('')
+    end
+
+    it "parses a basic chunked body" do
+      process("10\r\nasdfghjklasdfghj\r\n0\r\n").body.should eql('asdfghjklasdfghj')
+    end
+
+    it "parses a chunked body with no ending chunk" do
+      process("10\r\nasdfghjklasdfghj\r\n").body.should eql('asdfghjklasdfghj')
+    end
+
+    it "parses a chunked body with no trailing CRLF on the data chunk" do
+      process("10\r\nasdfghjklasdfghj0\r\n").body.should eql('asdfghjklasdfghj')
+    end
+
+    it "parses a chunked body with an extension" do
+      process("10;foo=bar\r\nasdfghjklasdfghj\r\n0\r\n").body.should eql('asdfghjklasdfghj')
+    end
+
+    it "parses a chunked body with two extensions" do
+      process("10;foo=bar;bar=baz\r\nasdfghjklasdfghj\r\n0\r\n").body.should eql('asdfghjklasdfghj')
+    end
+
+    it "parses a chunked body with two chunks" do
+      process("8\r\nasdfghjk\r\n8\r\nlasdfghj\r\n0\r\n").body.should eql('asdfghjklasdfghj')
+    end
+  end
+
+  context "transfer-encoding chunked,chunked" do
+    let(:headers) { {"transfer-encoding" => "chunked,chunked"}}
+
+    it "parses a basic chunked body" do
+      process("10\r\nasdfghjklasdfghj\r\n0\r\n").body.should eql('asdfghjklasdfghj')
+    end
+  end
+end

data/spec/follow_redirects_spec.rb

@@ -130,6 +130,29 @@ describe FaradayMiddleware::FollowRedirects do
     expect { conn.get('/') }.to raise_error(FaradayMiddleware::RedirectLimitReached)
   end
 
+  context 'when cookies option' do
+
+    let(:cookies) { 'cookie1=abcdefg; cookie2=1234567; cookie3=awesome' }
+
+    context "is :all" do
+      it "puts all cookies from the response into the next request" do
+        conn = connection(:cookies => :all) do |stub|
+          stub.get('/')           { [301, {'Location' => '/found', 'Cookies' => cookies }, ''] }
+          stub.get('/found')      { [200, {'Content-Type' => 'text/plain'}, ''] }
+        end.get('/').env[:request_headers][:cookies].should == cookies
+      end
+    end
+
+    context "is an array of cookie names" do
+      it "puts selected cookies from the response into the next request" do
+        conn = connection(:cookies => ['cookie2']) do |stub|
+          stub.get('/')           { [301, {'Location' => '/found', 'Cookies' => cookies }, ''] }
+          stub.get('/found')      { [200, {'Content-Type' => 'text/plain'}, ''] }
+        end.get('/').env[:request_headers][:cookies].should == 'cookie2=1234567'
+      end
+    end
+  end
+
   context 'for an HTTP 301 response' do
     it_should_behave_like 'a successful redirection', 301
     it_should_behave_like 'a forced GET redirection', 301

data/spec/helper.rb

@@ -21,6 +21,7 @@ require 'rspec'
 module ResponseMiddlewareExampleGroup
   def self.included(base)
     base.let(:options) { Hash.new }
+    base.let(:headers) { Hash.new }
     base.let(:middleware) {
       described_class.new(lambda {|env|
         Faraday::Response.new(env)
@@ -31,7 +32,7 @@ module ResponseMiddlewareExampleGroup
   def process(body, content_type = nil, options = {})
     env = {
       :body => body, :request => options,
-      :response_headers => Faraday::Utils::Headers.new
+      :response_headers => Faraday::Utils::Headers.new(headers)
     }
     env[:response_headers]['content-type'] = content_type if content_type
     middleware.call(env)

data/spec/mashify_spec.rb

@@ -39,6 +39,13 @@ describe FaradayMiddleware::Mashify do
       us.last.username.should == 'pengwynn'
     end
 
+    it 'should handle nested arrays of hashes' do
+      env = { :body => [[{ "username" => "sferik" }, { "username" => "pengwynn" }]] }
+      us  = mashify.on_complete(env)
+      us.first.first.username.should == 'sferik'
+      us.first.last.username.should == 'pengwynn'
+    end
+
     it 'should handle mixed arrays' do
       env = { :body => [123, { "username" => "sferik" }, 456] }
       values = mashify.on_complete(env)

data/spec/parse_dates_spec.rb

@@ -0,0 +1,42 @@
+require 'helper'
+require 'faraday_middleware/response/parse_dates'
+require 'json'
+
+describe FaradayMiddleware::ParseDates, :type => :response do
+  let(:parsed){
+    if RUBY_VERSION > "1.9"
+      "2012-02-01 13:14:15 UTC"
+    else
+      "Wed Feb 01 13:14:15 UTC 2012"
+    end
+  }
+
+  it "should parse dates" do
+    process({"x" => "2012-02-01T13:14:15Z"}).body["x"].to_s.should == parsed
+  end
+
+  it "should parse nested dates in hash" do
+    process({"x" => {"y" => "2012-02-01T13:14:15Z"}}).body["x"]["y"].to_s.should == parsed
+  end
+
+  it "should parse nested dates in arrays" do
+    process({"x" => [{"y" =>"2012-02-01T13:14:15Z"}]}).body["x"][0]["y"].to_s.should == parsed
+  end
+
+  it "should not blow up on empty body" do
+    process(nil).body.should == nil
+  end
+
+  it "should leave arrays with ids alone" do
+    process({"x" => [1,2,3]}).body.should == {"x" => [1,2,3]}
+  end
+
+  it "should not parse date-like things" do
+    process({"x" => "2012-02-01T13:14:15Z bla"}).body["x"].to_s.should ==
+      "2012-02-01T13:14:15Z bla"
+    process({"x" => "12012-02-01T13:14:15Z"}).body["x"].to_s.should ==
+      "12012-02-01T13:14:15Z"
+    process({"x" => "2012-02-01T13:14:15Z\nfoo"}).body["x"].to_s.should ==
+      "2012-02-01T13:14:15Z\nfoo"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -173,8 +173,10 @@ files:
 - lib/faraday_middleware/request/oauth.rb
 - lib/faraday_middleware/request/oauth2.rb
 - lib/faraday_middleware/response/caching.rb
+- lib/faraday_middleware/response/chunked.rb
 - lib/faraday_middleware/response/follow_redirects.rb
 - lib/faraday_middleware/response/mashify.rb
+- lib/faraday_middleware/response/parse_dates.rb
 - lib/faraday_middleware/response/parse_json.rb
 - lib/faraday_middleware/response/parse_marshal.rb
 - lib/faraday_middleware/response/parse_xml.rb
@@ -183,12 +185,14 @@ files:
 - lib/faraday_middleware/response_middleware.rb
 - lib/faraday_middleware/version.rb
 - spec/caching_test.rb
+- spec/chunked_spec.rb
 - spec/encode_json_spec.rb
 - spec/follow_redirects_spec.rb
 - spec/helper.rb
 - spec/mashify_spec.rb
 - spec/oauth2_spec.rb
 - spec/oauth_spec.rb
+- spec/parse_dates_spec.rb
 - spec/parse_json_spec.rb
 - spec/parse_marshal_spec.rb
 - spec/parse_xml_spec.rb
@@ -214,18 +218,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Various middleware for Faraday
 test_files:
 - spec/caching_test.rb
+- spec/chunked_spec.rb
 - spec/encode_json_spec.rb
 - spec/follow_redirects_spec.rb
 - spec/helper.rb
 - spec/mashify_spec.rb
 - spec/oauth2_spec.rb
 - spec/oauth_spec.rb
+- spec/parse_dates_spec.rb
 - spec/parse_json_spec.rb
 - spec/parse_marshal_spec.rb
 - spec/parse_xml_spec.rb