alexvollmer-httparty 0.2.6 → 0.3.1

data/spec/httparty/request_spec.rb

@@ -1,6 +1,20 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe HTTParty::Request do
+  def stub_response(body, code = 200)
+    unless @http
+      @http = Net::HTTP.new('localhost', 80)
+      @request.stub!(:http).and_return(@http)
+      @request.stub!(:uri).and_return(URI.parse("http://foo.com/foobar"))
+    end
+
+    response = Net::HTTPResponse::CODE_TO_OBJ[code.to_s].new("1.1", code, body)
+    response.stub!(:body).and_return(body)
+
+    @http.stub!(:request).and_return(response)
+    response
+  end
+
   before do
     @request = HTTParty::Request.new(Net::HTTP::Get, 'http://api.foo.com/v1', :format => :xml)
   end
@@ -13,14 +27,98 @@ describe HTTParty::Request do
 
   describe 'http' do
     it "should use ssl for port 443" do
-      @request.send(:http, URI.parse('https://api.foo.com/v1:443')).use_ssl?.should == true
+      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.send(:http, URI.parse('http://foobar.com')).use_ssl?.should == false
+      request = HTTParty::Request.new(Net::HTTP::Get, 'http://foobar.com')
+      @request.send(:http).use_ssl?.should == false
+    end
+
+    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
+  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 '#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>]
@@ -33,112 +131,153 @@ describe HTTParty::Request do
       @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
+
+      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
-    http = Net::HTTP.new('localhost', 80)
-    @request.stub!(:http).and_return(http)
-    response = Net::HTTPNoContent.new("1.1", 204, "No content for you")
-    response.stub!(:body).and_return(nil)
-    http.stub!(:request).and_return(response)
+    stub_response "", 204
 
     @request.options[:format] = :xml
     @request.perform.should be_nil
-
-    response.stub!(:body).and_return("")
-    @request.perform.should be_nil
   end
   
   it "should not fail for missing mime type" do
-    http = Net::HTTP.new('localhost', 80)
-    @request.stub!(:http).and_return(http)
-    
-    response = Net::HTTPOK.new("1.1", 200, "Content for you")
-    response.stub!(:[]).with('content-type').and_return(nil)
-    response.stub!(:body).and_return('Content for you')
-    
-    http.stub!(:request).and_return(response)
-    
+    stub_response "Content for you"
     @request.options[:format] = :html
-    @request.perform.should == 'Content for you'
+    @request.perform.body.should == 'Content for you'
   end
 
-  describe 'when we ask for the original body' do
-    it 'should add _body attribute in XML' do
-      xml = %q[<books><book><id>1234</id><name>Foo Bar!</name></book></books>]
-      @request.options[:keep_body] = true
-      @request.options[:format] = :xml
-      @request.send(:parse_response, xml).should == {'books' => {'book' => {'id' => '1234', 'name' => 'Foo Bar!'}}, '_body' => xml}
-    end
+  it "should drop query parameters when following redirects" do
+    request = HTTParty::Request.new(Net::HTTP::Post,
+                                    'http://api.foo.com/foo',
+                                    :query => { :bar => 1 },
+                                    :format => :xml)
 
-    it 'should add _body attribute in JSON' do
-      json = %q[{"books": {"book": {"name": "Foo Bar!", "id": "1234"}}}]
-      @request.options[:keep_body] = true
-      @request.options[:format] = :json
-      @request.send(:parse_response, json).should == {'books' => {'book' => {'id' => '1234', 'name' => 'Foo Bar!'}}, '_body' => json}
+    http = Net::HTTP.new('localhost', 80)
+    request.stub!(:http).and_return(http)
+    req1 = Net::HTTP::Post.new('/foo')
+    req1.should_receive(:set_form_data).once.with({ :bar => 1 })
+    req1.should_receive(:initialize_http_header).once.with(nil)
+    Net::HTTP::Post.should_receive(:new).once.with("/foo").and_return(req1)
+    redirect = stub_response('', 302)
+    redirect['location'] = 'http://api.foo.com/foo/1'
+    http.should_receive(:request).
+      once.
+      with(an_instance_of(Net::HTTP::Post)).
+      and_return(redirect)
 
-    end
+    req2 = Net::HTTP::Get.new('/foo/1')
+    Net::HTTP::Get.should_receive(:new).once.with("/foo/1").and_return(req2)
+    ok = stub_response('<hash><foo>bar</foo></hash>', 200)
+    http.should_receive(:request).
+      once.
+      with(an_instance_of(Net::HTTP::Get)).
+      and_return(ok)
+
+    request.perform.should == { "hash" => { "foo" => "bar" }}
   end
 
