kerryb-httparty 0.4.3 → 0.4.4

data/History

@@ -1,4 +1,10 @@
-== 0.4.5 2009-04-23
+== 0.4.4 2009-07-19
+* 2 minor update
+  * :query no longer sets form data. Use body and set content type to application/x-www-form-urlencoded if you need it. :query was wrong for that.
+  * Fixed a bug in the cookies class method that caused cookies to be forgotten after the first request.
+  * Also, some general cleanup of tests and such.
+  
+== 0.4.3 2009-04-23
 * 1 minor update
   * added message to the response object
   

data/Manifest

@@ -1,3 +1,8 @@
+History
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
 bin/httparty
 cucumber.yml
 examples/aaws.rb
@@ -17,8 +22,8 @@ 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.rb
 lib/httparty/cookie_hash.rb
 lib/httparty/core_extensions.rb
 lib/httparty/exceptions.rb
@@ -26,25 +31,17 @@ 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

data/README.rdoc

@@ -0,0 +1,54 @@
+= httparty
+
+Makes http fun again!
+
+== Note on Releases
+
+Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
+
+* rake build_gemspec
+* gem build httparty.gemspec
+* gem install the gem that was built
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Features:
+
+* Easy get, post 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 based on response content-type
+
+== Examples
+
+See http://github.com/jnunemaker/httparty/tree/master/examples
+
+== Command Line Interface
+
+httparty also includes the executable <tt>httparty</tt> which can be
+used to query web services and examine the resulting output. By default
+it will output the response as a pretty-printed Ruby object (useful for
+grokking the structure of output). This can also be overridden to output
+formatted XML or JSON. Execute <tt>httparty --help</tt> for all the
+options. Below is an example of how easy it is.
+
+  httparty "http://twitter.com/statuses/public_timeline.json"
+
+== Requirements
+
+* Crack http://github.com/jnunemaker/crack/ - For XML and JSON parsing.
+* You like to party!
+
+== Install
+
+* sudo gem install httparty
+
+== Docs
+
+http://rdoc.info/projects/jnunemaker/httparty

data/Rakefile

@@ -8,7 +8,7 @@ require 'spec/rake/spectask'
 require "lib/#{ProjectName}/version"
 require 'cucumber/rake/task'
 
-Echoe.new(ProjectName, HTTParty::Version) do |p|
+Echoe.new("kerryb-#{ProjectName}", HTTParty::Version) do |p|
   p.description     = "Makes http fun! Also, makes consuming restful web services dead easy."
   p.install_message = "When you HTTParty, you must party hard!"
   p.url             = "http://#{ProjectName}.rubyforge.org"

data/httparty.gemspec

@@ -2,39 +2,36 @@
 
 Gem::Specification.new do |s|
   s.name = %q{httparty}
-  s.version = "0.4.3"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2009-04-23}
+  s.date = %q{2009-08-03}
   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/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.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.rdoc"]
+  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.rdoc", "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/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.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 = ["--line-numbers", "--inline-source", "--title", "Httparty", "--main", "README"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Httparty", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{httparty}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.2}
   s.summary = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
 
   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<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/kerryb-httparty.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kerryb-httparty}
