jugend-httparty 0.5.2.1

data/spec/httparty/request_spec.rb

@@ -0,0 +1,415 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+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
+    end
+  end
+
+  context "options" do
+    it "should use basic auth when configured" do
+      @request.options[:basic_auth] = {:username => 'foobar', :password => 'secret'}
+      @request.send(:setup_raw_request)
+      @request.instance_variable_get(:@raw_request)['authorization'].should_not be_nil
+    end
+
+    it "should use digest auth when configured" do
+      FakeWeb.register_uri(:head, "http://api.foo.com/v1",
+        :www_authenticate => 'Digest realm="Log Viewer", qop="auth", nonce="2CA0EC6B0E126C4800E56BA0C0003D3C", opaque="5ccc069c403ebaf9f0171e9517f40e41", stale=false')
+
+      @request.options[:digest_auth] = {:username => 'foobar', :password => 'secret'}
+      @request.send(:setup_raw_request)
+
+      raw_request = @request.instance_variable_get(:@raw_request)
+      raw_request.instance_variable_get(:@header)['Authorization'].should_not be_nil
+    end
+  end
+
+  describe "#uri" do
+    context "query strings" do
+      it "does not add an empty query string when default_params are blank" do
+        @request.options[:default_params] = {}
+        @request.uri.query.should be_nil
+      end
+    end
+  end
+
+  describe 'http' do
+    it "should use ssl for port 443" 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
+    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
+
+      context "debugging" do
+        before do
+          @http = Net::HTTP.new('google.com')
+          Net::HTTP.stub(:new => @http)
+          @request = HTTParty::Request.new(Net::HTTP::Get, 'http://google.com')
+        end
+
+        it "calls #set_debug_output when the option is provided" do
+          @request.options[:debug_output] = $stderr
+          @http.should_receive(:set_debug_output).with($stderr)
+          @request.send(:http)
+        end
+
+        it "does not set_debug_output when the option is not provided" do
+          @http.should_not_receive(:set_debug_output)
+          @request.send(:http)
+        end
+      end
+    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|
+        @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
+
+    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
+    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
+      @request.send(:parse_response, json).should == {'books' => {'book' => {'id' => '1234', 'name' => 'Foo Bar!'}}}
+    end
+
+    it 'should handle yaml automatically' do
+      yaml = "books: \n  book: \n    name: Foo Bar!\n    id: \"1234\"\n"
+      @request.options[:format] = :yaml
+      @request.send(:parse_response, yaml).should == {'books' => {'book' => {'id' => '1234', 'name' => 'Foo Bar!'}}}
+    end
+
+    it "should include any HTTP headers in the returned response" do
+      @request.options[:format] = :html
+      response = stub_response "Content"
+      response.initialize_http_header("key" => "value")
+
+      @request.perform.headers.should == { "key" => ["value"] }
+    end
+
+    describe 'with non-200 responses' do
+      context "3xx responses" do
+        it 'returns a valid object for 304 not modified' do
+          stub_response '', 304
+          resp = @request.perform
+          resp.code.should == 304
+          resp.body.should == ''
+          resp.should be_nil
+        end
+
+        it "redirects if a 300 contains a location header" do
+          redirect = stub_response '', 300
+          redirect['location'] = 'http://foo.com/foo'
+          ok = stub_response('<hash><foo>bar</foo></hash>', 200)
+          @http.stub!(:request).and_return(redirect, ok)
+          @request.perform.should == {"hash" => {"foo" => "bar"}}
+        end
+
+        it "returns the Net::HTTP response if the 300 does not contain a location header" do
+          net_response = stub_response '', 300
+          @request.perform.should be_kind_of(Net::HTTPMultipleChoice)
+        end
+      end
+
+      it 'should return a valid object for 4xx response' do
+        stub_response '<foo><bar>yes</bar></foo>', 401
+        resp = @request.perform
+        resp.code.should == 401
+        resp.body.should == "<foo><bar>yes</bar></foo>"
+        resp['foo']['bar'].should == "yes"
+      end
+
+      it 'should return a valid object for 5xx response' do
+        stub_response '<foo><bar>error</bar></foo>', 500
+        resp = @request.perform
+        resp.code.should == 500
+        resp.body.should == "<foo><bar>error</bar></foo>"
+        resp['foo']['bar'].should == "error"
+      end
+    end
+  end
+
+  it "should not attempt to parse empty responses" do
+    [204, 304].each do |code|
+      stub_response "", code
+
+      @request.options[:format] = :xml
+      @request.perform.should be_nil
+    end
+  end
+
+  it "should not fail for missing mime type" do
+    stub_response "Content for you"
+    @request.options[:format] = :html
+    @request.perform.should == 'Content for you'
+  end
+
+  describe "a request that redirects" do
+    before(:each) do
+      @redirect = stub_response("", 302)
+      @redirect['location'] = '/foo'
+
+      @ok = stub_response('<hash><foo>bar</foo></hash>', 200)
+    end
+
+    describe "once" do
+      before(:each) do
+        @http.stub!(:request).and_return(@redirect, @ok)
+      end
+
+      it "should be handled by GET transparently" do
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
+
+      it "should be handled by POST transparently" do
+        @request.http_method = Net::HTTP::Post
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
+
+      it "should be handled by DELETE transparently" do
+        @request.http_method = Net::HTTP::Delete
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
+
+      it "should be handled by PUT transparently" 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
+
+      it 'should not make resulting request a get request if options[:maintain_method_across_redirects] is true' do
+        @request.options[:maintain_method_across_redirects] = true
+        @request.http_method = Net::HTTP::Delete
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+        @request.http_method.should == Net::HTTP::Delete
+      end
+    end
+
+    describe "infinitely" do
+      before(:each) do
+        @http.stub!(:request).and_return(@redirect)
+      end
+
+      it "should raise an exception" do
+        lambda { @request.perform }.should raise_error(HTTParty::RedirectionTooDeep)
+      end
+    end
+  end
+
+  context "with POST http method" do
+    it "should raise argument error if query is not a hash" do
+      lambda {
+        HTTParty::Request.new(Net::HTTP::Post, 'http://api.foo.com/v1', :format => :xml, :query => 'astring').perform
+      }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "argument validation" do
+    it "should raise argument error if basic_auth and digest_auth are both present" do
+      lambda {
+        HTTParty::Request.new(Net::HTTP::Post, 'http://api.foo.com/v1', :basic_auth => {}, :digest_auth => {}).perform
+      }.should raise_error(ArgumentError, "only one authentication method, :basic_auth or :digest_auth may be used at a time")
+    end
+
+    it "should raise argument error if basic_auth is not a hash" do
+      lambda {
+        HTTParty::Request.new(Net::HTTP::Post, 'http://api.foo.com/v1', :basic_auth => ["foo", "bar"]).perform
+      }.should raise_error(ArgumentError, ":basic_auth must be a hash")
+    end
+
+    it "should raise argument error if digest_auth is not a hash" do
+      lambda {
+        HTTParty::Request.new(Net::HTTP::Post, 'http://api.foo.com/v1', :digest_auth => ["foo", "bar"]).perform
+      }.should raise_error(ArgumentError, ":digest_auth must be a hash")
+    end
+  end
+end
+

