httparty 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88f8c122e637f99fecd417041020833f2ba2a775
-  data.tar.gz: 308db16b7ab96c4beb228bf72eaf85626c40298b
+  metadata.gz: e2e263bc6000ec32578c99ef814398a9742be7a7
+  data.tar.gz: 9f8eb0a8ddb0100669e3f08c86fbde96b7c538d7
 SHA512:
-  metadata.gz: ba5e4e41966cb967db3dae1988eb551721cf134f55d008e376353b482538cacda2a35294d7f52a43ddb81a137783e64ef8723962e8b5259617c2d21bc9a07f07
-  data.tar.gz: 7388e5ec85b6a1c5fb862c1ea11e92c1c501da28bce3a4f2af93ec0b4b535fa059a091632e5710c51c5cf3ce520e8c7f3120f95dd797cedbb84c45490fd23871
+  metadata.gz: 4e02f9c9aab76af35b66bc0421d7322357a3a180f55cb50434259ce907d9cb536adaef681312fdee37648d8b558731c1c003d5bb57caa0000a187d24377449b3
+  data.tar.gz: 39286a8c98a2375f4fa60c98fb0ec3a5dd8828760029fcdefa054acce0da38cc20eb113cfbb6759a6df3f7ffaf7a9d62021c17ddb599318cf557ab70fdfedfad

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - ree
   - 1.9.3
   - 2.0.0
 notifications:

data/bin/httparty

@@ -18,7 +18,7 @@ OptionParser.new do |o|
   o.on("-f",
        "--format [FORMAT]",
        "Output format to use instead of pretty-print ruby: " +
-       "plain, json or xml") do |f|
+       "plain, csv, json or xml") do |f|
     opts[:output_format] = f.downcase.to_sym
   end
 
@@ -107,6 +107,9 @@ else
       require 'rexml/document'
       REXML::Document.new(response.body).write(STDOUT, 2)
       puts
+    when :csv
+      require 'csv'
+      puts CSV.parse(response.body).map{|row| row.to_s }
     else
       puts response
   end

data/features/handles_multiple_formats.feature

@@ -14,6 +14,21 @@ Feature: Handles Multiple Formats
     Then it should return a String
     And the return value should match '<h1>Some HTML</h1>'
 
+  Scenario: A CSV service
+    Given a remote service that returns:
+      """
+      "Last Name","Name"
+      "jennings","waylon"
+      "cash","johnny"
+      """
+    And that service is accessed at the path '/service.csv'
+    And the response from the service has a Content-Type of 'application/csv'
+    When I call HTTParty#get with '/service.csv'
+    Then it should return an Array equaling:
+      | Last Name | Name   |
+      | jennings  | waylon |
+      | cash      | johnny |
+
   Scenario: A JSON service
     Given a remote service that returns '{ "jennings": "waylon", "cash": "johnny" }'
     And that service is accessed at the path '/service.json'

data/features/steps/httparty_response_steps.rb

@@ -29,6 +29,11 @@ Then /it should return a Hash equaling:/ do |hash_table|
   end
 end
 
+Then /it should return an Array equaling:/ do |array|
+  @response_from_httparty.should be_an_instance_of(Array)
+  @response_from_httparty.should eql array.raw
+end
+
 Then /it should return a response with a (\d+) response code/ do |code|
   @response_from_httparty.code.should eql(code.to_i)
 end

data/features/steps/remote_service_steps.rb

@@ -3,6 +3,11 @@ Given /a remote service that returns '(.*)'/ do |response_body|
   Given "the response from the service has a body of '#{response_body}'"
 end
 
+Given /^a remote service that returns:$/ do |response_body|
+  @handler = BasicMongrelHandler.new
+  @handler.response_body = response_body
+end
+
 Given /a remote service that returns a (\d+) status code/ do |code|
   @handler = BasicMongrelHandler.new
   @handler.response_code = code

data/lib/httparty.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'zlib'
 require 'multi_xml'
 require 'json'
+require 'csv'
 
 require 'httparty/module_inheritable_attributes'
 require 'httparty/cookie_hash'
@@ -282,6 +283,17 @@ module HTTParty
       default_options[:pem_password] = password
     end
 
