1
0
Fork 0
mirror of https://github.com/rest-client/rest-client.git synced 2022-11-09 13:49:40 -05:00
rest-client--rest-client/README.rdoc

270 lines
8.6 KiB
Text
Raw Normal View History

2010-01-24 10:04:31 -05:00
= REST Client -- simple DSL for accessing HTTP and REST resources
2008-03-09 16:25:18 -04:00
2010-01-24 10:04:31 -05:00
A simple HTTP and REST client for Ruby, inspired by the Sinatra's microframework style
2008-06-21 00:09:44 -04:00
of specifying actions: get, put, post, delete.
2008-03-09 16:25:18 -04:00
2010-04-30 12:34:35 -04:00
* Main page: http://github.com/archiloque/rest-client
* Mailing list: rest.client@librelist.com (send a mail to subscribe).
* IRC: #rest-client at freenode
2009-12-26 09:51:47 -05:00
== Usage: Raw URL
2008-03-09 16:25:18 -04:00
2008-03-09 16:31:52 -04:00
require 'rest_client'
2008-03-09 16:25:18 -04:00
RestClient.get 'http://example.com/resource'
2010-01-01 07:59:47 -05:00
RestClient.get 'http://example.com/resource', {:params => {:id => 50, 'foo' => 'bar'}}
RestClient.get 'https://user:password@example.com/private/resource', {:accept => :json}
2008-03-09 16:25:18 -04:00
RestClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
2008-06-21 00:07:20 -04:00
RestClient.post "http://example.com/resource", { 'x' => 1 }.to_json, :content_type => :json, :accept => :json
2008-06-21 00:07:20 -04:00
RestClient.delete 'http://example.com/resource'
response = RestClient.get 'http://example.com/resource'
response.code
➔ 200
response.cookies
➔ {"Foo"=>"BAR", "QUUX"=>"QUUUUX"}
response.headers
2010-03-29 13:39:48 -04:00
➔ {:content_type=>"text/html; charset=utf-8", :cache_control=>"private" ...
response.to_str
➔ \n<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n \"http://www.w3.org/TR/html4/strict.dtd\">\n\n<html ....
2010-04-12 07:27:00 -04:00
RestClient.post( url,
{
:transfer => {
:path => '/foo/bar',
:owner => 'that_guy',
:group => 'those_guys'
},
:upload => {
:file => File.new(path, 'rb')
2010-04-12 07:27:00 -04:00
}
})
2009-12-26 09:51:47 -05:00
== Multipart
2008-03-09 16:25:18 -04:00
2008-07-23 16:16:05 -04:00
Yeah, that's right! This does multipart sends for you!
RestClient.post '/data', :myfile => File.new("/path/to/image.jpg", 'rb')
2008-07-23 16:16:05 -04:00
This does two things for you:
* Auto-detects that you have a File value sends it as multipart
* Auto-detects the mime of the file and sets it in the HEAD of the payload for each entry
If you are sending params that do not contain a File object but the payload needs to be multipart then:
RestClient.post '/data', :foo => 'bar', :multipart => true
2009-12-26 09:51:47 -05:00
== Usage: ActiveResource-Style
2008-03-10 20:20:57 -04:00
2008-06-21 00:07:20 -04:00
resource = RestClient::Resource.new 'http://example.com/resource'
2008-03-10 20:20:57 -04:00
resource.get
2008-07-20 16:13:16 -04:00
private_resource = RestClient::Resource.new 'https://example.com/private/resource', 'user', 'pass'
2008-06-21 00:07:20 -04:00
private_resource.put File.read('pic.jpg'), :content_type => 'image/jpg'
2008-03-10 20:20:57 -04:00
2009-12-20 10:20:30 -05:00
See RestClient::Resource module docs for details.
2008-03-10 20:20:57 -04:00
2009-12-26 09:51:47 -05:00
== Usage: Resource Nesting
2008-06-21 00:07:20 -04:00
site = RestClient::Resource.new('http://example.com')
site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
See RestClient::Resource docs for details.
2010-02-10 15:48:46 -05:00
== Exceptions (see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)
* for results code between 200 and 207 a RestClient::Response will be returned
2010-05-25 12:55:57 -04:00
* for results code 301, 302 or 307 the redirection will be followed if the request is a get or a head
2010-02-10 15:48:46 -05:00
* for result code 303 the redirection will be followed and the request transformed into a get
* for other cases a RestClient::Exception holding the Response will be raised, a specific exception class will be thrown for know error codes
RestClient.get 'http://example.com/resource'
➔ RestClient::ResourceNotFound: RestClient::ResourceNotFound
begin
RestClient.get 'http://example.com/resource'
rescue => e
e.response
end
➔ 404 Resource Not Found | text/html 282 bytes
== Result handling
A block can be passed to the RestClient method, this block will then be called with the Response.
Response.return! can be called to invoke the default response's behavior.
# Don't raise exceptions but return the response
RestClient.get('http://example.com/resource'){|response, request, result| response }
➔ 404 Resource Not Found | text/html 282 bytes
# Manage a specific error code
RestClient.get('http://my-rest-service.com/resource'){ |response, request, result, &block|
case response.code
when 200
p "It worked !"
response
when 423
raise SomeCustomExceptionIfYouWant
else
response.return!(request, result, &block)
end
}
# Follow redirections for all request types and not only for get and head
2010-05-25 12:55:57 -04:00
# RFC : "If the 301, 302 or 307 status code is received in response to a request other than GET or HEAD,
# the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user,
# since this might change the conditions under which the request was issued."
RestClient.get('http://my-rest-service.com/resource'){ |response, request, result, &block|
2010-05-25 12:55:57 -04:00
if [301, 302, 307].include? response.code
response.follow_redirection(request, result, &block)
else
response.return!(request, result, &block)
end
}
2010-01-24 10:04:31 -05:00
== Non-normalized URIs.
2010-01-24 10:07:21 -05:00
If you want to use non-normalized URIs, you can normalize them with the addressable gem (http://addressable.rubyforge.org/api/).
2010-01-24 10:04:31 -05:00
require 'addressable/uri'
RestClient.get(Addressable::URI.parse("http://www.詹姆斯.com/").normalize.to_str)
2009-12-26 09:51:47 -05:00
== Lower-level access
2009-12-20 10:20:30 -05:00
For cases not covered by the general API, you can use the RestClient::Resource class which provide a lower-level API, see the class' rdoc for more information.
2009-12-26 09:51:47 -05:00
== Shell
2008-03-09 16:25:18 -04:00
2008-07-20 16:13:16 -04:00
The restclient shell command gives an IRB session with RestClient already loaded:
2008-07-07 22:49:10 -04:00
2008-07-20 16:13:16 -04:00
$ restclient
>> RestClient.get 'http://example.com'
2008-03-09 16:25:18 -04:00
2008-07-20 16:13:16 -04:00
Specify a URL argument for get/post/put/delete on that resource:
2008-07-20 16:13:16 -04:00
$ restclient http://example.com
>> put '/resource', 'data'
2008-07-20 16:13:16 -04:00
Add a user and password for authenticated resources:
$ restclient https://example.com user pass
>> delete '/private/resource'
2008-07-20 16:13:16 -04:00
Create ~/.restclient for named sessions:
2008-07-20 16:13:16 -04:00
sinatra:
url: http://localhost:4567
2008-07-20 16:13:16 -04:00
rack:
url: http://localhost:9292
2008-07-20 16:13:16 -04:00
private_site:
url: http://example.com
username: user
password: pass
2008-07-20 16:13:16 -04:00
Then invoke:
$ restclient private_site
2009-12-26 09:51:47 -05:00
Use as a one-off, curl-style:
$ restclient get http://example.com/resource > output_body
$ restclient put http://example.com/resource < input_body
== Logging
To enable logging you can
* set RestClient.log with a ruby Logger
* or set an environment variable to avoid modifying the code (in this case you can use a file name, "stdout" or "stderr"):
$ RESTCLIENT_LOG=stdout path/to/my/program
Either produces logs like this:
RestClient.get "http://some/resource"
# => 200 OK | text/html 250 bytes
RestClient.put "http://some/resource", "payload"
# => 401 Unauthorized | application/xml 340 bytes
Note that these logs are valid Ruby, so you can paste them into the restclient
shell or a script to replay your sequence of rest calls.
== Proxy
All calls to RestClient, including Resources, will use the proxy specified by
RestClient.proxy:
RestClient.proxy = "http://proxy.example.com/"
RestClient.get "http://some/resource"
# => response from some/resource as proxied through proxy.example.com
Often the proxy url is set in an environment variable, so you can do this to
use whatever proxy the system is configured to use:
RestClient.proxy = ENV['http_proxy']
== Cookies
Request and Response objects know about HTTP cookies, and will automatically
extract and set headers for them as needed:
response = RestClient.get 'http://example.com/action_which_sets_session_id'
response.cookies
# => {"_applicatioN_session_id" => "1234"}
response2 = RestClient.post(
'http://localhost:3000/',
{:param1 => "foo"},
{:cookies => {:session_id => "1234"}}
)
# ...response body
== SSL Client Certificates
RestClient::Resource.new(
'https://example.com',
:ssl_client_cert => OpenSSL::X509::Certificate.new(File.read("cert.pem")),
:ssl_client_key => OpenSSL::PKey::RSA.new(File.read("key.pem"), "passphrase, if any"),
:ssl_ca_file => "ca_certificate.pem",
:verify_ssl => OpenSSL::SSL::VERIFY_PEER
).get
Self-signed certificates can be generated with the openssl command-line tool.
2010-02-16 13:03:44 -05:00
== Hook
2010-02-16 13:05:16 -05:00
RestClient.add_before_execution_proc add a Proc to be called before each execution, it's handy if you need a direct access to the http request.
2010-02-16 13:03:44 -05:00
Example:
# Add oath support using the oauth gem
require 'oauth'
access_token = ...
RestClient.add_before_execution_proc do |req, params|
access_token.sign! req
end
RestClient.get 'http://example.com'
2010-04-23 15:50:54 -04:00
== More
Need caching, more advanced logging or any ability provided by a rack middleware ?
Have a look at rest-client-components http://github.com/crohr/rest-client-components
2009-12-26 09:51:47 -05:00
== Meta
2008-03-09 16:25:18 -04:00
Written by Adam Wiggins, major modifications by Blake Mizerany, maintained by Julien Kirch
2008-08-03 19:12:05 -04:00
Patches contributed by many, including Chris Anderson, Greg Borenstein, Ardekantur, Pedro Belo, Rafael Souza, Rick Olson, Aman Gupta, François Beausoleil and Nick Plante.
2008-03-09 16:25:18 -04:00
Released under the MIT License: http://www.opensource.org/licenses/mit-license.php