httparty 0.13.7 → 0.20.0

data/lib/httparty/text_encoder.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module HTTParty
+  class TextEncoder
+    attr_reader :text, :content_type, :assume_utf16_is_big_endian
+
+    def initialize(text, assume_utf16_is_big_endian: true, content_type: nil)
+      @text = text.dup
+      @content_type = content_type
+      @assume_utf16_is_big_endian = assume_utf16_is_big_endian
+    end
+
+    def call
+      if can_encode?
+        encoded_text
+      else
+        text
+      end
+    end
+
+    private
+
+    def can_encode?
+      ''.respond_to?(:encoding) && charset
+    end
+
+    def encoded_text
+      if 'utf-16'.casecmp(charset) == 0
+        encode_utf_16
+      else
+        encode_with_ruby_encoding
+      end
+    end
+
+    def encode_utf_16
+      if text.bytesize >= 2
+        if text.getbyte(0) == 0xFF && text.getbyte(1) == 0xFE
+          return text.force_encoding('UTF-16LE')
+        elsif text.getbyte(0) == 0xFE && text.getbyte(1) == 0xFF
+          return text.force_encoding('UTF-16BE')
+        end
+      end
+
+      if assume_utf16_is_big_endian # option
+        text.force_encoding('UTF-16BE')
+      else
+        text.force_encoding('UTF-16LE')
+      end
+    end
+
+    def encode_with_ruby_encoding
+      # NOTE: This will raise an argument error if the
+      # charset does not exist
+      encoding = Encoding.find(charset)
+      text.force_encoding(encoding.to_s)
+    rescue ArgumentError
+      text
+    end
+
+    def charset
+      return nil if content_type.nil?
+
+      if (matchdata = content_type.match(/;\s*charset\s*=\s*([^=,;"\s]+)/i))
+        return matchdata.captures.first
+      end
+
+      if (matchdata = content_type.match(/;\s*charset\s*=\s*"((\\.|[^\\"])+)"/i))
+        return matchdata.captures.first.gsub(/\\(.)/, '\1')
+      end
+    end
+  end
+end

data/lib/httparty/utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module HTTParty
+  module Utils
+    def self.stringify_keys(hash)
+      return hash.transform_keys(&:to_s) if hash.respond_to?(:transform_keys)
+
+      hash.each_with_object({}) do |(key, value), new_hash|
+        new_hash[key.to_s] = value
+      end
+    end
+  end
+end

data/lib/httparty/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTParty
-  VERSION = "0.13.7"
+  VERSION = '0.20.0'
 end

data/lib/httparty.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'net/http'
 require 'net/https'
 require 'uri'
 require 'zlib'
 require 'multi_xml'
+require 'mime/types'
 require 'json'
 require 'csv'
-require 'erb'
 
 require 'httparty/module_inheritable_attributes'
 require 'httparty/cookie_hash'
@@ -14,6 +16,11 @@ require 'httparty/net_digest_auth'
 require 'httparty/version'
 require 'httparty/connection_adapter'
 require 'httparty/logger/logger'
+require 'httparty/request/body'
+require 'httparty/response_fragment'
+require 'httparty/decompressor'
+require 'httparty/text_encoder'
+require 'httparty/headers_processor'
 
 # @see HTTParty::ClassMethods
 module HTTParty
@@ -22,8 +29,8 @@ module HTTParty
     base.send :include, ModuleInheritableAttributes
     base.send(:mattr_inheritable, :default_options)
     base.send(:mattr_inheritable, :default_cookies)
-    base.instance_variable_set("@default_options", {})
-    base.instance_variable_set("@default_cookies", CookieHash.new)
+    base.instance_variable_set(:@default_options, {})
+    base.instance_variable_set(:@default_cookies, CookieHash.new)
   end
 
   # == Common Request Options
@@ -37,10 +44,11 @@ module HTTParty
   # [:+limit+:] Maximum number of redirects to follow. Takes precedences over :+no_follow+.
   # [:+query+:] Query string, or an object that responds to #to_hash representing it. Normalized according to the same rules as :+body+. If you specify this on a POST, you must use an object which responds to #to_hash. See also HTTParty::ClassMethods.default_params.
   # [:+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.
-  # [:+stream_body:] Allow for streaming large files without loading them into memory.
+  # [:+local_host+:] Local address to bind to before connecting.
+  # [:+local_port+:] Local port to bind to before connecting.
+  # [:+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.
+  # [:+multipart+:] Force content-type to be multipart
   #
   # 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.
@@ -72,6 +80,16 @@ module HTTParty
       default_options[:log_format] = format
     end
 
+    # Raises HTTParty::ResponseError if response's code matches this statuses
+    #
+    #   class Foo
+    #     include HTTParty
+    #     raise_on [404, 500]
+    #   end
+    def raise_on(codes = [])
+      default_options[:raise_on] = *codes
+    end
+
     # Allows setting http proxy information to be used
     #
     #   class Foo
@@ -118,7 +136,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]}
@@ -147,7 +165,7 @@ module HTTParty
     #     default_params api_key: 'secret', another: 'foo'
     #   end
     def default_params(h = {})
-      raise ArgumentError, 'Default params must an object which respond to #to_hash' unless h.respond_to?(:to_hash)
+      raise ArgumentError, 'Default params must be an object which responds to #to_hash' unless h.respond_to?(:to_hash)
       default_options[:default_params] ||= {}
       default_options[:default_params].merge!(h)
     end
@@ -159,9 +177,9 @@ module HTTParty
     #     include HTTParty
     #     default_timeout 10
     #   end
-    def default_timeout(t)
-      raise ArgumentError, 'Timeout must be an integer or float' unless t && (t.is_a?(Integer) || t.is_a?(Float))
-      default_options[:timeout] = t
+    def default_timeout(value)
+      validate_timeout_argument(__method__, value)
+      default_options[:timeout] = value
     end
 
     # Allows setting a default open_timeout for all HTTP calls in seconds
@@ -170,9 +188,9 @@ module HTTParty
     #     include HTTParty
     #     open_timeout 10
     #   end
-    def open_timeout(t)
-      raise ArgumentError, 'open_timeout must be an integer or float' unless t && (t.is_a?(Integer) || t.is_a?(Float))
-      default_options[:open_timeout] = t
+    def open_timeout(value)
+      validate_timeout_argument(__method__, value)
+      default_options[:open_timeout] = value
     end
 
     # Allows setting a default read_timeout for all HTTP calls in seconds
@@ -181,11 +199,24 @@ module HTTParty
     #     include HTTParty
     #     read_timeout 10
     #   end
-    def read_timeout(t)
-      raise ArgumentError, 'read_timeout must be an integer or float' unless t && (t.is_a?(Integer) || t.is_a?(Float))
-      default_options[:read_timeout] = t
+    def read_timeout(value)
+      validate_timeout_argument(__method__, value)
+      default_options[:read_timeout] = value
+    end
+
+    # Allows setting a default write_timeout for all HTTP calls in seconds
+    # Supported by Ruby > 2.6.0
+    #
+    #   class Foo
+    #     include HTTParty
+    #     write_timeout 10
+    #   end
+    def write_timeout(value)
+      validate_timeout_argument(__method__, value)
+      default_options[:write_timeout] = value
     end
 
+
     # Set an output stream for debugging, defaults to $stderr.
     # The output stream is passed on to Net::HTTP#set_debug_output.
     #
@@ -203,14 +234,18 @@ module HTTParty
     #     include HTTParty
     #     headers 'Accept' => 'text/html'
     #   end
-    def headers(h = {})
-      raise ArgumentError, 'Headers must 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 = {})
-      raise ArgumentError, 'Cookies must an object which respond to #to_hash' unless h.respond_to?(:to_hash)
+      raise ArgumentError, 'Cookies must be an object which responds to #to_hash' unless h.respond_to?(:to_hash)
       default_cookies.add_cookies(h)
     end
 
@@ -367,6 +402,22 @@ module HTTParty
       default_options[:ssl_version] = version
     end
 
+    # Deactivate automatic decompression of the response body.
+    # This will require you to explicitly handle body decompression
+    # by inspecting the Content-Encoding response header.
+    #
+    # Refer to docs/README.md "HTTP Compression" section for
+    # further details.
+    #
+    # @example
+    #   class Foo
+    #     include HTTParty
+    #     skip_decompression
+    #   end
+    def skip_decompression(value = true)
+      default_options[:skip_decompression] = !!value
+    end
+
     # Allows setting of SSL ciphers to use.  This only works in Ruby 1.9+.
     # You can get a list of valid specific ciphers from OpenSSL::Cipher.ciphers.
     # You also can specify a cipher suite here, listed here at openssl.org:
@@ -486,7 +537,7 @@ module HTTParty
     #   Foo.post('http://foo.com/resources', body: {bar: 'baz'})
     #
     #   # Simple post with full url using :query option,
-    #   # which gets set as form data on the request.
+    #   # which appends the parameters to the URI.
     #   Foo.post('http://foo.com/resources', query: {bar: 'baz'})
     def post(path, options = {}, &block)
       perform_request Net::HTTP::Post, path, options, &block
@@ -528,38 +579,50 @@ module HTTParty
       perform_request Net::HTTP::Options, path, options, &block
     end
 
+    # Perform a MKCOL request to a path
+    def mkcol(path, options = {}, &block)
+      perform_request Net::HTTP::Mkcol, path, options, &block
+    end
+
+    def lock(path, options = {}, &block)
+      perform_request Net::HTTP::Lock, path, options, &block
+    end
+
+    def unlock(path, options = {}, &block)
+      perform_request Net::HTTP::Unlock, path, options, &block
+    end
+
     attr_reader :default_options
 
     private
 
+    def validate_timeout_argument(timeout_type, value)
+      raise ArgumentError, "#{ timeout_type } must be an integer or float" unless value && (value.is_a?(Integer) || value.is_a?(Float))
+    end
+
     def ensure_method_maintained_across_redirects(options)
-      unless options.has_key? :maintain_method_across_redirects
+      unless options.key?(:maintain_method_across_redirects)
         options[:maintain_method_across_redirects] = true
       end
     end
 
     def perform_request(http_method, path, options, &block) #:nodoc:
       options = ModuleInheritableAttributes.hash_deep_dup(default_options).merge(options)
-      process_headers(options)
+      HeadersProcessor.new(headers, options).call
       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
-      options[:headers]["cookie"] = cookies.merge(options.delete(:cookies) || {}).to_cookie_string
+      options[:headers]['cookie'] = cookies.merge(options.delete(:cookies) || {}).to_cookie_string
     end
 
     def validate_format
       if format && parser.respond_to?(:supports_format?) && !parser.supports_format?(format)
-        raise UnsupportedFormat, "'#{format.inspect}' Must be one of: #{parser.supported_formats.map(&:to_s).sort.join(', ')}"
+        supported_format_names = parser.supported_formats.map(&:to_s).sort.join(', ')
+        raise UnsupportedFormat, "'#{format.inspect}' Must be one of: #{supported_format_names}"
       end
     end
   end
@@ -617,6 +680,7 @@ module HTTParty
 end
 
 require 'httparty/hash_conversions'
+require 'httparty/utils'
 require 'httparty/exceptions'
 require 'httparty/parser'
 require 'httparty/request'

data/website/css/common.css

@@ -8,7 +8,7 @@
 	body {font:13px arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}select, input, textarea {font:99% arial,helvetica,clean,sans-serif;}pre, code {font:115% monospace;*font-size:100%;}body * {line-height:1.22em;}
 	body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}/*ol,ul {list-style:none;}*/caption,th {text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;}
 	/* end of yahoo reset and fonts */