+    # Allows setting a PKCS12 file to be used
+    #
+    #   class Foo
+    #     include HTTParty
+    #     pkcs12 File.read('/home/user/my.p12'), "password"
+    #   end
+    def pkcs12(p12_contents, password)
+      default_options[:p12] = p12_contents
+      default_options[:p12_password] = password
+    end
+
     # Override the way query strings are normalized.
     # Helpful for overriding the default rails normalization of Array queries.
     #
@@ -481,11 +493,18 @@ module HTTParty
     private
 
       def perform_request(http_method, path, options, &block) #:nodoc:
-        options = default_options.dup.merge(options)
+        options = default_options.merge(options)
+        process_headers(options)
         process_cookies(options)
         Request.new(http_method, path, options).perform(&block)
       end
 
+      def process_headers(options)
+        if options[:headers] && headers.any?
+          options[:headers] = headers.merge(options[:headers])
+        end
+      end
+
       def process_cookies(options) #:nodoc:
         return unless options[:cookies] || default_cookies.any?
         options[:headers] ||= headers.dup
@@ -539,7 +558,7 @@ module HTTParty
   end
 
   def self.copy(*args, &block)
-    Basement.move(*args, &block)
+    Basement.copy(*args, &block)
   end
 
   def self.head(*args, &block)

data/lib/httparty/connection_adapter.rb

@@ -147,6 +147,14 @@ module HTTParty
           http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         end
 
+        # PKCS12 client certificate authentication
+        if options[:p12]
+          p12 = OpenSSL::PKCS12.new(options[:p12], options[:p12_password])
+          http.cert = p12.certificate
+          http.key = p12.key
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+
         # SSL certificate authority file and/or directory
         if options[:ssl_ca_file]
           http.ca_file = options[:ssl_ca_file]

data/lib/httparty/exceptions.rb

@@ -1,13 +1,16 @@
 module HTTParty
+  # @abstact Exceptions raised by HTTParty inherit from Error
+  class Error < StandardError; end
+
   # Exception raised when you attempt to set a non-existant format
-  class UnsupportedFormat < StandardError; end
+  class UnsupportedFormat < Error; end
 
   # Exception raised when using a URI scheme other than HTTP or HTTPS
-  class UnsupportedURIScheme < StandardError; end
+  class UnsupportedURIScheme < Error; end
 
   # @abstract Exceptions which inherit from ResponseError contain the Net::HTTP
   # response object accessible via the {#response} method.
-  class ResponseError < StandardError
+  class ResponseError < Error
     # Returns the response of the last request
     # @return [Net::HTTPResponse] A subclass of Net::HTTPResponse, e.g.
     # Net::HTTPOK

data/lib/httparty/net_digest_auth.rb

@@ -44,9 +44,9 @@ module Net
     private
 
       def parse(response_header)
-        response_header['www-authenticate'] =~ /^(\w+) (.*)/
+        response_header['www-authenticate'] =~ /Digest (.*)/
         params = {}
-        $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
+        $1.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
         params
       end
 

data/lib/httparty/parser.rb

@@ -1,5 +1,5 @@
 module HTTParty
-  # The default parser used by HTTParty, supports xml, json, html, and
+  # The default parser used by HTTParty, supports xml, json, html, csv and
   # plain text.
   #
   # == Custom Parsers
@@ -45,7 +45,10 @@ module HTTParty
       'application/javascript' => :plain,
       'text/javascript'        => :plain,
       'text/html'              => :html,
-      'text/plain'             => :plain
+      'text/plain'             => :plain,
+      'text/csv'               => :csv,
+      'application/csv'        => :csv,
+      'text/comma-separated-values' => :csv
     }
 
     # The response body of the request
@@ -113,6 +116,10 @@ module HTTParty
       JSON.load(body, nil)
     end
 
+    def csv
+      CSV.parse(body)
+    end
+
     def html
       body
     end

data/lib/httparty/request.rb

@@ -15,7 +15,7 @@ module HTTParty
     SupportedURISchemes  = [URI::HTTP, URI::HTTPS, URI::Generic]
 
     NON_RAILS_QUERY_STRING_NORMALIZER = Proc.new do |query|
-      Array(query).map do |key, value|
+      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|
         if value.nil?
           key.to_s
         elsif value.is_a?(Array)
@@ -23,7 +23,7 @@ module HTTParty
         else
           HashConversions.to_params(key => value)
         end
-      end.flatten.sort.join('&')
+      end.flatten.join('&')
     end
 
     attr_accessor :http_method, :options, :last_response, :redirect, :last_uri
