alexvollmer-httparty 0.1.5

data/spec/httparty/request_spec.rb

@@ -0,0 +1,142 @@
+require 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 '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
+    end
+
+    it 'should not use ssl for port 80' do
+      @request.send(:http, URI.parse('http://foobar.com')).use_ssl?.should == false
+    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
+  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)
+
+    @request.options[:format] = :xml
+    @request.perform.should be_nil
+
+    response.stub!(:body).and_return("")
+    @request.perform.should be_nil
+  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
+
+    def setup_ok_response
+      @ok = Net::HTTPOK.new("1.1", 200, "Content for you")
+      @ok.stub!(:body).and_return({"foo" => "bar"}.to_xml)
+      @http.should_receive(:request).and_return(@redirect, @ok)
+      @request.options[:format] = :xml
+    end
+
+    def setup_redirect_response
+      @http.stub!(:request).and_return(@redirect)
+    end
+
+    def setup_successful_redirect
+      setup_redirect
+      setup_ok_response
+    end
+
+    def setup_infinite_redirect
+      setup_redirect
+      setup_redirect_response
+    end
+
+    it "should handle redirects for GET transparently" do
+      setup_successful_redirect
+      @request.perform.should == {"hash" => {"foo" => "bar"}}
+    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
+
+    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 handle redirects for PUT transparently" do
+      setup_successful_redirect
+      @request.http_method = Net::HTTP::Put
+      @request.perform.should == {"hash" => {"foo" => "bar"}}
+    end
+
+    it "should prevent infinite loops" do
+      setup_infinite_redirect
+
+      lambda do
+        @request.perform
+      end.should raise_error(HTTParty::RedirectionTooDeep)
+    end
+
+    describe "with explicit override of automatic redirect handling" do
+      before(:each) do
+        @request.options = { :no_follow => true }
+        setup_redirect_response
+      end
+
+      it "should fail with redirected GET" do
+        lambda do
+          @request.http_method = Net::HTTP::Get
+          @request.perform
+        end.should raise_error(HTTParty::RedirectionTooDeep)
+      end
+
+      it "should fail with redirected POST" do
+        lambda do
+          @request.http_method = Net::HTTP::Post
+          @request.perform
+        end.should raise_error(HTTParty::RedirectionTooDeep)
+      end
+
+      it "should fail with redirected DELETE" do
+        lambda do
+          @request.http_method = Net::HTTP::Delete
+          @request.perform
+        end
+      end
+
+      it "should fail with redirected PUT" do
+        lambda do
+          @request.http_method = Net::HTTP::Put
+          @request.perform
+        end
+      end
+    end
+  end
+end

data/spec/httparty_spec.rb

@@ -0,0 +1,149 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+class Foo
+  include HTTParty
+  base_uri 'api.foo.com/v1'
+end
+
+class FooWithHttps
+  include HTTParty
+  base_uri 'api.foo.com/v1:443'
+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
+
+    it "should add http if not present for non ssl requests" do
+      Foo.base_uri('api.foobar.com')
+      Foo.base_uri.should == 'http://api.foobar.com'
+    end
+
+    it "should add https if not present for ssl requests" do
+      Foo.base_uri('api.foo.com/v1:443')
+      Foo.base_uri.should == 'https://api.foo.com/v1:443'
+    end
+
+    it "should not remove https for ssl requests" do
+      Foo.base_uri('https://api.foo.com/v1:443')
+      Foo.base_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
+
+    describe "that respond with redirects" do
+      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
+        end
+
+        it "should fail with redirected PUT" do
+          lambda do
+            Foo.put('/foo', :no_follow => true)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'httparty')

data/tasks/deployment.rake

@@ -0,0 +1,43 @@
+desc 'Preps the gem for a new release'
+task :prep_for_release do
+  require 'rio'
+  Rake::Task['manifest:refresh'].invoke
+  gemspec = %x[rake debug_gem]
+  lines = gemspec.split("\n")
+  rio('httparty.gemspec') < lines[1, lines.length-1].join("\n")
+end
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_upload, :publish_docs]

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,83 @@
+<!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></p> 
+	</div> 
+</div> 
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+var pageTracker = _gat._getTracker("UA-85301-19");
+pageTracker._initData();
+pageTracker._trackPageview();
+</script>
+ 
+</body> 
+</html>

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: alexvollmer-httparty
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Makes http fun! Also, makes consuming restful web services dead easy.
+email: 
+- nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- examples/aaws.rb
+- examples/delicious.rb
+- examples/google.rb
+- examples/twitter.rb
+- examples/whoismyrep.rb
+- httparty.gemspec
+- lib/httparty.rb
+- lib/httparty/request.rb
+- lib/httparty/version.rb
+- script/console
+- script/destroy
+- script/generate
+- script/txt2html
+- setup.rb
+- spec/httparty/request_spec.rb
+- spec/httparty_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/website.rake
+- 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: 
+- --main
+- README.txt
+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: "0"
+  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: []
+