alexvollmer-httparty 0.3.1 → 0.4.3

data/History

@@ -1,3 +1,20 @@
+== 0.4.5 2009-04-23
+* 1 minor update
+  * added message to the response object
+  
+== 0.4.2 2009-03-30
+* 2 minor changes
+  * response code now returns an integer instead of a string (jqr)
+  * rubyforge project setup for crack so i'm now depending on that instead of jnunemaker-crack
+
+== 0.4.1 2009-03-29
+* 1 minor fix
+  * gem 'jnunemaker-crack' instead of gem 'crack'
+  
+== 0.4.0 2009-03-29
+* 1 minor change
+  * Switched xml and json parsing to crack (same code as before just moved to gem for easier reuse in other projects)
+  
 == 0.3.1 2009-02-10
 * 1 minor fix, 1 minor enhancement
   * Fixed unescaping umlauts (siebertm)

data/Manifest

@@ -19,13 +19,10 @@ features/steps/remote_service_steps.rb
 features/supports_redirection.feature
 History
 httparty.gemspec
-lib/core_extensions.rb
 lib/httparty/cookie_hash.rb
+lib/httparty/core_extensions.rb
 lib/httparty/exceptions.rb
 lib/httparty/module_inheritable_attributes.rb
-lib/httparty/parsers/json.rb
-lib/httparty/parsers/xml.rb
-lib/httparty/parsers.rb
 lib/httparty/request.rb
 lib/httparty/response.rb
 lib/httparty/version.rb
@@ -43,8 +40,6 @@ spec/fixtures/twitter.xml
 spec/fixtures/undefined_method_add_node_for_nil.xml
 spec/hash_spec.rb
 spec/httparty/cookie_hash_spec.rb
-spec/httparty/parsers/json_spec.rb
-spec/httparty/parsers/xml_spec.rb
 spec/httparty/request_spec.rb
 spec/httparty/response_spec.rb
 spec/httparty_spec.rb

data/README

@@ -15,7 +15,6 @@ Makes http fun again!
 
 See http://github.com/jnunemaker/httparty/tree/master/examples
 
-
 == COMMAND LINE INTERFACE
 
 httparty also includes the executable <tt>httparty</tt> which can be
@@ -29,8 +28,13 @@ options. Below is an example of how easy it is.
 
 == REQUIREMENTS:
 
+* Crack http://github.com/jnunemaker/crack/ - For XML and JSON parsing.
 * You like to party!
 
 == INSTALL:
 
-* sudo gem install httparty
+* sudo gem install httparty
+
+== DOCS:
+
+http://rdoc.info/projects/jnunemaker/httparty

data/Rakefile

@@ -14,6 +14,7 @@ Echoe.new(ProjectName, HTTParty::Version) do |p|
   p.url             = "http://#{ProjectName}.rubyforge.org"
   p.author          = "John Nunemaker"
   p.email           = "nunemaker@gmail.com"
+  p.extra_deps      = [['crack', '>= 0.1.1']]
   p.need_tar_gz     = false
   p.docs_host       = WebsitePath
 end

data/bin/httparty

@@ -12,11 +12,6 @@ opts = {
   :verbose => false
 }
 
-def die(msg)
-  STDERR.puts(msg)
-  exit 1
-end
-
 OptionParser.new do |o|
   o.banner = "USAGE: #{$0} [options] [url]"
   
@@ -44,7 +39,7 @@ OptionParser.new do |o|
   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
@@ -54,7 +49,7 @@ OptionParser.new do |o|
   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
@@ -65,21 +60,37 @@ OptionParser.new do |o|
   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

@@ -4,8 +4,8 @@ require 'pp'
 
 # You can also use post, put, delete in the same fashion
 response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
-puts response.body, response.code, response.headers.inspect
+puts response.body, response.code, response.message, response.headers.inspect
 
 response.each do |item|
   puts item['user']['screen_name']
-end
+end

data/features/steps/httparty_response_steps.rb

@@ -17,7 +17,7 @@ Then /it should return a Hash equaling:/ do |hash_table|
 end
 
 Then /it should return a response with a (\d+) response code/ do |code|
-  @response_from_httparty.code.should eql(code)
+  @response_from_httparty.code.should eql(code.to_i)
 end
 
 Then /it should raise an HTTParty::RedirectionTooDeep exception/ do

data/httparty.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{httparty}
-  s.version = "0.3.1"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-02-10}
+  s.date = %q{2009-04-23}
   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 = ["bin/httparty", "lib/core_extensions.rb", "lib/httparty/cookie_hash.rb", "lib/httparty/exceptions.rb", "lib/httparty/module_inheritable_attributes.rb", "lib/httparty/parsers/json.rb", "lib/httparty/parsers/xml.rb", "lib/httparty/parsers.rb", "lib/httparty/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb", "lib/httparty.rb", "README"]
