rest-client-maestro 1.7.2.maestro

data/history.md

@@ -0,0 +1,134 @@
+# 1.6.7
+
+- rebuild with 1.8.7 to avoid https://github.com/rubygems/rubygems/pull/57
+
+# 1.6.6
+
+- 1.6.5 was yanked
+
+# 1.6.5
+
+- RFC6265 requires single SP after ';' for separating parameters pairs in the 'Cookie:' header (patch provided by Hiroshi Nakamura)
+- enable url parameters for all actions
+- detect file parameters in arrays
+- allow disabling the timeouts by passing -1 (patch provided by Sven Böhm)
+
+# 1.6.4
+
+- fix restclient script compatibility with 1.9.2
+- fix unlinking temp file (patch provided by Evan Smith)
+- monkeypatching ruby for http patch method (patch provided by Syl Turner)
+
+# 1.6.3
+
+- 1.6.2 was yanked
+
+# 1.6.2
+
+- add support for HEAD in resources (patch provided by tpresa)
+- fix shell for 1.9.2
+- workaround when some gem monkeypatch net/http (patch provided by Ian Warshak)
+- DELETE requests should process parameters just like GET and HEAD
+- adding :block_response parameter for manual processing
+- limit number of redirections (patch provided by Chris Dinn)
+- close and unlink the temp file created by playload (patch provided by Chris Green)
+- make gemspec Rubygems 1.8 compatible (patch provided by David Backeus)
+- added RestClient.reset_before_execution_procs (patch provided by Cloudify)
+- added PATCH method (patch provided by Jeff Remer)
+- hack for HTTP servers that use raw DEFLATE compression, see http://www.ruby-forum.com/topic/136825 (path provided by James Reeves)
+
+# 1.6.1
+
+- add response body in Exception#inspect
+- add support for RestClient.options
+- fix tests for 1.9.2 (patch provided by Niko Dittmann)
+- block passing in Resource#[] (patch provided by Niko Dittmann)
+- cookies set in a response should be kept in a redirect
+- HEAD requests should process parameters just like GET (patch provided by Rob Eanes)
+- exception message should never be nil (patch provided by Michael Klett)
+
+# 1.6.0
+
+- forgot to include rest-client.rb in the gem
+- user, password and user-defined headers should survive a redirect
+- added all missing status codes
+- added parameter passing for get request using the :param key in header
+- the warning about the logger when using a string was a bad idea
+- multipart parameters names should not be escaped
+- remove the cookie escaping introduced by migrating to CGI cookie parsing in 1.5.1
+- add a streamed payload type (patch provided by Caleb Land)
+- Exception#http_body works even when no response
+
+# 1.5.1
+
+- only converts headers keys which are Symbols
+- use CGI for cookie parsing instead of custom code
+- unescape user and password before using them (patch provided by Lars Gierth)
+- expand ~ in ~/.restclientrc (patch provided by Mike Fletcher)
+- ssl verification raise an exception when the ca certificate is incorrect (patch provided by Braintree)
+
+# 1.5.0
+
+- the response is now a String with the Response module a.k.a. the change in 1.4.0 was a mistake (Response.body is returning self for compatability)
+- added AbstractResponse.to_i to improve semantic
+- multipart Payloads ignores the name attribute if it's not set (patch provided by Tekin Suleyman)
+- correctly takes into account user headers whose keys are strings (path provided by Cyril Rohr)
+- use binary mode for payload temp file
+- concatenate cookies with ';'
+- fixed deeper parameter handling
+- do not quote the boundary in the Content-Type header (patch provided by W. Andrew Loe III)
+
+# 1.4.2
+
+- fixed RestClient.add_before_execution_proc (patch provided by Nicholas Wieland)
+- fixed error when an exception is raised without a response (patch provided by Caleb Land)
+
+# 1.4.1
+
+- fixed parameters managment when using hash
+
+# 1.4.0
+
+- Response is no more a String, and the mixin is replaced by an abstract_response, existing calls are redirected to response body with a warning.
+- enable repeated parameters  RestClient.post 'http://example.com/resource', :param1 => ['one', 'two', 'three'], => :param2 => 'foo' (patch provided by Rodrigo Panachi)
+- fixed the redirect code concerning relative path and query string combination (patch provided by Kevin Read)
+- redirection code moved to Response so redirection can be customized using the block syntax
+- only get and head redirections are now followed by default, as stated in the specification
+- added RestClient.add_before_execution_proc to hack the http request, like for oauth
+
+The response change may be breaking in rare cases.
+
+# 1.3.1
+
+- added compatibility to enable responses in exception to act like Net::HTTPResponse
+
+# 1.3.0
+
+- a block can be used to process a request's result, this enable to handle custom error codes or paththrought (design by Cyril Rohr)
+- cleaner log API, add a warning for some cases but should be compatible
+- accept multiple "Set-Cookie" headers, see http://www.ietf.org/rfc/rfc2109.txt (patch provided by Cyril Rohr)
+- remove "Content-Length" and "Content-Type" headers when following a redirection (patch provided by haarts)
+- all http error codes have now a corresponding exception class and all of them contain the Reponse -> this means that the raised exception can be different
+- changed "Content-Disposition: multipart/form-data" to "Content-Disposition: form-data" per RFC 2388 (patch provided by Kyle Crawford)
+
+The only breaking change should be the exception classes, but as the new classes inherits from the existing ones, the breaking cases should be rare.
+
+# 1.2.0
+
+- formatting changed from tabs to spaces
+- logged requests now include generated headers
+- accept and content-type headers can now be specified using extentions: RestClient.post "http://example.com/resource", { 'x' => 1 }.to_json, :content_type => :json, :accept => :json
+- should be 1.1.1 but renamed to 1.2.0 because 1.1.X versions has already been packaged on Debian
+
+# 1.1.0
+
+- new maintainer: Archiloque, the working repo is now at http://github.com/archiloque/rest-client
+- a mailing list has been created at rest.client@librelist.com and an freenode irc channel #rest-client
+- François Beausoleil' multipart code from http://github.com/francois/rest-client has been merged
+- ability to use hash in hash as payload
+- the mime-type code now rely on the mime-types gem http://mime-types.rubyforge.org/ instead of an internal partial list
+- 204 response returns a Response instead of nil (patch provided by Elliott Draper)
+
+All changes exept the last one should be fully compatible with the previous version.
+
+NOTE: due to a dependency problem and to the last change, heroku users should update their heroku gem to >= 1.5.3 to be able to use this version.

