httparty 0.8.0 → 0.8.3

data/lib/httparty/parser.rb

@@ -93,12 +93,11 @@ module HTTParty
       @body = body
       @format = format
     end
-    private_class_method :new
 
     # @return [Object] the parsed body
-    # @return [nil] when the response body is nil or an empty string
+    # @return [nil] when the response body is nil, an empty string, spaces only or "null"
     def parse
-      return nil if body.nil? || body.empty?
+      return nil if body.nil? || body.strip.empty? || body == "null"
       if supports_format?
         parse_supported_format
       else
@@ -113,7 +112,12 @@ module HTTParty
     end
 
     def json
-      MultiJson.decode(body)
+      # https://github.com/sferik/rails/commit/5e62670131dfa1718eaf21ff8dd3371395a5f1cc
+      if MultiJson.respond_to?(:adapter)
+        MultiJson.load(body)
+      else
+        MultiJson.decode(body)
+      end
     end
 
     def yaml

data/lib/httparty/request.rb

@@ -3,6 +3,7 @@ module HTTParty
     SupportedHTTPMethods = [
       Net::HTTP::Get,
       Net::HTTP::Post,
+      Net::HTTP::Patch,
       Net::HTTP::Put,
       Net::HTTP::Delete,
       Net::HTTP::Head,
@@ -67,12 +68,26 @@ module HTTParty
       options[:parser]
     end
 
-    def perform
+    def perform(&block)
       validate
       setup_raw_request
-      self.last_response = http.request(@raw_request)
+      chunked_body = nil
+
+      self.last_response = http.request(@raw_request) do |http_response|
+        if block
+          chunks = []
+
+          http_response.read_body do |fragment|
+            chunks << fragment
+            block.call(fragment)
+          end
+
+          chunked_body = chunks.join
+        end
+      end
+
       handle_deflation
-      handle_response
+      handle_response(chunked_body)
     end
 
     private
@@ -102,7 +117,7 @@ module HTTParty
     end
 
     def http
-      http = Net::HTTP.new(uri.host, uri.port, options[:http_proxyaddr], options[:http_proxyport])
+      http = Net::HTTP.new(uri.host, uri.port, options[:http_proxyaddr], options[:http_proxyport], options[:http_proxyuser], options[:http_proxypass])
       http.use_ssl = ssl_implied?
 
       if options[:timeout] && (options[:timeout].is_a?(Integer) || options[:timeout].is_a?(Float))
@@ -160,7 +175,10 @@ module HTTParty
     end
 
     def setup_digest_auth
-      res = http.head(uri.request_uri, options[:headers])
+      auth_request = http_method.new(uri.request_uri)
+      auth_request.initialize_http_header(options[:headers])
+      res = http.request(auth_request)
+
       if res['www-authenticate'] != nil && res['www-authenticate'].length > 0
         @raw_request.digest_auth(username, password, res)
       end
@@ -180,8 +198,7 @@ module HTTParty
       query_string_parts.size > 0 ? query_string_parts.join('&') : nil
     end
 
-    # Raises exception Net::XXX (http error code) if an http error occured
-    def handle_response
+    def handle_response(body)
       if response_redirects?
         options[:limit] -= 1
         self.path = last_response['location']
@@ -190,18 +207,21 @@ module HTTParty
         capture_cookies(last_response)
         perform
       else
-        Response.new(self, last_response, parse_response(last_response.body))
+        body = body || last_response.body
+        Response.new(self, last_response, lambda { parse_response(body) }, :body => body)
       end
     end
 
     # Inspired by Ruby 1.9
     def handle_deflation
       case last_response["content-encoding"]
-      when "gzip"
+      when "gzip", "x-gzip"
         body_io = StringIO.new(last_response.body)
         last_response.body.replace Zlib::GzipReader.new(body_io).read
+        last_response.delete('content-encoding')
       when "deflate"
         last_response.body.replace Zlib::Inflate.inflate(last_response.body)
+        last_response.delete('content-encoding')
       end
     end
 
@@ -241,7 +261,7 @@ module HTTParty
 
     def validate
       raise HTTParty::RedirectionTooDeep.new(last_response), 'HTTP redirects too deep' if options[:limit].to_i <= 0
-      raise ArgumentError, 'only get, post, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)
+      raise ArgumentError, 'only get, post, patch, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)
       raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].is_a?(Hash)
       raise ArgumentError, 'only one authentication method, :basic_auth or :digest_auth may be used at a time' if options[:basic_auth] && options[:digest_auth]
       raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].is_a?(Hash)

