dnclabs-httparty 0.6.1.2010090201

data/features/steps/mongrel_helper.rb

@@ -0,0 +1,94 @@
+require 'base64'
+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)
+  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
+
+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
+
+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
+
+module BasicAuthentication
+  def self.extended(base)
+    base.custom_headers["WWW-Authenticate"] = 'Basic Realm="Super Secret Page"'
+  end
+
+  def process(request, response)
+    if authorized?(request)
+      super
+    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 process(request, response)
+    if authorized?(request)
+      super
+    else
+      reply_with(response, 401, "Incorrect.  You have 20 seconds to comply.")
+    end
+  end
+
+  def authorized?(request)
+    request.params["HTTP_AUTHORIZATION"] =~ /Digest.*uri=/
+  end
+end
+
+def new_mongrel_redirector(target_url, relative_path = false)
+  target_url = "http://#{@host_and_port}#{target_url}" unless relative_path
+  Mongrel::RedirectHandler.new(target_url)
+end

data/features/steps/remote_service_steps.rb

@@ -0,0 +1,69 @@
+Given /a remote service that returns '(.*)'/ do |response_body|
+  @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 = BasicMongrelHandler.new
+  @handler.response_code = code
+end
+
+Given /that service is accessed at the path '(.*)'/ do |path|
+  @server.register(path, @handler)
+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 }
+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|
+  @handler.content_type = content_type
+end
+
+Given /the response from the service has a body of '(.*)'/ do |response_body|
+  @handler.response_body = response_body
+end
+
+Given /the url '(.*)' redirects to '(.*)'/ do |redirection_url, target_url|
+  @server.register redirection_url, new_mongrel_redirector(target_url)
+end
+
+Given /that service is protected by Basic Authentication/ do
+  @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|
+  @handler.username = username
+  @handler.password = password
+end
+
+Given /a restricted page at '(.*)'/ do |url|
+  Given "a remote service that returns 'A response I will never see'"
+  And "that service is accessed at the path '#{url}'"
+  And "that service is protected by Basic Authentication"
+  And "that service requires the username 'something' with the password 'secret'"
+end
+
+# This joins the server thread, and halts cucumber, so you can actually hit the
+# server with a browser.  Runs until you kill it with Ctrl-c
+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_redirection.feature

@@ -0,0 +1,22 @@
+Feature: Supports Redirection
+
+  As a developer
+  I want to work with services that may redirect me
+  And I want it to follow a reasonable number of redirects
+  Because sometimes web services do that
+
+  Scenario: A service that redirects once
+    Given a remote service that returns 'Service Response'
+    And that service is accessed at the path '/landing_service.html'
+    And the url '/redirector.html' redirects to '/landing_service.html'
+    When I call HTTParty#get with '/redirector.html'
+    Then the return value should match 'Service Response'
+
+  # TODO: Look in to why this actually fails...
+  Scenario: A service that redirects to a relative URL
+
+  Scenario: A service that redirects infinitely
+    Given the url '/first.html' redirects to '/second.html'
+    And the url '/second.html' redirects to '/first.html'
+    When I call HTTParty#get with '/first.html'
+    Then it should raise an HTTParty::RedirectionTooDeep exception

data/features/supports_timeout_option.feature

@@ -0,0 +1,13 @@
+Feature: Supports the timeout option
+  In order to handle inappropriately slow response times
+  As a developer
+  I want my request to raise an exception after my specified timeout as elapsed
+
+  Scenario: A long running response
+    Given a remote service that returns '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/long_running_service.html'
+    And that service takes 2 seconds to generate a response
+    When I set my HTTParty timeout option to 1
+    And I call HTTParty#get with '/long_running_service.html'
+    Then it should raise a Timeout::Error exception
+    And I wait for the server to recover

data/httparty.gemspec

