httparty 0.8.0 → 0.9.0

data/.gitignore

@@ -7,3 +7,4 @@ log/
 pkg/
 *.swp
 /.bundle
+.rvmrc

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.3
+notifications:
+  email: false
+bundler_args: --without development

data/Gemfile

@@ -1,8 +1,15 @@
 source :rubygems
 gemspec
 
-gem 'rake',     '~> 0.8.7'
+gem 'rake'
 gem 'cucumber', '~> 0.7'
 gem 'fakeweb',  '~> 1.2'
 gem 'rspec',    '~> 1.3'
 gem 'mongrel',  '1.2.0.pre2'
+gem 'multi_json', '~> 1.3'
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+end

data/Guardfile

@@ -0,0 +1,16 @@
+rspec_options = {
+  :version        => 1,
+  :all_after_pass => false,
+  :all_on_start   => false,
+}
+
+guard 'rspec', rspec_options do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/History

@@ -1,3 +1,37 @@
+== 0.9.0 2012-09-07
+* new
+  * [support for connection adapters](https://github.com/jnunemaker/httparty/pull/157)
+  * [allow ssl_version on ruby 1.9](https://github.com/jnunemaker/httparty/pull/159)
+
+* bug fixes
+  * [don't treat port 4430 as ssl](https://github.com/jnunemaker/httparty/commit/a296b1c97f83d7dcc6ef85720a43664c265685ac)
+  * [deep clone default options](https://github.com/jnunemaker/httparty/commit/f74227d30f9389b4b23a888c9af49fb9b8248e1f)
+  * a few net digest auth fixes
+
+== 0.8.3 2012-04-21
+* new
+  * [lazy parsing of responses](https://github.com/jnunemaker/httparty/commit/9fd5259c8dab00e426082b66af44ede2c9068f45)
+  * [add support for PATCH requests](https://github.com/jnunemaker/httparty/commit/7ab6641e37a9e31517e46f6124f38c615395d38a)
+* bug fixes
+  * [subclasses no longer override superclass options](https://github.com/jnunemaker/httparty/commit/682af8fbf672e7b3009e650da776c85cdfe78d39)
+
+== 0.8.2 2012-04-12
+* new
+  * add -r to make CLI return failure code if status >= 400
+  * allow blank username from CLI
+* bug fixes
+  * return nil for null body
+  * automatically deflate responses with a Content-Encoding: x-gzip header
+  * Do not HEAD on POST request with digest authentication
+  * add support for proxy authentication
+  * fix posting data with CLI
+  * require rexml/document if xml format from CLI
+  * support for fragmented responses
+
+== 0.8.1 2011-10-05
+* bug fixes
+  * content-encoding header should be removed when automatically inflating the body
+
 == 0.8.0 2011-09-13
 * new
   * switch to multi json/xml for parsing by default

data/README.md

@@ -0,0 +1,79 @@
+# httparty
+
+Makes http fun again!
+
+## Install
+
+```
+gem install httparty
+```
+
+## Requirements
+
+* multi_json and multi_xml
+* You like to party!
+
+## Examples
+
+```ruby
+# Use the class methods to get down to business quickly
+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
+
+# Or wrap things up in your own class
+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 = { :body => {:status => text}, :basic_auth => @auth }
+    self.class.post('/statuses/update.json', options)
+  end
+end
+
+twitter = Twitter.new(config['email'], config['password'])
+pp twitter.timeline
+```
+
+See the [examples directory](http://github.com/jnunemaker/httparty/tree/master/examples) for even more goodies.
+
+## Command Line Interface
+
+httparty also includes the executable `httparty` 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 `httparty --help` for all the
+options. Below is an example of how easy it is.
+
+```
+httparty "http://twitter.com/statuses/public_timeline.json"
+```
+
+## Help and Docs
+
+* https://groups.google.com/forum/#!forum/httparty-gem
+* http://rdoc.info/projects/jnunemaker/httparty
+
+## Contributing
+
+* 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.

data/bin/httparty

@@ -32,13 +32,13 @@ OptionParser.new do |o|
        "--data [BODY]",
        "Data to put in request body (prefix with '@' for file)") do |d|
     if d =~ /^@/
-      opts[:data] = open(d[1..-1]).read
+      opts[:body] = open(d[1..-1]).read
     else
-      opts[:data] = d
+      opts[:body] = d
     end
   end
 
-  o.on("-H", "--header [NAME=VALUE]", "Additional HTTP headers in NAME=VALUE form") do |h|
+  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
@@ -49,11 +49,15 @@ OptionParser.new do |o|
   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 =~ /.+:.+/
+    abort "Invalid credentials format. Must be user:password" unless u =~ /.*:.+/
     user, password = u.split(':')
     opts[:basic_auth] = { :username => user, :password => password }
   end
 
+  o.on("-r", "--response-code", "Command fails if response code >= 400") do
+    opts[:response_code] = true
+  end
+
   o.on("-h", "--help", "Show help documentation") do |h|
     puts o
     exit
@@ -100,9 +104,11 @@ else
         puts YAML.dump(response.delegate)
       end
     when :xml
+      require 'rexml/document'
       REXML::Document.new(response.body).write(STDOUT, 2)
       puts
     else
       puts response
   end
 end
+exit false if opts[:response_code] && response.code >= 400

data/cucumber.yml

@@ -1 +1 @@
-default: features
+default: features --format progress

data/examples/crack.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'crack'
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Rep
+  include HTTParty
+
+  parser(
+    Proc.new do |body, format|
+      Crack::XML.parse(body)
+    end
+  )
+end
+
+pp Rep.get('http://whoismyrepresentative.com/whoismyrep.php?zip=46544')
+pp Rep.get('http://whoismyrepresentative.com/whoismyrep.php', :query => {:zip => 46544})

data/examples/headers_and_user_agents.rb

@@ -0,0 +1,6 @@
+# To send custom user agents to identify your application to a web service (or mask as a specific browser for testing), send "User-Agent" as a hash to headers as shown below.
+
+require 'httparty'
+
+APPLICATION_NAME = "Httparty" 
+response = HTTParty.get('http://example.com', :headers => {"User-Agent" => APPLICATION_NAME})

data/examples/nokogiri_html_parser.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'nokogiri'
+
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class HtmlParserIncluded < HTTParty::Parser
+  SupportedFormats.merge!('text/html' => :html)
+
+  def html
+    Nokogiri::HTML(body)
+  end
+end
+
+class Page
+  include HTTParty
+  parser HtmlParserIncluded
+end
+
+pp Page.get('http://www.google.com')

data/features/steps/remote_service_steps.rb

@@ -14,7 +14,7 @@ end
 
 Given /^that service takes (\d+) seconds to generate a response$/ do |time|
   @server_response_time = time.to_i
-  @handler.preprocessor = lambda { sleep time.to_i }
+  @handler.preprocessor = Proc.new { sleep time.to_i }
 end
 
 Given /^a remote deflate service$/ do

data/httparty.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["John Nunemaker", "Sandro Turriate"]
   s.email       = ["nunemaker@gmail.com"]
-  s.homepage    = "http://httparty.rubyforge.org/"
+  s.homepage    = "http://jnunemaker.github.com/httparty"
   s.summary     = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.description = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
 
-  s.add_dependency 'multi_json'
+  s.add_dependency 'multi_json', "~> 1.0"
   s.add_dependency 'multi_xml'
 
   s.post_install_message = "When you HTTParty, you must party hard!"

data/lib/httparty.rb

@@ -10,6 +10,7 @@ require 'httparty/module_inheritable_attributes'
 require 'httparty/cookie_hash'
 require 'httparty/net_digest_auth'
 require 'httparty/version'
+require 'httparty/connection_adapter'
 
 # @see HTTParty::ClassMethods
 module HTTParty
@@ -36,11 +37,13 @@ module HTTParty
   end
 
   # == Common Request Options
-  # Request methods (get, post, put, delete, head, options) all take a common set of options. These are:
+  # Request methods (get, post, patch, put, delete, head, options) all take a common set of options. These are:
   #
   # [:+body+:] Body of the request. If passed a Hash, will try to normalize it first, by default passing it to ActiveSupport::to_params. Any other kind of object will get used as-is.
   # [:+http_proxyaddr+:] Address of proxy server to use.
   # [:+http_proxyport+:]  Port of proxy server to use.
+  # [:+http_proxyuser+:] User for proxy server authentication.
+  # [:+http_proxypass+:] Password for proxy server authentication.
   # [:+limit+:] Maximum number of redirects to follow. Takes precedences over :+no_follow+.
   # [:+query+:] Query string, or a Hash representing it. Normalized according to the same rules as :+body+. If you specify this on a POST, you must use a Hash. See also HTTParty::ClassMethods.default_params.
   # [:+timeout+:] Timeout for opening connection and reading data.
@@ -55,9 +58,11 @@ module HTTParty
   # * :+maintain_method_across_redirects+: see HTTParty::ClassMethods.maintain_method_across_redirects.
   # * :+no_follow+: see HTTParty::ClassMethods.no_follow.
   # * :+parser+: see HTTParty::ClassMethods.parser.
+  # * :+connection_adapter+: see HTTParty::ClassMethods.connection_adapter.
   # * :+pem+: see HTTParty::ClassMethods.pem.
   # * :+query_string_normalizer+: see HTTParty::ClassMethods.query_string_normalizer
   # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.
+  # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path.
 
   module ClassMethods
 
@@ -67,11 +72,13 @@ module HTTParty
     #
     #   class Foo
     #     include HTTParty
-    #     http_proxy 'http://foo.com', 80
+    #     http_proxy 'http://foo.com', 80, 'user', 'pass'
     #   end
-    def http_proxy(addr=nil, port = nil)
+    def http_proxy(addr=nil, port=nil, user=nil, pass=nil)
       default_options[:http_proxyaddr] = addr
       default_options[:http_proxyport] = port
+      default_options[:http_proxyuser] = user
+      default_options[:http_proxypass] = pass
     end
 
     # Allows setting a base uri to be used for each request.
@@ -292,6 +299,17 @@ module HTTParty
       default_options[:query_string_normalizer] = normalizer
     end
 
+    # Allows setting of SSL version to use. This only works in Ruby 1.9.
+    # You can get a list of valid versions from OpenSSL::SSL::SSLContext::METHODS.
+    #
+    #   class Foo
+    #     include HTTParty
+    #     ssl_version :SSLv3
+    #   end
+    def ssl_version(version)
+      default_options[:ssl_version] = version
+    end
+
     # Allows setting an OpenSSL certificate authority file
     #
     #   class Foo
@@ -327,6 +345,30 @@ module HTTParty
       end
     end
 
+    # Allows setting a custom connection_adapter for the http connections
+    #
+    # @example
+    #   class Foo
+    #     include HTTParty
+    #     connection_adapter Proc.new {|uri, options| ... }
+    #   end
+    #
+    # @example provide optional configuration for your connection_adapter
+    #   class Foo
+    #     include HTTParty
+    #     connection_adapter Proc.new {|uri, options| ... }, {:foo => :bar}
+    #   end
+    #
+    # @see HTTParty::ConnectionAdapter
+    def connection_adapter(custom_adapter = nil, options = nil)
+      if custom_adapter.nil?
+        default_options[:connection_adapter]
+      else
+        default_options[:connection_adapter] = custom_adapter
+        default_options[:connection_adapter_options] = options
+      end
+    end
+
     # Allows making a get request to a url.
     #
     #   class Foo
@@ -339,8 +381,8 @@ module HTTParty
     #   # Simple get with full url and query parameters
     #   # ie: http://foo.com/resource.json?limit=10
     #   Foo.get('http://foo.com/resource.json', :query => {:limit => 10})
-    def get(path, options={})
-      perform_request Net::HTTP::Get, path, options
+    def get(path, options={}, &block)
+      perform_request Net::HTTP::Get, path, options, &block
     end
 
     # Allows making a post request to a url.
@@ -355,28 +397,33 @@ module HTTParty
     #   # Simple post with full url using :query option,
     #   # which gets set as form data on the request.
     #   Foo.post('http://foo.com/resources', :query => {:bar => 'baz'})
-    def post(path, options={})
-      perform_request Net::HTTP::Post, path, options
+    def post(path, options={}, &block)
+      perform_request Net::HTTP::Post, path, options, &block
+    end
+
+    # Perform a PATCH request to a path
+    def patch(path, options={}, &block)
+      perform_request Net::HTTP::Patch, path, options, &block
     end
 
     # Perform a PUT request to a path
-    def put(path, options={})
-      perform_request Net::HTTP::Put, path, options
+    def put(path, options={}, &block)
+      perform_request Net::HTTP::Put, path, options, &block
     end
 
     # Perform a DELETE request to a path
-    def delete(path, options={})
-      perform_request Net::HTTP::Delete, path, options
+    def delete(path, options={}, &block)
+      perform_request Net::HTTP::Delete, path, options, &block
     end
 
     # Perform a HEAD request to a path
-    def head(path, options={})
-      perform_request Net::HTTP::Head, path, options
+    def head(path, options={}, &block)
+      perform_request Net::HTTP::Head, path, options, &block
     end
 
     # Perform an OPTIONS request to a path
-    def options(path, options={})
-      perform_request Net::HTTP::Options, path, options
+    def options(path, options={}, &block)
+      perform_request Net::HTTP::Options, path, options, &block
     end
 
     def default_options #:nodoc:
@@ -385,10 +432,10 @@ module HTTParty
 
     private
 
-      def perform_request(http_method, path, options) #:nodoc:
+      def perform_request(http_method, path, options, &block) #:nodoc:
         options = default_options.dup.merge(options)
         process_cookies(options)
-        Request.new(http_method, path, options).perform
+        Request.new(http_method, path, options).perform(&block)
       end
 
       def process_cookies(options) #:nodoc:
@@ -406,7 +453,7 @@ module HTTParty
 
   def self.normalize_base_uri(url) #:nodoc:
     normalized_url = url.dup
-    use_ssl = (normalized_url =~ /^https/) || normalized_url.include?(':443')
+    use_ssl = (normalized_url =~ /^https/) || (normalized_url =~ /:443\b/)
     ends_with_slash = normalized_url =~ /\/$/
 
     normalized_url.chop! if ends_with_slash
@@ -419,28 +466,32 @@ module HTTParty
     include HTTParty
   end
 
-  def self.get(*args)
-    Basement.get(*args)
+  def self.get(*args, &block)
+    Basement.get(*args, &block)
+  end
+
+  def self.post(*args, &block)
+    Basement.post(*args, &block)
   end
 
-  def self.post(*args)
-    Basement.post(*args)
+  def self.patch(*args, &block)
+    Basement.patch(*args, &block)
   end
 
-  def self.put(*args)
-    Basement.put(*args)
+  def self.put(*args, &block)
+    Basement.put(*args, &block)
   end
 
-  def self.delete(*args)
-    Basement.delete(*args)
+  def self.delete(*args, &block)
+    Basement.delete(*args, &block)
   end
 
-  def self.head(*args)
-    Basement.head(*args)
+  def self.head(*args, &block)
+    Basement.head(*args, &block)
   end
 
-  def self.options(*args)
-    Basement.options(*args)
+  def self.options(*args, &block)
+    Basement.options(*args, &block)
   end
 end