httparty 0.5.2 → 0.6.0

data/History

@@ -1,3 +1,21 @@
+== 0.6.0 2010-06-13
+* major enhancements
+  * Digest Auth (bartiaco, sbecker, gilles, and aaronrussell)
+  * Maintain HTTP method across redirects (bartiaco and sbecker)
+  * HTTParty::Response#response returns the Net::HTTPResponse object
+  * HTTParty::Response#headers returns a HTTParty::Response::Headers object
+    which quacks like a Hash + Net::HTTPHeader. The #headers method continues
+    to be backwards-compatible with the old Hash return value but may become
+    deprecated in the future.
+
+* minor enhancements
+  * Update crack requirement to version 0.1.7
+    You may still get a warning because Crack's version constant is out of date
+  * Timeout option can be set for all requests using HTTParty.default_timeout (taazza)
+  * Closed #38 "headers hash should downcase keys so canonical header name can be used"
+  * Closed #40 "Gzip response" wherein gziped and deflated responses are
+    automatically inflated. (carsonmcdonald)
+
 == 0.5.2 2010-01-31
 * minor enhancements
   * Update crack requirement to version 0.1.6

data/Rakefile

@@ -9,12 +9,12 @@ begin
     gem.email = "nunemaker@gmail.com"
     gem.homepage = "http://httparty.rubyforge.org"
     gem.authors = ["John Nunemaker", "Sandro Turriate"]
-    gem.add_dependency 'crack', '0.1.6'
+    gem.add_dependency 'crack', '0.1.7'
     gem.add_development_dependency "activesupport", "~>2.3"
-    gem.add_development_dependency "cucumber", "~>0.4"
+    gem.add_development_dependency "cucumber", "~>0.7"
     gem.add_development_dependency "fakeweb", "~>1.2"
     gem.add_development_dependency "mongrel", "~>1.1"
-    gem.add_development_dependency "rspec", "1.2.9"
+    gem.add_development_dependency "rspec", "~>1.3"
     gem.post_install_message = "When you HTTParty, you must party hard!"
     gem.rubyforge_project = 'httparty'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.6.0

data/examples/aaws.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'activesupport'
+require 'active_support'
 
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
@@ -29,4 +29,4 @@ module AAWS
 end
 
 aaws = AAWS::Book.new(config[:access_key])
-pp aaws.search(:query => {:title => 'Ruby On Rails'})
+pp aaws.search(:query => {:title => 'Ruby On Rails'})

data/features/digest_authentication.feature

@@ -0,0 +1,20 @@
+Feature:  Digest Authentication
+
+  As a developer
+  I want to be able to use a service that requires Digest Authentication
+  Because that is not an uncommon requirement
+
+  Scenario: Passing no credentials to a page requiring Digest Authentication
+    Given a restricted page at '/protected.html'
+    When I call HTTParty#get with '/protected.html'
+    Then it should return a response with a 401 response code
+
+  Scenario: Passing proper credentials to a page requiring Digest Authentication
+    Given a remote service that returns 'Digest Authenticated Page'
+    And that service is accessed at the path '/protected.html'
+    And that service is protected by Digest Authentication
+    And that service requires the username 'jcash' with the password 'maninblack'
+    When I call HTTParty#get with '/protected.html' and a digest_auth hash:
+       | username | password   |
+       | jcash    | maninblack |
+    Then the return value should match 'Digest Authenticated Page'

data/features/handles_compressed_responses.feature

@@ -0,0 +1,19 @@
+Feature: Handles Compressed Responses
+
+  In order to save bandwidth
+  As a developer
+  I want to uncompress compressed responses
+
+  Scenario: Supports deflate encoding
+    Given a remote deflate service
+    And the response from the service has a body of '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/service.html'
+    When I call HTTParty#get with '/service.html'
+    Then the return value should match '<h1>Some HTML</h1>'
+
+  Scenario: Supports gzip encoding
+    Given a remote gzip service
+    And the response from the service has a body of '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/service.html'
+    When I call HTTParty#get with '/service.html'
+    Then the return value should match '<h1>Some HTML</h1>'

data/features/steps/env.rb

@@ -1,10 +1,17 @@
 require 'mongrel'
-require 'activesupport'
+require 'active_support'
 require 'lib/httparty'
 require 'spec/expectations'
 
 Before do
-  port = ENV["HTTPARTY_PORT"] || 31981
+  def new_port
+    server = TCPServer.new('0.0.0.0', nil)
+    port = server.addr[1]
+  ensure
+    server.close
+  end
+
+  port = ENV["HTTPARTY_PORT"] || new_port
   @host_and_port = "0.0.0.0:#{port}"
   @server = Mongrel::HttpServer.new("0.0.0.0", port)
   @server.run

