luigi-httparty 0.4.6 → 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

@@ -11,29 +11,34 @@ begin
   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.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.6
+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.6"
+  s.version = "0.5.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{2009-10-29}
+  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,7 +52,7 @@ Gem::Specification.new do |s|
      "lib/httparty/core_extensions.rb",
      "lib/httparty/exceptions.rb",
      "lib/httparty/module_inheritable_attributes.rb",
-     "lib/httparty/parsers.rb",
+     "lib/httparty/parser.rb",
      "lib/httparty/request.rb",
      "lib/httparty/response.rb",
      "lib/httparty/version.rb",
@@ -62,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",
@@ -79,12 +81,14 @@ Gem::Specification.new do |s|
   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",
@@ -98,13 +102,26 @@ Gem::Specification.new do |s|
 
     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/core_extensions.rb

@@ -1,7 +1,13 @@
-class BasicObject #:nodoc:
-  instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
-end unless defined?(BasicObject)
- 
+module HTTParty
+  if defined?(::BasicObject)
+    BasicObject = ::BasicObject #:nodoc:
+  else
+    class BasicObject #:nodoc:
+      instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
+    end
+  end
+end
+
 # 1.8.6 has mistyping of transitive in if statement
 require "rexml/document"
 module REXML #:nodoc:

data/lib/httparty/exceptions.rb

@@ -1,7 +1,10 @@
 module HTTParty
   # Exception raised when you attempt to set a non-existant format
   class UnsupportedFormat < StandardError; end
-  
+
+  # Exception raised when using a URI scheme other than HTTP or HTTPS
+  class UnsupportedURIScheme < StandardError; end
+
   # Exception that is raised when request has redirected too many times
   class RedirectionTooDeep < StandardError; end
-end
+end

data/lib/httparty/module_inheritable_attributes.rb

@@ -16,10 +16,10 @@ module HTTParty
 
       def inherited(subclass)
         @mattr_inheritable_attrs.each do |inheritable_attribute|
-          instance_var = "@#{inheritable_attribute}" 
+          instance_var = "@#{inheritable_attribute}"
           subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
         end
       end
     end
   end
-end
+end

data/lib/httparty/parser.rb

@@ -0,0 +1,140 @@
+module HTTParty
+  # The default parser used by HTTParty, supports xml, json, html, yaml, and
+  # plain text.
+  #
+  # == Custom Parsers
+  #
+  # If you'd like to do your own custom parsing, subclassing HTTParty::Parser
+  # will make that process much easier. There are a few different ways you can
+  # utilize HTTParty::Parser as a superclass.
+  #
+  # @example Intercept the parsing for all formats
+  #   class SimpleParser < HTTParty::Parser
+  #     def parse
+  #       perform_parsing
+  #     end
+  #   end
+  #
+  # @example Add the atom format and parsing method to the default parser
+  #   class AtomParsingIncluded < HTTParty::Parser
+  #     SupportedFormats.merge!(
+  #       {"application/atom+xml" => :atom}
+  #     )
+  #
+  #     def atom
+  #       perform_atom_parsing
+  #     end
+  #   end
+  #
+  # @example Only support the atom format
+  #   class ParseOnlyAtom < HTTParty::Parser
+  #     SupportedFormats = {"application/atom+xml" => :atom}
+  #
+  #     def atom
+  #       perform_atom_parsing
+  #     end
+  #   end
+  #
+  # @abstract Read the Custom Parsers section for more information.
+  class Parser
+    SupportedFormats = {
+      '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
+    }
+
+    # The response body of the request
+    # @return [String]
+    attr_reader :body
+
+    # The intended parsing format for the request
+    # @return [Symbol] e.g. :json
+    attr_reader :format
+
+    # @param [String] body the response body
+    # @param [Symbol] format the response format
+    # @return parsed response
+    def self.call(body, format)
+      new(body, format).parse
+    end
+
+    # @return [Hash] the SupportedFormats hash
+    def self.formats
+      const_get(:SupportedFormats)
+    end
+
+    # @param [String] mimetype response MIME type
+    # @return [Symbol]
+    # @return [nil] mime type not supported
+    def self.format_from_mimetype(mimetype)
+      formats[formats.keys.detect {|k| mimetype.include?(k)}]
+    end
+
+    # @return [Array<Symbol>] list of supported formats
+    def self.supported_formats
+      formats.values.uniq
+    end
+
+    # @param [Symbol] format e.g. :json, :xml
+    # @return [Boolean]
+    def self.supports_format?(format)
+      supported_formats.include?(format)
+    end
+
+    def initialize(body, format)
+      @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
+    def parse
+      return nil if body.nil? || body.empty?
+      if supports_format?
+        parse_supported_format
+      else
+        body
+      end
+    end
+
+    protected
+
+    def xml
+      Crack::XML.parse(body)
+    end
+
+    def json
+      Crack::JSON.parse(body)
+    end
+
+    def yaml
+      YAML.load(body)
+    end
+
+    def html
+      body
+    end
+
+    def plain
+      body
+    end
+
+    def supports_format?
+      self.class.supports_format?(format)
+    end
+
+    def parse_supported_format
+      send(format)
+      rescue NoMethodError
+        raise NotImplementedError, "#{self.class.name} has not implemented a parsing method for the #{format.inspect} format."
+    end
+  end
+end