juliocesar-httparty 0.2.6

data/spec/httparty_spec.rb

@@ -0,0 +1,181 @@
+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
+  
+  describe "base uri" do
+    before do
+      Foo.base_uri('api.foo.com/v1')
+    end
+
+    it "should have reader" do
+      Foo.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'
+    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
+  end
+  
+  describe "headers" do
+    it "should default to empty hash" do
+      Foo.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
+    end
+  end
+  
+  describe "default params" do
+    it "should default to empty hash" do
+      Foo.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
+    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'}
+    end
+  end
+  
+  describe "format" do
+    it "should allow xml" do
+      Foo.format :xml
+      Foo.default_options[:format].should == :xml
+    end
+    
+    it "should allow json" do
+      Foo.format :json
+      Foo.default_options[:format].should == :json
+    end
+    
+    it 'should not allow funky format' do
+      lambda do
+        Foo.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
+
+    it "should fail with redirected DELETE" do
+      lambda do
+        Foo.delete('/foo', :no_follow => true)
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    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'}}
+    end
+  end
+  
+  describe "#get" do
+    it "should be able to get html" do
+      stub_http_response_with('google.html')
+      resp = HTTParty.get('http://www.google.com')
+      resp.should == file_fixture('google.html')
+      resp.original_body.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"
+      }
+      tweets.original_body.should == file_fixture('twitter.json')
+    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
+      }
+      tweets.original_body.should == file_fixture('twitter.xml')
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--format
+  progress
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'httparty')
+
+def file_fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}")).read
+end
+
+def stub_http_response_with(filename)
+  format = filename.split('.').last.intern
+  data = file_fixture(filename)
+  http = Net::HTTP.new('localhost', 80)
+  
+  response = Net::HTTPOK.new("1.1", 200, "Content for you")
+  response.stub!(:body).and_return(data)
+  http.stub!(:request).and_return(response)
+  
+  http_request = HTTParty::Request.new(Net::HTTP::Get, '')
+  http_request.stub!(:get_response).and_return(response)
+  http_request.stub!(:format).and_return(format)
+  
+  HTTParty::Request.should_receive(:new).and_return(http_request)
+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,74 @@
+<!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://jnunemaker.lighthouseapp.com/projects/14842-httparty/tickets">Lighthouse</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://jnunemaker.lighthouseapp.com/projects/14842-httparty/overview">Lightouse</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>

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: juliocesar-httparty
+version: !ruby/object:Gem::Version 
+  version: 0.2.6
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-05 00:00:00 -08:00
+default_executable: httparty
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Makes http fun! Also, makes consuming restful web services dead easy.
+email: nunemaker@gmail.com
+executables: 
+- httparty
+extensions: []
+
+extra_rdoc_files: 
+- bin/httparty
+- lib/core_extensions.rb
+- lib/httparty/exceptions.rb
+- lib/httparty/request.rb
+- lib/httparty/version.rb
+- lib/httparty.rb
+- lib/module_level_inheritable_attributes.rb
+- README
+files: 
+- bin/httparty
+- examples/aaws.rb
+- examples/basic.rb
+- examples/delicious.rb
+- examples/google.rb
+- examples/rubyurl.rb
+- examples/twitter.rb
+- examples/whoismyrep.rb
+- History
+- httparty.gemspec
+- lib/core_extensions.rb
+- lib/httparty/exceptions.rb
+- lib/httparty/request.rb
+- lib/httparty/version.rb
+- lib/httparty.rb
+- lib/module_level_inheritable_attributes.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README
+- setup.rb
+- spec/as_buggery_spec.rb
+- spec/fixtures/delicious.xml
+- spec/fixtures/google.html
+- spec/fixtures/twitter.json
+- spec/fixtures/twitter.xml
+- spec/httparty/request_spec.rb
+- spec/httparty_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- website/css/common.css
+- website/index.html
+has_rdoc: true
+homepage: http://httparty.rubyforge.org
+post_install_message: When you HTTParty, you must party hard!
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Httparty
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: httparty
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Makes http fun! Also, makes consuming restful web services dead easy.
+test_files: []
+