data/features/steps/httparty_steps.rb

@@ -17,3 +17,11 @@ When /I call HTTParty#get with '(.*)' and a basic_auth hash:/ do |url, auth_tabl
     :basic_auth => { :username => h["username"], :password => h["password"] }
   )
 end
+
+When /I call HTTParty#get with '(.*)' and a digest_auth hash:/ do |url, auth_table|
+  h = auth_table.hashes.first
+  @response_from_httparty = HTTParty.get(
+    "http://#{@host_and_port}#{url}",
+    :digest_auth => { :username => h["username"], :password => h["password"] }
+  )
+end

data/features/steps/mongrel_helper.rb

@@ -1,53 +1,90 @@
-def basic_mongrel_handler
-  Class.new(Mongrel::HttpHandler) do
-    attr_writer :content_type, :response_body, :response_code, :preprocessor
-
-    def initialize
-      @content_type = "text/html"
-      @response_body = ""
-      @response_code = 200
-      @custom_headers = {}
-    end
+class BasicMongrelHandler < Mongrel::HttpHandler
+  attr_accessor :content_type, :custom_headers, :response_body, :response_code, :preprocessor, :username, :password
+
+  def initialize
+    @content_type = "text/html"
+    @response_body = ""
+    @response_code = 200
+    @custom_headers = {}
+  end
 
-    def process(request, response)
-      instance_eval &@preprocessor if @preprocessor
-      reply_with(response, @response_code, @response_body)
+  def process(request, response)
+    instance_eval &preprocessor if preprocessor
+    reply_with(response, response_code, response_body)
+  end
+
+  def reply_with(response, code, response_body)
+    response.start(code) do |head, body|
+      head["Content-Type"] = content_type
+      custom_headers.each { |k,v| head[k] = v }
+      body.write(response_body)
     end
+  end
+end
 
-    def reply_with(response, code, response_body)
-      response.start(code) do |head, body|
-        head["Content-Type"] = @content_type
-        @custom_headers.each { |k,v| head[k] = v }
-        body.write(response_body)
-      end
+class DeflateHandler < BasicMongrelHandler
+  def process(request, response)
+    response.start do |head, body|
+      head['Content-Encoding'] = 'deflate'
+      body.write Zlib::Deflate.deflate(response_body)
     end
   end
 end
 
-def new_mongrel_handler
-  basic_mongrel_handler.new
+class GzipHandler < BasicMongrelHandler
+  def process(request, response)
+    response.start do |head, body|
+      head['Content-Encoding'] = 'gzip'
+      body.write gzip(response_body)
+    end
+  end
+
+  protected
+
+  def gzip(string)
+    sio = StringIO.new('', 'r+')
+    gz = Zlib::GzipWriter.new sio
+    gz.write string
+    gz.finish
+    sio.rewind
+    sio.read
+  end
 end
 
-def add_basic_authentication_to(handler)
-  m = Module.new do
-    attr_writer :username, :password
+module BasicAuthentication
+  def self.extended(base)
+    base.custom_headers["WWW-Authenticate"] = 'Basic Realm="Super Secret Page"'
+  end
 
-    def self.extended(base)
-      base.instance_eval { @custom_headers["WWW-Authenticate"] = 'Basic Realm="Super Secret Page"' }
-      base.class_eval { alias_method_chain :process, :basic_authentication }
+  def process(request, response)
+    if authorized?(request)
+      super
+    else
+      reply_with(response, 401, "Incorrect.  You have 20 seconds to comply.")
     end
+  end
 
-    def process_with_basic_authentication(request, response)
-      if authorized?(request) then process_without_basic_authentication(request, response)
-      else reply_with(response, 401, "Incorrect.  You have 20 seconds to comply.")
-      end
-    end
+  def authorized?(request)
+    request.params["HTTP_AUTHORIZATION"] == "Basic " + Base64.encode64("#{@username}:#{@password}").strip
+  end
+end
+
+module DigestAuthentication
+  def self.extended(base)
+    base.custom_headers["WWW-Authenticate"] = 'Digest realm="testrealm@host.com",qop="auth,auth-int",nonce="nonce",opaque="opaque"'
+  end
 
-    def authorized?(request)
-      request.params["HTTP_AUTHORIZATION"] == "Basic " + Base64.encode64("#{@username}:#{@password}").strip
+  def process(request, response)
+    if authorized?(request)
+      super
+    else
+      reply_with(response, 401, "Incorrect.  You have 20 seconds to comply.")
     end
   end
