rest-client-multipart 1.1.0

This diff has not been reviewed by any users.
Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,99 @@
1
+ = REST Client -- simple DSL for accessing REST resources
2
+
3
+ A simple REST client for Ruby, inspired by the Sinatra's microframework style
4
+ of specifying actions: get, put, post, delete.
5
+
6
+ == Usage: Raw URL
7
+
8
+ require 'rest_client'
9
+
10
+ RestClient.get 'http://example.com/resource'
11
+ RestClient.get 'https://user:password@example.com/private/resource'
12
+
13
+ RestClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
14
+
15
+ RestClient.delete 'http://example.com/resource'
16
+
17
+ == Multipart
18
+
19
+ Yeah, that's right! This does multipart sends for you!
20
+
21
+ RestClient.post '/data', :myfile => File.new("/path/to/image.jpg")
22
+
23
+ This does two things for you:
24
+
25
+ * Auto-detects that you have a File value sends it as multipart
26
+ * Auto-detects the mime of the file and sets it in the HEAD of the payload for each entry
27
+
28
+ If you are sending params that do not contain a File object but the payload needs to be multipart then:
29
+
30
+ RestClient.post '/data', :foo => 'bar', :multipart => true
31
+
32
+ == Usage: ActiveResource-Style
33
+
34
+ resource = RestClient::Resource.new 'http://example.com/resource'
35
+ resource.get
36
+
37
+ private_resource = RestClient::Resource.new 'https://example.com/private/resource', 'user', 'pass'
38
+ private_resource.put File.read('pic.jpg'), :content_type => 'image/jpg'
39
+
40
+ See RestClient::Resource module docs for details.
41
+
42
+ == Usage: Resource Nesting
43
+
44
+ site = RestClient::Resource.new('http://example.com')
45
+ site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
46
+
47
+ See RestClient::Resource docs for details.
48
+
49
+ == Lower-level access
50
+
51
+ 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.
52
+
53
+ == Shell
54
+
55
+ The restclient shell command gives an IRB session with RestClient already loaded:
56
+
57
+ $ restclient
58
+ >> RestClient.get 'http://example.com'
59
+
60
+ Specify a URL argument for get/post/put/delete on that resource:
61
+
62
+ $ restclient http://example.com
63
+ >> put '/resource', 'data'
64
+
65
+ Add a user and password for authenticated resources:
66
+
67
+ $ restclient https://example.com user pass
68
+ >> delete '/private/resource'
69
+
70
+ Create ~/.restclient for named sessions:
71
+
72
+ sinatra:
73
+ url: http://localhost:4567
74
+ rack:
75
+ url: http://localhost:9292
76
+ private_site:
77
+ url: http://example.com
78
+ username: user
79
+ password: pass
80
+
81
+ Then invoke:
82
+
83
+ $ restclient private_site
84
+
85
+ == Meta
86
+
87
+ Written by Adam Wiggins, major modifications by Blake Mizerany, maintained by Archiloque
88
+
89
+ Patches contributed by: Chris Anderson, Greg Borenstein, Ardekantur, Pedro Belo, Rafael Souza, Rick Olson, Aman Gupta, François Beausoleil and Nick Plante.
90
+
91
+ Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
92
+
93
+ Main page: http://github.com/archiloque/rest-client
94
+
95
+ Rdoc: http://rdoc.info/projects/archiloque/rest-client
96
+
97
+ Mailing list: rest.client@librelist.com (send a mail to subscribe).
98
+
99
+ IRC: #rest-client at freenode
@@ -0,0 +1,57 @@
1
+ require 'rake'
2
+
3
+ require 'jeweler'
4
+
5
+ Jeweler::Tasks.new do |s|
6
+ s.name = "rest-client"
7
+ s.description = "A simple REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
8
+ s.summary = "Simple REST client for Ruby, inspired by microframework syntax for specifying actions."
9
+ s.author = "Adam Wiggins"
10
+ s.email = "adam@heroku.com"
11
+ s.homepage = "http://rest-client.heroku.com/"
12
+ s.rubyforge_project = "rest-client"
13
+ s.has_rdoc = true
14
+ s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
15
+ s.executables = %w(restclient)
16
+ end
17
+
18
+ Jeweler::RubyforgeTasks.new
19
+
20
+ ############################
21
+
22
+ require 'spec/rake/spectask'
23
+
24
+ desc "Run all specs"
25
+ Spec::Rake::SpecTask.new('spec') do |t|
26
+ t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
27
+ t.spec_files = FileList['spec/*_spec.rb']
28
+ end
29
+
30
+ desc "Print specdocs"
31
+ Spec::Rake::SpecTask.new(:doc) do |t|
32
+ t.spec_opts = ["--format", "specdoc", "--dry-run"]
33
+ t.spec_files = FileList['spec/*_spec.rb']
34
+ end
35
+
36
+ desc "Run all examples with RCov"
37
+ Spec::Rake::SpecTask.new('rcov') do |t|
38
+ t.spec_files = FileList['spec/*_spec.rb']
39
+ t.rcov = true
40
+ t.rcov_opts = ['--exclude', 'examples']
41
+ end
42
+
43
+ task :default => :spec
44
+
45
+ ############################
46
+
47
+ require 'rake/rdoctask'
48
+
49
+ Rake::RDocTask.new do |t|
50
+ t.rdoc_dir = 'rdoc'
51
+ t.title = "rest-client, fetch RESTful resources effortlessly"
52
+ t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
53
+ t.options << '--charset' << 'utf-8'
54
+ t.rdoc_files.include('README.rdoc')
55
+ t.rdoc_files.include('lib/*.rb')
56
+ end
57
+
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.1.6
@@ -0,0 +1,87 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ $:.unshift File.dirname(__FILE__) + "/../lib"
4
+ require 'restclient'
5
+
6
+ require "yaml"
7
+
8
+ def usage(why = nil)
9
+ puts "failed for reason: #{why}" if why
10
+ puts "usage: restclient [get|put|post|delete] url|name [username] [password]"
11
+ puts " The verb is optional, if you leave it off you'll get an interactive shell."
12
+ puts " put and post both take the input body on stdin."
13
+ exit(1)
14
+ end
15
+
16
+ if %w(get put post delete).include? ARGV.first
17
+ @verb = ARGV.shift
18
+ else
19
+ @verb = nil
20
+ end
21
+
22
+ @url = ARGV.shift || 'http://localhost:4567'
23
+
24
+ config = YAML.load(File.read(ENV['HOME'] + "/.restclient")) rescue {}
25
+
26
+ @url, @username, @password = if c = config[@url]
27
+ [c['url'], c['username'], c['password']]
28
+ else
29
+ [@url, *ARGV]
30
+ end
31
+
32
+ usage("invalid url '#{@url}") unless @url =~ /^https?/
33
+ usage("too few args") unless ARGV.size < 3
34
+
35
+ def r
36
+ @r ||= RestClient::Resource.new(@url, @username, @password)
37
+ end
38
+
39
+ r # force rc to load
40
+
41
+ if @verb
42
+ begin
43
+ if %w(put post).include? @verb
44
+ puts r.send(@verb, STDIN.read)
45
+ else
46
+ puts r.send(@verb)
47
+ end
48
+ exit 0
49
+ rescue RestClient::Exception => e
50
+ puts e.response.body if e.respond_to? :response
51
+ raise
52
+ end
53
+ end
54
+
55
+ %w(get post put delete).each do |m|
56
+ eval <<-end_eval
57
+ def #{m}(path, *args, &b)
58
+ r[path].#{m}(*args, &b)
59
+ end
60
+ end_eval
61
+ end
62
+
63
+ def method_missing(s, *args, &b)
64
+ super unless r.respond_to?(s)
65
+ begin
66
+ r.send(s, *args, &b)
67
+ rescue RestClient::RequestFailed => e
68
+ print STDERR, e.response.body
69
+ raise e
70
+ end
71
+ end
72
+
73
+ require 'irb'
74
+ require 'irb/completion'
75
+
76
+ if File.exists? ".irbrc"
77
+ ENV['IRBRC'] = ".irbrc"
78
+ end
79
+
80
+ if File.exists?(rcfile = "~/.restclientrc")
81
+ load(rcfile)
82
+ end
83
+
84
+ ARGV.clear
85
+
86
+ IRB.start
87
+ exit!
@@ -0,0 +1,2 @@
1
+ # This file exists for backward compatbility with require 'rest_client'
2
+ require File.dirname(__FILE__) + '/restclient'
@@ -0,0 +1,107 @@
1
+ require 'uri'
2
+ require 'zlib'
3
+ require 'stringio'
4
+
5
+ begin
6
+ require 'net/https'
7
+ rescue LoadError => e
8
+ raise e unless RUBY_PLATFORM =~ /linux/
9
+ raise LoadError, "no such file to load -- net/https. Try running apt-get install libopenssl-ruby"
10
+ end
11
+
12
+ require File.dirname(__FILE__) + '/restclient/request'
13
+ require File.dirname(__FILE__) + '/restclient/mixin/response'
14
+ require File.dirname(__FILE__) + '/restclient/response'
15
+ require File.dirname(__FILE__) + '/restclient/raw_response'
16
+ require File.dirname(__FILE__) + '/restclient/resource'
17
+ require File.dirname(__FILE__) + '/restclient/exceptions'
18
+ require File.dirname(__FILE__) + '/restclient/payload'
19
+ require File.dirname(__FILE__) + '/restclient/net_http_ext'
20
+
21
+ # This module's static methods are the entry point for using the REST client.
22
+ #
23
+ # # GET
24
+ # xml = RestClient.get 'http://example.com/resource'
25
+ # jpg = RestClient.get 'http://example.com/resource', :accept => 'image/jpg'
26
+ #
27
+ # # authentication and SSL
28
+ # RestClient.get 'https://user:password@example.com/private/resource'
29
+ #
30
+ # # POST or PUT with a hash sends parameters as a urlencoded form body
31
+ # RestClient.post 'http://example.com/resource', :param1 => 'one'
32
+ #
33
+ # # nest hash parameters
34
+ # RestClient.post 'http://example.com/resource', :nested => { :param1 => 'one' }
35
+ #
36
+ # # POST and PUT with raw payloads
37
+ # RestClient.post 'http://example.com/resource', 'the post body', :content_type => 'text/plain'
38
+ # RestClient.post 'http://example.com/resource.xml', xml_doc
39
+ # RestClient.put 'http://example.com/resource.pdf', File.read('my.pdf'), :content_type => 'application/pdf'
40
+ #
41
+ # # DELETE
42
+ # RestClient.delete 'http://example.com/resource'
43
+ #
44
+ # # retreive the response http code and headers
45
+ # res = RestClient.get 'http://example.com/some.jpg'
46
+ # res.code # => 200
47
+ # res.headers[:content_type] # => 'image/jpg'
48
+ #
49
+ # # HEAD
50
+ # RestClient.head('http://example.com').headers
51
+ #
52
+ # To use with a proxy, just set RestClient.proxy to the proper http proxy:
53
+ #
54
+ # RestClient.proxy = "http://proxy.example.com/"
55
+ #
56
+ # Or inherit the proxy from the environment:
57
+ #
58
+ # RestClient.proxy = ENV['http_proxy']
59
+ #
60
+ # For live tests of RestClient, try using http://rest-test.heroku.com, which echoes back information about the rest call:
61
+ #
62
+ # >> RestClient.put 'http://rest-test.heroku.com/resource', :foo => 'baz'
63
+ # => "PUT http://rest-test.heroku.com/resource with a 7 byte payload, content type application/x-www-form-urlencoded {\"foo\"=>\"baz\"}"
64
+ #
65
+ module RestClient
66
+ def self.get(url, headers={})
67
+ Request.execute(:method => :get, :url => url, :headers => headers)
68
+ end
69
+
70
+ def self.post(url, payload, headers={})
71
+ Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
72
+ end
73
+
74
+ def self.put(url, payload, headers={})
75
+ Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
76
+ end
77
+
78
+ def self.delete(url, headers={})
79
+ Request.execute(:method => :delete, :url => url, :headers => headers)
80
+ end
81
+
82
+ def self.head(url, headers={})
83
+ Request.execute(:method => :head, :url => url, :headers => headers)
84
+ end
85
+
86
+ class << self
87
+ attr_accessor :proxy
88
+ end
89
+
90
+ # Print log of RestClient calls. Value can be stdout, stderr, or a filename.
91
+ # You can also configure logging by the environment variable RESTCLIENT_LOG.
92
+ def self.log=(log)
93
+ @@log = log
94
+ end
95
+
96
+ def self.log # :nodoc:
97
+ return ENV['RESTCLIENT_LOG'] if ENV['RESTCLIENT_LOG']
98
+ return @@log if defined? @@log
99
+ nil
100
+ end
101
+
102
+ def self.version
103
+ version_path = File.dirname(__FILE__) + "/../VERSION"
104
+ return File.read(version_path).chomp if File.file?(version_path)
105
+ "0.0.0"
106
+ end
107
+ end
@@ -0,0 +1,88 @@
1
+ module RestClient
2
+ # This is the base RestClient exception class. Rescue it if you want to
3
+ # catch any exception that your request might raise
4
+ class Exception < RuntimeError
5
+ def message(default=nil)
6
+ self.class::ErrorMessage
7
+ end
8
+ end
9
+
10
+ # Base RestClient exception when there's a response available
11
+ class ExceptionWithResponse < Exception
12
+ attr_accessor :response
13
+
14
+ def initialize(response=nil)
15
+ @response = response
16
+ end
17
+
18
+ def http_code
19
+ @response.code.to_i if @response
20
+ end
21
+
22
+ def http_body
23
+ RestClient::Request.decode(@response['content-encoding'], @response.body) if @response
24
+ end
25
+ end
26
+
27
+ # A redirect was encountered; caught by execute to retry with the new url.
28
+ class Redirect < Exception
29
+ ErrorMessage = "Redirect"
30
+
31
+ attr_accessor :url
32
+ def initialize(url)
33
+ @url = url
34
+ end
35
+ end
36
+
37
+ class NotModified < ExceptionWithResponse
38
+ ErrorMessage = 'NotModified'
39
+ end
40
+
41
+ # Authorization is required to access the resource specified.
42
+ class Unauthorized < ExceptionWithResponse
43
+ ErrorMessage = 'Unauthorized'
44
+ end
45
+
46
+ # No resource was found at the given URL.
47
+ class ResourceNotFound < ExceptionWithResponse
48
+ ErrorMessage = 'Resource not found'
49
+ end
50
+
51
+ # The server broke the connection prior to the request completing. Usually
52
+ # this means it crashed, or sometimes that your network connection was
53
+ # severed before it could complete.
54
+ class ServerBrokeConnection < Exception
55
+ ErrorMessage = 'Server broke connection'
56
+ end
57
+
58
+ # The server took too long to respond.
59
+ class RequestTimeout < Exception
60
+ ErrorMessage = 'Request timed out'
61
+ end
62
+
63
+ # The request failed, meaning the remote HTTP server returned a code other
64
+ # than success, unauthorized, or redirect.
65
+ #
66
+ # The exception message attempts to extract the error from the XML, using
67
+ # format returned by Rails: <errors><error>some message</error></errors>
68
+ #
69
+ # You can get the status code by e.http_code, or see anything about the
70
+ # response via e.response. For example, the entire result body (which is
71
+ # probably an HTML error page) is e.response.body.
72
+ class RequestFailed < ExceptionWithResponse
73
+ def message
74
+ "HTTP status code #{http_code}"
75
+ end
76
+
77
+ def to_s
78
+ message
79
+ end
80
+ end
81
+ end
82
+
83
+ # backwards compatibility
84
+ class RestClient::Request
85
+ Redirect = RestClient::Redirect
86
+ Unauthorized = RestClient::Unauthorized
87
+ RequestFailed = RestClient::RequestFailed
88
+ end