jugend-httparty 0.5.2.1

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.yardoc/
+doc/
+tmp/
+log/
+pkg/
+*.swp

data/History

@@ -0,0 +1,209 @@
+== 0.5.3.4
+  * Update gem name to jugend-httparty
+  
+== 0.5.3.3
+  * Remove RubyforgeTasks
+  
+== 0.5.3.2
+  * Remove deprecated rubyforge gem push
+  
+== 0.5.3.1
+  * Update Pathname initialization to support earlier version of ruby (<=1.8.4)
+
+== 0.5.3 (master)
+* major enhancements
+  * Digest Auth (bartiaco, sbecker, gilles, and aaronrussell)
+  * Maintain HTTP method across redirects (bartiaco and sbecker)
+  * HTTParty::Response#response returns the Net::HTTPResponse object
+  * HTTParty::Response#headers returns a HTTParty::Response::Headers object
+    which quacks like a Hash + Net::HTTPHeader. The #headers method continues
+    to be backwards-compatible with the old Hash return value but may become
+    deprecated in the future.
+
+* minor enhancements
+  * Update crack requirement to version 0.1.7
+    You may still get a warning because Crack's version constant is out of date
+  * Timeout option can be set for all requests using HTTParty.default_timeout (taazza)
+  * Closed #38 "headers hash should downcase keys so canonical header name can be used"
+
+== 0.5.2 2010-01-31
+* minor enhancements
+  * Update crack requirement to version 0.1.6
+
+== 0.5.1 2010-01-30
+* bug fixes
+  * Handle 304 response correctly by returning the HTTParty::Response object instead of redirecting (seth and hellvinz)
+  * Only redirect 300 responses if the header contains a Location
+  * Don't append empty query strings to the uri. Closes #31
+  * When no_follow is enabled, only raise the RedirectionTooDeep exception when a response tries redirecting. Closes #28
+
+* major enhancements
+  * Removed rubygems dependency. I suggest adding rubygems to RUBYOPT if this causes problems for you.
+    $ export RUBYOPT='rubygems'
+  * HTTParty#debug_output prints debugging information for the current request (iwarshak)
+  * HTTParty#no_follow now available as a class-level option. Sets whether or not to follow redirects.
+
+* minor enhancements
+  * HTTParty::VERSION now available
+  * Update crack requirement to version 0.1.5
+
+== 0.5.0 2009-12-07
+* bug fixes
+  * inheritable attributes no longer mutable by subclasses (yyyc514)
+  * namespace BasicObject within HTTParty to avoid class name collisions (eric)
+
+* major enhancements
+  * Custom Parsers via class or proc
+  * Deprecation warning on HTTParty::AllowedFormats
+    moved to HTTParty::Parser::SupportedFormats
+
+* minor enhancements
+  * Curl inspired output when using the binary in verbose mode (alexvollmer)
+  * raise UnsupportedURIScheme when scheme is not HTTP or HTTPS (djspinmonkey)
+  * Allow SSL for ports other than 443 when scheme is HTTPS (stefankroes)
+  * Accept PEM certificates via HTTParty#pem (chrislo)
+  * Support HEAD and OPTION verbs (grempe)
+  * Verify SSL certificates when providing a PEM file (collectiveidea/danielmorrison)
+
+== 0.4.5 2009-09-12
+* bug fixes
+  * Fixed class-level headers overwritten by cookie management code. Closes #19
+  * Fixed "superclass mismatch for class BlankSlate" error. Closes #20
+  * Fixed reading files as post data from the command line (vesan)
+
+* minor enhancements
+  * Timeout option added; will raise a Timeout::Error after the timeout has elapsed (attack). Closes #17
+    HTTParty.get "http://github.com", :timeout => 1
+  * Building gem with Jeweler
+
+== 0.4.4 2009-07-19
+* 2 minor update
+  * :query no longer sets form data. Use body and set content type to application/x-www-form-urlencoded if you need it. :query was wrong for that.
+  * Fixed a bug in the cookies class method that caused cookies to be forgotten after the first request.
+  * Also, some general cleanup of tests and such.
+  
+== 0.4.3 2009-04-23
+* 1 minor update
+  * added message to the response object
+  
+== 0.4.2 2009-03-30
+* 2 minor changes
+  * response code now returns an integer instead of a string (jqr)
+  * rubyforge project setup for crack so i'm now depending on that instead of jnunemaker-crack
+
+== 0.4.1 2009-03-29
+* 1 minor fix
+  * gem 'jnunemaker-crack' instead of gem 'crack'
+  
+== 0.4.0 2009-03-29
+* 1 minor change
+  * Switched xml and json parsing to crack (same code as before just moved to gem for easier reuse in other projects)
+  
+== 0.3.1 2009-02-10
+* 1 minor fix, 1 minor enhancement
+  * Fixed unescaping umlauts (siebertm)
+  * Added yaml response parsing (Miha Filej)
+  
+== 0.3.0 2009-01-31
+* 1 major enhancement, 1 bug fix
+  * JSON gem no longer a requirement. It was conflicting with rails json stuff so I just stole ActiveSupport's json decoding and bundled it with HTTParty.
+  * Fixed bug where query strings were being duplicated on redirects
+  * Added a bunch of specs and moved some code around.
+  
+== 0.2.10 2009-01-29
+* 1 minor enhancement
+  * Made encoding on query parameters treat everything except URI::PATTERN::UNRESERVED as UNSAFE to force encoding of '+' character (Julian Russell)
+  
+== 0.2.9 2009-01-29
+* 3 minor enhancements
+  * Added a 'headers' accessor to the response with a hash of any HTTP headers. (Don Peterson)
+  * Add support for a ":cookies" option to be used at the class level, or as an option on any individual call.  It should be passed a hash, which will be converted to the proper format and added to the request headers when the call is made. (Don Peterson)
+  * Refactored several specs and added a full suite of cucumber features (Don Peterson)
+  
+== 0.2.8 2009-01-28
+* 1 major fix
+  * fixed major bug with response where it wouldn't iterate or really work at all with parsed responses
+  
+== 0.2.7 2009-01-28
+* 2 minor fixes, 2 minor enhancements, 2 major enhancements
+  * fixed undefined method add_node for nil class error that occasionally happened (juliocesar)
+  * Handle nil or unexpected values better when typecasting. (Brian Landau)
+  * More robust handling of mime types (Alex Vollmer)
+  * Fixed support for specifying headers and added support for basic auth to CLI. (Alex Vollmer)
+  * Added first class response object that includes original body and status code (Alex Vollmer)
+  * Now parsing all response types as some non-200 responses provide important information, this means no more exception raising (Alex Vollmer)
+
+== 0.2.6 2009-01-05
+* 1 minor bug fix
+  * added explicit require of time as Time#parse failed outside of rails (willcodeforfoo)
+  
+== 0.2.5 2009-01-05
+* 1 major enhancement
+  * Add command line interface to HTTParty (Alex Vollmer)
+  
+== 0.2.4 2008-12-23
+* 1 bug fix
+  * Fixed that mimetype detection was failing if no mimetype was returned from service (skippy)
+== 0.2.3 2008-12-23
+* 1 bug fix
+  * Fixed typecasting class variable naming issue
+
+== 0.2.2 2008-12-08
+* 1 bug fix
+  * Added the missing core extension hash method to_xml_attributes
+
+== 0.2.1 2008-12-08
+* 1 bug fix
+  * Fixed that HTTParty was borking ActiveSupport and as such Rails (thanks to Rob Sanheim)
+
+== 0.2.0 2008-12-07
+* 1 major enhancement
+  * Removed ActiveSupport as a dependency. Now requires json gem for json deserialization and uses an included class to do the xml parsing.
+
+== 0.1.8 2008-11-30
+* 3 major enhancements
+  * Moved base_uri normalization into request class and out of httparty module, fixing 
+    the problem where base_uri was not always being normalized.
+  * Stupid simple support for HTTParty.get/post/put/delete. (jqr)
+  * Switched gem management to Echoe from newgem.
+
+== 0.1.7 2008-11-30
+* 1 major enhancement
+  * fixed multiple class definitions overriding each others options
+  
+== 0.1.6 2008-11-26
+* 1 major enhancement
+  * now passing :query to set_form_data if post request to avoid content length errors
+  
+== 0.1.5 2008-11-14
+* 2 major enhancements
+  * Refactored send request method out into its own object.
+  * Added :html format if you just want to do that.
+  
+== 0.1.4 2008-11-08
+* 3 major enhancements:
+  * Removed some cruft
+  * Added ability to follow redirects automatically and turn that off (Alex Vollmer)
+
+== 0.1.3 2008-08-22
+
+* 3 major enhancements:
+	* Added http_proxy key for setting proxy server and port (francxk@gmail.com)
+	* Now raises exception when http error occurs (francxk@gmail.com)
+	* Changed auto format detection from file extension to response content type (Jay Pignata)
+
+== 0.1.2 2008-08-09
+
+* 1 major enhancement:
+	* default_params were not being appended to query string if option[:query] was blank
+
+== 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:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 John Nunemaker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,47 @@
+bin/httparty
+cucumber.yml
+examples/aaws.rb
+examples/basic.rb
+examples/delicious.rb
+examples/google.rb
+examples/rubyurl.rb
+examples/twitter.rb
+examples/whoismyrep.rb
+features/basic_authentication.feature
+features/command_line.feature
+features/deals_with_http_error_codes.feature
+features/handles_multiple_formats.feature
+features/steps/env.rb
+features/steps/httparty_response_steps.rb
+features/steps/httparty_steps.rb
+features/steps/mongrel_helper.rb
+features/steps/remote_service_steps.rb
+features/supports_redirection.feature
+History
+httparty.gemspec
+lib/httparty/cookie_hash.rb
+lib/httparty/core_extensions.rb
+lib/httparty/exceptions.rb
+lib/httparty/module_inheritable_attributes.rb
+lib/httparty/request.rb
+lib/httparty/response.rb
+lib/httparty/version.rb
+lib/httparty.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+spec/fixtures/delicious.xml
+spec/fixtures/empty.xml
+spec/fixtures/google.html
+spec/fixtures/twitter.json
+spec/fixtures/twitter.xml
+spec/fixtures/undefined_method_add_node_for_nil.xml
+spec/httparty/cookie_hash_spec.rb
+spec/httparty/request_spec.rb
+spec/httparty/response_spec.rb
+spec/httparty_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+website/css/common.css
+website/index.html