-  handler.extend(m)
+
+  def authorized?(request)
+    request.params["HTTP_AUTHORIZATION"] =~ /Digest.*uri=/
+  end
 end
 
 def new_mongrel_redirector(target_url, relative_path = false)

data/features/steps/remote_service_steps.rb

@@ -1,10 +1,10 @@
 Given /a remote service that returns '(.*)'/ do |response_body|
-  @handler = new_mongrel_handler
+  @handler = BasicMongrelHandler.new
   Given "the response from the service has a body of '#{response_body}'"
 end
 
 Given /a remote service that returns a (\d+) status code/ do |code|
-  @handler = new_mongrel_handler
+  @handler = BasicMongrelHandler.new
   @handler.response_code = code
 end
 
@@ -13,8 +13,16 @@ Given /that service is accessed at the path '(.*)'/ do |path|
 end
 
 Given /^that service takes (\d+) seconds to generate a response$/ do |time|
-  preprocessor = lambda { sleep time.to_i }
-  @handler.preprocessor = preprocessor
+  @server_response_time = time.to_i
+  @handler.preprocessor = lambda { sleep time.to_i }
+end
+
+Given /^a remote deflate service$/ do
+  @handler = DeflateHandler.new
+end
+
+Given /^a remote gzip service$/ do
+  @handler = GzipHandler.new
 end
 
 Given /the response from the service has a Content-Type of '(.*)'/ do |content_type|
@@ -30,7 +38,11 @@ Given /the url '(.*)' redirects to '(.*)'/ do |redirection_url, target_url|
 end
 
 Given /that service is protected by Basic Authentication/ do
-  add_basic_authentication_to @handler
+  @handler.extend BasicAuthentication
+end
+
+Given /that service is protected by Digest Authentication/ do
+  @handler.extend DigestAuthentication
 end
 
 Given /that service requires the username '(.*)' with the password '(.*)'/ do |username, password|
@@ -50,3 +62,8 @@ end
 Given /I want to hit this in a browser/ do
   @server.acceptor.join
 end
+
+Then /I wait for the server to recover/ do
+  timeout = @request_options[:timeout] || 0
+  sleep @server_response_time - timeout
+end

data/features/supports_timeout_option.feature

@@ -10,3 +10,4 @@ Feature: Supports the timeout option
     When I set my HTTParty timeout option to 1
     And I call HTTParty#get with '/service.html'
     Then it should raise a Timeout::Error exception
+    And I wait for the server to recover

data/httparty.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{httparty}
-  s.version = "0.5.2"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker", "Sandro Turriate"]
-  s.date = %q{2010-01-31}
+  s.date = %q{2010-06-13}
   s.default_executable = %q{httparty}
   s.description = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.email = %q{nunemaker@gmail.com}
@@ -38,6 +38,8 @@ Gem::Specification.new do |s|
      "features/basic_authentication.feature",
      "features/command_line.feature",
      "features/deals_with_http_error_codes.feature",
+     "features/digest_authentication.feature",
+     "features/handles_compressed_responses.feature",
      "features/handles_multiple_formats.feature",
      "features/steps/env.rb",
      "features/steps/httparty_response_steps.rb",
@@ -52,6 +54,7 @@ Gem::Specification.new do |s|
      "lib/httparty/core_extensions.rb",
      "lib/httparty/exceptions.rb",
      "lib/httparty/module_inheritable_attributes.rb",
+     "lib/httparty/net_digest_auth.rb",
      "lib/httparty/parser.rb",
      "lib/httparty/request.rb",
      "lib/httparty/response.rb",
@@ -77,7 +80,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{httparty}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.test_files = [
     "spec/httparty/cookie_hash_spec.rb",
@@ -102,27 +105,27 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<crack>, ["= 0.1.6"])
+      s.add_runtime_dependency(%q<crack>, ["= 0.1.7"])
       s.add_development_dependency(%q<activesupport>, ["~> 2.3"])
-      s.add_development_dependency(%q<cucumber>, ["~> 0.4"])
+      s.add_development_dependency(%q<cucumber>, ["~> 0.7"])
       s.add_development_dependency(%q<fakeweb>, ["~> 1.2"])
       s.add_development_dependency(%q<mongrel>, ["~> 1.1"])
