httparty 0.15.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 623e3c0f072b6dbd7ac990ec0eed857fb6639ea1
-  data.tar.gz: 19d364f6fe90c6ab731df0900e22eab28ae8792f
+SHA256:
+  metadata.gz: 9dccd9b1a1fa3f98ca96da312ccdf19371418815a556b1443acac322a8ae4e15
+  data.tar.gz: 61f75235d1dcf4e1e38cbab62869aeeff28de9d0dc27fad30c7ca11d6355cd0d
 SHA512:
-  metadata.gz: 900978930b87670ca410e9ecc634dc1846e47b3d1da5abf4f599d598e70ea4d640b0aa03ed6cbfb66f88109d18b8f84da845720d124b0e944ad8ec37509004ec
-  data.tar.gz: 5f7795609a87edf4b28f1b2a9db1b37d9d2be1a75d228e6e6545b9520b3225bbce00e27a0d8a1f0c558edd4f7daf8feb40cc7b6851ca17cccb8065b0589141c9
+  metadata.gz: e47fce0ce8b6c4fe97ee0335b4f0544bc039755f12f0c2aac9f47e901739fd172390a3dc01f070d6799b1af335293b5d09a66514deb0810dfafc37f25d2f3c81
+  data.tar.gz: 9aa37800410a58a60ca751de44eed1026514b26c408a1f890b48a8f0049c814052a70a55343d3798c3d4d59ca9b157257c1fa83240200d283ba374a9b62db2ef

data/.editorconfig

@@ -0,0 +1,18 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://EditorConfig.org
+
+root = true
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+
+[**.rb]
+indent_size = 2
+indent_style = spaces
+insert_final_newline = true
+
+[**.xml]
+trim_trailing_whitespace = false
+
+[**.html]
+trim_trailing_whitespace = false

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - '3.0' # Quoted, to avoid YAML float 3.0 interplated to "3"
+          - 3.1
+          - 3.2
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # Run "bundle install", and cache the result automatically.
+      - name: Run Rake
+        run: bundle exec rake

data/.gitignore

@@ -9,3 +9,6 @@ pkg/
 /.bundle
 .rvmrc
 coverage
+*.gem
+.idea
+.tool-versions

data/.rubocop_todo.yml

@@ -15,7 +15,7 @@ Lint/EndAlignment:
   Enabled: false
 
 # Offense count: 1
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 # Offense count: 5

data/{History.md → Changelog.md}

