httparty 0.4.5 → 0.5.0

data/History

@@ -1,3 +1,21 @@
+== 0.5.0 2009-12-07
+* bug fixes
+  * inheritable attributes no longer mutable by subclasses (yyyc514)
+  * namespace BasicObject within HTTParty to avoid class name collisions (eric)
+
+* major enhancements
+  * Custom Parsers via class or proc
+  * Deprecation warning on HTTParty::AllowedFormats
+    moved to HTTParty::Parser::SupportedFormats
+
+* minor enhancements
+  * Curl inspired output when using the binary in verbose mode (alexvollmer)
+  * raise UnsupportedURIScheme when scheme is not HTTP or HTTPS (djspinmonkey)
+  * Allow SSL for ports other than 443 when scheme is HTTPS (stefankroes)
+  * Accept PEM certificates via HTTParty#pem (chrislo)
+  * Support HEAD and OPTION verbs (grempe)
+  * Verify SSL certificates when providing a PEM file (collectiveidea/danielmorrison)
+
 == 0.4.5 2009-09-12
 * bug fixes
   * Fixed class-level headers overwritten by cookie management code. Closes #19
@@ -138,4 +156,4 @@
 == 0.1.0 2008-07-27
 
 * 1 major enhancement:
-  * Initial release
+  * Initial release

data/Rakefile

@@ -4,36 +4,41 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-  gem.name = "httparty"
-  gem.summary = %Q{Makes http fun! Also, makes consuming restful web services dead easy.}
-  gem.description = %Q{Makes http fun! Also, makes consuming restful web services dead easy.}
-  gem.email = "nunemaker@gmail.com"
-  gem.homepage = "http://httparty.rubyforge.org"
-  gem.authors = ["John Nunemaker", "Sandro Turriate"]
-  gem.add_dependency 'crack', '>= 0.1.1'
-  gem.add_development_dependency "rspec", "1.2.8"
-  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
+    gem.name = "httparty"
+    gem.summary = %Q{Makes http fun! Also, makes consuming restful web services dead easy.}
+    gem.description = %Q{Makes http fun! Also, makes consuming restful web services dead easy.}
+    gem.email = "nunemaker@gmail.com"
+    gem.homepage = "http://httparty.rubyforge.org"
+    gem.authors = ["John Nunemaker", "Sandro Turriate"]
+    gem.add_dependency 'crack', '>= 0.1.1'
+    gem.add_development_dependency "activesupport", "~>2.3"
+    gem.add_development_dependency "cucumber", "~>0.4"
+    gem.add_development_dependency "fakeweb", "~>1.2"
+    gem.add_development_dependency "mongrel", "~>1.1"
+    gem.add_development_dependency "rspec", "1.2.9"
+    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
   end
   Jeweler::RubyforgeTasks.new do |rubyforge|
-  rubyforge.doc_task = "rdoc"
+    rubyforge.doc_task = "rdoc"
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
-spec.libs << 'lib' << 'spec'
-spec.spec_files = FileList['spec/**/*_spec.rb']
-spec.spec_opts = ['--options', 'spec/spec.opts']
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', 'spec/spec.opts']
 end
 
 Spec::Rake::SpecTask.new(:rcov) do |spec|
-spec.libs << 'lib' << 'spec'
-spec.pattern = 'spec/**/*_spec.rb'
-spec.rcov = true
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
 task :spec => :check_dependencies
@@ -41,11 +46,11 @@ task :spec => :check_dependencies
 begin
   require 'cucumber/rake/task'
   Cucumber::Rake::Task.new(:features)
-  
+
   task :features => :check_dependencies
 rescue LoadError
   task :features do
-  abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
   end
 end
 
@@ -53,19 +58,19 @@ task :default => [:spec, :features]
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-if File.exist?('VERSION')
-  version = File.read('VERSION')
-else
-  version = ""
-end
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
 
-rdoc.rdoc_dir = 'rdoc'
-rdoc.title = "httparty #{version}"
-rdoc.rdoc_files.include('README*')
-rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "httparty #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
 desc 'Upload website files to rubyforge'
 task :website do
-sh %{rsync -av website/ jnunemaker@rubyforge.org:/var/www/gforge-projects/httparty}
-end
+  sh %{rsync -av website/ jnunemaker@rubyforge.org:/var/www/gforge-projects/httparty}
+end

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.5.0

data/bin/httparty

@@ -12,27 +12,22 @@ opts = {
   :verbose => false
 }
 
-def die(msg)
-  STDERR.puts(msg)
-  exit 1
-end
-
 OptionParser.new do |o|
   o.banner = "USAGE: #{$0} [options] [url]"
-  
+
   o.on("-f",
        "--format [FORMAT]",
        "Output format to use instead of pretty-print ruby: " +
        "plain, json or xml") do |f|
     opts[:output_format] = f.downcase.to_sym
   end