data/README.rdoc

@@ -0,0 +1,54 @@
+= httparty
+
+Makes http fun again!
+
+== Note on Releases
+
+Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
+
+* rake gemspec
+* gem build httparty.gemspec
+* gem install the gem that was built
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Features:
+
+* Easy get, post requests
+* Basic http authentication
+* Default request query string parameters (ie: for api keys that are needed on each request)
+* Automatic parsing of JSON and XML into ruby hashes based on response content-type
+
+== Examples
+
+See http://github.com/jnunemaker/httparty/tree/master/examples
+
+== Command Line Interface
+
+httparty also includes the executable <tt>httparty</tt> which can be
+used to query web services and examine the resulting output. By default
+it will output the response as a pretty-printed Ruby object (useful for
+grokking the structure of output). This can also be overridden to output
+formatted XML or JSON. Execute <tt>httparty --help</tt> for all the
+options. Below is an example of how easy it is.
+
+  httparty "http://twitter.com/statuses/public_timeline.json"
+
+== Requirements
+
+* Crack http://github.com/jnunemaker/crack/ - For XML and JSON parsing.
+* You like to party!
+
+== Install
+
+* sudo gem install httparty
+
+== Docs
+
+http://rdoc.info/projects/jnunemaker/httparty

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jugend-httparty"
+    gem.summary = %Q{Makes http fun! Also, makes consuming restful web services dead easy.}
+    gem.description = %Q{Makes http fun! Also, makes consuming restful web services dead easy.}
+    gem.email = "nunemaker@gmail.com"
+    gem.homepage = "http://github.com/jugend/httparty"
+    gem.authors = ["John Nunemaker", "Sandro Turriate"]
+    gem.add_dependency 'crack', '0.1.7'
+    gem.add_development_dependency "activesupport", "~>2.3"
+    gem.add_development_dependency "cucumber", "~>0.7"
+    gem.add_development_dependency "fakeweb", "~>1.2"
+    gem.add_development_dependency "mongrel", "~>1.1"
+    gem.add_development_dependency "rspec", "~>1.3"
+    gem.post_install_message = "When you HTTParty, you must party hard!"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => [:spec, :features]
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "httparty #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('lib/httparty.rb')
+end
+
+desc 'Upload website files to rubyforge'
+task :website do
+  sh %{rsync -av website/ jnunemaker@rubyforge.org:/var/www/gforge-projects/httparty}
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['--verbose']
+  end
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.3.4

