httparty 0.6.1 → 0.7.0

data/.gitignore

@@ -5,3 +5,4 @@ tmp/
 log/
 pkg/
 *.swp
+/.bundle

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use httparty

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    httparty (0.6.1)
+      crack (= 0.1.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.10)
+    builder (2.1.2)
+    cgi_multipart_eof_fix (2.5.0)
+    crack (0.1.8)
+    cucumber (0.9.2)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.5)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    fastthread (1.0.7)
+    gem_plugin (0.2.3)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    json (1.4.6)
+    mongrel (1.1.5)
+      cgi_multipart_eof_fix (>= 2.4)
+      daemons (>= 1.0.3)
+      fastthread (>= 1.0.1)
+      gem_plugin (>= 0.2.3)
+    rspec (1.3.1)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 2.3)
+  crack (= 0.1.8)
+  cucumber (~> 0.7)
+  fakeweb (~> 1.2)
+  httparty!
+  mongrel (~> 1.1)
+  rspec (~> 1.3)

data/History

@@ -1,4 +1,20 @@
-== 0.6.1
+== 0.7.0 2010-01-18
+* minor enhancements
+  * Added query methods for HTTP status codes, i.e. response.success?
+    response.created? (thanks citizenparker)
+  * Added support for ssl_ca_file and ssl_ca_path (dlitz)
+  * Allow custom query string normalization. gh-8
+  * Unlock private keys with password (freerange)
+  * Added high level request documentation (phildarnowsky)
+  * Added basic post example (pbuckley)
+  * Response object has access to its corresponding request object
+  * Added example of siginin into tripit.com
+  * Added option to follow redirects (rkj). gh-56
+* bug fixes
+  * Fixed superclass mismatch exception while running tests
+    (thanks dlitz http://github.com/dlitz/httparty/commit/48224f0615b32133afcff4718ad426df7a4b401b)
+
+== 0.6.1 2010-07-07
 * minor enhancements
   * updated to crack 0.1.8
 * bug fixes

data/Rakefile

@@ -19,13 +19,10 @@ begin
     gem.add_development_dependency "fakeweb", "~>1.2"
     gem.add_development_dependency "mongrel", "~>1.1"
     gem.add_development_dependency "rspec", "~>1.3"
+    gem.add_development_dependency "jeweler", "~>1.5"
     gem.post_install_message = "When you HTTParty, you must party hard!"
-    gem.rubyforge_project = 'httparty'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
-  Jeweler::RubyforgeTasks.new do |rubyforge|
-    rubyforge.doc_task = "rdoc"
-  end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
@@ -45,13 +42,10 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   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"
@@ -75,11 +69,6 @@ Rake::RDocTask.new do |rdoc|
   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|

data/examples/basic.rb

@@ -9,3 +9,24 @@ puts response.body, response.code, response.message, response.headers.inspect
 response.each do |item|
   puts item['user']['screen_name']
 end
+
+# An example post to a minimal rails app in the development environment
+# Note that "skip_before_filter :verify_authenticity_token" must be set in the
+# "pears" controller for this example
+
+class Partay
+  include HTTParty
+  base_uri 'http://localhost:3000'
+end
+
+options = {
+  :body => {
+    :pear => { # your resource
+      :foo => '123', # your columns/data
+      :bar => 'second',
+      :baz => 'last thing'
+    }
+  }
+}
+
+pp Partay.post('/pears.xml', options)

data/examples/tripit_sign_in.rb

@@ -0,0 +1,33 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+
+class TripIt
+  include HTTParty
+  base_uri 'http://www.tripit.com'
+  debug_output
+
+  def initialize(email, password)
+    @email = email
+    response = self.class.get('/account/login')
+    response = self.class.post(
+      '/account/login',
+      :body => {
+        :login_email_address => email,
+        :login_password => password
+      },
+      :headers => {'Cookie' => response.headers['Set-Cookie']}
+    )
+    @cookie = response.request.options[:headers]['Cookie']
+  end
+
+  def account_settings
+    self.class.get('/account/edit', :headers => {'Cookie' => @cookie})
+  end
+
+  def logged_in?
+    account_settings.include? "You're logged in as #{@email}"
+  end
+end
+
+tripit = TripIt.new('email', 'password')
+puts "Logged in: #{tripit.logged_in?}"

data/httparty.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{httparty}
-  s.version = "0.6.1"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker", "Sandro Turriate"]
-  s.date = %q{2010-07-07}
+  s.date = %q{2011-01-18}
   s.default_executable = %q{httparty}
   s.description = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.email = %q{nunemaker@gmail.com}
@@ -19,12 +19,14 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
+     ".rvmrc",
+     "Gemfile",
+     "Gemfile.lock",
      "History",
      "MIT-LICENSE",
      "Manifest",
      "README.rdoc",
      "Rakefile",
-     "VERSION",
      "bin/httparty",
      "cucumber.yml",
      "examples/aaws.rb",
@@ -33,6 +35,7 @@ Gem::Specification.new do |s|
      "examples/delicious.rb",
      "examples/google.rb",
      "examples/rubyurl.rb",
+     "examples/tripit_sign_in.rb",
      "examples/twitter.rb",
      "examples/whoismyrep.rb",
      "features/basic_authentication.feature",
@@ -61,6 +64,15 @@ Gem::Specification.new do |s|
      "spec/fixtures/delicious.xml",
      "spec/fixtures/empty.xml",
      "spec/fixtures/google.html",
+     "spec/fixtures/ssl/generate.sh",
+     "spec/fixtures/ssl/generated/1fe462c2.0",
+     "spec/fixtures/ssl/generated/bogushost.crt",
+     "spec/fixtures/ssl/generated/ca.crt",
+     "spec/fixtures/ssl/generated/ca.key",
+     "spec/fixtures/ssl/generated/selfsigned.crt",
+     "spec/fixtures/ssl/generated/server.crt",
+     "spec/fixtures/ssl/generated/server.key",
+     "spec/fixtures/ssl/openssl-exts.cnf",
      "spec/fixtures/twitter.json",
      "spec/fixtures/twitter.xml",
      "spec/fixtures/undefined_method_add_node_for_nil.xml",
@@ -68,9 +80,12 @@ Gem::Specification.new do |s|
      "spec/httparty/parser_spec.rb",
      "spec/httparty/request_spec.rb",
      "spec/httparty/response_spec.rb",
+     "spec/httparty/ssl_spec.rb",
      "spec/httparty_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
+     "spec/support/ssl_test_helper.rb",
+     "spec/support/ssl_test_server.rb",
      "spec/support/stub_response.rb",
      "website/css/common.css",
      "website/index.html"
@@ -79,16 +94,18 @@ Gem::Specification.new do |s|
   s.post_install_message = %q{When you HTTParty, you must party hard!}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{httparty}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Makes http fun! Also, makes consuming restful web services dead easy.}
   s.test_files = [
     "spec/httparty/cookie_hash_spec.rb",
      "spec/httparty/parser_spec.rb",
      "spec/httparty/request_spec.rb",
      "spec/httparty/response_spec.rb",
+     "spec/httparty/ssl_spec.rb",
      "spec/httparty_spec.rb",
      "spec/spec_helper.rb",
+     "spec/support/ssl_test_helper.rb",
+     "spec/support/ssl_test_server.rb",
      "spec/support/stub_response.rb",
      "examples/aaws.rb",
      "examples/basic.rb",
@@ -96,6 +113,7 @@ Gem::Specification.new do |s|
      "examples/delicious.rb",
      "examples/google.rb",
      "examples/rubyurl.rb",
+     "examples/tripit_sign_in.rb",
      "examples/twitter.rb",
      "examples/whoismyrep.rb"
   ]