@@ -1,3 +1,140 @@
+## 0.21.0
+
+* [escape filename in the multipart/form-data Content-Disposition header](https://github.com/jnunemaker/httparty/commit/cdb45a678c43e44570b4e73f84b1abeb5ec22b8e)
+* [Fix request marshaling](https://github.com/jnunemaker/httparty/pull/767)
+* [Replace `mime-types` with `mini_mime`](https://github.com/jnunemaker/httparty/pull/769)
+
+## 0.20.0
+
+Breaking changes
+
+* Require Ruby >= 2.3.0
+
+Fixes
+
+* [`Marshal.dump` fails on response objects when request option `:logger` is set or `:parser` is a proc](https://github.com/jnunemaker/httparty/pull/714)
+* [Switch `:pem` option to to `OpenSSL::PKey.read` to support other algorithms](https://github.com/jnunemaker/httparty/pull/720)
+
+## 0.19.1
+
+* [Remove use of unary + method for creating non-frozen string to increase compatibility with older versions of ruby](https://github.com/jnunemaker/httparty/commit/4416141d37fd71bdba4f37589ec265f55aa446ce)
+
+## 0.19.0
+
+* [Multipart/Form-Data: rewind files after read](https://github.com/jnunemaker/httparty/pull/709)
+* [add frozen_string_literal pragma to all files](https://github.com/jnunemaker/httparty/pull/711)
+* [Better handling of Accept-Encoding / Content-Encoding decompression (fixes #562)](https://github.com/jnunemaker/httparty/pull/729)
+
+## 0.18.1
+
+* [Rename cop Lint/HandleExceptions to Lint/SuppressedException](https://github.com/jnunemaker/httparty/pull/699).
+* [Encode keys in query params](https://github.com/jnunemaker/httparty/pull/698).
+* [Fixed SSL doc example](https://github.com/jnunemaker/httparty/pull/692).
+* [Add a build status badge](https://github.com/jnunemaker/httparty/pull/701).
+
+
+## 0.18.0
+
+* [Support gzip/deflate transfer encoding when explicit headers are set](https://github.com/jnunemaker/httparty/pull/678).
+* [Support edge case cookie format with a blank attribute](https://github.com/jnunemaker/httparty/pull/685).
+
+## 0.17.3
+
+0.17.2 is broken https://github.com/jnunemaker/httparty/issues/681
+
+## 0.17.2
+
+* [Add Response#nil? deprecetion warning](https://github.com/jnunemaker/httparty/pull/680)
+
+## 0.17.1
+
+* [Pass options to dynamic block headers](https://github.com/jnunemaker/httparty/pull/661)
+* [Normalize urls with URI adapter to allow International Domain Names support](https://github.com/jnunemaker/httparty/pull/668)
+* [Add max_retries support](https://github.com/jnunemaker/httparty/pull/660)
+* [Minize gem size by removing test files](https://github.com/jnunemaker/httparty/pull/658)
+
+## 0.17.0
+
+* [Fix encoding of streamed chunk](https://github.com/jnunemaker/httparty/pull/644)
+* [Avoid modifying frozen strings](https://github.com/jnunemaker/httparty/pull/649)
+* [Expose .connection on fragment block param](https://github.com/jnunemaker/httparty/pull/648)
+* [Add support for `Net::HTTP#write_timeout` method (Ruby 2.6.0)](https://github.com/jnunemaker/httparty/pull/647)
+
+## 0.16.4
+* [Add support for Ruby 2.6](https://github.com/jnunemaker/httparty/pull/636)
+* [Fix a few multipart issues](https://github.com/jnunemaker/httparty/pull/626)
+* [Improve a memory usage for https requests](https://github.com/jnunemaker/httparty/pull/625)
+* [Add response code to streamed body](https://github.com/jnunemaker/httparty/pull/588)
+
+## 0.16.3
+* [Add Logstash-compatible formatter](https://github.com/jnunemaker/httparty/pull/612)
+* [Add support for headers specified with symbols](https://github.com/jnunemaker/httparty/pull/622)
+* [Fix response object marshalling](https://github.com/jnunemaker/httparty/pull/618)
+* [Add ability to send multipart, without passing file](https://github.com/jnunemaker/httparty/pull/615)
+* [Fix detection of content_type for multipart payload](https://github.com/jnunemaker/httparty/pull/616)
+* [Process dynamic headers before making actual request](https://github.com/jnunemaker/httparty/pull/606)
+* [Fix multipart uploads with ActionDispatch::Http::UploadedFile TempFile by using original_filename](https://github.com/jnunemaker/httparty/pull/598)
+* [Added support for lock and unlock http requests](https://github.com/jnunemaker/httparty/pull/596)
+
+## 0.16.2
+
+* [Support ActionDispatch::Http::UploadedFile again](https://github.com/jnunemaker/httparty/pull/585)
+
+## 0.16.1
+
+* [Parse content with application/hal+json content type as JSON](https://github.com/jnunemaker/httparty/pull/573)
+* [Convert objects to string when concatenating in multipart stuff](https://github.com/jnunemaker/httparty/pull/575)
+* [Fix multipart to set its header even when other headers are provided](https://github.com/jnunemaker/httparty/pull/576)
+
+## 0.16.0
+
+* [Add multipart support](https://github.com/jnunemaker/httparty/pull/569)
+
+## 0.15.7
+
+Fixed
+
+* [Add Response#pretty_print | Restore documented behavior](https://github.com/jnunemaker/httparty/pull/570)
+* [Add ability to parse response from JSONAPI ](https://github.com/jnunemaker/httparty/pull/553)
+
+## 0.15.6
+
+Fixed
+
+* [Encoding and content type stuff](https://github.com/jnunemaker/httparty/pull/543)
+
+## 0.15.5
+
+Fixed
+
+* [Use non-destructive gsub](https://github.com/jnunemaker/httparty/pull/540)
+
+## 0.15.4
+
+Fixed
+
+* Prevent gsub errors with different encodings.
+* Prevent passing nil to encode_body.
+
+## 0.15.3
+
+Fixed
+
+* [Fix processing nil body for HEAD requests](https://github.com/jnunemaker/httparty/pull/530).
+* Add missing require to headers.rb (33439a8).
+
+## 0.15.2
+
+Fixed
+
+* Remove symlink from specs. It was reportedly still getting bundled with gem.
+
+## 0.15.1
+
+Fixed
+
+* Stop including test files in gem. Fixes installation issues on windows due to symlink in spec dir.
+
 ## 0.15.0
 
 Breaking Changes

data/Gemfile

@@ -2,8 +2,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'fakeweb',  '~> 1.3'
 gem 'mongrel',  '1.2.0.pre2'
+gem 'json'
 
 group :development do
   gem 'guard'
@@ -12,8 +12,15 @@ group :development do
 end
 
 group :test do
+  gem 'rexml'
   gem 'rspec',    '~> 3.4'
   gem 'simplecov', require: false
   gem 'aruba'
   gem 'cucumber', '~> 2.3'
+  gem 'webmock'
+  gem 'addressable'
+end
+
+group :development, :test do
+  gem 'pry'
 end

data/Guardfile

@@ -1,7 +1,8 @@
 rspec_options = {
-  version:        1,
   all_after_pass: false,
-  all_on_start:   false
+  all_on_start: false,
+  failed_mode: :keep,
+  cmd: 'bundle exec rspec',
 }
 
 guard 'rspec', rspec_options do

data/README.md

@@ -1,6 +1,8 @@
 # httparty
 
-Makes http fun again!
+[![CI](https://github.com/jnunemaker/httparty/actions/workflows/ci.yml/badge.svg)](https://github.com/jnunemaker/httparty/actions/workflows/ci.yml)
+
+Makes http fun again!  Ain't no party like a httparty, because a httparty don't stop.
 
 ## Install
 
@@ -10,7 +12,7 @@ gem install httparty
 
 ## Requirements
 
-* Ruby 2.0.0 or higher
+* Ruby 2.3.0 or higher
 * multi_xml
 * You like to party!
 
@@ -46,7 +48,6 @@ puts stack_exchange.users
 ```
 
 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
@@ -63,9 +64,8 @@ httparty "https://api.stackexchange.com/2.2/questions?site=stackoverflow"
 ## Help and Docs
 
 * [Docs](https://github.com/jnunemaker/httparty/tree/master/docs)
-* https://groups.google.com/forum/#!forum/httparty-gem
-* http://rdoc.info/projects/jnunemaker/httparty
-* http://stackoverflow.com/questions/tagged/httparty
+* https://github.com/jnunemaker/httparty/discussions
+* https://www.rubydoc.info/github/jnunemaker/httparty
 
 ## Contributing
 

data/docs/README.md

@@ -9,11 +9,25 @@ Makes http fun again!
 ## 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:
 
-```
+```ruby
 response = HTTParty.get('http://example.com', format: :plain)
 JSON.parse response, symbolize_names: true
 ```
 
+## Posting JSON
+When using Content Type `application/json` with `POST`, `PUT` or `PATCH` requests, the body should be a string of valid JSON:
+
+```ruby
+# With written JSON
+HTTParty.post('http://example.com', body: "{\"foo\":\"bar\"}", headers: { 'Content-Type' => 'application/json' })
+
+# Using JSON.generate
+HTTParty.post('http://example.com', body: JSON.generate({ foo: 'bar' }), headers: { 'Content-Type' => 'application/json' })
+
+# Using object.to_json
+HTTParty.post('http://example.com', body: { foo: 'bar' }.to_json, headers: { 'Content-Type' => 'application/json' })
+```
+
 ## Working with SSL
 
 You can use this guide to work with SSL certificates.
@@ -24,11 +38,10 @@ You can use this guide to work with SSL certificates.
 # Use this example if you are using a pem file
 
 class Client
-	include HTTParty
-	
-	base_uri "https://example.com"
-	pem File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456"
+  include HTTParty
 
+  base_uri "https://example.com"
+  pem File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456"
 end
 ```
 
@@ -38,11 +51,10 @@ end
 # Use this example if you are using a pkcs12 file
 
 class Client
-	include HTTParty
-	
-	base_uri "https://example.com"
-	pkcs12 File.read("#{File.expand_path('.')}/path/to/certs/cert.p12"), "123456"
+  include HTTParty
 
+  base_uri "https://example.com"
+  pkcs12 File.read("#{File.expand_path('.')}/path/to/certs/cert.p12"), "123456"
 end
 ```
 
@@ -52,11 +64,10 @@ end
 # Use this example if you are using a pkcs12 file
 
 class Client
-	include HTTParty
-	
-	base_uri "https://example.com"
-	ssl_ca_file "#{File.expand_path('.')}/path/to/certs/cert.pem"
+  include HTTParty
 
+  base_uri "https://example.com"
+  ssl_ca_file "#{File.expand_path('.')}/path/to/certs/cert.pem"
 end
 ```
 
@@ -66,44 +77,115 @@ end
 # Use this example if you are using a pkcs12 file
 
 class Client
-	include HTTParty
-	
-	base_uri "https://example.com"
- 	ssl_ca_path '/path/to/certs'
+  include HTTParty
+
+  base_uri "https://example.com"
+  ssl_ca_path '/path/to/certs'
 end
 ```
 
-You can also include this options with the call:
+You can also include all of these options with the call:
 
 ```ruby
 class Client
-	include HTTParty
-	
-	base_uri "https://example.com"
-	
-	def	self.fetch
-		get("/resources", pem: (File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456")
-	end
+  include HTTParty
+
+  base_uri "https://example.com"
+
+  def self.fetch
+    get("/resources", pem: File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), pem_password: "123456")
+  end
 end
 ```
 
 ### Avoid SSL verification
 
-In some cases you may want to skip SSL verification, because the entity that issue the certificate is not a valid one, but you still want to work with it. You can achieve this through:
+In some cases you may want to skip SSL verification, because the entity that issued the certificate is not a valid one, but you still want to work with it. You can achieve this through:
 
 ```ruby
-#Skips SSL certificate verification
+# Skips SSL certificate verification
 
 class Client
-	include HTTParty
-
-	base_uri "https://example.com"
-	pem File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456"
-	
-	def	self.fetch
-		get("/resources", verify: false)
-		# You can also use something like:
-		# get("resources", verify_peer: false)
-	end
+  include HTTParty
+
+  base_uri "https://example.com"
+  pem File.read("#{File.expand_path('.')}/path/to/certs/cert.pem"), "123456"
+
+  def self.fetch
+    get("/resources", verify: false)
+    # You can also use something like:
+    # get("resources", verify_peer: false)
+  end
 end
-```
+```
+
+### HTTP Compression
+
+The `Accept-Encoding` request header and `Content-Encoding` response header
+are used to control compression (gzip, etc.) over the wire. Refer to
+[RFC-2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) for details.
+(For clarity: these headers are **not** used for character encoding i.e. `utf-8`
+which is specified in the `Accept` and `Content-Type` headers.)
+
+Unless you have specific requirements otherwise, we recommend to **not** set
+set the `Accept-Encoding` header on HTTParty requests. In this case, `Net::HTTP`
+will set a sensible default compression scheme and automatically decompress the response.
+
+If you explicitly set `Accept-Encoding`, there be dragons:
+
+* If the HTTP response `Content-Encoding` received on the wire is `gzip` or `deflate`,
+  `Net::HTTP` will automatically decompress it, and will omit `Content-Encoding`
+  from your `HTTParty::Response` headers.
+
+* For the following encodings, HTTParty will automatically decompress them if you include
+  the required gem into your project. Similar to above, if decompression succeeds,
+  `Content-Encoding` will be omitted from your `HTTParty::Response` headers.
+  **Warning:** Support for these encodings is experimental and not fully battle-tested.
+
+  | Content-Encoding | Required Gem |
+  | --- | --- |
+  | `br` (Brotli)      | [brotli](https://rubygems.org/gems/brotli) |
+  | `compress` (LZW)   | [ruby-lzws](https://rubygems.org/gems/ruby-lzws) |
+  | `zstd` (Zstandard) | [zstd-ruby](https://rubygems.org/gems/zstd-ruby) |
+
+* For other encodings, `HTTParty::Response#body` will return the raw uncompressed byte string,
+  and you'll need to inspect the `Content-Encoding` response header and decompress it yourself.
+  In this case, `HTTParty::Response#parsed_response` will be `nil`.
+
+* Lastly, you may use the `skip_decompression` option to disable all automatic decompression
+  and always get `HTTParty::Response#body` in its raw form along with the `Content-Encoding` header.
+
+```ruby
+# Accept-Encoding=gzip,deflate can be safely assumed to be auto-decompressed
+
+res = HTTParty.get('https://example.com/test.json', headers: { 'Accept-Encoding' => 'gzip,deflate,identity' })
+JSON.parse(res.body) # safe
+
+
+# Accept-Encoding=br,compress requires third-party gems
+
+require 'brotli'
+require 'lzws'
+require 'zstd-ruby'
+res = HTTParty.get('https://example.com/test.json', headers: { 'Accept-Encoding' => 'br,compress,zstd' })
+JSON.parse(res.body)
+
+
+# Accept-Encoding=* may return unhandled Content-Encoding
+
+res = HTTParty.get('https://example.com/test.json', headers: { 'Accept-Encoding' => '*' })
+encoding = res.headers['Content-Encoding']
+if encoding
+JSON.parse(your_decompression_handling(res.body, encoding))
+else
+# Content-Encoding not present implies decompressed
+JSON.parse(res.body)
+end
+
+
+# Gimme the raw data!
+
+res = HTTParty.get('https://example.com/test.json', skip_decompression: true)
+encoding = res.headers['Content-Encoding']
+JSON.parse(your_decompression_handling(res.body, encoding))
+```

data/examples/README.md

@@ -13,22 +13,22 @@
     * Creates a custom parser for XML using crack gem
     * Uses `get` request
 
-* [Create HTML Nokogiri parser](nokogiri_html_parser.rb)   
+* [Create HTML Nokogiri parser](nokogiri_html_parser.rb)
     * Adds Html as a format
     * passed the body of request to Nokogiri
-    
+
 * [More Custom Parsers](custom_parsers.rb)
   * Create an additional parser for atom or make it the ONLY parser
-  
+
 * [Basic Auth, Delicious](delicious.rb)
   * Basic Auth, shows how to merge those into options
   * Uses `get` requests
-  
+
 * [Passing Headers, User Agent](headers_and_user_agents.rb)
   * Use the class method of Httparty
   * Pass the User-Agent in the headers
   * Uses `get` requests
-  
+
 * [Basic Post Request](basic.rb)
     * Httparty included into poro class
     * Uses `post` requests
@@ -36,7 +36,7 @@
 * [Access Rubyurl Shortener](rubyurl.rb)
   * Httparty included into poro class
   * Uses `post` requests
-  
+
 * [Add a custom log file](logging.rb)
   * create a log file and have httparty log requests
 
@@ -44,23 +44,23 @@
   * Httparty included into poro class
   * Creates methods for different endpoints
   * Uses `get` requests
-  
+
 * [Accessing Tripit](tripit_sign_in.rb)
   * Httparty included into poro class
   * Example of using `debug_output` to see headers/urls passed
   * Getting and using Cookies
   * Uses `get` requests
-  
+
 * [Accessing Twitter](twitter.rb)
   * Httparty included into poro class
   * Basic Auth
-  * Loads settings from a config file 
+  * Loads settings from a config file
   * Uses `get` requests
   * Uses `post` requests
-  
+
 * [Accessing WhoIsMyRep](whoismyrep.rb)
   * Httparty included into poro class
-  * Uses `get` requests     
+  * Uses `get` requests
   * Two ways to pass params to get, inline on the url or in query hash
 
 * [Rescue Json Error](rescue_json.rb)
@@ -70,3 +70,20 @@
   * Uses `get` requests
   * Uses `stream_body` mode
   * Download file without using the memory
+
+* [Microsoft graph](microsoft_graph.rb)
+  * Basic Auth
+  * Uses `post` requests
+  * Uses multipart
+
+* [Multipart](multipart.rb)
+  * Multipart data upload _(with and without file)_
+
+* [Uploading File](body_stream.rb)
+  * Uses `body_stream` to upload file
+
+* [Accessing x509 Peer Certificate](peer_cert.rb)
+  * Provides access to the server's TLS certificate
+
+* [Accessing IDNs](idn.rb)
+  * Uses a `get` request with an International domain names, which are Urls with emojis and non-ASCII characters such as accented letters.

data/examples/aaws.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'active_support'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
 
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'httparty')
@@ -13,14 +15,16 @@ module AAWS
     default_params Service: 'AWSECommerceService', Operation: 'ItemSearch', SearchIndex: 'Books'
 
     def initialize(key)
-      self.class.default_params AWSAccessKeyId: key
+      @auth = { AWSAccessKeyId: key }
     end
 
     def search(options = {})
       raise ArgumentError, 'You must search for something' if options[:query].blank?
 
       # amazon uses nasty camelized query params
-      options[:query] = options[:query].inject({}) { |h, q| h[q[0].to_s.camelize] = q[1]; h }
+      options[:query] = options[:query]
+        .reverse_merge(@auth)
+        .transform_keys { |k| k.to_s.camelize }
 
       # make a request and return the items (NOTE: this doesn't handle errors at this point)
       self.class.get('/onca/xml', options)['ItemSearchResponse']['Items']

data/examples/body_stream.rb

@@ -0,0 +1,14 @@
+# To upload file to a server use :body_stream
+
+HTTParty.put(
+  'http://localhost:3000/train',
+  body_stream: File.open('sample_configs/config_train_server_md.yml', 'r')
+)
+
+
+# Actually, it works with any IO object
+
+HTTParty.put(
+  'http://localhost:3000/train',
+  body_stream: StringIO.new('foo')
+)

data/examples/custom_parsers.rb

@@ -1,3 +1,7 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
 class ParseAtom
   include HTTParty
 

data/examples/headers_and_user_agents.rb

@@ -1,6 +1,10 @@
 # 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'
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
 
-APPLICATION_NAME = "Httparty"
-response = HTTParty.get('http://example.com', headers: {"User-Agent" => APPLICATION_NAME})
+response = HTTParty.get('http://example.com', {
+  headers: {"User-Agent" => "Httparty"},
+  debug_output: STDOUT, # To show that User-Agent is Httparty
+})

data/examples/idn.rb

@@ -0,0 +1,10 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
+class Idn
+    include HTTParty
+    uri_adapter Addressable::URI
+end
+
+pp Idn.get("https://i❤️.ws/emojidomain/💎?format=json")