data/bin/httparty

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pp"
+
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require "httparty"
+
+opts = {
+  :action => :get,
+  :headers => {},
+  :verbose => false
+}
+
+OptionParser.new do |o|
+  o.banner = "USAGE: #{$0} [options] [url]"
+
+  o.on("-f",
+       "--format [FORMAT]",
+       "Output format to use instead of pretty-print ruby: " +
+       "plain, json or xml") do |f|
+    opts[:output_format] = f.downcase.to_sym
+  end
+
+  o.on("-a",
+       "--action [ACTION]",
+       "HTTP action: get (default), post, put, delete, head, or options") do |a|
+    opts[:action] = a.downcase.to_sym
+  end
+
+  o.on("-d",
+       "--data [BODY]",
+       "Data to put in request body (prefix with '@' for file)") do |d|
+    if d =~ /^@/
+      opts[:data] = open(d[1..-1]).read
+    else
+      opts[:data] = d
+    end
+  end
+
+  o.on("-H", "--header [NAME=VALUE]", "Additional HTTP headers in NAME=VALUE form") do |h|
+    abort "Invalid header specification, should be Name:Value" unless h =~ /.+:.+/
+    name, value = h.split(':')
+    opts[:headers][name.strip] = value.strip
+  end
+
+  o.on("-v", "--verbose", "If set, print verbose output") do |v|
+    opts[:verbose] = true
+  end
+
+  o.on("-u", "--user [CREDS]", "Use basic authentication. Value should be user:password") do |u|
+    abort "Invalid credentials format. Must be user:password" unless u =~ /.+:.+/
+    user, password = u.split(':')
+    opts[:basic_auth] = { :username => user, :password => password }
+  end
+
+  o.on("-h", "--help", "Show help documentation") do |h|
+    puts o
+    exit
+  end
+end.parse!
+
+
+if ARGV.empty?
+  STDERR.puts "You need to provide a URL"
+  STDERR.puts "USAGE: #{$0} [options] [url]"
+end
+
+def dump_headers(response)
+  resp_type = Net::HTTPResponse::CODE_TO_OBJ[response.code.to_s]
+  puts "#{response.code} #{resp_type.to_s.sub(/^Net::HTTP/, '')}"
+  response.headers.each do |n,v|
+    puts "#{n}: #{v}"
+  end
+  puts
+end
+
+if opts[:verbose]
+  puts "#{opts[:action].to_s.upcase} #{ARGV.first}"
+  opts[:headers].each do |n,v|
+    puts "#{n}: #{v}"
+  end
+  puts
+end
+
+response = HTTParty.send(opts[:action], ARGV.first, opts)
+if opts[:output_format].nil?
+  dump_headers(response) if opts[:verbose]
+  pp response
+else
+  print_format = opts[:output_format]
+  dump_headers(response) if opts[:verbose]
+
+  case opts[:output_format]
+    when :json
+      begin
+        require 'json'
+        puts JSON.pretty_generate(response.delegate)
+      rescue LoadError
+        puts YAML.dump(response.delegate)
+      end
+    when :xml
+      REXML::Document.new(response.body).write(STDOUT, 2)
+      puts
+    else
+      puts response
+  end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: features