-  s.files = ["bin/httparty", "cucumber.yml", "examples/aaws.rb", "examples/basic.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", "History", "httparty.gemspec", "lib/core_extensions.rb", "lib/httparty/cookie_hash.rb", "lib/httparty/exceptions.rb", "lib/httparty/module_inheritable_attributes.rb", "lib/httparty/parsers/json.rb", "lib/httparty/parsers/xml.rb", "lib/httparty/parsers.rb", "lib/httparty/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb", "lib/httparty.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "setup.rb", "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/hash_spec.rb", "spec/httparty/cookie_hash_spec.rb", "spec/httparty/parsers/json_spec.rb", "spec/httparty/parsers/xml_spec.rb", "spec/httparty/request_spec.rb", "spec/httparty/response_spec.rb", "spec/httparty_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_spec.rb", "website/css/common.css", "website/index.html"]
+  s.extra_rdoc_files = ["bin/httparty", "lib/httparty/cookie_hash.rb", "lib/httparty/core_extensions.rb", "lib/httparty/exceptions.rb", "lib/httparty/module_inheritable_attributes.rb", "lib/httparty/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb", "lib/httparty.rb", "README"]
+  s.files = ["bin/httparty", "cucumber.yml", "examples/aaws.rb", "examples/basic.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", "History", "httparty.gemspec", "lib/httparty/cookie_hash.rb", "lib/httparty/core_extensions.rb", "lib/httparty/exceptions.rb", "lib/httparty/module_inheritable_attributes.rb", "lib/httparty/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb", "lib/httparty.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "setup.rb", "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/hash_spec.rb", "spec/httparty/cookie_hash_spec.rb", "spec/httparty/request_spec.rb", "spec/httparty/response_spec.rb", "spec/httparty_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_spec.rb", "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!}
@@ -27,11 +27,14 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     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<echoe>, [">= 0"])
     else
+      s.add_dependency(%q<crack>, [">= 0.1.1"])
       s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
+    s.add_dependency(%q<crack>, [">= 0.1.1"])
     s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

data/lib/httparty.rb

@@ -2,8 +2,10 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'net/http'
 require 'net/https'
-require 'core_extensions'
 require 'httparty/module_inheritable_attributes'
+require 'rubygems'
+gem 'crack'
+require 'crack'
 
 module HTTParty
   
@@ -16,7 +18,8 @@ module HTTParty
     'text/javascript'        => :json,
     'text/html'              => :html,
     'application/x-yaml'     => :yaml,
-    'text/yaml'              => :yaml
+    'text/yaml'              => :yaml,
+    'text/plain'             => :plain
   } unless defined?(AllowedFormats)
   
   def self.included(base)
@@ -99,7 +102,7 @@ module HTTParty
     #     format :json
     #   end
     def format(f)
-      raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.join(', ')}" unless AllowedFormats.value?(f)
+      raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.uniq.join(', ')}" unless AllowedFormats.value?(f)
       default_options[:format] = f
     end
     
@@ -164,13 +167,14 @@ module HTTParty
   end
 
   def self.normalize_base_uri(url) #:nodoc:
-    use_ssl = (url =~ /^https/) || url.include?(':443')
-    ends_with_slash = url =~ /\/$/
+    normalized_url = url.dup
+    use_ssl = (normalized_url =~ /^https/) || normalized_url.include?(':443')
+    ends_with_slash = normalized_url =~ /\/$/
     