data/lib/rest-client.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'rest-client'
+require File.dirname(__FILE__) + '/restclient'

data/lib/rest_client.rb

@@ -0,0 +1,2 @@
+# This file exists for backward compatbility with require 'rest_client'
+require File.dirname(__FILE__) + '/restclient'

data/lib/restclient/abstract_response.rb

@@ -0,0 +1,106 @@
+require 'cgi'
+
+module RestClient
+
+  module AbstractResponse
+
+    attr_reader :net_http_res, :args
+
+    # HTTP status code
+    def code
+      @code ||= @net_http_res.code.to_i
+    end
+
+    # A hash of the headers, beautified with symbols and underscores.
+    # e.g. "Content-type" will become :content_type.
+    def headers
+      @headers ||= AbstractResponse.beautify_headers(@net_http_res.to_hash)
+    end
+
+    # The raw headers.
+    def raw_headers
+      @raw_headers ||= @net_http_res.to_hash
+    end
+
+    # Hash of cookies extracted from response headers
+    def cookies
+      @cookies ||= (self.headers[:set_cookie] || {}).inject({}) do |out, cookie_content|
+        out.merge parse_cookie(cookie_content)
+      end
+    end
+
+    # Return the default behavior corresponding to the response code:
+    # the response itself for code in 200..206, redirection for 301, 302 and 307 in get and head cases, redirection for 303 and an exception in other cases
+    def return! request = nil, result = nil, & block
+      if (200..207).include? code
+        self
+      elsif [301, 302, 307].include? code
+        unless [:get, :head].include? args[:method]
+          raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
+        else
+          follow_redirection(request, result, & block)
+        end
+      elsif code == 303
+        args[:method] = :get
+        args.delete :payload
+        follow_redirection(request, result, & block)
+      elsif Exceptions::EXCEPTIONS_MAP[code]
+        raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
+      else
+        raise RequestFailed.new(self, code)
+      end
+    end
+
+    def to_i
+      code
+    end
+
+    def description
+      "#{code} #{STATUSES[code]} | #{(headers[:content_type] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+    end
+
+    # Follow a redirection
+    def follow_redirection request = nil, result = nil, & block
+      url = headers[:location]
+      if url !~ /^http/
+        url = URI.parse(args[:url]).merge(url).to_s
+      end
+      args[:url] = url
+      if request
+        if request.max_redirects == 0
+          raise MaxRedirectsReached
+        end
+        args[:password] = request.password
+        args[:user] = request.user
+        args[:headers] = request.headers
+        args[:max_redirects] = request.max_redirects - 1
+        # pass any cookie set in the result
+        if result && result['set-cookie']
+          args[:headers][:cookies] = (args[:headers][:cookies] || {}).merge(parse_cookie(result['set-cookie']))
+        end
+      end
+      Request.execute args, &block
+    end
+
+    def AbstractResponse.beautify_headers(headers)
+      headers.inject({}) do |out, (key, value)|
+        out[key.gsub(/-/, '_').downcase.to_sym] = %w{ set-cookie }.include?(key.downcase) ? value : value.first
+        out
+      end
+    end
+
+    private
+
+    # Parse a cookie value and return its content in an Hash
+    def parse_cookie cookie_content
+      out = {}
+      CGI::Cookie::parse(cookie_content).each do |key, cookie|
+        unless ['expires', 'path'].include? key
+          out[CGI::escape(key)] = cookie.value[0] ? (CGI::escape(cookie.value[0]) || '') : ''
+        end
+      end
+      out
+    end
+  end
+
+end

