httparty 0.8.1 → 0.8.2

data/History

@@ -1,3 +1,20 @@
+== 0.8.2 2012-04-12
+* new
+  * add -r to make CLI return failure code if status >= 400
+  * allow blank username from CLI
+* bug fixes
+  * return nil for null body
+  * automatically deflate responses with a Content-Encoding: x-gzip header
+  * Do not HEAD on POST request with digest authentication
+  * add support for proxy authentication
+  * fix posting data with CLI
+  * require rexml/document if xml format from CLI
+  * support for fragmented responses
+
+== 0.8.1 2011-10-05
+* bug fixes
+  * content-encoding header should be removed when automatically inflating the body
+
 == 0.8.0 2011-09-13
 * new
   * switch to multi json/xml for parsing by default

data/README.rdoc

@@ -49,6 +49,7 @@ options. Below is an example of how easy it is.
 
 * sudo gem install httparty
 
-== Docs
+== Help and Docs
 
-http://rdoc.info/projects/jnunemaker/httparty
+* https://groups.google.com/forum/#!forum/httparty-gem
+* http://rdoc.info/projects/jnunemaker/httparty

data/bin/httparty

@@ -32,9 +32,9 @@ OptionParser.new do |o|
        "--data [BODY]",
        "Data to put in request body (prefix with '@' for file)") do |d|
     if d =~ /^@/
-      opts[:data] = open(d[1..-1]).read
+      opts[:body] = open(d[1..-1]).read
     else
-      opts[:data] = d
+      opts[:body] = d
     end
   end
 
@@ -49,11 +49,15 @@ OptionParser.new do |o|
   end
 
   o.on("-u", "--user [CREDS]", "Use basic authentication. Value should be user:password") do |u|
-    abort "Invalid credentials format. Must be user:password" unless u =~ /.+:.+/
+    abort "Invalid credentials format. Must be user:password" unless u =~ /.*:.+/
     user, password = u.split(':')
     opts[:basic_auth] = { :username => user, :password => password }
   end
 
+  o.on("-r", "--response-code", "Command fails if response code >= 400") do
+    opts[:response_code] = true
+  end
+
   o.on("-h", "--help", "Show help documentation") do |h|
     puts o
     exit
@@ -100,9 +104,11 @@ else
         puts YAML.dump(response.delegate)
       end
     when :xml
+      require 'rexml/document'
       REXML::Document.new(response.body).write(STDOUT, 2)
       puts
     else
       puts response
   end
 end
+exit false if opts[:response_code] && response.code >= 400

data/examples/headers_and_user_agents.rb

@@ -0,0 +1,6 @@
+# To send custom user agents to identify your application to a web service (or mask as a specific browser for testing), send "User-Agent" as a hash to headers as shown below.
+
+require 'httparty'
+
+APPLICATION_NAME = "Httparty" 
+response = HTTParty.get('http://example.com', :headers => {"User-Agent" => APPLICATION_NAME})

data/examples/nokogiri_html_parser.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'nokogiri'
+
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class HtmlParserIncluded < HTTParty::Parser
+  SupportedFormats.merge!('text/html' => :html)
+
+  def html
+    Nokogiri::HTML(body)
+  end
+end
+
+class Page
+  include HTTParty
+  parser HtmlParserIncluded
+end
+
+pp Page.get('http://www.google.com')

data/features/steps/remote_service_steps.rb

@@ -14,7 +14,7 @@ end
 
 Given /^that service takes (\d+) seconds to generate a response$/ do |time|
   @server_response_time = time.to_i
-  @handler.preprocessor = lambda { sleep time.to_i }
+  @handler.preprocessor = Proc.new { sleep time.to_i }
 end
 
 Given /^a remote deflate service$/ do

data/lib/httparty.rb

@@ -41,6 +41,8 @@ module HTTParty
   # [:+body+:] Body of the request. If passed a Hash, will try to normalize it first, by default passing it to ActiveSupport::to_params. Any other kind of object will get used as-is.
   # [:+http_proxyaddr+:] Address of proxy server to use.
   # [:+http_proxyport+:]  Port of proxy server to use.
+  # [:+http_proxyuser+:] User for proxy server authentication.
+  # [:+http_proxypass+:] Password for proxy server authentication.
   # [:+limit+:] Maximum number of redirects to follow. Takes precedences over :+no_follow+.
   # [:+query+:] Query string, or a Hash representing it. Normalized according to the same rules as :+body+. If you specify this on a POST, you must use a Hash. See also HTTParty::ClassMethods.default_params.
   # [:+timeout+:] Timeout for opening connection and reading data.