data/examples/aaws.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'activesupport'
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+config = YAML::load(File.read(File.join(ENV['HOME'], '.aaws')))
+
+module AAWS
+  class Book
+    include HTTParty
+    base_uri 'http://ecs.amazonaws.com'
+    default_params :Service => 'AWSECommerceService', :Operation => 'ItemSearch', :SearchIndex => 'Books'
+    
+    def initialize(key)
+      self.class.default_params :AWSAccessKeyId => key
+    end
+    
+    def search(options={})
+      raise ArgumentError, 'You must search for something' if options[:query].blank?
+      
+      # amazon uses nasty camelized query params
+      options[:query] = options[:query].inject({}) { |h, q| h[q[0].to_s.camelize] = q[1]; h }
+      
+      # make a request and return the items (NOTE: this doesn't handle errors at this point)
+      self.class.get('/onca/xml', options)['ItemSearchResponse']['Items']
+    end
+  end
+end
+
+aaws = AAWS::Book.new(config[:access_key])
+pp aaws.search(:query => {:title => 'Ruby On Rails'})

data/examples/basic.rb

@@ -0,0 +1,11 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+# You can also use post, put, delete, head, options in the same fashion
+response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
+puts response.body, response.code, response.message, response.headers.inspect
+
+response.each do |item|
+  puts item['user']['screen_name']
+end

