voxdolo-httparty 0.3.1

data/History

@@ -0,0 +1,108 @@
+== 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,55 @@
+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/core_extensions.rb
+lib/httparty/cookie_hash.rb
+lib/httparty/exceptions.rb
+lib/httparty/module_inheritable_attributes.rb
+lib/httparty/parsers/json.rb
+lib/httparty/parsers/xml.rb
+lib/httparty/parsers.rb
+lib/httparty/request.rb
+lib/httparty/response.rb
+lib/httparty/version.rb
+lib/httparty.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README
+setup.rb
+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/hash_spec.rb
+spec/httparty/cookie_hash_spec.rb
+spec/httparty/parsers/json_spec.rb
+spec/httparty/parsers/xml_spec.rb
+spec/httparty/request_spec.rb
+spec/httparty/response_spec.rb
+spec/httparty_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/string_spec.rb
+website/css/common.css
+website/index.html

data/README

@@ -0,0 +1,35 @@
+= httparty
+
+== DESCRIPTION:
+
+Makes http fun again!
+
+== 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:
+
+* You like to party!
+
+== INSTALL:
+
+* sudo gem install httparty

data/Rakefile

@@ -0,0 +1,47 @@
+ProjectName = 'httparty'
+WebsitePath = "jnunemaker@rubyforge.org:/var/www/gforge-projects/#{ProjectName}"
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'spec/rake/spectask'
+require "lib/#{ProjectName}/version"
+require 'cucumber/rake/task'
+
+Echoe.new(ProjectName, HTTParty::Version) do |p|
+  p.description     = "Makes http fun! Also, makes consuming restful web services dead easy."
+  p.install_message = "When you HTTParty, you must party hard!"
+  p.url             = "http://#{ProjectName}.rubyforge.org"
+  p.author          = "John Nunemaker"
+  p.email           = "nunemaker@gmail.com"
+  p.need_tar_gz     = false
+  p.docs_host       = WebsitePath
+end
+
+desc 'Upload website files to rubyforge'
+task :website do
+  sh %{rsync -av website/ #{WebsitePath}}
+  Rake::Task['website_docs'].invoke
+end
+
+task :website_docs do
+  Rake::Task['redocs'].invoke
+  sh %{rsync -av doc/ #{WebsitePath}/docs}
+end
+
+desc 'Preps the gem for a new release'
+task :prepare do
+  %w[manifest build_gemspec].each do |task|
+    Rake::Task[task].invoke
+  end
+end
+
+Rake::Task[:default].prerequisites.clear
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty" 
+end

data/bin/httparty

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pp"
+
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+require "httparty"
+
+opts = {
+  :action => :get,
+  :headers => {},
+  :verbose => false
+}
+
+def die(msg)
+  STDERR.puts(msg)
+  exit 1
+end
+
+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 or delete") 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).read
+    else
+      opts[:data] = d
+    end
+  end
+  
+  o.on("-H", "--header [NAME=VALUE]", "Additional HTTP headers in NAME=VALUE form") do |h|
+    die "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|
+    die "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!
+
+puts "Querying #{ARGV.first} with options: #{opts.inspect}" if opts[:verbose]
+
+if ARGV.empty?
+  STDERR.puts "You need to provide a URL"
+  STDERR.puts "USAGE: #{$0} [options] [url]"
+end
+
+if opts[:output_format].nil?
+  response = HTTParty.send(opts[:action], ARGV.first, opts)
+  puts "Status: #{response.code}"
+  pp response
+else
+  print_format = opts[:output_format]
+  response = HTTParty.send(opts[:action], ARGV.first, opts)
+  puts "Status: #{response.code}"
+  case opts[:output_format]
+    when :json
+      begin
+        require 'rubygems'
+        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 in the same fashion
+response = HTTParty.get('http://twitter.com/statuses/public_timeline.json')
+puts response.body, response.code, response.headers.inspect
+
+response.each do |item|
+  puts item['user']['screen_name']
+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'] }

data/examples/google.rb

@@ -0,0 +1,16 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Google
+  include HTTParty
+  format :html
+end
+
+# google.com redirects to www.google.com so this is live test for redirection
+pp Google.get('http://google.com')
+
+puts '', '*'*70, ''
+
+# check that ssl is requesting right
+pp Google.get('https://www.google.com')

data/examples/rubyurl.rb

@@ -0,0 +1,14 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Rubyurl
+  include HTTParty
+  base_uri 'rubyurl.com'
+
+  def self.shorten( website_url )
+    post( '/api/links.json', :query => { :link => { :website_url => website_url } } )
+  end
+end
+
+pp Rubyurl.shorten( 'http://istwitterdown.com/')

data/examples/twitter.rb

@@ -0,0 +1,31 @@
+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'], '.twitter')))
+
+class Twitter
+  include HTTParty
+  base_uri 'twitter.com'
+  
+  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={})
+    options.merge!({:basic_auth => @auth})
+    self.class.get("/statuses/#{which}_timeline.json", options)
+  end
+  
+  def post(text)
+    options = { :query => {:status => text}, :basic_auth => @auth }
+    self.class.post('/statuses/update.json', options)
+  end
+end
+
+twitter = Twitter.new(config['email'], config['password'])
+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 of 0.2.0')

data/examples/whoismyrep.rb

@@ -0,0 +1,10 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Rep
+  include HTTParty
+end
+
+pp Rep.get('http://whoismyrepresentative.com/whoismyrep.php?zip=46544')
+pp Rep.get('http://whoismyrepresentative.com/whoismyrep.php', :query => {:zip => 46544})

data/features/basic_authentication.feature

@@ -0,0 +1,20 @@
+Feature:  Basic Authentication
+
+  As a developer
+  I want to be able to use a service that requires Basic Authentication
+  Because that is not an uncommon requirement
+
+  Scenario: Passing no credentials to a page requiring Basic Authentication
+    Given a restricted page at '/protected.html'
+    When I call HTTParty#get with '/protected.html'
+    Then it should return a response with a 401 response code
+
+  Scenario: Passing proper credentials to a page requiring Basic Authentication
+    Given a remote service that returns 'Authenticated Page'
+    And that service is accessed at the path '/protected.html'
+    And that service is protected by Basic Authentication
+    And that service requires the username 'jcash' with the password 'maninblack'
+    When I call HTTParty#get with '/protected.html' and a basic_auth hash:
+       | username | password   |
+       | jcash    | maninblack |
+    Then the return value should match 'Authenticated Page'

data/features/command_line.feature

@@ -0,0 +1,7 @@
+Feature: Command Line
+
+  As a developer
+  I want to be able to harness the power of HTTParty from the command line
+  Because that would make quick testing and debugging easy
+  And 'easy' is my middle name
+  And I'm kidding it's actually 'Danger'!

data/features/deals_with_http_error_codes.feature

@@ -0,0 +1,26 @@
+Feature: Deals with HTTP error codes
+
+  As a developer
+  I want to be informed of non-successful responses
+  Because sometimes thing explode
+  And I should probably know what happened
+
+  Scenario: A response of '404 - Not Found'
+    Given a remote service that returns a 404 status code
+    And that service is accessed at the path '/service.html'
+    When I call HTTParty#get with '/service.html'
+    Then it should return a response with a 404 response code
+
+  Scenario: A response of '500 - Internal Server Error'
+    Given a remote service that returns a 500 status code
+    And that service is accessed at the path '/service.html'
+    When I call HTTParty#get with '/service.html'
+    Then it should return a response with a 500 response code
+
+  Scenario: A non-successful response where I need the body
+    Given a remote service that returns a 400 status code
+    And the response from the service has a body of 'Bad response'
+    And that service is accessed at the path '/service.html'
+    When I call HTTParty#get with '/service.html'
+    Then it should return a response with a 400 response code
+    And the return value should match 'Bad response'

data/features/handles_multiple_formats.feature

@@ -0,0 +1,34 @@
+Feature: Handles Multiple Formats
+
+  As a developer
+  I want to be able to consume remote services of many different formats
+  And I want those formats to be automatically detected and handled
+  Because web services take many forms
+  And I don't want to have to do any extra work
+
+  Scenario: An HTML service
+    Given a remote service that returns '<h1>Some HTML</h1>'
+    And that service is accessed at the path '/service.html'
+    And the response from the service has a Content-Type of 'text/html'
+    When I call HTTParty#get with '/service.html'
+    Then it should return a String
+    And the return value should match '<h1>Some HTML</h1>'
+
+  Scenario: A JSON service
+    Given a remote service that returns '{ "jennings": "waylon", "cash": "johnny" }'
+    And that service is accessed at the path '/service.json'
+    And the response from the service has a Content-Type of 'application/json'
+    When I call HTTParty#get with '/service.json'
+    Then it should return a Hash equaling:
+       | key      | value  |
+       | jennings | waylon |
+       | cash     | johnny |
+
+  Scenario: An XML Service
+    Given a remote service that returns '<singer>waylon jennings</singer>'
+    And that service is accessed at the path '/service.xml'
+    And the response from the service has a Content-Type of 'text/xml'
+    When I call HTTParty#get with '/service.xml'
+    Then it should return a Hash equaling:
+       | key    | value           |
+       | singer | waylon jennings |

data/features/steps/env.rb

@@ -0,0 +1,15 @@
+require 'mongrel'
+require 'activesupport'
+require 'lib/httparty'
+require 'spec/expectations'
+
+Before do
+  port = ENV["HTTPARTY_PORT"] || 31981
+  @host_and_port = "0.0.0.0:#{port}"
+  @server = Mongrel::HttpServer.new("0.0.0.0", port)
+  @server.run
+end
+
+After do
+  @server.stop
+end

data/features/steps/httparty_response_steps.rb

@@ -0,0 +1,26 @@
+Then /it should return an? (\w+)$/ do |class_string|
+  @response_from_httparty.should be_an_instance_of(class_string.constantize)
+end
+
+Then /the return value should match '(.*)'/ do |expected_text|
+  @response_from_httparty.should eql(expected_text)
+end
+
+Then /it should return a Hash equaling:/ do |hash_table|
+  @response_from_httparty.should be_an_instance_of(Hash)
+  @response_from_httparty.keys.length.should eql(hash_table.rows.length)
+  hash_table.hashes.each do |pair|
+    key, value = pair["key"], pair["value"]
+    @response_from_httparty.keys.should include(key)
+    @response_from_httparty[key].should eql(value)
+  end
+end
+
+Then /it should return a response with a (\d+) response code/ do |code|
+  @response_from_httparty.code.should eql(code)
+end
+
+Then /it should raise an HTTParty::RedirectionTooDeep exception/ do
+  @exception_from_httparty.should_not be_nil
+  @exception_from_httparty.class.should eql(HTTParty::RedirectionTooDeep)
+end