httparty 0.4.3 → 0.5.0

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)
@@ -18,7 +18,20 @@ describe HTTParty::Request do
   before do
     @request = HTTParty::Request.new(Net::HTTP::Get, 'http://api.foo.com/v1', :format => :xml)
   end
-  
+
+  describe "initialization" do
+    it "sets parser to HTTParty::Parser" do
+      request = HTTParty::Request.new(Net::HTTP::Get, 'http://google.com')
+      request.parser.should == HTTParty::Parser
+    end
+
+    it "sets parser to the optional parser" do
+      my_parser = lambda {}
+      request = HTTParty::Request.new(Net::HTTP::Get, 'http://google.com', :parser => my_parser)
+      request.parser.should == my_parser
+    end
+  end
+
   describe "#format" do
     it "should return the correct parsing format" do
       @request.format.should == :xml
@@ -30,10 +43,74 @@ 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
+      request.send(:http).use_ssl?.should == false
+    end
+
+    it "uses ssl for https scheme with default port" do
+      request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com')
+      request.send(:http).use_ssl?.should == true
+    end
+
+    it "uses ssl for https scheme regardless of port" do
+      request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com:123456')
+      request.send(:http).use_ssl?.should == true
+    end
+
+    context "PEM certificates" do
+      before do
+        OpenSSL::X509::Certificate.stub(:new)
+        OpenSSL::PKey::RSA.stub(:new)
+      end
+
+      context "when scheme is https" do
+        before do
+          @request.stub!(:uri).and_return(URI.parse("https://google.com"))
+          pem = :pem_contents
+          @cert = mock("OpenSSL::X509::Certificate")
+          @key =  mock("OpenSSL::PKey::RSA")
+          OpenSSL::X509::Certificate.should_receive(:new).with(pem).and_return(@cert)
+          OpenSSL::PKey::RSA.should_receive(:new).with(pem).and_return(@key)
+
+          @request.options[:pem] = pem
+          @pem_http = @request.send(:http)
+        end
+
+        it "should use a PEM certificate when provided" do
+          @pem_http.cert.should == @cert
+          @pem_http.key.should == @key
+        end
+
+        it "should verify the certificate when provided" do
+          @pem_http = @request.send(:http)
+          @pem_http.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+        end
+      end
+
+      context "when scheme is not https" do
+        it "does not assign a PEM" do
+          http = Net::HTTP.new('google.com')
+          http.should_not_receive(:cert=)
+          http.should_not_receive(:key=)
+          Net::HTTP.stub(:new => http)
+
+          request = HTTParty::Request.new(Net::HTTP::Get, 'http://google.com')
+          request.options[:pem] = :pem_contents
+          request.send(:http)
+        end
+
+        it "should not verify a certificate if scheme is not https" do
+          http = Net::HTTP.new('google.com')
+          Net::HTTP.stub(:new => http)
+
+          request = HTTParty::Request.new(Net::HTTP::Get, 'http://google.com')
+          request.options[:pem] = :pem_contents
+          http = request.send(:http)
+          http.verify_mode.should == OpenSSL::SSL::VERIFY_NONE
+        end
+      end
     end
 
     it "should use basic auth when configured" do
@@ -41,8 +118,26 @@ describe HTTParty::Request do
       @request.send(:setup_raw_request)
       @request.instance_variable_get(:@raw_request)['authorization'].should_not be_nil
     end
+
+    context "when setting timeout" do
+      it "does nothing if the timeout option is a string" do
+        http = mock("http", :null_object => true)
+        http.should_not_receive(:open_timeout=)
+        http.should_not_receive(:read_timeout=)
+        Net::HTTP.stub(:new => http)
+
+        request = HTTParty::Request.new(Net::HTTP::Get, 'https://foobar.com', {:timeout => "five seconds"})
+        request.send(:http)
+      end
+
+      it "sets the timeout to 5 seconds" do
+        @request.options[:timeout] = 5
+        @request.send(:http).open_timeout.should == 5
+        @request.send(:http).read_timeout.should == 5
+      end
+    end
   end