@@ -67,11 +69,13 @@ module HTTParty
     #
     #   class Foo
     #     include HTTParty
-    #     http_proxy 'http://foo.com', 80
+    #     http_proxy 'http://foo.com', 80, 'user', 'pass'
     #   end
-    def http_proxy(addr=nil, port = nil)
+    def http_proxy(addr=nil, port=nil, user=nil, pass=nil)
       default_options[:http_proxyaddr] = addr
       default_options[:http_proxyport] = port
+      default_options[:http_proxyuser] = user
+      default_options[:http_proxypass] = pass
     end
 
     # Allows setting a base uri to be used for each request.
@@ -339,8 +343,8 @@ module HTTParty
     #   # Simple get with full url and query parameters
     #   # ie: http://foo.com/resource.json?limit=10
     #   Foo.get('http://foo.com/resource.json', :query => {:limit => 10})
-    def get(path, options={})
-      perform_request Net::HTTP::Get, path, options
+    def get(path, options={}, &block)
+      perform_request Net::HTTP::Get, path, options, &block
     end
 
     # Allows making a post request to a url.
@@ -355,28 +359,28 @@ module HTTParty
     #   # Simple post with full url using :query option,
     #   # which gets set as form data on the request.
     #   Foo.post('http://foo.com/resources', :query => {:bar => 'baz'})
-    def post(path, options={})
-      perform_request Net::HTTP::Post, path, options
+    def post(path, options={}, &block)
+      perform_request Net::HTTP::Post, path, options, &block
     end
 
     # Perform a PUT request to a path
-    def put(path, options={})
-      perform_request Net::HTTP::Put, path, options
+    def put(path, options={}, &block)
+      perform_request Net::HTTP::Put, path, options, &block
     end
 
     # Perform a DELETE request to a path
-    def delete(path, options={})
-      perform_request Net::HTTP::Delete, path, options
+    def delete(path, options={}, &block)
+      perform_request Net::HTTP::Delete, path, options, &block
     end
 
     # Perform a HEAD request to a path
-    def head(path, options={})
-      perform_request Net::HTTP::Head, path, options
+    def head(path, options={}, &block)
+      perform_request Net::HTTP::Head, path, options, &block
     end
 
     # Perform an OPTIONS request to a path
-    def options(path, options={})
-      perform_request Net::HTTP::Options, path, options
+    def options(path, options={}, &block)
+      perform_request Net::HTTP::Options, path, options, &block
     end
 
     def default_options #:nodoc:
@@ -385,10 +389,10 @@ module HTTParty
 
     private
 
-      def perform_request(http_method, path, options) #:nodoc:
+      def perform_request(http_method, path, options, &block) #:nodoc:
         options = default_options.dup.merge(options)
         process_cookies(options)
-        Request.new(http_method, path, options).perform
+        Request.new(http_method, path, options).perform(&block)
       end
 
       def process_cookies(options) #:nodoc:
@@ -419,28 +423,28 @@ module HTTParty
     include HTTParty
   end
 
-  def self.get(*args)
-    Basement.get(*args)
+  def self.get(*args, &block)
+    Basement.get(*args, &block)
   end
 
-  def self.post(*args)
-    Basement.post(*args)
+  def self.post(*args, &block)
+    Basement.post(*args, &block)
   end
 
-  def self.put(*args)
-    Basement.put(*args)
+  def self.put(*args, &block)
+    Basement.put(*args, &block)
   end
 
-  def self.delete(*args)
-    Basement.delete(*args)
+  def self.delete(*args, &block)
+    Basement.delete(*args, &block)
   end
 
-  def self.head(*args)
-    Basement.head(*args)
+  def self.head(*args, &block)
+    Basement.head(*args, &block)
   end
 
-  def self.options(*args)
-    Basement.options(*args)
+  def self.options(*args, &block)
+    Basement.options(*args, &block)
   end
 end
 

data/lib/httparty/parser.rb

@@ -96,9 +96,9 @@ module HTTParty
     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

data/lib/httparty/request.rb

@@ -67,10 +67,23 @@ module HTTParty
       options[:parser]
     end
 
-    def perform
+    def perform(&block)
       validate
       setup_raw_request
-      self.last_response = http.request(@raw_request)
+
+      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
+
+          http_response.body = chunks.join
+        end
+      end
+
       handle_deflation
       handle_response
     end
@@ -102,7 +115,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 +173,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
@@ -196,7 +212,7 @@ module HTTParty
     # 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')

data/lib/httparty/response.rb

@@ -3,7 +3,7 @@ module HTTParty
     class Headers
       include ::Net::HTTPHeader
 
