httparty 0.14.0 → 0.15.0

data/bin/httparty

@@ -103,9 +103,11 @@ else
     when :json
       begin
         require 'json'
-        puts JSON.pretty_generate(response)
+        puts JSON.pretty_generate(response.parsed_response)
       rescue LoadError
         puts YAML.dump(response)
+      rescue JSON::JSONError
+        puts response.inspect
       end
     when :xml
       require 'rexml/document'

data/docs/README.md

@@ -3,8 +3,17 @@
 Makes http fun again!
 
 ## Table of contents
+- [Parsing JSON](#parsing-json)
 - [Working with SSL](#working-with-ssl)
 
+## Parsing JSON
+If the response Content Type is `application/json`, HTTParty will parse the response and return Ruby objects such as a hash or array. The default behavior for parsing JSON will return keys as strings. This can be supressed with the `format` option. To get hash keys as symbols:
+
+```
+response = HTTParty.get('http://example.com', format: :plain)
+JSON.parse response, symbolize_names: true
+```
+
 ## Working with SSL
 
 You can use this guide to work with SSL certificates.

data/examples/README.md

@@ -64,4 +64,9 @@
   * Two ways to pass params to get, inline on the url or in query hash
 
 * [Rescue Json Error](rescue_json.rb)
-  * Rescue errors due to parsing response
+  * Rescue errors due to parsing response
+
+* [Download file using stream mode](stream_download.rb)
+  * Uses `get` requests
+  * Uses `stream_body` mode
+  * Download file without using the memory

data/examples/aaws.rb

@@ -29,4 +29,4 @@ module AAWS
 end
 
 aaws = AAWS::Book.new(config[:access_key])
-pp aaws.search(query: {title: 'Ruby On Rails'})
+pp aaws.search(query: { title: 'Ruby On Rails' })

data/examples/crack.rb

@@ -16,4 +16,4 @@ class Rep
 end
 
 pp Rep.get('http://whoismyrepresentative.com/getall_mems.php?zip=46544')
-pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: {zip: 46544})
+pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: { zip: 46544 })

data/examples/custom_parsers.rb

@@ -21,7 +21,7 @@ class OnlyParseAtom
 
   # Only support Atom
   class Parser::OnlyAtom < HTTParty::Parser
-    SupportedFormats = {"application/atom+xml" => :atom}
+    SupportedFormats = { "application/atom+xml" => :atom }
 
     protected
 

data/examples/delicious.rb

@@ -8,7 +8,7 @@ class Delicious
   base_uri 'https://api.del.icio.us/v1'
 
   def initialize(u, p)
-    @auth = {username: u, password: p}
+    @auth = { username: u, password: p }
   end
 
   # query params that filter the posts are:
@@ -17,7 +17,7 @@ class Delicious
   #   url (optional). Filter by this url.
   #   ie: posts(query: {tag: 'ruby'})
   def posts(options = {})
-    options.merge!({basic_auth: @auth})
+    options.merge!({ basic_auth: @auth })
     self.class.get('/posts/get', options)
   end
 
@@ -25,13 +25,13 @@ class Delicious
   #   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})
+    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.posts(query: { tag: 'ruby' })
 pp delicious.recent
 
 delicious.recent['posts']['post'].each { |post| puts post['href'] }

data/examples/logging.rb

@@ -22,7 +22,7 @@ Google.get "http://google.com"
 my_logger.info '*' * 70
 
 my_logger.info "The default formatter is :apache. The :curl formatter can also be used."
-my_logger.info "You can tell wich method to call on the logger too. It is info by default."
+my_logger.info "You can tell which method to call on the logger too. It is info by default."
 HTTParty.get "http://google.com", logger: my_logger, log_level: :debug, log_format: :curl
 
 my_logger.info '*' * 70

data/examples/stackexchange.rb

@@ -7,7 +7,7 @@ class StackExchange
   base_uri 'api.stackexchange.com'
 
   def initialize(service, page)
-    @options = { query: {site: service, page: page} }
+    @options = { query: { site: service, page: page } }
   end
 
   def questions

data/examples/stream_download.rb

@@ -0,0 +1,20 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+# download file linux-4.6.4.tar.xz without using the memory
+response = nil
+filename = "linux-4.6.4.tar.xz"
+url = "https://cdn.kernel.org/pub/linux/kernel/v4.x/#{filename}"
+
+File.open(filename, "w") do |file|
+  response = HTTParty.get(url, stream_body: true) do |fragment|
+    print "."
+    file.write(fragment)
+  end
+end
+puts
+
+pp "Success: #{response.success?}"
+pp File.stat(filename).inspect
+File.unlink(filename)

