Permalink
Browse files

Documentation updates.

  • Loading branch information...
1 parent 9aa7c84 commit 722e77d1127ece173630297f06e6f7a2c2b8bdf6 @jnunemaker committed Jan 31, 2009
Showing with 71 additions and 8 deletions.
  1. +71 −8 lib/httparty.rb
View
@@ -25,30 +25,58 @@ def self.included(base)
end
module ClassMethods
- def default_options
- @default_options
- end
-
+ # 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
-
+
+ # 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
-
+
+ # 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}
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
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
-
+
+ # 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] ||= {}
@@ -61,15 +89,46 @@ def cookies(h={})
default_options[:cookies].add_cookies(h)
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
def format(f)
raise UnsupportedFormat, "Must be one of: #{AllowedFormats.values.join(', ')}" unless AllowedFormats.value?(f)
default_options[:format] = f
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})
def get(path, options={})
perform_request Net::HTTP::Get, path, options
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'})
def post(path, options={})
perform_request Net::HTTP::Post, path, options
end
@@ -81,6 +140,10 @@ def put(path, options={})
def delete(path, options={})
perform_request Net::HTTP::Delete, path, options
end
+
+ def default_options #:nodoc:
+ @default_options
+ end
private
def perform_request(http_method, path, options) #:nodoc:

0 comments on commit 722e77d

Please sign in to comment.