data/spec/httparty/response_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe HTTParty::Response do
+  before do
+    @last_modified = Date.new(2010, 1, 15).to_s
+    @content_length = '1024'
+    @response_object = {'foo' => 'bar'}
+    @response_object = Net::HTTPOK.new('1.1', 200, 'OK')
+    @response_object.stub(:body => "{foo:'bar'}")
+    @response_object['last-modified'] = @last_modified
+    @response_object['content-length'] = @content_length
+    @parsed_response = {"foo" => "bar"}
+    @response = HTTParty::Response.new(@response_object, @parsed_response)
+  end
+
+  describe "initialization" do
+    it "should set the Net::HTTP Response" do
+      @response.response.should == @response_object
+    end
+
+    it "should set body" do
+      @response.body.should == @response_object.body
+    end
+
+    it "should set code" do
+      @response.code.should.to_s == @response_object.code
+    end
+
+    it "should set code as a Fixnum" do
+      @response.code.should be_an_instance_of(Fixnum)
+    end
+  end
+
+  it "returns response headers" do
+    response = HTTParty::Response.new(@response_object, @parsed_response)
+    response.headers.should == {'last-modified' => [@last_modified], 'content-length' => [@content_length]}
+  end
+
+  it "should send missing methods to delegate" do
+    response = HTTParty::Response.new(@response_object, {'foo' => 'bar'})
+    response['foo'].should == 'bar'
+  end
+
+  it "should be able to iterate if it is array" do
+    response = HTTParty::Response.new(@response_object, [{'foo' => 'bar'}, {'foo' => 'baz'}])
+    response.size.should == 2
+    expect {
+      response.each { |item| }
+    }.to_not raise_error
+  end
+
+  it "allows headers to be accessed by mixed-case names in hash notation" do
+    response = HTTParty::Response.new(@response_object, @parsed_response)
+    response.headers['Content-LENGTH'].should == @content_length
+  end
+
+  it "returns a comma-delimited value when multiple values exist" do
+    @response_object.add_field 'set-cookie', 'csrf_id=12345; path=/'
+    @response_object.add_field 'set-cookie', '_github_ses=A123CdE; path=/'
+    response = HTTParty::Response.new(@response_object, @parsed_response)
+    response.headers['set-cookie'].should == "csrf_id=12345; path=/, _github_ses=A123CdE; path=/"
+  end
+
+  # Backwards-compatibility - previously, #headers returned a Hash
+  it "responds to hash methods" do
+    response = HTTParty::Response.new(@response_object, @parsed_response)
+    hash_methods = {}.methods - response.headers.methods
+    hash_methods.each do |method_name|
+      response.headers.respond_to?(method_name).should be_true
+    end
+  end
+
+  xit "should allow hashes to be accessed with dot notation" do
+    response = HTTParty::Response.new({'foo' => 'bar'}, "{foo:'bar'}", 200, 'OK')
+    response.foo.should == 'bar'
+  end
+
+  xit "should allow nested hashes to be accessed with dot notation" do
+    response = HTTParty::Response.new({'foo' => {'bar' => 'baz'}}, "{foo: {bar:'baz'}}", 200, 'OK')
+    response.foo.should == {'bar' => 'baz'}
+    response.foo.bar.should == 'baz'
+  end
+end