data/examples/tripit_sign_in.rb

@@ -24,7 +24,7 @@ class TripIt
   end
 
   def account_settings
-    self.class.get('/account/edit', headers: {'Cookie' => @cookie.to_cookie_string})
+    self.class.get('/account/edit', headers: { 'Cookie' => @cookie.to_cookie_string })
   end
 
   def logged_in?

data/examples/twitter.rb

@@ -14,12 +14,12 @@ class Twitter
   # 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})
+    options.merge!({ basic_auth: @auth })
     self.class.get("/statuses/#{which}_timeline.json", options)
   end
 
   def post(text)
-    options = { query: {status: text}, basic_auth: @auth }
+    options = { query: { status: text }, basic_auth: @auth }
     self.class.post('/statuses/update.json', options)
   end
 end

data/examples/whoismyrep.rb

@@ -7,4 +7,4 @@ class Rep
 end
 
 pp Rep.get('http://whoismyrepresentative.com/getall_mems.php?zip=46544')
-pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: {zip: 46544})
+pp Rep.get('http://whoismyrepresentative.com/getall_mems.php', query: { zip: 46544 })

data/httparty.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Makes http fun! Also, makes consuming restful web services dead easy.'
   s.description = 'Makes http fun! Also, makes consuming restful web services dead easy.'
 
-  s.required_ruby_version     = '>= 1.9.3'
+  s.required_ruby_version     = '>= 2.0.0'
 
   s.add_dependency 'multi_xml', ">= 0.5.2"
 

data/lib/httparty.rb

@@ -6,7 +6,6 @@ require 'zlib'
 require 'multi_xml'
 require 'json'
 require 'csv'
-require 'erb'
 
 require 'httparty/module_inheritable_attributes'
 require 'httparty/cookie_hash'
@@ -39,7 +38,7 @@ module HTTParty
   # [:+timeout+:] Timeout for opening connection and reading data.
   # [:+local_host:] Local address to bind to before connecting.
   # [:+local_port:] Local port to bind to before connecting.
-  # [:+body_steam:] Allow streaming to a REST server to specify a body_stream.
+  # [:+body_stream:] Allow streaming to a REST server to specify a body_stream.
   # [:+stream_body:] Allow for streaming large files without loading them into memory.
   #
   # 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:
@@ -128,7 +127,7 @@ module HTTParty
     end
 
     # Do not send rails style query strings.
-    # Specically, don't use bracket notation when sending an array
+    # Specifically, don't use bracket notation when sending an array
     #
     # For a query:
     #   get '/', query: {selected_ids: [1,2,3]}
@@ -213,10 +212,14 @@ module HTTParty
     #     include HTTParty
     #     headers 'Accept' => 'text/html'
     #   end
-    def headers(h = {})
-      raise ArgumentError, 'Headers must be an object which responds to #to_hash' unless h.respond_to?(:to_hash)
-      default_options[:headers] ||= {}
-      default_options[:headers].merge!(h.to_hash)
+    def headers(h = nil)
+      if h
+        raise ArgumentError, 'Headers must be an object which responds to #to_hash' unless h.respond_to?(:to_hash)
+        default_options[:headers] ||= {}
+        default_options[:headers].merge!(h.to_hash)
+      else
+        default_options[:headers] || {}
+      end
     end
 
     def cookies(h = {})

data/lib/httparty/connection_adapter.rb

@@ -38,17 +38,31 @@ module HTTParty
   # in the #options attribute. It is up to you to interpret them within your
   # connection adapter. Take a look at the implementation of
   # HTTParty::ConnectionAdapter#connection for examples of how they are used.
-  # Some things that are probably interesting are as follows:
+  # The keys used in options are 
   # * :+timeout+: timeout in seconds
   # * :+open_timeout+: http connection open_timeout in seconds, overrides timeout if set
   # * :+read_timeout+: http connection read_timeout in seconds, overrides timeout if set
   # * :+debug_output+: see HTTParty::ClassMethods.debug_output.
-  # * :+pem+: contains pem data. see HTTParty::ClassMethods.pem.
+  # * :+cert_store+: contains certificate data. see method 'attach_ssl_certificates' 
+  # * :+pem+: contains pem client certificate data. see method 'attach_ssl_certificates'
+  # * :+p12+: contains PKCS12 client client certificate data.  see method 'attach_ssl_certificates'
   # * :+verify+: verify the server’s certificate against the ca certificate.
   # * :+verify_peer+: set to false to turn off server verification but still send client certificate
   # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.
   # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path.