data/lib/httparty/response.rb

@@ -1,46 +1,21 @@
 module HTTParty
   class Response < HTTParty::BasicObject #:nodoc:
-    class Headers
-      include ::Net::HTTPHeader
-
-      def initialize(header)
-        @header = header
-      end
-
-      def ==(other)
-        @header == other
-      end
-
-      def inspect
-        @header.inspect
-      end
-
-      def method_missing(name, *args, &block)
-        if @header.respond_to?(name)
-          @header.send(name, *args, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to?(method)
-        super || @header.respond_to?(method)
-      end
-    end
-
-
     def self.underscore(string)
       string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z])([A-Z])/,'\1_\2').downcase
     end
 
-    attr_reader :request, :response, :parsed_response, :body, :headers
+    attr_reader :request, :response, :body, :headers
 
-    def initialize(request, response, parsed_response)
-      @request = request
-      @response = response
-      @body = response.body
-      @parsed_response = parsed_response
-      @headers = Headers.new(response.to_hash)
+    def initialize(request, response, parsed_block, options={})
+      @request      = request
+      @response     = response
+      @body         = response.body || options[:body]
+      @parsed_block = parsed_block
+      @headers      = Headers.new(response.to_hash)
+    end
+
+    def parsed_response
+      @parsed_response ||= @parsed_block.call
     end
 
     def class
@@ -53,7 +28,7 @@ module HTTParty
 
     def inspect
       inspect_id = "%x" % (object_id * 2)