-    url.chop! if ends_with_slash
-    url.gsub!(/^https?:\/\//i, '')
+    normalized_url.chop! if ends_with_slash
+    normalized_url.gsub!(/^https?:\/\//i, '')
     
-    "http#{'s' if use_ssl}://#{url}"
+    "http#{'s' if use_ssl}://#{normalized_url}"
   end
   
   class Basement #:nodoc:
@@ -195,7 +199,7 @@ module HTTParty
 end
 
 require 'httparty/cookie_hash'
+require 'httparty/core_extensions'
 require 'httparty/exceptions'
 require 'httparty/request'
 require 'httparty/response'
-require 'httparty/parsers'

data/lib/httparty/core_extensions.rb

@@ -0,0 +1,25 @@
+class BlankSlate #:nodoc:
+  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+end
+ 
+# 1.8.6 has mistyping of transitive in if statement
+require "rexml/document"
+module REXML #:nodoc:
+  class Document < Element #:nodoc:
+    def write( output=$stdout, indent=-1, transitive=false, ie_hack=false )
+      if xml_decl.encoding != "UTF-8" && !output.kind_of?(Output)
+        output = Output.new( output, xml_decl.encoding )
+      end
+      formatter = if indent > -1
+          if transitive
+            REXML::Formatters::Transitive.new( indent, ie_hack )
+          else
+            REXML::Formatters::Pretty.new( indent, ie_hack )
+          end
+        else
+          REXML::Formatters::Default.new( ie_hack )
+        end
+      formatter.write( self, output )
+    end
+  end
+end

data/lib/httparty/request.rb

@@ -1,24 +1,24 @@
 require 'uri'
 
 module HTTParty
-  class Request
+  class Request #:nodoc:
     SupportedHTTPMethods = [Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Put, Net::HTTP::Delete]
-
+    
     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,
-        :default_params => {}
+        :limit => o.delete(:no_follow) ? 0 : 5, 
+        :default_params => {},
       }.merge(o)
     end
 
     def path=(uri)
       @path = URI.parse(uri)
     end
-
+    
     def uri
       new_uri = path.relative? ? URI.parse("#{options[:base_uri]}#{path}") : path
       
@@ -28,11 +28,11 @@ module HTTParty
       
       new_uri
     end
-
+    
     def format
       options[:format]
     end
-
+    
     def perform
       validate
       setup_raw_request
@@ -84,7 +84,7 @@ module HTTParty
           query_string_parts << options[:default_params].to_params unless options[:default_params].blank?
           query_string_parts << options[:query] unless options[:query].blank?
         end
-
+        
         query_string_parts.size > 0 ? query_string_parts.join('&') : nil
       end
       
@@ -102,7 +102,7 @@ module HTTParty
             perform
           else
             parsed_response = parse_response(response.body)
-            Response.new(parsed_response, response.body, response.code, response.to_hash)
+            Response.new(parsed_response, response.body, response.code, response.message, response.to_hash)
           end
       end
       
@@ -110,16 +110,16 @@ module HTTParty
         return nil if body.nil? or body.empty?
         case format
           when :xml
-            HTTParty::Parsers::XML.parse(body)
+            Crack::XML.parse(body)
           when :json
-            HTTParty::Parsers::JSON.decode(body)
+            Crack::JSON.parse(body)
           when :yaml
             YAML::load(body)
           else
             body
           end
       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
       def format_from_mimetype(mimetype)
@@ -133,7 +133,7 @@ module HTTParty
         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

data/lib/httparty/response.rb

@@ -1,12 +1,13 @@
 module HTTParty
   class Response < BlankSlate #:nodoc:
-    attr_accessor :body, :code, :headers
+    attr_accessor :body, :code, :message, :headers
     attr_reader :delegate
 
-    def initialize(delegate, body, code, headers={})
+    def initialize(delegate, body, code, message, headers={})
       @delegate = delegate
       @body = body
-      @code = code
+      @code = code.to_i
+      @message = message
       @headers = headers
     end
 

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty #:nodoc:
-  Version = '0.3.1'
+  Version = '0.4.3'
 end

data/spec/httparty/request_spec.rb

@@ -18,7 +18,7 @@ describe HTTParty::Request do
   before do
     @request = HTTParty::Request.new(Net::HTTP::Get, 'http://api.foo.com/v1', :format => :xml)
   end
-
+  
   describe "#format" do
     it "should return the correct parsing format" do
       @request.format.should == :xml
@@ -30,7 +30,7 @@ describe HTTParty::Request do
       request = HTTParty::Request.new(Net::HTTP::Get, 'https://api.foo.com/v1:443')
       request.send(:http).use_ssl?.should == true
     end
-
+    
     it 'should not use ssl for port 80' do
       request = HTTParty::Request.new(Net::HTTP::Get, 'http://foobar.com')
       @request.send(:http).use_ssl?.should == false
@@ -81,51 +81,13 @@ describe HTTParty::Request do
     end
   end
 
-  describe '#format_from_mimetype' do
-    it 'should handle text/xml' do
-      ["text/xml", "text/xml; charset=iso8859-1"].each do |ct|
-        @request.send(:format_from_mimetype, ct).should == :xml
-      end
-    end
-
-    it 'should handle application/xml' do
-      ["application/xml", "application/xml; charset=iso8859-1"].each do |ct|
-        @request.send(:format_from_mimetype, ct).should == :xml
-      end
-    end
-    
-    it 'should handle text/json' do
-      ["text/json", "text/json; charset=iso8859-1"].each do |ct|
-        @request.send(:format_from_mimetype, ct).should == :json
-      end
-    end
-
-    it 'should handle application/json' do
-      ["application/json", "application/json; charset=iso8859-1"].each do |ct|
-        @request.send(:format_from_mimetype, ct).should == :json
-      end
-    end
-
-    it 'should handle text/javascript' do
-      ["text/javascript", "text/javascript; charset=iso8859-1"].each do |ct|
-        @request.send(:format_from_mimetype, ct).should == :json
-      end
-    end
-    
-    it 'should handle application/javascript' do
-      ["application/javascript", "application/javascript; charset=iso8859-1"].each do |ct|
-        @request.send(:format_from_mimetype, ct).should == :json
-      end
-    end
-  end
-  
   describe 'parsing responses' do
     it 'should handle xml automatically' do
       xml = %q[<books><book><id>1234</id><name>Foo Bar!</name></book></books>]
       @request.options[:format] = :xml
       @request.send(:parse_response, xml).should == {'books' => {'book' => {'id' => '1234', 'name' => 'Foo Bar!'}}}
     end
-
+    
     it 'should handle json automatically' do
       json = %q[{"books": {"book": {"name": "Foo Bar!", "id": "1234"}}}]
       @request.options[:format] = :json
@@ -177,7 +139,7 @@ describe HTTParty::Request do
   it "should not fail for missing mime type" do
     stub_response "Content for you"
     @request.options[:format] = :html
-    @request.perform.body.should == 'Content for you'
+    @request.perform.should == 'Content for you'
   end
 
   it "should drop query parameters when following redirects" do