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

200 lines
5.4 KiB
Ruby
Raw Normal View History

2008-12-06 22:01:42 -05:00
$:.unshift(File.dirname(__FILE__))
2008-07-27 11:52:18 -04:00
require 'net/http'
require 'net/https'
require 'core_extensions'
require 'httparty/module_inheritable_attributes'
module HTTParty
AllowedFormats = {
'text/xml' => :xml,
'application/xml' => :xml,
'application/json' => :json,
'text/json' => :json,
'application/javascript' => :json,
'text/javascript' => :json,
'text/html' => :html
} unless defined?(AllowedFormats)
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.instance_variable_set("@default_options", {})
2008-07-27 11:52:18 -04:00
end
module ClassMethods
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-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-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-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-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_options[:cookies] ||= CookieHash.new
default_options[:cookies].add_cookies(h)
end
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)
raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.join(', ')}" unless AllowedFormats.value?(f)
default_options[:format] = f
end
2009-01-31 01:14:04 -05:00
# 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})
def get(path, options={})
perform_request Net::HTTP::Get, path, options
end
2009-01-31 01:14:04 -05:00
# 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 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-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:
process_cookies(options)
Request.new(http_method, path, default_options.dup.merge(options)).perform
end
def process_cookies(options) #:nodoc:
return unless options[:cookies] || default_options[:cookies]
options[:headers] ||= {}
options[:headers]["cookie"] = cookies(options[:cookies] || {}).to_cookie_string
default_options.delete(:cookies)
options.delete(:cookies)
end
2008-07-27 11:52:18 -04:00
end
def self.normalize_base_uri(url) #:nodoc:
use_ssl = (url =~ /^https/) || url.include?(':443')
ends_with_slash = url =~ /\/$/
url.chop! if ends_with_slash
url.gsub!(/^https?:\/\//i, '')
"http#{'s' if use_ssl}://#{url}"
end
2009-01-30 23:18:27 -05:00
class Basement #:nodoc:
include HTTParty
end
def self.get(*args)
Basement.get(*args)
end
def self.post(*args)
Basement.post(*args)
end
def self.put(*args)
Basement.put(*args)
end
def self.delete(*args)
Basement.delete(*args)
end
end
2008-12-06 22:01:42 -05:00
require 'httparty/cookie_hash'
2008-12-06 22:03:28 -05:00
require 'httparty/exceptions'
require 'httparty/request'
require 'httparty/response'
require 'httparty/parsers'