data/lib/restclient/exceptions.rb

@@ -0,0 +1,198 @@
+module RestClient
+
+  STATUSES = {100 => 'Continue',
+              101 => 'Switching Protocols',
+              102 => 'Processing', #WebDAV
+
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+              203 => 'Non-Authoritative Information', # http/1.1
+              204 => 'No Content',
+              205 => 'Reset Content',
+              206 => 'Partial Content',
+              207 => 'Multi-Status', #WebDAV
+
+              300 => 'Multiple Choices',
+              301 => 'Moved Permanently',
+              302 => 'Found',
+              303 => 'See Other', # http/1.1
+              304 => 'Not Modified',
+              305 => 'Use Proxy', # http/1.1
+              306 => 'Switch Proxy', # no longer used
+              307 => 'Temporary Redirect', # http/1.1
+
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              402 => 'Payment Required',
+              403 => 'Forbidden',
+              404 => 'Resource Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              407 => 'Proxy Authentication Required',
+              408 => 'Request Timeout',
+              409 => 'Conflict',
+              410 => 'Gone',
+              411 => 'Length Required',
+              412 => 'Precondition Failed',
+              413 => 'Request Entity Too Large',
+              414 => 'Request-URI Too Long',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+              418 => 'I\'m A Teapot',
+              421 => 'Too Many Connections From This IP',
+              422 => 'Unprocessable Entity', #WebDAV
+              423 => 'Locked', #WebDAV
+              424 => 'Failed Dependency', #WebDAV
+              425 => 'Unordered Collection', #WebDAV
+              426 => 'Upgrade Required',
+              449 => 'Retry With', #Microsoft
+              450 => 'Blocked By Windows Parental Controls', #Microsoft
+
+              500 => 'Internal Server Error',
+              501 => 'Not Implemented',
+              502 => 'Bad Gateway',
+              503 => 'Service Unavailable',
+              504 => 'Gateway Timeout',
+              505 => 'HTTP Version Not Supported',
+              506 => 'Variant Also Negotiates',
+              507 => 'Insufficient Storage', #WebDAV
+              509 => 'Bandwidth Limit Exceeded', #Apache
+              510 => 'Not Extended'}
+
+  # Compatibility : make the Response act like a Net::HTTPResponse when needed
+  module ResponseForException
+    def method_missing symbol, *args
+      if net_http_res.respond_to? symbol
+        warn "[warning] The response contained in an RestClient::Exception is now a RestClient::Response instead of a Net::HTTPResponse, please update your code"
+        net_http_res.send symbol, *args
+      else
+        super
+      end
+    end
+  end
+
+  # This is the base RestClient exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  # You can get the status code by e.http_code, or see anything about the
+  # response via e.response.
+  # For example, the entire result body (which is
+  # probably an HTML error page) is e.response.
+  class Exception < RuntimeError
+    attr_accessor :response
+    attr_writer   :message
+
+    def initialize response = nil, initial_response_code = nil
+      @response = response
+      @message = nil
+      @initial_response_code = initial_response_code
+
+      # compatibility: this make the exception behave like a Net::HTTPResponse
+      response.extend ResponseForException if response
+    end
+
+    def http_code
+      # return integer for compatibility
+      if @response
+        @response.code.to_i
+      else
+        @initial_response_code
+      end
+    end
+
+    def http_body
+      @response.body if @response
+    end
+
+    def inspect
+      "#{message}: #{http_body}"
+    end
+
+    def to_s
+      inspect
+    end
+
+    def message
+      @message || self.class.name
+    end
+
+  end
+
+  # Compatibility
+  class ExceptionWithResponse < Exception
+  end
+
+  # The request failed with an error code not managed by the code
+  class RequestFailed < ExceptionWithResponse
+
+    def message
+      "HTTP status code #{http_code}"
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  # We will a create an exception for each status code, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+  module Exceptions
+    # Map http status codes to the corresponding exception class
+    EXCEPTIONS_MAP = {}
+  end
+
+  STATUSES.each_pair do |code, message|
+
+    # Compatibility
+    superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed
+    klass = Class.new(superclass) do
+      send(:define_method, :message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
+    end
+    klass_constant = const_set message.delete(' \-\''), klass
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+
+  # A redirect was encountered; caught by execute to retry with the new url.
+  class Redirect < Exception
+
+    def message
+      'Redirect'
+    end
+
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+  end
+
+  class MaxRedirectsReached < Exception
+    def message
+      'Maximum number of redirect reached'
+    end
+  end
+
+  # The server broke the connection prior to the request completing.  Usually
+  # this means it crashed, or sometimes that your network connection was
+  # severed before it could complete.
+  class ServerBrokeConnection < Exception
+    def initialize(message = 'Server broke connection')
+      super nil, nil
+      self.message = message
+    end
+  end
+
+  class SSLCertificateNotVerified < Exception
+    def initialize(message)
+      super nil, nil
+      self.message = message
+    end
+  end
+end
+
+# backwards compatibility
+class RestClient::Request
+  Redirect = RestClient::Redirect
+  Unauthorized = RestClient::Unauthorized
+  RequestFailed = RestClient::RequestFailed
+end

data/lib/restclient/net_http_ext.rb

@@ -0,0 +1,55 @@
+module Net
+  class HTTP
+
+  # Adding the patch method if it doesn't exist (rest-client issue: https://github.com/archiloque/rest-client/issues/79)
+  if !defined?(Net::HTTP::Patch)
+    # Code taken from this commit: https://github.com/ruby/ruby/commit/ab70e53ac3b5102d4ecbe8f38d4f76afad29d37d#lib/net/http.rb
+    class Protocol
+      # Sends a PATCH request to the +path+ and gets a response,
+      # as an HTTPResponse object.
+      def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
+        send_entity(path, data, initheader, dest, Patch, &block)
+      end
+
+      # Executes a request which uses a representation
+      # and returns its body.
+      def send_entity(path, data, initheader, dest, type, &block)
+        res = nil
+        request(type.new(path, initheader), data) {|r|
+          r.read_body dest, &block
+          res = r
+        }
+        unless @newimpl
+          res.value
+          return res, res.body
+        end
+        res
+      end
+    end
+
+    class Patch < HTTPRequest
+      METHOD = 'PATCH'
+      REQUEST_HAS_BODY = true
+      RESPONSE_HAS_BODY = true
+    end
+  end
+
+    #
+    # Replace the request method in Net::HTTP to sniff the body type
+    # and set the stream if appropriate
+    #
+    # Taken from:
+    # http://www.missiondata.com/blog/ruby/29/streaming-data-to-s3-with-ruby/
+
+    alias __request__ request
+
+    def request(req, body=nil, &block)
+      if body != nil && body.respond_to?(:read)
+        req.body_stream = body
+        return __request__(req, nil, &block)
+      else
+        return __request__(req, body, &block)
+      end
+    end
+  end
+end