-      s.add_development_dependency(%q<rspec>, ["= 1.2.9"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3"])
     else
-      s.add_dependency(%q<crack>, ["= 0.1.6"])
+      s.add_dependency(%q<crack>, ["= 0.1.7"])
       s.add_dependency(%q<activesupport>, ["~> 2.3"])
-      s.add_dependency(%q<cucumber>, ["~> 0.4"])
+      s.add_dependency(%q<cucumber>, ["~> 0.7"])
       s.add_dependency(%q<fakeweb>, ["~> 1.2"])
       s.add_dependency(%q<mongrel>, ["~> 1.1"])
-      s.add_dependency(%q<rspec>, ["= 1.2.9"])
+      s.add_dependency(%q<rspec>, ["~> 1.3"])
     end
   else
-    s.add_dependency(%q<crack>, ["= 0.1.6"])
+    s.add_dependency(%q<crack>, ["= 0.1.7"])
     s.add_dependency(%q<activesupport>, ["~> 2.3"])
-    s.add_dependency(%q<cucumber>, ["~> 0.4"])
+    s.add_dependency(%q<cucumber>, ["~> 0.7"])
     s.add_dependency(%q<fakeweb>, ["~> 1.2"])
     s.add_dependency(%q<mongrel>, ["~> 1.1"])
-    s.add_dependency(%q<rspec>, ["= 1.2.9"])
+    s.add_dependency(%q<rspec>, ["~> 1.3"])
   end
 end
 

data/lib/httparty.rb

@@ -1,19 +1,19 @@
 require 'pathname'
 require 'net/http'
 require 'net/https'
+require 'uri'
+require 'zlib'
 require 'crack'
 
-if Crack::VERSION != "0.1.6"
-  warn "warning: HTTParty depends on version 0.1.6 of crack, not #{Crack::VERSION}."
-end
-
 dir = Pathname(__FILE__).dirname.expand_path
 
 require dir + 'httparty/module_inheritable_attributes'
 require dir + 'httparty/cookie_hash'
+require dir + 'httparty/net_digest_auth'
 
 module HTTParty
-  VERSION = "0.5.2".freeze
+  VERSION = "0.6.0".freeze
+  CRACK_DEPENDENCY = "0.1.7".freeze
 
   module AllowedFormatsDeprecation
     def const_missing(const)
@@ -73,6 +73,16 @@ module HTTParty
       default_options[:basic_auth] = {:username => u, :password => p}
     end
 
+    # Allows setting digest authentication username and password.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     digest_auth 'username', 'password'
+    #   end
+    def digest_auth(u, p)
+      default_options[:digest_auth] = {:username => u, :password => p}
+    end
+
     # Allows setting default parameters to be appended to each request.
     # Great for api keys and such.
     #
@@ -86,6 +96,18 @@ module HTTParty
       default_options[:default_params].merge!(h)
     end
 
+    # Allows setting a default timeout for all HTTP calls
+    # Timeout is specified in seconds.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     default_timeout 10
+    #   end
+    def default_timeout(t)
+      raise ArgumentError, 'Timeout must be an integer' unless t && t.is_a?(Integer)
+      default_options[:timeout] = t
+    end
+
     # Set an output stream for debugging, defaults to $stderr.
     # The output stream is passed on to Net::HTTP#set_debug_output.
     #
@@ -97,7 +119,7 @@ module HTTParty
       default_options[:debug_output] = stream
     end
 
-    # Allows setting a base uri to be used for each request.
+    # Allows setting HTTP headers to be used for each request.
     #
     #   class Foo
     #     include HTTParty
@@ -154,6 +176,21 @@ module HTTParty
       default_options[:no_follow] = value
     end
 
+    # Declare that you wish to maintain the chosen HTTP method across redirects.
+    # The default behavior is to follow redirects via the GET method.
+    # If you wish to maintain the original method, you can set this option to true.
+    #
+    # @example
+    #   class Foo
+    #     include HTTParty
+    #     base_uri 'http://google.com'
+    #     maintain_method_across_redirects true
+    #   end
+
+    def maintain_method_across_redirects(value = true)
+      default_options[:maintain_method_across_redirects] = value
+    end
+
     # Allows setting a PEM file to be used
     #
     #   class Foo
@@ -302,3 +339,7 @@ require dir + 'httparty/exceptions'
 require dir + 'httparty/parser'
 require dir + 'httparty/request'
 require dir + 'httparty/response'
+
+if Crack::VERSION != HTTParty::CRACK_DEPENDENCY
+  warn "warning: HTTParty depends on version #{HTTParty::CRACK_DEPENDENCY} of crack, not #{Crack::VERSION}."
+end