-  
+
   o.on("-a",
        "--action [ACTION]",
-       "HTTP action: get (default), post, put or delete") do |a|
+       "HTTP action: get (default), post, put, delete, head, or options") do |a|
     opts[:action] = a.downcase.to_sym
   end
-  
+
   o.on("-d",
        "--data [BODY]",
        "Data to put in request body (prefix with '@' for file)") do |d|
@@ -42,44 +37,60 @@ OptionParser.new do |o|
       opts[:data] = d
     end
   end
-  
+
   o.on("-H", "--header [NAME=VALUE]", "Additional HTTP headers in NAME=VALUE form") do |h|
-    die "Invalid header specification, should be Name:Value" unless h =~ /.+:.+/
+    abort "Invalid header specification, should be Name:Value" unless h =~ /.+:.+/
     name, value = h.split(':')
     opts[:headers][name.strip] = value.strip
   end
-  
+
   o.on("-v", "--verbose", "If set, print verbose output") do |v|
     opts[:verbose] = true
   end
-  
+
   o.on("-u", "--user [CREDS]", "Use basic authentication. Value should be user:password") do |u|
-    die "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("-h", "--help", "Show help documentation") do |h|
     puts o
     exit
   end
 end.parse!
 
-puts "Querying #{ARGV.first} with options: #{opts.inspect}" if opts[:verbose]
 
 if ARGV.empty?
   STDERR.puts "You need to provide a URL"
   STDERR.puts "USAGE: #{$0} [options] [url]"
 end
 
+def dump_headers(response)
+  resp_type = Net::HTTPResponse::CODE_TO_OBJ[response.code.to_s]
+  puts "#{response.code} #{resp_type.to_s.sub(/^Net::HTTP/, '')}"
+  response.headers.each do |n,v|
+    puts "#{n}: #{v}"
+  end
+  puts
+end
+
+if opts[:verbose]
+  puts "#{opts[:action].to_s.upcase} #{ARGV.first}"
+  opts[:headers].each do |n,v|
+    puts "#{n}: #{v}"
+  end
+  puts
+end
+
+response = HTTParty.send(opts[:action], ARGV.first, opts)
 if opts[:output_format].nil?
-  response = HTTParty.send(opts[:action], ARGV.first, opts)
-  puts "Status: #{response.code}"
+  dump_headers(response) if opts[:verbose]
   pp response
 else
   print_format = opts[:output_format]
-  response = HTTParty.send(opts[:action], ARGV.first, opts)
-  puts "Status: #{response.code}"
+  dump_headers(response) if opts[:verbose]
+
   case opts[:output_format]
     when :json
       begin
@@ -95,4 +106,4 @@ else
     else
       puts response
   end
-end
+end

data/examples/basic.rb

@@ -2,7 +2,7 @@ dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
 require 'pp'
 
-# You can also use post, put, delete in the same fashion
+# You can also use post, put, delete, head, options in the same fashion
 response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
 puts response.body, response.code, response.message, response.headers.inspect
 

data/examples/custom_parsers.rb

@@ -0,0 +1,67 @@
+class ParseAtom
+  include HTTParty
+
+  # Support Atom along with the default parsers: xml, json, yaml, etc.
+  class Parser::Atom < HTTParty::Parser
+    SupportedFormats.merge!({"application/atom+xml" => :atom})
+
+    protected
+
+    # perform atom parsing on body
+    def atom
+      body.to_atom
+    end
+  end
+
+  parser Parser::Atom
+end
+
+
+class OnlyParseAtom
+  include HTTParty
+
+  # Only support Atom
+  class Parser::OnlyAtom < HTTParty::Parser
+    SupportedFormats = {"application/atom+xml" => :atom}
+
+    protected
+
+    # perform atom parsing on body
+    def atom
+      body.to_atom
+    end
+  end
+
+  parser Parser::OnlyAtom
+end
+
+
+class SkipParsing
+  include HTTParty
+
+  # Parse the response body however you like
+  class Parser::Simple < HTTParty::Parser
+    def parse
+      body
+    end
+  end
+
+  parser Parser::Simple
+end
+
+
+class AdHocParsing
+  include HTTParty
+  parser(
+    Proc.new do |body, format|
+      case format
+      when :json
+        body.to_json
+      when :xml
+        body.to_xml
+      else
+        body
+      end
+    end
+  )
+end

data/httparty.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# 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.4.5"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Nunemaker"]
-  s.date = %q{2009-09-12}
+  s.authors = ["John Nunemaker", "Sandro Turriate"]
+  s.date = %q{2009-12-07}
   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}
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "cucumber.yml",
      "examples/aaws.rb",
      "examples/basic.rb",
+     "examples/custom_parsers.rb",
      "examples/delicious.rb",
      "examples/google.rb",
      "examples/rubyurl.rb",
@@ -51,6 +52,7 @@ Gem::Specification.new do |s|
      "lib/httparty/core_extensions.rb",
      "lib/httparty/exceptions.rb",
      "lib/httparty/module_inheritable_attributes.rb",
