Module: HTTParty::ClassMethods

Defined in:
lib/httparty.rb

Overview

Common Request Options

Request methods (get, post, patch, put, delete, head, options) all take a common set of options. These are:

:body:

Body of the request. If passed an object that responds to #to_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.

:http_proxyuser:

User for proxy server authentication.

:http_proxypass:

Password for proxy server authentication.

: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_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:

  • :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 an object which responds to #to_hash.

  • :maintain_method_across_redirects: see HTTParty::ClassMethods.maintain_method_across_redirects.

  • :no_follow: see HTTParty::ClassMethods.no_follow.

  • :parser: see HTTParty::ClassMethods.parser.

  • :uri_adapter: see HTTParty::ClassMethods.uri_adapter

  • :connection_adapter: see HTTParty::ClassMethods.connection_adapter.

  • :pem: see HTTParty::ClassMethods.pem.

  • :query_string_normalizer: see HTTParty::ClassMethods.query_string_normalizer

  • :ssl_ca_file: see HTTParty::ClassMethods.ssl_ca_file.

  • :ssl_ca_path: see HTTParty::ClassMethods.ssl_ca_path.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#default_optionsObject (readonly)

Returns the value of attribute default_options



549
550
551
# File 'lib/httparty.rb', line 549

def default_options
  @default_options
end

Instance Method Details

#base_uri(uri = nil) ⇒ Object

Allows setting a base uri to be used for each request. Will normalize uri to include http, etc.

class Foo
  include HTTParty
  base_uri 'twitter.com'
end


104
105
106
107
# File 'lib/httparty.rb', line 104

def base_uri(uri = nil)
  return default_options[:base_uri] unless uri
  default_options[:base_uri] = HTTParty.normalize_base_uri(uri)
end

#basic_auth(u, p) ⇒ Object

Allows setting basic authentication username and password.

class Foo
  include HTTParty
  basic_auth 'username', 'password'
end


115
116
117
# File 'lib/httparty.rb', line 115

def basic_auth(u, p)
  default_options[:basic_auth] = {username: u, password: p}
end

#ciphers(cipher_names) ⇒ Object

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: www.openssl.org/docs/apps/ciphers.html#CIPHER_SUITE_NAMES

class Foo
  include HTTParty
  ciphers "RC4-SHA"
end


392
393
394
# File 'lib/httparty.rb', line 392

def ciphers(cipher_names)
  default_options[:ciphers] = cipher_names
end

#connection_adapter(custom_adapter = nil, options = nil) ⇒ Object

Allows setting a custom connection_adapter for the http connections

Examples:

class Foo
  include HTTParty
  connection_adapter Proc.new {|uri, options| ... }
end

provide optional configuration for your connection_adapter

class Foo
  include HTTParty
  connection_adapter Proc.new {|uri, options| ... }, {foo: :bar}
end

See Also:



467
468
469
470
471
472
473
474
# File 'lib/httparty.rb', line 467

def connection_adapter(custom_adapter = nil, options = nil)
  if custom_adapter.nil?
    default_options[:connection_adapter]
  else
    default_options[:connection_adapter] = custom_adapter
    default_options[:connection_adapter_options] = options
  end
end

#cookies(h = {}) ⇒ Object

Raises:

  • (ArgumentError)


225
226
227
228
# File 'lib/httparty.rb', line 225

def cookies(h = {})
  raise ArgumentError, 'Cookies must be an object which responds to #to_hash' unless h.respond_to?(:to_hash)
  default_cookies.add_cookies(h)
end

#copy(path, options = {}, &block) ⇒ Object

Perform a COPY request to a path



529
530
531
# File 'lib/httparty.rb', line 529

def copy(path, options = {}, &block)
  perform_request Net::HTTP::Copy, path, options, &block
end

#debug_output(stream = $stderr) ⇒ Object

Set an output stream for debugging, defaults to $stderr. The output stream is passed on to Net::HTTP#set_debug_output.

class Foo
  include HTTParty
  debug_output $stderr
end


205
206
207
# File 'lib/httparty.rb', line 205

def debug_output(stream = $stderr)
  default_options[:debug_output] = stream
end