-  
+
   describe '#format_from_mimetype' do
     it 'should handle text/xml' do
       ["text/xml", "text/xml; charset=iso8859-1"].each do |ct|
@@ -79,6 +174,15 @@ describe HTTParty::Request do
         @request.send(:format_from_mimetype, ct).should == :json
       end
     end
+
+    it "returns nil for an unrecognized mimetype" do
+      @request.send(:format_from_mimetype, "application/atom+xml").should be_nil
+    end
+
+    it "returns nil when using a default parser" do
+      @request.options[:parser] = lambda {}
+      @request.send(:format_from_mimetype, "text/json").should be_nil
+    end
   end
 
   describe 'parsing responses' do
@@ -87,7 +191,7 @@ describe HTTParty::Request do
       @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
@@ -107,9 +211,8 @@ describe HTTParty::Request do
 
       @request.perform.headers.should == { "key" => ["value"] }
     end
-    
-    describe 'with non-200 responses' do
 
+    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
@@ -125,7 +228,6 @@ describe HTTParty::Request do
         resp.body.should == "<foo><bar>error</bar></foo>"
         resp['foo']['bar'].should == "error"
       end
-
     end
   end
 
@@ -135,7 +237,7 @@ describe HTTParty::Request do
     @request.options[:format] = :xml
     @request.perform.should be_nil
   end
-  
+
   it "should not fail for missing mime type" do
     stub_response "Content for you"
     @request.options[:format] = :html
@@ -173,6 +275,43 @@ describe HTTParty::Request do
         @request.http_method = Net::HTTP::Put
         @request.perform.should == {"hash" => {"foo" => "bar"}}
       end
+
+      it "should be handled by HEAD transparently" do
+        @request.http_method = Net::HTTP::Head
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
+
+      it "should be handled by OPTIONS transparently" do
+        @request.http_method = Net::HTTP::Options
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
+
+      it "should keep track of cookies between redirects" do
+        @redirect['Set-Cookie'] = 'foo=bar; name=value; HTTPOnly'
+        @request.perform
+        @request.options[:headers]['Cookie'].should match(/foo=bar/)
+        @request.options[:headers]['Cookie'].should match(/name=value/)
+      end
+
+      it 'should update cookies with rediects' do
+        @request.options[:headers] = {'Cookie'=> 'foo=bar;'}
+        @redirect['Set-Cookie'] = 'foo=tar;'
+        @request.perform
+        @request.options[:headers]['Cookie'].should match(/foo=tar/)
+      end
+
+      it 'should keep cookies between rediects' do
+        @request.options[:headers] = {'Cookie'=> 'keep=me'}
+        @redirect['Set-Cookie'] = 'foo=tar;'
+        @request.perform
+        @request.options[:headers]['Cookie'].should match(/keep=me/)
+      end
+
+      it 'should make resulting request a get request if it not already' do
+        @request.http_method = Net::HTTP::Delete
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+        @request.http_method.should == Net::HTTP::Get
+      end
     end
 
     describe "infinitely" do

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,10 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+class CustomParser
+  def self.parse(body)
+    return {:sexy => true}
+  end
+end
 
 describe HTTParty do
   before(:each) do
@@ -6,6 +12,20 @@ describe HTTParty do
     @klass.instance_eval { include HTTParty }
   end
 
+  describe "AllowedFormats deprecated" do
+    before do
+      Kernel.stub(:warn)
+    end
+    it "warns with a deprecation message" do
+      Kernel.should_receive(:warn).with("Deprecated: Use HTTParty::Parser::SupportedFormats")
+      HTTParty::AllowedFormats
+    end
+
+    it "returns HTTPart::Parser::SupportedFormats" do
+      HTTParty::AllowedFormats.should == HTTParty::Parser::SupportedFormats
+    end
+  end
+
   describe "base uri" do
     before(:each) do
       @klass.base_uri('api.foo.com/v1')
