xpflow 0.1b

data/lib/mime-types.rb

@@ -0,0 +1,3 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'mime/types'

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,193 @@
+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
+      @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
+
+    message = 'Redirect'
+
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+  end
+
+  class MaxRedirectsReached < Exception	
+    message = 'Maximum number of redirect reached'	
+  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

data/lib/restclient/payload.rb

@@ -0,0 +1,235 @@
+require 'tempfile'
+require 'stringio'
+require 'mime/types'
+
+module RestClient
+  module Payload
+    extend self
+
+    def generate(params)
+      if params.is_a?(String)
+        Base.new(params)
+      elsif params.respond_to?(:read)
+        Streamed.new(params)
+      elsif params
+        if params.delete(:multipart) == true || has_file?(params)
+          Multipart.new(params)
+        else
+          UrlEncoded.new(params)
+        end
+      else
+        nil
+      end
+    end
+
+    def has_file?(params)
+      params.any? do |_, v|
+        case v
+          when Hash
+            has_file?(v)
+          when Array
+            has_file_array?(v)
+          else
+            v.respond_to?(:path) && v.respond_to?(:read)
+        end
+      end
+    end
+
+    def has_file_array?(params)
+      params.any? do |v|
+        case v
+          when Hash
+            has_file?(v)
+          when Array
+            has_file_array?(v)
+          else
+            v.respond_to?(:path) && v.respond_to?(:read)
+          end
+      end
+    end
+
+    class Base
+      def initialize(params)
+        build_stream(params)
+      end
+
+      def build_stream(params)
+        @stream = StringIO.new(params)
+        @stream.seek(0)
+      end
+
+      def read(bytes=nil)
+        @stream.read(bytes)
+      end
+
+      alias :to_s :read
+
+      # Flatten parameters by converting hashes of hashes to flat hashes
+      # {keys1 => {keys2 => value}} will be transformed into [keys1[key2], value]
+      def flatten_params(params, parent_key = nil)
+        result = []
+        params.each do |key, value|
+          calculated_key = parent_key ? "#{parent_key}[#{handle_key(key)}]" : handle_key(key)
+          if value.is_a? Hash
+            result += flatten_params(value, calculated_key)
+          elsif value.is_a? Array
+            result += flatten_params_array(value, calculated_key)
+          else
+            result << [calculated_key, value]
+          end
+        end
+        result
+      end
+
+      def flatten_params_array value, calculated_key
+        result = []
+        value.each do |elem|
+          if elem.is_a? Hash
+            result += flatten_params(elem, calculated_key)
+          elsif elem.is_a? Array
+            result += flatten_params_array(elem, calculated_key)
+          else
+            result << ["#{calculated_key}[]", elem]
+          end
+        end
+        result
+      end
+
+      def headers
+        {'Content-Length' => size.to_s}
+      end
+
+      def size
+        @stream.size
+      end
+
+      alias :length :size
+
+      def close
+        @stream.close unless @stream.closed?
+      end
+
+      def inspect
+        result = to_s.inspect
+        @stream.seek(0)
+        result
+      end
+
+      def short_inspect
+        (size > 500 ? "#{size} byte(s) length" : inspect)
+      end
+
+    end
+
+    class Streamed < Base
+      def build_stream(params = nil)
+        @stream = params
+      end
+
+      def size
+        if @stream.respond_to?(:size)
+          @stream.size
+        elsif @stream.is_a?(IO)
+          @stream.stat.size
+        end
+      end
+
+      alias :length :size
+    end
+
+    class UrlEncoded < Base
+      def build_stream(params = nil)
+        @stream = StringIO.new(flatten_params(params).collect do |entry|
+          "#{entry[0]}=#{handle_key(entry[1])}"
+        end.join("&"))
+        @stream.seek(0)
+      end
+
+      # for UrlEncoded escape the keys
+      def handle_key key
+        URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+
+      def headers
+        super.merge({'Content-Type' => 'application/x-www-form-urlencoded'})
+      end
+    end
+
+    class Multipart < Base
+      EOL = "\r\n"
+
+      def build_stream(params)
+        b = "--#{boundary}"
+
+        @stream = Tempfile.new("RESTClient.Stream.#{rand(1000)}")
+        @stream.binmode
+        @stream.write(b + EOL)
+
+        if params.is_a? Hash
+          x = flatten_params(params)
+        else
+          x = params
+        end
+
+        last_index = x.length - 1
+        x.each_with_index do |a, index|
+          k, v = * a
+          if v.respond_to?(:read) && v.respond_to?(:path)
+            create_file_field(@stream, k, v)
+          else
+            create_regular_field(@stream, k, v)
+          end
+          @stream.write(EOL + b)
+          @stream.write(EOL) unless last_index == index
+        end
+        @stream.write('--')
+        @stream.write(EOL)
+        @stream.seek(0)
+      end
+
+      def create_regular_field(s, k, v)
+        s.write("Content-Disposition: form-data; name=\"#{k}\"")
+        s.write(EOL)
+        s.write(EOL)
+        s.write(v)
+      end
+
+      def create_file_field(s, k, v)
+        begin
+          s.write("Content-Disposition: form-data;")
+          s.write(" name=\"#{k}\";") unless (k.nil? || k=='')
+          s.write(" filename=\"#{v.respond_to?(:original_filename) ? v.original_filename : File.basename(v.path)}\"#{EOL}")
+          s.write("Content-Type: #{v.respond_to?(:content_type) ? v.content_type : mime_for(v.path)}#{EOL}")
+          s.write(EOL)
+          while data = v.read(8124)
+            s.write(data)
+          end
+        ensure
+          v.close if v.respond_to?(:close)
+        end
+      end
+
+      def mime_for(path)
+        mime = MIME::Types.type_for path
+        mime.empty? ? 'text/plain' : mime[0].content_type
+      end
+
+      def boundary
+        @boundary ||= rand(1_000_000).to_s
+      end
+
+      # for Multipart do not escape the keys
+      def handle_key key
+        key
+      end
+
+      def headers
+        super.merge({'Content-Type' => %Q{multipart/form-data; boundary=#{boundary}}})
+      end
+
+      def close
+        @stream.close!
+      end
+    end
+  end
+end

data/lib/restclient/raw_response.rb

@@ -0,0 +1,34 @@
+module RestClient
+  # The response from RestClient on a raw request looks like a string, but is
+  # actually one of these.  99% of the time you're making a rest call all you
+  # care about is the body, but on the occassion you want to fetch the
+  # headers you can:
+  #
+  #   RestClient.get('http://example.com').headers[:content_type]
+  #
+  # In addition, if you do not use the response as a string, you can access
+  # a Tempfile object at res.file, which contains the path to the raw
+  # downloaded request body.
+  class RawResponse
+
+    include AbstractResponse
+
+    attr_reader :file
+
+    def initialize tempfile, net_http_res, args
+      @net_http_res = net_http_res
+      @args = args
+      @file = tempfile
+    end
+
+    def to_s
+      @file.open
+      @file.read
+    end
+
+    def size
+      File.size file
+    end
+
+  end
+end