#default_params(h = {}) ⇒ Object

Allows setting default parameters to be appended to each request. Great for api keys and such.

class Foo
  include HTTParty
  default_params api_key: 'secret', another: 'foo'
end

Raises:

  • (ArgumentError)


158
159
160
161
162
# File 'lib/httparty.rb', line 158

def default_params(h = {})
  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

#default_timeout(t) ⇒ Object

Allows setting a default timeout for all HTTP calls Timeout is specified in seconds.

class Foo
  include HTTParty
  default_timeout 10
end

Raises:

  • (ArgumentError)


171
172
173
174
# File 'lib/httparty.rb', line 171

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
end

#delete(path, options = {}, &block) ⇒ Object

Perform a DELETE request to a path



519
520
521
# File 'lib/httparty.rb', line 519

def delete(path, options = {}, &block)
  perform_request Net::HTTP::Delete, path, options, &block
end

#digest_auth(u, p) ⇒ Object

Allows setting digest authentication username and password.

class Foo
  include HTTParty
  digest_auth 'username', 'password'
end


125
126
127
# File 'lib/httparty.rb', line 125

def digest_auth(u, p)
  default_options[:digest_auth] = {username: u, password: p}
end

#disable_rails_query_string_formatObject

Do not send rails style query strings. Specifically, 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

Examples:

class Foo
  include HTTParty
  disable_rails_query_string_format
end


147
148
149
# File 'lib/httparty.rb', line 147

def disable_rails_query_string_format
  query_string_normalizer Request::NON_RAILS_QUERY_STRING_NORMALIZER
end

#follow_redirects(value = true) ⇒ Object

Proceed to the location header when an HTTP response dictates a redirect. Redirects are always followed by default.

Examples:

class Foo
  include HTTParty
  base_uri 'http://google.com'
  follow_redirects true
end


239
240
241
# File 'lib/httparty.rb', line 239

def follow_redirects(value = true)
  default_options[:follow_redirects] = value
end

#format(f = nil) ⇒ Object

Allows setting the format with which to parse. Must be one of the allowed formats ie: json, xml

class Foo
  include HTTParty
  format :json
end


250
251
252
253
254
255
256
257
258
# File 'lib/httparty.rb', line 250

def format(f = nil)
  if f.nil?
    default_options[:format]
  else
    parser(Parser) if parser.nil?
    default_options[:format] = f
    validate_format
  end
end

#get(path, options = {}, &block) ⇒ Object

Allows making a get request to a url.

class Foo
  include HTTParty
end

# Simple get with full url
Foo.get('http://foo.com/resource.json')

# Simple get with full url and query parameters
# ie: http://foo.com/resource.json?limit=10
Foo.get('http://foo.com/resource.json', query: {limit: 10})


488
489
490
# File 'lib/httparty.rb', line 488

def get(path, options = {}, &block)
  perform_request Net::HTTP::Get, path, options, &block
end

#head(path, options = {}, &block) ⇒ Object

Perform a HEAD request to a path



534
535
536
537
# File 'lib/httparty.rb', line 534

def head(path, options = {}, &block)
  ensure_method_maintained_across_redirects options
  perform_request Net::HTTP::Head, path, options, &block
end

#headers(h = nil) ⇒ Object

Allows setting HTTP headers to be used for each request.

class Foo
  include HTTParty
  headers 'Accept' => 'text/html'
end


215
216
217
218
219
220
221
222
223
# File 'lib/httparty.rb', line 215

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

#http_proxy(addr = nil, port = nil, user = nil, pass = nil) ⇒ Object

Allows setting http proxy information to be used

class Foo
  include HTTParty
  http_proxy 'http://foo.com', 80, 'user', 'pass'
end


90
91
92
93
94
95
# File 'lib/httparty.rb', line 90

def http_proxy(addr = nil, port = nil, user = nil, pass = nil)
  default_options[:http_proxyaddr] = addr
  default_options[:http_proxyport] = port
  default_options[:http_proxyuser] = user
  default_options[:http_proxypass] = pass
end

#logger(logger, level = :info, format = :apache) ⇒ Object

Turns on logging

class Foo
  include HTTParty
  logger Logger.new('http_logger'), :info, :apache