@@ -174,6 +174,7 @@ module HTTParty
         query_string_parts << options[:query] unless options[:query].nil?
       end
 
+      query_string_parts.reject!(&:empty?) unless query_string_parts == [""]
       query_string_parts.size > 0 ? query_string_parts.join('&') : nil
     end
 

data/lib/httparty/response.rb

@@ -50,9 +50,9 @@ module HTTParty
       alias_method :multiple_choice?, :multiple_choices?
     end
 
-    def respond_to?(name)
+    def respond_to?(name, include_all = false)
       return true if [:request, :response, :parsed_response, :body, :headers].include?(name)
-      parsed_response.respond_to?(name) || response.respond_to?(name)
+      parsed_response.respond_to?(name, include_all) || response.respond_to?(name, include_all)
     end
 
     protected

data/lib/httparty/response/headers.rb

@@ -23,8 +23,8 @@ module HTTParty
         end
       end
 
-      def respond_to?(method)
-        super || @header.respond_to?(method)
+      def respond_to?(method, include_all = false)
+        super || @header.respond_to?(method, include_all)
       end
     end
   end

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/spec/fixtures/twitter.csv

@@ -0,0 +1,2 @@
+"name","url","id","description","protected","screen_name","followers_count","profile_image_url","location"
+"Magic 8 Bot",,"17656026","ask me a question","false","magic8bot","90","http://s3.amazonaws.com/twitter_production/profile_images/65565851/8ball_large_normal.jpg",

data/spec/httparty/connection_adapter_spec.rb

@@ -251,6 +251,48 @@ describe HTTParty::ConnectionAdapter do
           end
         end
       end
+
+      context "when providing PKCS12 certificates" do
+        let(:p12) { :p12_contents }
+        let(:options) { {:p12 => p12, :p12_password => "password"} }
+
+        context "when scheme is https" do
+          let(:uri) { URI 'https://google.com' }
+          let(:pkcs12) { mock("OpenSSL::PKCS12", :certificate => cert, :key => key) }
+          let(:cert) { mock("OpenSSL::X509::Certificate") }
+          let(:key) { mock("OpenSSL::PKey::RSA") }
+
+          before do
+            OpenSSL::PKCS12.should_receive(:new).with(p12, "password").and_return(pkcs12)
+          end
+
+          it "uses the provided P12 certificate " do
+            subject.cert.should == cert
+            subject.key.should == key
+          end
+
+          it "will verify the certificate" do
+            subject.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+          end
+        end
+
+        context "when scheme is not https" do
+          let(:uri) { URI 'http://google.com' }
+          let(:http) { Net::HTTP.new(uri) }
+
+          before do
+            Net::HTTP.stub(:new => http)
+            OpenSSL::PKCS12.new.should_not_receive(:new).with(p12, "password")
+            http.should_not_receive(:cert=)
+            http.should_not_receive(:key=)
+          end
+
+          it "has no PKCS12 certificate " do
+            subject.cert.should be_nil
+            subject.key.should be_nil
+          end
+        end
+      end
     end
   end
 end

data/spec/httparty/exception_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe HTTParty::Error do
+  subject { described_class }
+
+  its(:ancestors) { should include(StandardError) }
+
+  describe HTTParty::UnsupportedFormat do
+    its(:ancestors) { should include(HTTParty::Error) }
+  end
+  
+  describe HTTParty::UnsupportedURIScheme do
+    its(:ancestors) { should include(HTTParty::Error) }
+  end
+
+  describe HTTParty::ResponseError do
+    its(:ancestors) { should include(HTTParty::Error) }
+  end
+
+  describe HTTParty::RedirectionTooDeep do
+    its(:ancestors) { should include(HTTParty::ResponseError) }
+  end
+end

data/spec/httparty/net_digest_auth_spec.rb

@@ -112,4 +112,41 @@ describe Net::HTTPHeader::DigestAuthenticator do
       authorization_header.should include(%Q(response="#{request_digest}"))
     end
   end
