1
0
Fork 0
mirror of https://github.com/jnunemaker/httparty synced 2023-03-27 23:23:07 -04:00
httparty/lib/httparty.rb

264 lines
6.8 KiB
Ruby
Raw Normal View History

require 'pathname'
2008-07-27 11:52:18 -04:00
require 'net/http'
require 'net/https'
require 'rubygems'
gem 'crack', '>= 0.1.1'
require 'crack'
dir = Pathname(__FILE__).dirname.expand_path
require dir + 'httparty/module_inheritable_attributes'
require dir + 'httparty/cookie_hash'
module HTTParty
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
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
base.send :include, HTTParty::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)
2008-07-27 11:52:18 -04:00
end
2009-11-09 22:09:33 -05:00
module ClassMethods
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
def http_proxy(addr=nil, port = nil)
default_options[:http_proxyaddr] = addr
default_options[:http_proxyport] = port
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
def base_uri(uri=nil)
return default_options[:base_uri] unless uri
default_options[:base_uri] = HTTParty.normalize_base_uri(uri)
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
def basic_auth(u, p)
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
def default_params(h={})
raise ArgumentError, 'Default params must be a hash' unless h.is_a?(Hash)
default_options[:default_params] ||= {}
default_options[:default_params].merge!(h)
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
def headers(h={})
raise ArgumentError, 'Headers must be a hash' unless h.is_a?(Hash)
default_options[:headers] ||= {}
default_options[:headers].merge!(h)
end
def cookies(h={})
raise ArgumentError, 'Cookies must be a hash' unless h.is_a?(Hash)
default_cookies.add_cookies(h)
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
def format(f = nil)
if f.nil?
default_options[:format]
else
parser(Parser) if parser.nil?
default_options[:format] = f
validate_format
end
end
2009-11-09 22:09:33 -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')
# end
2009-11-20 17:45:06 -05:00
def pem(pem_contents)
default_options[:pem] = pem_contents
end
# Allows setting a custom parser for the response.
#
# class Foo
# include HTTParty
# parser Proc.new {|data| ...}
# end
def parser(customer_parser = nil)
if customer_parser.nil?
default_options[:parser]
else
default_options[:parser] = customer_parser
validate_format
end
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})
def get(path, options={})
perform_request Net::HTTP::Get, path, options
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'})
def post(path, options={})
perform_request Net::HTTP::Post, path, options
end
def put(path, options={})
perform_request Net::HTTP::Put, path, options
end
def delete(path, options={})
perform_request Net::HTTP::Delete, path, options
end
2009-11-09 22:09:33 -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-07-27 11:52:18 -04:00
private
2008-11-11 23:27:58 -05:00
def perform_request(http_method, path, options) #:nodoc:
options = default_options.dup.merge(options)
process_cookies(options)
Request.new(http_method, path, options).perform
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
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{|f| f.to_s}.sort.join(', ')}"
end
end
2008-07-27 11:52:18 -04:00
end
def self.normalize_base_uri(url) #:nodoc:
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
normalized_url.chop! if ends_with_slash
normalized_url.gsub!(/^https?:\/\//i, '')
2009-11-09 22:09:33 -05:00
"http#{'s' if use_ssl}://#{normalized_url}"
end
2009-11-09 22:09:33 -05:00
2009-01-30 23:18:27 -05:00
class Basement #:nodoc:
include HTTParty
end
2009-11-09 22:09:33 -05:00
def self.get(*args)
Basement.get(*args)
end
2009-11-09 22:09:33 -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
def self.head(*args)
Basement.head(*args)
end
def self.options(*args)
Basement.options(*args)
end
end
2008-12-06 22:01:42 -05:00
require dir + 'httparty/core_extensions'
require dir + 'httparty/exceptions'
require dir + 'httparty/parser'
require dir + 'httparty/request'
require dir + 'httparty/response'