end


68
69
70
71
72
# File 'lib/httparty.rb', line 68

def logger(logger, level = :info, format = :apache)
  default_options[:logger]     = logger
  default_options[:log_level]  = level
  default_options[:log_format] = format
end

#maintain_method_across_redirects(value = true) ⇒ Object

Declare that you wish to maintain the chosen HTTP method across redirects. The default behavior is to follow redirects via the GET method, except if you are making a HEAD request, in which case the default is to follow all redirects with HEAD requests. If you wish to maintain the original method, you can set this option to true.

Examples:

class Foo
  include HTTParty
  base_uri 'http://google.com'
  maintain_method_across_redirects true
end


296
297
298
# File 'lib/httparty.rb', line 296

def maintain_method_across_redirects(value = true)
  default_options[:maintain_method_across_redirects] = value
end

#mkcol(path, options = {}, &block) ⇒ Object

Perform a MKCOL request to a path



545
546
547
# File 'lib/httparty.rb', line 545

def mkcol(path, options = {}, &block)
  perform_request Net::HTTP::Mkcol, path, options, &block
end

#move(path, options = {}, &block) ⇒ Object

Perform a MOVE request to a path



524
525
526
# File 'lib/httparty.rb', line 524

def move(path, options = {}, &block)
  perform_request Net::HTTP::Move, path, options, &block
end

#no_follow(value = false) ⇒ Object

Declare whether or not to follow redirects. When true, an RedirectionTooDeep error will raise upon encountering a redirect. You can then gain access to the response object via HTTParty::RedirectionTooDeep#response.

Examples:

class Foo
  include HTTParty
  base_uri 'http://google.com'
  no_follow true
end

begin
  Foo.get('/')
rescue HTTParty::RedirectionTooDeep => e
  puts e.response.body
end

See Also:



279
280
281
# File 'lib/httparty.rb', line 279

def no_follow(value = false)
  default_options[:no_follow] = value
end

#open_timeout(t) ⇒ Object

Allows setting a default open_timeout for all HTTP calls in seconds

class Foo
  include HTTParty
  open_timeout 10
end

Raises:

  • (ArgumentError)


182
183
184
185
# File 'lib/httparty.rb', line 182

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
end

#options(path, options = {}, &block) ⇒ Object

Perform an OPTIONS request to a path



540
541
542
# File 'lib/httparty.rb', line 540

def options(path, options = {}, &block)
  perform_request Net::HTTP::Options, path, options, &block
end

#parser(custom_parser = nil) ⇒ Object

Allows setting a custom parser for the response.

class Foo
  include HTTParty
  parser Proc.new {|data| ...}
end


432
433
434
435
436
437
438
439
# File 'lib/httparty.rb', line 432

def parser(custom_parser = nil)
  if custom_parser.nil?
    default_options[:parser]
  else
    default_options[:parser] = custom_parser
    validate_format
  end
end

#patch(path, options = {}, &block) ⇒ Object

Perform a PATCH request to a path



509
510
511
# File 'lib/httparty.rb', line 509

def patch(path, options = {}, &block)
  perform_request Net::HTTP::Patch, path, options, &block
end

#pem(pem_contents, password = nil) ⇒ Object

Allows setting a PEM file to be used

class Foo
  include HTTParty
  pem File.read('/home/user/my.pem'), "optional password"
end


324
325
326
327
# File 'lib/httparty.rb', line 324

def pem(pem_contents, password = nil)
  default_options[:pem] = pem_contents
  default_options[:pem_password] = password
end

#pkcs12(p12_contents, password) ⇒ Object

Allows setting a PKCS12 file to be used

class Foo
  include HTTParty
  pkcs12 File.read('/home/user/my.p12'), "password"
end


335
336
337
338
# File 'lib/httparty.rb', line 335

def pkcs12(p12_contents, password)
  default_options[:p12] = p12_contents
  default_options[:p12_password] = password
end

#post(path, options = {}, &block) ⇒ Object

Allows making a post request to a url.

class Foo
  include HTTParty
end

# Simple post with full url and setting the body
Foo.post('http://foo.com/resources', body: {bar: 'baz'})