+
+  context "with multiple authenticate headers" do
+    before do
+      @digest = setup_digest({
+        'www-authenticate' => 'NTLM, Digest realm="myhost@testrealm.com", nonce="NONCE", qop="auth"',
+      })
+    end
+
+    it "should set prefix" do
+      authorization_header.should =~ /^Digest /
+    end
+
+    it "should set username" do
+      authorization_header.should include(%Q(username="Mufasa"))
+    end
+
+    it "should set digest-uri" do
+      authorization_header.should include(%Q(uri="/dir/index.html"))
+    end
+
+    it "should set qop" do
+      authorization_header.should include(%Q(qop="auth"))
+    end
+
+    it "should set cnonce" do
+      authorization_header.should include(%Q(cnonce="md5(deadbeef)"))
+    end
+
+    it "should set nonce-count" do
+      authorization_header.should include(%Q(nc=00000001))
+    end
+
+    it "should set response" do
+      request_digest = "md5(md5(Mufasa:myhost@testrealm.com:Circle Of Life):NONCE:00000001:md5(deadbeef):auth:md5(GET:/dir/index.html))"
+      authorization_header.should include(%Q(response="#{request_digest}"))
+    end
+  end
 end

data/spec/httparty/parser_spec.rb

@@ -156,5 +156,10 @@ describe HTTParty::Parser do
     it "parses plain text by simply returning the body" do
       subject.send(:plain).should == 'body'
     end
+
+    it "parses csv with CSV" do
+      CSV.should_receive(:parse).with('body')
+      subject.send(:csv)
+    end
   end
 end

data/spec/httparty/request_spec.rb

@@ -21,8 +21,8 @@ describe HTTParty::Request do
       end
 
       it "URI encodes array values" do
-        query_string = normalizer[{:people => ["Bob Marley", "Tim & Jon"]}]
-        query_string.should == "people=Bob%20Marley&people=Tim%20%26%20Jon"
+        query_string = normalizer[{:people => ["Otis Redding", "Bob Marley", "Tim & Jon"], :page => 1, :xyzzy => 3}]
+        query_string.should == "page=1&people=Otis%20Redding&people=Bob%20Marley&people=Tim%20%26%20Jon&xyzzy=3"
       end
     end
 
@@ -133,6 +133,12 @@ describe HTTParty::Request do
         URI.unescape(@request.uri.query).should == ""
       end
 
+      it "does not append an ampersand when queries are embedded in paths" do
+        @request.path = "/path?a=1"
+        @request.options[:query] = {}
+        @request.uri.query.should == "a=1"
+      end
+
       it "does not duplicate query string parameters when uri is called twice" do
         @request.options[:query] = {:foo => :bar}
         @request.uri
@@ -196,6 +202,24 @@ describe HTTParty::Request do
       end
     end
 
+    it 'should handle text/csv' do
+      ["text/csv", "text/csv; charset=iso8859-1"].each do |ct|
+        @request.send(:format_from_mimetype, ct).should == :csv
+      end
+    end
+
+    it 'should handle application/csv' do
+      ["application/csv", "application/csv; charset=iso8859-1"].each do |ct|
+        @request.send(:format_from_mimetype, ct).should == :csv
+      end
+    end
+
+    it 'should handle text/comma-separated-values' do
+      ["text/comma-separated-values", "text/comma-separated-values; charset=iso8859-1"].each do |ct|
+        @request.send(:format_from_mimetype, ct).should == :csv
+      end
+    end
+
     it 'should handle text/javascript' do
       ["text/javascript", "text/javascript; charset=iso8859-1"].each do |ct|
         @request.send(:format_from_mimetype, ct).should == :plain
@@ -225,6 +249,12 @@ describe HTTParty::Request do
       @request.send(:parse_response, xml).should == {'books' => {'book' => {'id' => '1234', 'name' => 'Foo Bar!'}}}
     end
 
+    it 'should handle csv automatically' do
+      csv=[%q["id","Name"],%q["1234","Foo Bar!"]].join("\n")
+      @request.options[:format] = :csv
+      @request.send(:parse_response, csv).should == [["id","Name"],["1234","Foo Bar!"]]
+    end
+
     it 'should handle json automatically' do
       json = %q[{"books": {"book": {"name": "Foo Bar!", "id": "1234"}}}]
       @request.options[:format] = :json

data/spec/httparty_spec.rb

@@ -38,6 +38,18 @@ describe HTTParty do
     end
   end
 