+  s.version = "0.4.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker"]
+  s.date = %q{2010-04-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", "bin/httparty", "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/request.rb", "lib/httparty/response.rb", "lib/httparty/version.rb"]
+  s.files = ["History", "MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "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", "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/request.rb", "lib/httparty/response.rb", "lib/httparty/version.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/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", "website/css/common.css", "website/index.html", "kerryb-httparty.gemspec"]
+  s.homepage = %q{http://httparty.rubyforge.org}
+  s.post_install_message = %q{When you HTTParty, you must party hard!}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Kerryb-httparty", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{kerryb-httparty}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
+
+  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"])
+    else
+      s.add_dependency(%q<crack>, [">= 0.1.1"])
+    end
+  else
+    s.add_dependency(%q<crack>, [">= 0.1.1"])
+  end
+end

data/lib/httparty.rb

@@ -7,6 +7,8 @@ require 'rubygems'
 gem 'crack'
 require 'crack'
 
+require 'httparty/cookie_hash'
+
 module HTTParty
   
   AllowedFormats = {
@@ -26,7 +28,9 @@ module HTTParty
     base.extend ClassMethods
     base.send :include, HTTParty::ModuleInheritableAttributes
     base.send(:mattr_inheritable, :default_options)
+    base.send(:mattr_inheritable, :default_cookies)
     base.instance_variable_set("@default_options", {})
+    base.instance_variable_set("@default_cookies", CookieHash.new)
   end
   
   module ClassMethods
@@ -90,8 +94,7 @@ module HTTParty
 
     def cookies(h={})
       raise ArgumentError, 'Cookies must be a hash' unless h.is_a?(Hash)
-      default_options[:cookies] ||= CookieHash.new
-      default_options[:cookies].add_cookies(h)
+      default_cookies.add_cookies(h)
     end
     
     # Allows setting the format with which to parse.
@@ -102,7 +105,7 @@ module HTTParty
     #     format :json
     #   end
     def format(f)
-      raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.uniq.join(', ')}" unless AllowedFormats.value?(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
     end
     
@@ -157,11 +160,10 @@ module HTTParty
       end
 
       def process_cookies(options) #:nodoc:
-        return unless options[:cookies] || default_options[:cookies]
+        return unless options[:cookies] || default_cookies
         options[:headers] ||= {}
-        options[:headers]["cookie"] = cookies(options[:cookies] || {}).to_cookie_string
+        options[:headers]["cookie"] = cookies.merge(options[:cookies] || {}).to_cookie_string
 
-        default_options.delete(:cookies)
         options.delete(:cookies)
       end
   end
@@ -198,7 +200,6 @@ module HTTParty
   end
 end
 
-require 'httparty/cookie_hash'
 require 'httparty/core_extensions'
 require 'httparty/exceptions'
 require 'httparty/request'

data/lib/httparty/core_extensions.rb

@@ -1,5 +1,9 @@
-class BlankSlate #:nodoc:
-  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+if RUBY_VERSION.to_f == 1.8
+  class BlankSlate #:nodoc:
+    instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval|object_id/ }
+  end
+else
+  class BlankSlate < BasicObject; end
 end
  
 # 1.8.6 has mistyping of transitive in if statement

data/lib/httparty/request.rb

@@ -41,28 +41,42 @@ module HTTParty
     end
 
     private
+      # 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
+      # end
+
       def http
         http = Net::HTTP.new(uri.host, uri.port, options[:http_proxyaddr], options[:http_proxyport])
         http.use_ssl = (uri.port == 443 || uri.scheme == 'https')
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        if options[:timeout] && options[:timeout].is_a?(Integer)
+          http.open_timeout = options[:timeout]
+          http.read_timeout = options[:timeout]
+        end
         http
       end
+      
 
-      def configure_basic_auth
-        @raw_request.basic_auth(options[:basic_auth][:username], options[:basic_auth][:password])
+      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
 
       def setup_raw_request
         @raw_request = http_method.new(uri.request_uri)
-        
-        if post? && options[:query]
-          @raw_request.set_form_data(options[:query])
-        end
-        
-        @raw_request.body = options[:body].is_a?(Hash) ? options[:body].to_params : options[:body] unless options[:body].blank?
-        @raw_request.initialize_http_header options[:headers]
-        
-        configure_basic_auth if options[:basic_auth]
+        @raw_request.body = body if body
+        @raw_request.initialize_http_header(options[:headers])
+        @raw_request.basic_auth(username, password) if options[:basic_auth]
       end
 
       def perform_actual_request
@@ -77,13 +91,13 @@ module HTTParty
       
       def query_string(uri)
         query_string_parts = []
-        query_string_parts << uri.query unless uri.query.blank?
+        query_string_parts << uri.query unless uri.query.nil?
 
         if options[:query].is_a?(Hash)
           query_string_parts << options[:default_params].merge(options[:query]).to_params
         else
-          query_string_parts << options[:default_params].to_params unless options[:default_params].blank?
-          query_string_parts << options[:query] unless options[:query].blank?
+          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

data/lib/httparty/version.rb

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

data/spec/httparty/cookie_hash_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '../spec_helper')
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
 
 describe HTTParty::CookieHash do
   before(:each) do

data/spec/httparty/request_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
 describe HTTParty::Request do
   def stub_response(body, code = 200)
@@ -35,6 +35,11 @@ describe HTTParty::Request do
       request = HTTParty::Request.new(Net::HTTP::Get, 'http://foobar.com')
       request.send(:http).use_ssl?.should == false
     end
+    
+    it "should use ssl for https scheme" do
+      request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com')
+      request.send(:http).use_ssl?.should == true
+    end
 
     it 'should use ssl for https scheme' do
       request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com')
@@ -46,6 +51,23 @@ describe HTTParty::Request do
       @request.send(:setup_raw_request)
       @request.instance_variable_get(:@raw_request)['authorization'].should_not be_nil
     end
+    
+    it "should change timeout when configured (if an Integer)" do
+      @request.send(:http).open_timeout.should be_nil
+      @request.send(:http).read_timeout.should == 60
+      
+      invalid_timeout = "invalid"
+      invalid_timeout.is_a?(Integer).should be_false
+      @request.options[:timeout] = invalid_timeout
+      @request.send(:http).open_timeout.should be_nil
+      @request.send(:http).read_timeout.should == 60
+      
+      timeout = 30
+      timeout.is_a?(Integer).should be_true
+      @request.options[:timeout] = timeout
+      @request.send(:http).open_timeout.should == timeout
+      @request.send(:http).read_timeout.should == timeout
+    end
   end
   
   describe '#format_from_mimetype' do
@@ -114,7 +136,6 @@ describe HTTParty::Request do
     end
     
     describe 'with non-200 responses' do
-
       it 'should return a valid object for 4xx response' do
         stub_response '<foo><bar>yes</bar></foo>', 401
         resp = @request.perform
@@ -130,7 +151,6 @@ describe HTTParty::Request do
         resp.body.should == "<foo><bar>error</bar></foo>"
         resp['foo']['bar'].should == "error"
       end
-
     end
   end
 

data/spec/httparty/response_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
 describe HTTParty::Response do
   describe "initialization" do

data/spec/httparty_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 describe HTTParty do
   before(:each) do
@@ -96,6 +96,13 @@ describe HTTParty do
         @klass.get("")
       end
 
+      it "should pass the proper cookies when requested multiple times" do
+        2.times do
+          expect_cookie_header "type=snickerdoodle"
+          @klass.get("")
+        end
+      end
+
       it "should allow the class defaults to be overridden" do
         expect_cookie_header "type=chocolate_chip"
 
@@ -175,7 +182,7 @@ describe HTTParty do
     it 'should only print each format once with an exception' do
       lambda do
         @klass.format :foobar
-      end.should raise_error(HTTParty::UnsupportedFormat, "Must be one of: json, plain, html, yaml, xml")
+      end.should raise_error(HTTParty::UnsupportedFormat, "Must be one of: html, json, plain, xml, yaml")
     end
 
   end