-  describe "that respond with redirects" do
-    def setup_redirect
-      @http = Net::HTTP.new('localhost', 80)
-      @request.stub!(:http).and_return(@http)
-      @request.stub!(:uri).and_return(URI.parse("http://foo.com/foobar"))
-      @redirect = Net::HTTPFound.new("1.1", 302, "")
-      @redirect['location'] = '/foo'
-    end
+  it "should not follow redirects after POST if no_follow is set" do
+    request = HTTParty::Request.new(Net::HTTP::Post,
+                                    'http://api.foo.com/foo',
+                                    :query => { :bar => 1 },
+                                    :no_follow => true,
+                                    :format => :xml)
 
-    def setup_ok_response
-      @ok = Net::HTTPOK.new("1.1", 200, "Content for you")
-      @ok.stub!(:body).and_return('<hash><foo>bar</foo></hash>')
-      @http.should_receive(:request).and_return(@redirect, @ok)
-      @request.options[:format] = :xml
-    end
+    http = Net::HTTP.new('localhost', 80)
+    request.stub!(:http).and_return(http)
+    req1 = Net::HTTP::Post.new('/foo')
+    req1.should_receive(:set_form_data).once.with({ :bar => 1 })
+    req1.should_receive(:initialize_http_header).once.with(nil)
+    Net::HTTP::Post.should_receive(:new).once.with("/foo").and_return(req1)
+    redirect = stub_response('', 302)
+    redirect['location'] = 'http://api.foo.com/foo/1'
+    http.should_receive(:request).
+      once.
+      with(an_instance_of(Net::HTTP::Post)).
+      and_return(redirect)
 
-    def setup_redirect_response
-      @http.stub!(:request).and_return(@redirect)
-    end
+    Net::HTTP::Get.should_not_receive(:new).with("/foo/1")
 
-    def setup_successful_redirect
-      setup_redirect
-      setup_ok_response
-    end
+    lambda {
+      request.perform.should be_empty
+    }.should raise_error(HTTParty::RedirectionTooDeep)
+  end
 
-    def setup_infinite_redirect
-      setup_redirect
-      setup_redirect_response
-    end
+  describe "a request that redirects" do
+    before(:each) do
+      @redirect = stub_response("", 302)
+      @redirect['location'] = '/foo'
 
-    it "should handle redirects for GET transparently" do
-      setup_successful_redirect
-      @request.perform.should == {"hash" => {"foo" => "bar"}}
+      @ok = stub_response('<hash><foo>bar</foo></hash>', 200)
     end
 
-    it "should handle redirects for POST transparently" do
-      setup_successful_redirect
-      @request.http_method = Net::HTTP::Post
-      @request.perform.should == {"hash" => {"foo" => "bar"}}
-    end
+    describe "once" do
+      before(:each) do
+        @http.stub!(:request).and_return(@redirect, @ok)
+      end
 
-    it "should handle redirects for DELETE transparently" do
-      setup_successful_redirect
-      @request.http_method = Net::HTTP::Delete
-      @request.perform.should == {"hash" => {"foo" => "bar"}}
-    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 handle redirects for PUT transparently" do
-      setup_successful_redirect
-      @request.http_method = Net::HTTP::Put
-      @request.perform.should == {"hash" => {"foo" => "bar"}}
+      it "should be handled by PUT transparently" do
+        @request.http_method = Net::HTTP::Put
+        @request.perform.should == {"hash" => {"foo" => "bar"}}
+      end
     end
 
-    it "should prevent infinite loops" do
-      setup_infinite_redirect
+    describe "infinitely" do
+      before(:each) do
+        @http.stub!(:request).and_return(@redirect)
+      end
 
-      lambda do
-        @request.perform
-      end.should raise_error(HTTParty::RedirectionTooDeep)
+      it "should raise an exception" do
+        lambda { @request.perform }.should raise_error(HTTParty::RedirectionTooDeep)
+      end
     end
   end
 end