+  describe "pkcs12" do
+    it 'should set the p12 content' do
+      @klass.pkcs12 'P12-CONTENT', 'PASSWORD'
+      @klass.default_options[:p12].should == 'P12-CONTENT'
+    end
+
+    it 'should set the password' do
+      @klass.pkcs12 'P12-CONTENT', 'PASSWORD'
+      @klass.default_options[:p12_password].should == 'PASSWORD'
+    end
+  end
+
   describe 'ssl_version' do
     it 'should set the ssl_version content' do
       @klass.ssl_version :SSLv3
@@ -148,12 +160,18 @@ describe HTTParty do
       @klass.get('')
     end
 
-    it "overwrites class headers when passing in headers" do
-      expect_headers(:baz => 'spax')
+    it "merges class headers with request headers" do
+      expect_headers(:baz => 'spax', :foo => 'bar')
       @klass.headers(:foo => 'bar')
       @klass.get('', :headers => {:baz => 'spax'})
     end
 
+    it 'overrides class headers with request headers' do
+      expect_headers(:baz => 'spax', :foo => 'baz')
+      @klass.headers(:foo => 'bar')
+      @klass.get('', :headers => {:baz => 'spax', :foo => 'baz'})
+    end
+
     context "with cookies" do
       it 'utilizes the class-level cookies' do
         expect_headers(:foo => 'bar', 'cookie' => 'type=snickerdoodle')
@@ -379,6 +397,11 @@ describe HTTParty do
       @klass.default_options[:format].should == :xml
     end
 
+    it "should allow csv" do
+      @klass.format :csv
+      @klass.default_options[:format].should == :csv
+    end
+
     it "should allow json" do
       @klass.format :json
       @klass.default_options[:format].should == :json
@@ -398,7 +421,7 @@ describe HTTParty do
     it 'should only print each format once with an exception' do
       lambda do
         @klass.format :foobar
-      end.should raise_error(HTTParty::UnsupportedFormat, "':foobar' Must be one of: html, json, plain, xml")
+      end.should raise_error(HTTParty::UnsupportedFormat, "':foobar' Must be one of: csv, html, json, plain, xml")
     end
 
     it 'sets the default parser' do
@@ -691,6 +714,14 @@ describe HTTParty do
       }
     end
 
+    it "should be able parse response type csv automatically" do
+      stub_http_response_with('twitter.csv')
+      profile = HTTParty.get('http://twitter.com/statuses/profile.csv')
+      profile.size.should == 2
+      profile[0].should == ["name","url","id","description","protected","screen_name","followers_count","profile_image_url","location"]
+      profile[1].should == ["Magic 8 Bot",nil,"17656026","ask me a question","false","magic8bot","90","http://s3.amazonaws.com/twitter_production/profile_images/65565851/8ball_large_normal.jpg",nil]
+    end
+
     it "should not get undefined method add_node for nil class for the following xml" do
       stub_http_response_with('undefined_method_add_node_for_nil.xml')
       result = HTTParty.get('http://foobar.com')

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 $:.push File.expand_path("../lib", __FILE__)
+
 require "httparty"
 
 require 'spec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httparty
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - John Nunemaker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -112,11 +112,13 @@ files:
 - spec/fixtures/ssl/generated/server.crt
 - spec/fixtures/ssl/generated/server.key
 - spec/fixtures/ssl/openssl-exts.cnf
+- spec/fixtures/twitter.csv
 - spec/fixtures/twitter.json
 - spec/fixtures/twitter.xml
 - spec/fixtures/undefined_method_add_node_for_nil.xml
 - spec/httparty/connection_adapter_spec.rb
 - spec/httparty/cookie_hash_spec.rb
+- spec/httparty/exception_spec.rb
 - spec/httparty/logger/apache_logger_spec.rb
 - spec/httparty/logger/curl_logger_spec.rb
 - spec/httparty/logger/logger_spec.rb
@@ -182,11 +184,13 @@ test_files:
 - spec/fixtures/ssl/generated/server.crt
 - spec/fixtures/ssl/generated/server.key
 - spec/fixtures/ssl/openssl-exts.cnf
+- spec/fixtures/twitter.csv
 - spec/fixtures/twitter.json
 - spec/fixtures/twitter.xml
 - spec/fixtures/undefined_method_add_node_for_nil.xml
 - spec/httparty/connection_adapter_spec.rb
 - spec/httparty/cookie_hash_spec.rb
+- spec/httparty/exception_spec.rb
 - spec/httparty/logger/apache_logger_spec.rb
 - spec/httparty/logger/curl_logger_spec.rb
 - spec/httparty/logger/logger_spec.rb