@@ -14,7 +34,7 @@ describe HTTParty do
     it "should have reader" do
       @klass.base_uri.should == 'http://api.foo.com/v1'
     end
-    
+
     it 'should have writer' do
       @klass.base_uri('http://api.foobar.com')
       @klass.base_uri.should == 'http://api.foobar.com'
@@ -26,18 +46,18 @@ describe HTTParty do
       uri.should == 'http://api.foobar.com'
     end
   end
-  
+
   describe "#normalize_base_uri" do
     it "should add http if not present for non ssl requests" do
       uri = HTTParty.normalize_base_uri('api.foobar.com')
       uri.should == 'http://api.foobar.com'
     end
-    
+
     it "should add https if not present for ssl requests" do
       uri = HTTParty.normalize_base_uri('api.foo.com/v1:443')
       uri.should == 'https://api.foo.com/v1:443'
     end
-    
+
     it "should not remove https for ssl requests" do
       uri = HTTParty.normalize_base_uri('https://api.foo.com/v1:443')
       uri.should == 'https://api.foo.com/v1:443'
@@ -49,17 +69,55 @@ describe HTTParty do
       uri.should == 'http://api.foobar.com'
     end
   end
-  
+
   describe "headers" do
+    def expect_headers(header={})
+      HTTParty::Request.should_receive(:new) \
+        .with(anything, anything, hash_including({ :headers => header })) \
+        .and_return(mock("mock response", :perform => nil))
+    end
+
     it "should default to empty hash" do
       @klass.headers.should == {}
     end
-    
+
     it "should be able to be updated" do
       init_headers = {:foo => 'bar', :baz => 'spax'}
       @klass.headers init_headers
       @klass.headers.should == init_headers
     end
+
+    it "uses the class headers when sending a request" do
+      expect_headers(:foo => 'bar')
+      @klass.headers(:foo => 'bar')
+      @klass.get('')
+    end
+
+    it "overwrites class headers when passing in headers" do
+      expect_headers(:baz => 'spax')
+      @klass.headers(:foo => 'bar')
+      @klass.get('', :headers => {:baz => 'spax'})
+    end
+
+    context "with cookies" do
+      it 'utilizes the class-level cookies' do
+        expect_headers(:foo => 'bar', 'cookie' => 'type=snickerdoodle')
+        @klass.headers(:foo => 'bar')
+        @klass.cookies(:type => 'snickerdoodle')
+        @klass.get('')
+      end
+
+      it 'adds cookies to the headers' do
+        expect_headers(:foo => 'bar', 'cookie' => 'type=snickerdoodle')
+        @klass.headers(:foo => 'bar')
+        @klass.get('', :cookies => {:type => 'snickerdoodle'})
+      end
+
+      it 'adds optional cookies to the optional headers' do
+        expect_headers(:baz => 'spax', 'cookie' => 'type=snickerdoodle')
+        @klass.get('', :cookies => {:type => 'snickerdoodle'}, :headers => {:baz => 'spax'})
+      end
+    end
   end
 
   describe "cookies" do
@@ -96,6 +154,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"
 
@@ -125,47 +190,82 @@ describe HTTParty do
       end
     end
   end
-  
+
   describe "default params" do
     it "should default to empty hash" do
       @klass.default_params.should == {}
     end
-    
+
     it "should be able to be updated" do
       new_defaults = {:foo => 'bar', :baz => 'spax'}
       @klass.default_params new_defaults
       @klass.default_params.should == new_defaults
     end
   end
-  
+
   describe "basic http authentication" do
     it "should work" do
       @klass.basic_auth 'foobar', 'secret'
       @klass.default_options[:basic_auth].should == {:username => 'foobar', :password => 'secret'}
     end
   end