data/examples/custom_parsers.rb

@@ -0,0 +1,67 @@
+class ParseAtom
+  include HTTParty
+
+  # Support Atom along with the default parsers: xml, json, yaml, etc.
+  class Parser::Atom < HTTParty::Parser
+    SupportedFormats.merge!({"application/atom+xml" => :atom})
+
+    protected
+
+    # perform atom parsing on body
+    def atom
+      body.to_atom
+    end
+  end
+
+  parser Parser::Atom
+end
+
+
+class OnlyParseAtom
+  include HTTParty
+
+  # Only support Atom
+  class Parser::OnlyAtom < HTTParty::Parser
+    SupportedFormats = {"application/atom+xml" => :atom}
+
+    protected
+
+    # perform atom parsing on body
+    def atom
+      body.to_atom
+    end
+  end
+
+  parser Parser::OnlyAtom
+end
+
+
+class SkipParsing
+  include HTTParty
+
+  # Parse the response body however you like
+  class Parser::Simple < HTTParty::Parser
+    def parse
+      body
+    end
+  end
+
+  parser Parser::Simple
+end
+
+
+class AdHocParsing
+  include HTTParty
+  parser(
+    Proc.new do |body, format|
+      case format
+      when :json
+        body.to_json
+      when :xml
+        body.to_xml
+      else
+        body
+      end
+    end
+  )
+end

data/examples/delicious.rb

@@ -0,0 +1,37 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+config = YAML::load(File.read(File.join(ENV['HOME'], '.delicious')))
+
+class Delicious
+  include HTTParty
+  base_uri 'https://api.del.icio.us/v1'
+  
+  def initialize(u, p)
+    @auth = {:username => u, :password => p}
+  end
+  
+  # query params that filter the posts are:
+  #   tag (optional). Filter by this tag.
+  #   dt (optional). Filter by this date (CCYY-MM-DDThh:mm:ssZ).
+  #   url (optional). Filter by this url.
+  #   ie: posts(:query => {:tag => 'ruby'})
+  def posts(options={})
+    options.merge!({:basic_auth => @auth})
+    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={})
+    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'})
+pp delicious.recent
+
+delicious.recent['posts']['post'].each { |post| puts post['href'] }