httparty 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,9 @@
+== 0.1.1 2008-07-30
+
+* 2 major enhancement:
+	* Added :basic_auth key for options when making a request
+	* :query and :body both now work with query string or hash
+
 == 0.1.0 2008-07-27
 
 * 1 major enhancement:

data/Manifest.txt

@@ -27,3 +27,5 @@ spec/spec_helper.rb
 tasks/deployment.rake
 tasks/environment.rake
 tasks/website.rake
+website/css/common.css
+website/index.html

data/examples/delicious.rb

@@ -8,8 +8,8 @@ class Delicious
   base_uri 'https://api.del.icio.us/v1'
   format :xml
   
-  def initialize(user, pass)
-    self.class.basic_auth(user, pass)
+  def initialize(u, p)
+    @auth = {:username => u, :password => p}
   end
   
   # query params that filter the posts are:
@@ -18,23 +18,21 @@ class Delicious
   #   url (optional). Filter by this url.
   #   ie: posts(:query => {:tag => 'ruby'})
   def posts(options={})
+    options.merge!({:basic_auth => @auth})
     # get posts and convert to structs so we can do .key instead of ['key'] with results
-    self.class.get('/posts/get', options)['posts']['post'].map { |b| b.to_struct }
+    self.class.get('/posts/get', options)
   end
   
   # query params that filter the posts are:
   #   tag (optional). Filter by this tag.
   #   count (optional). Number of items to retrieve (Default:15, Maximum:100).
   def recent(options={})
-    self.class.get('/posts/recent', options)['posts']['post'].map { |b| b.to_struct }
+    options.merge!({:basic_auth => @auth})
+    self.class.get('/posts/recent', options)
   end
 end
 
 delicious = Delicious.new(config['username'], config['password'])
-
 pp delicious.posts(:query => {:tag => 'ruby'})
-
-puts '', '*' * 50, ''
-
 pp delicious.recent
 

data/examples/twitter.rb

@@ -7,30 +7,25 @@ class Twitter
   include HTTParty
   base_uri 'twitter.com'
   
-  def initialize(user, pass)
-    self.class.basic_auth user, pass
+  def initialize(u, p)
+    @auth = {:username => u, :password => p}
   end
   
   # which can be :friends, :user or :public
   # options[:query] can be things like since, since_id, count, etc.
   def timeline(which=:friends, options={})
-    self.class.get("/statuses/#{which}_timeline.xml", options)['statuses'].map { |s| s.to_struct }
+    options.merge!({:basic_auth => @auth})
+    self.class.get("/statuses/#{which}_timeline.json", options)
   end
   
   def post(text)
-    self.class.post('/statuses/update.xml', :query => {:status => text})['status'].to_struct
+    options = { :query => {:status => text}, :basic_auth => @auth }
+    self.class.post('/statuses/update.json', options)
   end
 end
 
-
 twitter = Twitter.new(config['email'], config['password'])
-
-twitter.timeline.each do |s|
-  puts s.user.name, s.text, "#{s.created_at} #{s.id}", ''
-end
-
-# twitter.timeline(:friends, :query => {:since_id => 868482746}).each do |s|
-#   puts s.user.name, s.text, "#{s.created_at} #{s.id}", ''
-# end
-# 
+pp twitter.timeline
+# pp twitter.timeline(:friends, :query => {:since_id => 868482746})
+# pp twitter.timeline(:friends, :query => 'since_id=868482746')
 # pp twitter.post('this is a test')