-      %(#<#{self.class}:0x#{inspect_id} @parsed_response=#{parsed_response.inspect}, @response=#{response.inspect}, @headers=#{headers.inspect}>)
+      %(#<#{self.class}:0x#{inspect_id} parsed_response=#{parsed_response.inspect}, @response=#{response.inspect}, @headers=#{headers.inspect}>)
     end
 
     CODES_TO_OBJ = ::Net::HTTPResponse::CODE_CLASS_TO_OBJ.merge ::Net::HTTPResponse::CODE_TO_OBJ
@@ -64,10 +39,10 @@ module HTTParty
         klass === response
       end
     end
-    
+
     def respond_to?(name)
-      return true if [:request,:response,:parsed_response,:body,:headers].include?(name)
-      parsed_response.respond_to?(name) or response.respond_to?(name)
+      return true if [:request, :response, :parsed_response, :body, :headers].include?(name)
+      parsed_response.respond_to?(name) || response.respond_to?(name)
     end
 
     protected
@@ -83,3 +58,5 @@ module HTTParty
     end
   end
 end
+
+require 'httparty/response/headers'

data/lib/httparty/response/headers.rb

@@ -0,0 +1,31 @@
+module HTTParty
+  class Response #:nodoc:
+    class Headers
+      include ::Net::HTTPHeader
+
+      def initialize(header = {})
+        @header = header
+      end
+
+      def ==(other)
+        @header == other
+      end
+
+      def inspect
+        @header.inspect
+      end
+
+      def method_missing(name, *args, &block)
+        if @header.respond_to?(name)
+          @header.send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to?(method)
+        super || @header.respond_to?(method)
+      end
+    end
+  end
+end

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty
-  VERSION = "0.8.0"
+  VERSION = "0.8.3"
 end

data/spec/httparty/cookie_hash_spec.rb

@@ -6,7 +6,6 @@ describe HTTParty::CookieHash do
   end
 
   describe "#add_cookies" do
-    
     describe "with a hash" do
       it "should add new key/value pairs to the hash" do
         @cookie_hash.add_cookies(:foo => "bar")
@@ -29,7 +28,7 @@ describe HTTParty::CookieHash do
         @cookie_hash[:second].should == 'two'
         @cookie_hash[:third].should == nil
       end
-      
+
       it "should overwrite any existing key" do
         @cookie_hash[:foo] = 'bar'
         @cookie_hash.add_cookies("foo=tar")
@@ -37,7 +36,7 @@ describe HTTParty::CookieHash do
         @cookie_hash[:foo].should eql("tar")
       end
     end
-    
+
     describe 'with other class' do
       it "should error" do
         lambda {
@@ -61,7 +60,7 @@ describe HTTParty::CookieHash do
       @s.should match(/rofl=copter/)
       @s.should match(/^\w+=\w+; \w+=\w+$/)
     end
-    
+
     it "should not include client side only cookies" do
       @cookie_hash.add_cookies(:path => "/")
       @s = @cookie_hash.to_cookie_string

data/spec/httparty/net_digest_auth_spec.rb

@@ -13,11 +13,11 @@ describe Net::HTTPHeader::DigestAuthenticator do
     @digest.authorization_header.join(", ")
   end
 
-
   context "with specified quality of protection (qop)" do
     before do
-      @digest = setup_digest({'www-authenticate' =>
-        'Digest realm="myhost@testrealm.com", nonce="NONCE", qop="auth"'})
+      @digest = setup_digest({
+        'www-authenticate' => 'Digest realm="myhost@testrealm.com", nonce="NONCE", qop="auth"',
+      })
     end
 
     it "should set prefix" do
@@ -45,9 +45,7 @@ describe Net::HTTPHeader::DigestAuthenticator do
     end
 
     it "should set response" do
-      request_digest =
-        "md5(md5(Mufasa:myhost@testrealm.com:Circle Of Life)" +
-        ":NONCE:0:md5(deadbeef):auth:md5(GET:/dir/index.html))"
+      request_digest = "md5(md5(Mufasa:myhost@testrealm.com:Circle Of Life):NONCE:0:md5(deadbeef):auth:md5(GET:/dir/index.html))"
       authorization_header.should include(%Q(response="#{request_digest}"))
     end
   end
@@ -55,8 +53,9 @@ describe Net::HTTPHeader::DigestAuthenticator do
 
   context "with unspecified quality of protection (qop)" do
     before do
-      @digest = setup_digest({'www-authenticate' =>
-        'Digest realm="myhost@testrealm.com", nonce="NONCE"'})
+      @digest = setup_digest({
+        'www-authenticate' => 'Digest realm="myhost@testrealm.com", nonce="NONCE"',
+      })
     end
 
     it "should set prefix" do
@@ -84,9 +83,7 @@ describe Net::HTTPHeader::DigestAuthenticator do
     end
 
     it "should set response" do
-      request_digest =
-        "md5(md5(Mufasa:myhost@testrealm.com:Circle Of Life)" +
-        ":NONCE:md5(GET:/dir/index.html))"
+      request_digest = "md5(md5(Mufasa:myhost@testrealm.com:Circle Of Life):NONCE:md5(GET:/dir/index.html))"
       authorization_header.should include(%Q(response="#{request_digest}"))
     end
   end

data/spec/httparty/parser_spec.rb

@@ -87,6 +87,16 @@ describe HTTParty::Parser do
       @parser.stub(:body => nil)
       @parser.parse.should be_nil
     end
+
+    it "returns nil for a 'null' body" do
+      @parser.stub(:body => "null")
+      @parser.parse.should be_nil
+    end
+
+    it "returns nil for a body with spaces only" do
+      @parser.stub(:body => "   ")
+      @parser.parse.should be_nil
+    end
   end
 
   describe "#supports_format?" do
@@ -135,6 +145,12 @@ describe HTTParty::Parser do
     end
 
     it "parses json with MultiJson" do
+      MultiJson.should_receive(:load).with('body')
+      subject.send(:json)
+    end
+
+    it "uses MultiJson.decode if MultiJson does not respond to adapter" do
+      MultiJson.should_receive(:respond_to?).with(:adapter).and_return(false)
       MultiJson.should_receive(:decode).with('body')
       subject.send(:json)
     end

data/spec/httparty/request_spec.rb

@@ -86,7 +86,7 @@ describe HTTParty::Request do
     end
 
     it "should use digest auth when configured" do
-      FakeWeb.register_uri(:head, "http://api.foo.com/v1",
+      FakeWeb.register_uri(:get, "http://api.foo.com/v1",
         :www_authenticate => 'Digest realm="Log Viewer", qop="auth", nonce="2CA0EC6B0E126C4800E56BA0C0003D3C", opaque="5ccc069c403ebaf9f0171e9517f40e41", stale=false')
 
       @request.options[:digest_auth] = {:username => 'foobar', :password => 'secret'}
@@ -95,6 +95,17 @@ describe HTTParty::Request do
       raw_request = @request.instance_variable_get(:@raw_request)
       raw_request.instance_variable_get(:@header)['Authorization'].should_not be_nil
     end
+
+    it "should use the right http method for digest authentication" do
+      @post_request = HTTParty::Request.new(Net::HTTP::Post, 'http://api.foo.com/v1', :format => :xml)
+      FakeWeb.register_uri(:post, "http://api.foo.com/v1", {})
+
+      http = @post_request.send(:http)
+      @post_request.should_receive(:http).and_return(http)
+      http.should_not_receive(:head).and_return({'www-authenticate' => nil})
+      @post_request.options[:digest_auth] = {:username => 'foobar', :password => 'secret'}
+      @post_request.send(:setup_raw_request)
+    end
   end
 
   describe "#uri" do
@@ -216,6 +227,25 @@ describe HTTParty::Request do
           @request.send(:http)
         end
       end
+
+      context 'with a proxy' do
+        it 'should use a proxy address and port' do
+          request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com',
+            :http_proxyaddr => '1.2.3.4', :http_proxyport => 8080)
+          http = request.send(:http)
+          http.proxy_address.should == '1.2.3.4'
+          http.proxy_port.should == 8080
+        end
+
+        it 'should use a proxy user and password when provided' do
+          request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com',
+            :http_proxyaddr => '1.2.3.4', :http_proxyport => 8080,
+            :http_proxyuser => 'user', :http_proxypass => 'pass')
+          http = request.send(:http)
+          http.proxy_user.should == 'user'
+          http.proxy_pass.should == 'pass'
+        end
+      end
     end
 
     context "when setting timeout" do
@@ -381,6 +411,16 @@ describe HTTParty::Request do
         resp.body.should == "<foo><bar>error</bar></foo>"
         resp['foo']['bar'].should == "error"
       end
+
+      it "parses response lazily so codes can be checked prior" do
+        stub_response 'not xml', 500
+        @request.options[:format] = :xml
+        lambda {
+          response = @request.perform
+          response.code.should == 500
+          response.body.should == 'not xml'
+        }.should_not raise_error
+      end
     end
   end
 
@@ -426,6 +466,11 @@ describe HTTParty::Request do
         @request.perform.should == {"hash" => {"foo" => "bar"}}
       end
 
+      it "should be handled by PATCH transparently" do
+        @request.http_method = Net::HTTP::Patch
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
+
       it "should be handled by PUT transparently" do
         @request.http_method = Net::HTTP::Put
         @request.perform.should == {"hash" => {"foo" => "bar"}}
@@ -487,6 +532,40 @@ describe HTTParty::Request do
     end
   end
 
+  describe "#handle_deflation" do
+    context "context-encoding" do
+      before do
+        @request.options[:format] = :html
+        @last_response = mock()
+        @last_response.stub!(:body).and_return('')
+      end
+
+      it "should inflate the gzipped body with content-encoding: gzip" do
+        @last_response.stub!(:[]).with("content-encoding").and_return("gzip")
+        @request.stub!(:last_response).and_return(@last_response)
+        Zlib::GzipReader.should_receive(:new).and_return(StringIO.new(''))
+        @request.last_response.should_receive(:delete).with('content-encoding')
+        @request.send(:handle_deflation)
+      end
+
+      it "should inflate the gzipped body with content-encoding: x-gzip" do
+        @last_response.stub!(:[]).with("content-encoding").and_return("x-gzip")
+        @request.stub!(:last_response).and_return(@last_response)
+        Zlib::GzipReader.should_receive(:new).and_return(StringIO.new(''))
+        @request.last_response.should_receive(:delete).with('content-encoding')
+        @request.send(:handle_deflation)
+      end
+
+      it "should inflate the deflated body" do
+        @last_response.stub!(:[]).with("content-encoding").and_return("deflate")
+        @request.stub!(:last_response).and_return(@last_response)
+        Zlib::Inflate.should_receive(:inflate).and_return('')
+        @request.last_response.should_receive(:delete).with('content-encoding')
+        @request.send(:handle_deflation)
+      end
+    end
+  end
+
   context "with POST http method" do
     it "should raise argument error if query is not a hash" do
       lambda {