data/spec/httparty/response_spec.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe HTTParty::Response do
+  describe "initialization" do
+    before do
+      @response_object = {'foo' => 'bar'}
+      @body = "{foo:'bar'}"
+      @code = 200
+      @response = HTTParty::Response.new(@response_object, @body, @code)
+    end
+    
+    it "should set delegate" do
+      @response.delegate.should == @response_object
+    end
+    
+    it "should set body" do
+      @response.body.should == @body
+    end
+    
+    it "should set code" do
+      @response.code.should == @code
+    end
+  end
+  
+  it "should be able to set headers during initialization" do
+    response = HTTParty::Response.new({'foo' => 'bar'}, "{foo:'bar'}", 200, {'foo' => 'bar'})
+    response.headers.should == {'foo' => 'bar'}
+  end
+  
+  it "should send missing methods to delegate" do
+    response = HTTParty::Response.new({'foo' => 'bar'}, "{foo:'bar'}", 200)
+    response['foo'].should == 'bar'
+  end
+  
+  it "should be able to iterate delegate if it is array" do
+    response = HTTParty::Response.new([{'foo' => 'bar'}, {'foo' => 'baz'}], "[{foo:'bar'}, {foo:'baz'}]", 200)
+    response.size.should == 2
+    lambda {
+      response.each { |item| }
+    }.should_not raise_error
+  end
+  
+  xit "should allow hashes to be accessed with dot notation" do
+    response = HTTParty::Response.new({'foo' => 'bar'}, "{foo:'bar'}", 200)
+    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)
+    response.foo.should == {'bar' => 'baz'}
+    response.foo.bar.should == 'baz'
+  end
+end

data/spec/httparty_spec.rb

@@ -1,36 +1,25 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
-class Foo
-  include HTTParty
-  base_uri 'api.foo.com/v1'
-end
-
-class GRest
-  include HTTParty
-  base_uri "grest.com"
-  default_params :one => 'two'
-end
-
-class HRest
-  include HTTParty
-  base_uri "hrest.com"
-  default_params :two => 'three'
-end
-
 describe HTTParty do
-  
+  before(:each) do
+    @klass = Class.new do
+      include HTTParty
+      base_uri "http://api.foo.com"
+    end
+  end
+
   describe "base uri" do
-    before do
-      Foo.base_uri('api.foo.com/v1')
+    before(:each) do
+      @klass.base_uri('api.foo.com/v1')
     end
 
     it "should have reader" do
-      Foo.base_uri.should == 'http://api.foo.com/v1'
+      @klass.base_uri.should == 'http://api.foo.com/v1'
     end
     
     it 'should have writer' do
-      Foo.base_uri('http://api.foobar.com')
-      Foo.base_uri.should == 'http://api.foobar.com'
+      @klass.base_uri('http://api.foobar.com')
+      @klass.base_uri.should == 'http://api.foobar.com'
     end
   end
   
@@ -53,91 +42,149 @@ describe HTTParty do
   
   describe "headers" do
     it "should default to empty hash" do
-      Foo.headers.should == {}
+      @klass.headers.should == {}
     end
     
     it "should be able to be updated" do
       init_headers = {:foo => 'bar', :baz => 'spax'}
-      Foo.headers init_headers
-      Foo.headers.should == init_headers
+      @klass.headers init_headers
+      @klass.headers.should == init_headers
+    end
+  end
+
+  describe "cookies" do
+    def expect_cookie_header(s)
+      HTTParty::Request.should_receive(:new) \
+        .with(anything, anything, hash_including({ :headers => { "cookie" => s } })) \
+        .and_return(mock("mock response", :perform => nil))
+    end
+
+    it "should not be in the headers by default" do
+      HTTParty::Request.stub!(:new).and_return(stub(nil, :perform => nil))
+      @klass.get("")
+      @klass.headers.keys.should_not include("cookie")
+    end
+
+    it "should raise an ArgumentError if passed a non-Hash" do
+      lambda do
+        @klass.cookies("nonsense")
+      end.should raise_error(ArgumentError)
+    end
+
+    it "should allow a cookie to be specified with a one-off request" do
+      expect_cookie_header "type=snickerdoodle"
+      @klass.get("", :cookies => { :type => "snickerdoodle" })
+    end
+
+    describe "when a cookie is set at the class level" do
+      before(:each) do
+        @klass.cookies({ :type => "snickerdoodle" })
+      end
+
+      it "should include that cookie in the request" do
+        expect_cookie_header "type=snickerdoodle"
+        @klass.get("")
+      end
+
+      it "should allow the class defaults to be overridden" do
+        expect_cookie_header "type=chocolate_chip"
+
+        @klass.get("", :cookies => { :type => "chocolate_chip" })
+      end
+    end
+
+    describe "in a class with multiple methods that use different cookies" do
+      before(:each) do
+        @klass.instance_eval do
+          def first_method
+            get("first_method", :cookies => { :first_method_cookie => "foo" })
+          end
+
+          def second_method
+            get("second_method", :cookies => { :second_method_cookie => "foo" })
+          end
+        end
+      end
+
+      it "should not allow cookies used in one method to carry over into other methods" do
+        expect_cookie_header "first_method_cookie=foo"
+        @klass.first_method
+
+        expect_cookie_header "second_method_cookie=foo"
+        @klass.second_method
+      end
     end
   end
   
   describe "default params" do
     it "should default to empty hash" do
-      Foo.default_params.should == {}
+      @klass.default_params.should == {}
     end
     
     it "should be able to be updated" do
       new_defaults = {:foo => 'bar', :baz => 'spax'}
-      Foo.default_params new_defaults
-      Foo.default_params.should == new_defaults
+      @klass.default_params new_defaults
+      @klass.default_params.should == new_defaults
     end
   end
   
   describe "basic http authentication" do
     it "should work" do
-      Foo.basic_auth 'foobar', 'secret'
-      Foo.default_options[:basic_auth].should == {:username => 'foobar', :password => 'secret'}
+      @klass.basic_auth 'foobar', 'secret'
+      @klass.default_options[:basic_auth].should == {:username => 'foobar', :password => 'secret'}
     end
   end
   
   describe "format" do
     it "should allow xml" do
-      Foo.format :xml
-      Foo.default_options[:format].should == :xml
+      @klass.format :xml
+      @klass.default_options[:format].should == :xml
     end
     
     it "should allow json" do
-      Foo.format :json
-      Foo.default_options[:format].should == :json
+      @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 not allow funky format' do
       lambda do
-        Foo.format :foobar
+        @klass.format :foobar
       end.should raise_error(HTTParty::UnsupportedFormat)
     end
   end
 
-  describe "with explicit override of automatic redirect handling" do
-
-    it "should fail with redirected GET" do
-      lambda do
-        Foo.get('/foo', :no_follow => true)
-      end.should raise_error(HTTParty::RedirectionTooDeep)
-    end
-
-    it "should fail with redirected POST" do
-      lambda do
-        Foo.post('/foo', :no_follow => true)
-      end.should raise_error(HTTParty::RedirectionTooDeep)
-    end
+  describe "with multiple class definitions" do
+    before(:each) do
+      @klass.instance_eval do
+        base_uri "http://first.com"
+        default_params :one => 1
+      end
 
-    it "should fail with redirected DELETE" do
-      lambda do
-        Foo.delete('/foo', :no_follow => true)
-      end.should raise_error(HTTParty::RedirectionTooDeep)
+      @additional_klass = Class.new
+      @additional_klass.instance_eval do
+        include HTTParty
+        base_uri "http://second.com"
+        default_params :two => 2
+      end
     end
 
-    it "should fail with redirected PUT" do
-      lambda do
-        Foo.put('/foo', :no_follow => true)
-      end.should raise_error(HTTParty::RedirectionTooDeep)
-    end
-  end
-  
-  describe "with multiple class definitions" do
     it "should not run over each others options" do
-      HRest.default_options.should == {:base_uri => 'http://hrest.com', :default_params => {:two => 'three'}}
-      GRest.default_options.should == {:base_uri => 'http://grest.com', :default_params => {:one => 'two'}}
+      @klass.default_options.should == { :base_uri => 'http://first.com', :default_params => { :one => 1 } }
+      @additional_klass.default_options.should == { :base_uri => 'http://second.com', :default_params => { :two => 2 } }
     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')
+      resp = HTTParty.get('http://www.google.com')
+      resp.should == file_fixture('google.html')
+      resp.body.should == file_fixture('google.html')
     end
     
     it "should be able parse response type json automatically" do
@@ -155,6 +202,7 @@ describe HTTParty do
         "location"          => "Opera Plaza, California", 
         "profile_image_url" => "http://static.twitter.com/images/default_profile_normal.png"
       }
+      tweets.body.should == file_fixture('twitter.json')
     end
     
     it "should be able parse response type xml automatically" do
@@ -172,6 +220,19 @@ describe HTTParty do
         "profile_image_url" => "http://s3.amazonaws.com/twitter_production/profile_images/65565851/8ball_large_normal.jpg", 
         "location"          => nil
       }
+      tweets.body.should == file_fixture('twitter.xml')
+    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
     end
   end
 end