@@ -0,0 +1,146 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{httparty}
+  s.version = "0.6.1.hmac"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker", "Sandro Turriate"]
+  s.date = %q{2010-08-12}
+  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}
+  s.executables = ["httparty"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History",
+     "MIT-LICENSE",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/httparty",
+     "cucumber.yml",
+     "examples/aaws.rb",
+     "examples/basic.rb",
+     "examples/custom_parsers.rb",
+     "examples/delicious.rb",
+     "examples/google.rb",
+     "examples/rubyurl.rb",
+     "examples/twitter.rb",
+     "examples/whoismyrep.rb",
+     "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",
+     "features/steps/httparty_steps.rb",
+     "features/steps/mongrel_helper.rb",
+     "features/steps/remote_service_steps.rb",
+     "features/supports_redirection.feature",
+     "features/supports_timeout_option.feature",
+     "httparty.gemspec",
+     "lib/httparty.rb",
+     "lib/httparty/cookie_hash.rb",
+     "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",
+     "spec/fixtures/delicious.xml",
+     "spec/fixtures/empty.xml",
+     "spec/fixtures/google.html",
+     "spec/fixtures/ssl/generate.sh",
+     "spec/fixtures/ssl/generated/1fe462c2.0",
+     "spec/fixtures/ssl/generated/bogushost.crt",
+     "spec/fixtures/ssl/generated/ca.crt",
+     "spec/fixtures/ssl/generated/ca.key",
+     "spec/fixtures/ssl/generated/selfsigned.crt",
+     "spec/fixtures/ssl/generated/server.crt",
+     "spec/fixtures/ssl/generated/server.key",
+     "spec/fixtures/ssl/openssl-exts.cnf",
+     "spec/fixtures/twitter.json",
+     "spec/fixtures/twitter.xml",
+     "spec/fixtures/undefined_method_add_node_for_nil.xml",
+     "spec/httparty/cookie_hash_spec.rb",
+     "spec/httparty/parser_spec.rb",
+     "spec/httparty/request_spec.rb",
+     "spec/httparty/response_spec.rb",
+     "spec/httparty/ssl_spec.rb",
+     "spec/httparty_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/ssl_test_helper.rb",
+     "spec/support/ssl_test_server.rb",
+     "spec/support/stub_response.rb",
+     "website/css/common.css",
+     "website/index.html"
+  ]
+  s.homepage = %q{http://httparty.rubyforge.org}
+  s.post_install_message = %q{When you HTTParty, you must party hard!}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{httparty}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
+  s.test_files = [
+    "spec/httparty/cookie_hash_spec.rb",
+     "spec/httparty/parser_spec.rb",
+     "spec/httparty/request_spec.rb",
+     "spec/httparty/response_spec.rb",
+     "spec/httparty/ssl_spec.rb",
+     "spec/httparty_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/ssl_test_helper.rb",
+     "spec/support/ssl_test_server.rb",
+     "spec/support/stub_response.rb",
+     "examples/aaws.rb",
+     "examples/basic.rb",
+     "examples/custom_parsers.rb",
+     "examples/delicious.rb",
+     "examples/google.rb",
+     "examples/rubyurl.rb",
+     "examples/twitter.rb",
+     "examples/whoismyrep.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<crack>, ["= 0.1.8"])
+      s.add_development_dependency(%q<activesupport>, ["~> 2.3"])
+      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.3"])
+    else
+      s.add_dependency(%q<crack>, ["= 0.1.8"])
+      s.add_dependency(%q<activesupport>, ["~> 2.3"])
+      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.3"])
+    end
+  else
+    s.add_dependency(%q<crack>, ["= 0.1.8"])
+    s.add_dependency(%q<activesupport>, ["~> 2.3"])
+    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.3"])
+  end
+end
+

data/lib/httparty.rb

@@ -0,0 +1,365 @@
+require 'pathname'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'zlib'
+require 'crack'
+
+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.6.1".freeze
+  CRACK_DEPENDENCY = "0.1.8".freeze
+
+  module AllowedFormatsDeprecation
+    def const_missing(const)
+      if const.to_s =~ /AllowedFormats$/
+        Kernel.warn("Deprecated: Use HTTParty::Parser::SupportedFormats")
+        HTTParty::Parser::SupportedFormats
+      else
+        super
+      end
+    end
+  end
+
+  extend AllowedFormatsDeprecation
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, HTTParty::ModuleInheritableAttributes
+    base.send(:mattr_inheritable, :default_options)
+    base.send(:mattr_inheritable, :default_cookies)
+    base.instance_variable_set("@default_options", {})
+    base.instance_variable_set("@default_cookies", CookieHash.new)
+  end
+
+  module ClassMethods
+    extend AllowedFormatsDeprecation
+
+    # Allows setting http proxy information to be used
+    #
+    #   class Foo
+    #     include HTTParty
+    #     http_proxy 'http://foo.com', 80
+    #   end
+    def http_proxy(addr=nil, port = nil)
+      default_options[:http_proxyaddr] = addr
+      default_options[:http_proxyport] = port
+    end
+
+    # Allows setting a base uri to be used for each request.
+    # Will normalize uri to include http, etc.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     base_uri 'twitter.com'
+    #   end
+    def base_uri(uri=nil)
+      return default_options[:base_uri] unless uri
+      default_options[:base_uri] = HTTParty.normalize_base_uri(uri)
+    end
+
+    # Allows setting basic authentication username and password.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     basic_auth 'username', 'password'
+    #   end
+    def basic_auth(u, p)
+      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.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     default_params :api_key => 'secret', :another => 'foo'
+    #   end
+    def default_params(h={})
+      raise ArgumentError, 'Default params must be a hash' unless h.is_a?(Hash)
+      default_options[:default_params] ||= {}
+      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.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     debug_output $stderr
+    #   end
+    def debug_output(stream = $stderr)
+      default_options[:debug_output] = stream
+    end
+
+    # Allows setting HTTP headers to be used for each request.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     headers 'Accept' => 'text/html'
+    #   end
+    def headers(h={})
+      raise ArgumentError, 'Headers must be a hash' unless h.is_a?(Hash)
+      default_options[:headers] ||= {}
+      default_options[:headers].merge!(h)
+    end
+
+    def cookies(h={})
+      raise ArgumentError, 'Cookies must be a hash' unless h.is_a?(Hash)
+      default_cookies.add_cookies(h)
+    end
+
+    # Allows setting the format with which to parse.
+    # Must be one of the allowed formats ie: json, xml
+    #
+    #   class Foo
+    #     include HTTParty
+    #     format :json
+    #   end
+    def format(f = nil)
+      if f.nil?
+        default_options[:format]
+      else
+        parser(Parser) if parser.nil?
+        default_options[:format] = f
+        validate_format
+      end
+    end
+
+    # Declare whether or not to follow redirects.  When true, an
+    # {HTTParty::RedirectionTooDeep} error will raise upon encountering a
+    # redirect. You can then gain access to the response object via
+    # HTTParty::RedirectionTooDeep#response.
+    #
+    # @see HTTParty::ResponseError#response
+    #
+    # @example
+    #   class Foo
+    #     include HTTParty
+    #     base_uri 'http://google.com'
+    #     no_follow true
+    #   end
+    #
+    #   begin
+    #     Foo.get('/')
+    #   rescue HTTParty::RedirectionTooDeep => e
+    #     puts e.response.body
+    #   end
+    def no_follow(value = false)
+      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
+    #     include HTTParty
+    #     pem File.read('/home/user/my.pem')
+    #   end
+    def pem(pem_contents)
+      default_options[:pem] = pem_contents
+    end
+
+    # Allows setting an OpenSSL certificate authority file
+    #
+    #   class Foo
+    #     include HTTParty
+    #     ssl_ca_file '/etc/ssl/certs/ca-certificates.crt'
+    #   end
+    def ssl_ca_file(path)
+      default_options[:ssl_ca_file] = path
+    end
+
+    # Allows setting an OpenSSL certificate authority path (directory)
+    #
+    #   class Foo
+    #     include HTTParty
+    #     ssl_ca_path '/etc/ssl/certs/'
+    #   end
+    def ssl_ca_path(path)
+      default_options[:ssl_ca_path] = path
+    end
+
+    # Allows setting a custom parser for the response.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     parser Proc.new {|data| ...}
+    #   end
+    def parser(custom_parser = nil)
+      if custom_parser.nil?
+        default_options[:parser]
+      else
+        default_options[:parser] = custom_parser
+        validate_format
+      end
+    end
+
+    # Allows making a get request to a url.
+    #
+    #   class Foo
+    #     include HTTParty
+    #   end
+    #
+    #   # Simple get with full url
+    #   Foo.get('http://foo.com/resource.json')
+    #
+    #   # 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
+    end
+
+    # Allows making a post request to a url.
+    #
+    #   class Foo
+    #     include HTTParty
+    #   end
+    #
+    #   # Simple post with full url and setting the body
+    #   Foo.post('http://foo.com/resources', :body => {:bar => 'baz'})
+    #
+    #   # 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
+    end
+
+    # Perform a PUT request to a path
+    def put(path, options={})
+      perform_request Net::HTTP::Put, path, options
+    end
+
+    # Perform a DELETE request to a path
+    def delete(path, options={})
+      perform_request Net::HTTP::Delete, path, options
+    end
+
+    # Perform a HEAD request to a path
+    def head(path, options={})
+      perform_request Net::HTTP::Head, path, options
+    end
+
+    # Perform an OPTIONS request to a path
+    def options(path, options={})
+      perform_request Net::HTTP::Options, path, options
+    end
+
+    def default_options #:nodoc:
+      @default_options
+    end
+
+    private
+
+      def perform_request(http_method, path, options) #:nodoc:
+        options = default_options.dup.merge(options)
+        process_cookies(options)
+        Request.new(http_method, path, options).perform
+      end
+
+      def process_cookies(options) #:nodoc:
+        return unless options[:cookies] || default_cookies.any?
+        options[:headers] ||= headers.dup
+        options[:headers]["cookie"] = cookies.merge(options.delete(:cookies) || {}).to_cookie_string
+      end
+
+      def validate_format
+        if format && parser.respond_to?(:supports_format?) && !parser.supports_format?(format)
+          raise UnsupportedFormat, "'#{format.inspect}' Must be one of: #{parser.supported_formats.map{|f| f.to_s}.sort.join(', ')}"
+        end
+      end
+  end
+
+  def self.normalize_base_uri(url) #:nodoc:
+    normalized_url = url.dup
+    use_ssl = (normalized_url =~ /^https/) || normalized_url.include?(':443')
+    ends_with_slash = normalized_url =~ /\/$/
+
+    normalized_url.chop! if ends_with_slash
+    normalized_url.gsub!(/^https?:\/\//i, '')
+
+    "http#{'s' if use_ssl}://#{normalized_url}"
+  end
+
+  class Basement #:nodoc:
+    include HTTParty
+  end
+
+  def self.get(*args)
+    Basement.get(*args)
+  end
+
+  def self.post(*args)
+    Basement.post(*args)
+  end
+
+  def self.put(*args)
+    Basement.put(*args)
+  end
+
+  def self.delete(*args)
+    Basement.delete(*args)
+  end
+
+  def self.head(*args)
+    Basement.head(*args)
+  end
+
+  def self.options(*args)
+    Basement.options(*args)
+  end
+
+end
+
+require dir + 'httparty/core_extensions'
+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