+     "lib/httparty/parser.rb",
      "lib/httparty/request.rb",
      "lib/httparty/response.rb",
      "lib/httparty/version.rb",
@@ -61,6 +63,7 @@ Gem::Specification.new do |s|
      "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_spec.rb",
@@ -69,21 +72,23 @@ Gem::Specification.new do |s|
      "website/css/common.css",
      "website/index.html"
   ]
-  s.has_rdoc = true
   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.rubygems_version = %q{1.3.1}
+  s.rubyforge_project = %q{httparty}
+  s.rubygems_version = %q{1.3.5}
   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_spec.rb",
      "spec/spec_helper.rb",
      "examples/aaws.rb",
      "examples/basic.rb",
+     "examples/custom_parsers.rb",
      "examples/delicious.rb",
      "examples/google.rb",
      "examples/rubyurl.rb",
@@ -93,17 +98,30 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    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.1"])
-      s.add_development_dependency(%q<rspec>, ["= 1.2.8"])
+      s.add_development_dependency(%q<activesupport>, ["~> 2.3"])
+      s.add_development_dependency(%q<cucumber>, ["~> 0.4"])
+      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"])
     else
       s.add_dependency(%q<crack>, [">= 0.1.1"])
-      s.add_dependency(%q<rspec>, ["= 1.2.8"])
+      s.add_dependency(%q<activesupport>, ["~> 2.3"])
+      s.add_dependency(%q<cucumber>, ["~> 0.4"])
+      s.add_dependency(%q<fakeweb>, ["~> 1.2"])
+      s.add_dependency(%q<mongrel>, ["~> 1.1"])
+      s.add_dependency(%q<rspec>, ["= 1.2.9"])
     end
   else
     s.add_dependency(%q<crack>, [">= 0.1.1"])
-    s.add_dependency(%q<rspec>, ["= 1.2.8"])
+    s.add_dependency(%q<activesupport>, ["~> 2.3"])
+    s.add_dependency(%q<cucumber>, ["~> 0.4"])
+    s.add_dependency(%q<fakeweb>, ["~> 1.2"])
+    s.add_dependency(%q<mongrel>, ["~> 1.1"])
+    s.add_dependency(%q<rspec>, ["= 1.2.9"])
   end
 end
+

data/lib/httparty.rb

@@ -11,20 +11,19 @@ require dir + 'httparty/module_inheritable_attributes'
 require dir + 'httparty/cookie_hash'
 
 module HTTParty
-  
-  AllowedFormats = {
-    'text/xml'               => :xml,
-    'application/xml'        => :xml,
-    'application/json'       => :json,
-    'text/json'              => :json,
-    'application/javascript' => :json,
-    'text/javascript'        => :json,
-    'text/html'              => :html,
-    'application/x-yaml'     => :yaml,
-    'text/yaml'              => :yaml,
-    'text/plain'             => :plain
-  } unless defined?(AllowedFormats)
-  
+  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
@@ -33,8 +32,10 @@ module HTTParty
     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
@@ -45,7 +46,7 @@ module HTTParty
       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.
     #
@@ -57,7 +58,7 @@ module HTTParty
       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
@@ -67,7 +68,7 @@ module HTTParty
     def basic_auth(u, p)
       default_options[:basic_auth] = {:username => u, :password => p}
     end
-    
+
     # Allows setting default parameters to be appended to each request.
     # Great for api keys and such.
     #
@@ -80,7 +81,7 @@ module HTTParty
       default_options[:default_params] ||= {}
       default_options[:default_params].merge!(h)
     end
-    
+
     # Allows setting a base uri to be used for each request.
     #
     #   class Foo
@@ -97,7 +98,7 @@ module HTTParty
       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
     #
@@ -105,47 +106,67 @@ module HTTParty
     #     include HTTParty
     #     format :json
     #   end
-    def format(f)
-      raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.map { |v| v.to_s }.uniq.sort.join(', ')}" unless AllowedFormats.value?(f)
-      default_options[:format] = f
+    def format(f = nil)
+      if f.nil?
+        default_options[:format]
+      else
+        parser(Parser) if parser.nil?
+        default_options[:format] = f
+        validate_format
+      end
     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 a custom parser for the response.
     #
     #   class Foo
     #     include HTTParty
     #     parser Proc.new {|data| ...}
     #   end
-    def parser(customer_parser)
-      default_options[:parser] = customer_parser
+    def parser(customer_parser = nil)
+      if customer_parser.nil?
+        default_options[:parser]
+      else
+        default_options[:parser] = customer_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, 
+    #   # 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={})
@@ -159,12 +180,21 @@ module HTTParty
     def delete(path, options={})
       perform_request Net::HTTP::Delete, path, options
     end
-    
+
+    def head(path, options={})
+      perform_request Net::HTTP::Head, path, options
+    end
+
+    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)
@@ -176,27 +206,33 @@ module HTTParty
         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
@@ -208,9 +244,20 @@ module HTTParty
   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'
+