jugend-httparty 0.5.2.1

data/spec/httparty_spec.rb

@@ -0,0 +1,514 @@
+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
+    @klass = Class.new
+    @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')
+    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 "default timeout" do
+    it "should default to nil" do
+      @klass.default_options[:timeout].should == nil
+    end
+
+    it "should support updating" do
+      @klass.default_timeout 10
+      @klass.default_options[:timeout].should == 10
+    end
+  end
+
+  describe "debug_output" do
+    it "stores the given stream as a default_option" do
+      @klass.debug_output $stdout
+      @klass.default_options[:debug_output].should == $stdout
+    end
+
+    it "stores the $stderr stream by default" do
+      @klass.debug_output
+      @klass.default_options[:debug_output].should == $stderr
+    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 "digest http authentication" do
+    it "should work" do
+      @klass.digest_auth 'foobar', 'secret'
+      @klass.default_options[:digest_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 unless defined?(MyParser)
+      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
+      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, "':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 "#no_follow" do
+    it "sets no_follow to false by default" do
+      @klass.no_follow
+      @klass.default_options[:no_follow].should be_false
+    end
+
+    it "sets the no_follow option to true" do
+      @klass.no_follow true
+      @klass.default_options[:no_follow].should be_true
+    end
+  end
+
+  describe "#maintain_method_across_redirects" do
+    it "sets maintain_method_across_redirects to true by default" do
+      @klass.maintain_method_across_redirects
+      @klass.default_options[:maintain_method_across_redirects].should be_true
+    end
+
+    it "sets the maintain_method_across_redirects option to false" do
+      @klass.maintain_method_across_redirects false
+      @klass.default_options[:maintain_method_across_redirects].should be_false
+    end
+  end
+
+  describe "with explicit override of automatic redirect handling" do
+    before do
+      @request = HTTParty::Request.new(Net::HTTP::Get, 'http://api.foo.com/v1', :format => :xml, :no_follow => true)
+      @redirect = stub_response 'first redirect', 302
+      @redirect['location'] = 'http://foo.com/bar'
+      HTTParty::Request.stub(:new => @request)
+    end
+
+    it "should fail with redirected GET" do
+      lambda do
+        @error = @klass.get('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
+    end
+
+    it "should fail with redirected POST" do
+      lambda do
+        @klass.post('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
+    end
+
+    it "should fail with redirected DELETE" do
+      lambda do
+        @klass.delete('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
+    end
+
+    it "should fail with redirected PUT" do
+      lambda do
+        @klass.put('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
+    end
+
+    it "should fail with redirected HEAD" do
+      lambda do
+        @klass.head('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
+    end
+
+    it "should fail with redirected OPTIONS" do
+      lambda do
+        @klass.options('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep) {|e| e.response.body.should == 'first redirect'}
+    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 "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",
+        "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 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

@@ -0,0 +1,3 @@
+--colour
+--format specdoc
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'httparty')
+require 'spec/autorun'
+require 'fakeweb'
+
+def file_fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+end
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  config.include HTTParty::StubResponse
+  config.before(:suite) do
+    FakeWeb.allow_net_connect = false
+  end
+  config.after(:suite) do
+    FakeWeb.allow_net_connect = true
+  end
+end

data/spec/support/stub_response.rb

@@ -0,0 +1,30 @@
+module HTTParty
+  module StubResponse
+    def stub_http_response_with(filename)
+      format = filename.split('.').last.intern
+      data = file_fixture(filename)
+
+      response = Net::HTTPOK.new("1.1", 200, "Content for you")
+      response.stub!(:body).and_return(data)
+
+      http_request = HTTParty::Request.new(Net::HTTP::Get, 'http://localhost', :format => format)
+      http_request.stub!(:perform_actual_request).and_return(response)
+
+      HTTParty::Request.should_receive(:new).and_return(http_request)
+    end
+
+    def stub_response(body, code = 200)
+      unless defined?(@http) && @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
+  end
+end

data/website/css/common.css

@@ -0,0 +1,47 @@
+@media screen, projection {
+	/*
+	Copyright (c) 2007, Yahoo! Inc. All rights reserved.
+	Code licensed under the BSD License:
+	http://developer.yahoo.net/yui/license.txt
+	version: 2.2.0
+	*/
+	body {font:13px arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}select, input, textarea {font:99% arial,helvetica,clean,sans-serif;}pre, code {font:115% monospace;*font-size:100%;}body * {line-height:1.22em;}
+	body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}/*ol,ul {list-style:none;}*/caption,th {text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;}
+	/* end of yahoo reset and fonts */
+	
+	body 										{color:#333; background:#4b1a1a; line-height:1.3;}
+	p												{margin:0 0 20px;}
+	a												{color:#4b1a1a;}
+	a:hover									{text-decoration:none;}
+	strong									{font-weight:bold;}
+	em											{font-style:italics;}
+	h1,h2,h3,h4,h5,h6				{font-weight:bold;}
+	h1											{font-size:197%; margin:30px 0; color:#4b1a1a;}
+	h2											{font-size:174%; margin:20px 0; color:#b8111a;}
+	h3											{font-size:152%; margin:10px 0;}
+	h4											{font-size:129%; margin:10px 0;}
+	pre 										{background:#eee; margin:0 0 20px; padding:20px; border:1px solid #ccc; font-size:100%; overflow:auto;}
+	code										{font-size:100%; margin:0; padding:0;}
+	ul, ol									{margin:10px 0 10px 25px;}
+	ol li										{margin:0 0 10px;}
+
+
+
+
+
+	div#wrapper 							{background:#fff; width:560px; margin:0 auto; padding:20px; border:10px solid #bc8c46; border-width:0 10px;}
+	div#header								{position:relative; border-bottom:1px dotted; margin:0 0 10px; padding:0 0 10px;}
+	div#header p							{margin:0; padding:0;}
+	div#header h1							{margin:0; padding:0;}
+	ul#nav										{position:absolute; top:0; right:0; list-style:none; margin:0; padding:0;}
+	ul#nav li									{display:inline; padding:0 0 0 5px;}
+	ul#nav li a								{}
+	div#content								{}
+	div#footer								{margin:40px 0 0; border-top:1px dotted; padding:10px 0 0;}
+
+
+
+
+
+
+}

data/website/index.html

@@ -0,0 +1,73 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 
+<head> 
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> 
+  <title>HTTParty by John Nunemaker</title> 
+  <link rel="stylesheet" href="css/common.css" type="text/css" /> 
+</head> 
+<body> 
+ 
+<div id="wrapper"> 
+  <div id="header"> 
+    <h1>HTTParty</h1> 
+    <p>Tonight we're gonna HTTParty like it's 1999!</p> 
+    
+    <ul id="nav">
+      <li><a href="rdoc/">Docs</a></li> 
+      <li><a href="http://github.com/jnunemaker/httparty">Github</a></li>
+      <li><a href="http://rubyforge.org/projects/httparty/">Rubyforge</a></li> 
+    </ul> 
+  </div> 
+  
+  <div id="content"> 
+    <h2>Install</h2> 
+    <pre><code>$ sudo gem install httparty</code></pre> 
+    
+    <h2>Some Quick Examples</h2>
+    
+    <p>The following is a simple example of wrapping Twitter's API for posting updates.</p>
+
+<pre><code>class Twitter
+  include HTTParty
+  base_uri 'twitter.com'
+  basic_auth 'username', 'password'
+end
+
+Twitter.post('/statuses/update.json', :query => {:status => "It's an HTTParty and everyone is invited!"})</code></pre>
+
+    <p>That is really it! The object returned is a ruby hash that is decoded from Twitter's json response. JSON parsing is used because of the .json extension in the path of the request. You can also explicitly set a format (see the examples). </p>
+
+    <p>That works and all but what if you don't want to embed your username and password in the class? Below is an example to fix that:</p>
+
+<pre><code>class Twitter
+  include HTTParty
+  base_uri 'twitter.com'
+
+  def initialize(u, p)
+    @auth = {:username => u, :password => p}
+  end
+
+  def post(text)
+    options = { :query => {:status => text}, :basic_auth => @auth }
+    self.class.post('/statuses/update.json', options)
+  end
+end
+
+Twitter.new('username', 'password').post("It's an HTTParty and everyone is invited!")</code></pre>
+    
+    <p><strong>More Examples:</strong> There are <a href="http://github.com/jnunemaker/httparty/tree/master/examples/">several examples in the gem itself</a>.</p>
+    
+    <h2>Support</h2> 
+    <p>Conversations welcome in the <a href="http://groups.google.com/group/httparty-gem">google group</a> and bugs/features over at <a href="http://github.com/jnunemaker/httparty">Github</a>.</p> 
+    
+    
+  </div> 
+ 
+  <div id="footer"> 
+    <p>Created by <a href="http://addictedtonew.com/about/">John Nunemaker</a> | 
+      <a href="http://orderedlist.com/">Hire Me at Ordered List</a></p> 
+  </div> 
+</div> 
+ 
+</body> 
+</html>