-  
+
+  describe "parser" do
+    let(:parser) do
+      Proc.new{ |data, format| CustomParser.parse(data) }
+    end
+
+    it "should set parser options" do
+      @klass.parser parser
+      @klass.default_options[:parser].should == parser
+    end
+
+    it "should be able parse response with custom parser" do
+      @klass.parser parser
+      FakeWeb.register_uri(:get, 'http://twitter.com/statuses/public_timeline.xml', :body => 'tweets')
+      custom_parsed_response = @klass.get('http://twitter.com/statuses/public_timeline.xml')
+      custom_parsed_response[:sexy].should == true
+    end
+
+    it "raises UnsupportedFormat when the parser cannot handle the format" do
+      @klass.format :json
+      class MyParser < HTTParty::Parser
+        SupportedFormats = {}
+      end
+      expect do
+        @klass.parser MyParser
+      end.to raise_error(HTTParty::UnsupportedFormat)
+    end
+
+    it 'does not validate format whe custom parser is a proc' do
+      expect do
+        @klass.format :json
+        @klass.parser lambda {|body, format|}
+      end.to_not raise_error(HTTParty::UnsupportedFormat)
+    end
+  end
+
   describe "format" do
     it "should allow xml" do
       @klass.format :xml
       @klass.default_options[:format].should == :xml
     end
-    
+
     it "should allow json" do
       @klass.format :json
       @klass.default_options[:format].should == :json
     end
-    
+
     it "should allow yaml" do
       @klass.format :yaml
       @klass.default_options[:format].should == :yaml
     end
-    
+
     it "should allow plain" do
       @klass.format :plain
       @klass.default_options[:format].should == :plain
     end
-    
+
     it 'should not allow funky format' do
       lambda do
         @klass.format :foobar
@@ -175,9 +275,21 @@ 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, "':foobar' Must be one of: html, json, plain, xml, yaml")
     end
 
+    it 'sets the default parser' do
+      @klass.default_options[:parser].should be_nil
+      @klass.format :json
+      @klass.default_options[:parser].should == HTTParty::Parser
+    end
+
+    it 'does not reset parser to the default parser' do
+      my_parser = lambda {}
+      @klass.parser my_parser
+      @klass.format :json
+      @klass.parser.should == my_parser
+    end
   end
 
   describe "with explicit override of automatic redirect handling" do
@@ -205,8 +317,20 @@ describe HTTParty do
         @klass.put('/foo', :no_follow => true)
       end.should raise_error(HTTParty::RedirectionTooDeep)
     end
