2009-08-22 10:36:41 -04:00
|
|
|
require 'pathname'
|
2008-07-27 11:52:18 -04:00
|
|
|
require 'net/http'
|
|
|
|
require 'net/https'
|
2009-03-29 00:30:05 -04:00
|
|
|
require 'rubygems'
|
2009-08-22 10:26:42 -04:00
|
|
|
gem 'crack', '>= 0.1.1'
|
2009-03-29 00:30:05 -04:00
|
|
|
require 'crack'
|
2008-11-08 13:59:57 -05:00
|
|
|
|
2009-08-22 10:36:41 -04:00
|
|
|
dir = Pathname(__FILE__).dirname.expand_path
|
|
|
|
|
|
|
|
require dir + 'httparty/module_inheritable_attributes'
|
|
|
|
require dir + 'httparty/cookie_hash'
|
2009-06-23 20:28:42 -04:00
|
|
|
|
2009-01-28 14:06:46 -05:00
|
|
|
module HTTParty
|
2009-12-05 21:00:36 -05:00
|
|
|
module AllowedFormatsDeprecation
|
|
|
|
def const_missing(const)
|
|
|
|
if const.to_s =~ /AllowedFormats$/
|
|
|
|
Kernel.warn("Deprecated: Use HTTParty::Parser::SupportedFormats")
|
|
|
|
HTTParty::Parser::SupportedFormats
|
|
|
|
else
|
|
|
|
super
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-12-05 21:00:36 -05:00
|
|
|
extend AllowedFormatsDeprecation
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2008-07-27 11:52:18 -04:00
|
|
|
def self.included(base)
|
|
|
|
base.extend ClassMethods
|
2009-01-31 00:53:26 -05:00
|
|
|
base.send :include, HTTParty::ModuleInheritableAttributes
|
2008-11-30 23:58:06 -05:00
|
|
|
base.send(:mattr_inheritable, :default_options)
|
2009-06-23 20:28:42 -04:00
|
|
|
base.send(:mattr_inheritable, :default_cookies)
|
2008-11-30 23:58:06 -05:00
|
|
|
base.instance_variable_set("@default_options", {})
|
2009-06-23 20:28:42 -04:00
|
|
|
base.instance_variable_set("@default_cookies", CookieHash.new)
|
2008-07-27 11:52:18 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2008-12-06 22:47:01 -05:00
|
|
|
module ClassMethods
|
2009-12-05 21:00:36 -05:00
|
|
|
extend AllowedFormatsDeprecation
|
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# Allows setting http proxy information to be used
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
|
|
|
# http_proxy 'http://foo.com', 80
|
|
|
|
# end
|
2008-08-18 15:48:54 -04:00
|
|
|
def http_proxy(addr=nil, port = nil)
|
2008-11-08 13:59:57 -05:00
|
|
|
default_options[:http_proxyaddr] = addr
|
|
|
|
default_options[:http_proxyport] = port
|
2008-08-18 15:48:54 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# 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
|
2008-11-08 13:59:57 -05:00
|
|
|
def base_uri(uri=nil)
|
|
|
|
return default_options[:base_uri] unless uri
|
2008-12-06 23:41:28 -05:00
|
|
|
default_options[:base_uri] = HTTParty.normalize_base_uri(uri)
|
2008-07-27 14:44:18 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# Allows setting basic authentication username and password.
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
|
|
|
# basic_auth 'username', 'password'
|
|
|
|
# end
|
2008-07-27 14:44:18 -04:00
|
|
|
def basic_auth(u, p)
|
2008-11-08 13:59:57 -05:00
|
|
|
default_options[:basic_auth] = {:username => u, :password => p}
|
2008-07-27 11:52:18 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# 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
|
2008-07-28 12:40:40 -04:00
|
|
|
def default_params(h={})
|
|
|
|
raise ArgumentError, 'Default params must be a hash' unless h.is_a?(Hash)
|
2008-11-08 13:59:57 -05:00
|
|
|
default_options[:default_params] ||= {}
|
|
|
|
default_options[:default_params].merge!(h)
|
2008-07-28 12:08:21 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# Allows setting a base uri to be used for each request.
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
|
|
|
# headers 'Accept' => 'text/html'
|
|
|
|
# end
|
2008-07-28 12:08:21 -04:00
|
|
|
def headers(h={})
|
|
|
|
raise ArgumentError, 'Headers must be a hash' unless h.is_a?(Hash)
|
2008-11-08 13:59:57 -05:00
|
|
|
default_options[:headers] ||= {}
|
|
|
|
default_options[:headers].merge!(h)
|
2008-07-28 12:08:21 -04:00
|
|
|
end
|
2009-01-28 23:54:42 -05:00
|
|
|
|
|
|
|
def cookies(h={})
|
|
|
|
raise ArgumentError, 'Cookies must be a hash' unless h.is_a?(Hash)
|
2009-06-23 20:28:42 -04:00
|
|
|
default_cookies.add_cookies(h)
|
2009-01-28 23:54:42 -05:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# 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
|
2009-12-05 21:00:36 -05:00
|
|
|
def format(f = nil)
|
|
|
|
if f.nil?
|
|
|
|
default_options[:format]
|
|
|
|
else
|
|
|
|
parser(Parser) if parser.nil?
|
|
|
|
default_options[:format] = f
|
|
|
|
validate_format
|
|
|
|
end
|
2008-07-28 12:40:40 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-11-19 18:03:59 -05:00
|
|
|
# Allows setting a PEM file to be used
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
2009-11-20 17:45:06 -05:00
|
|
|
# pem File.read('/home/user/my.pem')
|
2009-11-19 18:03:59 -05:00
|
|
|
# end
|
2009-11-20 17:45:06 -05:00
|
|
|
def pem(pem_contents)
|
|
|
|
default_options[:pem] = pem_contents
|
2009-11-19 18:03:59 -05:00
|
|
|
end
|
|
|
|
|
2009-09-08 23:34:21 -04:00
|
|
|
# Allows setting a custom parser for the response.
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
|
|
|
# parser Proc.new {|data| ...}
|
|
|
|
# end
|
2009-12-05 21:00:36 -05:00
|
|
|
def parser(customer_parser = nil)
|
|
|
|
if customer_parser.nil?
|
|
|
|
default_options[:parser]
|
|
|
|
else
|
|
|
|
default_options[:parser] = customer_parser
|
|
|
|
validate_format
|
|
|
|
end
|
2009-09-08 23:34:21 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# Allows making a get request to a url.
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
|
|
|
# end
|
2009-11-09 22:09:33 -05:00
|
|
|
#
|
2009-01-31 01:14:04 -05:00
|
|
|
# # Simple get with full url
|
|
|
|
# Foo.get('http://foo.com/resource.json')
|
2009-11-09 22:09:33 -05:00
|
|
|
#
|
2009-01-31 01:14:04 -05:00
|
|
|
# # 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})
|
2008-07-27 14:44:18 -04:00
|
|
|
def get(path, options={})
|
2008-11-11 19:07:11 -05:00
|
|
|
perform_request Net::HTTP::Get, path, options
|
2008-07-27 14:44:18 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
# Allows making a post request to a url.
|
|
|
|
#
|
|
|
|
# class Foo
|
|
|
|
# include HTTParty
|
|
|
|
# end
|
2009-11-09 22:09:33 -05:00
|
|
|
#
|
2009-01-31 01:14:04 -05:00
|
|
|
# # Simple post with full url and setting the body
|
|
|
|
# Foo.post('http://foo.com/resources', :body => {:bar => 'baz'})
|
|
|
|
#
|
2009-11-09 22:09:33 -05:00
|
|
|
# # Simple post with full url using :query option,
|
2009-01-31 01:14:04 -05:00
|
|
|
# # which gets set as form data on the request.
|
|
|
|
# Foo.post('http://foo.com/resources', :query => {:bar => 'baz'})
|
2008-07-27 14:44:18 -04:00
|
|
|
def post(path, options={})
|
2008-11-11 19:07:11 -05:00
|
|
|
perform_request Net::HTTP::Post, path, options
|
2008-07-27 14:44:18 -04:00
|
|
|
end
|
2008-07-28 12:40:40 -04:00
|
|
|
|
2008-07-27 14:44:18 -04:00
|
|
|
def put(path, options={})
|
2008-11-11 19:07:11 -05:00
|
|
|
perform_request Net::HTTP::Put, path, options
|
2008-07-27 14:44:18 -04:00
|
|
|
end
|
2008-07-28 12:40:40 -04:00
|
|
|
|
2008-07-27 14:44:18 -04:00
|
|
|
def delete(path, options={})
|
2008-11-11 19:07:11 -05:00
|
|
|
perform_request Net::HTTP::Delete, path, options
|
2008-07-27 14:44:18 -04:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-11-22 23:18:29 -05:00
|
|
|
def head(path, options={})
|
|
|
|
perform_request Net::HTTP::Head, path, options
|
|
|
|
end
|
|
|
|
|
|
|
|
def options(path, options={})
|
|
|
|
perform_request Net::HTTP::Options, path, options
|
|
|
|
end
|
|
|
|
|
2009-01-31 01:14:04 -05:00
|
|
|
def default_options #:nodoc:
|
|
|
|
@default_options
|
|
|
|
end
|
2008-11-08 13:59:57 -05:00
|
|
|
|
2008-07-27 11:52:18 -04:00
|
|
|
private
|
2009-12-05 21:00:36 -05:00
|
|
|
|
2008-11-11 23:27:58 -05:00
|
|
|
def perform_request(http_method, path, options) #:nodoc:
|
2009-08-21 20:32:15 -04:00
|
|
|
options = default_options.dup.merge(options)
|
2009-01-28 23:54:42 -05:00
|
|
|
process_cookies(options)
|
2009-08-21 20:32:15 -04:00
|
|
|
Request.new(http_method, path, options).perform
|
2008-07-27 14:44:18 -04:00
|
|
|
end
|
2009-01-28 23:54:42 -05:00
|
|
|
|
|
|
|
def process_cookies(options) #:nodoc:
|
2009-09-08 19:02:09 -04:00
|
|
|
return unless options[:cookies] || default_cookies.any?
|
|
|
|
options[:headers] ||= headers.dup
|
|
|
|
options[:headers]["cookie"] = cookies.merge(options.delete(:cookies) || {}).to_cookie_string
|
2009-01-28 23:54:42 -05:00
|
|
|
end
|
2009-12-05 21:00:36 -05:00
|
|
|
|
|
|
|
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{|f| f.to_s}.sort.join(', ')}"
|
|
|
|
end
|
|
|
|
end
|
2008-07-27 11:52:18 -04:00
|
|
|
end
|
2008-12-05 16:13:11 -05:00
|
|
|
|
2008-12-06 23:41:28 -05:00
|
|
|
def self.normalize_base_uri(url) #:nodoc:
|
2009-03-03 11:13:41 -05:00
|
|
|
normalized_url = url.dup
|
|
|
|
use_ssl = (normalized_url =~ /^https/) || normalized_url.include?(':443')
|
|
|
|
ends_with_slash = normalized_url =~ /\/$/
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-03-03 11:13:41 -05:00
|
|
|
normalized_url.chop! if ends_with_slash
|
|
|
|
normalized_url.gsub!(/^https?:\/\//i, '')
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-03-03 11:13:41 -05:00
|
|
|
"http#{'s' if use_ssl}://#{normalized_url}"
|
2008-12-06 23:41:28 -05:00
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2009-01-30 23:18:27 -05:00
|
|
|
class Basement #:nodoc:
|
2008-12-05 16:13:11 -05:00
|
|
|
include HTTParty
|
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2008-12-05 16:13:11 -05:00
|
|
|
def self.get(*args)
|
|
|
|
Basement.get(*args)
|
|
|
|
end
|
2009-11-09 22:09:33 -05:00
|
|
|
|
2008-12-05 16:13:11 -05:00
|
|
|
def self.post(*args)
|
|
|
|
Basement.post(*args)
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.put(*args)
|
|
|
|
Basement.put(*args)
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.delete(*args)
|
|
|
|
Basement.delete(*args)
|
|
|
|
end
|
2009-11-22 23:18:29 -05:00
|
|
|
|
|
|
|
def self.head(*args)
|
|
|
|
Basement.head(*args)
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.options(*args)
|
|
|
|
Basement.options(*args)
|
|
|
|
end
|
|
|
|
|
2008-11-08 12:05:59 -05:00
|
|
|
end
|
2008-12-06 22:01:42 -05:00
|
|
|
|
2009-08-22 10:36:41 -04:00
|
|
|
require dir + 'httparty/core_extensions'
|
|
|
|
require dir + 'httparty/exceptions'
|
2009-12-05 21:00:36 -05:00
|
|
|
require dir + 'httparty/parser'
|
2009-08-22 10:36:41 -04:00
|
|
|
require dir + 'httparty/request'
|
|
|
|
require dir + 'httparty/response'
|
2009-11-22 23:18:29 -05:00
|
|
|
|