luigi-httparty 0.4.6 → 0.5.0

data/lib/httparty/request.rb

@@ -2,38 +2,57 @@ require 'uri'
 
 module HTTParty
   class Request #:nodoc:
-    SupportedHTTPMethods = [Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Put, Net::HTTP::Delete]
-    
+    SupportedHTTPMethods = [
+      Net::HTTP::Get,
+      Net::HTTP::Post,
+      Net::HTTP::Put,
+      Net::HTTP::Delete,
+      Net::HTTP::Head,
+      Net::HTTP::Options
+    ]
+
+    SupportedURISchemes  = [URI::HTTP, URI::HTTPS]
+
     attr_accessor :http_method, :path, :options
-    
+
     def initialize(http_method, path, o={})
       self.http_method = http_method
       self.path = path
       self.options = {
-        :limit => o.delete(:no_follow) ? 0 : 5, 
+        :limit => o.delete(:no_follow) ? 0 : 5,
         :default_params => {},
+        :parser => Parser
       }.merge(o)
     end
 
     def path=(uri)
       @path = URI.parse(uri)
     end
-    
+
     def uri
       new_uri = path.relative? ? URI.parse("#{options[:base_uri]}#{path}") : path
-      
+
       # avoid double query string on redirects [#12]
       unless @redirect
         new_uri.query = query_string(new_uri)
       end
-      
+
+      unless SupportedURISchemes.include? new_uri.class
+        raise UnsupportedURIScheme, "'#{new_uri}' Must be HTTP or HTTPS"
+      end
+
       new_uri
     end
-    
+
     def format
       options[:format]
     end
-    
+
+    def parser
+      options[:parser]
+    end
+
+
     def perform
       validate
       setup_raw_request
@@ -44,23 +63,36 @@ module HTTParty
 
       def http
         http = Net::HTTP.new(uri.host, uri.port, options[:http_proxyaddr], options[:http_proxyport])
-        http.use_ssl = (uri.port == 443)
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = ssl_implied?
+
         if options[:timeout] && options[:timeout].is_a?(Integer)
           http.open_timeout = options[:timeout]
           http.read_timeout = options[:timeout]
         end
+
+        if options[:pem] && http.use_ssl?
+          http.cert = OpenSSL::X509::Certificate.new(options[:pem])
+          http.key = OpenSSL::PKey::RSA.new(options[:pem])
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
         http
       end
 
+      def ssl_implied?
+        uri.port == 443 || uri.instance_of?(URI::HTTPS)
+      end
+
       def body
         options[:body].is_a?(Hash) ? options[:body].to_params : options[:body]
       end
-      
+
       def username
         options[:basic_auth][:username]
       end
-      
+
       def password
         options[:basic_auth][:password]
       end
@@ -81,7 +113,7 @@ module HTTParty
         options[:format] ||= format_from_mimetype(response['content-type'])
         response
       end
-      
+
       def query_string(uri)
         query_string_parts = []
         query_string_parts << uri.query unless uri.query.nil?
@@ -92,10 +124,10 @@ module HTTParty
           query_string_parts << options[:default_params].to_params unless options[:default_params].nil?
           query_string_parts << options[:query] unless options[:query].nil?
         end
-        
+
         query_string_parts.size > 0 ? query_string_parts.join('&') : nil
       end
-      
+
       # Raises exception Net::XXX (http error code) if an http error occured
       def handle_response(response)
         case response
@@ -107,43 +139,14 @@ module HTTParty
             capture_cookies(response)
             perform
           else
-            parsed_response = parse_response(response.body)
-            Response.new(parsed_response, response.body, response.code, response.message, response.to_hash)
+            Response.new(parse_response(response.body), response.body, response.code, response.message, response.to_hash)
           end
       end
-      
-      # HTTParty.const_get((self.format.to_s || 'text').capitalize)
+
       def parse_response(body)
-        return nil if body.nil? or body.empty?
-        if options[:parser].blank?
-          case format
-            when :xml
-              Crack::XML.parse(body)
-            when :json
-              Crack::JSON.parse(body)
-            when :yaml
-              YAML::load(body)
-            else
-              body
-            end
-        else
-          if options[:parser].is_a?(Proc)
-            options[:parser].call(body)
-          else
-            body
-          end
-        end
-      end
-            
-      def capture_cookies(response)
-        return unless response['Set-Cookie']
-        cookies_hash = HTTParty::CookieHash.new()
-        cookies_hash.add_cookies(options[:headers]['Cookie']) if options[:headers] && options[:headers]['Cookie']
-        cookies_hash.add_cookies(response['Set-Cookie'])
-        options[:headers] ||= {}
-        options[:headers]['Cookie'] = cookies_hash.to_cookie_string
+        parser.call(body, format)
       end
-      
+
       def capture_cookies(response)
         return unless response['Set-Cookie']
         cookies_hash = HTTParty::CookieHash.new()
@@ -152,24 +155,27 @@ module HTTParty
         options[:headers] ||= {}
         options[:headers]['Cookie'] = cookies_hash.to_cookie_string
       end
-  
-      # Uses the HTTP Content-Type header to determine the format of the response
-      # It compares the MIME type returned to the types stored in the AllowedFormats hash
+
+      # Uses the HTTP Content-Type header to determine the format of the
+      # response It compares the MIME type returned to the types stored in the
+      # SupportedFormats hash
       def format_from_mimetype(mimetype)
-        return nil if mimetype.nil?
-        AllowedFormats.each { |k, v| return v if mimetype.include?(k) }
+        if mimetype && parser.respond_to?(:format_from_mimetype)
+          parser.format_from_mimetype(mimetype)
+        end
       end
-      
+
       def validate
         raise HTTParty::RedirectionTooDeep, 'HTTP redirects too deep' if options[:limit].to_i <= 0
-        raise ArgumentError, 'only get, post, put and delete methods are supported' unless SupportedHTTPMethods.include?(http_method)
+        raise ArgumentError, 'only get, post, put, delete, head, and options methods are supported' unless SupportedHTTPMethods.include?(http_method)
         raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].is_a?(Hash)
         raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].is_a?(Hash)
         raise ArgumentError, ':query must be hash if using HTTP Post' if post? && !options[:query].nil? && !options[:query].is_a?(Hash)
       end
-      
+
       def post?
         Net::HTTP::Post == http_method
       end
   end
 end
+

data/lib/httparty/response.rb

@@ -1,5 +1,6 @@
 module HTTParty
-  class Response < BasicObject #:nodoc:
+
+  class Response < HTTParty::BasicObject #:nodoc:
     RESPONDS_TO = /^((body|code|message|headers)=?|delegate)$/
     attr_accessor :body, :code, :message, :headers
     attr_reader :delegate

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty #:nodoc:
-  Version = '0.4.4'
+  Version = '0.5.0'
 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'
+

data/luigi-httparty.gemspec

@@ -0,0 +1,128 @@
+# 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{luigi-httparty}
+  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-12-08}
+  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/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/parser.rb",
+     "lib/httparty/request.rb",
+     "lib/httparty/response.rb",
+     "lib/httparty/version.rb",
+     "luigi-httparty.gemspec",
+     "spec/fixtures/delicious.xml",
+     "spec/fixtures/empty.xml",
+     "spec/fixtures/google.html",
+     "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_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.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.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",
+     "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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<crack>, [">= 0.1.1"])
+      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<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<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
+