+
+    it "should fail with redirected HEAD" do
+      lambda do
+        @klass.head('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    end
+
+    it "should fail with redirected OPTIONS" do
+      lambda do
+        @klass.options('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    end
   end
-  
+
   describe "with multiple class definitions" do
     before(:each) do
       @klass.instance_eval do
@@ -227,57 +351,104 @@ describe HTTParty do
       @additional_klass.default_options.should == { :base_uri => 'http://second.com', :default_params => { :two => 2 } }
     end
   end
-  
+
+  describe "two child classes inheriting from one parent" do
+    before(:each) do
+      @parent = Class.new do
+        include HTTParty
+      end
+
+      @child1 = Class.new(@parent)
+      @child2 = Class.new(@parent)
+    end
+
+    it "does not modify each others inherited attributes" do
+      @child1.default_params :joe => "alive"
+      @child2.default_params :joe => "dead"
+
+      @child1.default_options.should == { :default_params => {:joe => "alive"} }
+      @child2.default_options.should == { :default_params => {:joe => "dead"} }
+
+      @parent.default_options.should == { }
+    end
+  end
+
   describe "#get" do
     it "should be able to get html" do
       stub_http_response_with('google.html')
       HTTParty.get('http://www.google.com').should == file_fixture('google.html')
     end
-    
+
     it "should be able parse response type json automatically" do
       stub_http_response_with('twitter.json')
       tweets = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
       tweets.size.should == 20
       tweets.first['user'].should == {
-        "name"              => "Pyk", 
-        "url"               => nil, 
-        "id"                => "7694602", 
-        "description"       => nil, 
-        "protected"         => false, 
-        "screen_name"       => "Pyk", 
-        "followers_count"   => 1, 
-        "location"          => "Opera Plaza, California", 
+        "name"              => "Pyk",
+        "url"               => nil,
+        "id"                => "7694602",
+        "description"       => nil,
+        "protected"         => false,
+        "screen_name"       => "Pyk",
+        "followers_count"   => 1,
+        "location"          => "Opera Plaza, California",
         "profile_image_url" => "http://static.twitter.com/images/default_profile_normal.png"
       }
     end
-    
+
     it "should be able parse response type xml automatically" do
       stub_http_response_with('twitter.xml')
       tweets = HTTParty.get('http://twitter.com/statuses/public_timeline.xml')
       tweets['statuses'].size.should == 20
       tweets['statuses'].first['user'].should == {
-        "name"              => "Magic 8 Bot", 
-        "url"               => nil, 
-        "id"                => "17656026", 
-        "description"       => "ask me a question", 
-        "protected"         => "false", 
-        "screen_name"       => "magic8bot", 
-        "followers_count"   => "90", 
-        "profile_image_url" => "http://s3.amazonaws.com/twitter_production/profile_images/65565851/8ball_large_normal.jpg", 
+        "name"              => "Magic 8 Bot",
+        "url"               => nil,
+        "id"                => "17656026",
+        "description"       => "ask me a question",
+        "protected"         => "false",
+        "screen_name"       => "magic8bot",
+        "followers_count"   => "90",
+        "profile_image_url" => "http://s3.amazonaws.com/twitter_production/profile_images/65565851/8ball_large_normal.jpg",
         "location"          => nil
       }
     end
-    
+
     it "should not get undefined method add_node for nil class for the following xml" do
       stub_http_response_with('undefined_method_add_node_for_nil.xml')
       result = HTTParty.get('http://foobar.com')
       result.should == {"Entities"=>{"href"=>"https://s3-sandbox.parature.com/api/v1/5578/5633/Account", "results"=>"0", "total"=>"0", "page_size"=>"25", "page"=>"1"}}
     end
-    
+
     it "should parse empty response fine" do
       stub_http_response_with('empty.xml')
       result = HTTParty.get('http://foobar.com')
-      result.should == nil
+      result.should be_nil
+    end
+
+    it "should accept http URIs" do
+      stub_http_response_with('google.html')
+      lambda do
+        HTTParty.get('http://google.com')
+      end.should_not raise_error(HTTParty::UnsupportedURIScheme)
+    end
+
+    it "should accept https URIs" do
+      stub_http_response_with('google.html')
+      lambda do
+        HTTParty.get('https://google.com')
+      end.should_not raise_error(HTTParty::UnsupportedURIScheme)
+    end
+
+    it "should raise an ArgumentError on URIs that are not http or https" do
+      lambda do
+        HTTParty.get("file:///there_is_no_party_on/my/filesystem")
+      end.should raise_error(HTTParty::UnsupportedURIScheme)
+    end
+
+    it "should raise an InvalidURIError on URIs that can't be parsed at all" do
+      lambda do
+        HTTParty.get("It's the one that says 'Bad URI'")
+      end.should raise_error(URI::InvalidURIError)
     end
   end
 end

data/spec/spec.opts

@@ -1,3 +1,2 @@
---format
-  progress
 --colour
+--format specdoc

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
-require 'rubygems'
-gem 'rspec'
-require 'spec'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'httparty')
+gem 'rspec', '1.2.9'
+gem 'fakeweb'
+require 'spec/autorun'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
 
 def file_fixture(filename)
   open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
@@ -18,4 +21,4 @@ def stub_http_response_with(filename)
   http_request.stub!(:perform_actual_request).and_return(response)
 
   HTTParty::Request.should_receive(:new).and_return(http_request)
-end
+end