httparty 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.3 2008-08-22
+
+* 3 major enhancements:
+	* Added http_proxy key for setting proxy server and port (francxk@gmail.com)
+	* Now raises exception when http error occurs (francxk@gmail.com)
+	* Changed auto format detection from file extension to response content type (Jay Pignata)
+
 == 0.1.2 2008-08-09
 
 * 1 major enhancement:

data/README.txt

@@ -9,7 +9,7 @@ Makes http fun again!
 * Easy get, post, put, delete requests
 * Basic http authentication
 * Default request query string parameters (ie: for api keys that are needed on each request)
-* Automatic parsing of JSON and XML into ruby hashes
+* Automatic parsing of JSON and XML into ruby hashes based on response content-type
 
 == SYNOPSIS:
 

data/examples/aaws.rb

@@ -8,7 +8,6 @@ module AAWS
     include HTTParty
     base_uri 'http://ecs.amazonaws.com'
     default_params :Service => 'AWSECommerceService', :Operation => 'ItemSearch', :SearchIndex => 'Books'
-    format :xml
     
     def initialize(key)
       self.class.default_params :AWSAccessKeyId => key

data/examples/delicious.rb

@@ -6,7 +6,6 @@ config = YAML::load(File.read(File.join(ENV['HOME'], '.delicious')))
 class Delicious
   include HTTParty
   base_uri 'https://api.del.icio.us/v1'
-  format :xml
   
   def initialize(u, p)
     @auth = {:username => u, :password => p}

data/examples/whoismyrep.rb

@@ -4,7 +4,6 @@ require 'pp'
 
 class Rep
   include HTTParty
-  format :xml
 end
 
 puts Rep.get('http://whoismyrepresentative.com/whoismyrep.php?zip=46544').inspect

data/httparty.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = %q{httparty}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2008-08-09}
+  s.date = %q{2008-08-22}
   s.description = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.email = ["nunemaker@gmail.com"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt"]

data/lib/httparty.rb

@@ -12,15 +12,27 @@ dir = File.expand_path(File.join(File.dirname(__FILE__), 'httparty'))
 require dir + '/core_ext'
   
 module HTTParty
+  class UnsupportedFormat < StandardError; end
+  
   def self.included(base)
     base.extend ClassMethods
   end
   
-  class UnsupportedFormat < StandardError; end
-  
-  AllowedFormats = %w[xml json]
+  AllowedFormats = {:xml => 'text/xml', :json => 'application/json'}
   
   module ClassMethods    
+    #
+    # Set an http proxy
+    #
+    #	class Twitter
+    #	  include HTTParty
+    #	  http_proxy http://myProxy, 1080
+    # ....
+    def http_proxy(addr=nil, port = nil)
+	   @http_proxyaddr = addr
+	   @http_proxyport = port
+    end
+
     def base_uri(base_uri=nil)
       return @base_uri unless base_uri
       # don't want this to ever end with /
@@ -52,8 +64,7 @@ module HTTParty
     end
     
     def format(f)
-      f = f.to_s
-      raise UnsupportedFormat, "Must be one of: #{AllowedFormats.join(', ')}" unless AllowedFormats.include?(f)
+      raise UnsupportedFormat, "Must be one of: #{AllowedFormats.keys.join(', ')}" unless AllowedFormats.key?(f)
       @format = f
     end
     
@@ -80,7 +91,7 @@ module HTTParty
     private
       def http(uri) #:nodoc:
         if @http.blank?
-          @http = Net::HTTP.new(uri.host, uri.port)
+          @http = Net::HTTP.new(uri.host, uri.port, @http_proxyaddr, @http_proxyport)
           @http.use_ssl = (uri.port == 443)
           # so we can avoid ssl warnings
           @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -94,13 +105,11 @@ module HTTParty
       #   body        => hash of keys/values or a query string (foo=bar&baz=poo)
       #   headers     => hash of headers to send request with
       #   basic_auth  => :username and :password to use as basic http authentication (overrides @auth class instance variable)
+      # Raises exception Net::XXX (http error code) if an http error occured
       def send_request(method, path, options={}) #:nodoc:
         raise ArgumentError, 'only get, post, put and delete methods are supported' unless %w[get post put delete].include?(method.to_s)
         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)
-        # we always want path that begins with /
-        path           = path =~ /^(\/|https?:\/\/)/ ? path : "/#{path}"
-        @format      ||= format_from_path(path)
         uri            = URI.parse("#{base_uri}#{path}")
         existing_query = uri.query ? "#{uri.query}&" : ''
         uri.query      = if options[:query].blank?
@@ -116,14 +125,24 @@ module HTTParty
         # note to self: self, do not put basic auth above headers because it removes basic auth
         request.basic_auth(basic_auth[:username], basic_auth[:password]) if basic_auth
         response       = http(uri).request(request)
-        parse_response(response.body)
+        @format      ||= format_from_mimetype(response['content-type'])
+        
+        case response
+        when Net::HTTPSuccess
+          parse_response(response.body)
+        else
+          response.instance_eval { class << self; attr_accessor :body_parsed; end }
+          begin; response.body_parsed = parse_response(response.body); rescue; end
+          response.error! # raises  exception corresponding to http error Net::XXX
+        end
+
       end
       
       def parse_response(body) #:nodoc:
         case @format
-        when 'xml'
+        when :xml
           Hash.from_xml(body)
-        when 'json'
+        when :json
           ActiveSupport::JSON.decode(body)
         else
           # just return the response if no format 
@@ -136,13 +155,10 @@ module HTTParty
         str =~ /^https?:\/\// ? str : "http#{'s' if str.include?(':443')}://#{str}"
       end
       
-      # Returns a format that we can handle from the path if possible. 
-      # Just does simple pattern matching on file extention:
-      #   /foobar.xml => 'xml'
-      #   /foobar.json => 'json'
-      def format_from_path(path) #:nodoc:
-        ext = File.extname(path)[1..-1]
-        !ext.blank? && AllowedFormats.include?(ext) ? ext : nil
+      # 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
+      def format_from_mimetype(mimetype) #:nodoc:
+        AllowedFormats.each { |k, v| return k if mimetype.include?(v) }
       end
   end
 end

data/lib/httparty/version.rb

@@ -2,7 +2,7 @@ module HTTParty
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: httparty
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - John Nunemaker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-09 00:00:00 -04:00
+date: 2008-08-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency