luigi-httparty 0.4.6

data/spec/fixtures/undefined_method_add_node_for_nil.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Entities total="0" results="0" page="1" page-size="25" href="https://s3-sandbox.parature.com/api/v1/5578/5633/Account" />

data/spec/httparty/cookie_hash_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+
+describe HTTParty::CookieHash do
+  before(:each) do
+    @cookie_hash = HTTParty::CookieHash.new
+  end
+
+  describe "#add_cookies" do
+    
+    describe "with a hash" do
+      it "should add new key/value pairs to the hash" do
+        @cookie_hash.add_cookies(:foo => "bar")
+        @cookie_hash.add_cookies(:rofl => "copter")
+        @cookie_hash.length.should eql(2)
+      end
+
+      it "should overwrite any existing key" do
+        @cookie_hash.add_cookies(:foo => "bar")
+        @cookie_hash.add_cookies(:foo => "copter")
+        @cookie_hash.length.should eql(1)
+        @cookie_hash[:foo].should eql("copter")
+      end
+    end
+
+    describe "with a string" do
+      it "should add new key/value pairs to the hash" do
+        @cookie_hash.add_cookies("first=one; second=two; third")
+        @cookie_hash[:first].should == 'one'
+        @cookie_hash[:second].should == 'two'
+        @cookie_hash[:third].should == nil
+      end
+      
+      it "should overwrite any existing key" do
+        @cookie_hash[:foo] = 'bar'
+        @cookie_hash.add_cookies("foo=tar")
+        @cookie_hash.length.should eql(1)
+        @cookie_hash[:foo].should eql("tar")
+      end
+    end
+    
+    describe 'with other class' do
+      it "should error" do
+        lambda {
+          @cookie_hash.add_cookies(Array.new)
+        }.should raise_error
+      end
+    end
+  end
+
+  # The regexen are required because Hashes aren't ordered, so a test against
+  # a hardcoded string was randomly failing.
+  describe "#to_cookie_string" do
+    before(:each) do
+      @cookie_hash.add_cookies(:foo => "bar")
+      @cookie_hash.add_cookies(:rofl => "copter")
+      @s = @cookie_hash.to_cookie_string
+    end
+
+    it "should format the key/value pairs, delimited by semi-colons" do
+      @s.should match(/foo=bar/)
+      @s.should match(/rofl=copter/)
+      @s.should match(/^\w+=\w+; \w+=\w+$/)
+    end
+    
+    it "should not include client side only cookies" do
+      @cookie_hash.add_cookies(:path => "/")
+      @s = @cookie_hash.to_cookie_string
+      @s.should_not match(/path=\//)
+    end
+  end
+end

data/spec/httparty/request_spec.rb

@@ -0,0 +1,244 @@
+require File.expand_path(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
+  
+  describe "#format" do
+    it "should return the correct parsing format" do
+      @request.format.should == :xml
+    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 "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 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
+
+    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
+  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
+      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
+    stub_response "", 204
+
+    @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
+    @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 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
+      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
+end
+
+describe HTTParty::Request, "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

data/spec/httparty/response_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(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'
+      @message = 'OK'
+      @response = HTTParty::Response.new(@response_object, @body, @code, @message)
+    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.to_s == @code
+    end
+
+    it "should set code as a Fixnum" do
+      @response.code.should be_an_instance_of(Fixnum)
+    end
+    
+    it "should set body" do
+      @response.body.should == @body
+    end
+    
+    it "should inflect its body, code, and message" do
+      [:body, :code, :message].each do |method|
+        @response.respond_to?(method).should be true
+      end
+    end
+  end
+  
+  it "should be able to set headers during initialization" do
+    response = HTTParty::Response.new({'foo' => 'bar'}, "{foo:'bar'}", 200, 'OK', {'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, 'OK')
+    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, 'OK')
+    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, '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

data/spec/httparty_spec.rb

@@ -0,0 +1,328 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe HTTParty do
+  before(:each) do
+    @klass = Class.new
+    @klass.instance_eval { include HTTParty }
+  end
+
+  describe "base uri" do
+    before(:each) do
+      @klass.base_uri('api.foo.com/v1')
+    end
+
+    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'
+    end
+
+    it 'should not modify the parameter during assignment' do
+      uri = 'http://api.foobar.com'
+      @klass.base_uri(uri)
+      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'
+    end
+
+    it 'should not modify the parameter' do
+      uri = 'http://api.foobar.com'
+      HTTParty.normalize_base_uri(uri)
+      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
+    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 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"
+
+        @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
+      @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 "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
+      end.should raise_error(HTTParty::UnsupportedFormat)
+    end
+
+    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: html, json, plain, xml, yaml")
+    end
+
+  end
+
+  describe "with explicit override of automatic redirect handling" do
+
+    it "should fail with redirected GET" do
+      lambda do
+        @klass.get('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    end
+
+    it "should fail with redirected POST" do
+      lambda do
+        @klass.post('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    end
+
+    it "should fail with redirected DELETE" do
+      lambda do
+        @klass.delete('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    end
+
+    it "should fail with redirected PUT" do
+      lambda do
+        @klass.put('/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
+        base_uri "http://first.com"
+        default_params :one => 1
+      end
+
+      @additional_klass = Class.new
+      @additional_klass.instance_eval do
+        include HTTParty
+        base_uri "http://second.com"
+        default_params :two => 2
+      end
+    end
+
+    it "should not run over each others options" do
+      @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')
+    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", 
+        "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", 
+        "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
+    end
+  end
+end