@@ -104,13 +122,14 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<crack>, ["= 0.1.8"])
       s.add_development_dependency(%q<activesupport>, ["~> 2.3"])
       s.add_development_dependency(%q<cucumber>, ["~> 0.7"])
       s.add_development_dependency(%q<fakeweb>, ["~> 1.2"])
       s.add_development_dependency(%q<mongrel>, ["~> 1.1"])
       s.add_development_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5"])
     else
       s.add_dependency(%q<crack>, ["= 0.1.8"])
       s.add_dependency(%q<activesupport>, ["~> 2.3"])
@@ -118,6 +137,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<fakeweb>, ["~> 1.2"])
       s.add_dependency(%q<mongrel>, ["~> 1.1"])
       s.add_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5"])
     end
   else
     s.add_dependency(%q<crack>, ["= 0.1.8"])
@@ -126,6 +146,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<fakeweb>, ["~> 1.2"])
     s.add_dependency(%q<mongrel>, ["~> 1.1"])
     s.add_dependency(%q<rspec>, ["~> 1.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5"])
   end
 end
 

data/lib/httparty.rb

@@ -11,8 +11,9 @@ require dir + 'httparty/module_inheritable_attributes'
 require dir + 'httparty/cookie_hash'
 require dir + 'httparty/net_digest_auth'
 
+# @see HTTParty::ClassMethods
 module HTTParty
-  VERSION          = "0.6.1".freeze
+  VERSION          = "0.7.0".freeze
   CRACK_DEPENDENCY = "0.1.8".freeze
 
   module AllowedFormatsDeprecation
@@ -37,7 +38,32 @@ module HTTParty
     base.instance_variable_set("@default_cookies", CookieHash.new)
   end
 