# Simple post with full url using :query option,
# which appends the parameters to the URI.
Foo.post('http://foo.com/resources', query: {bar: 'baz'})


504
505
506
# File 'lib/httparty.rb', line 504

def post(path, options = {}, &block)
  perform_request Net::HTTP::Post, path, options, &block
end

#put(path, options = {}, &block) ⇒ Object

Perform a PUT request to a path



514
515
516
# File 'lib/httparty.rb', line 514

def put(path, options = {}, &block)
  perform_request Net::HTTP::Put, path, options, &block
end

#query_string_normalizer(normalizer) {|Hash, String| ... } ⇒ Object

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.

Examples:

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

Parameters:

  • normalizer (Proc)

    custom query string normalizer.

Yields:

  • (Hash, String)

    query string

Yield Returns:

  • (Array)

    an array that will later be joined with '&'



368
369
370
# File 'lib/httparty.rb', line 368

def query_string_normalizer(normalizer)
  default_options[:query_string_normalizer] = normalizer
end

#raise_on(codes = []) ⇒ Object

Raises HTTParty::ResponseError if response's code matches this statuses

class Foo
  include HTTParty
  raise_on [404, 500]
end


80
81
82
# File 'lib/httparty.rb', line 80

def raise_on(codes = [])
  default_options[:raise_on] = *codes
end

#read_timeout(t) ⇒ Object

Allows setting a default read_timeout for all HTTP calls in seconds

class Foo
  include HTTParty
  read_timeout 10
end

Raises:

  • (ArgumentError)


193
194
195
196
# File 'lib/httparty.rb', line 193

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
end

#resend_on_redirect(value = true) ⇒ Object

Declare that you wish to resend the full HTTP request across redirects, even on redirects that should logically become GET requests. A 303 redirect in HTTP signifies that the redirected url should normally retrieved using a GET request, for instance, it is the output of a previous POST. maintain_method_across_redirects respects this behavior, but you can force HTTParty to resend_on_redirect even on 303 responses.

Examples:

class Foo
  include HTTParty
  base_uri 'http://google.com'
  resend_on_redirect
end


314
315
316
# File 'lib/httparty.rb', line 314

def resend_on_redirect(value = true)
  default_options[:resend_on_redirect] = value
end

#ssl_ca_file(path) ⇒ Object

Allows setting an OpenSSL certificate authority file. The file should contain one or more certificates in PEM format.

Setting this option enables certificate verification. All certificates along a chain must be available in ssl_ca_file or ssl_ca_path for verification to succeed.

class Foo
  include HTTParty
  ssl_ca_file '/etc/ssl/certs/ca-certificates.crt'
end


408
409
410
# File 'lib/httparty.rb', line 408

def ssl_ca_file(path)
  default_options[:ssl_ca_file] = path
end

#ssl_ca_path(path) ⇒ Object

Allows setting an OpenSSL certificate authority path (directory).

Setting this option enables certificate verification. All certificates along a chain must be available in ssl_ca_file or ssl_ca_path for verification to succeed.

class Foo
  include HTTParty
  ssl_ca_path '/etc/ssl/certs/'
end


422
423
424
# File 'lib/httparty.rb', line 422

def ssl_ca_path(path)
  default_options[:ssl_ca_path] = path
end

#ssl_version(version) ⇒ Object

Allows setting of SSL version to use. This only works in Ruby 1.9+. You can get a list of valid versions from OpenSSL::SSL::SSLContext::METHODS.

class Foo
  include HTTParty
  ssl_version :SSLv3
end


379
380
381
# File 'lib/httparty.rb', line 379

def ssl_version(version)
  default_options[:ssl_version] = version
end

#uri_adapter(uri_adapter) ⇒ Object

Allows setting a custom URI adapter.

class Foo
  include HTTParty
  uri_adapter Addressable::URI
end

Raises:

  • (ArgumentError)


447
448
449
450
# File 'lib/httparty.rb', line 447

def uri_adapter(uri_adapter)
  raise ArgumentError, 'The URI adapter should respond to #parse' unless uri_adapter.respond_to?(:parse)
  default_options[:uri_adapter] = uri_adapter
end