-	
+
 	body 										{color:#333; background:#4b1a1a; line-height:1.3;}
 	p												{margin:0 0 20px;}
 	a												{color:#4b1a1a;}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httparty
 version: !ruby/object:Gem::Version
-  version: 0.13.7
+  version: 0.20.0
 platform: ruby
 authors:
 - John Nunemaker
@@ -9,36 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
-  name: multi_xml
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '3.0'
 description: Makes http fun! Also, makes consuming restful web services dead easy.
 email:
 - nunemaker@gmail.com
@@ -47,103 +47,72 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".simplecov"
-- ".travis.yml"
 - CONTRIBUTING.md
+- Changelog.md
 - Gemfile
 - Guardfile
-- History
 - MIT-LICENSE
 - README.md
 - Rakefile
 - bin/httparty
 - cucumber.yml
+- docs/README.md
 - examples/README.md
 - examples/aaws.rb
 - examples/basic.rb
+- examples/body_stream.rb
 - examples/crack.rb
 - examples/custom_parsers.rb
 - examples/delicious.rb
 - examples/google.rb
 - examples/headers_and_user_agents.rb
+- examples/idn.rb
 - examples/logging.rb
+- examples/microsoft_graph.rb
+- examples/multipart.rb
 - examples/nokogiri_html_parser.rb
+- examples/peer_cert.rb
 - examples/rescue_json.rb
 - examples/rubyurl.rb
 - examples/stackexchange.rb
+- examples/stream_download.rb
 - examples/tripit_sign_in.rb
 - examples/twitter.rb
 - examples/whoismyrep.rb
-- features/basic_authentication.feature
-- features/command_line.feature
-- features/deals_with_http_error_codes.feature
-- features/digest_authentication.feature
-- features/handles_compressed_responses.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_read_timeout_option.feature
-- features/supports_redirection.feature
-- features/supports_timeout_option.feature
 - httparty.gemspec
 - lib/httparty.rb
 - lib/httparty/connection_adapter.rb
 - lib/httparty/cookie_hash.rb
+- lib/httparty/decompressor.rb
 - lib/httparty/exceptions.rb
 - lib/httparty/hash_conversions.rb
+- lib/httparty/headers_processor.rb
 - lib/httparty/logger/apache_formatter.rb
 - lib/httparty/logger/curl_formatter.rb
 - lib/httparty/logger/logger.rb
+- lib/httparty/logger/logstash_formatter.rb
 - lib/httparty/module_inheritable_attributes.rb
 - lib/httparty/net_digest_auth.rb
 - lib/httparty/parser.rb
 - lib/httparty/request.rb
+- lib/httparty/request/body.rb
+- lib/httparty/request/multipart_boundary.rb
 - lib/httparty/response.rb
 - lib/httparty/response/headers.rb
+- lib/httparty/response_fragment.rb
+- lib/httparty/text_encoder.rb
+- lib/httparty/utils.rb
 - lib/httparty/version.rb
 - script/release
-- 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.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/hash_conversions_spec.rb
-- spec/httparty/logger/apache_formatter_spec.rb
-- spec/httparty/logger/curl_formatter_spec.rb
-- spec/httparty/logger/logger_spec.rb
-- spec/httparty/net_digest_auth_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
 - website/css/common.css
 - website/index.html
-homepage: http://jnunemaker.github.com/httparty
+homepage: https://github.com/jnunemaker/httparty
 licenses:
 - MIT
 metadata: {}
@@ -155,63 +124,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Makes http fun! Also, makes consuming restful web services dead easy.
-test_files:
-- features/basic_authentication.feature
-- features/command_line.feature
-- features/deals_with_http_error_codes.feature
-- features/digest_authentication.feature
-- features/handles_compressed_responses.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_read_timeout_option.feature
-- features/supports_redirection.feature
-- features/supports_timeout_option.feature
-- 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.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/hash_conversions_spec.rb
-- spec/httparty/logger/apache_formatter_spec.rb
-- spec/httparty/logger/curl_formatter_spec.rb
-- spec/httparty/logger/logger_spec.rb
-- spec/httparty/net_digest_auth_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
+test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-notifications:
-  email: false
-bundler_args: --without development

data/features/basic_authentication.feature

@@ -1,20 +0,0 @@
-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 '/basic_auth.html'
-    When I call HTTParty#get with '/basic_auth.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 '/basic_auth.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 '/basic_auth.html' and a basic_auth hash:
-       | username | password   |
-       | jcash    | maninblack |
-    Then the return value should match 'Authenticated Page'