+  # * :+ssl_version+: SSL versions to allow. see method 'attach_ssl_certificates'
+  # * :+ciphers+: The list of SSL ciphers to support
   # * :+connection_adapter_options+: contains the hash you passed to HTTParty.connection_adapter when you configured your connection adapter
+  # * :+local_host+: The local address to bind to
+  # * :+local_port+: The local port to bind to
+  # * :+http_proxyaddr+: HTTP Proxy address
+  # * :+http_proxyport+: HTTP Proxy port
+  # * :+http_proxyuser+: HTTP Proxy user
+  # * :+http_proxypass+: HTTP Proxy password
+  #
+  # === Inherited methods
+  # * :+clean_host+: Method used to sanitize host names
+
   class ConnectionAdapter
     # Private: Regex used to strip brackets from IPv6 URIs.
     StripIpv6BracketsRegex = /\A\[(.*)\]\z/

data/lib/httparty/hash_conversions.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module HTTParty
   module HashConversions
     # @return <String> This hash as a query string

data/lib/httparty/net_digest_auth.rb

@@ -12,13 +12,13 @@ module Net
         response
       )
 
-      @header['Authorization'] = authenticator.authorization_header
-      @header['cookie'] = append_cookies(authenticator) if response['Set-Cookie']
-    end
+      authenticator.authorization_header.each do |v|
+        add_field('Authorization', v)
+      end 
 
-    def append_cookies(authenticator)
-      cookies = @header['cookie'] ? @header['cookie'] : []
-      cookies.concat(authenticator.cookie_header)
+      authenticator.cookie_header.each do |v|
+        add_field('Cookie', v)
+      end      
     end
 
     class DigestAuthenticator

data/lib/httparty/parser.rb

@@ -114,8 +114,10 @@ module HTTParty
       MultiXml.parse(body)
     end
 
+    UTF8_BOM = "\xEF\xBB\xBF".freeze
+
     def json