data/httparty.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = %q{httparty}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2008-07-28}
+  s.date = %q{2008-07-31}
   s.description = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.email = ["nunemaker@gmail.com"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt"]
-  s.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/twitter.rb", "examples/whoismyrep.rb", "httparty.gemspec", "lib/httparty.rb", "lib/httparty/core_ext.rb", "lib/httparty/core_ext/hash.rb", "lib/httparty/version.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "spec/hash_spec.rb", "spec/httparty_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/deployment.rake", "tasks/environment.rake", "tasks/website.rake"]
+  s.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/twitter.rb", "examples/whoismyrep.rb", "httparty.gemspec", "lib/httparty.rb", "lib/httparty/core_ext.rb", "lib/httparty/core_ext/hash.rb", "lib/httparty/version.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "spec/hash_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"]
   s.has_rdoc = true
   s.homepage = %q{http://httparty.rubyforge.org}
   s.post_install_message = %q{When you HTTParty, you must party hard!}

data/lib/httparty.rb

@@ -28,10 +28,15 @@ module HTTParty
       @base_uri = normalize_base_uri(base_uri)
     end
     
+    # Warning: This is not thread safe most likely and
+    # only works if you use one set of credentials. I
+    # leave it because it is convenient on some occasions.
     def basic_auth(u, p)
       @auth = {:username => u, :password => p}
     end
     
+    # Updates the default query string parameters
+    # that should be appended to each request.
     def default_params(h={})
       raise ArgumentError, 'Default params must be a hash' unless h.is_a?(Hash)
       @default_params ||= {}
@@ -83,26 +88,34 @@ module HTTParty
         @http
       end
       
+      # FIXME: this method is doing way to much and needs to be split up
       # options can be any or all of:
-      #   query   => hash of keys/values to be converted to query string
-      #   body    => string for raw post data
-      #   headers => hash of headers to send request with
+      #   query       => hash of keys/values or a query string (foo=bar&baz=poo)
+      #   body        => hash of keys/values or a query string (foo=bar&baz=poo)
+      #   headers     => hash of headers to send request with
+      #   basic_auth  => :username and :password to use as basic http authentication (overrides @auth class instance variable)
       def send_request(method, path, options={})
         raise ArgumentError, 'only get, post, put and delete methods are supported' unless %w[get post put delete].include?(method.to_s)
-        raise ArgumentError, ':query must be a hash' if options[:query] && !options[:query].is_a?(Hash)
         raise ArgumentError, ':headers must be a hash' if options[:headers] && !options[:headers].is_a?(Hash)
+        raise ArgumentError, ':basic_auth must be a hash' if options[:basic_auth] && !options[:basic_auth].is_a?(Hash)
         # we always want path that begins with /
-        path         = path =~ /^(\/|https?:\/\/)/ ? path : "/#{path}"
-        @format    ||= format_from_path(path)
-        uri          = URI.parse("#{base_uri}#{path}")
-        current_qs   = uri.query ? "#{uri.query}&" : ''
-        uri.query    = current_qs + default_params.merge(options[:query] || {}).to_query
-        klass        = Net::HTTP.const_get method.to_s.downcase.capitalize
-        request      = klass.new(uri.request_uri)
-        request.body = options[:body] unless options[:body].blank?
+        path           = path =~ /^(\/|https?:\/\/)/ ? path : "/#{path}"
+        @format      ||= format_from_path(path)
+        uri            = URI.parse("#{base_uri}#{path}")
+        existing_query = uri.query ? "#{uri.query}&" : ''
+        uri.query      = if options[:query].blank?
+          existing_query
+        else
+          existing_query + (options[:query].is_a?(Hash) ? default_params.merge(options[:query]).to_query : options[:query])
+        end
+        klass          = Net::HTTP.const_get method.to_s.downcase.capitalize
+        request        = klass.new(uri.request_uri)
+        request.body   = options[:body].is_a?(Hash) ? options[:body].to_query : options[:body] unless options[:body].blank?
+        basic_auth     = options.delete(:basic_auth) || @auth
         request.initialize_http_header headers.merge(options[:headers] || {})
-        request.basic_auth(@auth[:username], @auth[:password]) if @auth
-        response     = http(uri).start() { |conn| conn.request(request) }
+        # note to self: self, do not put basic auth above headers because it removes basic auth
+        request.basic_auth(basic_auth[:username], basic_auth[:password]) if basic_auth
+        response       = http(uri).request(request)
         parse_response(response.body)
       end
       

data/lib/httparty/version.rb

@@ -2,7 +2,7 @@ module HTTParty
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/httparty_spec.rb

@@ -130,15 +130,15 @@ describe HTTParty do
       end.should raise_error(ArgumentError)
     end
     
-    it 'should require that :query is a hash if present' do
+    it 'should require that :headers is a hash if present' do
       lambda do
-        Foo.send(:send_request, 'get', '/foo', :query => 'string')
+        Foo.send(:send_request, 'get', '/foo', :headers => 'string')
       end.should raise_error(ArgumentError)
     end
     
-    it 'should require that :headers is a hash if present' do
+    it 'should require that :basic_auth is a hash if present' do
       lambda do
-        Foo.send(:send_request, 'get', '/foo', :headers => 'string')
+        Foo.send(:send_request, 'get', '/foo', :basic_auth => 'string')
       end.should raise_error(ArgumentError)
     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,77 @@
+<!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(user, pass)
+    self.class.basic_auth user, pass
+  end
+
+  def post(text)
+    self.class.post('/statuses/update.json', :query => {:status => text})
+  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 src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 
+<script type="text/javascript">_uacct = "UA-85301-9"; urchinTracker();</script> 
+ 
+<!-- 103bees.com 'bee' code v1.11 - please do not make any changes! --> 
+<script type="text/javascript" src="http://103bees.com/bees/?bee=3672&amp;fid=5643"></script> 
+<!-- 103bees.com 'bee' code --> 
+</body> 
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: httparty
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - John Nunemaker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-29 00:00:00 -04:00
+date: 2008-07-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,8 @@ files:
 - 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!