-      def initialize(header)
+      def initialize(header = {})
         @header = header
       end
 

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 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

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
@@ -495,7 +525,7 @@ describe HTTParty::Request do
         @last_response.stub!(:body).and_return('')
       end
 
-      it "should inflate the gzipped body" do
+      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(''))
@@ -503,6 +533,14 @@ describe HTTParty::Request do
         @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)

data/spec/httparty/response_spec.rb

@@ -190,4 +190,11 @@ describe HTTParty::Response do
       end
     end
   end
+
+  describe "headers" do
+    it "can initialize without headers" do
+      headers = HTTParty::Response::Headers.new
+      headers.should == {}
+    end
+  end
 end

data/spec/httparty_spec.rb

@@ -19,7 +19,7 @@ describe HTTParty do
       HTTParty::AllowedFormats.should == HTTParty::Parser::SupportedFormats
     end
   end
-  
+
   describe "pem" do
 
     it 'should set the pem content' do
@@ -39,6 +39,22 @@ describe HTTParty do
 
   end
 
+  describe 'http_proxy' do
+    it 'should set the address' do
+      @klass.http_proxy 'proxy.foo.com', 80
+      options = @klass.default_options
+      options[:http_proxyaddr].should == 'proxy.foo.com'
+      options[:http_proxyport].should == 80
+    end
+
+    it 'should set the proxy user and pass when they are provided' do
+      @klass.http_proxy 'proxy.foo.com', 80, 'user', 'pass'
+      options = @klass.default_options
+      options[:http_proxyuser].should == 'user'
+      options[:http_proxypass].should == 'pass'
+    end
+  end
+
   describe "base uri" do
     before(:each) do
       @klass.base_uri('api.foo.com/v1')
@@ -546,6 +562,15 @@ describe HTTParty do
       HTTParty.get('http://www.google.com').should == file_fixture('google.html')
     end
 
+    it "should be able to get chunked html" do
+      chunks = ["Chunk1", "Chunk2", "Chunk3", "Chunk4"]
+      stub_chunked_http_response_with(chunks)
+
+      HTTParty.get('http://www.google.com') do |fragment|
+        chunks.should include(fragment)
+      end.should == chunks.join
+    end
+
     it "should be able parse response type json automatically" do
       stub_http_response_with('twitter.json')
       tweets = HTTParty.get('http://twitter.com/statuses/public_timeline.json')

data/spec/support/stub_response.rb

@@ -13,6 +13,19 @@ module HTTParty
       HTTParty::Request.should_receive(:new).and_return(http_request)
     end
 
+    def stub_chunked_http_response_with(chunks)
+      response = Net::HTTPResponse.new("1.1", 200, nil)
+      response.stub(:chunked_data).and_return(chunks)
+      def response.read_body(&block)
+        @body || chunked_data.each(&block)
+      end
+
+      http_request = HTTParty::Request.new(Net::HTTP::Get, 'http://localhost', :format => "html")
+      http_request.stub_chain(:http, :request).and_yield(response).and_return(response)
+
+      HTTParty::Request.should_receive(:new).and_return(http_request)
+    end
+
     def stub_response(body, code = 200)
       @request.options[:base_uri] ||= 'http://localhost'
       unless defined?(@http) && @http

metadata

@@ -1,61 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: httparty
-version: !ruby/object:Gem::Version 
-  hash: 61
+version: !ruby/object:Gem::Version
+  version: 0.8.2
   prerelease: 
-  segments: 
-  - 0
-  - 8
-  - 1
-  version: 0.8.1
 platform: ruby
-authors: 
+authors:
 - John Nunemaker
 - Sandro Turriate
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: multi_json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70278647636880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: multi_xml
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70278647636880
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &70278647636320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70278647636320
 description: Makes http fun! Also, makes consuming restful web services dead easy.
-email: 
+email:
 - nunemaker@gmail.com
-executables: 
+executables:
 - httparty
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - History
@@ -70,6 +56,8 @@ files:
 - examples/custom_parsers.rb
 - examples/delicious.rb
 - examples/google.rb
+- examples/headers_and_user_agents.rb
+- examples/nokogiri_html_parser.rb
 - examples/rubyurl.rb
 - examples/tripit_sign_in.rb
 - examples/twitter.rb
@@ -130,38 +118,29 @@ files:
 - website/index.html
 homepage: http://httparty.rubyforge.org/
 licenses: []
-
 post_install_message: When you HTTParty, you must party hard!
 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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Makes http fun! Also, makes consuming restful web services dead easy.
-test_files: 
+test_files:
 - features/basic_authentication.feature
 - features/command_line.feature
 - features/deals_with_http_error_codes.feature