-      JSON.parse(body, :quirks_mode => true, :allow_nan => true)
+      JSON.parse(body.gsub(/\A#{UTF8_BOM}/, ''), :quirks_mode => true, :allow_nan => true)
     end
 
     def csv

data/lib/httparty/request.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module HTTParty
   class Request #:nodoc:
     SupportedHTTPMethods = [
@@ -27,10 +29,26 @@ module HTTParty
       end.flatten.join('&')
     end
 
+    JSON_API_QUERY_STRING_NORMALIZER = proc do |query|
+      Array(query).sort_by { |a| a[0].to_s }.map do |key, value|
+        if value.nil?
+          key.to_s
+        elsif value.respond_to?(:to_ary)
+          values = value.to_ary.map{|v| ERB::Util.url_encode(v.to_s)}
+          "#{key}=#{values.join(',')}"
+        else
+          HashConversions.to_params(key => value)
+        end
+      end.flatten.join('&')
+    end
+
     attr_accessor :http_method, :options, :last_response, :redirect, :last_uri
     attr_reader :path
 
     def initialize(http_method, path, o = {})
+      @changed_hosts = false
+      @credentials_sent = false
+
       self.http_method = http_method
       self.options = {
         limit: o.delete(:no_follow) ? 1 : 5,
@@ -42,7 +60,7 @@ module HTTParty
         connection_adapter: ConnectionAdapter
       }.merge(o)
       self.path = path
-      set_basic_auth_from_uri
+      set_basic_auth_from_uri      
     end
 
     def path=(uri)
@@ -74,7 +92,13 @@ module HTTParty
         path.path = last_uri_host + path.path
       end
 
-      new_uri = path.relative? ? options[:uri_adapter].parse("#{base_uri}#{path}") : path.clone
+      if path.relative? && path.host
+        new_uri = options[:uri_adapter].parse("#{@last_uri.scheme}:#{path}")
+      elsif path.relative?
+        new_uri = options[:uri_adapter].parse("#{base_uri}#{path}")
+      else
+        new_uri = path.clone
+      end
 
       # avoid double query string on redirects [#12]
       unless redirect
@@ -127,10 +151,19 @@ module HTTParty
           chunked_body = chunks.join
         end
       end
-
-      handle_deflation unless http_method == Net::HTTP::Head
+      
+      
       handle_host_redirection if response_redirects?
-      handle_response(chunked_body, &block)
+      result = handle_unauthorized
+      result ||= handle_response(chunked_body, &block)
+      result      
+    end
+
+    def handle_unauthorized(&block)
+      return unless digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?
+      return if @credentials_sent
+      @credentials_sent = true      
+      perform(&block)
     end
 
     def raw_body
@@ -175,19 +208,39 @@ module HTTParty
       @raw_request = http_method.new(request_uri(uri))
       @raw_request.body = body if body
       @raw_request.body_stream = options[:body_stream] if options[:body_stream]
-      @raw_request.initialize_http_header(options[:headers].to_hash) if options[:headers].respond_to?(:to_hash)
-      @raw_request.basic_auth(username, password) if options[:basic_auth] && send_authorization_header?
-      setup_digest_auth if options[:digest_auth]
+      if options[:headers].respond_to?(:to_hash)
+        headers_hash = options[:headers].to_hash
+        
+        @raw_request.initialize_http_header(headers_hash)
+        # If the caller specified a header of 'Accept-Encoding', assume they want to 
+        # deal with encoding of content. Disable the internal logic in Net:HTTP
+        # that handles encoding, if the platform supports it.
+        if @raw_request.respond_to?(:decode_content) && (headers_hash.key?('Accept-Encoding') || headers_hash.key?('accept-encoding'))
+          # Using the '[]=' sets decode_content to false
+          @raw_request['accept-encoding'] = @raw_request['accept-encoding']
+        end
+      end
+      if options[:basic_auth] && send_authorization_header?        
+        @raw_request.basic_auth(username, password)
+        @credentials_sent = true
+      end 
+      setup_digest_auth if digest_auth? && response_unauthorized? && response_has_digest_auth_challenge?
     end
 
-    def setup_digest_auth
-      auth_request = http_method.new(uri.request_uri)
-      auth_request.initialize_http_header(options[:headers].to_hash) if options[:headers].respond_to?(:to_hash)
-      res = http.request(auth_request)
+    def digest_auth?
+      !!options[:digest_auth]
+    end
 
-      if !res['www-authenticate'].nil? && res['www-authenticate'].length > 0
-        @raw_request.digest_auth(username, password, res)
-      end
+    def response_unauthorized?
+      !!last_response && last_response.code == '401'
+    end
+
+    def response_has_digest_auth_challenge?
+      !last_response['www-authenticate'].nil? && last_response['www-authenticate'].length > 0
+    end
+
+    def setup_digest_auth
+      @raw_request.digest_auth(username, password, last_response)      
     end
 
     def query_string(uri)
@@ -223,10 +276,11 @@ module HTTParty
     end
 
     def encode_with_ruby_encoding(body, charset)
-      encoding = Encoding.find(charset)
-      body.force_encoding(encoding)
-    rescue
-      body
+      if Encoding.name_list.include?(charset)
+        body.force_encoding(charset)
+      else 
+        body
+      end 
     end
 
     def assume_utf16_is_big_endian
@@ -298,22 +352,6 @@ module HTTParty
       end
     end
 
-    # Inspired by Ruby 1.9
-    def handle_deflation
-      return if response_redirects?
-      return if last_response.body.nil?
-
-      case last_response["content-encoding"]
-      when "gzip", "x-gzip"
-        body_io = StringIO.new(last_response.body)
-        last_response.body.replace Zlib::GzipReader.new(body_io).read
-        last_response.delete('content-encoding')
-      when "deflate"
-        last_response.body.replace Zlib::Inflate.inflate(last_response.body)
-        last_response.delete('content-encoding')
-      end
-    end
-
     def handle_host_redirection
       check_duplicate_location_header
       redirect_path = options[:uri_adapter].parse last_response['location']
@@ -329,7 +367,7 @@ module HTTParty
     end
 
     def send_authorization_header?
-      !defined?(@changed_hosts)
+      !@changed_hosts      
     end
 
     def response_redirects?
@@ -350,6 +388,7 @@ module HTTParty
       cookies_hash = HTTParty::CookieHash.new
       cookies_hash.add_cookies(options[:headers].to_hash['Cookie']) if options[:headers] && options[:headers].to_hash['Cookie']
       response.get_fields('Set-Cookie').each { |cookie| cookies_hash.add_cookies(cookie) }
+      
       options[:headers] ||= {}
       options[:headers]['Cookie'] = cookies_hash.to_cookie_string
     end
@@ -381,6 +420,7 @@ module HTTParty
       if path.userinfo
         username, password = path.userinfo.split(':')
         options[:basic_auth] = {username: username, password: password}
+        @credentials_sent = true
       end
     end
   end