+  # == Common Request Options
+  # Request methods (get, post, 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.
+  # [:+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.
+  #
+  # There are also another set of options with names corresponding to various class methods. The methods in question are those that let you set a class-wide default, and the options override the defaults on a request-by-request basis. Those options are:
+  # * :+base_uri+: see HTTParty::ClassMethods.base_uri.
+  # * :+basic_auth+: see HTTParty::ClassMethods.basic_auth. Only one of :+basic_auth+ and :+digest_auth+ can be used at a time; if you try using both, you'll get an ArgumentError.
+  # * :+debug_output+: see HTTParty::ClassMethods.debug_output.
+  # * :+digest_auth+: see HTTParty::ClassMethods.digest_auth. Only one of :+basic_auth+ and :+digest_auth+ can be used at a time; if you try using both, you'll get an ArgumentError.
+  # * :+format+: see HTTParty::ClassMethods.format.
+  # * :+headers+: see HTTParty::ClassMethods.headers. Must be a Hash.
+  # * :+maintain_method_across_redirects+: see HTTParty::ClassMethods.maintain_method_across_redirects.
+  # * :+no_follow+: see HTTParty::ClassMethods.no_follow.
+  # * :+parser+: see HTTParty::ClassMethods.parser.
+  # * :+pem+: see HTTParty::ClassMethods.pem.
+  # * :+query_string_normalizer+: see HTTParty::ClassMethods.query_string_normalizer
+  # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.
+
   module ClassMethods
+
     extend AllowedFormatsDeprecation
 
     # Allows setting http proxy information to be used
@@ -83,6 +109,28 @@ module HTTParty
       default_options[:digest_auth] = {:username => u, :password => p}
     end
 
+    # Do not send rails style query strings.
+    # Specically, don't use bracket notation when sending an array
+    #
+    # For a query:
+    #   get '/', :query => {:selected_ids => [1,2,3]}
+    #
+    # The default query string looks like this:
+    #   /?selected_ids[]=1&selected_ids[]=2&selected_ids[]=3
+    #
+    # Call `disable_rails_query_string_format` to transform the query string
+    # into:
+    #   /?selected_ids=1&selected_ids=2&selected_ids=3
+    #
+    # @example
+    #   class Foo
+    #     include HTTParty
+    #     disable_rails_query_string_format
+    #   end
+    def disable_rails_query_string_format
+      query_string_normalizer Request::NON_RAILS_QUERY_STRING_NORMALIZER
+    end
+
     # Allows setting default parameters to be appended to each request.
     # Great for api keys and such.
     #
@@ -136,6 +184,19 @@ module HTTParty
       default_cookies.add_cookies(h)
     end
 
+    # Proceed to the location header when an HTTP response dictates a redirect.
+    # Redirects are always followed by default.
+    #
+    # @example
+    #   class Foo
+    #     include HTTParty
+    #     base_uri 'http://google.com'
+    #     follow_redirects true
+    #   end
+    def follow_redirects(value = true)
+      default_options[:follow_redirects] = value
+    end
+
     # Allows setting the format with which to parse.
     # Must be one of the allowed formats ie: json, xml
     #
@@ -195,10 +256,63 @@ module HTTParty
     #
     #   class Foo
     #     include HTTParty
-    #     pem File.read('/home/user/my.pem')
+    #     pem File.read('/home/user/my.pem'), "optional password"
     #   end
-    def pem(pem_contents)
+    def pem(pem_contents, password=nil)
       default_options[:pem] = pem_contents
+      default_options[:pem_password] = password
+    end
+
+    # Override the way query strings are normalized.
+    # Helpful for overriding the default rails normalization of Array queries.
+    #
+    # For a query:
+    #   get '/', :query => {:selected_ids => [1,2,3]}
+    #
+    # The default query string normalizer returns:
+    #   /?selected_ids[]=1&selected_ids[]=2&selected_ids[]=3
+    #
+    # Let's change it to this:
+    #  /?selected_ids=1&selected_ids=2&selected_ids=3
+    #
+    # Pass a Proc to the query normalizer which accepts the yielded query.
+    #
+    # @example Modifying Array query strings
+    #   class ServiceWrapper
+    #     include HTTParty
+    #
+    #     query_string_normalizer proc { |query|
+    #       query.map do |key, value|
+    #         value.map {|v| "#{key}=#{v}"}
+    #       end.join('&')
+    #     }
+    #   end
+    #
+    # @param [Proc] normalizer custom query string normalizer.
+    # @yield [Hash, String] query string
+    # @yieldreturn [Array] an array that will later be joined with '&'
+    def query_string_normalizer(normalizer)
+      default_options[:query_string_normalizer] = normalizer
+    end
+
+    # Allows setting an OpenSSL certificate authority file
+    #
+    #   class Foo
+    #     include HTTParty
+    #     ssl_ca_file '/etc/ssl/certs/ca-certificates.crt'
+    #   end
+    def ssl_ca_file(path)
+      default_options[:ssl_ca_file] = path
+    end
+
+    # Allows setting an OpenSSL certificate authority path (directory)
+    #
+    #   class Foo
+    #     include HTTParty
+    #     ssl_ca_path '/etc/ssl/certs/'
+    #   end
+    def ssl_ca_path(path)
+      default_options[:ssl_ca_path] = path
     end
 
     # Allows setting a custom parser for the response.