Module | HTTParty::ClassMethods |
In: |
lib/httparty.rb
|
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
Allows setting basic authentication username and password.
class Foo include HTTParty basic_auth 'username', 'password' end
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
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
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})
Allows setting a base uri to be used for each request.
class Foo include HTTParty headers 'Accept' => 'text/html' end
Allows setting http proxy information to be used
class Foo include HTTParty http_proxy 'http://foo.com', 80 end
Allows setting a custom parser for the response.
class Foo include HTTParty parser Proc.new {|data| ...} end
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'})